@compassdigital/sdk.typescript 4.93.0 → 4.94.1

package/src/interface/order.ts

@@ -22,8 +22,6 @@ export interface CreateOrder {
 	// user
 	customer?: string;
 	is?: {
-		//@deprecated
-		accepted?: boolean;
 		in_progress?: boolean;
 		ready?: boolean;
 	};
@@ -112,7 +110,6 @@ export interface Order {
 	// user
 	customer?: string;
 	is?: {
-		//@deprecated
 		accepted?: boolean;
 		in_progress?: boolean;
 		ready?: boolean;
@@ -189,10 +186,12 @@ export interface Order {
 		shoppingcart?: {
 			total?: {
 				amount?: number;
+				meals?: number;
 			};
 			// Total of first cart on order. Carts can change after refunds, so this is original value
 			original_total?: {
 				amount?: number;
+				meals?: number;
 			};
 			[index: string]: any;
 		};
@@ -570,8 +569,10 @@ export interface GetOrderLocationBrandQuery {
 	order_type?: string;
 	// number of orders per page
 	limit?: number;
-	// return orders with all status types
+	// include not accepted checkin orders
 	all_statuses?: boolean;
+	// return orders with specific statuses. Comma separated list of status:value pairs. Example: ready:true,cancelled:true - will return orders that are ready or cancelled
+	status?: string;
 	// Graphql query string
 	_query?: string;
 }

package/src/interface/partner.ts

@@ -32,6 +32,23 @@ export interface ShoppingCartResponse {
 		app?: string;
 		discount?: Record<string, any>;
 		provider_data?: FPValidationData;
+		order?: {
+			items_applied_discount_amount?: number;
+			amount?: number;
+			items_discount_amount?: number;
+			total_amount?: number;
+			total_applied_discount_amount?: number;
+			total_discount_amount?: number;
+			items?: {
+				applied_discount_amount?: number;
+				amount?: number;
+				discount_amount?: number;
+				price?: number;
+				quantity?: number;
+				source_id?: string;
+				subtotal_amount?: number;
+			}[];
+		};
 	};
 	//@deprecated
 	loyalty?: {
@@ -44,15 +61,7 @@ export interface ShoppingCartResponse {
 		// Points to be earned for this shopping cart total
 		order_loyalty_points?: boolean;
 	};
-	discount?: {
-		code?: string;
-		provider?: 'fp' | 'voucherify';
-		amount_off?: MonetaryValue;
-		percent_off?: MonetaryValue;
-		amount?: MonetaryValue;
-		discount?: Record<string, any>;
-		provider_data?: FPValidationData;
-	};
+	discount?: ShoppingCartResponse['promo'];
 	payment_method?: {
 		// Mealplan payment details
 		mealplan?: {
@@ -123,10 +132,16 @@ export interface ShoppingCartResponse {
 		email_tax_exempt?: boolean;
 		// Indicates to clients that a tax recalculation is required
 		tax_calculation_required?: boolean;
+		// Indicates that the shopping cart is a system 365 shopping cart
+		system365?: boolean;
 	};
 	meta?: {
 		// Raw request from any vendor integrated with CDL
 		vendor?: Record<string, any>;
+		drain_order_type?: {
+			taxable?: boolean;
+			tax_exempt?: boolean;
+		};
 		[index: string]: any;
 	};
 }
@@ -138,6 +153,10 @@ export interface ItemResponse {
 	// index based on cdl id or stringified timestamp
 	_index?: string;
 	quantity: Quantity;
+	quantity_by_weight?: {
+		unit?: string;
+		value?: number;
+	};
 	unit?: number;
 	price?: Price;
 	// Final item price after LTO/Bundle/BOGO etc is applied on the item.
@@ -145,6 +164,7 @@ export interface ItemResponse {
 		active?: boolean;
 		amount?: MonetaryValue;
 	};
+	weighed_price?: Price;
 	// Subtotal of the item including all options
 	_subtotal?: {
 		amount?: MonetaryValue;
@@ -164,9 +184,16 @@ export interface ItemResponse {
 		brand?: string;
 		brand_label?: Label;
 		taxes?: string[];
+		tax?: {
+			tax_tag_code?: string;
+			tax_rate?: number;
+			tax_amount?: number;
+		};
 		menu_tax_tags?: string[];
 		orderable?: boolean;
 		volante_id?: string;
+		barcodes?: string[];
+		plu?: string;
 		[index: string]: any;
 	};
 	options?: {
@@ -175,6 +202,8 @@ export interface ItemResponse {
 		meta?: {
 			taxes?: string[];
 			original_label?: Label;
+			order_type?: 'selection' | 'option' | 'quantity';
+			surchage_limit_value?: number;
 		};
 		items?: {
 			// option/modifier
@@ -188,6 +217,11 @@ export interface ItemResponse {
 				sort_number?: number;
 				original_label?: Label;
 				taxes?: string[];
+				sizing?: {
+					name?: string;
+					price?: MonetaryValue;
+					posid?: string;
+				}[];
 			};
 			amount_off_exclusions?: AmountOffExclusion[];
 			is?: {
@@ -196,6 +230,8 @@ export interface ItemResponse {
 		}[];
 		is?: {
 			disabled?: boolean;
+			incremental?: boolean;
+			surchage_limit?: boolean;
 		};
 	}[];
 	// Details about discount like BOGO, LTO, Bundle etc.
@@ -206,8 +242,15 @@ export interface ItemResponse {
 	added_on?: string;
 	meal_value?: IntegerValue;
 	category?: Label;
+	menu_label?: Label;
 	tax_rate?: MonetaryValue;
 	label?: Label;
+	reporting?: {
+		category?: {
+			primary?: string;
+			secondary?: string;
+		};
+	};
 }
 
 export type MonetaryValue = number;
@@ -257,12 +300,62 @@ export interface Taxes {
 		combined_tax_rate?: MonetaryValue;
 		gst?: MonetaryValue;
 		pst?: MonetaryValue;
+		provider?: string;
 		[index: string]: any;
 	};
+	provider?: string;
+	quote_payload?: {
+		// a unique identifier representing the transaction
+		id: string;
+		// the app to associate the transaction with
+		appName: string;
+		// the order fulfillment type
+		transactionType: 'pickup' | 'delivery';
+		// numeric value of service fee
+		serviceFee?: number;
+		// numeric value of delivery fee
+		deliveryFee?: number;
+		// location data of the transaction
+		locationData: {
+			// unique location identifier
+			id: string;
+			// country of transaction
+			country: string;
+			// state or province of transaction
+			stateOrProvince: string;
+			// city of transaction
+			city: string;
+			// postal code of transaction
+			postalCode: string;
+			// street address of transaction
+			streetAddress: string;
+		};
+		// items to calculate tax on
+		items: {
+			// unique item identifier
+			id: string;
+			// indicates a tax rule for an item
+			taxTagCode: string;
+			// amount of an item
+			quantity: number;
+			// decimal price of an item
+			price: number;
+			// amount of tax charged on an item after funds are captured
+			taxedAmount?: number;
+		}[];
+		// iso timstamp of transaction date
+		transactionDate?: string;
+		// an array of items to refund
+		refunds?: {
+			// unique identifier of the refunded item
+			refundItemId: string;
+			// quantity amount of the item to be refunded
+			refundItemQuantity: number;
+		}[];
+	};
 }
 
 export interface LocationGroup {
-	// group
 	id?: string;
 	name?: string;
 	label?: {
@@ -274,13 +367,16 @@ export interface LocationGroup {
 	locations?: Location[];
 	address?: Address;
 	meta?: Record<string, any>;
-	style?: Record<string, any>;
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
 	timezone?: string;
 	[index: string]: any;
 }
 
 export interface Location {
-	// location
 	id?: string;
 	operation_id?: number;
 	name?: string;
@@ -296,11 +392,11 @@ export interface Location {
 	brands?: Brand[];
 	meta?: Record<string, any>;
 	phone?: string;
-	// group
+	// The CDL is representing the group of this location
 	location_group?: string;
-	// multigroup
+	// The CDL id representing the multigroup of this location
 	location_multigroup?: string;
-	// sector
+	// The CDL id representing the sector of this location
 	sector?: string;
 	date?: {
 		deleted?: string;
@@ -318,6 +414,7 @@ export interface Location {
 		};
 		logo?: string;
 		is?: {
+			enabled?: boolean;
 			pickup_supported?: boolean;
 			delivery_supported?: boolean;
 		};
@@ -345,7 +442,7 @@ export interface Location {
 export interface Brand {
 	// brand
 	id?: string;
-	// sector
+	// The CDL id representing the sector this brand belongs to
 	sector?: string;
 	name?: string;
 	label?: {
@@ -366,8 +463,12 @@ export interface Brand {
 	};
 	hours?: Hours[];
 	deliveryHours?: DeliveryHours[];
-	style?: Record<string, any>;
-	// pos
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
+	// The CDL id representing the PoS for this brand
 	pos?: string;
 	terminals?: Record<string, any>[];
 	device_mapping?: Record<
@@ -398,6 +499,7 @@ export interface Brand {
 	is?: {
 		pickup_supported?: boolean;
 		delivery_supported?: boolean;
+		frictionless_supported?: boolean;
 		plu_enabled?: boolean;
 		promo_exemptions_enabled?: boolean;
 		local_images_enabled?: boolean;
@@ -408,21 +510,21 @@ export interface Brand {
 		scan_and_go_supported?: boolean;
 		calories_edit_enabled?: boolean;
 		// admin panel toggle
-		special_instructions?: boolean;
+		special_instructions_enabled?: boolean;
 		dining_hall?: boolean;
 		[index: string]: any;
 	};
-	// brand
+	// The CDL id representing the brand
 	brand?: string;
-	// location
+	// The CDL id representing the location of this brand
 	location?: string;
 	// location group
 	group?: string;
-	// payment
+	// The CDL id representing the payment provider of this brand
 	payment_provider?: string;
 	//@deprecated
 	location_description?: string;
-	// company
+	// The CDL id representing the company of this brand
 	company?: string;
 	config?: {
 		private?: Record<string, any>;
@@ -462,6 +564,9 @@ export interface Brand {
 		software_integrations?: {
 			system365?: string;
 			jwo?: string;
+			nextep?: {
+				mobile_app?: boolean;
+			};
 		};
 		[index: string]: any;
 	};
@@ -504,7 +609,6 @@ export interface Address {
 }
 
 export interface MenuHours {
-	// menu
 	id?: string;
 	label?: {
 		en?: string;
@@ -515,10 +619,10 @@ export interface MenuHours {
 	is_frictionless?: boolean;
 	// Identifies a brand or menu state, i.e open, closed or accepting preorders
 	state?: 'open' | 'closed' | 'preorder';
+	is_disabled?: boolean;
 }
 
 export interface Hours {
-	// hours
 	id?: string;
 	date?: {
 		deleted?: string;
@@ -533,7 +637,6 @@ export interface Hours {
 }
 
 export interface DeliveryHours {
-	// hours
 	id?: string;
 	day?: {
 		start?: number;
@@ -592,6 +695,16 @@ export interface Menu {
 		last_modified_user?: string;
 		centricos?: boolean;
 		version?: number;
+		// V3 Brand metadata if menu came from Centric
+		brand?: {
+			id?: string;
+			name?: string;
+		};
+		// V3 Local Menu Group metadata if menu came from Centric
+		local_menu_group?: {
+			id?: string;
+			name?: string;
+		};
 		[index: string]: any;
 	};
 }
@@ -617,6 +730,8 @@ export interface Group {
 		price?: {
 			amount?: number;
 			currency?: string;
+			total_price?: number;
+			discount?: number;
 		};
 		// Meal exchange value of the item
 		meal_value?: number;
@@ -729,7 +844,6 @@ export interface Group {
 					sort_number?: number;
 					// menu sort order
 					menu_sort_number?: number;
-					plu?: string;
 					sizing?: {
 						name?: string;
 						posid?: string;
@@ -738,6 +852,28 @@ export interface Group {
 					tax?: {
 						tax_tag_code?: string;
 					};
+					recipe?: {
+						// menuworks mrn
+						mrn?: string;
+						// menuworks unit id
+						unit_id?: string;
+						// menuworks portion quantity
+						portion_quantity?: number;
+						// menuworks portion unit name
+						portion_unit_name?: string;
+						// menuworks grams
+						grams?: number;
+						// menuworks cost (per serving)
+						cost?: number;
+						// menuworks ingredients
+						ingredients?: string[];
+						// menuworks smart tags
+						smart_tags?: string[];
+						// menuworks allergen tags
+						allergen_tags?: string[];
+					};
+					// unique id of the entity
+					unique_id?: number;
 					[index: string]: any;
 				};
 				is?: {
@@ -746,6 +882,7 @@ export interface Group {
 					out_of_stock?: boolean;
 				};
 				amount_off_exclusions?: AmountOffExclusionTypes[];
+				line_route?: string;
 			}[];
 			min?: number;
 			max?: number;
@@ -754,10 +891,15 @@ export interface Group {
 				hidden?: boolean;
 				out_of_stock?: boolean;
 				incremental?: boolean;
+				surcharge_limit?: boolean;
 			};
 			meta?: {
 				// chit sort order
 				sort_number?: number;
+				// Type of mod group
+				order_type?: 'selection' | 'option' | 'quantity';
+				// # of modifiers before surcharge apply
+				surcharge_limit_value?: number;
 				// menu sort order
 				menu_sort_number?: number;
 				[index: string]: any;
@@ -772,13 +914,6 @@ export interface Group {
 				type_id?: number;
 				type?: string;
 			};
-			featured?: {
-				sort_number?: number;
-				dates?: {
-					start?: string;
-					end?: string;
-				};
-			};
 			// chit sort order
 			sort_number?: number;
 			// menu sort order
@@ -787,7 +922,32 @@ export interface Group {
 			barcodes?: string[];
 			tax?: {
 				tax_tag_code?: string;
+				tax_jwo_code?: string;
+				tax_rate?: number;
+				tax_amount?: number;
+			};
+			recipe?: {
+				// menuworks mrn
+				mrn?: string;
+				// menuworks unit id
+				unit_id?: string;
+				// menuworks portion quantity
+				portion_quantity?: number;
+				// menuworks portion unit name
+				portion_unit_name?: string;
+				// menuworks grams
+				grams?: number;
+				// menuworks cost (per serving)
+				cost?: number;
+				// menuworks ingredients
+				ingredients?: string[];
+				// menuworks smart tags
+				smart_tags?: string[];
+				// menuworks allergen tags
+				allergen_tags?: string[];
 			};
+			// unique id of the entity
+			unique_id?: number;
 		};
 		category?: {
 			en?: string;

package/src/interface/user.ts

@@ -10,7 +10,6 @@ export interface Error {
 }
 
 export interface User {
-	// user
 	id?: string;
 	email?: string;
 	name?: {
@@ -27,7 +26,7 @@ export interface User {
 	phone?: number;
 	// User phone country code in ISO 3166-1 alpha-2 format
 	phone_country_code?: string;
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 	gender?: 'male' | 'female' | 'non-binary';
 	meta?: UserMeta;
@@ -61,12 +60,12 @@ export interface GuestUserCreate {
 		first?: string;
 		last?: string;
 	};
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 }
 
 export interface GuestUserToken {
-	// realm
+	// The ID for the realm (Boost, Thrive, etc.) that the user belongs to
 	realm?: string;
 }
 
@@ -109,7 +108,6 @@ export interface auth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -121,7 +119,6 @@ export interface guestAuth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -139,7 +136,6 @@ export interface omsauth {
 		token?: string;
 		expires?: string;
 	};
-	// user
 	user?: string;
 	profile?: User;
 }
@@ -179,7 +175,7 @@ export interface KDSDevice {
 }
 
 export interface Checkin {
-	// checkin
+	// The ID for user check-in
 	checkin_id?: string;
 	// The colour that identifies the visit in hex code
 	colour?: string;
@@ -198,7 +194,6 @@ export interface Checkin {
 		// If the `User` is near or far from a store (as determined by the backend). If this is `false` for a prolonged period the client should assume the `User` is not in a standard store and stop trying to attach.
 		near_store?: boolean;
 	};
-	// user
 	user_id?: string;
 	date_queued?: string;
 	// The state of the user association process (attaching). Present for NFC check-ins only
@@ -258,7 +253,7 @@ export interface Key {
 }
 
 export interface UserDeviceAuthBody {
-	// KDS IDFA id
+	// The ID for the body of the user device's authentication
 	id?: string;
 	// CDL encoded id of a serial_number
 	serial_number?: string;
@@ -823,7 +818,6 @@ export interface GetUserProfileQuery {
 }
 
 export interface GetUserProfileResponse {
-	// user
 	id: string;
 	name: {
 		first?: string;