Reference

BackstageClient.passContents

BackstageClient.passContents in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / passContents

passContents: {
  list: (passId: string, requestOptions?: RequestOptions) => Promise<{
     eventId: string | null;
     eventOccurrenceId: string | null;
     holderId: string | null;
     id: string;
     name: string;
     orderId: string;
     redemptionCount: number;
     redemptionLimit: number | null;
     seatLabel: string | null;
     status: string;
     ticketTypeId: string | null;
     type: string;
  }[]>;
  load: (passId: string, request: {
     entitlementId: string;
     reason: string;
   }, requestOptions?: RequestOptions) => Promise<{
     entitlement: {
        eventId: string | null;
        eventOccurrenceId: string | null;
        holderId: string | null;
        id: string;
        name: string;
        orderId: string;
        redemptionCount: number;
        redemptionLimit: number | null;
        seatLabel: string | null;
        status: string;
        ticketTypeId: string | null;
        type: string;
     };
     fromPassId: string | null;
     revokedPassId: string | null;
  }>;
  moves: (passId: string, requestOptions?: RequestOptions) => Promise<{
     createdAt: string;
     entitlementId: string;
     fromPassId: string | null;
     id: string;
     movedBy: string | null;
     reason: string;
     toPassId: string;
  }[]>;
};

Defined in: client.ts:9106

Pass Contents methods

list()#

list: (passId: string, requestOptions?: RequestOptions) => Promise<{
  eventId: string | null;
  eventOccurrenceId: string | null;
  holderId: string | null;
  id: string;
  name: string;
  orderId: string;
  redemptionCount: number;
  redemptionLimit: number | null;
  seatLabel: string | null;
  status: string;
  ticketTypeId: string | null;
  type: string;
}[]>;

What a pass carries The entitlements on a pass, oldest first: one for a ticket, every day and add-on for a wristband, everything loaded onto a membership card.

Parameters#

Parameter	Type
`passId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ eventId: string | null; eventOccurrenceId: string | null; holderId: string | null; id: string; name: string; orderId: string; redemptionCount: number; redemptionLimit: number | null; seatLabel: string | null; status: string; ticketTypeId: string | null; type: string; }[]>

Operation Id#

listPassEntitlements

load()#

load: (passId: string, request: {
  entitlementId: string;
  reason: string;
}, requestOptions?: RequestOptions) => Promise<{
  entitlement: {
     eventId: string | null;
     eventOccurrenceId: string | null;
     holderId: string | null;
     id: string;
     name: string;
     orderId: string;
     redemptionCount: number;
     redemptionLimit: number | null;
     seatLabel: string | null;
     status: string;
     ticketTypeId: string | null;
     type: string;
  };
  fromPassId: string | null;
  revokedPassId: string | null;
}>;

Move an entitlement onto this pass Put a ticket on a membership card, or on the holder's wristband for the event. Onto a long-lived pass: the event's pass policy must allow it (loadOntoLongLived), the card must be the same customer's and valid when the entitlement is used. Onto a per-holder pass: the same event and holder. A scanned entitlement never moves (409 ENTITLEMENT_IN_USE). A ticket left with nothing on it is revoked with its barcodes, so the old copy stops working at the door. Recorded in the pass's moves.

Parameters#

Parameter	Type	Description
`passId`	`string`	-
`request`	{ `entitlementId`: `string`; `reason`: `string`; }	-
`request.entitlementId`	`string`	Example `ent_PfK1N8UTb3MbN7nl7TiR`
`request.reason?`	`string`	Example `Customer asked to use their membership card`
`requestOptions?`	`RequestOptions`	-

Returns#

Promise<{ entitlement: { eventId: string | null; eventOccurrenceId: string | null; holderId: string | null; id: string; name: string; orderId: string; redemptionCount: number; redemptionLimit: number | null; seatLabel: string | null; status: string; ticketTypeId: string | null; type: string; }; fromPassId: string | null; revokedPassId: string | null; }>

Operation Id#

loadEntitlementOntoPass

moves()#

moves: (passId: string, requestOptions?: RequestOptions) => Promise<{
  createdAt: string;
  entitlementId: string;
  fromPassId: string | null;
  id: string;
  movedBy: string | null;
  reason: string;
  toPassId: string;
}[]>;

Entitlements moved onto or off a pass Every move onto or off this pass, oldest first, including placement onto a per-holder pass at issuance.

Parameters#

Parameter	Type
`passId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ createdAt: string; entitlementId: string; fromPassId: string | null; id: string; movedBy: string | null; reason: string; toPassId: string; }[]>

Operation Id#

listPassMoves