Reference

BackstageClient.partners

BackstageClient.partners in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / partners

partners: {
  createAccount: (request: {
     channelName?: string;
     channelSlug?: string;
     name: string;
     status?: "active" | "inactive";
   }, requestOptions?: RequestOptions) => Promise<{
     account: {
        createdAt: string;
        id: string;
        isDeleted: boolean;
        name: string;
        organisationId: string;
        status: "active" | "inactive";
        updatedAt: string;
     };
     publishableKey: {
        id: string;
        key: string;
     };
     salesChannel: {
        channelType: string;
        id: string;
        slug: string;
     };
  }>;
};

Defined in: client.ts:1865

Partners methods

createAccount()#

createAccount: (request: {
  channelName?: string;
  channelSlug?: string;
  name: string;
  status?: "active" | "inactive";
}, requestOptions?: RequestOptions) => Promise<{
  account: {
     createdAt: string;
     id: string;
     isDeleted: boolean;
     name: string;
     organisationId: string;
     status: "active" | "inactive";
     updatedAt: string;
  };
  publishableKey: {
     id: string;
     key: string;
  };
  salesChannel: {
     channelType: string;
     id: string;
     slug: string;
  };
}>;

Provision a partner customer account For a partner server authenticated with an organisation API key (tlak_). Creates an account inside the caller's organisation, a website sales channel for it and a publishable key. Requires the accounts.write, saleschannels.write and saleschannelkeys.write scopes.

Parameters#

Parameter	Type
`request`	{ `channelName?`: `string`; `channelSlug?`: `string`; `name`: `string`; `status?`: `"active"` \| `"inactive"`; }
`request.channelName?`	`string`
`request.channelSlug?`	`string`
`request.name?`	`string`
`request.status?`	`"active"` \| `"inactive"`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ account: { createdAt: string; id: string; isDeleted: boolean; name: string; organisationId: string; status: "active" | "inactive"; updatedAt: string; }; publishableKey: { id: string; key: string; }; salesChannel: { channelType: string; id: string; slug: string; }; }>

Operation Id#

createPartnerAccount