Class: BackstageClient

@ticketlayer/backstage

@ticketlayer/backstage / BackstageClient

Defined in: client.ts:1003

Constructors#

Constructor#

new BackstageClient(config: BackstageClientConfig): BackstageClient;

Defined in: client.ts:1018

Parameters#

Returns#

BackstageClient

Methods#

clearAccessToken()#

clearAccessToken(): void;

Defined in: client.ts:1076

Clear the access token

Returns#

void

getAccessToken()#

getAccessToken(): string | undefined;

Defined in: client.ts:1083

Get the current access token

Returns#

string | undefined

getRefreshToken()#

getRefreshToken(): string | undefined;

Defined in: client.ts:1097

Get the current refresh token

Returns#

string | undefined

setAccessToken()#

setAccessToken(token: string): void;

Defined in: client.ts:1069

Set the access token for authenticated requests

Parameters#

Returns#

void

setRefreshToken()#

setRefreshToken(token: string): void;

Defined in: client.ts:1090

Set the refresh token

Parameters#

Returns#

void

Properties#

accounts#

Defined in: client.ts:1782

Accounts methods

accounts methods: create(), delete(), get(), list(), update()

aiActionLimits#

Defined in: client.ts:8208

AI Action Limits methods

aiActionLimits methods: list(), resolve(), set()

apiKeys#

Defined in: client.ts:1885

API Keys methods

apiKeys methods: create(), get(), list(), listScopes(), revoke(), roll(), update()

assets#

Defined in: client.ts:9485

Assets methods

assets methods: completeUpload(), createUpload(), delete(), get(), getContent(), list(), upload()

billing#

Defined in: client.ts:3779

Billing methods

billing methods: cancelSubscription(), canSell(), createAiTopup(), createPurchase(), createSetupIntent(), createSubscription(), deletePaymentMethod(), getAiBalance(), getAutoTopup(), getBalance(), getInvoice(), listAiPackages(), listAiTransactions(), listInvoices(), listPackages(), listPaymentMethods(), listPayments(), listSubscriptions(), listTransactions(), savePaymentMethod(), setDefaultPaymentMethod(), updateAutoTopup()

brands#

Defined in: client.ts:8323

Brands methods

brands methods: create(), delete(), get(), list(), resolved(), update()

carts#

Defined in: client.ts:7812

Carts methods

carts methods: addItem(), addUnlock(), applyCode(), changeSeat(), checkout(), choose(), create(), get(), getCheckout(), holders(), options(), quote(), releaseSeat(), removeCode(), removeItem(), removeUnlock(), reserveSeats(), setHolders()

cases#

Defined in: client.ts:10961

Cases methods

cases methods: clearPresence(), create(), get(), link(), list(), listActions(), listActivities(), listProposals(), logActivity(), renderMacro(), setPresence(), takeAction(), unlink(), update()

cashSessions#

Defined in: client.ts:6481

Cash sessions methods

cashSessions methods: approve(), close(), get(), getSettings(), handover(), list(), open(), recordMovement(), report(), setSettings()

clientVersions#

Defined in: client.ts:10710

Client Versions methods

clientVersions methods: list()

codes#

Defined in: client.ts:8796

Codes methods

codes methods: archive(), create(), get(), list(), update()

conciergeSimulations#

Defined in: client.ts:8261

Concierge Simulations methods

conciergeSimulations methods: addRegression(), get(), list(), start()

customers#

Defined in: client.ts:4643

Customers methods

customers methods: addNote(), block(), correct(), create(), deleteNote(), deletePhoto(), erase(), get(), getHistory(), getTimeline(), grantTag(), list(), listNotes(), listTags(), logActivity(), match(), photo(), revokeTag(), setPhoto(), unblock(), update(), updateNote()

deliveryMethods#

Defined in: client.ts:6640

Delivery methods methods

deliveryMethods methods: getPolicy(), list(), setPolicy()

deviceAuth#

Defined in: client.ts:9679

Device Auth methods

deviceAuth methods: issueToken(), jwks()

devicePairing#

Defined in: client.ts:9600

Device Pairing methods

devicePairing methods: claim(), confirm(), getStatus(), reject(), start()

devices#

Defined in: client.ts:9840

Devices methods

