Reference

BackstageClient.locations

BackstageClient.locations in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / locations

locations: {
  create: (request: {
     accountId: string;
     description?: string;
     name: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     createdAt: string;
     description: string | null;
     id: string;
     name: string;
     updatedAt: string;
  }>;
  delete: (locationId: string, requestOptions?: RequestOptions) => Promise<boolean>;
  get: (locationId: string, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     createdAt: string;
     description: string | null;
     id: string;
     name: string;
     updatedAt: string;
  }>;
  list: (requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     createdAt: string;
     description: string | null;
     id: string;
     name: string;
     updatedAt: string;
  }[]>;
  update: (locationId: string, request: {
     description?: any;
     name?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     createdAt: string;
     description: string | null;
     id: string;
     name: string;
     updatedAt: string;
  }>;
};

Defined in: client.ts:10069

Locations methods

create()#

create: (request: {
  accountId: string;
  description?: string;
  name: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  createdAt: string;
  description: string | null;
  id: string;
  name: string;
  updatedAt: string;
}>;

Create location

Parameters#

Parameter	Type
`request`	{ `accountId`: `string`; `description?`: `string`; `name`: `string`; }
`request.accountId`	`string`
`request.description?`	`string`
`request.name?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; createdAt: string; description: string | null; id: string; name: string; updatedAt: string; }>

Operation Id#

createLocation

delete()#

delete: (locationId: string, requestOptions?: RequestOptions) => Promise<boolean>;

Delete location

Parameters#

Parameter	Type
`locationId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<boolean>

Operation Id#

deleteLocation

get()#

get: (locationId: string, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  createdAt: string;
  description: string | null;
  id: string;
  name: string;
  updatedAt: string;
}>;

Get location

Parameters#

Parameter	Type
`locationId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; createdAt: string; description: string | null; id: string; name: string; updatedAt: string; }>

Operation Id#

getLocation

list()#

list: (requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  createdAt: string;
  description: string | null;
  id: string;
  name: string;
  updatedAt: string;
}[]>;

List locations

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; createdAt: string; description: string | null; id: string; name: string; updatedAt: string; }[]>

Operation Id#

listLocations

update()#

update: (locationId: string, request: {
  description?: any;
  name?: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  createdAt: string;
  description: string | null;
  id: string;
  name: string;
  updatedAt: string;
}>;

Update location

Parameters#

Parameter	Type
`locationId`	`string`
`request`	{ `description?`: `any`; `name?`: `string`; }
`request.description?`	`any`
`request.name?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; createdAt: string; description: string | null; id: string; name: string; updatedAt: string; }>

Operation Id#

updateLocation