@compassdigital/sdk.typescript 4.96.0 → 4.98.0

package/src/interface/consumer.ts

@@ -76,28 +76,102 @@ export interface NotFoundErrorDTO {
 	data: Record<string, any>;
 }
 
-export interface Brand {
+export interface OrderTotals {
+	amount?: number;
+	meals?: number;
+}
+
+export interface OrderTransaction {
+	mx_totals?: OrderTotals;
+	// the amount remaining on the transaction after refund - remaining amount available for refund
+	transaction_remainder_amount?: number;
+}
+
+export interface OrderMetaShoppingcart {
+	original_total?: OrderTotals;
+	total?: OrderTotals;
+}
+
+export interface OrderDelivery {
+	// provider
+	provider?: string;
+	tracker_url?: string;
+	loading_code?: string;
+}
+
+export interface OrderDiscount {
+	app?: string;
+	code?: string;
+}
+
+export interface OrderRefundTransaction {
+	// shoppingcart
+	original_shoppingcart?: string;
+	// user
+	issued_by?: string;
+	refund_date?: string;
+	amount?: number;
+	refund_amount?: number;
+}
+
+export interface OrderMeta {
+	// Check-in UUID for frictionless orders
+	checkin_uuid?: string;
+	// which ui the order was placed on
+	source?: 'web' | 'mobile';
+	transaction?: OrderTransaction;
+	shoppingcart?: OrderMetaShoppingcart;
+	// Indicate whether the order is active or inactive
+	active?: boolean;
+	// Override for meta.active for testing purposes
+	active_override?: boolean;
+	delivery?: OrderDelivery;
+	discount?: OrderDiscount;
+	// The type of kds that the brand uses
+	type_of_kds?: string;
+	// Indicate whether the order is eligible for cancellation
+	cancel_eligible?: boolean;
+	refunds: OrderRefundTransaction[];
+}
+
+export interface CustomerOrderBrandDTO {
 	id: string;
-	name?: string;
+	name: string;
+	location_description: string;
 }
 
 export interface OrderDate {
+	// 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;
+	created?: string;
+	modified?: string;
 }
 
 export interface OrderDetails {
+	// Pickup or delivery instructions
+	instructions?: string;
 	name?: string;
 	display_id?: string;
 	contact_number?: string;
@@ -105,22 +179,71 @@ export interface OrderDetails {
 	order_type?: string;
 	duration?: string;
 	destination?: string;
-	instructions?: string;
 }
 
-export interface Price {
+export interface OrderMonetaryValue {
 	amount?: number;
 }
 
-export interface RefundItem {
+export interface OrderRefundItem {
+	// Item ID
 	id?: string;
+	// unique index within cart
 	_index?: string;
+	// Quantity of the item
 	quantity?: number;
-	price?: Price;
+	price?: OrderMonetaryValue;
+	// Reason for refund
 	reason?: string;
 }
 
-export interface OrderIsStatus {
+export interface OrderCreditCard {
+	// The credit card type (Amex, Visa, Mastercard, etc...
+	card_type?: string;
+	// The last 4 digits of the card number
+	last4?: string;
+}
+
+export interface OrderCashlessPayment {
+	// The badge pay tender id
+	tender?: string;
+	// The badge pay payment id
+	id?: string;
+	// The total charged to the badge pay tender
+	total?: number;
+	// The badge pay tender name
+	name?: string;
+}
+
+export interface OrderPayment {
+	token?: string;
+	credit_card?: OrderCreditCard;
+	digital_wallet_pay?: string;
+	badge_pay?: OrderCashlessPayment;
+	stipend?: OrderCashlessPayment;
+	voucher?: OrderCashlessPayment;
+	coupon_voucher?: OrderCashlessPayment;
+}
+
+export interface OrderMealplan {
+	// mealplan
+	id?: string;
+	// tender
+	tender?: string;
+	name?: string;
+}
+
+export interface OrderMealSwipes {
+	// mealplan
+	id?: string;
+	// tender
+	tender?: string;
+	tender_name?: string;
+	swipes?: number;
+	total?: number;
+}
+
+export interface OrderIs {
 	accepted?: boolean;
 	in_progress?: boolean;
 	ready?: boolean;
@@ -133,47 +256,155 @@ export interface OrderIsStatus {
 	cancelled?: boolean;
 }
 
-export interface CartTotal {
+export interface OrderLabel {
+	en?: string;
+}
+
+export interface OrderItemOption {
+	// option
+	id?: string;
+	// index
+	_index?: string;
+	meta?: Record<string, any>;
+}
+
+export interface OrderedItemOptionGroup {
+	label?: OrderLabel;
+	items?: OrderItemOption[];
+}
+
+export interface OrderItemWithIssue {
+	// item
+	id: string;
+	// index
+	_index: string;
+	_subtotal?: OrderMonetaryValue;
+	_promo?: OrderMonetaryValue;
+	reason?: string;
+	quantity?: number;
+	unit?: number;
+	price?: OrderMonetaryValue;
+	meta?: Record<string, any>;
+	options?: OrderedItemOptionGroup[];
+}
+
+export interface OrderIssueMeta {
+	created_at?: string;
+}
+
+export interface OrderIssue {
+	// issue
+	id?: string;
+	// Array of Items with issues
+	items?: OrderItemWithIssue[];
+	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
+	reason?: string;
+	meta?: {
+		[index: string]: any;
+	} & OrderIssueMeta;
+	type?: string;
+}
+
+export interface ShoppingcartSalePrice {
+	active?: boolean;
+	amount?: number;
+}
+
+export interface ShoppingcartMonetaryValue {
 	amount?: number;
-	meals?: number;
 }
 
-export interface Label {
+export interface ShoppingcartLabel {
 	en?: string;
 	fr?: string;
 }
 
-export interface QuantityByWeight {
+export interface ShoppingcartItemMeta {
+	// menu id
+	menu?: string;
+	// brand id
+	brand?: string;
+	brand_label?: ShoppingcartLabel;
+	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;
+}
+
+export interface ShoppingcartQuantityByWeight {
 	unit?: string;
 	value?: number;
 }
 
-export interface SalePrice {
-	active?: boolean;
-	amount?: number;
+export interface ShoppingcartItemModifierGroupMeta {
+	order_type?: 'selection' | 'option' | 'quantity';
+	taxes?: string[];
+	original_label?: ShoppingcartLabel;
+	surchage_limit_value?: number;
 }
 
-export interface Modifier {
-	id: string;
-	price?: Price;
-	quantity?: number;
-	label?: Label;
+export interface ShoppingcartItemModifierSizing {
+	name?: string;
+	price?: number;
+	posid?: string;
+}
+
+export interface ShoppingcartItemModifierMeta {
+	sort_number?: number;
+	original_label?: ShoppingcartLabel;
+	taxes?: string[];
+	sizing?: ShoppingcartItemModifierSizing[];
+}
+
+export interface ShoppingcartItemModifierIs {
+	disabled?: boolean;
+	incremental?: boolean;
+	surchage_limit?: boolean;
+}
+
+export interface ShoppingcartItemModifier {
+	// index
 	_index?: string;
+	meta?: {
+		[index: string]: any;
+	} & ShoppingcartItemModifierMeta;
+	amount_off_exclusions?: string[];
+	id?: string;
+	price?: ShoppingcartMonetaryValue;
+	quantity?: number;
+	label?: ShoppingcartLabel;
+	is?: ShoppingcartItemModifierIs;
 }
 
-export interface ModifierGroup {
-	id: string;
-	label?: Label;
-	items?: Modifier[];
+export interface ShoppingcartItemModifierGroup {
+	meta?: {
+		[index: string]: any;
+	} & ShoppingcartItemModifierGroupMeta;
+	id?: string;
+	label?: ShoppingcartLabel;
+	items?: ShoppingcartItemModifier[];
+	is?: ShoppingcartItemModifierIs;
 }
 
-export interface OrderItemRating {
-	// order id
+export interface ShoppingcartItemReportingCategory {
+	primary?: string;
+	secondary?: string;
+}
+
+export interface ShoppingcartItemReporting {
+	category?: ShoppingcartItemReportingCategory;
+}
+
+export interface OrderItemReview {
+	// review id
 	id: string;
-	// menu id
-	menu: string;
-	// item id
-	item: string;
 	// rating score
 	score: number;
 	// review comment
@@ -182,29 +413,254 @@ export interface OrderItemRating {
 	reason: string[];
 }
 
-export interface CartItem {
+export interface ShoppingcartItem {
+	// can be cdl item id or stringified timestamp
 	id: string;
-	description?: Label;
+	// index based on cdl id or stringified timestamp
 	_index?: string;
+	sale_price?: ShoppingcartSalePrice;
+	_subtotal?: ShoppingcartMonetaryValue;
+	_promo?: ShoppingcartMonetaryValue;
+	_discount?: ShoppingcartMonetaryValue;
+	meta?: {
+		[index: string]: any;
+	} & ShoppingcartItemMeta;
+	// 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?: string[];
+	description?: ShoppingcartLabel;
 	quantity: number;
-	quantity_by_weight?: QuantityByWeight;
-	price?: Price;
-	sale_price?: SalePrice;
-	weighed_price?: Price;
-	_subtotal?: Price;
-	options?: ModifierGroup[];
-	label?: Label;
+	quantity_by_weight?: ShoppingcartQuantityByWeight;
+	unit?: number;
+	price?: ShoppingcartMonetaryValue;
+	weighed_price?: ShoppingcartMonetaryValue;
+	options?: ShoppingcartItemModifierGroup[];
+	added_on?: string;
+	meal_value?: number;
+	category?: ShoppingcartLabel;
+	menu_label?: ShoppingcartLabel;
+	tax_rate?: number;
+	label?: ShoppingcartLabel;
+	reporting?: ShoppingcartItemReporting;
+	review?: OrderItemReview;
+}
+
+export interface ShoppingcartDiscountIncentives {
+	id?: string;
+	program: {
+		code?: string;
+	};
+}
+
+export interface ShoppingcartFPValidationData {
+	discountIncentives?: ShoppingcartDiscountIncentives[];
+}
+
+export interface ShoppingcartPromoItem {
+	applied_discount_amount?: number;
+	amount?: number;
+	discount_amount?: number;
+	price?: number;
+	quantity?: number;
+	source_id?: string;
+	subtotal_amount?: number;
+}
+
+export interface ShoppingcartPromoOrder {
+	items_applied_discount_amount?: number;
+	amount?: number;
+	items_discount_amount?: number;
+	total_amount?: number;
+	total_applied_discount_amount?: number;
+	total_discount_amount?: number;
+	items?: ShoppingcartPromoItem[];
+}
+
+export interface ShoppingcartPromoDetails {
+	provider?: 'fp' | 'voucherify';
+	provider_data?: ShoppingcartFPValidationData;
+	code?: string;
+	amount_off?: number;
+	percent_off?: number;
+	amount?: number;
+	app?: string;
+	discount?: Record<string, any>;
+	order?: ShoppingcartPromoOrder;
+}
+
+export interface ShoppingcartPaymentMethodMealplan {
+	id?: string;
+	tender?: string;
+	total?: number;
+	type?: string;
+}
+
+export interface ShoppingcartPaymentMethodCreditCard {
+	card_type?: string;
+	last4?: string;
+	total?: number;
+	type?: string;
+}
+
+export interface ShoppingcartPaymentMethodDigitalWalletPay {
+	wallet_type?: string;
+	total?: number;
+	type?: string;
+}
+
+export interface ShoppingcartPaymentMethodMealSwipes {
+	id?: string;
+	tender?: string;
+	tender_type?: string;
+	tender_name?: string;
+	swipes?: number;
+	rate?: number;
+	total?: number;
+	type?: string;
+}
+
+export interface ShoppingcartPaymentMethodMealExchange {
+	id?: string;
+	tender?: string;
+	type?: string;
+}
+
+export interface ShppingcartPaymentMethodCashlessTender {
+	id?: string;
+	total?: number;
+	tender?: string;
 	name?: string;
-	review: OrderItemRating;
+	type?: string;
+}
+
+export interface ShoppingcartPaymentMethod {
+	mealplan?: ShoppingcartPaymentMethodMealplan;
+	credit_card?: ShoppingcartPaymentMethodCreditCard;
+	digital_wallet_pay?: ShoppingcartPaymentMethodDigitalWalletPay;
+	meal_swipes?: ShoppingcartPaymentMethodMealSwipes;
+	meal_exchange?: ShoppingcartPaymentMethodMealExchange;
+	badge_pay?: ShppingcartPaymentMethodCashlessTender;
+	stipend?: ShppingcartPaymentMethodCashlessTender;
+	voucher?: ShppingcartPaymentMethodCashlessTender;
+	coupon_voucher?: ShppingcartPaymentMethodCashlessTender;
+}
+
+export interface ShoppingcartTaxBreakdown {
+	taxable_amount?: number;
+	tax_collectable?: number;
+	combined_tax_rate?: number;
+	gst?: number;
+	pst?: number;
+	provider?: string;
+}
+
+export interface TaxItem {
+	// 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 ShoppingCart {
+export interface TaxLocationData {
+	// unique location identifier
 	id: string;
-	total?: CartTotal;
-	items?: CartItem[];
+	// 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 TaxRequest {
+	// 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;
+	// items to calculate tax on
+	items: TaxItem[];
+	// iso timstamp of transaction date
+	transactionDate?: string;
+	// an array of items to refund
+	refunds?: TaxRefund[];
+	locationData: TaxLocationData;
+}
+
+export interface ShoppingcartTaxes {
+	breakdown?: ShoppingcartTaxBreakdown;
+	amount?: number;
+	rate?: number;
+	provider?: string;
+	quote_payload?: TaxRequest;
+}
+
+export interface ShoppingcartTotal {
+	amount: number;
+	meals?: number;
+}
+
+export interface ShoppingcartIs {
+	// Shoppingcart Type: delivery, pickup
+	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;
+	system365?: boolean;
 }
 
-export interface Order {
+export interface CustomerOrderShoppingcartDTO {
+	// shoppingcart
+	id: string;
+	// location
+	location: string;
+	// menu
+	menu?: string;
+	// brand
+	brand?: string;
+	items?: ShoppingcartItem[];
+	sub_total?: ShoppingcartMonetaryValue;
+	promo?: ShoppingcartPromoDetails;
+	discount?: ShoppingcartPromoDetails;
+	payment_method?: ShoppingcartPaymentMethod;
+	taxes?: ShoppingcartTaxes;
+	total?: ShoppingcartTotal;
+	service_fee?: ShoppingcartMonetaryValue;
+	delivery_fee?: ShoppingcartMonetaryValue;
+	is?: ShoppingcartIs;
+}
+
+export interface CustomerOrder {
+	meta?: {
+		[index: string]: any;
+	} & OrderMeta;
 	id?: string;
 	reorder_eligibility?:
 		| 'eligible'
@@ -221,20 +677,25 @@ export interface Order {
 		| 'modifiers_unavailable'
 		| 'modified_items'
 		| 'cancelled_order';
-	location_brand?: Brand;
+	location_brand?: CustomerOrderBrandDTO;
 	location?: string;
 	date?: OrderDate;
 	details?: OrderDetails;
 	pickup?: string;
 	requested_date?: string;
-	refunds?: RefundItem[];
+	refunds?: OrderRefundItem[];
 	pickup_id?: string;
-	is?: OrderIsStatus;
-	shoppingcart?: ShoppingCart;
+	payment?: OrderPayment;
+	mealplan?: OrderMealplan;
+	meal_swipes?: OrderMealSwipes;
+	is?: OrderIs;
+	issue?: OrderIssue;
+	shoppingcart?: CustomerOrderShoppingcartDTO;
 }
 
 export interface GetCustomerOrdersResponseDTO {
-	orders: Order[];
+	// customer orders
+	orders: CustomerOrder[];
 }
 
 export interface BadRequestErrorDTO {
@@ -243,26 +704,24 @@ export interface BadRequestErrorDTO {
 	data: Record<string, any>;
 }
 
-export interface ReviewOrderItemRatings {
-	// menu id
-	menu: string;
-	// item id
-	item: string;
+export interface PostReviewOrderItemRequest {
 	// rating score
 	score: number;
 	// review comment
 	comment: string;
 	// review tags
 	reason: string[];
+	menu: string;
+	item: string;
 }
 
-export interface PostReviewOrderItemRatingsRequestDTO {
+export interface PostReviewOrderItemsRequestDTO {
 	orderId: string;
-	reviews: ReviewOrderItemRatings[];
+	reviews: PostReviewOrderItemRequest[];
 }
 
-export interface PostReviewOrderItemRatingsResponseDTO {
-	reviews: OrderItemRating[];
+export interface PostReviewOrderItemsResponseDTO {
+	reviews: OrderItemReview[];
 }
 
 // GET /consumer/v1/health-check
@@ -295,7 +754,12 @@ export interface GetPaymentListByBrandRequest
 	extends BaseRequest,
 		RequestQuery<GetPaymentListByBrandQuery> {}
 
-// GET /consumer/customer-orders - Get customer orders
+// GET /consumer/customer-orders/{userId} - Get customer orders
+
+export interface GetCustomerOrdersPath {
+	// TODO: add parameter to swagger.json
+	userId: string;
+}
 
 export interface GetCustomerOrdersQuery {
 	// 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.
@@ -310,14 +774,15 @@ export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
 
 export interface GetCustomerOrdersRequest
 	extends BaseRequest,
-		RequestQuery<GetCustomerOrdersQuery> {}
+		RequestQuery<GetCustomerOrdersQuery>,
+		GetCustomerOrdersPath {}
 
-// POST /consumer/review/order/item-ratings - Submit review containing order item ratings
+// POST /consumer/review/order-items - Submit reviews for order items
 
-export type PostReviewOrderItemRatingsBody = PostReviewOrderItemRatingsRequestDTO;
+export type PostReviewOrderItemsBody = PostReviewOrderItemsRequestDTO;
 
-export type PostReviewOrderItemRatingsResponse = PostReviewOrderItemRatingsResponseDTO;
+export type PostReviewOrderItemsResponse = PostReviewOrderItemsResponseDTO;
 
-export interface PostReviewOrderItemRatingsRequest extends BaseRequest {
-	body: PostReviewOrderItemRatingsBody;
+export interface PostReviewOrderItemsRequest extends BaseRequest {
+	body: PostReviewOrderItemsBody;
 }