@compassdigital/sdk.typescript 4.83.0 → 4.85.0

package/src/interface/partner.ts

@@ -273,9 +273,7 @@ export interface LocationGroup {
 	distance?: number;
 	locations?: Location[];
 	address?: Address;
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	style?: Record<string, any>;
 	timezone?: string;
 	[index: string]: any;
@@ -296,9 +294,7 @@ export interface Location {
 	latitude?: number;
 	longitude?: number;
 	brands?: Brand[];
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	phone?: string;
 	// group
 	location_group?: string;
@@ -374,13 +370,14 @@ export interface Brand {
 	// pos
 	pos?: string;
 	terminals?: Record<string, any>[];
-	device_mapping?: {
-		[index: string]: {
+	device_mapping?: Record<
+		string,
+		{
 			device_type: string;
 			site_device_id: string;
 			business_units: string[];
-		}[];
-	};
+		}[]
+	>;
 	timeslots?: {
 		time?: string;
 		averagePrepTime?: string;

package/src/interface/promo.ts

@@ -93,9 +93,7 @@ export interface Event {
 }
 
 export interface Calendar {
-	timezones: {
-		[index: string]: string;
-	};
+	timezones: Record<string, string>;
 	events: Event[];
 }
 
@@ -114,9 +112,7 @@ export type PromotionMenuItems = {
 	min?: number;
 	max?: number;
 	quantity?: number;
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }[];
 
 export interface PromoMeta {
@@ -256,16 +252,10 @@ export interface Customer {
 	name?: string;
 	email?: string;
 	description?: string;
-	address?: {
-		[index: string]: any;
-	};
+	address?: Record<string, any>;
 	phone?: string;
-	summary?: {
-		[index: string]: any;
-	};
-	loyalty?: {
-		[index: string]: any;
-	};
+	summary?: Record<string, any>;
+	loyalty?: Record<string, any>;
 	metadata?: {
 		origin?: string;
 		[index: string]: any;

package/src/interface/search.ts

@@ -18,9 +18,7 @@ export interface GetShoppingcartDto {
 	source_id: string;
 	menu: string;
 	location: string;
-	meta: {
-		[index: string]: any;
-	};
+	meta: Record<string, any>;
 	sub_total: Record<string, any>;
 	payment_method: Record<string, any>;
 	loyalty: Record<string, any>;

package/src/interface/shoppingcart.ts

@@ -262,6 +262,19 @@ export interface ShoppingCartRequest {
 	menu?: string;
 	// brand
 	brand?: string;
+	promo?: PromoDetails;
+	discount?: PromoDetails;
+	payment_method?: PaymentMethod;
+	taxes?: Taxes;
+	exemptions?: {
+		tax?: boolean;
+	};
+	service_fee?: {
+		amount?: MonetaryValue;
+	};
+	delivery_fee?: {
+		amount?: MonetaryValue;
+	};
 	is?: {
 		// Shoppingcart Type: delivery, pickup
 		type?: 'delivery' | 'pickup' | 'scan_and_go' | 'frictionless';
@@ -295,17 +308,7 @@ export interface ShoppingCartResponse {
 	sub_total?: {
 		amount?: MonetaryValue;
 	};
-	promo?: {
-		code?: string;
-		provider?: 'fp' | 'voucherify';
-		amount_off?: MonetaryValue;
-		percent_off?: MonetaryValue;
-		amount?: MonetaryValue;
-		app?: string;
-		discount?: Record<string, any>;
-		provider_data?: FPValidationData;
-		order?: PromoOrder;
-	};
+	promo?: PromoDetails;
 	//@deprecated
 	loyalty?: {
 		coupon?: {
@@ -317,26 +320,8 @@ export interface ShoppingCartResponse {
 		// Points to be earned for this shopping cart total
 		order_loyalty_points?: boolean;
 	};
-	discount?: {
-		code?: string;
-		provider?: 'fp' | 'voucherify';
-		amount_off?: MonetaryValue;
-		percent_off?: MonetaryValue;
-		amount?: MonetaryValue;
-		discount?: Record<string, any>;
-		provider_data?: FPValidationData;
-	};
-	payment_method?: {
-		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;
-	};
+	discount?: PromoDetails;
+	payment_method?: PaymentMethod;
 	taxes?: Taxes;
 	total?: {
 		amount?: MonetaryValue;
@@ -377,6 +362,18 @@ export interface ShoppingCartResponse {
 
 export type ShoppingCart = ShoppingCartResponse;
 
+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 PaymentMethods {
 	mealplan: {
 		tenders: Tender[];
@@ -497,6 +494,7 @@ export interface DrainOrderType {
 }
 
 export interface TaxRequestDTO {
+	// a unique identifier representing the transaction
 	id: string;
 	// the app to associate the transaction with
 	appName: string;
@@ -516,6 +514,7 @@ export interface TaxRequestDTO {
 }
 
 export interface TaxLocationData {
+	// unique location identifier
 	id: string;
 	// country of transaction
 	country: string;
@@ -530,6 +529,7 @@ export interface TaxLocationData {
 }
 
 export interface TaxItemDTO {
+	// unique item identifier
 	id: string;
 	// indicates a tax rule for an item
 	taxTagCode: string;
@@ -554,6 +554,18 @@ export type ModifierSizing = {
 	posid?: string;
 }[];
 
+export interface PromoDetails {
+	code?: string;
+	provider?: 'fp' | 'voucherify';
+	amount_off?: MonetaryValue;
+	percent_off?: MonetaryValue;
+	amount?: MonetaryValue;
+	app?: string;
+	discount?: Record<string, any>;
+	provider_data?: FPValidationData;
+	order?: PromoOrder;
+}
+
 // POST /shoppingcart - Create a new ShoppingCart
 
 export interface PostShoppingcartCartQuery {

package/src/interface/task.ts

@@ -43,9 +43,7 @@ export interface Task {
 	dropoff_details?: TaskLocation;
 	status?: TaskStatus;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	// Date when Task was created
 	created?: string;
 	// Date when Task expires
@@ -84,9 +82,7 @@ export interface TaskCreate {
 	dropoff_details: TaskLocation;
 	status: TaskStatus;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	// Task Type
 	type: 'bolter' | 'kds';
 }
@@ -107,9 +103,7 @@ export interface TaskUpdate {
 	status?: TaskStatus;
 	assignee?: string;
 	// Any related metadata information about this Task
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }
 
 export interface OrderUpdate {
@@ -137,9 +131,7 @@ export interface OrderIssue {
 	id?: string;
 	type?: string;
 	//@deprecated
-	item?: {
-		[index: string]: any;
-	};
+	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: Record<string, any>[];
 	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues

package/src/interface/util.ts

@@ -1,8 +1,22 @@
 /**
- * Convert number query parameters to string.
+ * Convert a query parameter value to the request type.
+ *
+ * - number types are converted to string
+ * - Array<T> types are converted to Array<T> | T
+ */
+export type RequestQueryParam<T> = T extends undefined
+	? undefined
+	: T extends number
+		? string
+		: T extends any[]
+			? RequestQueryParam<T[number]>[] | RequestQueryParam<T[number]>
+			: T;
+
+/**
+ * Convert the query parameters to the request types.
  */
 export type RequestQuery<T extends object> = {
-	[K in keyof T]: T[K] extends number | undefined ? string : T[K];
+	[K in keyof T]: RequestQueryParam<T[K]>;
 };
 
 /**