BackstageClient.passWallet

@ticketlayer/backstage

@ticketlayer/backstage / BackstageClient / passWallet

passWallet: {
  apple: (passId: string, requestOptions?: RequestOptions) => Promise<any>;
  google: (passId: string, requestOptions?: RequestOptions) => Promise<{
     classId: string;
     demoMode: boolean;
     objectId: string;
     saveUrl: string;
  }>;
};

Defined in: client.ts:9034

Pass Wallet methods

apple()#

apple: (passId: string, requestOptions?: RequestOptions) => Promise<any>;

Get a pass as an Apple Wallet pass The signed .pkpass (application/vnd.apple.pkpass) for the pass: one wallet pass per pass, a per-holder pass showing every entitlement on it. It updates itself when the pass's time, seat, status or identifiers change; a re-issue or transfer voids it. 409 PASS_RENDITION_NOT_ALLOWED for a protected pass; a code released late is shown from its time. 503 WALLET_NOT_CONFIGURED until the Apple issuer is configured. Browsers and staff tools fetch this directly.

Parameters#

Returns#

Promise<any>

Operation Id#

getPassAppleWallet

google()#

google: (passId: string, requestOptions?: RequestOptions) => Promise<{
  classId: string;
  demoMode: boolean;
  objectId: string;
  saveUrl: string;
}>;

Get a pass as a Google Wallet pass The save-to-Google-Wallet link for the pass, its event ticket object written first: one wallet pass per pass, in a class per event. It updates itself when the pass changes, with a notification (at most 3 a day) when the time, seat or status does; a re-issue or transfer makes it inactive. A protected pass carries a rotating barcode. 503 WALLET_NOT_CONFIGURED until the Google issuer is configured; 502 WALLET_PROVIDER_ERROR when Google refuses.

Parameters#

Returns#

Promise<{ classId: string; demoMode: boolean; objectId: string; saveUrl: string; }>

Operation Id#

getPassGoogleWallet