@compassdigital/sdk.typescript 4.193.0 → 4.195.0

package/src/interface/consumer.ts

@@ -1487,43 +1487,234 @@ export interface ConsumerGetActiveMenusResponse {
 	menus: ConsumerMenuHours[];
 }
 
-export interface GetConsumerMenuResponse {
+export interface GetMenuLabelConsumer {
+	// English
+	en?: string;
+}
+
+export interface GetMenuGroupLabelConsumer {
+	// English
+	en?: string;
+	// French
+	fr?: string;
+}
+
+export interface GetMenuItemLabelConsumer {
+	// English
+	en?: string;
+}
+
+export interface GetMenuItemPriceConsumer {
+	// Amount
+	amount?: number;
+	// Currency code
+	currency?: string;
+}
+
+export interface GetMenuItemCalorieConsumer {
+	// Amount
+	amount?: number;
+	// Unit of measurement
+	unit?: string;
+}
+
+export interface GetMenuItemNutritionConsumer {
+	// Calories
+	calories?: GetMenuItemCalorieConsumer;
+}
+
+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?: GetMenuItemCalorieConsumer;
+}
+
+export interface GetMenuItemOptionSizingConsumer {
+	// Sizing name
+	name?: string;
+	// POS ID for sizing
+	posid?: string;
+	// Price for this sizing
+	price?: number;
+}
+
+export interface GetMenuItemOptionMetaConsumer {
+	// Available sizings
+	sizing?: GetMenuItemOptionSizingConsumer[];
+}
+
+export interface GetMenuItemOptionConsumer {
+	// Menu Option ID
+	id?: string;
+	// Label for the option
+	label?: GetMenuItemLabelConsumer;
+	// Price
+	price?: GetMenuItemPriceConsumer;
+	// Nutrition
+	nutrition?: GetMenuOptionNutritionConsumer;
+	// Metadata for the option
+	meta?: GetMenuItemOptionMetaConsumer;
+}
+
+export interface GetMenuItemGroupIsConsumer {
+	// Options group incremental?
+	incremental?: boolean;
+}
+
+export interface GetMenuItemGroupMetaConsumer {
+	// Type of mod group
+	order_type?: 'selection' | 'option' | 'quantity';
+}
+
+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;
+}
+
+export interface GetMenuItemRecipeConsumer {
+	// Smart tags
+	smart_tags?: string[];
+	// Allergen tags
+	allergen_tags?: string[];
+}
+
+export interface GetMenuItemMetaConsumer {
+	// Barcodes of the item
+	barcodes?: string[];
+	// Recipe meta
+	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 GetMenuItemConsumer {
+	// Menu Item ID
+	id?: string;
+	// Label for the menu item
+	label?: GetMenuItemLabelConsumer;
+	// Description of the item
+	description?: GetMenuItemLabelConsumer;
+	// Item price
+	price?: GetMenuItemPriceConsumer;
+	// Meal exchange value of the item
+	meal_value?: number;
+	// Sale price of the item
+	sale_price?: GetMenuItemPriceConsumer;
+	// Number of units for the item. For example, a dozen doughnuts should have a unit value of 12
+	unit?: number;
+	// Item nutrition
+	nutrition?: GetMenuItemNutritionConsumer;
+	// Food certifications like vegan, organic, etc
+	certified?: Certified;
+	// Item options/modifiers
+	options?: GetMenuItemOptionsGroupConsumer[];
+	// Metadata for the item
+	meta?: GetMenuItemMetaConsumer;
+	// Item image data
+	image?: GetMenuItemImageConsumer;
+	// Quick boolean details
+	is?: GetMenuItemIsConsumer;
+}
+
+export interface GetMenuGroupConsumer {
+	// Menu Group ID
+	id?: string;
+	// Menu Group label
+	label?: GetMenuGroupLabelConsumer;
+	// Menu Items
+	items?: GetMenuItemConsumer[];
+}
+
+export interface GetMenuResponseConsumer {
 	// menu id
 	id: string;
-	date?: {
-		created?: string;
-		modified?: string;
-		published?: string;
-	};
-	label?: {
-		en?: string;
-	};
+	// menu label
+	label?: GetMenuLabelConsumer;
 	// menu groups
-	groups: ConsumerGroup[];
+	groups: GetMenuGroupConsumer[];
 	// menu parent id
 	parent_id: string;
-	// menu location brand
-	location_brand?: string;
-	// menu company
-	company?: string;
-	// menu sector
-	sector?: string;
-	is?: {
-		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;
-	};
-	// menu meta
-	meta?: Record<string, any>;
 }
 
 export interface ConsumerOption {
@@ -2550,10 +2741,10 @@ export interface GetConsumerActiveMenusQuery {
 
 export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
 
-// GET /consumer/menu/{id} - Provide the front end all the data required to render the home page
+// GET /consumer/menu/{id} - Get full Menu by ID
 
 export interface GetConsumerMenuPath {
-	// Menu ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	// Menu ID as Encoded CDL ID
 	id: string;
 }
 
@@ -2562,7 +2753,7 @@ export interface GetConsumerMenuQuery {
 	_query?: string;
 }
 
-export type GetConsumerMenuResponse$0 = GetConsumerMenuResponse;
+export type GetConsumerMenuResponse = GetMenuResponseConsumer;
 
 // GET /consumer/menu/{id}/items - Provide the front end with menu items
 

package/src/interface/search.ts

@@ -110,8 +110,6 @@ export interface Error {
 	data: ErrorData;
 }
 
-export type Object = Record<string, any>;
-
 export interface GetLocationDto {
 	source_id: string;
 	source_type: string;
@@ -194,8 +192,8 @@ export interface GetSearchLocationQuery {
 	source_type?: 'brand' | 'location' | 'group' | 'multigroup' | 'sector' | 'company';
 	// Filter entities with specific group id as a parent
 	source_group_parent?: string;
-	// Filter entities with specific multigroup id as a parent
-	source_multigroup_parent?: Object;
+	// Filter entities with specific multigroup id as a parent (string or comma-separated string)
+	source_multigroup_parent?: string;
 	// Graphql query string
 	_query?: string;
 }