@compassdigital/sdk.typescript 4.589.0 → 4.590.0

package/src/messages/events/OrderRefundCreatedEvent.ts

@@ -0,0 +1,277 @@
+// 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>;
+}
+
+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 {
+	accepted?: string;
+	created?: string;
+	modified?: string;
+	should_start?: string;
+	completion_warning?: string;
+	ready?: string;
+	started?: string;
+	show_as_active_until?: string;
+	no_show?: string;
+	collected?: string;
+	delivered?: string;
+	pickup?: string;
+	cancelled?: string;
+	polled?: string;
+}
+
+export interface OrderDetails {
+	name?: string;
+	display_id?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	instructions?: string;
+	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 {
+	mx_totals?: {
+		amount?: number;
+		meals?: number;
+	};
+	transaction_remainder_amount?: number;
+	[index: string]: any;
+}
+
+export interface ShoppingCartDetails {
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	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 {
+	app?: string;
+	date?: string;
+	order_created_at?: string;
+	order_id?: string;
+	order_items?: {
+		source_id?: string;
+		quantity?: number;
+		price?: number;
+	}[];
+	order_total?: number;
+	reason?: string;
+	redemption_id?: string;
+	result?: boolean;
+	[index: string]: any;
+}
+
+export interface MultiLanguageLabel {
+	en?: string;
+	fr?: string;
+	es?: string;
+}
+
+export interface OrderMeta {
+	checkin_uuid?: string;
+	refunds?: RefundTransaction[];
+	source?: 'web' | 'mobile' | 'centric_hub';
+	transaction?: TransactionDetails;
+	shoppingcart?: ShoppingCartDetails;
+	active?: boolean;
+	active_override?: boolean;
+	delivery?: DeliveryDetails;
+	discount?: DiscountDetails;
+	discounts?: OrderDiscount[];
+	discounts_refund?: DiscountsRefund;
+	type_of_kds?: string;
+	cancel_eligible?: boolean;
+	pickup_instruction?: MultiLanguageLabel;
+	market_place_label?: MultiLanguageLabel;
+	market_place_description?: MultiLanguageLabel;
+	[index: string]: any;
+}
+
+export interface OrderedItem {
+	id: string;
+	_index: string;
+	quantity?: number;
+	price?: {
+		amount?: number;
+	};
+}
+
+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 Order {
+	// order id
+	id?: string;
+	location_brand?: string;
+	location?: string;
+	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;
+	customer?: string;
+	is?: OrderStatus;
+	date?: OrderDates;
+	pickup?: string;
+	pickup_name?: string;
+	pickup_id?: string;
+	requested_date?: string;
+	details?: OrderDetails;
+	meta?: OrderMeta;
+	issue?: Issue;
+	past_issues?: Issue[];
+	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 OrderRefundCreatedEvent {
+	id: string;
+	type: 'OrderRefundCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		order: Order;
+	};
+	source: string;
+}

package/src/messages/events/OrderRefundDeniedEvent.ts

@@ -0,0 +1,279 @@
+// 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>;
+}
+
+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 {
+	accepted?: string;
+	created?: string;
+	modified?: string;
+	should_start?: string;
+	completion_warning?: string;
+	ready?: string;
+	started?: string;
+	show_as_active_until?: string;
+	no_show?: string;
+	collected?: string;
+	delivered?: string;
+	pickup?: string;
+	cancelled?: string;
+	polled?: string;
+}
+
+export interface OrderDetails {
+	name?: string;
+	display_id?: string;
+	contact_number?: string;
+	country_code?: string;
+	order_type?: string;
+	duration?: string;
+	destination?: string;
+	instructions?: string;
+	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 {
+	mx_totals?: {
+		amount?: number;
+		meals?: number;
+	};
+	transaction_remainder_amount?: number;
+	[index: string]: any;
+}
+
+export interface ShoppingCartDetails {
+	total?: {
+		amount?: number;
+		meals?: number;
+	};
+	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 {
+	app?: string;
+	date?: string;
+	order_created_at?: string;
+	order_id?: string;
+	order_items?: {
+		source_id?: string;
+		quantity?: number;
+		price?: number;
+	}[];
+	order_total?: number;
+	reason?: string;
+	redemption_id?: string;
+	result?: boolean;
+	[index: string]: any;
+}
+
+export interface MultiLanguageLabel {
+	en?: string;
+	fr?: string;
+	es?: string;
+}
+
+export interface OrderMeta {
+	checkin_uuid?: string;
+	refunds?: RefundTransaction[];
+	source?: 'web' | 'mobile' | 'centric_hub';
+	transaction?: TransactionDetails;
+	shoppingcart?: ShoppingCartDetails;
+	active?: boolean;
+	active_override?: boolean;
+	delivery?: DeliveryDetails;
+	discount?: DiscountDetails;
+	discounts?: OrderDiscount[];
+	discounts_refund?: DiscountsRefund;
+	type_of_kds?: string;
+	cancel_eligible?: boolean;
+	pickup_instruction?: MultiLanguageLabel;
+	market_place_label?: MultiLanguageLabel;
+	market_place_description?: MultiLanguageLabel;
+	[index: string]: any;
+}
+
+export interface OrderedItem {
+	id: string;
+	_index: string;
+	quantity?: number;
+	price?: {
+		amount?: number;
+	};
+}
+
+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 Order {
+	// order id
+	id?: string;
+	location_brand?: string;
+	location?: string;
+	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;
+	customer?: string;
+	is?: OrderStatus;
+	date?: OrderDates;
+	pickup?: string;
+	pickup_name?: string;
+	pickup_id?: string;
+	requested_date?: string;
+	details?: OrderDetails;
+	meta?: OrderMeta;
+	issue?: Issue;
+	past_issues?: Issue[];
+	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 OrderRefundDeniedEvent {
+	id: string;
+	type: 'OrderRefundDeniedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		traceId?: string;
+	};
+	payload: {
+		order: Order;
+		// The reason the refund was denied
+		reason: string;
+	};
+	source: string;
+}

package/src/messages/events/index.ts

@@ -54,6 +54,12 @@ export { OrderCompletedEvent } from './OrderCompletedEvent';
 
 export { OrderCreatedEvent } from './OrderCreatedEvent';
 
+export { OrderIssueCreatedEvent } from './OrderIssueCreatedEvent';
+
+export { OrderRefundCreatedEvent } from './OrderRefundCreatedEvent';
+
+export { OrderRefundDeniedEvent } from './OrderRefundDeniedEvent';
+
 export { OrderUpdatedEvent } from './OrderUpdatedEvent';
 
 export { PublishedMenuCreatedEvent } from './PublishedMenuCreatedEvent';