@compassdigital/sdk.typescript 4.111.0 → 4.113.0

package/src/interface/consumer.ts

@@ -488,7 +488,7 @@ export interface ShoppingcartItem {
 export interface ShoppingcartDiscountIncentives {
 	id?: string;
 	program?: {
-		code: string;
+		code?: string;
 	};
 }
 
@@ -762,18 +762,6 @@ export interface PostReviewOrderItemsResponseDTO {
 	reviews: OrderItemReview[];
 }
 
-export interface HomePageRequest {
-	// site id
-	siteId: string;
-	// start date as a long
-	start: number;
-	// end date as a long
-	end: number;
-	// current date as a long
-	date: number;
-	reorderEligible: boolean;
-}
-
 export interface LocalizedGreetingMessage {
 	en: string;
 	fr: string;
@@ -795,9 +783,10 @@ export interface HeroImage {
 export interface HomePageResponse {
 	greetingMessage: DiverseGreetingMessages;
 	heroImages: HeroImage;
-	orders: Record<string, any>[][];
+	// array of orders
+	orders?: Record<string, any>[];
 	// location object for the site
-	location: Record<string, any>;
+	location?: Record<string, any>;
 }
 
 export interface FrictionlessCheckinResponse {
@@ -921,6 +910,313 @@ export interface GetConsumerMenuResponse {
 	meta?: Record<string, any>;
 }
 
+export interface GetConsumerMenuItemsResponse {
+	// meta
+	meta?: Record<string, any>;
+	// items
+	items: Record<string, any>[];
+}
+
+export interface PostConsumerRecommendedRequest {
+	// excluded items
+	excludedItems: string[];
+}
+
+export interface PostConsumerRecommendedResponse {
+	// items
+	items: string[];
+}
+
+export interface PostConsumerLocationMarketplaceTimeslotsResponse {
+	// The timeslots
+	timeslots?: Record<string, any>[];
+}
+
+export interface PostConsumerLocationMarketplaceTimeslotsDeliveryResponse {
+	// The timeslots
+	timeslots?: Record<string, any>[];
+}
+
+export interface ConsumerDeleteUserResponse {
+	// success
+	success: boolean;
+}
+
+export interface ConsumerDeleteUserLogoutResponse {
+	// success
+	success: boolean;
+}
+
+export interface PostConsumerUserChangePasswordRequest {
+	// password
+	password: string;
+	// new_password
+	new_password: string;
+}
+
+export interface PostConsumerUserChangePasswordResponse {
+	// The ID of the user
+	id: string;
+	// The email of the user
+	email: string;
+	name?: {
+		first?: string;
+		last?: string;
+	};
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	// The gender of the user
+	gender?: Record<string, any>;
+	meta?: Record<string, any>;
+	is?: {
+		locked_out?: boolean;
+		verified?: boolean;
+	};
+}
+
+export interface PutConsumerUserRequest {
+	id?: string;
+	email?: string;
+	name?: {
+		first?: string;
+		last?: string;
+	};
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	birthday?: string;
+	password?: string;
+	phone?: number;
+	phone_country_code?: string;
+	realm?: string;
+	gender?: Record<string, any>;
+	meta?: Record<string, any>;
+	is?: {
+		disabled?: boolean;
+		locked_out?: boolean;
+		verified?: boolean;
+		phone_verified?: boolean;
+		deleted?: boolean;
+		placeholder?: boolean;
+	};
+	permissions?: Record<string, any>;
+	location_group?: string;
+	ssoId?: string;
+}
+
+export interface PutConsumerUserResponse {
+	// The ID of the user
+	id: string;
+	// The email of the user
+	email: string;
+	name?: {
+		first?: string;
+		last?: string;
+	};
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	// The birthday of the user
+	birthday?: string;
+	// The password of the user
+	password?: string;
+	// The phone of the user
+	phone?: number;
+	// The phone country code of the user
+	phone_country_code?: string;
+	// The realm of the user
+	realm?: string;
+	// The gender of the user
+	gender?: Record<string, any>;
+	// The meta of the user
+	meta?: Record<string, any>;
+	is?: {
+		disabled?: boolean;
+		locked_out?: boolean;
+		verified?: boolean;
+		phone_verified?: boolean;
+		deleted?: boolean;
+		placeholder?: boolean;
+	};
+	// The permissions of the user
+	permissions?: Record<string, any>;
+	// The location group of the user
+	location_group?: string;
+	// The ssoId of the user
+	ssoId?: string;
+}
+
+export interface GetConsumerUserResponse {
+	// The ID of the user
+	id: string;
+	// The email of the user
+	email: string;
+	name?: {
+		first?: string;
+		last?: string;
+	};
+	date?: {
+		created?: string;
+		modified?: string;
+	};
+	// The birthday of the user
+	birthday?: string;
+	// The password of the user
+	password?: string;
+	// The phone of the user
+	phone?: number;
+	// The phone country code of the user
+	phone_country_code?: string;
+	// The realm of the user
+	realm?: string;
+	// The gender of the user
+	gender?: Record<string, any>;
+	// The meta of the user
+	meta?: Record<string, any>;
+	is?: {
+		disabled?: boolean;
+		locked_out?: boolean;
+		verified?: boolean;
+		phone_verified?: boolean;
+		deleted?: boolean;
+		placeholder?: boolean;
+	};
+	// The permissions of the user
+	permissions?: Record<string, any>;
+	// The location group of the user
+	location_group?: string;
+	// The ssoId of the user
+	ssoId?: string;
+}
+
+export interface GetConsumerShoppingCartResponse {
+	id?: string;
+	location?: string;
+	menu?: string;
+	brand?: string;
+	date?: Record<string, any>;
+	items?: ShoppingcartItem[];
+	sub_total?: {
+		amount?: number;
+	};
+	promo?: ShoppingcartPromoDetails;
+	loyalty?: {
+		coupon: {
+			code?: string;
+			amount_off?: number;
+			amount?: number;
+			name?: string;
+		};
+		order_loyalty_points?: boolean;
+	};
+	discount?: ShoppingcartPromoDetails;
+	payment_method?: ShoppingcartPaymentMethod;
+	taxes?: ShoppingcartTaxes;
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	exemptions?: {
+		tax?: boolean;
+	};
+	order?: {
+		id?: string;
+	};
+	service_fee?: {
+		amount?: number;
+	};
+	delivery_fee?: {
+		amount?: number;
+	};
+	is?: {
+		type?: Record<string, any>;
+		mx_cart?: boolean;
+		email_tax_exempt?: boolean;
+		tax_calculation_required?: boolean;
+		system365?: boolean;
+	};
+}
+
+export interface ConsumerLabel {
+	en?: string;
+	fr?: string;
+}
+
+export interface ConsumerModifierGroupRequest {
+	label?: ConsumerLabel;
+	id?: string;
+	items?: ConsumerModifierGroupRequest[];
+}
+
+export interface ConsumerItemRequest {
+	id: string;
+	quantity: number;
+	quantity_by_weight?: {
+		unit?: string;
+		value?: number;
+	};
+	options?: ConsumerModifierGroupRequest[];
+	_index?: string;
+	special_instructions?: string;
+	amount_off_exclusions?: Record<string, any>[];
+}
+
+export interface PutConsumerShoppingCartItemsRequest {
+	items?: ConsumerItemRequest[];
+}
+
+export interface PutConsumerShoppingCartResponse {
+	id?: string;
+	location?: string;
+	menu?: string;
+	brand?: string;
+	date?: Record<string, any>;
+	items?: ShoppingcartItem[];
+	sub_total?: {
+		amount?: number;
+	};
+	promo?: ShoppingcartPromoDetails;
+	loyalty?: {
+		coupon: {
+			code?: string;
+			amount_off?: number;
+			amount?: number;
+			name?: string;
+		};
+		order_loyalty_points?: boolean;
+	};
+	discount?: ShoppingcartPromoDetails;
+	payment_method?: ShoppingcartPaymentMethod;
+	taxes?: ShoppingcartTaxes;
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	exemptions?: {
+		tax?: boolean;
+	};
+	order?: {
+		id?: string;
+	};
+	service_fee?: {
+		amount?: number;
+	};
+	delivery_fee?: {
+		amount?: number;
+	};
+	is?: {
+		type?: Record<string, any>;
+		mx_cart?: boolean;
+		email_tax_exempt?: boolean;
+		tax_calculation_required?: boolean;
+		system365?: boolean;
+	};
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -967,11 +1263,27 @@ export type PostReviewOrderItemsBody = PostReviewOrderItemsRequestDTO;
 
 export type PostReviewOrderItemsResponse = PostReviewOrderItemsResponseDTO;
 
-// POST /consumer/home - Provide the front end all the data required to render the home page
+// GET /consumer/home/{siteId} - Provide the front end all the data required to render the home page
+
+export interface GetConsumerHomePagePath {
+	// Site ID as Encoded CDL ID
+	siteId: string;
+}
 
-export type PostHomePageBody = HomePageRequest;
+export interface GetConsumerHomePageQuery {
+	// order start time in epoch time
+	start: number;
+	// order end time in epoch time
+	end: number;
+	// current date in epoch time
+	date: number;
+	// reorder eligible
+	reorderEligible: boolean;
+	// Graphql query string
+	_query?: string;
+}
 
-export type PostHomePageResponse = HomePageResponse;
+export type GetConsumerHomePageResponse = HomePageResponse;
 
 // GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
 
@@ -1005,7 +1317,7 @@ export type PostConsumerAddSecretResponse = AddUserSecretResponse;
 // GET /consumer/location-group/{id} - Get location group
 
 export interface GetConsumerLocationGroupPath {
-	// TODO: add parameter to swagger.json
+	// Location Group ID as Encoded CDL ID; TODO: mark parameter as required in swagger
 	id: string;
 }
 
@@ -1034,8 +1346,6 @@ export interface GetConsumerLocationGroupQuery {
 	_query?: string;
 	// Latitude of the user
 	nocache?: boolean;
-	// Location Group ID as Encoded CDL ID
-	id?: string;
 }
 
 export type GetConsumerLocationGroupResponse$0 = GetConsumerLocationGroupResponse;
@@ -1043,7 +1353,7 @@ export type GetConsumerLocationGroupResponse$0 = GetConsumerLocationGroupRespons
 // GET /consumer/location-multigroup/{id} - Get location multi group
 
 export interface GetConsumerLocationMultigroupPath {
-	// TODO: add parameter to swagger.json
+	// Location Group ID as Encoded CDL ID; TODO: mark parameter as required in swagger
 	id: string;
 }
 
@@ -1069,8 +1379,6 @@ export interface GetConsumerLocationMultigroupQuery {
 	// Graphql query string
 	_query?: string;
 	nocache?: boolean;
-	// Location Group ID as Encoded CDL ID
-	id?: string;
 }
 
 export type GetConsumerLocationMultigroupResponse = GetConsumerLocationMultiGroupResponse;
@@ -1078,13 +1386,13 @@ export type GetConsumerLocationMultigroupResponse = GetConsumerLocationMultiGrou
 // GET /consumer/active-menus/{stationId} - Get current menu
 
 export interface GetConsumerActiveMenusPath {
+	// Station ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
 	// TODO: add parameter to swagger.json
 	stationId: string;
 }
 
 export interface GetConsumerActiveMenusQuery {
-	// Station ID as Encoded CDL ID
-	id?: string;
 	// current time in epoch time
 	currentTime: number;
 	// is pickup
@@ -1100,6 +1408,7 @@ export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
 // GET /consumer/menu/{id} - Provide the front end all the data required to render the home page
 
 export interface GetConsumerMenuPath {
+	// Menu ID as Encoded CDL ID; TODO: mark parameter as required in swagger
 	id: string;
 }
 
@@ -1109,3 +1418,133 @@ export interface GetConsumerMenuQuery {
 }
 
 export type GetConsumerMenuResponse$0 = GetConsumerMenuResponse;
+
+// GET /consumer/menu/{id}/items - Provide the front end with menu items
+
+export interface GetConsumerMenuItemsPath {
+	// Menu ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export interface GetConsumerMenuItemsQuery {
+	// Comma separated barcodes
+	barcodes: string;
+	// Brand ID
+	brand_id: string;
+	// GraphQL query
+	query: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerMenuItemsResponse$0 = GetConsumerMenuItemsResponse;
+
+// POST /consumer/menu/{id}/recommended - Get recommended items
+
+export interface PostConsumerMenuRecommendedItemsPath {
+	// Menu ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export type PostConsumerMenuRecommendedItemsBody = PostConsumerRecommendedRequest;
+
+export type PostConsumerMenuRecommendedItemsResponse = PostConsumerRecommendedResponse;
+
+// POST /consumer/location/marketplace/timeslots - Get Marketplace timeslots
+
+export interface PostConsumerLocationsMarketplaceTimeslotsQuery {
+	// Date of the timeslot
+	date?: number;
+	// Limit the number of timeslots returned
+	limit?: number;
+}
+
+export type PostConsumerLocationsMarketplaceTimeslotsResponse =
+	PostConsumerLocationMarketplaceTimeslotsResponse;
+
+// POST /consumer/location/marketplace/timeslots/delivery - Get Marketplace timeslots
+
+export interface PostConsumerLocationsMarketplaceTimeslotsDeliveryQuery {
+	// Date of the timeslot
+	date?: number;
+	// Limit the number of timeslots returned
+	limit?: number;
+}
+
+export type PostConsumerLocationsMarketplaceTimeslotsDeliveryResponse =
+	PostConsumerLocationMarketplaceTimeslotsDeliveryResponse;
+
+// DELETE /consumer/user/{id} - Delete user
+
+export interface DeleteConsumerUserPath {
+	id: string;
+}
+
+export interface DeleteConsumerUserQuery {
+	// Use ACL permission system
+	acl?: boolean;
+}
+
+export type DeleteConsumerUserResponse = ConsumerDeleteUserResponse;
+
+// PUT /consumer/user/{id} - Change password
+
+export interface PutConsumerUserPath {
+	id: string;
+}
+
+export type PutConsumerUserBody = PutConsumerUserRequest;
+
+export type PutConsumerUserResponse$0 = PutConsumerUserResponse;
+
+// GET /consumer/user/{id} - Get user
+
+export interface GetConsumerUserPath {
+	id: string;
+}
+
+export interface GetConsumerUserQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerUserResponse$0 = GetConsumerUserResponse;
+
+// DELETE /consumer/user/logout - Delete user
+
+export type DeleteConsumerLogoutResponse = ConsumerDeleteUserLogoutResponse;
+
+// POST /consumer/user/{id}/changepassword - Change password
+
+export interface PostConsumerChangePasswordPath {
+	id: string;
+}
+
+export type PostConsumerChangePasswordBody = PostConsumerUserChangePasswordRequest;
+
+export type PostConsumerChangePasswordResponse = PostConsumerUserChangePasswordResponse;
+
+// GET /consumer/shoppingcart/{id} - Get a shopping cart by ID
+
+export interface GetConsumerShoppingcartPath {
+	// Shopping Cart ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export interface GetConsumerShoppingcartQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerShoppingcartResponse = GetConsumerShoppingCartResponse;
+
+// PUT /consumer/shoppingcart/{id} - Update a shopping cart by ID
+
+export interface PutConsumerShoppingcartPath {
+	// Shopping Cart ID as Encoded CDL ID; TODO: mark parameter as required in swagger
+	id: string;
+}
+
+export type PutConsumerShoppingcartBody = PutConsumerShoppingCartItemsRequest;
+
+export type PutConsumerShoppingcartResponse = PutConsumerShoppingCartResponse;

package/src/interface/mealplan.ts

@@ -266,6 +266,25 @@ export interface PatchMealplanTenderRequest extends BaseRequest, PatchMealplanTe
 	body: PatchMealplanTenderBody;
 }
 
+// POST /mealplan/{id}/tender/{tender} - Check the user's tender balance
+
+export interface PostMealplanTenderPath {
+	// Meal plan ID
+	id: string;
+	// Tender ID
+	tender: string;
+}
+
+export interface PostMealplanTenderBody {
+	card_data?: string;
+}
+
+export type PostMealplanTenderResponse = Tender;
+
+export interface PostMealplanTenderRequest extends BaseRequest, PostMealplanTenderPath {
+	body: PostMealplanTenderBody;
+}
+
 // POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
 
 export interface PostMealplanVerifyPath {

package/src/interface/menu.ts

@@ -443,6 +443,7 @@ export interface DraftBrandDTO {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -466,6 +467,7 @@ export interface PublishedBrandDTO {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: Record<string, any>;
 	permissions?: Record<string, any>;
@@ -2942,6 +2944,7 @@ export interface PostMenuV3DraftBrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3014,6 +3017,7 @@ export interface PatchMenuV3DraftBrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3108,6 +3112,7 @@ export type PostMenuV3DraftBrandsBody = {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -3614,6 +3619,7 @@ export interface PostMenuV3BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
@@ -3684,6 +3690,7 @@ export interface PatchMenuV3BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	version?: number;
@@ -3778,6 +3785,7 @@ export type PostMenuV3BrandsBody = {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	local_menu_group?: LocalMenuGroupDTO;
@@ -7236,6 +7244,7 @@ export interface PostMenuV4BrandBody {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7277,6 +7286,7 @@ export interface PostMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7335,6 +7345,7 @@ export interface GetMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;
@@ -7388,6 +7399,7 @@ export interface DeleteMenuV4BrandResponse {
 	global_menu_group_id?: string;
 	posid_segment?: string;
 	is_simplified_view?: boolean;
+	auto_push_to_local?: boolean;
 	frictionless_partner?: string;
 	meta?: BrandMeta;
 	applied_diff_snapshot?: Record<string, any>;