Reference

BackstageClient.passHolders

BackstageClient.passHolders in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / passHolders

passHolders: {
  changeName: (passId: string, request: {
     customerId?: any;
     email?: any;
     name: string;
     reason?: any;
   }, requestOptions?: RequestOptions) => Promise<{
     barcode: string | null;
     holder: {
        email: string | null;
        id: string;
        name: string | null;
     };
     kind: "name_change" | "transfer" | "naming";
     passId: string;
  }>;
  history: (passId: string, requestOptions?: RequestOptions) => Promise<{
     changedBy: string | null;
     createdAt: string;
     fromHolderId: string | null;
     id: string;
     kind: "name_change" | "transfer" | "naming";
     reason: string | null;
     toHolderId: string;
  }[]>;
  transfer: (passId: string, request: {
     customerId?: any;
     email?: any;
     name: string;
     reason?: any;
   }, requestOptions?: RequestOptions) => Promise<{
     barcode: string | null;
     holder: {
        email: string | null;
        id: string;
        name: string | null;
     };
     kind: "name_change" | "transfer" | "naming";
     passId: string;
  }>;
};

Defined in: client.ts:8985

Pass Holders methods

changeName()#

changeName: (passId: string, request: {
  customerId?: any;
  email?: any;
  name: string;
  reason?: any;
}, requestOptions?: RequestOptions) => Promise<{
  barcode: string | null;
  holder: {
     email: string | null;
     id: string;
     name: string | null;
  };
  kind: "name_change" | "transfer" | "naming";
  passId: string;
}>;

Name a pass's holder, or change the name Put a name on a pass, or change it. The pass keeps its barcode. Naming a pass with no name yet is always allowed before the event's cutoff; a change follows the event's or ticket type's pass policy (allowed, how many, until when) and is refused once the pass is scanned or activated (409 PASS_FROZEN, PASS_CHANGE_NOT_ALLOWED, PASS_CHANGE_LIMIT_REACHED, PASS_CHANGE_CLOSED). Recorded in the pass's holder history.

Parameters#

Parameter	Type
`passId`	`string`
`request`	{ `customerId?`: `any`; `email?`: `any`; `name`: `string`; `reason?`: `any`; }
`request.customerId?`	`any`
`request.email?`	`any`
`request.name?`	`string`
`request.reason?`	`any`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ barcode: string | null; holder: { email: string | null; id: string; name: string | null; }; kind: "name_change" | "transfer" | "naming"; passId: string; }>

Operation Id#

changePassHolderName

history()#

history: (passId: string, requestOptions?: RequestOptions) => Promise<{
  changedBy: string | null;
  createdAt: string;
  fromHolderId: string | null;
  id: string;
  kind: "name_change" | "transfer" | "naming";
  reason: string | null;
  toHolderId: string;
}[]>;

A pass's holder history Every naming, name change and transfer of this pass, oldest first: from which holder to which, why and by whom.

Parameters#

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

Returns#

Promise<{ changedBy: string | null; createdAt: string; fromHolderId: string | null; id: string; kind: "name_change" | "transfer" | "naming"; reason: string | null; toHolderId: string; }[]>

Operation Id#

listPassHolderChanges

transfer()#

transfer: (passId: string, request: {
  customerId?: any;
  email?: any;
  name: string;
  reason?: any;
}, requestOptions?: RequestOptions) => Promise<{
  barcode: string | null;
  holder: {
     email: string | null;
     id: string;
     name: string | null;
  };
  kind: "name_change" | "transfer" | "naming";
  passId: string;
}>;

Transfer a pass to another person Give the pass to someone else. The pass is re-keyed: every identifier the old holder could present is revoked and a new barcode issued, so their copy stops working at the door. Follows the pass policy (transfers are off unless the event or ticket type allows them) and is refused once the pass is scanned or activated. Recorded in the pass's holder history.

Parameters#

Parameter	Type
`passId`	`string`
`request`	{ `customerId?`: `any`; `email?`: `any`; `name`: `string`; `reason?`: `any`; }
`request.customerId?`	`any`
`request.email?`	`any`
`request.name?`	`string`
`request.reason?`	`any`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

transferPass