@compassdigital/sdk.typescript 4.140.0 → 4.143.0

package/lib/messages/commands/FakeCommand.d.ts

@@ -0,0 +1,14 @@
+export interface FakeCommand {
+    id: string;
+    type: 'FakeCommand';
+    version: '0.0.1';
+    timestamp: string;
+    traceContext: {
+        traceId?: string;
+    };
+    payload: {
+        foo: string;
+    };
+    source: string;
+}
+//# sourceMappingURL=FakeCommand.d.ts.map

package/lib/messages/commands/FakeCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeCommand.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/FakeCommand.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}

package/lib/messages/commands/FakeCommand.js

@@ -0,0 +1,4 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FakeCommand.js.map

package/lib/messages/commands/FakeCommand.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeCommand.js","sourceRoot":"","sources":["../../../src/messages/commands/FakeCommand.ts"],"names":[],"mappings":";AAAA,sDAAsD"}

package/lib/messages/commands/index.d.ts

@@ -1,2 +1,3 @@
+export { FakeCommand } from './FakeCommand';
 export { SendPushNotificationCommand } from './SendPushNotificationCommand';
 //# sourceMappingURL=index.d.ts.map

package/lib/messages/commands/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/commands/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC"}

package/lib/messages/events/FakeEvent.d.ts

@@ -0,0 +1,14 @@
+export interface FakeEvent {
+    id: string;
+    type: 'FakeEvent';
+    version: '0.0.1';
+    timestamp: string;
+    traceContext: {
+        traceId?: string;
+    };
+    payload: {
+        foo: string;
+    };
+    source: string;
+}
+//# sourceMappingURL=FakeEvent.d.ts.map

package/lib/messages/events/FakeEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeEvent.d.ts","sourceRoot":"","sources":["../../../src/messages/events/FakeEvent.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,SAAS;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,WAAW,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;CACf"}

package/lib/messages/events/FakeEvent.js

@@ -0,0 +1,4 @@
+"use strict";
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=FakeEvent.js.map

package/lib/messages/events/FakeEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FakeEvent.js","sourceRoot":"","sources":["../../../src/messages/events/FakeEvent.ts"],"names":[],"mappings":";AAAA,sDAAsD"}

package/lib/messages/events/index.d.ts

@@ -1 +1,2 @@
+export { FakeEvent } from './FakeEvent';
 //# sourceMappingURL=index.d.ts.map

package/lib/messages/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/messages/events/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/lib/messages/events/index.js

@@ -1,3 +1,4 @@
 "use strict";
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=index.js.map

package/package.json

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

package/src/interface/catalog.ts

@@ -10,9 +10,29 @@ export interface CatalogResponseDTO {
 	display: Record<string, any>;
 	meta: Record<string, any> | null;
 	items: Record<string, any> | null;
+	created_at: string;
+	updated_at: string;
 }
 
