@compassdigital/sdk.typescript 4.326.0 → 4.328.0

package/src/messages/events/LocationGroupCreatedEvent.ts

@@ -1,5 +1,270 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export interface Group {
+	id?: string;
+	// ISO timestamp when the group was soft deleted
+	deleted_at?: string;
+	name?: string;
+	label?: Label;
+	// Distance in meters from the group
+	distance?: number;
+	locations?: Location[];
+	address?: Address;
+	meta?: Record<string, any>;
+	style?: {
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
+		appThemeId?: string;
+	};
+	timezone?: string;
+	device_mapping?: Record<string, DeviceMapping[]>;
+	date?: DateInfo;
+	[index: string]: any;
+}
+
+export interface Location {
+	id?: string;
+	// ISO timestamp when the location was soft deleted
+	deleted_at?: string;
+	operation_id?: number;
+	name?: string;
+	label?: Label;
+	sequence?: number;
+	search?: string[];
+	app?: string;
+	address?: Address;
+	latitude?: number;
+	longitude?: number;
+	brands?: Brand[];
+	meta?: Record<string, any>;
+	phone?: string;
+	// The CDL is representing the group of this location
+	location_group?: string;
+	// The CDL id representing the multigroup of this location
+	location_multigroup?: string;
+	// The CDL id representing the sector of this location
+	sector?: string;
+	date?: DateInfo;
+	market_place?: MarketPlace;
+	[index: string]: any;
+}
+
+export interface Address {
+	// Suite number of the address, if applicable
+	suite?: string;
+	// First line of the address, should include street number
+	address?: string;
+	// City of the address
+	city?: string;
+	// State of the address, also province in Canada
+	state?: string;
+	// Country of the address
+	country?: string;
+	// Zip code or postal code of the address
+	zip?: string;
+	coordinates?: {
+		// latitude of the the address
+		latitude?: number;
+		// longitude of the the address
+		longitude?: number;
+	};
+}
+
+export interface Label {
+	en?: string;
+	fr?: string;
+}
+
+export interface DateInfo {
+	deleted?: string;
+	created?: string;
+	modified?: string;
+}
+
+export interface DeviceMapping {
+	device_type?: string;
+	site_device_id?: string;
+	name?: string;
+	business_units?: string[];
+}
+
+export interface BrandDeviceMapping {
+	device_type: string;
+	site_device_id: string;
+	business_units?: string[];
+}
+
+export interface Brand {
+	// brand
+	id?: string;
+	// ISO timestamp when the brand was soft deleted
+	deleted_at?: string;
+	// The CDL id representing the sector this brand belongs to
+	sector?: string;
+	name?: string;
+	label?: Label;
+	sequence?: number;
+	timezone?: string;
+	description?: string;
+	address?: Address;
+	menus?: MenuHours[];
+	date?: DateInfo;
+	hours?: Hours[];
+	deliveryHours?: DeliveryHours[];
+	style?: {
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
+	};
+	// The CDL id representing the PoS for this brand
+	pos?: string;
+	terminals?: Record<string, any>[];
+	device_mapping?: Record<string, BrandDeviceMapping[]>;
+	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;
+		delivery_user_defined?: {
+			start_time: string;
+			end_time: string;
+			delivery_destinations?: string[];
+		}[];
+	};
+	is?: {
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		frictionless_supported?: boolean;
+		plu_enabled?: boolean;
+		promo_exemptions_enabled?: boolean;
+		local_images_enabled?: boolean;
+		hidden?: boolean;
+		show_in_kiosk?: boolean;
+		show_in_pos?: boolean;
+		item_desc_edit_enabled?: boolean;
+		scan_and_go_supported?: boolean;
+		calories_edit_enabled?: boolean;
+		special_instructions_enabled?: boolean;
+		dining_hall?: boolean;
+		[index: string]: any;
+	};
+	// The CDL id representing the brand
+	brand?: string;
+	// The CDL id representing the location of this brand
+	location?: string;
+	// location group
+	group?: string;
+	// The CDL id representing the payment provider of this brand
+	payment_provider?: string;
+	// @deprecated
+	location_description?: string;
+	// The CDL id representing the company of this brand
+	company?: string;
+	config?: {
+		private?: Record<string, any>;
+		public?: Record<string, any>;
+	};
+	tax_rate?: number;
+	meta?: Record<string, any>;
+	descriptions?: {
+		location?: Label;
+	};
+	estimated_wait_time?: {
+		delivery?: WaitTime;
+		pickup?: WaitTime;
+	};
+	state?: {
+		pickup?: BrandOrMenuState;
+		delivery?: BrandOrMenuState;
+	};
+}
+
+export interface MenuHours {
+	id?: string;
+	label?: Label;
+	hours?: Hours[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	state?: BrandOrMenuState;
+	is_disabled?: boolean;
+}
+
+export interface Hours {
+	id?: string;
+	date?: {
+		deleted?: string;
+		start?: string;
+		end?: string;
+	};
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface DeliveryHours {
+	id?: string;
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface WaitTime {
+	// maxium wait time to the next time slot in minutes
+	max: number;
+	// minimum wait time to the next time slot in minutes
+	min: number;
+	// the epoch timestamp of the next available ready time for a station
+	ready_time: number;
+}
+
+export type BrandOrMenuState = 'open' | 'closed' | 'preorder';
+
+export interface MarketPlace {
+	stations?: Station[];
+	label?: Label;
+	location_description?: Label;
+	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?: Label;
+	hours?: Hours[];
+	deliveryHours?: DeliveryHours[];
+	service_fee?: {
+		type?: string;
+		value?: number;
+	};
+	[index: string]: any;
+}
+
+export interface Station {
+	// The CDL id representing the brand of the station object
+	brand?: string;
+	// The CDL id representing the menu of the station object
+	menu?: string;
+	[index: string]: any;
+}
+
 export interface LocationGroupCreatedEvent {
 	id: string;
 	type: 'LocationGroupCreatedEvent';
@@ -9,80 +274,7 @@ export interface LocationGroupCreatedEvent {
 		traceId?: string;
 	};
 	payload: {
-		locationGroup?: {
-			// location group id
-			id?: string;
-			// ISO timestamp when the location group was soft deleted
-			deletedAt?: string;
-			// Name of the location group
-			name?: string;
-			label?: {
-				en?: string;
-				fr?: string;
-			};
-			// Distance in meters from the location group
-			distance?: number;
-			// Array of Location objects
-			locations?: {
-				id?: string;
-				name?: string;
-				address?: {
-					address?: string;
-					city?: string;
-					state?: string;
-					country?: string;
-					zip?: string;
-					coordinates?: {
-						latitude?: number;
-						longitude?: number;
-					};
-				};
-			}[];
-			address?: {
-				// Suite number of the address, if applicable
-				suite?: string;
-				// First line of the address, should include street number
-				address?: string;
-				// City of the address
-				city?: string;
-				// State of the address, also province in Canada
-				state?: string;
-				// Country of the address
-				country?: string;
-				// Zip code or postal code of the address
-				zip?: string;
-				coordinates?: {
-					// latitude of the address
-					latitude?: number;
-					// longitude of the address
-					longitude?: number;
-				};
-			};
-			meta?: {
-				tags?: string[];
-				category?: string;
-				[index: string]: any;
-			};
-			style?: {
-				logo?: string;
-				mainLogo?: string;
-				altLogo?: string;
-				appThemeId?: string;
-			};
-			timezone?: string;
-			deviceMapping?: {
-				pos?: {
-					deviceType?: string;
-					siteDeviceId?: string;
-					name?: string;
-				}[];
-			};
-			date?: {
-				created?: string;
-				modified?: string;
-			};
-			[index: string]: any;
-		};
+		group: Group;
 	};
 	source: string;
 }

package/src/messages/events/LocationGroupUpdatedEvent.ts

@@ -1,5 +1,270 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export interface Group {
+	id?: string;
+	// ISO timestamp when the group was soft deleted
+	deleted_at?: string;
+	name?: string;
+	label?: Label;
+	// Distance in meters from the group
+	distance?: number;
+	locations?: Location[];
+	address?: Address;
+	meta?: Record<string, any>;
+	style?: {
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
+		appThemeId?: string;
+	};
+	timezone?: string;
+	device_mapping?: Record<string, DeviceMapping[]>;
+	date?: DateInfo;
+	[index: string]: any;
+}
+
+export interface Location {
+	id?: string;
+	// ISO timestamp when the location was soft deleted
+	deleted_at?: string;
+	operation_id?: number;
+	name?: string;
+	label?: Label;
+	sequence?: number;
+	search?: string[];
+	app?: string;
+	address?: Address;
+	latitude?: number;
+	longitude?: number;
+	brands?: Brand[];
+	meta?: Record<string, any>;
+	phone?: string;
+	// The CDL is representing the group of this location
+	location_group?: string;
+	// The CDL id representing the multigroup of this location
+	location_multigroup?: string;
+	// The CDL id representing the sector of this location
+	sector?: string;
+	date?: DateInfo;
+	market_place?: MarketPlace;
+	[index: string]: any;
+}
+
+export interface Address {
+	// Suite number of the address, if applicable
+	suite?: string;
+	// First line of the address, should include street number
+	address?: string;
+	// City of the address
+	city?: string;
+	// State of the address, also province in Canada
+	state?: string;
+	// Country of the address
+	country?: string;
+	// Zip code or postal code of the address
+	zip?: string;
+	coordinates?: {
+		// latitude of the the address
+		latitude?: number;
+		// longitude of the the address
+		longitude?: number;
+	};
+}
+
+export interface Label {
+	en?: string;
+	fr?: string;
+}
+
+export interface DateInfo {
+	deleted?: string;
+	created?: string;
+	modified?: string;
+}
+
+export interface DeviceMapping {
+	device_type?: string;
+	site_device_id?: string;
+	name?: string;
+	business_units?: string[];
+}
+
+export interface BrandDeviceMapping {
+	device_type: string;
+	site_device_id: string;
+	business_units?: string[];
+}
+
+export interface Brand {
+	// brand
+	id?: string;
+	// ISO timestamp when the brand was soft deleted
+	deleted_at?: string;
+	// The CDL id representing the sector this brand belongs to
+	sector?: string;
+	name?: string;
+	label?: Label;
+	sequence?: number;
+	timezone?: string;
+	description?: string;
+	address?: Address;
+	menus?: MenuHours[];
+	date?: DateInfo;
+	hours?: Hours[];
+	deliveryHours?: DeliveryHours[];
+	style?: {
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
+	};
+	// The CDL id representing the PoS for this brand
+	pos?: string;
+	terminals?: Record<string, any>[];
+	device_mapping?: Record<string, BrandDeviceMapping[]>;
+	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;
+		delivery_user_defined?: {
+			start_time: string;
+			end_time: string;
+			delivery_destinations?: string[];
+		}[];
+	};
+	is?: {
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		frictionless_supported?: boolean;
+		plu_enabled?: boolean;
+		promo_exemptions_enabled?: boolean;
+		local_images_enabled?: boolean;
+		hidden?: boolean;
+		show_in_kiosk?: boolean;
+		show_in_pos?: boolean;
+		item_desc_edit_enabled?: boolean;
+		scan_and_go_supported?: boolean;
+		calories_edit_enabled?: boolean;
+		special_instructions_enabled?: boolean;
+		dining_hall?: boolean;
+		[index: string]: any;
+	};
+	// The CDL id representing the brand
+	brand?: string;
+	// The CDL id representing the location of this brand
+	location?: string;
+	// location group
+	group?: string;
+	// The CDL id representing the payment provider of this brand
+	payment_provider?: string;
+	// @deprecated
+	location_description?: string;
+	// The CDL id representing the company of this brand
+	company?: string;
+	config?: {
+		private?: Record<string, any>;
+		public?: Record<string, any>;
+	};
+	tax_rate?: number;
+	meta?: Record<string, any>;
+	descriptions?: {
+		location?: Label;
+	};
+	estimated_wait_time?: {
+		delivery?: WaitTime;
+		pickup?: WaitTime;
+	};
+	state?: {
+		pickup?: BrandOrMenuState;
+		delivery?: BrandOrMenuState;
+	};
+}
+
+export interface MenuHours {
+	id?: string;
+	label?: Label;
+	hours?: Hours[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	state?: BrandOrMenuState;
+	is_disabled?: boolean;
+}
+
+export interface Hours {
+	id?: string;
+	date?: {
+		deleted?: string;
+		start?: string;
+		end?: string;
+	};
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface DeliveryHours {
+	id?: string;
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
+}
+
+export interface WaitTime {
+	// maxium wait time to the next time slot in minutes
+	max: number;
+	// minimum wait time to the next time slot in minutes
+	min: number;
+	// the epoch timestamp of the next available ready time for a station
+	ready_time: number;
+}
+
+export type BrandOrMenuState = 'open' | 'closed' | 'preorder';
+
+export interface MarketPlace {
+	stations?: Station[];
+	label?: Label;
+	location_description?: Label;
+	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?: Label;
+	hours?: Hours[];
+	deliveryHours?: DeliveryHours[];
+	service_fee?: {
+		type?: string;
+		value?: number;
+	};
+	[index: string]: any;
+}
+
+export interface Station {
+	// The CDL id representing the brand of the station object
+	brand?: string;
+	// The CDL id representing the menu of the station object
+	menu?: string;
+	[index: string]: any;
+}
+
 export interface LocationGroupUpdatedEvent {
 	id: string;
 	type: 'LocationGroupUpdatedEvent';
@@ -9,59 +274,7 @@ export interface LocationGroupUpdatedEvent {
 		traceId?: string;
 	};
 	payload: {
-		group: {
-			// group id
-			id: string;
-			// ISO timestamp when the group was soft deleted
-			deletedAt?: string;
-			// Name of the group
-			name: string;
-			label?: {
-				en?: string;
-				fr?: string;
-			};
-			// Distance in meters from the group
-			distance?: number;
-			// Array of Location objects
-			locations?: Record<string, any>[];
-			address?: {
-				// Suite number of the address, if applicable
-				suite?: string;
-				// First line of the address, should include street number
-				address?: string;
-				// City of the address
-				city?: string;
-				// State of the address, also province in Canada
-				state?: string;
-				// Country of the address
-				country?: string;
-				// Zip code or postal code of the address
-				zip?: string;
-				coordinates?: {
-					// latitude of the address
-					latitude?: number;
-					// longitude of the address
-					longitude?: number;
-				};
-			};
-			// Additional metadata
-			meta?: Record<string, any>;
-			style?: {
-				logo?: string;
-				mainLogo?: string;
-				altLogo?: string;
-				appThemeId?: string;
-			};
-			// Timezone of the group
-			timezone?: string;
-			// Device mapping configuration
-			deviceMapping?: Record<string, any>;
-			date?: {
-				deleted?: string;
-				created?: string;
-				modified?: string;
-			};
-		};
+		group: Group;
 	};
 	source: string;
 }