@compassdigital/sdk.typescript 3.42.1 → 3.43.1

package/src/interface/menu.ts

@@ -387,15 +387,23 @@ export interface PatchMenuV2ModifierPath {
   id: string;
 }
 
+export type PatchMenuV2ModifierBody = Modifier;
+
 export type PatchMenuV2ModifierResponse = Modifier;
 
-export interface PatchMenuV2ModifierRequest extends BaseRequest, PatchMenuV2ModifierPath {}
+export interface PatchMenuV2ModifierRequest extends BaseRequest, PatchMenuV2ModifierPath {
+  body: PatchMenuV2ModifierBody;
+}
 
 // POST /menu/v2/modifier
 
+export type PostMenuV2ModifierBody = Modifier;
+
 export type PostMenuV2ModifierResponse = Modifier;
 
-export interface PostMenuV2ModifierRequest extends BaseRequest {}
+export interface PostMenuV2ModifierRequest extends BaseRequest {
+  body: PostMenuV2ModifierBody;
+}
 
 // GET /menu/v2/modifier/count
 
@@ -427,9 +435,13 @@ export interface GetMenuV2ModifierGroupsRequest
 
 // POST /menu/v2/modifier-group
 
-export type PostMenuV2ModifierGroupResponse = Modifier;
+export type PostMenuV2ModifierGroupBody = ModifierGroup;
 
-export interface PostMenuV2ModifierGroupRequest extends BaseRequest {}
+export type PostMenuV2ModifierGroupResponse = ModifierGroup;
+
+export interface PostMenuV2ModifierGroupRequest extends BaseRequest {
+  body: PostMenuV2ModifierGroupBody;
+}
 
 // GET /menu/v2/modifier-group/{id}
 
@@ -442,7 +454,7 @@ export interface GetMenuV2ModifierGroupQuery {
   _query?: string;
 }
 
-export type GetMenuV2ModifierGroupResponse = Modifier;
+export type GetMenuV2ModifierGroupResponse = ModifierGroup;
 
 export interface GetMenuV2ModifierGroupRequest
   extends BaseRequest,
@@ -455,11 +467,13 @@ export interface PatchMenuV2ModifierGroupPath {
   id: string;
 }
 
-export type PatchMenuV2ModifierGroupResponse = Modifier;
+export type PatchMenuV2ModifierGroupBody = ModifierGroup;
 
-export interface PatchMenuV2ModifierGroupRequest
-  extends BaseRequest,
-    PatchMenuV2ModifierGroupPath {}
+export type PatchMenuV2ModifierGroupResponse = ModifierGroup;
+
+export interface PatchMenuV2ModifierGroupRequest extends BaseRequest, PatchMenuV2ModifierGroupPath {
+  body: PatchMenuV2ModifierGroupBody;
+}
 
 // GET /menu/v2/modifier-group/count
 

package/src/interface/partner.ts

@@ -7,7 +7,7 @@ export interface Error {
   code?: number;
 }
 
