@compassdigital/sdk.typescript 4.263.0 → 4.264.0

package/src/messages/events/ShoppingCartCreatedEvent.ts

@@ -0,0 +1,499 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface ShoppingCart {
+	// Shopping cart ID
+	id?: string;
+	// The CDL id representing the location
+	location?: string;
+	// The CDL id representing the menu
+	menu?: string;
+	// The CDL id representing the brand
+	brand?: string;
+	date?: Record<string, any>;
+	items?: ItemResponse[];
+	sub_total?: {
+		amount?: MonetaryValue;
+	};
+	promo?: PromoDetails;
+	discount?: PromoDetails;
+	discounts?: Discounts;
+	payment_method?: PaymentMethod;
+	taxes?: Taxes;
+	total?: {
+		amount?: MonetaryValue;
+		meals?: MonetaryValue;
+	};
+	exemptions?: {
+		tax?: boolean;
+	};
+	order?: {
+		// order id
+		id?: string;
+	};
+	service_fee?: {
+		amount?: MonetaryValue;
+	};
+	delivery_fee?: {
+		amount?: MonetaryValue;
+	};
+	is?: {
+		// Shoppingcart Type
+		type?: 'delivery' | 'pickup' | 'scan_and_go' | 'frictionless';
+		// If an order should be paid with meal exchange. If true, this will calculate meals total.
+		mx_cart?: boolean;
+		// If a user's email or email domain is a match in a sites list of tax exempt emails or domains
+		email_tax_exempt?: boolean;
+		// Indicates to clients that a tax recalculation is required
+		tax_calculation_required?: boolean;
+		// Indicates that the shopping cart is a system 365 shopping cart
+		system365?: boolean;
+	};
+	meta?: {
+		// Raw request from any vendor integrated with CDL
+		vendor?: Record<string, any>;
+		drain_order_type?: DrainOrderType;
+		[index: string]: any;
+	};
+	incentives: Incentives;
+}
+
+export interface ItemResponse {
+	// can be cdl item id or stringified timestamp
+	id: string;
+	description?: Label;
+	// index based on cdl id or stringified timestamp
+	_index?: string;
+	quantity: Quantity;
+	quantity_by_weight?: {
+		unit?: string;
+		value?: number;
+	};
+	unit?: number;
+	price?: Price;
+	// Final item price after LTO/Bundle/BOGO etc is applied on the item.
+	sale_price?: {
+		active?: boolean;
+		amount?: MonetaryValue;
+	};
+	weighed_price?: Price;
+	// Subtotal of the item including all options
+	_subtotal?: {
+		amount?: MonetaryValue;
+	};
+	// Promo applied to this item
+	_promo?: {
+		amount?: MonetaryValue;
+	};
+	// discount applied to this item
+	_discount?: {
+		amount?: MonetaryValue;
+	};
+	meta?: {
+		// menu id
+		menu?: string;
+		// brand id
+		brand?: string;
+		brand_label?: Label;
+		taxes?: string[];
+		tax?: {
+			tax_tag_code?: string;
+			tax_rate?: number;
+			tax_amount?: number;
+		};
+		menu_tax_tags?: string[];
+		orderable?: boolean;
+		volante_id?: string;
+		barcodes?: string[];
+		plu?: string;
+		[index: string]: any;
+	};
+	options?: ModifierGroupResponse[];
+	// Details about discount like BOGO, LTO, Bundle etc.
+	item_discount?: Record<string, any>;
+	// user specified instructions for the item
+	special_instructions?: string;
+	amount_off_exclusions?: AmountOffExclusion[];
+	added_on?: string;
+	meal_value?: IntegerValue;
+	category?: Label;
+	menu_label?: Label;
+	tax_rate?: MonetaryValue;
+	label?: Label;
+	reporting?: {
+		category?: {
+			primary?: string;
+			secondary?: string;
+		};
+	};
+}
+
+export interface ModifierGroupResponse {
+	id?: string;
+	label?: Label;
+	meta?: {
+		taxes?: string[];
+		original_label?: Label;
+		order_type?: 'selection' | 'option' | 'quantity';
+		surchage_limit_value?: number;
+		[index: string]: any;
+	};
+	items?: ModifierResponse[];
+	is?: {
+		disabled?: boolean;
+		incremental?: boolean;
+		surchage_limit?: boolean;
+	};
+}
+
+export interface ModifierResponse {
+	// option/modifier
+	id?: string;
+	price?: Price;
+	quantity?: Quantity;
+	label?: Label;
+	// index
+	_index?: string;
+	meta?: {
+		sort_number?: number;
+		original_label?: Label;
+		taxes?: string[];
+		sizing?: ModifierSizing;
+		[index: string]: any;
+	};
+	amount_off_exclusions?: AmountOffExclusion[];
+	is?: {
+		disabled?: boolean;
+	};
+}
+
+export interface Taxes {
+	amount?: MonetaryValue;
+	rate?: MonetaryValue;
+	breakdown?: {
+		taxable_amount?: MonetaryValue;
+		tax_collectable?: MonetaryValue;
+		combined_tax_rate?: MonetaryValue;
+		gst?: MonetaryValue;
+		pst?: MonetaryValue;
+		provider?: string;
+		[index: string]: any;
+	};
+	provider?: string;
+	quote_payload?: TaxRequestDTO;
+}
+
+export interface PromoDetails {
+	code?: string;
+	provider?: 'fp' | 'voucherify';
+	amount_off?: MonetaryValue;
+	percent_off?: MonetaryValue;
+	amount?: MonetaryValue;
+	app?: string;
+	discount?: {
+		// effect of the discount, current usage reflects if it is a whole order or item level promo
+		effect?: string;
+		[index: string]: any;
+	};
+	provider_data?: FPValidationData;
+	order?: PromoOrder;
+}
+
+export interface Discounts {
+	stacked_total?: MonetaryValue;
+	stacked_discounts?: Discount[];
+	app?: string;
+}
+
+export interface Discount {
+	id: string;
+	// unix epoch timestamp of discount creation in UTC
+	createdAt: string;
+	// unix epoch timestamp of discount update in UTC
+	updatedAt: string;
+	// id of the user who created the discount
+	createdBy: string;
+	// id of the user who updated the discount most recently
+	updatedBy: string;
+	name: string;
+	is?: {
+		badgepayPromo?: boolean;
+		mealplanPromo?: boolean;
+		decliningBalancePromo?: boolean;
+		voucherPromo?: boolean;
+	};
+	status?: {
+		live?: boolean;
+		publishedTo3rdParty?: boolean;
+		readyToPublish?: boolean;
+	};
+	meta?: {
+		provider: {
+			voucherify?: {
+				id?: string;
+				code?: string;
+				discount?: {
+					type: string;
+					amountOff?: number;
+					percentOff?: number;
+				};
+			};
+		};
+		[index: string]: any;
+	};
+	applied_amount: MonetaryValue;
+}
+
+export interface PaymentMethod {
+	mealplan?: Mealplan;
+	credit_card?: CreditCard;
+	digital_wallet_pay?: DigitalWalletPay;
+	meal_swipes?: MealSwipes;
+	meal_exchange?: MealExchange;
+	badge_pay?: CashlessTender;
+	stipend?: CashlessTender;
+	voucher?: CashlessTender;
+	coupon_voucher?: CashlessTender;
+}
+
+export interface Mealplan {
+	id?: string;
+	tender?: string;
+	total?: MonetaryValue;
+	type?: PaymentType;
+}
+
+export interface CreditCard {
+	card_type?: string;
+	last4?: string;
+	total?: MonetaryValue;
+	type?: PaymentType;
+}
+
+export interface DigitalWalletPay {
+	wallet_type?: string;
+	total?: MonetaryValue;
+	type?: PaymentType;
+}
+
+export interface MealSwipes {
+	id?: string;
+	tender?: string;
+	tender_type?: string;
+	tender_name?: string;
+	swipes?: MonetaryValue;
+	rate?: MonetaryValue;
+	total?: MonetaryValue;
+	type?: PaymentType;
+}
+
+export interface MealExchange {
+	id?: string;
+	tender?: string;
+	type?: PaymentType;
+}
+
+export interface CashlessTender {
+	id?: string;
+	total?: MonetaryValue;
+	tender?: string;
+	name?: string;
+	type?: PaymentType;
+}
+
+export interface DrainOrderType {
+	taxable?: boolean;
+	tax_exempt?: boolean;
+}
+
+export interface Incentives {
+	discounts?: Discounts;
+	promo?: PromoDetails;
+	stacked_total?: MonetaryValue;
+}
+
+export interface Label {
+	en?: string;
+	fr?: string;
+}
+
+export interface Price {
+	amount?: MonetaryValue;
+}
+
+export type MonetaryValue = number;
+
+export type IntegerValue = number;
+
+export type Quantity = number;
+
+export type PaymentType = string;
+
+export type AmountOffExclusion = 'discount' | 'promo';
+
+export type ModifierSizing = {
+	name?: string;
+	price?: MonetaryValue;
+	posid?: string;
+}[];
+
+export interface FPValidationData {
+	discountIncentives?: {
+		id?: string;
+		program?: {
+			code?: string;
+		};
+		[index: string]: any;
+	}[];
+	[index: string]: any;
+}
+
+export interface PromoOrder {
+	items_applied_discount_amount?: number;
+	amount?: number;
+	items_discount_amount?: number;
+	total_amount?: number;
+	total_applied_discount_amount?: number;
+	total_discount_amount?: number;
+	items?: PromoItem[];
+}
+
+export interface PromoItem {
+	applied_discount_amount?: number;
+	amount?: number;
+	discount_amount?: number;
+	price?: number;
+	quantity?: number;
+	source_id?: string;
+	subtotal_amount?: number;
+}
+
+export interface TaxRequestDTO {
+	// a unique identifier representing the transaction
+	id: string;
+	// the app to associate the transaction with
+	appName: string;
+	// the order fulfillment type
+	transactionType: 'pickup' | 'delivery';
+	// numeric value of service fee
+	serviceFee?: number;
+	// numeric value of delivery fee
+	deliveryFee?: number;
+	locationData: TaxLocationData;
+	// items to calculate tax on
+	items: TaxItemDTO[];
+	// iso timstamp of transaction date
+	transactionDate?: string;
+	// an array of items to refund
+	refunds?: TaxRefund[];
+}
+
+export interface TaxLocationData {
+	// unique location identifier
+	id: string;
+	// country of transaction
+	country: string;
+	// state or province of transaction
+	stateOrProvince: string;
+	// city of transaction
+	city: string;
+	// postal code of transaction
+	postalCode: string;
+	// street address of transaction
+	streetAddress: string;
+}
+
+export interface TaxItemDTO {
+	// unique item identifier
+	id: string;
+	// indicates a tax rule for an item
+	taxTagCode: string;
+	// amount of an item
+	quantity: number;
+	// decimal price of an item
+	price: number;
+	// amount of tax charged on an item after funds are captured
+	taxedAmount?: number;
+}
+
+export interface TaxRefund {
+	// unique identifier of the refunded item
+	refundItemId: string;
+	// quantity amount of the item to be refunded
+	refundItemQuantity: number;
+}
+
+export interface Tender {
+	id: string;
+	name?: string;
+	balance?: MonetaryValue;
+	type: 'declining_balance' | 'meal_equivalent' | 'meal_exchange';
+	is: {
+		eligible: boolean;
+		validated?: boolean;
+	};
+	currency?: string;
+	tender_number?: string;
+}
+
+export interface PaymentMethods {
+	mealplan?: {
+		tenders: Tender[];
+	};
+	cashless?: {
+		tenders: {
+			balance?: MonetaryValue;
+			id: string;
+			name?: string;
+			is: {
+				eligible: boolean;
+			};
+		}[];
+	};
+	credit_cards?: {
+		data: {
+			billing_address?: {
+				postal_code?: string;
+			};
+			card_type?: string;
+			expiry?: {
+				month?: number;
+				year?: number;
+			};
+			is: {
+				eligible: boolean;
+				preferred?: boolean;
+			};
+			masked_card_number?: string;
+			name_on_card?: string;
+			nickname?: string;
+			token: string;
+			token_expiration_date?: string;
+		}[];
+	};
+	digital_wallet_pay?: {
+		applewallet: {
+			is: {
+				eligible: boolean;
+			};
+		};
+		googlewallet: {
+			is: {
+				eligible: boolean;
+			};
+		};
+	};
+}
+
+export interface ShoppingCartCreatedEvent {
+	id: string;
+	type: 'ShoppingCartCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		shoppingCart: ShoppingCart;
+	};
+	source: string;
+}