@compassdigital/sdk.typescript 4.620.0 → 4.621.0

package/src/interface/consumer.ts

@@ -228,6 +228,7 @@ export interface OrderDetails {
 	order_type?: string;
 	duration?: string;
 	destination?: string;
+	receiptEmail?: string;
 }
 
 export interface OrderMonetaryValue {
@@ -265,14 +266,28 @@ export interface OrderCashlessPayment {
 	name?: string;
 }
 
+export interface OrderPOSPayment {
+	type?: string;
+	transaction?: Record<string, any>;
+}
+
 export interface OrderPayment {
+	// Payment token
 	token?: string;
+	// Credit card payment details
 	credit_card?: OrderCreditCard;
+	// Digital wallet payment token
 	digital_wallet_pay?: string;
+	// Badge pay cashless payment details
 	badge_pay?: OrderCashlessPayment;
+	// Stipend cashless payment details
 	stipend?: OrderCashlessPayment;
+	// Voucher cashless payment details
 	voucher?: OrderCashlessPayment;
+	// Coupon voucher cashless payment details
 	coupon_voucher?: OrderCashlessPayment;
+	// POS payment details
+	pos?: OrderPOSPayment;
 }
 
 export interface OrderMealplan {
@@ -341,8 +356,15 @@ export interface OrderItemWithIssue {
 	options?: OrderedItemOptionGroup[];
 }
 
+export interface OrderNoRefundMeta {
+	reason?: string;
+	no_refund_date?: string;
+	processed_by?: string;
+}
+
 export interface OrderIssueMeta {
 	created_at?: string;
+	no_refund?: OrderNoRefundMeta;
 }
 
 export interface OrderIssue {
@@ -355,6 +377,7 @@ export interface OrderIssue {
 	// Issue Meta
 	meta?: OrderIssueMeta;
 	type?: string;
+	item?: Record<string, any>;
 }
 
 export interface ShoppingcartSalePrice {
@@ -818,6 +841,36 @@ export interface GetCustomerOrdersResponseDTO {
 	orders: CustomerOrder[];
 }
 
+export interface CustomerOrderV2 {
+	// Order metadata
+	meta?: OrderMeta;
+	id?: string;
+	reorder_eligibility?: string;
+	location_brand?: string;
+	location?: string;
+	customer?: string;
+	date?: OrderDate;
+	details?: OrderDetails;
+	pickup?: string;
+	pickup_name?: string;
+	requested_date?: string;
+	refunds?: OrderRefundItem[];
+	pickup_id?: string;
+	payment?: OrderPayment;
+	mealplan?: OrderMealplan;
+	meal_swipes?: OrderMealSwipes;
+	is?: OrderIs;
+	issue?: OrderIssue;
+	past_issues?: OrderIssue[];
+	shoppingcart?: string;
+	runner?: string;
+}
+
+export interface GetCustomerOrdersV2ResponseDTO {
+	// customer orders
+	orders: CustomerOrderV2[];
+}
+
 export interface GooglePayToken {
 	// Google Pay token signature
 	signature?: string;
@@ -839,17 +892,26 @@ export interface ConsumerPaymentToken {
 }
 
 export interface CreateOrderPayment {
+	// Deprecated payment token
 	token?: string | Record<string, any>;
+	// Consumer payment token (Google Pay, Apple Pay, etc.)
 	consumer_payment_token?: ConsumerPaymentToken;
+	// Credit card payment details
 	credit_card?: OrderCreditCard;
+	// Badge pay cashless payment details
 	badge_pay?: OrderCashlessPayment;
+	// Stipend cashless payment details
 	stipend?: OrderCashlessPayment;
+	// Voucher cashless payment details
 	voucher?: OrderCashlessPayment;
+	// Coupon voucher cashless payment details
 	coupon_voucher?: OrderCashlessPayment;
 }
 
 export interface CreateOrderIs {
+	// Is the order in progress
 	in_progress?: boolean;
+	// Is the order ready
 	ready?: boolean;
 }
 
@@ -861,16 +923,25 @@ export interface CreateOrderMeta {
 }
 
 export interface CreateOrderDetails {
+	// Customer name
 	name?: string;
+	// Customer contact number
 	contact_number?: string;
+	// Customer country code
+	country_code?: string;
+	// Order type
 	order_type?: string;
+	// Order duration
 	duration?: string;
+	// Delivery destination
 	destination?: string;
 	// Pickup or delivery instructions
 	instructions?: string;
 }
 
 export interface PostOrderBodyDto {
+	// Order ID
+	id?: string;
 	// The location brand
 	location_brand?: string;
 	// The location
@@ -897,6 +968,42 @@ export interface PostOrderBodyDto {
 	details?: CreateOrderDetails;
 }
 
+export interface OrderDiscountEffect {
+	type?: string;
+	amount_off?: number;
+	percent_off?: number;
+}
+
+export interface OrderDiscountItem {
+	id?: string;
+	date?: string;
+	result?: boolean;
+	discount?: OrderDiscountEffect;
+	type?: string;
+	original_redemption?: string;
+	app?: string;
+	name?: string;
+	resource_id?: string;
+}
+
+export interface OrderDiscountsRefundItem {
+	source_id?: string;
+	quantity?: number;
+	price?: number;
+}
+
+export interface OrderDiscountsRefund {
+	app?: string;
+	date?: string;
+	order_created_at?: string;
+	order_id?: string;
+	order_items?: OrderDiscountsRefundItem[];
+	order_total?: number;
+	reason?: string;
+	redemption_id?: string;
+	result?: boolean;
+}
+
 export interface PlacedOrderMeta {
 	// Check-in UUID for frictionless orders
 	checkin_uuid?: string;
@@ -919,6 +1026,14 @@ export interface PlacedOrderMeta {
 	// Indicate whether the order is eligible for cancellation
 	cancel_eligible?: boolean;
 	refunds?: OrderRefundTransaction[];
+	pickup_instruction?: MultiLanguageLabel;
+	market_place_label?: MultiLanguageLabel;
+	market_place_description?: MultiLanguageLabel;
+	apex_code?: string;
+	apex_qr?: string;
+	apex_codes?: ApexCodes;
+	discounts?: OrderDiscountItem[];
+	discounts_refund?: OrderDiscountsRefund;
 }
 
 export interface PostOrderResponseDTO {
@@ -2325,12 +2440,10 @@ export interface ConsumerCashlessTender {
 	balance?: number;
 	// Cashless tender ID
 	id?: string;
+	// Cashless tender
+	tender?: string;
 	// Cashless tender name
 	name?: string;
-	// Cashless tender total
-	total?: number;
-	// Cashless tender tender
-	tender?: string;
 	// Cashless tender type
 	type?: 'badge_pay' | 'stipend' | 'voucher' | 'coupon_voucher';
 }
@@ -2678,8 +2791,8 @@ export interface ConsumerModifierRequest {
 	quantity?: number;
 	amount_off_exclusions?: Record<string, any>[];
 	meta?: ConsumerModifierRequestMeta;
-	is_selected?: boolean;
-	parent_label?: ConsumerLabel;
+	isSelected?: boolean;
+	parentLabel?: ConsumerLabel;
 	price?: ConsumerPrice;
 }
 
@@ -2816,6 +2929,8 @@ export interface PostConsumerShoppingCartResponse {
 export interface PostConsumerPromoValidateRequest {
 	// The code of the promo voucher
 	code?: string;
+	// The customer ID
+	customer_id?: string;
 	// The email of the customer
 	email?: string;
 	// The app of the customer
@@ -2842,6 +2957,22 @@ export interface ConsumerAppliedDiscount {
 	amount_limit?: number;
 }
 
+export interface RedeemableResult {
+	discount?: ConsumerAppliedDiscount;
+}
+
+export interface RedeemableOrder {
+	total_applied_discount_amount?: number;
+}
+
+export interface ConsumerRedeemable {
+	status: string;
+	id: string;
+	object: Record<string, any>;
+	result?: RedeemableResult;
+	order?: RedeemableOrder;
+}
+
 export interface ConsumerVoucher {
 	provider?: Record<string, any>;
 	code?: string;
@@ -2849,17 +2980,55 @@ export interface ConsumerVoucher {
 	discount?: ConsumerAppliedDiscount;
 	app?: string;
 	provider_data?: ShoppingcartFPValidationData;
+	stacked_total?: number;
+	redeemables?: ConsumerRedeemable[];
+	stacked_vouchers?: ConsumerRedeemable[];
+	inapplicable_redeemables?: ConsumerRedeemable[];
+}
+
+export interface PromoRedeemShoppingcart {
+	// The shopping cart ID
+	id?: string;
+	// The date the shopping cart was created
+	date_created?: string;
+	// Items in the shopping cart
+	items?: Record<string, any>[];
+}
+
+export interface PromoRedeemTotals {
+	// The total amount
+	amount?: number;
+	// The discount amount
+	discount?: number;
+	// The currency code
+	currency?: string;
 }
 
 export interface PostConsumerPromoRedeemRequest {
 	// The promo code to redeem
 	code: string;
 	// The email of the customer
-	email: string;
+	email?: string;
 	// The app of the customer
-	app: string;
+	app?: string;
+	// The realm of the customer
+	realm?: string;
 	// The location brand of the customer
 	location_brand?: string;
+	// The customer ID
+	customer_id?: string;
+	// The order ID
+	order_id?: string;
+	// The brand ID
+	brand_id?: string;
+	// The site ID
+	site_id?: string;
+	// The payment request ID
+	payment_request_id?: string;
+	// The shopping cart details
+	shoppingcart?: PromoRedeemShoppingcart;
+	// The order totals
+	totals?: PromoRedeemTotals;
 }
 
 export interface ConsumerRedemption {
@@ -4107,6 +4276,24 @@ export interface GetCustomerOrdersQuery {
 
 export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
 
+// GET /consumer/v2/customer-orders/{userId} - Get customer orders
+
+export interface GetCustomerOrdersV2Path {
+	// a valid CDL user id
+	userId: string;
+}
+
+export interface GetCustomerOrdersV2Query {
+	// Filter orders by their requested date. Only return orders that have a date greater than or equal to the date. Default is the current time in milliseconds. Please ensure to use a millisecond timestamp, not just an epoch timestamp
+	start?: number;
+	// Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is 24 hours from the current time in milliseconds. Please ensure to use a millisecond timestamp, not just an epoch timestamp
+	end?: number;
+	// When true, only orders eligible for reorder are returned. When false, only orders that are not eligible for reorder are returned. If omitted, no filter is applied.
+	reorderEligible?: boolean;
+}
+
+export type GetCustomerOrdersV2Response = GetCustomerOrdersV2ResponseDTO;
+
 // POST /consumer/order - Create a new order
 
 export type PostConsumerOrderBody = PostOrderBodyDto;