Reference

BackstageClient.longLivedPasses

BackstageClient.longLivedPasses in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / longLivedPasses

longLivedPasses: {
  create: (request: {
     accountId: string;
     customerId: string;
     label: string;
     type?: "wristband" | "ticket" | "membership_card";
     validFrom?: string | null;
     validUntil?: string | null;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     barcode: string | null;
     createdAt: string;
     customerId: string | null;
     holderId: string | null;
     id: string;
     label: string | null;
     status: string;
     type: string;
     validFrom: string | null;
     validUntil: string | null;
  }>;
  list: (options?: {
     customerId: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     barcode: string | null;
     createdAt: string;
     customerId: string | null;
     holderId: string | null;
     id: string;
     label: string | null;
     status: string;
     type: string;
     validFrom: string | null;
     validUntil: string | null;
  }[]>;
};

Defined in: client.ts:9067

Long-lived Passes methods

create()#

create: (request: {
  accountId: string;
  customerId: string;
  label: string;
  type?: "wristband" | "ticket" | "membership_card";
  validFrom?: string | null;
  validUntil?: string | null;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  barcode: string | null;
  createdAt: string;
  customerId: string | null;
  holderId: string | null;
  id: string;
  label: string | null;
  status: string;
  type: string;
  validFrom: string | null;
  validUntil: string | null;
}>;

Create a long-lived pass for a customer A membership card, season card or account pass: a pass for a customer with a validity window and no order. Entitlements are loaded onto it where their event's pass policy allows (loadOntoLongLived), and scanning it admits whichever the door can admit now.

Parameters#

Parameter	Type	Description
`request`	{ `accountId`: `string`; `customerId`: `string`; `label`: `string`; `type?`: `"wristband"` \| `"ticket"` \| `"membership_card"`; `validFrom?`: `string` \| `null`; `validUntil?`: `string` \| `null`; }	-
`request.accountId`	`string`	Description The account the pass belongs to Example `acc_Ab12Cd34`
`request.customerId?`	`string`	Example `cus_Ab12Cd34`
`request.label?`	`string`	Example `Membership 2026-27`
`request.type?`	`"wristband"` \| `"ticket"` \| `"membership_card"`	Description What the pass is; membership_card by default
`request.validFrom?`	`string` \| `null`	Format: date-time Description Null is from now
`request.validUntil?`	`string` \| `null`	Format: date-time Description Null is open-ended
`requestOptions?`	`RequestOptions`	-

Returns#

Promise<{ accountId: string; barcode: string | null; createdAt: string; customerId: string | null; holderId: string | null; id: string; label: string | null; status: string; type: string; validFrom: string | null; validUntil: string | null; }>

Operation Id#

createLongLivedPass

list()#

list: (options?: {
  customerId: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  barcode: string | null;
  createdAt: string;
  customerId: string | null;
  holderId: string | null;
  id: string;
  label: string | null;
  status: string;
  type: string;
  validFrom: string | null;
  validUntil: string | null;
}[]>;

List a customer's long-lived passes A customer's membership and season cards, newest first, on the accounts the caller can read.

Parameters#

Parameter	Type
`options?`	{ `customerId`: `string`; }
`options.customerId?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listLongLivedPasses