Reference

BackstageClient.scanConfigs

BackstageClient.scanConfigs in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / scanConfigs

scanConfigs: {
  create: (request: {
     accountId: string;
     allowedKinds: ("validate" | "redeem" | "reverse")[];
     entitlementFilter?: {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
     };
     eventFilter: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates?: string[];
     isTest?: boolean;
     name: string;
     validFrom?: string;
     validUntil?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     allowedKinds: ("validate" | "redeem" | "reverse")[];
     createdAt: string;
     deviceIds?: string[];
     entitlementFilter:   | {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
      }
        | null;
     eventFilter: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates: string[] | null;
     id: string;
     isTest: boolean;
     name: string;
     status: string;
     updatedAt: string;
     validFrom: string | null;
     validUntil: string | null;
  }>;
  delete: (configId: string, requestOptions?: RequestOptions) => Promise<boolean>;
  get: (configId: string, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     allowedKinds: ("validate" | "redeem" | "reverse")[];
     createdAt: string;
     deviceIds?: string[];
     entitlementFilter:   | {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
      }
        | null;
     eventFilter: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates: string[] | null;
     id: string;
     isTest: boolean;
     name: string;
     status: string;
     updatedAt: string;
     validFrom: string | null;
     validUntil: string | null;
  }>;
  list: (requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     allowedKinds: ("validate" | "redeem" | "reverse")[];
     createdAt: string;
     deviceIds?: string[];
     entitlementFilter:   | {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
      }
        | null;
     eventFilter: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates: string[] | null;
     id: string;
     isTest: boolean;
     name: string;
     status: string;
     updatedAt: string;
     validFrom: string | null;
     validUntil: string | null;
  }[]>;
  setDevices: (configId: string, request: {
     deviceIds: string[];
  }, requestOptions?: RequestOptions) => Promise<string[]>;
  update: (configId: string, request: {
     accountId?: string;
     allowedKinds?: ("validate" | "redeem" | "reverse")[];
     entitlementFilter?: {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
     };
     eventFilter?: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates?: string[];
     isTest?: boolean;
     name?: string;
     status?: "active" | "archived";
     validFrom?: string;
     validUntil?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     accountId: string;
     allowedKinds: ("validate" | "redeem" | "reverse")[];
     createdAt: string;
     deviceIds?: string[];
     entitlementFilter:   | {
        entitlementIds?: string[];
        tags?: string[];
        ticketTypeIds?: string[];
        types?: string[];
      }
        | null;
     eventFilter: {
        eventIds?: string[];
        mode: "occurrences" | "all" | "events";
        occurrenceIds?: string[];
     };
     gates: string[] | null;
     id: string;
     isTest: boolean;
     name: string;
     status: string;
     updatedAt: string;
     validFrom: string | null;
     validUntil: string | null;
  }>;
};

Defined in: client.ts:9281

Scan Configs methods

create()#

create: (request: {
  accountId: string;
  allowedKinds: ("validate" | "redeem" | "reverse")[];
  entitlementFilter?: {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
  };
  eventFilter: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates?: string[];
  isTest?: boolean;
  name: string;
  validFrom?: string;
  validUntil?: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  allowedKinds: ("validate" | "redeem" | "reverse")[];
  createdAt: string;
  deviceIds?: string[];
  entitlementFilter:   | {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
   }
     | null;
  eventFilter: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates: string[] | null;
  id: string;
  isTest: boolean;
  name: string;
  status: string;
  updatedAt: string;
  validFrom: string | null;
  validUntil: string | null;
}>;

Create a scan configuration Create a scanner scope (events + entitlement/gate/time filters + allowed operations). Delegation-gated: the author must hold entitlements.redeem on the account.

Parameters#

Parameter	Type
`request`	{ `accountId`: `string`; `allowedKinds`: (`"validate"` \| `"redeem"` \| `"reverse"`)[]; `entitlementFilter?`: { `entitlementIds?`: `string`[]; `tags?`: `string`[]; `ticketTypeIds?`: `string`[]; `types?`: `string`[]; }; `eventFilter`: { `eventIds?`: `string`[]; `mode`: `"occurrences"` \| `"all"` \| `"events"`; `occurrenceIds?`: `string`[]; }; `gates?`: `string`[]; `isTest?`: `boolean`; `name`: `string`; `validFrom?`: `string`; `validUntil?`: `string`; }
`request.accountId`	`string`
`request.allowedKinds?`	(`"validate"` \| `"redeem"` \| `"reverse"`)[]
`request.entitlementFilter?`	{ `entitlementIds?`: `string`[]; `tags?`: `string`[]; `ticketTypeIds?`: `string`[]; `types?`: `string`[]; }
`request.entitlementFilter.entitlementIds?`	`string`[]
`request.entitlementFilter.tags?`	`string`[]
`request.entitlementFilter.ticketTypeIds?`	`string`[]
`request.entitlementFilter.types?`	`string`[]
`request.eventFilter?`	{ `eventIds?`: `string`[]; `mode`: `"occurrences"` \| `"all"` \| `"events"`; `occurrenceIds?`: `string`[]; }
`request.eventFilter.eventIds?`	`string`[]
`request.eventFilter.mode?`	`"occurrences"` \| `"all"` \| `"events"`
`request.eventFilter.occurrenceIds?`	`string`[]
`request.gates?`	`string`[]
`request.isTest?`	`boolean`
`request.name?`	`string`
`request.validFrom?`	`string`
`request.validUntil?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ accountId: string; allowedKinds: ("validate" | "redeem" | "reverse")[]; createdAt: string; deviceIds?: string[]; entitlementFilter: | { entitlementIds?: string[]; tags?: string[]; ticketTypeIds?: string[]; types?: string[]; } | null; eventFilter: { eventIds?: string[]; mode: "occurrences" | "all" | "events"; occurrenceIds?: string[]; }; gates: string[] | null; id: string; isTest: boolean; name: string; status: string; updatedAt: string; validFrom: string | null; validUntil: string | null; }>

Operation Id#

createScanConfig

delete()#

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

Delete a scan configuration

Parameters#

Parameter	Type
`configId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<boolean>

Operation Id#

deleteScanConfig

get()#

get: (configId: string, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  allowedKinds: ("validate" | "redeem" | "reverse")[];
  createdAt: string;
  deviceIds?: string[];
  entitlementFilter:   | {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
   }
     | null;
  eventFilter: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates: string[] | null;
  id: string;
  isTest: boolean;
  name: string;
  status: string;
  updatedAt: string;
  validFrom: string | null;
  validUntil: string | null;
}>;

Get a scan configuration

Parameters#

Parameter	Type
`configId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

getScanConfig

list()#

list: (requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  allowedKinds: ("validate" | "redeem" | "reverse")[];
  createdAt: string;
  deviceIds?: string[];
  entitlementFilter:   | {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
   }
     | null;
  eventFilter: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates: string[] | null;
  id: string;
  isTest: boolean;
  name: string;
  status: string;
  updatedAt: string;
  validFrom: string | null;
  validUntil: string | null;
}[]>;

List scan configurations

Parameters#

Parameter	Type
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listScanConfigs

setDevices()#

setDevices: (configId: string, request: {
  deviceIds: string[];
}, requestOptions?: RequestOptions) => Promise<string[]>;

Assign scanner devices to a configuration Replace the set of scanner devices driven by this config. A device has at most one active config.

Parameters#

Parameter	Type
`configId`	`string`
`request`	{ `deviceIds`: `string`[]; }
`request.deviceIds`	`string`[]
`requestOptions?`	`RequestOptions`

Returns#

Promise<string[]>

Operation Id#

setScanConfigDevices

update()#

update: (configId: string, request: {
  accountId?: string;
  allowedKinds?: ("validate" | "redeem" | "reverse")[];
  entitlementFilter?: {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
  };
  eventFilter?: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates?: string[];
  isTest?: boolean;
  name?: string;
  status?: "active" | "archived";
  validFrom?: string;
  validUntil?: string;
}, requestOptions?: RequestOptions) => Promise<{
  accountId: string;
  allowedKinds: ("validate" | "redeem" | "reverse")[];
  createdAt: string;
  deviceIds?: string[];
  entitlementFilter:   | {
     entitlementIds?: string[];
     tags?: string[];
     ticketTypeIds?: string[];
     types?: string[];
   }
     | null;
  eventFilter: {
     eventIds?: string[];
     mode: "occurrences" | "all" | "events";
     occurrenceIds?: string[];
  };
  gates: string[] | null;
  id: string;
  isTest: boolean;
  name: string;
  status: string;
  updatedAt: string;
  validFrom: string | null;
  validUntil: string | null;
}>;

Update a scan configuration

Parameters#

Parameter	Type
`configId`	`string`
`request`	{ `accountId?`: `string`; `allowedKinds?`: (`"validate"` \| `"redeem"` \| `"reverse"`)[]; `entitlementFilter?`: { `entitlementIds?`: `string`[]; `tags?`: `string`[]; `ticketTypeIds?`: `string`[]; `types?`: `string`[]; }; `eventFilter?`: { `eventIds?`: `string`[]; `mode`: `"occurrences"` \| `"all"` \| `"events"`; `occurrenceIds?`: `string`[]; }; `gates?`: `string`[]; `isTest?`: `boolean`; `name?`: `string`; `status?`: `"active"` \| `"archived"`; `validFrom?`: `string`; `validUntil?`: `string`; }
`request.accountId?`	`string`
`request.allowedKinds?`	(`"validate"` \| `"redeem"` \| `"reverse"`)[]
`request.entitlementFilter?`	{ `entitlementIds?`: `string`[]; `tags?`: `string`[]; `ticketTypeIds?`: `string`[]; `types?`: `string`[]; }
`request.entitlementFilter.entitlementIds?`	`string`[]
`request.entitlementFilter.tags?`	`string`[]
`request.entitlementFilter.ticketTypeIds?`	`string`[]
`request.entitlementFilter.types?`	`string`[]
`request.eventFilter?`	{ `eventIds?`: `string`[]; `mode`: `"occurrences"` \| `"all"` \| `"events"`; `occurrenceIds?`: `string`[]; }
`request.eventFilter.eventIds?`	`string`[]
`request.eventFilter.mode?`	`"occurrences"` \| `"all"` \| `"events"`
`request.eventFilter.occurrenceIds?`	`string`[]
`request.gates?`	`string`[]
`request.isTest?`	`boolean`
`request.name?`	`string`
`request.status?`	`"active"` \| `"archived"`
`request.validFrom?`	`string`
`request.validUntil?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

updateScanConfig