@compassdigital/sdk.typescript 4.680.0 → 4.682.0

package/package.json

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

package/src/interface/location.ts

@@ -248,6 +248,7 @@ export interface Brand {
 		max_showcase_items?: number;
 		jde_category?: string;
 		software_integrations?: SoftwareIntegrations;
+		// @deprecated
 		type_of_kds?: {
 			cdl?: boolean;
 			nextep?: boolean;

package/src/interface/menu.ts

@@ -575,8 +575,8 @@ export interface PublishedBrandDTO {
 	posid_segment?: string;
 	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
-	meta?: Record<string, any>;
-	supported_languages?: Record<string, any>;
+	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
 	archived_at?: string;
 	version?: number;
 	permissions?: Record<string, any>;
@@ -679,7 +679,7 @@ export interface FilterFieldDTO {
 	// Can be combined with other operators (such as '{ key : { $not : { $more_than: 2 } } }')
 	$not?: string;
 	$in?: string[];
-	$and?: Record<string, any>[];
+	$and?: FilterFieldDTO[];
 	$array_contains?: string[];
 	$contains?: string;
 }
@@ -758,10 +758,10 @@ export interface BrandChangeDTO {
 }
 
 export interface DraftMenuDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
 	categories?: DraftCategoryDTO[];
-	stocks?: Record<string, any>[];
+	stocks?: StockDTO[];
 	station_id?: string;
 	price_level_id?: string;
 	id?: string;
@@ -777,8 +777,8 @@ export interface DraftMenuDTO {
 	brand?: DraftBrandDTO;
 	changes?: MenuChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	menu_category_items?: Record<string, any>[];
-	attachments?: Record<string, any>;
+	menu_category_items?: MenuCategoryItemsDTO[];
+	attachments?: FileAttachmentsDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -788,8 +788,8 @@ export interface NameTranslation {
 }
 
 export interface DraftCategoryDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftCategoryDTO;
+	children?: DraftCategoryDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -801,23 +801,23 @@ export interface DraftCategoryDTO {
 	is_active?: boolean;
 	brand_id?: string;
 	menu_id?: string;
-	translation?: Record<string, any>;
+	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
-	menu?: Record<string, any>;
+	menu?: DraftMenuDTO;
 	items?: DraftCategoryToItemRelationshipDTO[];
 	brand?: DraftBrandDTO;
 	changes?: CategoryChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
-	menu_category_items?: Record<string, any>[];
-	attachments?: Record<string, any>;
+	menu_category_items?: MenuCategoryItemsDTO[];
+	attachments?: FileAttachmentsDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface DraftCategoryToItemRelationshipDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftCategoryToItemRelationshipDTO;
+	children?: DraftCategoryToItemRelationshipDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -829,7 +829,7 @@ export interface DraftCategoryToItemRelationshipDTO {
 	sequence?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
-	category?: Record<string, any>;
+	category?: DraftCategoryDTO;
 	item?: DraftItemDTO;
 	brand?: DraftBrandDTO;
 	changes?: CategoryToItemRelationshipChangeDTO[];
@@ -840,8 +840,8 @@ export interface DraftCategoryToItemRelationshipDTO {
 
 export interface DraftItemDTO {
 	is_published?: boolean;
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftItemDTO;
+	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
 	cpg_item?: UniversalItemDTO;
 	stocks?: StockDTO[];
@@ -856,7 +856,7 @@ export interface DraftItemDTO {
 	name_on_pos?: string;
 	label?: string;
 	description?: string;
-	reporting?: Record<string, any>;
+	reporting?: ReportingMetadataDTO;
 	price?: number;
 	barcode?: string;
 	calories?: number;
@@ -869,7 +869,7 @@ export interface DraftItemDTO {
 	brand_id?: string;
 	line_route?: string;
 	posid_segment?: number;
-	menu_works?: Record<string, any>;
+	menu_works?: MenuWorksDTO;
 	is_out_of_stock?: boolean;
 	tax_tag_code?: string;
 	tags?: string[];
@@ -883,19 +883,19 @@ export interface DraftItemDTO {
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	brand?: DraftBrandDTO;
-	categories?: Record<string, any>[];
+	categories?: DraftCategoryToItemRelationshipDTO[];
 	changes?: ItemChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
 	menu_category_items?: MenuCategoryItemsDTO[];
-	attachments?: Record<string, any>;
-	weight?: Record<string, any>;
+	attachments?: FileAttachmentsDTO;
+	weight?: WeightDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
 
 export interface DraftItemToModifierGroupRelationshipDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftItemToModifierGroupRelationshipDTO;
+	children?: DraftItemToModifierGroupRelationshipDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -907,7 +907,7 @@ export interface DraftItemToModifierGroupRelationshipDTO {
 	sequence?: number;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
-	item?: Record<string, any>;
+	item?: DraftItemDTO;
 	modifier_group?: DraftModifierGroupDTO;
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
@@ -917,10 +917,10 @@ export interface DraftItemToModifierGroupRelationshipDTO {
 }
 
 export interface DraftModifierGroupDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftModifierGroupDTO;
+	children?: DraftModifierGroupDTO[];
 	modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
-	items?: Record<string, any>[];
+	items?: DraftItemToModifierGroupRelationshipDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -937,7 +937,7 @@ export interface DraftModifierGroupDTO {
 	sizing?: string;
 	is_out_of_stock?: boolean;
 	is_incremental?: boolean;
-	translation?: Record<string, any>;
+	translation?: NameTranslation;
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	brand?: DraftBrandDTO;
@@ -948,8 +948,8 @@ export interface DraftModifierGroupDTO {
 }
 
 export interface DraftModifierGroupToModifierRelationshipDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
+	parent?: DraftModifierGroupToModifierRelationshipDTO;
+	children?: DraftModifierGroupToModifierRelationshipDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -962,7 +962,7 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
 	applied_diff_snapshot?: Record<string, any>;
 	version?: number;
 	modifier?: DraftModifierDTO;
-	modifier_group?: Record<string, any>;
+	modifier_group?: DraftModifierGroupDTO;
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
@@ -971,9 +971,9 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
 }
 
 export interface DraftModifierDTO {
-	parent?: Record<string, any>;
-	children?: Record<string, any>[];
-	modifier_groups?: Record<string, any>[];
+	parent?: DraftModifierDTO;
+	children?: DraftModifierDTO[];
+	modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
 	id?: string;
 	created_at?: string;
 	updated_at?: string;
@@ -1029,7 +1029,7 @@ export interface ModifierChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftModifierDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1082,16 +1082,16 @@ export interface AllergenDTO {
 
 export interface NutritionDTO {
 	calories?: NutritionValueDTO;
-	total_fat?: Record<string, any>;
-	saturated_fat?: Record<string, any>;
-	total_carbohydrate?: Record<string, any>;
-	total_sugars?: Record<string, any>;
-	protein?: Record<string, any>;
-	dietary_fiber?: Record<string, any>;
-	sodium?: Record<string, any>;
-	trans_fat?: Record<string, any>;
-	cholesterol?: Record<string, any>;
-	added_sugars?: Record<string, any>;
+	total_fat?: NutritionValueDTO;
+	saturated_fat?: NutritionValueDTO;
+	total_carbohydrate?: NutritionValueDTO;
+	total_sugars?: NutritionValueDTO;
+	protein?: NutritionValueDTO;
+	dietary_fiber?: NutritionValueDTO;
+	sodium?: NutritionValueDTO;
+	trans_fat?: NutritionValueDTO;
+	cholesterol?: NutritionValueDTO;
+	added_sugars?: NutritionValueDTO;
 	[index: string]: any;
 }
 
@@ -1118,7 +1118,7 @@ export interface ModifierGroupToModifierRelationshipChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftModifierGroupToModifierRelationshipDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1132,7 +1132,7 @@ export interface ModifierGroupChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftModifierGroupDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1146,7 +1146,7 @@ export interface ItemToModifierGroupRelationshipChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftItemToModifierGroupRelationshipDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1160,7 +1160,7 @@ export interface ItemChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftItemDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1194,7 +1194,7 @@ export interface StockDTO {
 	deleted_at?: string;
 	business_unit_id?: string;
 	version?: number;
-	menu?: Record<string, any>;
+	menu?: DraftMenuDTO;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -1210,9 +1210,9 @@ export interface MenuCategoryItemsDTO {
 	updated_at?: string;
 	deleted_at?: string;
 	version?: number;
-	item?: Record<string, any>;
-	menu?: Record<string, any>;
-	category?: Record<string, any>;
+	item?: DraftItemDTO;
+	menu?: DraftMenuDTO;
+	category?: DraftCategoryDTO;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -1227,7 +1227,7 @@ export interface CategoryToItemRelationshipChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftCategoryToItemRelationshipDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1241,7 +1241,7 @@ export interface CategoryChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftCategoryDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1255,7 +1255,7 @@ export interface MenuChangeDTO {
 	delete?: Record<string, any>;
 	snapshot_entity_id?: string;
 	version?: number;
-	snapshot_entity?: Record<string, any>;
+	snapshot_entity?: DraftMenuDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1351,7 +1351,7 @@ export interface GlobalDiffDependencyDTO {
 	deleted_at?: string;
 	version?: number;
 	depends_on?: GlobalDiffDTO;
-	is_depended_by?: Record<string, any>;
+	is_depended_by?: GlobalDiffDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1371,8 +1371,8 @@ export interface GlobalDiffDTO {
 	global_snapshot?: Record<string, any>;
 	brand_id?: string;
 	version?: number;
-	depends_on?: Record<string, any>[];
-	is_depended_by?: Record<string, any>[];
+	depends_on?: GlobalDiffDependencyDTO[];
+	is_depended_by?: GlobalDiffDependencyDTO[];
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -1384,7 +1384,7 @@ export interface DiffDTO {
 	created_at?: string;
 	updated_at?: string;
 	deleted_at?: string;
-	child_nodes?: Record<string, any>[];
+	child_nodes?: DiffDTO[];
 	name?: string;
 	entity_type?: string;
 	local_id?: string;
@@ -1619,14 +1619,14 @@ export interface IsStockUpdate {
 
 export interface ModifierGroupStockUpdate {
 	id: string;
-	is?: Record<string, any>;
+	is?: IsStockUpdate;
 	items?: ModifierStockUpdate[];
 	[index: string]: any;
 }
 
 export interface ModifierStockUpdate {
 	id: string;
-	is?: Record<string, any>;
+	is?: IsStockUpdate;
 	[index: string]: any;
 }
 
@@ -1657,11 +1657,11 @@ export interface V2CategoryLabelDTO {
 
 export interface V2ItemDTO {
 	id?: string;
-	label?: Record<string, any>;
-	description?: Record<string, any>;
+	label?: V2MenuLabelDTO;
+	description?: V2MenuLabelDTO;
 	price?: V2PriceDTO;
 	meal_value?: number;
-	sale_price?: Record<string, any>;
+	sale_price?: V2PriceDTO;
 	unit?: number;
 	ingredients?: Record<string, any>;
 	amount_off_exclusions?: string[];
@@ -1671,12 +1671,12 @@ export interface V2ItemDTO {
 	options?: V2ModifierGroupDTO[];
 	required?: boolean;
 	special?: boolean;
-	category?: Record<string, any>;
+	category?: V2MenuLabelDTO;
 	location?: string;
 	sku?: number;
 	item_number?: number;
 	image?: V2ItemImageDTO;
-	weight?: Record<string, any>;
+	weight?: V2AmountDTO;
 	is_deleted?: boolean;
 	is?: V2ItemIsDTO;
 }
@@ -1747,20 +1747,20 @@ export interface V2AmountDTO {
 
 export interface V2ModifierGroupDTO {
 	id?: string;
-	label?: Record<string, any>;
+	label?: V2MenuLabelDTO;
 	unique_name?: string;
 	items?: V2ModifierDTO[];
 	min?: number;
 	max?: number;
-	is?: Record<string, any>;
-	meta?: Record<string, any>;
+	is?: V2ModifierIsDTO;
+	meta?: V2ModifierMetaDTO;
 }
 
 export interface V2ModifierDTO {
 	id?: string;
-	label?: Record<string, any>;
-	price?: Record<string, any>;
-	weight?: Record<string, any>;
+	label?: V2MenuLabelDTO;
+	price?: V2PriceDTO;
+	weight?: V2AmountDTO;
 	sku?: string;
 	nutrition?: V2ModifierNutritionDTO;
 	certified?: V2CertifiedDTO;
@@ -1772,7 +1772,7 @@ export interface V2ModifierDTO {
 
 export interface V2ModifierNutritionDTO {
 	kcal?: number;
-	calories?: Record<string, any>;
+	calories?: V2AmountDTO;
 }
 
 export interface V2CertifiedDTO {
@@ -1786,7 +1786,7 @@ export interface V2ModifierSetsDTO {
 
 export interface V2ModifierMetaDTO {
 	sort_number?: number;
-	menu_sort_number?: Record<string, any>;
+	menu_sort_number?: V2AmountDTO;
 }
 
 export interface V2ModifierIsDTO {
@@ -1815,9 +1815,9 @@ export interface V2CategoryIsDTO {
 }
 
 export interface V2CategoryMetaDTO {
-	original_label?: Record<string, any>;
+	original_label?: V2MenuLabelDTO;
 	sort_number?: number;
-	menu_sort_number?: Record<string, any>;
+	menu_sort_number?: V2AmountDTO;
 }
 
 export interface V2MenuIsDTO {