@compassdigital/sdk.typescript 3.40.0 → 3.41.0

package/src/interface/mealplan.ts

@@ -5,6 +5,9 @@ import { RequestQuery, BaseRequest } from "./util";
 export interface Error {
   code?: number;
   message?: string;
+  headers?: {
+    Location?: string;
+  };
 }
 
 export interface Tender {
@@ -142,13 +145,21 @@ export interface PostMealplanCallbackPath {
   id: string;
 }
 
+export interface PostMealplanCallbackQuery {
+  // Determines whether the request originates from a web client or not
+  web?: boolean;
+}
+
 export interface PostMealplanCallbackResponse {
   token?: string;
   // DH 1.0 format for returning the token
   cardNumber?: string;
 }
 
-export interface PostMealplanCallbackRequest extends BaseRequest, PostMealplanCallbackPath {}
+export interface PostMealplanCallbackRequest
+  extends BaseRequest,
+    RequestQuery<PostMealplanCallbackQuery>,
+    PostMealplanCallbackPath {}
 
 // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
 

package/src/interface/menu.ts

@@ -2,6 +2,55 @@
 
 import { RequestQuery, BaseRequest } from "./util";
 
+export interface ModifiersListResponse {
+  meta?: Meta;
+  results?: Modifier[];
+}
+
+export interface ModifierGroupsListResponse {
+  meta?: Meta;
+  results?: ModifierGroup[];
+}
+
+export interface Meta {
+  limit?: number;
+  page?: number;
+  sort_by?: string;
+  sort_order?: string;
+  search?: string;
+  total_results?: number;
+  total_pages?: number;
+  result_count?: number;
+  [index: string]: any;
+}
+
+export interface Modifier {
+  id?: string;
+  name?: string;
+  description?: string;
+  price?: number;
+  calories?: number;
+  posid?: string;
+  tax_tags?: string[];
+  barcode?: string;
+  is_active?: boolean;
+  is_in_stock?: boolean;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
+export interface ModifierGroup {
+  id?: string;
+  name?: string;
+  label?: string;
+  created_at?: string;
+  updated_at?: string;
+  deleted_at?: string;
+  [index: string]: any;
+}
+
 export interface Menu {
   // menu
   id?: string;
@@ -299,20 +348,131 @@ export interface ZippedExcelExport {
   format?: string;
 }
 
-// GET /menu/modifier/count
+// GET /menu/v2/modifiers
+
+export interface GetMenuV2ModifiersQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifiersResponse = ModifiersListResponse;
+
+export interface GetMenuV2ModifiersRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifiersQuery> {}
+
+// GET /menu/v2/modifier/{id}
+
+export interface GetMenuV2ModifierPath {
+  id: string;
+}
+
+export interface GetMenuV2ModifierQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierResponse = Modifier;
+
+export interface GetMenuV2ModifierRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierQuery>,
+    GetMenuV2ModifierPath {}
+
+// PATCH /menu/v2/modifier/{id}
+
+export interface PatchMenuV2ModifierPath {
+  id: string;
+}
+
+export type PatchMenuV2ModifierResponse = Modifier;
+
+export interface PatchMenuV2ModifierRequest extends BaseRequest, PatchMenuV2ModifierPath {}
+
+// POST /menu/v2/modifier
+
+export type PostMenuV2ModifierResponse = Modifier;
+
+export interface PostMenuV2ModifierRequest extends BaseRequest {}
+
+// GET /menu/v2/modifier/count
+
+export interface GetMenuV2ModifierCountQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV2ModifierCountResponse {
+  count?: number;
+}
+
+export interface GetMenuV2ModifierCountRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierCountQuery> {}
+
+// GET /menu/v2/modifier-groups
+
+export interface GetMenuV2ModifierGroupsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupsResponse = ModifierGroupsListResponse;
+
+export interface GetMenuV2ModifierGroupsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupsQuery> {}
+
+// POST /menu/v2/modifier-group
+
+export type PostMenuV2ModifierGroupResponse = Modifier;
+
+export interface PostMenuV2ModifierGroupRequest extends BaseRequest {}
+
+// GET /menu/v2/modifier-group/{id}
+
+export interface GetMenuV2ModifierGroupPath {
+  id: string;
+}
+
+export interface GetMenuV2ModifierGroupQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export type GetMenuV2ModifierGroupResponse = Modifier;
+
+export interface GetMenuV2ModifierGroupRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV2ModifierGroupQuery>,
+    GetMenuV2ModifierGroupPath {}
+
+// PATCH /menu/v2/modifier-group/{id}
+
+export interface PatchMenuV2ModifierGroupPath {
+  id: string;
+}
+
+export type PatchMenuV2ModifierGroupResponse = Modifier;
+
+export interface PatchMenuV2ModifierGroupRequest
+  extends BaseRequest,
+    PatchMenuV2ModifierGroupPath {}
+
+// GET /menu/v2/modifier-group/count
 
-export interface GetMenuModifierCountQuery {
+export interface GetMenuV2ModifierGroupCountQuery {
   // Graphql query string
   _query?: string;
 }
 
-export interface GetMenuModifierCountResponse {
+export interface GetMenuV2ModifierGroupCountResponse {
   count?: number;
 }
 
-export interface GetMenuModifierCountRequest
+export interface GetMenuV2ModifierGroupCountRequest
   extends BaseRequest,
-    RequestQuery<GetMenuModifierCountQuery> {}
+    RequestQuery<GetMenuV2ModifierGroupCountQuery> {}
 
 // GET /menu/client/{client_id} - Get menu client
 

package/src/interface/partner.ts

@@ -454,8 +454,6 @@ 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 {

package/src/interface/shoppingcart.ts

@@ -7,79 +7,134 @@ export interface Error {
   code?: number;
 }
 
-export interface Item {
-  // item
+export interface ItemsRequest {
+  items?: ItemRequest[];
+}
+
+export interface ItemRequest {
+  // item id
   id: string;
-  // index
+  quantity: Quantity;
+  options?: ModifierGroupRequest[];
   _index?: string;
-  quantity: number;
-  unit?: number;
-  price?: {
-    amount?: number;
+  meta?: {
+    brand?: string;
+    brand_label?: Label;
+    menu?: string;
+    [index: string]: any;
   };
+  special_instructions?: string;
+  amount_off_exclusions?: string[];
+}
+
+export interface ItemResponse {
+  // can be cdl item id or stringified timestamp
+  id: string;
+  description?: Label;
+  // index based on cdl id or stringified timestamp
+  _index?: string;
+  quantity: Quantity;
+  unit?: 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;
-    };
-    meta?: any;
-    items?: {
-      // option
-      id?: string;
-      label?: {
-        en?: string;
-      };
-      // index
-      _index?: string;
-      meta?: any;
-      quantity?: number;
-      amount_off_exclusions?: string[];
-    }[];
-  }[];
+  options?: ModifierGroupResponse[];
   // Details about discount like BOGO, LTO, Bundle etc.
   item_discount?: any;
   // user specified instructions for the item
   special_instructions?: string;
   amount_off_exclusions?: string[];
   added_on?: string;
-  [index: string]: any;
+  meal_value?: IntegerValue;
+  category?: Label;
 }
 
-export interface taxes {
-  amount?: number;
-  rate?: number;
-  breakdown?: {
-    taxable_amount?: number;
-    tax_collectable?: number;
-    combined_tax_rate?: number;
-    gst?: number;
-    pst?: number;
+export interface ModifierGroupRequest {
+  label?: Label;
+  items?: ModifierRequest[];
+}
+
+export interface ModifierGroupResponse {
+  id?: string;
+  label?: Label;
+  meta?: {
+    taxes?: string[];
+    original_label?: Label;
+    [index: string]: any;
+  };
+  items?: ModifierResponse[];
+  is?: {
+    disabled?: boolean;
+  };
+}
+
+export interface ModifierRequest {
+  // option/modifier
+  id?: string;
+  label?: Label;
+  _index?: string;
+  quantity?: Quantity;
+  amount_off_exclusions?: string[];
+}
+
+export interface ModifierResponse {
+  // option/modifier
+  id?: string;
+  price?: Price;
+  quantity?: Quantity;
+  label?: Label;
+  // index
+  _index?: string;
+  meta?: {
+    sort_number?: number;
+    original_label?: Label;
+    taxes?: string[];
     [index: string]: any;
   };
+  amount_off_exclusions?: string[];
+  is?: {
+    disabled?: boolean;
+  };
 }
 
-export interface Items {
-  items?: Item[];
+export interface Taxes {
+  amount?: MonetaryValue;
+  rate?: MonetaryValue;
+  breakdown?: {
+    taxable_amount?: MonetaryValue;
+    tax_collectable?: MonetaryValue;
+    combined_tax_rate?: MonetaryValue;
+    gst?: MonetaryValue;
+    pst?: MonetaryValue;
+    [index: string]: any;
+  };
 }
 
 export interface Promo {
@@ -89,7 +144,7 @@ export interface Promo {
 
 export interface BadgePay {
   id?: string;
-  total?: number;
+  total?: MonetaryValue;
   tender?: string;
   name?: string;
 }
@@ -99,26 +154,25 @@ export interface Payment {
   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 per swipe in cents
-    rate?: number;
-    total?: number;
+    swipes?: MonetaryValue;
+    rate?: MonetaryValue;
+    total?: MonetaryValue;
   };
   meal_exchange?: {
     id?: string;
@@ -174,23 +228,23 @@ export interface ShoppingCartResponse {
   // 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
@@ -198,34 +252,34 @@ export interface ShoppingCartResponse {
   };
   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;
@@ -233,10 +287,10 @@ export interface ShoppingCartResponse {
     };
     badge_pay?: BadgePay;
   };
-  taxes?: taxes;
+  taxes?: Taxes;
   total?: {
-    amount?: number;
-    meals?: number;
+    amount?: MonetaryValue;
+    meals?: MonetaryValue;
   };
   exemptions?: {
     tax?: boolean;
@@ -246,10 +300,10 @@ export interface ShoppingCartResponse {
     id?: string;
   };
   service_fee?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   delivery_fee?: {
-    amount?: number;
+    amount?: MonetaryValue;
   };
   is?: {
     // Shoppingcart Type: delivery, pickup
@@ -270,6 +324,21 @@ export interface ShoppingCartResponse {
 
 export type ShoppingCart = ShoppingCartResponse;
 
+export interface Label {
+  en?: string;
+  fr?: string;
+}
+
+export interface Price {
+  amount?: MonetaryValue;
+}
+
+export type MonetaryValue = number;
+
+export type IntegerValue = number;
+
+export type Quantity = IntegerValue;
+
 // POST /shoppingcart/ - Create a new ShoppingCart
 
 export type PostShoppingcartCartBody = ShoppingCartRequest;
@@ -287,7 +356,7 @@ export interface PutShoppingcartCartItemsPath {
   id: string;
 }
 
-export type PutShoppingcartCartItemsBody = Items;
+export type PutShoppingcartCartItemsBody = ItemsRequest;
 
 export type PutShoppingcartCartItemsResponse = ShoppingCartResponse;
 
@@ -302,7 +371,7 @@ export interface DeleteShoppingcartCartItemsPath {
   id: string;
 }
 
-export type DeleteShoppingcartCartItemsBody = Items;
+export type DeleteShoppingcartCartItemsBody = ItemsRequest;
 
 export type DeleteShoppingcartCartItemsResponse = ShoppingCartResponse;