-export interface ShoppingCart {
+export interface ShoppingCartResponse {
   // shoppingcart
   id?: string;
   // location
@@ -17,23 +17,23 @@ export interface ShoppingCart {
   // brand
   brand?: string;
   date?: any;
-  items?: Item[];
+  items?: ItemResponse[];
   sub_total?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   promo?: {
     code?: string;
-    amount_off?: number;
-    percent_off?: number;
-    amount?: number;
+    amount_off?: MonetaryValue;
+    percent_off?: MonetaryValue;
+    amount?: MonetaryValue;
     app?: string;
   };
   //@deprecated
   loyalty?: {
     coupon?: {
       code?: string;
-      amount_off?: number;
-      amount?: number;
+      amount_off?: MonetaryValue;
+      amount?: MonetaryValue;
       name?: string;
     };
     // Points to be earned for this shopping cart total
@@ -41,34 +41,34 @@ export interface ShoppingCart {
   };
   discount?: {
     code?: string;
-    amount_off?: number;
-    percent_off?: number;
-    amount?: number;
+    amount_off?: MonetaryValue;
+    percent_off?: MonetaryValue;
+    amount?: MonetaryValue;
   };
   payment_method?: {
     email?: string;
     mealplan?: {
       id?: string;
       tender?: string;
-      total?: number;
+      total?: MonetaryValue;
     };
     credit_card?: {
       card_type?: string;
       last4?: string;
-      total?: number;
+      total?: MonetaryValue;
     };
     digital_wallet_pay?: {
       wallet_type?: string;
-      total?: number;
+      total?: MonetaryValue;
     };
     meal_swipes?: {
       id?: string;
       tender?: string;
       tender_type?: string;
       tender_name?: string;
-      swipes?: number;
-      rate?: number;
-      total?: number;
+      swipes?: MonetaryValue;
+      rate?: MonetaryValue;
+      total?: MonetaryValue;
     };
     meal_exchange?: {
       id?: string;
@@ -76,10 +76,10 @@ export interface ShoppingCart {
     };
     badge_pay?: BadgePay;
   };
-  taxes?: taxes;
+  taxes?: Taxes;
   total?: {
-    amount?: number;
-    meals?: number;
+    amount?: MonetaryValue;
+    meals?: MonetaryValue;
   };
   exemptions?: {
     tax?: boolean;
@@ -89,10 +89,10 @@ export interface ShoppingCart {
     id?: string;
   };
   service_fee?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   delivery_fee?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   is?: {
     // Shoppingcart Type: delivery, pickup
@@ -111,54 +111,72 @@ export interface ShoppingCart {
   };
 }
 
-export interface Item {
-  // item
+export interface ItemResponse {
+  // can be cdl item id or stringified timestamp
   id: string;
-  // index
+  description?: Label;
+  // index based on cdl id or stringified timestamp
   _index?: string;
-  quantity: number;
+  quantity: Quantity;
   unit?: number;
-  price?: {
-    amount?: number;
-  };
+  price?: Price;
   // Final item price after LTO/Bundle/BOGO etc is applied on the item.
   sale_price?: {
     active?: boolean;
-    amount?: number;
+    amount?: MonetaryValue;
   };
   // Subtotal of the item including all options
   _subtotal?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   // Promo applied to this item
   _promo?: {
-    amount?: number;
+    amount?: MonetaryValue;
+  };
+  // discount applied to this item
+  _discount?: {
+    amount?: MonetaryValue;
   };
   meta?: {
     // menu id
     menu?: string;
     // brand id
     brand?: string;
+    brand_label?: Label;
+    taxes?: string[];
+    menu_tax_tags?: string[];
+    orderable?: boolean;
+    volante_id?: string;
     [index: string]: any;
   };
   options?: {
     id?: string;
-    label?: {
-      en?: string;
+    label?: Label;
+    meta?: {
+      taxes?: string[];
+      original_label?: Label;
     };
-    meta?: any;
     items?: {
-      // option
+      // option/modifier
       id?: string;
-      label?: {
-        en?: string;
-      };
+      price?: Price;
+      quantity?: Quantity;
+      label?: Label;
       // index
       _index?: string;
-      meta?: any;
-      quantity?: number;
+      meta?: {
+        sort_number?: number;
+        original_label?: Label;
+        taxes?: string[];
+      };
       amount_off_exclusions?: string[];
+      is?: {
+        disabled?: boolean;
+      };
     }[];
+    is?: {
+      disabled?: boolean;
+    };
   }[];
   // Details about discount like BOGO, LTO, Bundle etc.
   item_discount?: any;
@@ -166,25 +184,41 @@ export interface Item {
   special_instructions?: string;
   amount_off_exclusions?: string[];
   added_on?: string;
-  [index: string]: any;
+  meal_value?: IntegerValue;
+  category?: Label;
+}
+
+export type MonetaryValue = number;
+
+export interface Label {
+  en?: string;
+  fr?: string;
+}
+
+export type IntegerValue = number;
+
+export interface Price {
+  amount?: MonetaryValue;
 }
 
+export type Quantity = number;
+
 export interface BadgePay {
   id?: string;
-  total?: number;
+  total?: MonetaryValue;
   tender?: string;
   name?: string;
 }
 
-export interface taxes {
-  amount?: number;
-  rate?: number;
+export interface Taxes {
+  amount?: MonetaryValue;
+  rate?: MonetaryValue;
   breakdown?: {
-    taxable_amount?: number;
-    tax_collectable?: number;
-    combined_tax_rate?: number;
-    gst?: number;
-    pst?: number;
+    taxable_amount?: MonetaryValue;
+    tax_collectable?: MonetaryValue;
+    combined_tax_rate?: MonetaryValue;
+    gst?: MonetaryValue;
+    pst?: MonetaryValue;
     [index: string]: any;
   };
 }
@@ -454,6 +488,8 @@ export interface WaitTime {
   max: number;
   // minimum wait time to the next time slot in minutes
   min: number;
+  // the epoch timestamp of the next available ready time for a station
+  ready_time: number;
 }
 
 export interface Menu {
@@ -526,24 +562,21 @@ export interface Group {
     // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
     unit?: number;
     ingredients?: any[];
-    amount_off_exclusions?: string[];
+    amount_off_exclusions?: AmountOffExclusionTypes[];
     nutrition?: {
       kcal?: number;
-      calories?: any;
-      serving_size?: any;
-      total_fat?: any;
-      saturated_fat?: any;
-      trans_fat?: any;
-      cholesterol?: any;
-      sodium?: {
-        amount?: number;
-        unit?: string;
-      };
-      total_carbohydrate?: any;
-      dietary_fiber?: any;
-      sugars?: any;
-      protein?: any;
-      well_being?: any;
+      calories?: Nutrition;
+      serving_size?: Nutrition;
+      total_fat?: Nutrition;
+      saturated_fat?: Nutrition;
+      trans_fat?: Nutrition;
+      cholesterol?: Nutrition;
+      sodium?: Nutrition;
+      total_carbohydrate?: Nutrition;
+      dietary_fiber?: Nutrition;
+      sugars?: Nutrition;
+      protein?: Nutrition;
+      well_being?: Nutrition;
       [index: string]: any;
     };
     certified?: {
@@ -593,7 +626,7 @@ export interface Group {
         sku?: number;
         nutrition?: {
           kcal?: number;
-          calories?: any;
+          calories?: Nutrition;
         };
         certified?: {
           vegan?: boolean;
@@ -614,7 +647,7 @@ export interface Group {
           hidden?: boolean;
           out_of_stock?: boolean;
         };
-        amount_off_exclusions?: any[];
+        amount_off_exclusions?: AmountOffExclusionTypes[];
       }[];
       min?: number;
       max?: number;
@@ -685,6 +718,13 @@ export interface Group {
   };
 }
 
+export interface Nutrition {
+  amount?: number;
+  unit?: string;
+}
+
+export type AmountOffExclusionTypes = string;
+
 export interface CognitionStore {
   // UUID for external store
   uuid?: string;
@@ -733,7 +773,7 @@ export interface PostPartnerStandardcognitionShoppingcartBody {
   meta?: any;
 }
 
-export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCart;
+export type PostPartnerStandardcognitionShoppingcartResponse = ShoppingCartResponse;
 
 export interface PostPartnerStandardcognitionShoppingcartRequest extends BaseRequest {
   body: PostPartnerStandardcognitionShoppingcartBody;