@compassdigital/sdk.typescript 4.26.0 → 4.28.0

package/src/interface/menu.ts

@@ -34,6 +34,7 @@ export interface Menu {
     item_desc_edit_enabled?: boolean;
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
+    frictionless?: boolean;
   };
   meta?: {
     // User ID
@@ -73,6 +74,7 @@ export interface Item {
   ingredients?: Record<string, any>[];
   amount_off_exclusions?: AmountOffExclusionTypes[];
   nutrition?: {
+    //@deprecated
     kcal?: number;
     calories?: Nutrition;
     serving_size?: Nutrition;
@@ -151,6 +153,7 @@ export interface Item {
     unit?: string;
     amount?: number;
   };
+  //@deprecated
   is_deleted?: boolean;
   is?: {
     disabled?: boolean;
@@ -170,7 +173,9 @@ export interface Group {
     fr?: string;
   };
   items?: Item[];
+  //@deprecated
   is_disabled?: boolean;
+  //@deprecated
   name?: string;
   is?: {
     disabled?: boolean;
@@ -201,6 +206,7 @@ export interface Option {
   };
   sku?: number;
   nutrition?: {
+    //@deprecated
     kcal?: number;
     calories?: Nutrition;
   };
@@ -1744,11 +1750,11 @@ export interface DraftModifierEntityDTO {
   brand_id: string;
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
-  price_for_none: number;
-  price_for_less: number;
-  price_for_more: number;
-  pre_surcharge: number;
-  post_surcharge: number;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5968,11 +5974,11 @@ export interface PostMenuV3DraftModifierBody {
   brand_id: string;
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
-  price_for_none: number;
-  price_for_less: number;
-  price_for_more: number;
-  pre_surcharge: number;
-  post_surcharge: number;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -6124,11 +6130,11 @@ export type PostMenuV3DraftModifiersBody = {
   brand_id: string;
   menu_works?: MenuWorksDTO;
   is_out_of_stock?: boolean;
-  price_for_none: number;
-  price_for_less: number;
-  price_for_more: number;
-  pre_surcharge: number;
-  post_surcharge: number;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;

package/src/interface/order.ts

@@ -22,6 +22,7 @@ export interface CreateOrder {
   // user
   customer?: string;
   is?: {
+    //@deprecated
     accepted?: boolean;
     in_progress?: boolean;
     ready?: boolean;
@@ -31,7 +32,9 @@ export interface CreateOrder {
     source?: "web" | "mobile";
     [index: string]: any;
   };
+  //@deprecated
   pickup?: string;
+  //@deprecated
   pickup_name?: string;
   requested_date?: string;
   details?: {
@@ -56,6 +59,7 @@ export interface Issue {
   // issue
   id?: string;
   type?: string;
+  //@deprecated
   item?: {
     [index: string]: any;
   };
@@ -108,6 +112,7 @@ export interface Order {
   // user
   customer?: string;
   is?: {
+    //@deprecated
     accepted?: boolean;
     in_progress?: boolean;
     ready?: boolean;
@@ -142,8 +147,11 @@ export interface Order {
     // For delivery orders - date order was picked up from station for delivery(out_for_delivery)
     pickup?: string;
   };
+  //@deprecated
   pickup?: string;
+  //@deprecated
   pickup_name?: string;
+  //@deprecated
   pickup_id?: string;
   requested_date?: string;
   details?: {
@@ -287,6 +295,7 @@ export interface MealPlan {
 export interface OrderIssue {
   // Type of issue
   type?: string;
+  //@deprecated
   item?: {
     [index: string]: any;
   };
@@ -339,7 +348,9 @@ export interface Orders {
   lastKey?: string;
   count?: number;
   // url to query next set of data
-  links?: Record<string, any>;
+  links?: {
+    next?: string;
+  };
 }
 
 export interface ItemsWithIssue extends OrderedItem {

package/src/interface/partner.ts

@@ -277,6 +277,7 @@ export interface LocationGroup {
     [index: string]: any;
   };
   style?: Record<string, any>;
+  timezone?: string;
   [index: string]: any;
 }
 
@@ -357,7 +358,9 @@ export interface Brand {
   };
   timezone?: string;
   description?: string;
+  //@deprecated
   latitude?: number;
+  //@deprecated
   longitude?: number;
   address?: Address;
   menus?: MenuHours[];
@@ -413,6 +416,7 @@ export interface Brand {
   group?: string;
   // payment
   payment_provider?: string;
+  //@deprecated
   location_description?: string;
   // company
   company?: string;
@@ -611,6 +615,7 @@ export interface Group {
     ingredients?: Record<string, any>[];
     amount_off_exclusions?: AmountOffExclusionTypes[];
     nutrition?: {
+      //@deprecated
       kcal?: number;
       calories?: Nutrition;
       serving_size?: Nutrition;
@@ -676,6 +681,7 @@ export interface Group {
         };
         sku?: number;
         nutrition?: {
+          //@deprecated
           kcal?: number;
           calories?: Nutrition;
         };
@@ -734,6 +740,8 @@ export interface Group {
       sort_number?: number;
       // menu sort order
       menu_sort_number?: number;
+      // barcodes of the item
+      barcodes?: string[];
     };
     category?: {
       en?: string;
@@ -748,6 +756,7 @@ export interface Group {
       unit?: string;
       amount?: number;
     };
+    //@deprecated
     is_deleted?: boolean;
     is?: {
       disabled?: boolean;
@@ -758,7 +767,9 @@ export interface Group {
       featured?: boolean;
     };
   }[];
+  //@deprecated
   is_disabled?: boolean;
+  //@deprecated
   name?: string;
   is?: {
     disabled?: boolean;
@@ -804,12 +815,12 @@ export interface Success {
 // POST /partner/standardcognition/shoppingcart - Calculates a shoppingcart
 
 export interface PostPartnerStandardcognitionShoppingcartBody {
-  items?: {
+  items: {
     sku?: string;
     quantity?: number;
   }[];
   // brand
-  location_brand?: string;
+  location_brand: string;
   // shoppingcart
   shoppingcart?: string;
   // Meta data from Standard Cognition shoppingcart
@@ -844,7 +855,7 @@ export interface GetPartnerStandardcognitionStoresQuery {
   _query?: string;
 }
 
-export type GetPartnerStandardcognitionStoresResponse = CognitionStore;
+export type GetPartnerStandardcognitionStoresResponse = CognitionStore[];
 
 export interface GetPartnerStandardcognitionStoresRequest
   extends BaseRequest,

package/src/interface/promo.ts

@@ -254,12 +254,19 @@ export interface Customer {
   name?: string;
   email?: string;
   description?: string;
-  address?: Record<string, any>;
+  address?: {
+    [index: string]: any;
+  };
   phone?: string;
-  summary?: Record<string, any>;
-  loyalty?: Record<string, any>;
+  summary?: {
+    [index: string]: any;
+  };
+  loyalty?: {
+    [index: string]: any;
+  };
   metadata?: {
     origin?: string;
+    [index: string]: any;
   };
   created_at?: string;
   updated_at?: string;

package/src/interface/task.ts

@@ -16,6 +16,7 @@ export interface TaskLocation {
   action_time: string;
   // optional details
   details?: Record<string, any>;
+  [index: string]: any;
 }
 
 export interface Error {
@@ -136,12 +137,14 @@ export interface TaskOrder {
   delivery_instructions?: string;
   issue?: OrderIssue;
   past_issues?: OrderIssue[];
+  [index: string]: any;
 }
 
 export interface OrderIssue {
   // issue
   id?: string;
   type?: string;
+  //@deprecated
   item?: {
     [index: string]: any;
   };
@@ -153,6 +156,7 @@ export interface OrderIssue {
     created_at?: string;
     [index: string]: any;
   };
+  [index: string]: any;
 }
 
 export type TaskStatus =

package/src/interface/user.ts

@@ -50,7 +50,7 @@ export interface User {
       attempts?: number;
       first_attempted?: string;
     };
-    // phone verification details
+    //@deprecated
     phone_verification?: {
       verification_code?: string;
       date_generated?: number;
@@ -71,7 +71,7 @@ export interface User {
     locked_out?: boolean;
     // If the users email is verified
     verified?: boolean;
-    // User phone number verification
+    //@deprecated
     phone_verified?: boolean;
     // User deleted status
     deleted?: boolean;
@@ -130,6 +130,7 @@ export interface success {
 }
 
 export interface auth {
+  //@deprecated
   token?: string;
   access?: {
     token?: string;
@@ -145,6 +146,7 @@ export interface auth {
 }
 
 export interface guestAuth {
+  //@deprecated
   token?: string;
   access?: {
     token?: string;
@@ -174,6 +176,7 @@ export interface omsauth {
 }
 
 export interface guestAuthToken {
+  //@deprecated
   token?: string;
   access?: {
     token?: string;
@@ -184,7 +187,7 @@ export interface guestAuthToken {
 export type Permission = string;
 
 export interface KDSToken {
-  device?: Record<string, any>;
+  device?: KDSDevice;
   access?: {
     token?: string;
     expires?: number;
@@ -196,15 +199,13 @@ export interface KDSDevices {
 }
 
 export interface KDSDevice {
-  device?: {
-    id?: string;
-    lat?: string;
-    long?: string;
-    location_group?: string;
-    is?: {
-      authorized?: boolean;
-      deleted?: boolean;
-    };
+  id?: string;
+  lat?: string;
+  long?: string;
+  location_group?: string;
+  is?: {
+    authorized?: boolean;
+    deleted?: boolean;
   };
 }
 
@@ -512,9 +513,14 @@ export interface PatchUserAuthKdsPath {
   device_id: string;
 }
 
-export type PatchUserAuthKdsBody = Record<string, any>;
+export interface PatchUserAuthKdsBody {
+  // Location group of the device
+  location_group?: string;
+}
 
-export type PatchUserAuthKdsResponse = KDSDevice;
+export interface PatchUserAuthKdsResponse {
+  device?: KDSDevice;
+}
 
 export interface PatchUserAuthKdsRequest extends BaseRequest, PatchUserAuthKdsPath {
   body: PatchUserAuthKdsBody;

package/src/interface/vendor.ts

@@ -227,7 +227,6 @@ export interface GetVendorApplicationRequest
 // PATCH /vendor/application/{id} - Update an application (or update status)
 
 export interface PatchVendorApplicationPath {
-  // TODO: add parameter to swagger.json
   id: string;
 }