@compassdigital/sdk.typescript 4.99.0 → 4.101.0

package/package.json

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

package/src/index.ts

@@ -1075,6 +1075,8 @@ import {
 	GetCentricosSitesResponse,
 	GetReviewOrderItemsQuery,
 	GetReviewOrderItemsResponse,
+	GetCentricosStationQuery,
+	GetCentricosStationResponse,
 } from './interface/centricos';
 
 import {
@@ -10941,7 +10943,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * GET /consumer/customer-orders/{userId} - Get customer orders
 	 *
-	 * @param userId - TODO: add parameter to swagger.json
+	 * @param userId - a valid CDL user id
 	 * @param options - additional request options
 	 */
 	get_customer_orders(
@@ -11249,6 +11251,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /centricos/station/{station_id} - Get station details
+	 *
+	 * @param station_id - TODO: add parameter to swagger.json
+	 * @param options - additional request options
+	 */
+	get_centricos_station(
+		station_id: string,
+		options?: {
+			query?: GetCentricosStationQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetCentricosStationResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/station/{station_id}',
+			'get',
+			`/centricos/station/${station_id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *

package/src/interface/centricos.ts

@@ -107,9 +107,64 @@ export interface GetSitesResponse {
 	results: Site[];
 }
 
+export interface ReviewOrderItem {
+	// Order id
+	id: string;
+	// Taxonomy
+	taxonomy: Record<string, any>;
+	// Rating score
+	score: number;
+	// Review comment
+	comment?: string;
+	// Review tags
+	reason?: ('Freshness' | 'Value for money' | 'Taste' | 'Temperature' | 'Portion')[];
+}
+
 export interface ReviewOrderItemsResponseDTO {
 	// List of reviews
-	reviews: Record<string, any>[][];
+	reviews: ReviewOrderItem[];
+}
+
+export interface Toggle {
+	name: string;
+	label: string;
+	value: boolean;
+}
+
+export interface Data {
+	name: string;
+	label: string;
+	value: string;
+}
+
+export interface Content {
+	label: string;
+	toggles?: Toggle[];
+	data?: Data[];
+}
+
+export interface Integration {
+	id: string;
+	label: string;
+	is_integrated: boolean;
+	is_enabled: boolean;
+	content: Content;
+}
+
+export interface Integrations {
+	thrive: Integration;
+	boost: Integration;
+	nextep: Integration;
+	volante: Integration;
+	agilysys: Integration;
+}
+
+export interface GetStationResponse {
+	id: string;
+	name: string;
+	station_location: string;
+	business_unit: string;
+	integrations: Integrations;
 }
 
 // POST /centricos/ai/item/description - Generate item description
@@ -322,3 +377,22 @@ export interface GetReviewOrderItemsRequest
 	extends BaseRequest,
 		RequestQuery<GetReviewOrderItemsQuery>,
 		GetReviewOrderItemsPath {}
+
+// GET /centricos/station/{station_id} - Get station details
+
+export interface GetCentricosStationPath {
+	// TODO: add parameter to swagger.json
+	station_id: string;
+}
+
+export interface GetCentricosStationQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCentricosStationResponse = GetStationResponse;
+
+export interface GetCentricosStationRequest
+	extends BaseRequest,
+		RequestQuery<GetCentricosStationQuery>,
+		GetCentricosStationPath {}

package/src/interface/consumer.ts

@@ -438,9 +438,13 @@ export interface OrderItemReview {
 	reason?: string[];
 }
 
+export interface DisputedReason {
+	name: string;
+	isSelected: boolean;
+}
+
 export interface Disputed {
-	reasons?: string[];
-	isSelected?: boolean;
+	reasons?: DisputedReason[];
 }
 
 export interface ShoppingcartItem {
@@ -789,7 +793,7 @@ export interface GetPaymentListByBrandRequest
 // GET /consumer/customer-orders/{userId} - Get customer orders
 
 export interface GetCustomerOrdersPath {
-	// TODO: add parameter to swagger.json
+	// a valid CDL user id
 	userId: string;
 }
 

package/src/interface/location.ts

@@ -108,7 +108,7 @@ export interface Brand {
 		{
 			device_type: string;
 			site_device_id: string;
-			business_units: string[];
+			business_units?: string[];
 		}[]
 	>;
 	timeslots?: {
@@ -203,6 +203,13 @@ export interface Brand {
 				mobile_app?: boolean;
 			};
 		};
+		type_of_kds?: {
+			cdl?: boolean;
+			nextep?: boolean;
+			volante?: boolean;
+			agilysys?: boolean;
+			[index: string]: any;
+		};
 		[index: string]: any;
 	};
 	descriptions?: {
@@ -305,6 +312,7 @@ export interface Group {
 		alt_logo?: string | null;
 	};
 	timezone?: string;
+	device_mapping?: Record<string, DeviceMapping[]>;
 	[index: string]: any;
 }
 
@@ -481,6 +489,12 @@ export interface WaitTimeResponse {
 	}[];
 }
 
+export interface DeviceMapping {
+	device_type?: string;
+	site_device_id?: string;
+	name?: string;
+}
+
 // POST /location - Create a new location
 
 export type PostLocationBody = Location;

package/src/interface/menu.ts

@@ -430,6 +430,8 @@ export interface GlobalMenuGroupDTO {
 }
 
 export interface DraftBrandDTO {
+	catalog_id?: number;
+	published_catalog_id?: number;
 	id?: string;
 	name?: string;
 	description?: string;
@@ -441,7 +443,6 @@ export interface DraftBrandDTO {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	permissions?: Record<string, any>;
@@ -464,7 +465,6 @@ export interface PublishedBrandDTO {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: Record<string, any>;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -2867,6 +2867,8 @@ export interface PostMenuV3DraftBrandBody {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	name: string;
 	description?: string;
 	is_active?: boolean;
@@ -2877,7 +2879,6 @@ export interface PostMenuV3DraftBrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
@@ -2936,6 +2937,8 @@ export interface PatchMenuV3DraftBrandBody {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	id?: string;
 	name?: string;
 	description?: string;
@@ -2947,7 +2950,6 @@ export interface PatchMenuV3DraftBrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -3029,6 +3031,8 @@ export type PostMenuV3DraftBrandsBody = {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	name: string;
 	description?: string;
 	is_active?: boolean;
@@ -3039,7 +3043,6 @@ export type PostMenuV3DraftBrandsBody = {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
@@ -3529,7 +3532,6 @@ export interface PostMenuV3BrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
@@ -3599,7 +3601,6 @@ export interface PatchMenuV3BrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	version?: number;
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3693,7 +3694,6 @@ export type PostMenuV3BrandsBody = {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
@@ -7099,6 +7099,8 @@ export interface PostMenuV4BrandBody {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	name: string;
 	description?: string;
 	is_active?: boolean;
@@ -7109,7 +7111,6 @@ export interface PostMenuV4BrandBody {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
@@ -7134,6 +7135,8 @@ export interface PostMenuV4BrandResponse {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -7148,7 +7151,6 @@ export interface PostMenuV4BrandResponse {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -7189,6 +7191,8 @@ export interface GetMenuV4BrandResponse {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -7203,7 +7207,6 @@ export interface GetMenuV4BrandResponse {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
@@ -7240,6 +7243,8 @@ export interface DeleteMenuV4BrandResponse {
 	modifiers?: DraftModifierDTO[];
 	statuses?: BrandStatusDTO[];
 	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
 	id: string;
 	created_at?: string;
 	updated_at?: string;
@@ -7254,7 +7259,6 @@ export interface DeleteMenuV4BrandResponse {
 	posid_segment?: string;
 	is_simplified_view?: boolean;
 	frictionless_partner?: string;
-	catalog_id?: number;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;