@compassdigital/sdk.typescript 4.376.0 → 4.378.0

package/src/index.ts

@@ -1209,6 +1209,8 @@ import {
 	GetConsumerLocationMultigroupResponse,
 	GetConsumerActiveMenusQuery,
 	GetConsumerActiveMenusResponse,
+	GetConsumerMenuRecommendedItemsQuery,
+	GetConsumerMenuRecommendedItemsResponse$0,
 	GetConsumerMenuQuery,
 	GetConsumerMenuResponse,
 	GetConsumerMenuItemsQuery,
@@ -13212,6 +13214,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /consumer/menu/{id}/recommended - Get recommended menu items
+	 *
+	 * @param id - Menu ID as Encoded CDL ID
+	 * @param options - additional request options
+	 */
+	get_consumer_menu_recommended_items(
+		id: string,
+		options?: {
+			query?: GetConsumerMenuRecommendedItemsQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerMenuRecommendedItemsResponse$0> {
+		return this.request(
+			'consumer',
+			'/consumer/menu/{id}/recommended',
+			'GET',
+			`/consumer/menu/${id}/recommended`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /consumer/menu/{id} - Get full Menu by ID
 	 *

package/src/interface/consumer.ts

@@ -1508,6 +1508,172 @@ export interface ConsumerGetActiveMenusResponse {
 	menus: ConsumerMenuHours[];
 }
 
+export interface ConsumerOption {
+	// Metadata for the option
+	meta?: Record<string, any>;
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	name?: string;
+	description?: {
+		en?: string;
+	};
+	price?: {
+		amount?: number;
+		currency?: string;
+	};
+	reporting?: {
+		category: {
+			primary?: string;
+			secondary?: string;
+		};
+	};
+	weight?: {
+		unit?: string;
+		amount?: number;
+	};
+	image?: {
+		src?: string;
+		sizes: {
+			original?: string;
+			thumbnail_80_80?: string;
+		};
+	};
+	sku?: number;
+	nutrition?: {
+		kcal?: number;
+		calories?: Record<string, any>;
+	};
+	certified?: {
+		vegan?: boolean;
+	};
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		out_of_stock?: boolean;
+	};
+	amount_off_exclusions?: Record<string, any>[];
+	line_route?: string;
+}
+
+export interface ConsumerOptionsGroup {
+	// Metadata for the options group
+	meta?: Record<string, any>;
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	unique_name?: string;
+	name?: string;
+	items?: ConsumerOption[];
+	min?: number;
+	max?: number;
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		out_of_stock?: boolean;
+		incremental?: boolean;
+		surcharge_limit?: boolean;
+	};
+	limit?: number;
+}
+
+export interface ConsumerItem {
+	// Metadata for the item
+	meta?: Record<string, any>;
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	name?: string;
+	description?: {
+		en?: string;
+	};
+	price?: {
+		amount?: number;
+		currency?: string;
+		total_price?: number;
+		discount?: number;
+	};
+	meal_value?: number;
+	sale_price?: {
+		amount?: number;
+		currency?: string;
+	};
+	unit?: number;
+	ingredients?: Record<string, any>[];
+	amount_off_exclusions?: Record<string, any>[];
+	certified?: {
+		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;
+	};
+	options?: ConsumerOptionsGroup[];
+	required?: boolean;
+	special?: boolean;
+	category?: {
+		en?: string;
+	};
+	location?: string;
+	sku?: number;
+	item_number?: number;
+	image?: {
+		src?: string;
+		sizes: {
+			original?: string;
+			thumbnail_80_80?: string;
+		};
+	};
+	weight?: {
+		unit?: string;
+		amount?: number;
+	};
+	line_route?: string;
+	reporting?: {
+		category: {
+			primary?: string;
+			secondary?: string;
+		};
+	};
+	is_deleted?: boolean;
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		meq_eligible?: boolean;
+		out_of_stock?: boolean;
+		deleted?: boolean;
+		featured?: boolean;
+	};
+}
+
+export interface GetConsumerMenuRecommendedItemsResponse {
+	// items
+	items: ConsumerItem[];
+}
+
 export interface GetMenuLabelConsumer {
 	// English
 	en?: string;
@@ -1689,6 +1855,15 @@ export interface GetMenuItemIsConsumer {
 	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;
+}
+
 export interface GetMenuItemConsumer {
 	// Menu Item ID
 	id?: string;
@@ -1716,6 +1891,8 @@ export interface GetMenuItemConsumer {
 	image?: GetMenuItemImageConsumer;
 	// Quick boolean details
 	is?: GetMenuItemIsConsumer;
+	// Menu labels
+	menu_labels?: GetMenuItemMenuLabelConsumer[];
 }
 
 export interface GetMenuGroupConsumer {
@@ -1738,167 +1915,6 @@ export interface GetMenuResponseConsumer {
 	parent_id?: string;
 }
 
-export interface ConsumerOption {
-	// Metadata for the option
-	meta?: Record<string, any>;
-	id?: string;
-	label?: {
-		en?: string;
-	};
-	name?: string;
-	description?: {
-		en?: string;
-	};
-	price?: {
-		amount?: number;
-		currency?: string;
-	};
-	reporting?: {
-		category: {
-			primary?: string;
-			secondary?: string;
-		};
-	};
-	weight?: {
-		unit?: string;
-		amount?: number;
-	};
-	image?: {
-		src?: string;
-		sizes: {
-			original?: string;
-			thumbnail_80_80?: string;
-		};
-	};
-	sku?: number;
-	nutrition?: {
-		kcal?: number;
-		calories?: Record<string, any>;
-	};
-	certified?: {
-		vegan?: boolean;
-	};
-	is?: {
-		disabled?: boolean;
-		hidden?: boolean;
-		out_of_stock?: boolean;
-	};
-	amount_off_exclusions?: Record<string, any>[];
-	line_route?: string;
-}
-
-export interface ConsumerOptionsGroup {
-	// Metadata for the options group
-	meta?: Record<string, any>;
-	id?: string;
-	label?: {
-		en?: string;
-	};
-	unique_name?: string;
-	name?: string;
-	items?: ConsumerOption[];
-	min?: number;
-	max?: number;
-	is?: {
-		disabled?: boolean;
-		hidden?: boolean;
-		out_of_stock?: boolean;
-		incremental?: boolean;
-		surcharge_limit?: boolean;
-	};
-	limit?: number;
-}
-
-export interface ConsumerItem {
-	// Metadata for the item
-	meta?: Record<string, any>;
-	id?: string;
-	label?: {
-		en?: string;
-	};
-	name?: string;
-	description?: {
-		en?: string;
-	};
-	price?: {
-		amount?: number;
-		currency?: string;
-		total_price?: number;
-		discount?: number;
-	};
-	meal_value?: number;
-	sale_price?: {
-		amount?: number;
-		currency?: string;
-	};
-	unit?: number;
-	ingredients?: Record<string, any>[];
-	amount_off_exclusions?: Record<string, any>[];
-	certified?: {
-		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;
-	};
-	options?: ConsumerOptionsGroup[];
-	required?: boolean;
-	special?: boolean;
-	category?: {
-		en?: string;
-	};
-	location?: string;
-	sku?: number;
-	item_number?: number;
-	image?: {
-		src?: string;
-		sizes: {
-			original?: string;
-			thumbnail_80_80?: string;
-		};
-	};
-	weight?: {
-		unit?: string;
-		amount?: number;
-	};
-	line_route?: string;
-	reporting?: {
-		category: {
-			primary?: string;
-			secondary?: string;
-		};
-	};
-	is_deleted?: boolean;
-	is?: {
-		disabled?: boolean;
-		hidden?: boolean;
-		meq_eligible?: boolean;
-		out_of_stock?: boolean;
-		deleted?: boolean;
-		featured?: boolean;
-	};
-}
-
 export interface GetConsumerMenuItemsResponse {
 	// meta
 	meta?: Record<string, any>;
@@ -2948,7 +2964,7 @@ export interface PostConsumerShoppingCartCloneBodyRequest {
 
 export interface PostCustomerRewardsBodyDTO {
 	// The shoppingcart brands
-	shoppingcart_brands?: string[];
+	shoppingcartBrands?: string[];
 }
 
 export interface ConsumerRewardWindowDTO {
@@ -3355,6 +3371,22 @@ export interface GetConsumerActiveMenusQuery {
 
 export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
 
+// GET /consumer/menu/{id}/recommended - Get recommended menu items
+
+export interface GetConsumerMenuRecommendedItemsPath {
+	// Menu ID as Encoded CDL ID
+	id: string;
+}
+
+export interface GetConsumerMenuRecommendedItemsQuery {
+	// Comma-separated list of item IDs to exclude from recommendations
+	excludedItems?: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerMenuRecommendedItemsResponse$0 = GetConsumerMenuRecommendedItemsResponse;
+
 // GET /consumer/menu/{id} - Get full Menu by ID
 
 export interface GetConsumerMenuPath {