devices methods: assignRoles(), delete(), dispatchCommand(), get(), getCommand(), list(), listCommands(), listEvents(), mediaCatalog(), mintLocalToken(), nfcReaders(), printers(), revoke(), rotateCredential(), update()

deviceSelf#

Defined in: client.ts:9713

Device Self methods

deviceSelf methods: declarePeripherals(), fetchCommands(), getCertificate(), getMe(), heartbeat(), ingestEvents(), reportProgress(), reportResult()

embedSessions#

Defined in: client.ts:1991

Embed Sessions methods

embedSessions methods: create(), current()

events#

Defined in: client.ts:2502

Events methods Use events() to access nested resources: events(id).offers, occurrences, priceschemes, plans

events methods: addNote(), applyLayoutChanges(), create(), delete(), deleteNote(), get(), getHistory(), getLayout(), getLayoutChangeResult(), list(), listNotes(), streamLayoutChangeProgress(), update(), updateNote(), validateLayoutChanges()

exchange#

Defined in: client.ts:7188

Exchange methods

exchange methods: list(), lookup(), swap()

feeProfiles#

Defined in: client.ts:8083

Fee Profiles methods

feeProfiles methods: create(), delete(), get(), list(), update()

feeSettings#

Defined in: client.ts:8160

Fee Settings methods

feeSettings methods: get(), put(), surchargeRules()

flows#

Defined in: client.ts:11634

Flows methods

flows methods: get(), list()

fulfilment#

Defined in: client.ts:6688

Fulfilment methods

fulfilment methods: cancel(), collect(), collection(), get(), hold(), list(), print(), providers(), release(), reportProgress(), retry()

fulfilmentExceptions#

Defined in: client.ts:7245

Fulfilment Exceptions methods

fulfilmentExceptions methods: list(), resolve()

giftCards#

Defined in: client.ts:7441

Gift cards methods

giftCards methods: createProduct(), issueCode(), listProducts(), lookup(), updateProduct()

identity#

Defined in: client.ts:1421

Identity methods

identity methods: abortSignInInteraction(), emailCode(), getSignInInteraction(), invitationAccept(), invitationStart(), mfa(), password(), signupStart(), signupVerify(), start(), submitSignInInteractionConsent(), submitSignInInteractionLogin(), submitSignInInteractionOrganisation(), switchSignInInteraction()

identityProviders#

Defined in: client.ts:2448

Identity Providers methods

identityProviders methods: get(), list(), update()

integrations#

Defined in: client.ts:10607

Integrations methods

integrations methods: get(), list(), listConnectedApps(), listGrants(), listScopes(), revokeConnection(), revokeGrant()

inventory#

Defined in: client.ts:4124

Inventory methods

inventory methods: create(), delete(), get(), getAuditLog(), list(), updateCapacity()

inventoryHolds#

Defined in: client.ts:4403

Inventory Holds methods

inventoryHolds methods: createHold(), releaseHold()

inventoryReservations#

Defined in: client.ts:4281

Inventory Reservations methods

inventoryReservations methods: checkAvailability(), confirmReservation(), extendReservation(), getReservation(), listReservations(), releaseReservation(), reserve()

inventorySeats#

Defined in: client.ts:4239

Inventory Seats methods

inventorySeats methods: importSeats(), listSeats()

knowledge#

Defined in: client.ts:8498

Knowledge methods

knowledge methods: archiveArticle(), createArticle(), createFact(), deleteFact(), getArticle(), getFact(), listArticles(), listFactKeys(), listFacts(), listGaps(), previewArticle(), refundPolicyText(), resolve(), search(), updateArticle(), updateFact()

ledger#

Defined in: client.ts:10734

Ledger methods

ledger methods: balances(), createSettlement(), eventStatement(), exceptions(), payout(), payouts(), retryException(), reverseSettlement(), settlement(), settlements(), statement()

locations#

Defined in: client.ts:10069

Locations methods

locations methods: create(), delete(), get(), list(), update()

longLivedPasses#

Defined in: client.ts:9067

Long-lived Passes methods

longLivedPasses methods: create(), list()

me#

Defined in: client.ts:1672

Me methods

me methods: current(), grants(), organisations(), permissions(), redeemInvitation(), revokeGrant(), roles()

