Skip to content
Docs
Open Backstage
Reference

BackstageClient.clientVersions

BackstageClient.clientVersions in @ticketlayer/backstage.

@ticketlayer/backstage

@ticketlayer/backstage / BackstageClient / clientVersions

clientVersions: {
  list: (options?: {
     days?: number;
   }, requestOptions?: RequestOptions) => Promise<{
     capabilities: ("redirect" | "complete_form" | "await_approval")[];
     datedVersion: string;
     datedVersionStatus: "current" | "supported" | "deprecated" | "sunset" | "unknown";
     firstSeenAt: string;
     lastSeenAt: string;
     needsUpgrade: boolean;
     package: string;
     requestCount: number;
     runtime: string;
     version: string;
  }[]>;
};

Defined in: client.ts:10710

Client Versions methods

list()#

list: (options?: {
  days?: number;
}, requestOptions?: RequestOptions) => Promise<{
  capabilities: ("redirect" | "complete_form" | "await_approval")[];
  datedVersion: string;
  datedVersionStatus: "current" | "supported" | "deprecated" | "sunset" | "unknown";
  firstSeenAt: string;
  lastSeenAt: string;
  needsUpgrade: boolean;
  package: string;
  requestCount: number;
  runtime: string;
  version: string;
}[]>;

List client versions in use The SDK builds this organisation's own traffic came from over a window of recent days, rolled up daily from the TL-Client request header. One row per package, package version, dated API version, runtime family and declared TL-Client-Capabilities, most recently seen first. The header is caller-supplied, so these are labels for aggregation: nothing is authorised or gated on them. Users only (requires settings.read).

Parameters#

ParameterType
options?{ days?: number; }
options.days?number
requestOptions?RequestOptions

Returns#

Promise<{ capabilities: ("redirect" | "complete_form" | "await_approval")[]; datedVersion: string; datedVersionStatus: "current" | "supported" | "deprecated" | "sunset" | "unknown"; firstSeenAt: string; lastSeenAt: string; needsUpgrade: boolean; package: string; requestCount: number; runtime: string; version: string; }[]>

Operation Id#

listClientVersions