@compassdigital/sdk.typescript 4.325.0 → 4.327.0

package/src/messages/events/LocationBrandCreatedEvent.ts

@@ -1,255 +1,261 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-export interface LocationBrandCreatedEvent {
-	id: string;
-	type: 'LocationBrandCreatedEvent';
-	version: '0.0.1';
-	timestamp: string;
-	traceContext: {
-		traceId?: string;
+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;
 	};
-	payload: {
-		brand?: {
-			// brand id
-			id?: string;
-			// ISO timestamp when the brand was soft deleted
-			deletedAt?: string;
-			// The CDL id representing the sector this brand belongs to
-			sector?: string;
-			// brand name
-			name?: string;
-			label?: {
-				en?: string;
-				fr?: string;
-			};
-			sequence?: number;
-			timezone?: string;
-			description?: string;
-			// @deprecated
-			latitude?: number;
-			// @deprecated
-			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 the address
-					latitude?: number;
-					// longitude of the the address
-					longitude?: number;
-				};
-			};
-			menus?: {
-				id?: string;
-				label?: {
-					en?: string;
-				};
-				hours?: {
-					id?: string;
-					date?: {
-						deleted?: string;
-						start?: string;
-						end?: string;
-					};
-					day?: {
-						start?: number;
-						end?: number;
-					};
-					hours?: string;
-				}[];
-				isPickup?: boolean;
-				isDelivery?: boolean;
-				isFrictionless?: boolean;
-				state?: 'open' | 'closed' | 'preorder';
-				isDisabled?: boolean;
-			}[];
-			date?: {
-				deleted?: string;
-				created?: string;
-				modified?: string;
-			};
-			hours?: {
-				id?: string;
-				date?: {
-					deleted?: string;
-					start?: string;
-					end?: string;
-				};
-				day?: {
-					start?: number;
-					end?: number;
-				};
-				hours?: string;
-			}[];
-			deliveryHours?: {
-				id?: string;
-				day?: {
-					start?: number;
-					end?: number;
-				};
-				hours?: string;
-			}[];
-			style?: {
-				logo?: string;
-				mainLogo?: string;
-				altLogo?: string;
-			};
-			// The CDL id representing the PoS for this brand
-			pos?: string;
-			terminals?: Record<string, any>[];
-			deviceMapping?: Record<
-				string,
-				{
-					deviceType?: string;
-					siteDeviceId?: string;
-					businessUnits?: string[];
-				}[]
-			>;
-			timeslots?: {
-				time?: string;
-				averagePrepTime?: string;
-				durationMinutes?: number;
-				customersPerSlot?: number;
-				menuItemsPerSlot?: number;
-				deliveryTime?: string;
-				deliveryCustomersPerSlot?: number;
-				deliveryMenuItemsPerSlot?: number;
-				deliveryPrepTime?: string;
-				deliveryIsUserDefined?: boolean;
-				deliveryUserDefined?: {
-					startTime?: string;
-					endTime?: string;
-					deliveryDestinations?: string[];
-				}[];
+}
+
+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 MenuHours {
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	hours?: Hours[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	state?: 'open' | 'closed' | 'preorder';
+	is_disabled?: boolean;
+}
+
+export interface DateInfo {
+	deleted?: string;
+	created?: string;
+	modified?: 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 type PartnerStatus = 'await_partner' | 'await_scout' | 'completed';
+
+export interface DeviceMapping {
+	device_type: string;
+	site_device_id: string;
+	business_units?: string[];
+}
+
+export interface Brand {
+	// brand id
+	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;
+	// brand name
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	sequence?: number;
+	timezone?: string;
+	description?: string;
+	// @deprecated
+	latitude?: number;
+	// @deprecated
+	longitude?: number;
+	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, DeviceMapping[]>;
+	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;
+		// admin panel toggle
+		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?: {
+		scout?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
 			};
-			is?: {
-				pickupSupported?: boolean;
-				deliverySupported?: boolean;
-				frictionlessSupported?: boolean;
-				pluEnabled?: boolean;
-				promoExemptionsEnabled?: boolean;
-				localImagesEnabled?: boolean;
-				hidden?: boolean;
-				showInKiosk?: boolean;
-				showInPos?: boolean;
-				itemDescEditEnabled?: boolean;
-				scanAndGoSupported?: boolean;
-				caloriesEditEnabled?: boolean;
-				// admin panel toggle
-				specialInstructionsEnabled?: boolean;
-				diningHall?: boolean;
-				[index: string]: any;
+		};
+		partner?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
 			};
-			// 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
-			paymentProvider?: string;
-			// @deprecated
-			locationDescription?: string;
-			// The CDL id representing the company of this brand
-			company?: string;
-			config?: {
-				private?: Record<string, any>;
-				public?: Record<string, any>;
+		};
+		contact?: {
+			name?: string;
+			role?: string;
+			email?: string;
+			phone?: string;
+		};
+		market_id?: string;
+		partner_type?: string;
+		business_number?: number;
+		website?: string;
+		cuisine_types?: string[];
+		status?: PartnerStatus;
+		active?: boolean;
+		max_showcase_items?: number;
+		jde_category?: string;
+		software_integrations?: {
+			system365?: string;
+			jwo?: string;
+			time2eat?: {
+				enabled?: boolean;
+				use_timeslots?: boolean;
+				ignore_station_hours?: boolean;
 			};
-			taxRate?: number;
-			meta?: {
-				scout?: {
-					userId?: string;
-					name?: {
-						first?: string;
-						last?: string;
-					};
-				};
-				partner?: {
-					userId?: string;
-					name?: {
-						first?: string;
-						last?: string;
-					};
-				};
-				contact?: {
-					name?: string;
-					role?: string;
-					email?: string;
-					phone?: string;
-				};
-				marketId?: string;
-				partnerType?: string;
-				businessNumber?: number;
-				website?: string;
-				cuisineTypes?: string[];
-				status?: 'await_partner' | 'await_scout' | 'completed';
-				active?: boolean;
-				maxShowcaseItems?: number;
-				jdeCategory?: string;
-				softwareIntegrations?: {
-					system365?: string;
-					jwo?: string;
-					time2eat?: {
-						enabled?: boolean;
-					};
-					nextep?: {
-						mobileApp?: boolean;
-						web?: boolean;
-					};
-					mashgin?: {
-						enabled?: boolean;
-					};
-				};
-				typeOfKds?: {
-					cdl?: boolean;
-					nextep?: boolean;
-					volante?: boolean;
-					agilysys?: boolean;
-					[index: string]: any;
-				};
-				[index: string]: any;
+			nextep?: {
+				mobile_app?: boolean;
+				web?: boolean;
 			};
-			descriptions?: {
-				location?: {
-					en?: string;
-					fr?: string;
-				};
+			mashgin?: {
+				enabled?: boolean;
 			};
-			estimatedWaitTime?: {
-				delivery?: {
-					// 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
-					readyTime?: number;
-				};
-				pickup?: {
-					// 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
-					readyTime?: number;
-				};
+			centric_hub?: {
+				enabled?: boolean;
 			};
-			state?: {
-				pickup?: 'open' | 'closed' | 'preorder';
-				delivery?: 'open' | 'closed' | 'preorder';
+			agilysys?: {
+				order_streaming_enabled?: boolean;
 			};
+		};
+		type_of_kds?: {
+			cdl?: boolean;
+			nextep?: boolean;
+			volante?: boolean;
+			agilysys?: boolean;
 			[index: string]: any;
 		};
+		[index: string]: any;
+	};
+	descriptions?: {
+		location?: {
+			en?: string;
+			fr?: string;
+		};
+	};
+	estimated_wait_time?: {
+		delivery?: WaitTime;
+		pickup?: WaitTime;
+	};
+	state?: {
+		pickup?: BrandOrMenuState;
+		delivery?: BrandOrMenuState;
+	};
+	[index: string]: any;
+}
+
+export interface LocationBrandCreatedEvent {
+	id: string;
+	type: 'LocationBrandCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		brand: Brand;
 	};
 	source: string;
 }