@compassdigital/sdk.typescript 4.608.0 → 4.610.0

package/src/interface/consumer.ts

@@ -1793,7 +1793,7 @@ export interface GetMenuItemPriceConsumer {
 	currency?: string;
 }
 
-export interface GetMenuItemCalorieConsumer {
+export interface GetMenuItemNutritionValueConsumer {
 	// Amount
 	amount?: number;
 	// Unit of measurement
@@ -1804,7 +1804,7 @@ export interface GetMenuItemCalorieConsumer {
 
 export interface GetMenuItemNutritionConsumer {
 	// Calories
-	calories?: GetMenuItemCalorieConsumer;
+	calories?: GetMenuItemNutritionValueConsumer;
 }
 
 export interface Certified {
@@ -1862,7 +1862,27 @@ export interface Certified {
 
 export interface GetMenuOptionNutritionConsumer {
 	// Calories
-	calories?: GetMenuItemCalorieConsumer;
+	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 {
@@ -2484,67 +2504,86 @@ export interface GetConsumerShoppingCartResponse {
 	incentives?: ConsumerIncentives;
 }
 
-export interface ConsumerLabel {
-	en?: string;
-	fr?: string;
-}
-
-export interface ConsumerModifierSizingInner {
-	name?: string;
-	price?: number;
-	posid?: string;
+export interface ConsumerMealplan {
+	// The meal plan ID
+	id?: string;
+	// The meal plan tender
+	tender?: string;
+	// The meal plan total
+	total?: number;
+	// The meal plan type
+	type?: string;
 }
 
-export interface ConsumerModifierRequestMeta {
-	sizing?: ConsumerModifierSizingInner[];
+export interface ConsumerCreditCard {
+	// The credit card type
+	card_type?: string;
+	// The last 4 digits of the card number
+	last4?: string;
+	// The credit card total
+	total?: number;
+	// The credit card type
+	type?: string;
 }
 
-export interface ConsumerPrice {
-	amount?: number;
+export interface ConsumerDigitalWalletPay {
+	// The digital wallet type
+	wallet_type?: string;
+	// The digital wallet total
+	total: number;
+	// The digital wallet type
+	type: string;
 }
 
-export interface ConsumerModifierRequest {
+export interface ConsumerMealSwipes {
+	// The meal swipes ID
 	id?: string;
-	label?: ConsumerLabel;
-	_index?: string;
-	quantity?: number;
-	amount_off_exclusions?: Record<string, any>[];
-	meta?: ConsumerModifierRequestMeta;
-	is_selected?: boolean;
-	parent_label?: ConsumerLabel;
-	price?: ConsumerPrice;
+	// The meal swipes tender
+	tender?: string;
+	// The meal swipes tender type
+	tender_type?: string;
+	// The meal swipes tender name
+	tender_name?: string;
+	// The meal swipes swipes
+	swipes?: number;
+	// The meal swipes rate
+	rate?: number;
+	// The meal swipes total
+	total?: number;
+	// The meal swipes type
+	type?: string;
 }
 
-export interface ConsumerModifierGroupRequest {
-	label?: ConsumerLabel;
+export interface ConsumerMealExchange {
+	// The meal exchange ID
 	id?: string;
-	items?: ConsumerModifierRequest[];
-}
-
-export interface ConsumerItemRequestMeta {
-	brand?: string;
-	brand_label?: ConsumerLabel;
-	menu?: string;
-	barcodes?: string[];
-	plu?: string;
-}
-
-export interface ConsumerItemRequest {
-	id: string;
-	quantity: number;
-	quantity_by_weight?: {
-		unit?: string;
-		value?: number;
-	};
-	options?: ConsumerModifierGroupRequest[];
-	_index?: string;
-	special_instructions?: string;
-	meta?: ConsumerItemRequestMeta;
-	amount_off_exclusions?: Record<string, any>[];
+	// The meal exchange tender
+	tender?: string;
+	// The meal exchange type
+	type?: string;
 }
 
-export interface PutConsumerShoppingCartItemsRequest {
-	items?: ConsumerItemRequest[];
+export interface PutConsumerShoppingCartPaymentRequestDto {
+	// The email to apply to the shopping cart
+	email?: string;
+	// The meal plan to apply to the shopping cart
+	mealplan?: ConsumerMealplan;
+	// The credit card to apply to the shopping cart
+	credit_card?: ConsumerCreditCard;
+	// The digital wallet pay to apply to the shopping cart
+	digital_wallet_pay?: ConsumerDigitalWalletPay;
+	// The meal swipes to apply to the shopping cart
+	meal_swipes?: ConsumerMealSwipes;
+	// The meal exchange to apply to the shopping cart
+	meal_exchange?: ConsumerMealExchange;
+	// The badge pay to apply to the shopping cart
+	badge_pay?: ConsumerCashlessTender;
+	// The stipend to apply to the shopping cart
+	voucher?: ConsumerCashlessTender;
+	// The coupon voucher to apply to the shopping cart
+	coupon_voucher?: ConsumerCashlessTender;
+	// The stipend to apply to the shopping cart
+	stipend?: ConsumerCashlessTender;
 }
 
 export interface PutConsumerShoppingCartResponse {
@@ -2601,6 +2640,69 @@ export interface PutConsumerShoppingCartResponse {
 	incentives?: ConsumerIncentives;
 }
 
+export interface ConsumerLabel {
+	en?: string;
+	fr?: string;
+}
+
+export interface ConsumerModifierSizingInner {
+	name?: string;
+	price?: number;
+	posid?: string;
+}
+
+export interface ConsumerModifierRequestMeta {
+	sizing?: ConsumerModifierSizingInner[];
+}
+
+export interface ConsumerPrice {
+	amount?: number;
+}
+
+export interface ConsumerModifierRequest {
+	id?: string;
+	label?: ConsumerLabel;
+	_index?: string;
+	quantity?: number;
+	amount_off_exclusions?: Record<string, any>[];
+	meta?: ConsumerModifierRequestMeta;
+	is_selected?: boolean;
+	parent_label?: ConsumerLabel;
+	price?: ConsumerPrice;
+}
+
+export interface ConsumerModifierGroupRequest {
+	label?: ConsumerLabel;
+	id?: string;
+	items?: ConsumerModifierRequest[];
+}
+
+export interface ConsumerItemRequestMeta {
+	brand?: string;
+	brand_label?: ConsumerLabel;
+	menu?: string;
+	barcodes?: string[];
+	plu?: string;
+}
+
+export interface ConsumerItemRequest {
+	id: string;
+	quantity: number;
+	quantity_by_weight?: {
+		unit?: string;
+		value?: number;
+	};
+	options?: ConsumerModifierGroupRequest[];
+	_index?: string;
+	special_instructions?: string;
+	meta?: ConsumerItemRequestMeta;
+	amount_off_exclusions?: Record<string, any>[];
+}
+
+export interface PutConsumerShoppingCartItemsRequest {
+	items?: ConsumerItemRequest[];
+}
+
 export interface PostConsumerRecommendedRequest {
 	// excluded items
 	excludedItems: string[];
@@ -3024,88 +3126,6 @@ export interface ConsumerPutMealplanResponse {
 	tenders?: ConsumerTender[];
 }
 
-export interface ConsumerMealplan {
-	// The meal plan ID
-	id?: string;
-	// The meal plan tender
-	tender?: string;
-	// The meal plan total
-	total?: number;
-	// The meal plan type
-	type?: string;
-}
-
-export interface ConsumerCreditCard {
-	// The credit card type
-	card_type?: string;
-	// The last 4 digits of the card number
-	last4?: string;
-	// The credit card total
-	total?: number;
-	// The credit card type
-	type?: string;
-}
-
-export interface ConsumerDigitalWalletPay {
-	// The digital wallet type
-	wallet_type?: string;
-	// The digital wallet total
-	total: number;
-	// The digital wallet type
-	type: string;
-}
-
-export interface ConsumerMealSwipes {
-	// The meal swipes ID
-	id?: string;
-	// The meal swipes tender
-	tender?: string;
-	// The meal swipes tender type
-	tender_type?: string;
-	// The meal swipes tender name
-	tender_name?: string;
-	// The meal swipes swipes
-	swipes?: number;
-	// The meal swipes rate
-	rate?: number;
-	// The meal swipes total
-	total?: number;
-	// The meal swipes type
-	type?: string;
-}
-
-export interface ConsumerMealExchange {
-	// The meal exchange ID
-	id?: string;
-	// The meal exchange tender
-	tender?: string;
-	// The meal exchange type
-	type?: string;
-}
-
-export interface PutConsumerShoppingCartPaymentRequestDto {
-	// The email to apply to the shopping cart
-	email?: string;
-	// The meal plan to apply to the shopping cart
-	mealplan?: ConsumerMealplan;
-	// The credit card to apply to the shopping cart
-	credit_card?: ConsumerCreditCard;
-	// The digital wallet pay to apply to the shopping cart
-	digital_wallet_pay?: ConsumerDigitalWalletPay;
-	// The meal swipes to apply to the shopping cart
-	meal_swipes?: ConsumerMealSwipes;
-	// The meal exchange to apply to the shopping cart
-	meal_exchange?: ConsumerMealExchange;
-	// The badge pay to apply to the shopping cart
-	badge_pay?: ConsumerCashlessTender;
-	// The stipend to apply to the shopping cart
-	voucher?: ConsumerCashlessTender;
-	// The coupon voucher to apply to the shopping cart
-	coupon_voucher?: ConsumerCashlessTender;
-	// The stipend to apply to the shopping cart
-	stipend?: ConsumerCashlessTender;
-}
-
 export interface PutConsumerShoppingCartPromoRequestDto {
 	// The promo code to apply to the shopping cart
 	code?: string;
@@ -3635,6 +3655,36 @@ export interface PostExternalExchangeLoginCodeResponseDTO {
 	profile: ExchangeProfileDTO;
 }
 
+export interface GetConsumerLocationResponse {
+	// id
+	id: string;
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	// name
+	name: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	// distance in meters from the group
+	distance?: number;
+	// meta data
+	meta?: Record<string, any>;
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
+	// timezone
+	timezone?: string;
+	// site operational status
+	status?: Record<string, any>;
+	locations?: ConsumerLocation[];
+	address?: ConsumerAddress;
+}
+
 // GET /consumer/v1/health-check
 
 export type HealthCheckControllerExecuteResponse = {};
@@ -4069,6 +4119,17 @@ export type PatchConsumerShoppingcartBody = PatchConsumerShoppingCartRequest;
 
 export type PatchConsumerShoppingcartResponse = PatchConsumerShoppingCartResponse;
 
+// PUT /consumer/shoppingcart/{id}/paymentmethod - Update a shopping cart by ID
+
+export interface PutConsumerShoppingcartPaymentPath {
+	// Shopping Cart ID as Encaded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export type PutConsumerShoppingcartPaymentBody = PutConsumerShoppingCartPaymentRequestDto;
+
+export type PutConsumerShoppingcartPaymentResponse = PutConsumerShoppingCartResponse;
+
 // POST /consumer/shoppingcart/{id}/recommended - Get recommended items for a station or marketplace cart
 
 export interface PostConsumerShoppingcartRecommendedItemsPath {
@@ -4236,17 +4297,6 @@ export interface GetConsumerConfigPublicPath {
 
 export type GetConsumerConfigPublicResponse$0 = GetConsumerConfigPublicResponse;
 
-// PUT /consumer/shoppingcart/{id}/paymentmethod - Update a shopping cart by ID
-
-export interface PutConsumerShoppingcartPaymentPath {
-	// Shopping Cart ID as Encaded CDL ID; TODO: mark parameter as required in swagger
-	id: string;
-}
-
-export type PutConsumerShoppingcartPaymentBody = PutConsumerShoppingCartPaymentRequestDto;
-
-export type PutConsumerShoppingcartPaymentResponse = PutConsumerShoppingCartResponse;
-
 // PUT /consumer/shoppingcart/{id}/promo - Add a promo code to a shopping cart
 
 export interface PutConsumerShoppingcartPromoPath {
@@ -4413,3 +4463,23 @@ export interface GetConsumerUserMealplanBarcodePath {
 }
 
 export type GetConsumerUserMealplanBarcodeResponse = {};
+
+// GET /consumer/location/{id} - Get location
+
+export interface GetConsumerLocationPath {
+	// Location ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export interface GetConsumerLocationQuery {
+	// Show disabled marketplace
+	show_disabled_marketplace?: boolean;
+	// Include brands config
+	include_brands_config?: boolean;
+	// Extended
+	extended?: boolean;
+	// Active cafes
+	active_cafes?: string[];
+}
+
+export type GetConsumerLocationResponse$0 = GetConsumerLocationResponse;

package/src/interface/discount.ts

@@ -466,7 +466,7 @@ export interface ItemDiscountContextDTO {
 	itemDiscountedTotal: number;
 	// Single Items: discount amount applied across the affected quantity of this item (itemRegularTotal - itemDiscountedTotal). Bundle: discount amount applied to this item per bundle qualification.
 	appliedAmount: number;
-	// Bundle only: quantity of this item consumed per bundle qualification which must be the minimum of the respective bundle group in a bundle.
+	// Bundle only: the minimum quantity of this item's respective bundle group in a bundle.
 	bundleGroupMinimum?: number;
 	// Bundle only: regular (pre-discount) total of the entire bundle per qualification, this is the sum of every item that participates in the bundle. Omitted for Single Items.
 	bundleRegularTotal?: number;
@@ -490,7 +490,7 @@ export interface PostValidateDiscountsResponseDTO {
 	stackedTotal: number;
 	// List of validated and applied discounts
 	stackedDiscounts: StackedDiscountDTO[];
-	// Cart items affected by an item-level discount (Single Items or Bundle), one entry per cart item. Each entry references the original cart item by `id` and carries `discounts` pre-merged across every discount that touched the item. Leftover (non-discounted) quantity is not stored and can be derived against the request cart item as: Single Items -> `discountMultiplier`; Bundle -> `discountMultiplier × bundleGroupMinimum`. Combined: `cartItem.quantity - Σ(discountMultiplier × (bundleGroupMinimum ?? 1))`.
+	// Cart items affected by an item-level discount (Single Items or Bundle), one entry per affected cart item. Each entry references the original cart item by `id` and carries the merged per-discount contexts in `discounts`.
 	appliedItems?: AppliedItemResponseDTO[];
 }