mediaStock#

Defined in: client.ts:7134

Media stock methods

mediaStock methods: list(), move(), movements()

mediaTypes#

Defined in: client.ts:7051

Media types methods

mediaTypes methods: create(), list(), update()

meta#

Defined in: client.ts:1633

Meta methods

meta methods: versions()

objectTypes#

Defined in: client.ts:11601

Object types methods

objectTypes methods: get(), list()

occurrenceSeating#

Defined in: client.ts:4438

Occurrence Seating methods

occurrenceSeating methods: bestAvailable(), createAllocation(), createHold(), createSeatmapToken(), getSeatmap(), getState(), listAllocations(), listHolds(), releaseAllocation(), releaseHold(), releaseKills(), restoreKills(), updateAllocation()

orders#

Defined in: client.ts:5136

Orders methods

orders methods: activateWristband(), addFeeLine(), addGiftCard(), addItem(), addNote(), assignAddOn(), cancel(), create(), deleteNote(), fulfilment(), get(), getByNumber(), getHistory(), getPasses(), getPassPdf(), getPaymentStatus(), holders(), initiatePayment(), list(), listNotes(), nameHolder(), paymentMethods(), paymentTerms(), placeAwaitingPayment(), printPass(), recordExternalPayment(), recordPayment(), removeFeeLine(), removeGiftCard(), removeItem(), resendConfirmation(), sendNow(), setShipTo(), shipTo(), spendStoredValue(), storedValue(), transitionStatus(), update(), updateItem(), updateNote(), validate()

organisations#

Defined in: client.ts:2381

Organisations methods

organisations methods: get(), graduate(), update()

partners#

Defined in: client.ts:1865

Partners methods

partners methods: createAccount()

passContents#

Defined in: client.ts:9106

Pass Contents methods

passContents methods: list(), load(), moves()

passes()#

Defined in: client.ts:8880

passes methods Use passes() to access nested resources: passes(id).entitlements

passes() methods: entitlements.redeem()

passHolders#

Defined in: client.ts:8985

Pass Holders methods

passHolders methods: changeName(), history(), transfer()

passIdentifiers#

Defined in: client.ts:8907

Pass Identifiers methods

passIdentifiers methods: bind(), list(), reissue(), revoke(), sign()

passPolicies#

Defined in: client.ts:9154

Pass Policies methods

passPolicies methods: get(), put()

passWallet#

Defined in: client.ts:9034

Pass Wallet methods

passWallet methods: apple(), google()

paymentMethods#

Defined in: client.ts:6433

Payment methods methods

paymentMethods methods: getPolicy(), list(), setPolicy()

paymentProviders#

Defined in: client.ts:6069

Payment Providers methods

paymentProviders methods: balances(), connectAdyen(), connectPaypal(), create(), createAccountOnboardingLink(), createAccountOnboardingSession(), createTicketlayerPayOnboardingLink(), createTicketlayerPayOnboardingSession(), delete(), enableTicketlayerPay(), get(), getAccount(), getAdyen(), getDefault(), getStripeConnect(), getTicketlayerPay(), linkStripeConnect(), list(), listAccounts(), listPaypalConnections(), reportStatus(), setAccountMode(), update()

payments#

Defined in: client.ts:5921

Payments methods

payments methods: cancel(), capturePaypal(), confirmSandbox(), create(), createRefund(), get(), list(), listRefunds(), raiseSandboxPayouts()

plan#

Defined in: client.ts:2429

Plan methods

plan methods: get()

printerMedia#

Defined in: client.ts:7100

Printer media methods

printerMedia methods: get(), set()

refundPolicies#

Defined in: client.ts:5004

Refund Policies methods

refundPolicies methods: listPolicies(), upsertPolicy()

refundRequests#

Defined in: client.ts:5038

Refund Requests methods

refundRequests methods: approveRequest(), createRequest(), listRequests(), processRequest(), rejectRequest(), updateRequest()

reports#

Defined in: client.ts:10146

Reports methods

reports methods: dashboardCreate(), dashboardDelete(), dashboardGet(), dashboardList(), dashboardUpdate(), inventory(), meta(), query(), savedCreate(), savedDelete(), savedGet(), savedList(), savedRun(), savedUpdate(), summary(), templateInstall(), templateList(), timeseries()

