@compassdigital/sdk.typescript 4.228.0 → 4.229.0

package/src/messages/events/LocationBrandUpdatedEvent.ts

@@ -0,0 +1,255 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LocationBrandUpdatedEvent {
+	id: string;
+	type: 'LocationBrandUpdatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	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[];
+				}[];
+			};
+			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;
+			};
+			// 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>;
+			};
+			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;
+			};
+			descriptions?: {
+				location?: {
+					en?: string;
+					fr?: string;
+				};
+			};
+			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;
+				};
+			};
+			state?: {
+				pickup?: 'open' | 'closed' | 'preorder';
+				delivery?: 'open' | 'closed' | 'preorder';
+			};
+			[index: string]: any;
+		};
+	};
+	source: string;
+}

package/src/messages/events/LocationGroupCreatedEvent.ts

@@ -0,0 +1,88 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LocationGroupCreatedEvent {
+	id: string;
+	type: 'LocationGroupCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		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;
+		};
+	};
+	source: string;
+}

package/src/messages/events/OrderUpdatedEvent.ts

@@ -0,0 +1,295 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface OrderUpdatedEvent {
+	id: string;
+	type: 'OrderUpdatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		order?: {
+			// order id
+			id?: string;
+			// The CDL id representing the brand location
+			locationBrand?: string;
+			// The CDL id representing the location
+			location?: string;
+			// The CDL id representing the shopping cart
+			shoppingcart?: string;
+			payment?: {
+				token?: string;
+				creditCard?: {
+					cardType?: string;
+					last4?: string;
+				};
+				digitalWalletPay?: string;
+				badgePay?: {
+					id?: string;
+					tender?: string;
+					name?: string;
+					total?: number;
+				};
+				stipend?: {
+					id?: string;
+					tender?: string;
+					name?: string;
+					total?: number;
+				};
+				voucher?: {
+					id?: string;
+					tender?: string;
+					name?: string;
+					total?: number;
+				};
+				couponVoucher?: {
+					id?: string;
+					tender?: string;
+					name?: string;
+					total?: number;
+				};
+				pos?: {
+					provider?: string;
+					transactionId?: string;
+					[index: string]: any;
+				};
+			};
+			mealplan?: {
+				id?: string;
+				tender?: string;
+				name?: string;
+			};
+			mealSwipes?: {
+				id?: string;
+				tender?: string;
+				tenderName?: string;
+				swipes?: number;
+				total?: number;
+			};
+			mealExchange?: {
+				id?: string;
+				tender?: string;
+				name?: string;
+			};
+			// The CDL id representing the customer
+			customer?: string;
+			is?: {
+				accepted?: boolean;
+				inProgress?: boolean;
+				ready?: boolean;
+				outForDelivery?: boolean;
+				delivered?: boolean;
+				checkinOrder?: boolean;
+				diningHallOrder?: boolean;
+				noShow?: boolean;
+				collected?: boolean;
+				cancelled?: boolean;
+			};
+			date?: {
+				// Date order was accepted into our system and shown on kitchen apps
+				accepted?: string;
+				created?: string;
+				modified?: string;
+				// Date kitchen should start preparation ideally(not mandatory)
+				shouldStart?: string;
+				// Date kitchen should be half way preparation ideally(not mandatory)
+				completionWarning?: string;
+				// Date kitchen finished preparation
+				ready?: string;
+				// Date kitchen started preparation
+				started?: string;
+				// Date till which show orders as active
+				showAsActiveUntil?: string;
+				// For delivery orders - date customer did not pick the order
+				noShow?: string;
+				// For delivery orders - date customer completed the order collected and sent back robot
+				collected?: string;
+				// For delivery orders - date order was delivered to destination(not picked by user)
+				delivered?: string;
+				// For delivery orders - date order was picked up from station for delivery(out_for_delivery)
+				pickup?: string;
+				// Date order was cancelled
+				cancelled?: string;
+				// Date order was polled for kds
+				polled?: string;
+			};
+			// @deprecated
+			pickup?: string;
+			// @deprecated
+			pickupName?: string;
+			// @deprecated
+			pickupId?: string;
+			requestedDate?: string;
+			details?: {
+				name?: string;
+				displayId?: string;
+				contactNumber?: string;
+				countryCode?: string;
+				orderType?: string;
+				duration?: string;
+				destination?: string;
+				// Pickup or delivery instructions
+				instructions?: string;
+				// Email address for receipt
+				receiptEmail?: string;
+			};
+			meta?: {
+				// Check-in UUID for frictionless orders
+				checkinUuid?: string;
+				refunds?: {
+					originalShoppingcart?: string;
+					refundDate?: string;
+					[index: string]: any;
+				}[];
+				// which ui the order was placed on
+				source?: 'web' | 'mobile' | 'pos';
+				// details pertaining to the amount charged on the order
+				transaction?: {
+					// used in mx orders - cart totals in dollars and meal exchange value (meals)
+					mxTotals?: {
+						amount?: number;
+						meals?: number;
+					};
+					// the amount remaining on the transaction after refund - remaining amount available for refund
+					transactionRemainderAmount?: number;
+					[index: string]: any;
+				};
+				// Shoppingcart details
+				shoppingcart?: {
+					total?: {
+						amount?: number;
+						meals?: number;
+					};
+					// Total of first cart on order. Carts can change after refunds, so this is original value
+					originalTotal?: {
+						amount?: number;
+						meals?: number;
+					};
+					[index: string]: any;
+				};
+				// Indicate whether the order is active or inactive
+				active?: boolean;
+				// Override for meta.active for testing purposes
+				activeOverride?: boolean;
+				// Delivery details
+				delivery?: {
+					provider?: string;
+					trackerUrl?: string;
+					loadingCode?: string;
+					[index: string]: any;
+				};
+				// Discount details
+				discount?: {
+					app?: string;
+					code?: string;
+					[index: string]: any;
+				};
+				discounts?: {
+					app?: string;
+					code?: string;
+					[index: string]: any;
+				}[];
+				// Discounts for refunds
+				discountsRefund?: {
+					// Client app that applied the discount
+					app?: string;
+					// Date the discount was refunded
+					date?: string;
+					// Date the order was created
+					orderCreatedAt?: string;
+					// Vocuherify Order ID
+					orderId?: string;
+					// Order items
+					orderItems?: {
+						// Compassdigital item id
+						sourceId?: string;
+						// Quantity of the item
+						quantity?: number;
+						// Price of the item in cents
+						price?: number;
+					}[];
+					// Order total
+					orderTotal?: number;
+					// Reason for refund
+					reason?: string;
+					// Voucherify parent redemption id for the stacked discounts
+					redemptionId?: string;
+					// true if refund succeeded
+					result?: boolean;
+					[index: string]: any;
+				};
+				// The type of kds that the brand uses
+				typeOfKds?: string;
+				// Indicate whether the order is eligible for cancellation
+				cancelEligible?: boolean;
+				pickupInstruction?: {
+					en?: string;
+					fr?: string;
+				};
+				marketPlaceLabel?: {
+					en?: string;
+					fr?: string;
+				};
+				marketPlaceDescription?: {
+					en?: string;
+					fr?: string;
+				};
+				apexCode?: string;
+				apexQr?: string;
+				apexCodes?: {
+					customerCode?: {
+						qrExpiryDate?: string;
+					};
+					[index: string]: any;
+				};
+				[index: string]: any;
+			};
+			issue?: {
+				id?: string;
+				type?: string;
+				items?: any;
+				[index: string]: any;
+			};
+			pastIssues?: {
+				id?: string;
+				type?: string;
+				items?: any;
+				[index: string]: any;
+			}[];
+			// Delivery user
+			runner?: string;
+			reorderEligibility?:
+				| 'eligible'
+				| 'order_type_ineligible'
+				| 'location_ineligible'
+				| 'active_order'
+				| 'old_order'
+				| 'marketplace_order'
+				| 'duplicate_order'
+				| 'brand_unavailable'
+				| 'menu_unavailable'
+				| 'items_unavailable'
+				| 'refunded_order'
+				| 'modifiers_unavailable'
+				| 'modified_items'
+				| 'cancelled_order';
+			refunds?: {
+				id?: string;
+				amount?: number;
+				reason?: string;
+				date?: string;
+				[index: string]: any;
+			}[];
+			latestRefunds?: {
+				id?: string;
+				amount?: number;
+				reason?: string;
+				date?: string;
+				[index: string]: any;
+			}[];
+			[index: string]: any;
+		};
+	};
+	source: string;
+}

package/src/messages/events/index.ts

@@ -8,12 +8,20 @@ export { DiscountUpdatedEvent } from './DiscountUpdatedEvent';
 
 export { FakeEvent } from './FakeEvent';
 
+export { LocationBrandCreatedEvent } from './LocationBrandCreatedEvent';
+
+export { LocationBrandUpdatedEvent } from './LocationBrandUpdatedEvent';
+
 export { LocationCreatedEvent } from './LocationCreatedEvent';
 
+export { LocationGroupCreatedEvent } from './LocationGroupCreatedEvent';
+
 export { LocationUpdatedEvent } from './LocationUpdatedEvent';
 
 export { OrderCompletedEvent } from './OrderCompletedEvent';
 
 export { OrderCreatedEvent } from './OrderCreatedEvent';
 
+export { OrderUpdatedEvent } from './OrderUpdatedEvent';
+
 export { PublishedMenuUpdatedEvent } from './PublishedMenuUpdatedEvent';