-export type CatalogItemResponseDTO = Record<string, any>;
+export interface CatalogItemResponseDTO {
+	id: number;
+	catalog_id: number;
+	item_id: string;
+	name: string;
+	label?: string;
+	description?: string;
+	price: number;
+	overrides?: Record<string, any>;
+	options: Record<string, any>;
+	barcode?: string;
+	reporting?: Record<string, any>;
+	tax?: Record<string, any>;
+	is_visible: boolean;
+	is_out_of_stock: boolean;
+	meta: Record<string, any>;
+	created_at: string;
+	updated_at: string;
+}
 
 export interface PaginationQueryDTO {
 	// Page number
@@ -32,7 +52,47 @@ export interface ListParamsDTO {
 	filter?: FilterQueryDTO;
 }
 
-export type CatalogItemsListResponseDTO = Record<string, any>;
+export interface CatalogItemRecord {
+	id: number;
+	catalog_id: number;
+	item_id: string;
+	name: string;
+	label?: string;
+	description?: string;
+	price: number;
+	overrides?: Record<string, any>;
+	options: Record<string, any>;
+	barcode?: string;
+	reporting?: Record<string, any>;
+	tax?: Record<string, any>;
+	is_visible: boolean;
+	is_out_of_stock: boolean;
+	meta: Record<string, any>;
+	created_at: string;
+	updated_at: string;
+}
+
+export interface MetaData {
+	// Total number of results
+	total_results: number;
+	// Total number of pages
+	total_pages: number;
+	// Number of results on this page
+	result_count: number;
+	// Number of results per page
+	limit?: number;
+	// Current page number
+	page?: number;
+	// Field to sort by
+	sort_by?: string;
+	// Sort order
+	order?: 'ASC' | 'DESC';
+}
+
+export interface CatalogItemsListResponseDTO {
+	results: CatalogItemRecord[];
+	meta: MetaData;
+}
 
 export interface SearchConditionDTO {
 	// Contains search term
@@ -55,7 +115,36 @@ export interface SearchConditionDTO {
 	lessThanOrEqual?: Record<string, any>;
 }
 
-export type BaseItemDTO = Record<string, any>;
+export interface DeleteCatalogItemResponseDTO {
+	id: number;
+	catalog_id: number;
+	item_id: string;
+	name: string;
+	label?: string;
+	description?: string;
+	price: number;
+	overrides?: Record<string, any>;
+	options: Record<string, any>;
+	barcode?: string;
+	reporting?: Record<string, any>;
+	tax?: Record<string, any>;
+	is_visible: boolean;
+	is_out_of_stock: boolean;
+	meta: Record<string, any>;
+}
+
+export interface BaseItemResponseDTO {
+	id: string;
+	name: string;
+	description: string;
+	price: number;
+	barcode: string;
+	reporting: Record<string, any>;
+	tax: Record<string, any>;
+	meta: Record<string, any>;
+	created_at: string;
+	updated_at: string;
+}
 
 // GET /catalog/status - Get the status of the Catalog service
 
@@ -175,7 +264,19 @@ export interface PostCatalogItemsBulkPath {
 	id: number;
 }
 
-export type PostCatalogItemsBulkBody = string[];
+export type PostCatalogItemsBulkBody = {
+	base_item_id?: string;
+	name?: string;
+	catalog_item_id?: number | null;
+	label?: string | null;
+	description?: string | null;
+	price?: number | null;
+	overrides?: Record<string, any> | null;
+	options?: Record<string, any> | null;
+	meta?: Record<string, any> | null;
+	is_visible?: boolean | null;
+	is_out_of_stock?: boolean | null;
+}[];
 
 export type PostCatalogItemsBulkResponse = CatalogItemResponseDTO[];
 
@@ -216,7 +317,7 @@ export interface DeleteCatalogItemPath {
 	id: number;
 }
 
-export type DeleteCatalogItemResponse = CatalogItemResponseDTO;
+export type DeleteCatalogItemResponse = DeleteCatalogItemResponseDTO;
 
 export interface DeleteCatalogItemRequest extends BaseRequest, DeleteCatalogItemPath {}
 
@@ -279,7 +380,7 @@ export interface PostCatalogBaseItemBody {
 	meta?: Record<string, any> | null;
 }
 
-export type PostCatalogBaseItemResponse = BaseItemDTO;
+export type PostCatalogBaseItemResponse = BaseItemResponseDTO;
 
 export interface PostCatalogBaseItemRequest extends BaseRequest {
 	body: PostCatalogBaseItemBody;
@@ -298,7 +399,7 @@ export interface GetCatalogBaseItemsBody {
 	offset?: number;
 }
 
-export type GetCatalogBaseItemsResponse = BaseItemDTO[];
+export type GetCatalogBaseItemsResponse = BaseItemResponseDTO[];
 
 export interface GetCatalogBaseItemsRequest
 	extends BaseRequest,
@@ -317,7 +418,7 @@ export interface GetCatalogBaseItemQuery {
 	_query?: string;
 }
 
-export type GetCatalogBaseItemResponse = BaseItemDTO;
+export type GetCatalogBaseItemResponse = BaseItemResponseDTO;
 
 export interface GetCatalogBaseItemRequest
 	extends BaseRequest,

package/src/interface/menu.ts

@@ -454,6 +454,7 @@ export interface DraftBrandDTO {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	permissions?: Record<string, any>;
@@ -464,6 +465,11 @@ export interface BrandMeta {
 	jde_category?: string;
 }
 
+export interface SupportedLanguages {
+	fr?: string;
+	kvi?: string;
+}
+
 export interface PublishedBrandDTO {
 	published_catalog_id?: number;
 	id?: string;
@@ -482,6 +488,7 @@ export interface PublishedBrandDTO {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: Record<string, any>;
+	supported_languages?: Record<string, any>;
 	version?: number;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -3093,6 +3100,7 @@ export interface PostMenuV3DraftBrandBody {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3166,6 +3174,7 @@ export interface PatchMenuV3DraftBrandBody {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -3261,6 +3270,7 @@ export type PostMenuV3DraftBrandsBody = {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3788,6 +3798,7 @@ export interface PostMenuV3BrandBody {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
 	attachments?: FileAttachmentsDTO;
@@ -3859,6 +3870,7 @@ export interface PatchMenuV3BrandBody {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	version?: number;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
@@ -3954,6 +3966,7 @@ export type PostMenuV3BrandsBody = {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	local_menu_group?: LocalMenuGroupDTO;
 	global_menu_group?: GlobalMenuGroupDTO;
 	attachments?: FileAttachmentsDTO;
@@ -7407,6 +7420,7 @@ export interface PostMenuV4BrandBody {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	changes?: BrandChangeDTO[];
 	local_menu_group?: LocalMenuGroupDTO;
@@ -7449,6 +7463,7 @@ export interface PostMenuV4BrandResponse {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -7508,6 +7523,7 @@ export interface GetMenuV4BrandResponse {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];
@@ -7562,6 +7578,7 @@ export interface DeleteMenuV4BrandResponse {
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	changes?: BrandChangeDTO[];

package/src/messages/commands/FakeCommand.ts

@@ -0,0 +1,15 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface FakeCommand {
+	id: string;
+	type: 'FakeCommand';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		foo: string;
+	};
+	source: string;
+}

package/src/messages/commands/index.ts

@@ -1,3 +1,5 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export { FakeCommand } from './FakeCommand';
+
 export { SendPushNotificationCommand } from './SendPushNotificationCommand';

package/src/messages/events/FakeEvent.ts

@@ -0,0 +1,15 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface FakeEvent {
+	id: string;
+	type: 'FakeEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		foo: string;
+	};
+	source: string;
+}

package/src/messages/events/index.ts

@@ -1 +1,3 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export { FakeEvent } from './FakeEvent';