@compassdigital/sdk.typescript 4.46.0 → 4.48.0

package/src/interface/menu.ts

@@ -35,12 +35,15 @@ export interface Menu {
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
     frictionless?: boolean;
+    category_images_enabled?: boolean;
   };
   meta?: {
     // User ID
     locked_by_user?: string;
     // User ID
     last_modified_user?: string;
+    centricos?: boolean;
+    version?: number;
     [index: string]: any;
   };
 }
@@ -56,6 +59,7 @@ export interface Item {
   label?: {
     en?: string;
   };
+  name?: string;
   description?: {
     en?: string;
   };
@@ -125,13 +129,6 @@ export interface Item {
       type_id?: number;
       type?: string;
     };
-    featured?: {
-      sort_number?: number;
-      dates?: {
-        start?: string;
-        end?: string;
-      };
-    };
     // chit sort order
     sort_number?: number;
     // menu sort order
@@ -151,11 +148,22 @@ export interface Item {
   item_number?: number;
   image?: {
     src?: string;
+    sizes?: {
+      original?: string;
+      thumbnail_80_80?: string;
+    };
   };
   weight?: {
     unit?: string;
     amount?: number;
   };
+  line_route?: string;
+  reporting?: {
+    category?: {
+      primary?: string;
+      secondary?: string;
+    };
+  };
   //@deprecated
   is_deleted?: boolean;
   is?: {
@@ -171,6 +179,7 @@ export interface Item {
 export interface Group {
   // group
   id?: string;
+  name?: string;
   label?: {
     en?: string;
     fr?: string;
@@ -178,11 +187,10 @@ export interface Group {
   items?: Item[];
   //@deprecated
   is_disabled?: boolean;
-  //@deprecated
-  name?: string;
   is?: {
     disabled?: boolean;
     hidden?: boolean;
+    item_images_enabled?: boolean;
   };
   meta?: {
     // chit sort order
@@ -191,6 +199,13 @@ export interface Group {
     menu_sort_number?: number;
     [index: string]: any;
   };
+  image?: {
+    src?: string;
+    sizes?: {
+      original?: string;
+      thumbnail_80_80?: string;
+    };
+  };
 }
 
 export interface Option {
@@ -199,14 +214,31 @@ export interface Option {
   label?: {
     en?: string;
   };
+  name?: string;
+  description?: {
+    en?: string;
+  };
   price?: {
     amount?: number;
     currency?: string;
   };
+  reporting?: {
+    category?: {
+      primary?: string;
+      secondary?: string;
+    };
+  };
   weight?: {
     unit?: string;
     amount?: number;
   };
+  image?: {
+    src?: string;
+    sizes?: {
+      original?: string;
+      thumbnail_80_80?: string;
+    };
+  };
   sku?: number;
   nutrition?: {
     //@deprecated
@@ -225,6 +257,12 @@ export interface Option {
     sort_number?: number;
     // menu sort order
     menu_sort_number?: number;
+    plu?: string;
+    sizing?: {
+      name?: string;
+      posid?: string;
+      price?: number;
+    }[];
     tax?: {
       tax_tag_code?: string;
     };
@@ -245,6 +283,7 @@ export interface OptionsGroup {
     en?: string;
   };
   unique_name?: string;
+  name?: string;
   items?: Option[];
   min?: number;
   max?: number;
@@ -252,6 +291,7 @@ export interface OptionsGroup {
     disabled?: boolean;
     hidden?: boolean;
     out_of_stock?: boolean;
+    incremental?: boolean;
   };
   meta?: {
     // chit sort order
@@ -260,6 +300,7 @@ export interface OptionsGroup {
     menu_sort_number?: number;
     [index: string]: any;
   };
+  limit?: number;
   [index: string]: any;
 }
 
@@ -343,6 +384,7 @@ export interface DraftBrandDTO {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   applied_diff_snapshot?: Record<string, any>;
   permissions?: Record<string, any>;
   [index: string]: any;
@@ -359,6 +401,7 @@ export interface PublishedBrandDTO {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -575,6 +618,7 @@ export interface DraftItemDTO {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: Record<string, any>[];
@@ -945,6 +989,7 @@ export interface PublishedItemDTO {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1146,7 +1191,6 @@ export interface V2ItemCertifiedDTO {
 
 export interface V2ItemMetaDTO {
   superplate?: V2ItemMetaSuperplateDTO;
-  featured?: V2ItemMetaFeaturedDTO;
   taxes?: Record<string, any>;
   sort_number?: number;
   menu_sort_number?: V2AmountDTO;
@@ -1157,16 +1201,6 @@ export interface V2ItemMetaSuperplateDTO {
   type?: string;
 }
 
-export interface V2ItemMetaFeaturedDTO {
-  sort_number?: number;
-  dates?: V2DatesDTO;
-}
-
-export interface V2DatesDTO {
-  start?: string;
-  end?: string;
-}
-
 export interface V2AmountDTO {
   unit?: number;
   amount?: string;
@@ -1303,6 +1337,7 @@ export interface DraftItemEntityDTO {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1565,6 +1600,8 @@ export interface GetMenuItemsQuery {
   query: string;
   // Comma Seperated Barcodes
   barcodes: string;
+  // AP3 Brand ID
+  brand_id: string;
   // Graphql query string
   _query?: string;
 }
@@ -2581,6 +2618,7 @@ export interface PostMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
@@ -2647,6 +2685,7 @@ export interface PatchMenuV3DraftBrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   changes?: BrandChangeDTO[];
@@ -2735,6 +2774,7 @@ export type PostMenuV3DraftBrandsBody = {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   applied_diff_snapshot?: Record<string, any>;
   changes?: BrandChangeDTO[];
   local_menu_group?: LocalMenuGroupDTO;
@@ -2959,6 +2999,46 @@ export interface GetMenuV3DraftBrandModifiersReportingCategoriesRequest
     RequestQuery<GetMenuV3DraftBrandModifiersReportingCategoriesQuery>,
     GetMenuV3DraftBrandModifiersReportingCategoriesPath {}
 
+// GET /menu/v3/draft/brand/{id}/items/tags
+
+export interface GetMenuV3DraftBrandItemsTagsPath {
+  id: string;
+}
+
+export interface GetMenuV3DraftBrandItemsTagsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3DraftBrandItemsTagsResponse {
+  tags?: string[];
+}
+
+export interface GetMenuV3DraftBrandItemsTagsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3DraftBrandItemsTagsQuery>,
+    GetMenuV3DraftBrandItemsTagsPath {}
+
+// GET /menu/v3/draft/brand/{id}/modifiers/tags
+
+export interface GetMenuV3DraftBrandModifiersTagsPath {
+  id: string;
+}
+
+export interface GetMenuV3DraftBrandModifiersTagsQuery {
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3DraftBrandModifiersTagsResponse {
+  tags?: string[];
+}
+
+export interface GetMenuV3DraftBrandModifiersTagsRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3DraftBrandModifiersTagsQuery>,
+    GetMenuV3DraftBrandModifiersTagsPath {}
+
 // POST /menu/v3/draft/brand/{id}/publish
 
 export interface PostMenuV3DraftBrandPublishPath {
@@ -3087,6 +3167,7 @@ export interface PostMenuV3BrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
   attachments?: FileAttachmentsDTO;
@@ -3154,6 +3235,7 @@ export interface PatchMenuV3BrandBody {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   version?: number;
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
@@ -3245,6 +3327,7 @@ export type PostMenuV3BrandsBody = {
   global_menu_group_id?: string;
   posid_segment?: string;
   is_simplified_view?: boolean;
+  frictionless_partner?: "AWS";
   local_menu_group?: LocalMenuGroupDTO;
   global_menu_group?: GlobalMenuGroupDTO;
   attachments?: FileAttachmentsDTO;
@@ -4279,6 +4362,7 @@ export interface PostMenuV3DraftItemBody {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4350,6 +4434,7 @@ export interface PatchMenuV3DraftItemBody {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -4443,6 +4528,7 @@ export type PostMenuV3DraftItemsBody = {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4532,6 +4618,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
   is_out_of_stock?: boolean;
   tax_tag_code?: string;
   tags?: string[];
+  is_featured?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];

package/src/interface/partner.ts

@@ -462,6 +462,9 @@ export interface Brand {
     active?: boolean;
     max_showcase_items?: number;
     jde_category?: string;
+    software_integrations?: {
+      system365?: string;
+    };
     [index: string]: any;
   };
   descriptions?: {
@@ -582,12 +585,15 @@ export interface Menu {
     calories_edit_enabled?: boolean;
     item_label_edit_enabled?: boolean;
     frictionless?: boolean;
+    category_images_enabled?: boolean;
   };
   meta?: {
     // User ID
     locked_by_user?: string;
     // User ID
     last_modified_user?: string;
+    centricos?: boolean;
+    version?: number;
     [index: string]: any;
   };
 }
@@ -595,6 +601,7 @@ export interface Menu {
 export interface Group {
   // group
   id?: string;
+  name?: string;
   label?: {
     en?: string;
     fr?: string;
@@ -605,6 +612,7 @@ export interface Group {
     label?: {
       en?: string;
     };
+    name?: string;
     description?: {
       en?: string;
     };
@@ -673,20 +681,38 @@ export interface Group {
         en?: string;
       };
       unique_name?: string;
+      name?: string;
       items?: {
         // option
         id?: string;
         label?: {
           en?: string;
         };
+        name?: string;
+        description?: {
+          en?: string;
+        };
         price?: {
           amount?: number;
           currency?: string;
         };
+        reporting?: {
+          category?: {
+            primary?: string;
+            secondary?: string;
+          };
+        };
         weight?: {
           unit?: string;
           amount?: number;
         };
+        image?: {
+          src?: string;
+          sizes?: {
+            original?: string;
+            thumbnail_80_80?: string;
+          };
+        };
         sku?: number;
         nutrition?: {
           //@deprecated
@@ -705,6 +731,12 @@ export interface Group {
           sort_number?: number;
           // menu sort order
           menu_sort_number?: number;
+          plu?: string;
+          sizing?: {
+            name?: string;
+            posid?: string;
+            price?: number;
+          }[];
           tax?: {
             tax_tag_code?: string;
           };
@@ -723,6 +755,7 @@ export interface Group {
         disabled?: boolean;
         hidden?: boolean;
         out_of_stock?: boolean;
+        incremental?: boolean;
       };
       meta?: {
         // chit sort order
@@ -731,6 +764,7 @@ export interface Group {
         menu_sort_number?: number;
         [index: string]: any;
       };
+      limit?: number;
       [index: string]: any;
     }[];
     required?: boolean;
@@ -765,11 +799,22 @@ export interface Group {
     item_number?: number;
     image?: {
       src?: string;
+      sizes?: {
+        original?: string;
+        thumbnail_80_80?: string;
+      };
     };
     weight?: {
       unit?: string;
       amount?: number;
     };
+    line_route?: string;
+    reporting?: {
+      category?: {
+        primary?: string;
+        secondary?: string;
+      };
+    };
     //@deprecated
     is_deleted?: boolean;
     is?: {
@@ -783,11 +828,10 @@ export interface Group {
   }[];
   //@deprecated
   is_disabled?: boolean;
-  //@deprecated
-  name?: string;
   is?: {
     disabled?: boolean;
     hidden?: boolean;
+    item_images_enabled?: boolean;
   };
   meta?: {
     // chit sort order
@@ -796,6 +840,13 @@ export interface Group {
     menu_sort_number?: number;
     [index: string]: any;
   };
+  image?: {
+    src?: string;
+    sizes?: {
+      original?: string;
+      thumbnail_80_80?: string;
+    };
+  };
 }
 
 export interface Nutrition {