@compassdigital/sdk.typescript 4.253.0 → 4.255.0

package/src/messages/events/OrderUpdatedEvent.ts

@@ -1,5 +1,345 @@
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
+export interface CreditCard {
+	card_type?: string;
+	last4?: string;
+}
+
+export interface CashlessPayment {
+	id?: string;
+	tender?: string;
+	name?: string;
+	total?: number;
+}
+
+export interface POSPayment {
+	type?: string;
+	transaction?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface MealPlan {
+	id?: string;
+	tender?: string;
+	name?: string;
+}
+
+export interface OrderStatus {
+	accepted?: boolean;
+	in_progress?: boolean;
+	ready?: boolean;
+	out_for_delivery?: boolean;
+	delivered?: boolean;
+	checkin_order?: boolean;
+	dining_hall_order?: boolean;
+	no_show?: boolean;
+	collected?: boolean;
+	cancelled?: boolean;
+}
+
+export interface OrderDates {
+	// 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)
+	should_start?: string;
+	// Date kitchen should be half way preparation ideally(not mandatory)
+	completion_warning?: string;
+	// Date kitchen finished preparation
+	ready?: string;
+	// Date kitchen started preparation
+	started?: string;
+	// Date till which show orders as active
+	show_as_active_until?: string;
+	// For delivery orders - date customer did not pick the order
+	no_show?: 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;
+}
+
+export interface OrderDetails {
+	name?: string;
+	display_id?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	// Pickup or delivery instructions
+	instructions?: string;
+	// Email address for receipt
+	receiptEmail?: string;
+}
+
+export interface RefundTransaction {
+	original_shoppingcart?: string;
+	refund_date?: string;
+	issued_by?: string;
+	amount?: number;
+	refund_amount?: number;
+	[index: string]: any;
+}
+
+export interface TransactionDetails {
+	// used in mx orders - cart totals in dollars and meal exchange value (meals)
+	mx_totals?: {
+		amount?: number;
+		meals?: number;
+	};
+	// the amount remaining on the transaction after refund - remaining amount available for refund
+	transaction_remainder_amount?: number;
+	[index: string]: any;
+}
+
+export interface ShoppingCartDetails {
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	// Total of first cart on order. Carts can change after refunds, so this is original value
+	original_total?: {
+		amount?: number;
+		meals?: number;
+	};
+	[index: string]: any;
+}
+
+export interface DeliveryDetails {
+	provider?: string;
+	tracker_url?: string;
+	loading_code?: string;
+	[index: string]: any;
+}
+
+export interface DiscountDetails {
+	app?: string;
+	code?: string;
+	[index: string]: any;
+}
+
+export interface OrderDiscount {
+	id?: string;
+	date?: string;
+	result?: boolean;
+	discount?: {
+		type?: string;
+		amount_off?: number;
+		percent_off?: number;
+	};
+	type?: string;
+	original_redemption?: string;
+	app?: string;
+	name?: string;
+	resource_id?: string;
+	[index: string]: any;
+}
+
+export interface DiscountsRefund {
+	// Client app that applied the discount
+	app?: string;
+	// Date the discount was refunded
+	date?: string;
+	// Date the order was created
+	order_created_at?: string;
+	// Vocuherify Order ID
+	order_id?: string;
+	// Order items
+	order_items?: {
+		// Compassdigital item id
+		source_id?: string;
+		// Quantity of the item
+		quantity?: number;
+		// Price of the item in cents
+		price?: number;
+	}[];
+	// Order total
+	order_total?: number;
+	// Reason for refund
+	reason?: string;
+	// Voucherify parent redemption id for the stacked discounts
+	redemption_id?: string;
+	// true if refund succeeded
+	result?: boolean;
+	[index: string]: any;
+}
+
+export interface MultiLanguageLabel {
+	en?: string;
+	fr?: string;
+	es?: string;
+}
+
+export interface ApexCodeProperties {
+	codeType: string;
+	codeValue: string;
+	qrImage: string;
+	qrExpiryDate?: string;
+}
+
+export interface ApexCodes {
+	operator_code: ApexCodeProperties;
+	customer_code: ApexCodeProperties;
+	reclaim_code: ApexCodeProperties;
+}
+
+export interface OrderedItem {
+	id: string;
+	_index: string;
+	quantity?: number;
+	unit?: number;
+	price?: {
+		amount?: number;
+	};
+	_subtotal?: {
+		amount?: number;
+	};
+	_promo?: {
+		amount?: number;
+	};
+	meta?: Record<string, any>;
+	options?: {
+		label?: {
+			en?: string;
+		};
+		items?: {
+			id?: string;
+			_index?: string;
+			meta?: Record<string, any>;
+		}[];
+	}[];
+}
+
+export type ItemsWithIssue = OrderedItem & {
+	reason?: string;
+};
+
+export interface RefundItem {
+	id?: string;
+	_index?: string;
+	quantity?: number;
+	price?: {
+		amount?: number;
+	};
+	reason?: string;
+	[index: string]: any;
+}
+
+export interface Issue {
+	id?: string;
+	type?: string;
+	item?: Record<string, any>;
+	items?: ItemsWithIssue[];
+	reason?: string;
+	meta?: {
+		created_at?: string;
+		[index: string]: any;
+	};
+	[index: string]: any;
+}
+
+export interface OrderMeta {
+	// Check-in UUID for frictionless orders
+	checkin_uuid?: string;
+	refunds?: RefundTransaction[];
+	// which ui the order was placed on
+	source?: 'web' | 'mobile' | 'centric_hub';
+	transaction?: TransactionDetails;
+	shoppingcart?: ShoppingCartDetails;
+	// Indicate whether the order is active or inactive
+	active?: boolean;
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+	delivery?: DeliveryDetails;
+	discount?: DiscountDetails;
+	discounts?: OrderDiscount[];
+	discounts_refund?: DiscountsRefund;
+	// The type of kds that the brand uses
+	type_of_kds?: string;
+	// Indicate whether the order is eligible for cancellation
+	cancel_eligible?: boolean;
+	pickup_instruction?: MultiLanguageLabel;
+	market_place_label?: MultiLanguageLabel;
+	market_place_description?: MultiLanguageLabel;
+	apex_code?: string;
+	apex_qr?: string;
+	apex_codes?: ApexCodes;
+	[index: string]: any;
+}
+
+export interface Order {
+	// order id
+	id?: string;
+	// The CDL id representing the brand location
+	location_brand?: string;
+	// The CDL id representing the location
+	location?: string;
+	// The CDL id representing the shopping cart
+	shoppingcart?: string;
+	payment?: {
+		token?: string;
+		credit_card?: CreditCard;
+		digital_wallet_pay?: string;
+		badge_pay?: CashlessPayment;
+		stipend?: CashlessPayment;
+		voucher?: CashlessPayment;
+		coupon_voucher?: CashlessPayment;
+		pos?: POSPayment;
+	};
+	mealplan?: MealPlan;
+	meal_swipes?: {
+		id?: string;
+		tender?: string;
+		tender_name?: string;
+		swipes?: number;
+		total?: number;
+	};
+	meal_exchange?: MealPlan;
+	// The CDL id representing the customer
+	customer?: string;
+	is?: OrderStatus;
+	date?: OrderDates;
+	// @deprecated
+	pickup?: string;
+	// @deprecated
+	pickup_name?: string;
+	// @deprecated
+	pickup_id?: string;
+	requested_date?: string;
+	details?: OrderDetails;
+	meta?: OrderMeta;
+	issue?: Issue;
+	past_issues?: Issue[];
+	// Delivery user
+	runner?: string;
+	reorder_eligibility?:
+		| '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?: RefundItem[];
+	latest_refunds?: RefundItem[];
+	[index: string]: any;
+}
+
 export interface OrderUpdatedEvent {
 	id: string;
 	type: 'OrderUpdatedEvent';
@@ -9,287 +349,7 @@ export interface OrderUpdatedEvent {
 		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' | 'centric_hub';
-				// 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;
-		};
+		order: Order;
 	};
 	source: string;
 }