@compassdigital/sdk.typescript 4.326.0 → 4.327.0

package/src/messages/events/LocationMultigroupCreatedEvent.ts

@@ -0,0 +1,461 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface MultiGroup {
+	// multigroup
+	id?: string;
+	// Multigroup name
+	name?: string;
+	// Array of groups associated with this multigroup
+	groups?: Group[];
+	meta?: Pagination;
+	[index: string]: any;
+}
+
+export interface Group {
+	// Unique group identifier
+	id?: string;
+	// ISO timestamp when the group was soft deleted
+	deleted_at?: string;
+	// Group name
+	name?: string;
+	label?: Label;
+	// Distance in meters from the group
+	distance?: number;
+	// Array of locations associated with this group
+	locations?: Location[];
+	address?: Address;
+	// Additional metadata
+	meta?: Record<string, any>;
+	style?: Style;
+	// Group timezone
+	timezone?: string;
+	// Device mapping configuration
+	device_mapping?: Record<string, DeviceMapping[]>;
+	date?: DateInfo;
+	[index: string]: any;
+}
+
+export interface Location {
+	// Unique location identifier
+	id?: string;
+	// ISO timestamp when the location was soft deleted
+	deleted_at?: string;
+	// Operation identifier
+	operation_id?: number;
+	// Location name
+	name?: string;
+	label?: Label;
+	// Location sequence number
+	sequence?: number;
+	// Search terms for this location
+	search?: string[];
+	// Application identifier
+	app?: string;
+	address?: Address;
+	// Location latitude
+	latitude?: number;
+	// Location longitude
+	longitude?: number;
+	// Array of brands associated with this location
+	brands?: Brand[];
+	// Additional metadata
+	meta?: Record<string, any>;
+	// Location phone number
+	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 Pagination {
+	// Last key for pagination
+	last_key?: string;
+	// Total count of items
+	count?: number;
+	[index: string]: any;
+}
+
+export interface Label {
+	// English label
+	en?: string;
+	// French label
+	fr?: string;
+	[index: string]: any;
+}
+
+export interface Address {
+	// Suite or unit number
+	suite?: string;
+	// Street address
+	address?: string;
+	// City name
+	city?: string;
+	// State or province
+	state?: string;
+	// Country code
+	country?: string;
+	// Postal or ZIP code
+	zip?: string;
+	coordinates?: {
+		// Latitude coordinate
+		latitude?: number;
+		// Longitude coordinate
+		longitude?: number;
+		[index: string]: any;
+	};
+	[index: string]: any;
+}
+
+export interface Style {
+	// Group logo URL
+	logo?: string;
+	// Main group logo URL
+	main_logo?: string;
+	// Alternative group logo URL
+	alt_logo?: string;
+	// Application theme identifier
+	appThemeId?: string;
+	[index: string]: any;
+}
+
+export interface DateInfo {
+	// Creation timestamp
+	created?: string;
+	// Last modification timestamp
+	modified?: string;
+	// Deletion timestamp
+	deleted?: string;
+	[index: string]: any;
+}
+
+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;
+	// Brand name
+	name?: string;
+	label?: Label;
+	// Brand sequence number
+	sequence?: number;
+	// Brand timezone
+	timezone?: string;
+	// Brand description
+	description?: string;
+	// @deprecated
+	latitude?: number;
+	// @deprecated
+	longitude?: number;
+	address?: Address;
+	// Menu hours configuration
+	menus?: MenuHours[];
+	date?: DateInfo;
+	// Operating hours
+	hours?: Hours[];
+	// Delivery hours configuration
+	deliveryHours?: DeliveryHours[];
+	style?: Style;
+	// The CDL id representing the PoS for this brand
+	pos?: string;
+	// Terminal configurations
+	terminals?: Record<string, any>[];
+	// Device mapping configuration
+	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[];
+			[index: string]: any;
+		}[];
+		[index: string]: any;
+	};
+	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>;
+		[index: string]: any;
+	};
+	// Tax rate
+	tax_rate?: number;
+	meta?: {
+		scout?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+				[index: string]: any;
+			};
+			[index: string]: any;
+		};
+		partner?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+				[index: string]: any;
+			};
+			[index: string]: any;
+		};
+		contact?: {
+			name?: string;
+			role?: string;
+			email?: string;
+			phone?: string;
+			[index: string]: any;
+		};
+		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;
+				[index: string]: any;
+			};
+			nextep?: {
+				mobile_app?: boolean;
+				web?: boolean;
+				[index: string]: any;
+			};
+			mashgin?: {
+				enabled?: boolean;
+				[index: string]: any;
+			};
+			centric_hub?: {
+				enabled?: boolean;
+				[index: string]: any;
+			};
+			agilysys?: {
+				order_streaming_enabled?: boolean;
+				[index: string]: any;
+			};
+			[index: string]: any;
+		};
+		type_of_kds?: {
+			cdl?: boolean;
+			nextep?: boolean;
+			volante?: boolean;
+			agilysys?: boolean;
+			[index: string]: any;
+		};
+		[index: string]: any;
+	};
+	descriptions?: {
+		location?: Label;
+		[index: string]: any;
+	};
+	estimated_wait_time?: {
+		delivery?: WaitTime;
+		pickup?: WaitTime;
+		[index: string]: any;
+	};
+	state?: {
+		pickup?: BrandOrMenuState;
+		delivery?: BrandOrMenuState;
+		[index: string]: any;
+	};
+	[index: string]: any;
+}
+
+export interface MenuHours {
+	id?: string;
+	label?: {
+		en?: string;
+		[index: string]: any;
+	};
+	hours?: Hours[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	state?: BrandOrMenuState;
+	is_disabled?: boolean;
+	[index: string]: any;
+}
+
+export interface Hours {
+	id?: string;
+	date?: {
+		deleted?: string;
+		start?: string;
+		end?: string;
+		[index: string]: any;
+	};
+	day?: {
+		start?: number;
+		end?: number;
+		[index: string]: any;
+	};
+	hours?: string;
+	[index: string]: any;
+}
+
+export interface DeliveryHours {
+	id?: string;
+	day?: {
+		start?: number;
+		end?: number;
+		[index: string]: any;
+	};
+	hours?: string;
+	[index: string]: any;
+}
+
+export interface Timeslot {
+	// timeslot id (optional)
+	id?: number;
+	// The CDL id representing the brand this timeslot belongs to
+	brand_id?: string;
+	start_time?: string;
+	duration?: string;
+	is_available?: boolean;
+	number_orders?: number;
+	delivery_destinations?: string[];
+	[index: string]: any;
+}
+
+export interface DeviceMapping {
+	device_type?: string;
+	site_device_id?: string;
+	name?: string;
+	business_units?: string[];
+	[index: string]: any;
+}
+
+export interface BrandDeviceMapping {
+	device_type: string;
+	site_device_id: string;
+	business_units?: string[];
+}
+
+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 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;
+	[index: string]: any;
+}
+
+export type BrandOrMenuState = 'open' | 'closed' | 'preorder';
+
+export type PartnerStatus = 'await_partner' | 'await_scout' | 'completed';
+
+export interface MarketPlace {
+	stations?: Station[];
+	label?: Label;
+	location_description?: Label;
+	// Marketplace logo URL
+	logo?: string;
+	is?: {
+		// Whether marketplace is enabled
+		enabled?: boolean;
+		// Whether pickup is supported
+		pickup_supported?: boolean;
+		// Whether delivery is supported
+		delivery_supported?: boolean;
+		[index: string]: any;
+	};
+	delivery_details?: {
+		// Whether to show single timeslot
+		show_single_timeslot?: boolean;
+		// Whether to show delivery instructions
+		show_instructions?: boolean;
+		// Whether runner app is enabled
+		runner_app_enabled?: boolean;
+		[index: string]: any;
+	};
+	// Available delivery destinations
+	delivery_destinations?: string[];
+	pickup_instruction?: Label;
+	// Marketplace hours
+	hours?: Hours[];
+	// Marketplace delivery hours
+	deliveryHours?: DeliveryHours[];
+	service_fee?: {
+		// Service fee type
+		type?: string;
+		// Service fee value
+		value?: number;
+		[index: string]: any;
+	};
+	[index: string]: any;
+}
+
+export interface LocationMultigroupCreatedEvent {
+	id: string;
+	type: 'LocationMultigroupCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		multiGroup: MultiGroup;
+	};
+	source: string;
+}