@compassdigital/sdk.typescript 4.326.0 → 4.328.0

package/src/messages/events/LocationCreatedEvent.ts

@@ -1,41 +1,318 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-export interface LocationAddress {
+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;
-	zip?: string;
+	// Country of the address
 	country?: string;
+	// Zip code or postal code of the address
+	zip?: string;
 	coordinates?: {
-		latitude: number;
-		longitude: number;
+		// 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 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;
+	// @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;
+		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?: BrandMeta;
+	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 LocationIs {
-	scanAndGoSupported?: boolean;
-	frictionlessSupported?: boolean;
-	pickupSupported?: boolean;
-	deliverySupported?: boolean;
-	specialInstructionsEnabled?: boolean;
-	cafe360?: boolean;
-	hidden?: boolean;
-	webOrderEnabled?: boolean;
-	itemLabelEditEnabled?: boolean;
-	localImagesEnabled?: boolean;
-	pluEnabled?: boolean;
+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[];
+}
+
+export interface DeviceMapping {
+	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 BrandMeta {
+	scout?: {
+		user_id?: string;
+		name?: {
+			first?: string;
+			last?: string;
+		};
+	};
+	partner?: {
+		user_id?: string;
+		name?: {
+			first?: string;
+			last?: string;
+		};
+	};
+	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;
+		};
+		nextep?: {
+			mobile_app?: boolean;
+			web?: boolean;
+		};
+		mashgin?: {
+			enabled?: boolean;
+		};
+		centric_hub?: {
+			enabled?: boolean;
+		};
+		agilysys?: {
+			order_streaming_enabled?: boolean;
+		};
+	};
+	type_of_kds?: {
+		cdl?: boolean;
+		nextep?: boolean;
+		volante?: boolean;
+		agilysys?: boolean;
+		[index: string]: any;
+	};
+	[index: string]: any;
 }
 
-export interface LocationTimeslots {
-	averagePrepTime?: string;
-	customersPerSlot?: number;
-	time?: string;
-	deliveryPrepTime?: string;
-	deliveryIsUserDefined?: boolean;
-	deliveryTime?: string;
-	deliveryDestinations?: string[];
-	deliveryUserDefined?: string[];
-	deliveryCustomersPerSlot?: number;
+export type PartnerStatus = 'await_partner' | 'await_scout' | 'completed';
+
+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 LocationCreatedEvent {
@@ -47,75 +324,7 @@ export interface LocationCreatedEvent {
 		traceId?: string;
 	};
 	payload: {
-		location: {
-			// location id
-			id: string;
-			// user id of location creator
-			createdBy: string;
-			// user id of most recent update
-			updatedBy?: string;
-			createdAt: string;
-			updatedAt: string;
-			// Name of the location
-			name: string;
-			// Type of entity (e.g., brand, location, group, etc.)
-			type: string;
-			// Multi-group association
-			multiGroup?: string;
-			// Group association
-			group?: string;
-			// Location identifier
-			location?: string;
-			// Sector identifier
-			sector?: string;
-			// Company identifier
-			company?: string;
-			// External identifier for cross-system references
-			externalId?: string;
-			address?: LocationAddress;
-			// Labeling metadata
-			label?: Record<string, any>;
-			// Styling metadata
-			style?: Record<string, any>;
-			// Additional metadata
-			meta?: Record<string, any>;
-			// Device mapping information
-			deviceMapping?: Record<string, any>;
-			is?: LocationIs;
-			timeslots?: LocationTimeslots;
-			menus?: Record<string, any>[];
-			hours?: Record<string, any>[];
-			deliveryHours?: Record<string, any>[];
-			// Description data for the entity
-			descriptions?: Record<string, any>;
-			// Payment provider associated with the entity
-			paymentProvider?: string;
-			// Latitude coordinate
-			latitude?: number;
-			// Longitude coordinate
-			longitude?: number;
-			// Timezone for the entity
-			timezone?: string;
-			// Geohash of the entity's location
-			geohash?: string;
-			// Associated operation ID
-			operationId?: number;
-			// Description of the location
-			locationDescription?: string;
-			// Point-of-sale system identifier
-			pos?: string;
-			terminals?: Record<string, any>[];
-			// Marketplace information
-			marketPlace?: Record<string, any>;
-			// Indicates if the location has a food locker
-			foodlocker?: boolean;
-			// Indicates if the entity is archived
-			archived?: boolean;
-			// Sorting order for listings
-			sortSequence?: number;
-			// Additional information
-			information?: string;
-		};
+		location: Location;
 	};
 	source: string;
 }

package/src/messages/events/LocationDeliveryDestinationCreatedEvent.ts

@@ -0,0 +1,50 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface DeliveryDestination {
+	// Unique identifier for the delivery destination
+	id: string;
+	// Name of the delivery destination
+	name: string;
+	// Boolean to indicate whether the delivery destination is a foodlocker or not
+	foodlocker: boolean;
+	address: Address;
+	// Additional information of the delivery destination
+	information?: string;
+	// Sort order for the delivery destination
+	sort_sequence?: number;
+}
+
+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 LocationDeliveryDestinationCreatedEvent {
+	id: string;
+	type: 'LocationDeliveryDestinationCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		deliveryDestination: DeliveryDestination;
+	};
+	source: string;
+}

package/src/messages/events/LocationDeliveryDestinationUpdatedEvent.ts

@@ -0,0 +1,50 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface DeliveryDestination {
+	// Unique identifier for the delivery destination
+	id: string;
+	// Name of the delivery destination
+	name: string;
+	// Boolean to indicate whether the delivery destination is a foodlocker or not
+	foodlocker: boolean;
+	address: Address;
+	// Additional information of the delivery destination
+	information?: string;
+	// Sort order for the delivery destination
+	sort_sequence?: number;
+}
+
+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 LocationDeliveryDestinationUpdatedEvent {
+	id: string;
+	type: 'LocationDeliveryDestinationUpdatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		deliveryDestination: DeliveryDestination;
+	};
+	source: string;
+}