@compassdigital/sdk.typescript 4.617.0 → 4.618.0

package/src/interface/consumer.ts

@@ -1802,7 +1802,14 @@ export interface ConsumerItem {
 			primary?: string;
 			secondary?: string;
 		};
+		jde_category?: string;
 	};
+	parent_id?: string;
+	menu_labels?: {
+		id?: string;
+		text?: string;
+		s3_link?: string;
+	}[];
 	is_deleted?: boolean;
 	is?: {
 		disabled?: boolean;
@@ -1857,90 +1864,23 @@ export interface GetMenuItemNutritionConsumer {
 	calories?: GetMenuItemNutritionValueConsumer;
 }
 
-export interface Certified {
-	// Certified vegan
-	vegan?: boolean;
-	// Certified vegetarian
-	vegetarian?: boolean;
-	// Seafood Watch certified (sustainable seafood)
-	seafood_watch?: boolean;
-	// Certified for general wellbeing
-	wellbeing?: boolean;
-	// Farm to Fork certified (locally sourced)
-	farm_to_fork?: boolean;
-	// In Balance certified (nutritionally balanced)
-	in_balance?: boolean;
-	// Certified organic
-	organic?: boolean;
-	// No gluten ingredients present
-	no_gluten_ingredients?: boolean;
-	// Certified halal
-	halal?: boolean;
-	// Certified kosher
-	kosher?: boolean;
-	// Certified humane (animal welfare)
-	humane?: boolean;
-	// Locally crafted product
-	locally_crafted?: boolean;
-	// Contains nuts
-	nuts?: boolean;
-	// Oracle Garden Grown certified
-	oracle_garden_grown?: boolean;
-	// Oracle OYES certified
-	oracle_oyes?: boolean;
-	// Peanut free
-	peanut_free?: boolean;
-	// Tree nut free
-	tree_nut_free?: boolean;
-	// Wheat free
-	wheat_free?: boolean;
-	// Non-GMO certified
-	non_gmo?: boolean;
-	// Milk free
-	milk_free?: boolean;
-	// Egg free
-	egg_free?: boolean;
-	// Soy free
-	soy_free?: boolean;
-	// Fair Trade certified
-	fair_trade?: boolean;
-	// Rainforest Alliance certified
-	rainforest_alliance?: boolean;
-	// Salt free
-	salt_free?: boolean;
-}
-
 export interface GetMenuOptionNutritionConsumer {
-	// Calories
 	calories?: GetMenuItemNutritionValueConsumer;
-	// Total fat
 	total_fat?: GetMenuItemNutritionValueConsumer;
-	// Saturated fat
 	saturated_fat?: GetMenuItemNutritionValueConsumer;
-	// Total carbohydrates
 	total_carbohydrate?: GetMenuItemNutritionValueConsumer;
-	// Total sugars
 	total_sugars?: GetMenuItemNutritionValueConsumer;
-	// Protein
 	protein?: GetMenuItemNutritionValueConsumer;
-	// Dietary fiber
 	dietary_fiber?: GetMenuItemNutritionValueConsumer;
-	// Sodium
 	sodium?: GetMenuItemNutritionValueConsumer;
-	// Trans fat
 	trans_fat?: GetMenuItemNutritionValueConsumer;
-	// Cholesterol
 	cholesterol?: GetMenuItemNutritionValueConsumer;
-	// Added sugars
 	added_sugars?: GetMenuItemNutritionValueConsumer;
 }
 
 export interface GetMenuItemOptionSizingConsumer {
-	// Sizing name
 	name?: string;
-	// POS ID for sizing
 	posid?: string;
-	// Price for this sizing
 	price?: number;
 }
 
@@ -1949,6 +1889,16 @@ export interface GetMenuItemOptionMetaConsumer {
 	sizing?: GetMenuItemOptionSizingConsumer[];
 }
 
+export interface GetMenuItemImageSizesConsumer {
+	original?: string;
+	thumbnail_80_80?: string;
+}
+
+export interface GetMenuItemImageConsumer {
+	src?: string;
+	sizes?: GetMenuItemImageSizesConsumer;
+}
+
 export interface GetMenuItemOptionConsumer {
 	// Menu Option ID
 	id?: string;
@@ -1963,7 +1913,6 @@ export interface GetMenuItemOptionConsumer {
 }
 
 export interface GetMenuItemGroupIsConsumer {
-	// Options group incremental?
 	incremental?: boolean;
 }
 
@@ -1975,17 +1924,11 @@ export interface GetMenuItemGroupMetaConsumer {
 export interface GetMenuItemOptionsGroupConsumer {
 	// Menu Options Group ID
 	id?: string;
-	// Label for the options group
 	label?: GetMenuItemLabelConsumer;
-	// Options group items
 	items?: GetMenuItemOptionConsumer[];
-	// Minimum number of options
 	min?: number;
-	// Maximum number of options
 	max?: number;
-	// Object containing quick boolean details
 	is?: GetMenuItemGroupIsConsumer;
-	// Metadata for the options group
 	meta?: GetMenuItemGroupMetaConsumer;
 }
 
@@ -2003,31 +1946,14 @@ export interface GetMenuItemMetaConsumer {
 	recipe?: GetMenuItemRecipeConsumer;
 }
 
-export interface GetMenuItemImageSizesConsumer {
-	// Image URL
-	original?: string;
-	// 80x80 thumbnail image URL
-	thumbnail_80_80?: string;
-}
-
-export interface GetMenuItemImageConsumer {
-	// Image source URL
-	src?: string;
-	// Image sizes
-	sizes?: GetMenuItemImageSizesConsumer;
-}
-
 export interface GetMenuItemIsConsumer {
 	// Is the item out of stock?
 	out_of_stock?: boolean;
 }
 
 export interface GetMenuItemMenuLabelConsumer {
-	// Menu label ID
 	id?: string;
-	// Menu label text
 	text?: string;
-	// Image for Menu label S3 link
 	s3_link?: string;
 }
 
@@ -3792,6 +3718,363 @@ export interface GetConsumerLocationResponse {
 	address?: ConsumerAddress;
 }
 
+export interface GetMenuItemNutritionValueConsumerV2 {
+	amount?: number;
+	unit?: string;
+	display?: string;
+}
+
+export interface GetMenuItemNutritionConsumerV2 {
+	kcal?: number;
+	calories?: GetMenuItemNutritionValueConsumerV2;
+	serving_size?: GetMenuItemNutritionValueConsumerV2;
+	total_fat?: GetMenuItemNutritionValueConsumerV2;
+	saturated_fat?: GetMenuItemNutritionValueConsumerV2;
+	trans_fat?: GetMenuItemNutritionValueConsumerV2;
+	cholesterol?: GetMenuItemNutritionValueConsumerV2;
+	sodium?: GetMenuItemNutritionValueConsumerV2;
+	total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
+	dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
+	sugars?: GetMenuItemNutritionValueConsumerV2;
+	total_sugars?: GetMenuItemNutritionValueConsumerV2;
+	protein?: GetMenuItemNutritionValueConsumerV2;
+	well_being?: GetMenuItemNutritionValueConsumerV2;
+}
+
+export interface GetMenuOptionNutritionConsumerV2 {
+	calories?: GetMenuItemNutritionValueConsumerV2;
+	total_fat?: GetMenuItemNutritionValueConsumerV2;
+	saturated_fat?: GetMenuItemNutritionValueConsumerV2;
+	total_carbohydrate?: GetMenuItemNutritionValueConsumerV2;
+	total_sugars?: GetMenuItemNutritionValueConsumerV2;
+	protein?: GetMenuItemNutritionValueConsumerV2;
+	dietary_fiber?: GetMenuItemNutritionValueConsumerV2;
+	sodium?: GetMenuItemNutritionValueConsumerV2;
+	trans_fat?: GetMenuItemNutritionValueConsumerV2;
+	cholesterol?: GetMenuItemNutritionValueConsumerV2;
+	added_sugars?: GetMenuItemNutritionValueConsumerV2;
+}
+
+export interface GetMenuItemPriceConsumerV2 {
+	amount?: number;
+	currency?: string;
+	total_price?: number;
+	discount?: number;
+}
+
+export interface GetMenuItemImageSizesConsumerV2 {
+	original?: string;
+	thumbnail_80_80?: string;
+}
+
+export interface GetMenuItemImageConsumerV2 {
+	src?: string;
+	sizes?: GetMenuItemImageSizesConsumerV2;
+}
+
+export interface GetMenuItemCertifiedConsumerV2 {
+	vegan?: boolean;
+	vegetarian?: boolean;
+	seafood_watch?: boolean;
+	wellbeing?: boolean;
+	farm_to_fork?: boolean;
+	in_balance?: boolean;
+	organic?: boolean;
+	no_gluten_ingredients?: boolean;
+	halal?: boolean;
+	kosher?: boolean;
+	humane?: boolean;
+	locally_crafted?: boolean;
+	nuts?: boolean;
+	oracle_garden_grown?: boolean;
+	oracle_oyes?: boolean;
+	peanut_free?: boolean;
+	tree_nut_free?: boolean;
+	wheat_free?: boolean;
+	non_gmo?: boolean;
+	milk_free?: boolean;
+	egg_free?: boolean;
+	soy_free?: boolean;
+	fair_trade?: boolean;
+	rainforest_alliance?: boolean;
+	salt_free?: boolean;
+}
+
+export interface GetMenuItemReportingConsumerV2 {
+	category?: {
+		primary?: string;
+		secondary?: string;
+	};
+	jde_category?: string;
+}
+
+export interface GetMenuItemIsConsumerV2 {
+	disabled?: boolean;
+	hidden?: boolean;
+	meq_eligible?: boolean;
+	out_of_stock?: boolean;
+	deleted?: boolean;
+	featured?: boolean;
+}
+
+export interface GetMenuItemMenuLabelConsumerV2 {
+	id?: string;
+	text?: string;
+	s3_link?: string;
+}
+
+export interface GetMenuItemOptionMetaConsumerV2 {
+	sizing?: {
+		name?: string;
+		posid?: string;
+		price?: number;
+	}[];
+	sort_number?: number;
+	menu_sort_number?: number;
+	unique_id?: number;
+	tax?: {
+		tax_tag_code?: string;
+	};
+}
+
+export interface GetMenuItemOptionIsConsumerV2 {
+	disabled?: boolean;
+	hidden?: boolean;
+	out_of_stock?: boolean;
+}
+
+export interface GetMenuItemOptionConsumerV2 {
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	name?: string;
+	description?: {
+		en?: string;
+	};
+	price?: GetMenuItemPriceConsumerV2;
+	nutrition?: GetMenuOptionNutritionConsumerV2;
+	meta?: GetMenuItemOptionMetaConsumerV2;
+	image?: GetMenuItemImageConsumerV2;
+	certified?: GetMenuItemCertifiedConsumerV2;
+	is?: GetMenuItemOptionIsConsumerV2;
+	reporting?: GetMenuItemReportingConsumerV2;
+	sku?: number;
+	weight?: {
+		unit?: string;
+		amount?: number;
+	};
+	line_route?: string;
+	amount_off_exclusions?: string[];
+}
+
+export interface GetMenuItemGroupIsConsumerV2 {
+	incremental?: boolean;
+}
+
+export interface GetMenuItemGroupMetaConsumerV2 {
+	order_type?: 'selection' | 'option' | 'quantity';
+	sort_number?: number;
+	menu_sort_number?: number;
+	surcharge_limit_value?: number;
+}
+
+export interface GetMenuItemOptionsGroupConsumerV2 {
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	items?: GetMenuItemOptionConsumerV2[];
+	min?: number;
+	max?: number;
+	is?: GetMenuItemGroupIsConsumerV2;
+	meta?: GetMenuItemGroupMetaConsumerV2;
+}
+
+export interface GetMenuItemRecipeConsumerV2 {
+	smart_tags?: string[];
+	allergen_tags?: string[];
+	mrn?: string;
+	unit_id?: string;
+	portion_quantity?: number;
+	portion_unit_name?: string;
+	grams?: number;
+	cost?: number;
+	ingredients?: string[];
+}
+
+export interface GetMenuItemMetaConsumerV2 {
+	barcodes?: string[];
+	recipe?: GetMenuItemRecipeConsumerV2;
+	superplate?: {
+		type_id?: number;
+		type?: string;
+	};
+	sort_number?: number;
+	menu_sort_number?: number;
+	unique_id?: number;
+	tax?: {
+		tax_tag_code?: string;
+		tax_jwo_code?: string;
+		tax_rate?: number;
+		tax_amount?: number;
+	};
+}
+
+export interface GetMenuItemConsumerV2 {
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	name?: string;
+	description?: {
+		en?: string;
+	};
+	price?: GetMenuItemPriceConsumerV2;
+	meal_value?: number;
+	sale_price?: GetMenuItemPriceConsumerV2;
+	unit?: number;
+	sku?: number;
+	item_number?: number;
+	parent_id?: string;
+	location?: string;
+	line_route?: string;
+	weight?: {
+		unit?: string;
+		amount?: number;
+	};
+	category?: {
+		en?: string;
+	};
+	ingredients?: Record<string, any>[];
+	amount_off_exclusions?: string[];
+	nutrition?: GetMenuItemNutritionConsumerV2;
+	certified?: GetMenuItemCertifiedConsumerV2;
+	options?: GetMenuItemOptionsGroupConsumerV2[];
+	meta?: GetMenuItemMetaConsumerV2;
+	image?: GetMenuItemImageConsumerV2;
+	is?: GetMenuItemIsConsumerV2;
+	menu_labels?: GetMenuItemMenuLabelConsumerV2[];
+	reporting?: GetMenuItemReportingConsumerV2;
+}
+
+export interface GetMenuGroupConsumerV2 {
+	id: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	items?: GetMenuItemConsumerV2[];
+}
+
+export interface GetMenuIsConsumerV2 {
+	disabled?: boolean;
+	hidden?: boolean;
+	linked?: boolean;
+	promo_exemptions_enabled?: boolean;
+	plu_enabled?: boolean;
+	item_images_enabled?: boolean;
+	item_showcase_enabled?: boolean;
+	item_desc_edit_enabled?: boolean;
+	calories_edit_enabled?: boolean;
+	item_label_edit_enabled?: boolean;
+	frictionless?: boolean;
+	category_images_enabled?: boolean;
+}
+
+export interface GetMenuMetaConsumerV2 {
+	locked_by_user?: string;
+	last_modified_user?: string;
+	centricos?: boolean;
+	version?: number;
+	revision?: string;
+}
+
+export interface GetMenuDateConsumerV2 {
+	created?: string;
+	modified?: string;
+	published?: string;
+}
+
+export interface GetMenuImageSizesConsumerV2 {
+	original?: string;
+	thumbnail_80_80?: string;
+}
+
+export interface GetMenuImageConsumerV2 {
+	src?: string;
+	sizes?: GetMenuImageSizesConsumerV2;
+}
+
+export interface GetMenuResponseConsumerV2 {
+	id: string;
+	label?: {
+		en?: string;
+	};
+	groups?: GetMenuGroupConsumerV2[];
+	parent_id?: string;
+	location_brand?: string;
+	company?: string;
+	sector?: string;
+	date?: GetMenuDateConsumerV2;
+	is?: GetMenuIsConsumerV2;
+	meta?: GetMenuMetaConsumerV2;
+	image?: GetMenuImageConsumerV2;
+}
+
+export interface Certified {
+	// Certified vegan
+	vegan?: boolean;
+	// Certified vegetarian
+	vegetarian?: boolean;
+	// Seafood Watch certified (sustainable seafood)
+	seafood_watch?: boolean;
+	// Certified for general wellbeing
+	wellbeing?: boolean;
+	// Farm to Fork certified (locally sourced)
+	farm_to_fork?: boolean;
+	// In Balance certified (nutritionally balanced)
+	in_balance?: boolean;
+	// Certified organic
+	organic?: boolean;
+	// No gluten ingredients present
+	no_gluten_ingredients?: boolean;
+	// Certified halal
+	halal?: boolean;
+	// Certified kosher
+	kosher?: boolean;
+	// Certified humane (animal welfare)
+	humane?: boolean;
+	// Locally crafted product
+	locally_crafted?: boolean;
+	// Contains nuts
+	nuts?: boolean;
+	// Oracle Garden Grown certified
+	oracle_garden_grown?: boolean;
+	// Oracle OYES certified
+	oracle_oyes?: boolean;
+	// Peanut free
+	peanut_free?: boolean;
+	// Tree nut free
+	tree_nut_free?: boolean;
+	// Wheat free
+	wheat_free?: boolean;
+	// Non-GMO certified
+	non_gmo?: boolean;
+	// Milk free
+	milk_free?: boolean;
+	// Egg free
+	egg_free?: boolean;
+	// Soy free
+	soy_free?: boolean;
+	// Fair Trade certified
+	fair_trade?: boolean;
+	// Rainforest Alliance certified
+	rainforest_alliance?: boolean;
+	// Salt free
+	salt_free?: boolean;
+}
+
 // GET /consumer/v1/health-check
 
 export type HealthCheckControllerExecuteResponse = {};
@@ -4611,3 +4894,12 @@ export interface GetConsumerLocationQuery {
 }
 
 export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;
+
+// GET /consumer/v2/menu/{id} - Get full Menu by ID (v2)
+
+export interface GetConsumerMenuV2Path {
+	// Menu ID as Encoded CDL ID
+	id: string;
+}
+
+export type GetConsumerMenuV2Response = GetMenuResponseConsumerV2;