@compassdigital/sdk.typescript 4.537.0 → 4.538.0

package/lib/interface/kds.d.ts

@@ -45,6 +45,14 @@ export interface DeviceInfo {
     brands?: string[];
     [index: string]: any;
 }
+export interface DeviceLocations {
+    unit_id: string;
+    location_name: string;
+    location_group: string;
+}
+export interface DeviceLocationsResponse {
+    locations: DeviceLocations[];
+}
 export interface GetKdsDevicesQuery {
     unitNumber: string;
     nocache?: boolean;
@@ -52,6 +60,12 @@ export interface GetKdsDevicesQuery {
 export type GetKdsDevicesResponse = Units;
 export interface GetKdsDevicesRequest extends BaseRequest, RequestQuery<GetKdsDevicesQuery> {
 }
+export interface GetKdsDeviceLocationsQuery {
+    serial_number: string;
+}
+export type GetKdsDeviceLocationsResponse = DeviceLocationsResponse;
+export interface GetKdsDeviceLocationsRequest extends BaseRequest, RequestQuery<GetKdsDeviceLocationsQuery> {
+}
 export type PostKdsDeviceAuthBody = AuthPostBody;
 export type PostKdsDeviceAuthResponse = AuthPostBodyResponse;
 export interface PostKdsDeviceAuthRequest extends BaseRequest {

package/lib/interface/kds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kds.d.ts","sourceRoot":"","sources":["../../src/interface/kds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,OAAO;IACvB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACrB,KAAK,EAAE;QACN,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,EAAE,CAAC;CACJ;AAED,MAAM,WAAW,YAAY;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,EAAE,CAAC,EAAE;QACJ,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,MAAM,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IAE1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAID,MAAM,WAAW,kBAAkB;IAElC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAE1C,MAAM,WAAW,oBAAqB,SAAQ,WAAW,EAAE,YAAY,CAAC,kBAAkB,CAAC;CAAG;AAI9F,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC;AAEjD,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAE7D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC5D,IAAI,EAAE,qBAAqB,CAAC;CAC5B;AAID,MAAM,WAAW,uBAAuB;IAEvC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD,MAAM,WAAW,0BAA2B,SAAQ,WAAW,EAAE,uBAAuB;CAAG;AAI3F,MAAM,WAAW,sBAAsB;IAEtC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC;AAEpD,MAAM,WAAW,yBAA0B,SAAQ,WAAW,EAAE,sBAAsB;IACrF,IAAI,EAAE,sBAAsB,CAAC;CAC7B;AAID,MAAM,WAAW,uBAAuB;IAEvC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,0BAA2B,SAAQ,WAAW,EAAE,uBAAuB;CAAG;AAI3F,MAAM,WAAW,qBAAqB;IACrC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;CAAG"}
+{"version":3,"file":"kds.d.ts","sourceRoot":"","sources":["../../src/interface/kds.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAEnD,MAAM,WAAW,OAAO;IACvB,OAAO,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,KAAK;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,KAAK;IACrB,KAAK,EAAE;QACN,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,EAAE,CAAC;CACJ;AAED,MAAM,WAAW,YAAY;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,EAAE,CAAC,EAAE;QACJ,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,OAAO,CAAC,EAAE,OAAO,CAAC;KAClB,CAAC;IACF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,MAAM,EAAE,UAAU,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IAE1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IAEtB,cAAc,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACvC,SAAS,EAAE,eAAe,EAAE,CAAC;CAC7B;AAID,MAAM,WAAW,kBAAkB;IAElC,UAAU,EAAE,MAAM,CAAC;IAEnB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,CAAC;AAE1C,MAAM,WAAW,oBAAqB,SAAQ,WAAW,EAAE,YAAY,CAAC,kBAAkB,CAAC;CAAG;AAI9F,MAAM,WAAW,0BAA0B;IAE1C,aAAa,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,6BAA6B,GAAG,uBAAuB,CAAC;AAEpE,MAAM,WAAW,4BAChB,SAAQ,WAAW,EAClB,YAAY,CAAC,0BAA0B,CAAC;CAAG;AAI7C,MAAM,MAAM,qBAAqB,GAAG,YAAY,CAAC;AAEjD,MAAM,MAAM,yBAAyB,GAAG,oBAAoB,CAAC;AAE7D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;IAC5D,IAAI,EAAE,qBAAqB,CAAC;CAC5B;AAID,MAAM,WAAW,uBAAuB;IAEvC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,2BAA2B,GAAG,KAAK,CAAC;AAEhD,MAAM,WAAW,0BAA2B,SAAQ,WAAW,EAAE,uBAAuB;CAAG;AAI3F,MAAM,WAAW,sBAAsB;IAEtC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,sBAAsB,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,0BAA0B,GAAG,UAAU,CAAC;AAEpD,MAAM,WAAW,yBAA0B,SAAQ,WAAW,EAAE,sBAAsB;IACrF,IAAI,EAAE,sBAAsB,CAAC;CAC7B;AAID,MAAM,WAAW,uBAAuB;IAEvC,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAElD,MAAM,WAAW,0BAA2B,SAAQ,WAAW,EAAE,uBAAuB;CAAG;AAI3F,MAAM,WAAW,qBAAqB;IACrC,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC;CACrB;AAED,MAAM,WAAW,oBAAqB,SAAQ,WAAW;CAAG"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.537.0",
+	"version": "4.538.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -250,6 +250,8 @@ import {
 import {
 	GetKdsDevicesQuery,
 	GetKdsDevicesResponse,
+	GetKdsDeviceLocationsQuery,
+	GetKdsDeviceLocationsResponse,
 	PostKdsDeviceAuthBody,
 	PostKdsDeviceAuthResponse,
 	DeleteKdsDeviceAuthResponse,
@@ -3812,6 +3814,26 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('kds', '/kds/devices', 'GET', `/kds/devices`, null, options);
 	}
 
+	/**
+	 * GET /kds/device/locations - List unit ids and location names for a serial number
+	 *
+	 * @param options - additional request options
+	 */
+	get_kds_device_locations(
+		options: {
+			query: GetKdsDeviceLocationsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetKdsDeviceLocationsResponse> {
+		return this.request(
+			'kds',
+			'/kds/device/locations',
+			'GET',
+			`/kds/device/locations`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /kds/device/auth - Get auth token for a device
 	 *

package/src/interface/kds.ts

@@ -58,6 +58,17 @@ export interface DeviceInfo {
 	[index: string]: any;
 }
 
+export interface DeviceLocations {
+	unit_id: string;
+	location_name: string;
+	// CDL location group id
+	location_group: string;
+}
+
+export interface DeviceLocationsResponse {
+	locations: DeviceLocations[];
+}
+
 // GET /kds/devices - Get kds devices for a specified unit number
 
 export interface GetKdsDevicesQuery {
@@ -71,6 +82,19 @@ export type GetKdsDevicesResponse = Units;
 
 export interface GetKdsDevicesRequest extends BaseRequest, RequestQuery<GetKdsDevicesQuery> {}
 
+// GET /kds/device/locations - List unit ids and location names for a serial number
+
+export interface GetKdsDeviceLocationsQuery {
+	// KDS device serial number
+	serial_number: string;
+}
+
+export type GetKdsDeviceLocationsResponse = DeviceLocationsResponse;
+
+export interface GetKdsDeviceLocationsRequest
+	extends BaseRequest,
+		RequestQuery<GetKdsDeviceLocationsQuery> {}
+
 // POST /kds/device/auth - Get auth token for a device
 
 export type PostKdsDeviceAuthBody = AuthPostBody;