@compassdigital/sdk.typescript 4.113.0 → 4.115.0

package/src/interface/consumer.ts

@@ -161,8 +161,8 @@ export interface OrderMeta {
 
 export interface CustomerOrderBrandDTO {
 	id: string;
-	name: string;
-	location_description: string;
+	name?: string;
+	location_description?: string;
 }
 
 export interface OrderDate {
@@ -780,13 +780,247 @@ export interface HeroImage {
 	images: string[];
 }
 
+export interface HomePageOrder {
+	meta?: {
+		[index: string]: any;
+	} & OrderMeta;
+	id?: string;
+	reorder_eligibility?:
+		| 'eligible'
+		| 'order_type_ineligible'
+		| 'location_ineligible'
+		| 'active_order'
+		| 'old_order'
+		| 'marketplace_order'
+		| 'duplicate_order'
+		| 'brand_unavailable'
+		| 'menu_unavailable'
+		| 'items_unavailable'
+		| 'refunded_order'
+		| 'modifiers_unavailable'
+		| 'modified_items'
+		| 'cancelled_order';
+	location_brand?: string;
+	location?: string;
+	date?: OrderDate;
+	details?: OrderDetails;
+	requested_date?: string;
+	refunds?: OrderRefundItem[];
+	customer?: string;
+	pickup_id?: string;
+	payment?: OrderPayment;
+	mealplan?: OrderMealplan;
+	meal_swipes?: OrderMealSwipes;
+	is?: OrderIs;
+	issue?: OrderIssue;
+	shoppingcart?: string;
+}
+
+export interface ConsumerAddress {
+	suite?: string;
+	address?: string;
+	city?: string;
+	state?: string;
+	country?: string;
+	zip?: string;
+	coordinates?: {
+		latitude?: number;
+		longitude?: number;
+	};
+}
+
+export interface ConsumerMenuHours {
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	hours?: Record<string, any>[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	state?: Record<string, any>;
+	is_disabled?: boolean;
+}
+
+export interface ConsumerHours {
+	id?: string;
+	date?: {
+		deleted?: string;
+		start?: string;
+		end?: string;
+	};
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface ConsumerDeliveryHours {
+	id?: string;
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface ConsumerWaitTime {
+	max: number;
+	min: number;
+	ready_time: number;
+}
+
+export interface ConsumerBrand {
+	id?: string;
+	sector?: string;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	timezone?: string;
+	description?: string;
+	latitude?: number;
+	longitude?: number;
+	address?: ConsumerAddress;
+	menus?: ConsumerMenuHours[];
+	date?: {
+		deleted?: string;
+		created?: string;
+	};
+	hours?: ConsumerHours[];
+	deliveryHours?: ConsumerDeliveryHours[];
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
+	pos?: string;
+	terminals?: Record<string, any>[];
+	device_mapping?: Record<string, any>;
+	timeslots?: {
+		time?: string;
+		averagePrepTime?: string;
+		duration_minutes?: number;
+		customers_per_slot?: number;
+		menu_items_per_slot?: number;
+		delivery_time?: string;
+		delivery_customers_per_slot?: number;
+		delivery_menu_items_per_slot?: number;
+		delivery_prep_time?: string;
+		delivery_is_user_defined?: boolean;
+	};
+	brand?: string;
+	location?: string;
+	group?: string;
+	payment_provider?: string;
+	location_description?: string;
+	company?: string;
+	config?: {
+		private?: Record<string, any>;
+		public?: Record<string, any>;
+	};
+	tax_rate?: number;
+	descriptions?: {
+		location: {
+			en?: string;
+			fr?: string;
+		};
+	};
+	estimated_wait_time?: {
+		delivery?: ConsumerWaitTime;
+		pickup?: ConsumerWaitTime;
+	};
+	state?: {
+		pickup?: Record<string, any>;
+		delivery?: Record<string, any>;
+	};
+}
+
+export interface ConsumerLocation {
+	id?: string;
+	operation_id?: number;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	search?: string[];
+	app?: string;
+	address?: ConsumerAddress;
+	latitude?: number;
+	longitude?: number;
+	brands?: ConsumerBrand[];
+	meta?: Record<string, any>;
+	phone?: string;
+	location_group?: string;
+	location_multigroup?: string;
+	sector?: string;
+	date?: {
+		deleted?: string;
+		created?: string;
+		modified?: string;
+	};
+	market_place?: {
+		label: {
+			en?: string;
+			fr?: string;
+		};
+		location_description: {
+			en?: string;
+			fr?: string;
+		};
+		logo?: string;
+		is: {
+			enabled?: boolean;
+			pickup_supported?: boolean;
+			delivery_supported?: boolean;
+		};
+		delivery_details: {
+			show_single_timeslot?: boolean;
+			show_instructions?: boolean;
+			runner_app_enabled?: boolean;
+		};
+		delivery_destinations?: string[];
+		pickup_instruction: {
+			en?: string;
+			fr?: string;
+		};
+		hours?: ConsumerHours[];
+		deliveryHours?: ConsumerDeliveryHours[];
+		service_fee: {
+			type?: string;
+			value?: number;
+		};
+	};
+}
+
+export interface ConsumerGroup {
+	id?: string;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	distance?: number;
+	locations?: ConsumerLocation[];
+	address?: ConsumerAddress;
+	meta?: Record<string, any>;
+	style?: {
+		logo?: string | null;
+		main_logo?: string | null;
+		alt_logo?: string | null;
+	};
+	timezone?: string;
+}
+
 export interface HomePageResponse {
 	greetingMessage: DiverseGreetingMessages;
 	heroImages: HeroImage;
 	// array of orders
-	orders?: Record<string, any>[];
-	// location object for the site
-	location?: Record<string, any>;
+	orders?: HomePageOrder[];
+	location?: ConsumerGroup;
 }
 
 export interface FrictionlessCheckinResponse {
@@ -863,12 +1097,12 @@ export interface GetConsumerLocationMultiGroupResponse {
 	// name
 	name: string;
 	// groups
-	groups: Record<string, any>[];
+	groups: ConsumerGroup[];
 }
 
 export interface ConsumerGetActiveMenusResponse {
 	// menus
-	menus: Record<string, any>[];
+	menus: ConsumerMenuHours[];
 }
 
 export interface GetConsumerMenuResponse {
@@ -883,7 +1117,7 @@ export interface GetConsumerMenuResponse {
 		en?: string;
 	};
 	// menu groups
-	groups: Record<string, any>[];
+	groups: ConsumerGroup[];
 	// menu parent id
 	parent_id: string;
 	// menu location brand
@@ -910,11 +1144,166 @@ export interface GetConsumerMenuResponse {
 	meta?: Record<string, any>;
 }
 
+export interface ConsumerOption {
+	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 {
+	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 {
+	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>;
 	// items
-	items: Record<string, any>[];
+	items: ConsumerItem[];
 }
 
 export interface PostConsumerRecommendedRequest {
@@ -927,14 +1316,23 @@ export interface PostConsumerRecommendedResponse {
 	items: string[];
 }
 
+export interface ConsumerTimeslot {
+	id?: number;
+	brand_id?: string;
+	start_time?: string;
+	duration?: string;
+	is_available?: boolean;
+	number_orders?: number;
+}
+
 export interface PostConsumerLocationMarketplaceTimeslotsResponse {
 	// The timeslots
-	timeslots?: Record<string, any>[];
+	timeslots?: ConsumerTimeslot[];
 }
 
 export interface PostConsumerLocationMarketplaceTimeslotsDeliveryResponse {
 	// The timeslots
-	timeslots?: Record<string, any>[];
+	timeslots?: ConsumerTimeslot[];
 }
 
 export interface ConsumerDeleteUserResponse {
@@ -954,6 +1352,43 @@ export interface PostConsumerUserChangePasswordRequest {
 	new_password: string;
 }
 
+export interface ConsumerCashlessLog {
+	added?: string;
+	deleted?: string;
+}
+
+export interface ConsumerUserMeta {
+	marketing_opt_in?: boolean;
+	marketing_opt_in_date?: string;
+	marketing_opt_in_source?: Record<string, any>;
+	order_status_notification?: {
+		send_emails?: boolean;
+		send_emails_date_updated?: string;
+	};
+	mealplan_added_date?: string;
+	login_limit?: {
+		login_attempts?: number;
+		last_attempt_date?: string;
+	};
+	password_verification?: {
+		attempts?: number;
+		first_attempted?: string;
+	};
+	phone_verification?: {
+		verification_code?: string;
+		date_generated?: number;
+		failed_attempts?: number;
+		consecutive_failed_attempts?: number;
+	};
+	cashless?: {
+		stipend?: ConsumerCashlessLog;
+		voucher?: ConsumerCashlessLog;
+		badge_pay?: ConsumerCashlessLog;
+		coupon_voucher?: ConsumerCashlessLog;
+	};
+	last_location?: string;
+}
+
 export interface PostConsumerUserChangePasswordResponse {
 	// The ID of the user
 	id: string;
@@ -969,13 +1404,20 @@ export interface PostConsumerUserChangePasswordResponse {
 	};
 	// The gender of the user
 	gender?: Record<string, any>;
-	meta?: Record<string, any>;
+	meta?: ConsumerUserMeta;
 	is?: {
 		locked_out?: boolean;
 		verified?: boolean;
 	};
 }
 
+export type ConsumerAcl = Record<string, any>;
+
+export interface ConsumerScopes {
+	scopes?: string[];
+	acl?: ConsumerAcl;
+}
+
 export interface PutConsumerUserRequest {
 	id?: string;
 	email?: string;
@@ -993,7 +1435,7 @@ export interface PutConsumerUserRequest {
 	phone_country_code?: string;
 	realm?: string;
 	gender?: Record<string, any>;
-	meta?: Record<string, any>;
+	meta?: ConsumerUserMeta;
 	is?: {
 		disabled?: boolean;
 		locked_out?: boolean;
@@ -1002,7 +1444,7 @@ export interface PutConsumerUserRequest {
 		deleted?: boolean;
 		placeholder?: boolean;
 	};
-	permissions?: Record<string, any>;
+	permissions?: ConsumerScopes;
 	location_group?: string;
 	ssoId?: string;
 }
@@ -1032,8 +1474,9 @@ export interface PutConsumerUserResponse {
 	realm?: string;
 	// The gender of the user
 	gender?: Record<string, any>;
-	// The meta of the user
-	meta?: Record<string, any>;
+	meta?: {
+		[index: string]: any;
+	} & ConsumerUserMeta;
 	is?: {
 		disabled?: boolean;
 		locked_out?: boolean;
@@ -1042,8 +1485,7 @@ export interface PutConsumerUserResponse {
 		deleted?: boolean;
 		placeholder?: boolean;
 	};
-	// The permissions of the user
-	permissions?: Record<string, any>;
+	permissions?: ConsumerScopes;
 	// The location group of the user
 	location_group?: string;
 	// The ssoId of the user
@@ -1075,8 +1517,9 @@ export interface GetConsumerUserResponse {
 	realm?: string;
 	// The gender of the user
 	gender?: Record<string, any>;
-	// The meta of the user
-	meta?: Record<string, any>;
+	meta?: {
+		[index: string]: any;
+	} & ConsumerUserMeta;
 	is?: {
 		disabled?: boolean;
 		locked_out?: boolean;
@@ -1085,8 +1528,7 @@ export interface GetConsumerUserResponse {
 		deleted?: boolean;
 		placeholder?: boolean;
 	};
-	// The permissions of the user
-	permissions?: Record<string, any>;
+	permissions?: ConsumerScopes;
 	// The location group of the user
 	location_group?: string;
 	// The ssoId of the user
@@ -1217,6 +1659,44 @@ export interface PutConsumerShoppingCartResponse {
 	};
 }
 
+export interface PostConsumerPromoValidateRequest {
+	// The code of the promo voucher
+	code?: string;
+	// The email of the customer
+	email?: string;
+	// The app of the customer
+	app?: string;
+	// The realm of the customer
+	realm?: string;
+	// The location brand of the customer
+	location_brand?: string;
+	shoppingcart?: {
+		id?: string;
+		date_created?: string;
+		items?: ShoppingcartItem[];
+	};
+	totals?: {
+		amount?: number;
+		currency?: string;
+	};
+}
+
+export interface ConsumerAppliedDiscount {
+	type?: string;
+	amount_off?: number;
+	percent_off?: number;
+	amount_limit?: number;
+}
+
+export interface ConsumerVoucher {
+	provider?: Record<string, any>;
+	code?: string;
+	valid?: boolean;
+	discount?: ConsumerAppliedDiscount;
+	app?: string;
+	provider_data?: ShoppingcartFPValidationData;
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -1548,3 +2028,9 @@ export interface PutConsumerShoppingcartPath {
 export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
 
 export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;
+
+// POST /consumer/promo/validate - Validate a promo voucher
+
+export type PostConsumerPromoValidateBody = PostConsumerPromoValidateRequest;
+
+export type PostConsumerPromoValidateResponse = ConsumerVoucher;

package/src/interface/location.ts

@@ -602,6 +602,18 @@ export interface PatchLocationRequest extends BaseRequest, PatchLocationPath {
 	body: PatchLocationBody;
 }
 
+// POST /location/batch-get - Get multiple locations by their IDs
+
+export interface PostLocationBatchGetBody {
+	ids?: string[];
+}
+
+export type PostLocationBatchGetResponse = Locations;
+
+export interface PostLocationBatchGetRequest extends BaseRequest {
+	body: PostLocationBatchGetBody;
+}
+
 // GET /location/multigroup - Get all the top level multigroups
 
 export interface GetLocationMultigroupsQuery {
@@ -830,6 +842,18 @@ export interface PatchLocationGroupRequest extends BaseRequest, PatchLocationGro
 	body: PatchLocationGroupBody;
 }
 
+// POST /location/group/batch-get - Get multiple location groups by their IDs
+
+export interface PostLocationGroupBatchGetBody {
+	ids?: string[];
+}
+
+export type PostLocationGroupBatchGetResponse = Groups;
+
+export interface PostLocationGroupBatchGetRequest extends BaseRequest {
+	body: PostLocationGroupBatchGetBody;
+}
+
 // GET /location/group/{id}/waittimes - Get an individual Group's estimated wait times based on id
 
 export interface GetLocationGroupWaittimesPath {

package/src/interface/mealplan.ts

@@ -217,7 +217,9 @@ export interface DeleteMealplanTenderBody {
 	type?: string;
 	conversion_amount?: number;
 	terminal_id?: string;
-	card_data?: string;
+	overrides?: {
+		credentials?: string;
+	};
 	drain_order_type?: {
 		taxable?: boolean;
 		tax_exempt?: boolean;
@@ -257,7 +259,9 @@ export interface PatchMealplanTenderBody {
 	// Amount for order paid by user
 	transaction_amount?: number;
 	terminal_id?: string;
-	card_data?: string;
+	overrides?: {
+		credentials?: string;
+	};
 }
 
 export type PatchMealplanTenderResponse = Tender;
@@ -276,7 +280,9 @@ export interface PostMealplanTenderPath {
 }
 
 export interface PostMealplanTenderBody {
-	card_data?: string;
+	overrides?: {
+		credentials?: string;
+	};
 }
 
 export type PostMealplanTenderResponse = Tender;