roles#

Defined in: client.ts:2213

Roles methods

roles methods: create(), delete(), get(), list(), update()

salesChannels#

Defined in: client.ts:7525

Sales Channels methods Use salesChannels() to access nested resources: salesChannels(id).keys, listings, channelaccess, concierge

salesChannels methods: create(), delete(), get(), list(), mySalesChannels(), update()

scan#

Defined in: client.ts:9373

Scan methods

scan methods: config(), keys(), manifest(), operations()

scanConfigs#

Defined in: client.ts:9281

Scan Configs methods

scanConfigs methods: create(), delete(), get(), list(), setDevices(), update()

scans#

Defined in: client.ts:9440

Scans methods

scans methods: list(), reverse()

shipments#

Defined in: client.ts:6863

Shipments methods

shipments methods: addItems(), cancel(), create(), delivered(), dispatch(), encode(), get(), getSettings(), list(), returned(), scan(), setSettings()

signup#

Defined in: client.ts:1652

Signup methods

signup methods: signUp()

storedValue#

Defined in: client.ts:7286

Stored value methods

storedValue methods: activity(), adjust(), closedLoopReport(), get(), getSettings(), giveCredit(), list(), setStatus(), updateSettings()

support#

Defined in: client.ts:11193

Support methods

support methods: createInboundAddress(), createMacro(), deleteMacro(), getInbox(), getMacro(), getSettings(), listForwardingConfirmations(), listInboundAddresses(), listMacros(), updateMacro(), updateSettings()

tags#

Defined in: client.ts:8414

Tags methods

tags methods: archive(), create(), get(), list(), update()

taskQueues#

Defined in: client.ts:11533

Task Queues methods

taskQueues methods: create(), get(), list(), update()

tasks#

Defined in: client.ts:11379

Tasks methods

tasks methods: claim(), counts(), create(), decide(), get(), list(), reassign(), release()

taskTypes#

Defined in: client.ts:11514

Task Types methods

taskTypes methods: list()

taxDocuments#

Defined in: client.ts:11809

Tax Documents methods

taxDocuments methods: get(), issue(), list(), render()

taxRegistrations#

Defined in: client.ts:11667

Tax Registrations methods

taxRegistrations methods: create(), delete(), list(), update()

taxSettings#

Defined in: client.ts:11735

Tax Settings methods

taxSettings methods: get(), put(), ukVatRates()

terminal#

Defined in: client.ts:5785

Terminal methods

terminal methods: cancelPayment(), chargeOrder(), getPayment(), getReader(), listReaders(), presentTestPaymentMethod(), registerReader(), removeReader()

ticketTemplates#

Defined in: client.ts:9198

Ticket Templates methods

ticketTemplates methods: create(), delete(), get(), list(), update()

ticketTypeConfigs#

Defined in: client.ts:3035

Ticket Type Configs methods

ticketTypeConfigs methods: get(), list(), put()

userAccountRoles#

Defined in: client.ts:2290

User Account Roles methods

userAccountRoles methods: assign(), list(), listByAccount(), listByUser(), remove(), update()

userInvitations#

Defined in: client.ts:2025

User Invitations methods

userInvitations methods: cancel(), create(), get(), list(), resend()

users#

Defined in: client.ts:2107

Users methods

users methods: addRole(), create(), delete(), get(), list(), removeRole(), update()

vatReturns#

Defined in: client.ts:11783

VAT Returns methods

vatReturns methods: get()

venues#

Defined in: client.ts:3084

Venues methods Use venues() to access nested resources: venues(id).venuelayouts, venuelayoutareas, venuelayoutcategories, venuelayoutseats, venueplans, venueplanversions

venues methods: create(), delete(), get(), list(), update()

webhookDeliveries#

Defined in: client.ts:10535

Webhook Deliveries methods

webhookDeliveries methods: get(), list(), listInbound()

webhookEndpoints#

Defined in: client.ts:10439

Webhook Endpoints methods

webhookEndpoints methods: create(), delete(), get(), list(), test(), update()

webhookEventTypes#

Defined in: client.ts:10588

Webhook Event Types methods

webhookEventTypes methods: list()