@compassdigital/sdk.typescript 4.46.0 → 4.48.0

package/lib/interface/menu.d.ts

@@ -26,10 +26,13 @@ export interface Menu {
         calories_edit_enabled?: boolean;
         item_label_edit_enabled?: boolean;
         frictionless?: boolean;
+        category_images_enabled?: boolean;
     };
     meta?: {
         locked_by_user?: string;
         last_modified_user?: string;
+        centricos?: boolean;
+        version?: number;
         [index: string]: any;
     };
 }
@@ -42,6 +45,7 @@ export interface Item {
     label?: {
         en?: string;
     };
+    name?: string;
     description?: {
         en?: string;
     };
@@ -108,13 +112,6 @@ export interface Item {
             type_id?: number;
             type?: string;
         };
-        featured?: {
-            sort_number?: number;
-            dates?: {
-                start?: string;
-                end?: string;
-            };
-        };
         sort_number?: number;
         menu_sort_number?: number;
         barcodes?: string[];
@@ -131,11 +128,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;
+        };
+    };
     is_deleted?: boolean;
     is?: {
         disabled?: boolean;
@@ -148,36 +156,61 @@ export interface Item {
 }
 export interface Group {
     id?: string;
+    name?: string;
     label?: {
         en?: string;
         fr?: string;
     };
     items?: Item[];
     is_disabled?: boolean;
-    name?: string;
     is?: {
         disabled?: boolean;
         hidden?: boolean;
+        item_images_enabled?: boolean;
     };
     meta?: {
         sort_number?: number;
         menu_sort_number?: number;
         [index: string]: any;
     };
+    image?: {
+        src?: string;
+        sizes?: {
+            original?: string;
+            thumbnail_80_80?: string;
+        };
+    };
 }
 export interface 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?: {
         kcal?: number;
@@ -193,6 +226,12 @@ export interface Option {
     meta?: {
         sort_number?: number;
         menu_sort_number?: number;
+        plu?: string;
+        sizing?: {
+            name?: string;
+            posid?: string;
+            price?: number;
+        }[];
         tax?: {
             tax_tag_code?: string;
         };
@@ -211,6 +250,7 @@ export interface OptionsGroup {
         en?: string;
     };
     unique_name?: string;
+    name?: string;
     items?: Option[];
     min?: number;
     max?: number;
@@ -218,12 +258,14 @@ export interface OptionsGroup {
         disabled?: boolean;
         hidden?: boolean;
         out_of_stock?: boolean;
+        incremental?: boolean;
     };
     meta?: {
         sort_number?: number;
         menu_sort_number?: number;
         [index: string]: any;
     };
+    limit?: number;
     [index: string]: any;
 }
 export interface OptionsGroupList {
@@ -292,6 +334,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;
@@ -307,6 +350,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;
 }
@@ -494,6 +538,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>[];
@@ -835,6 +880,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;
 }
@@ -1018,7 +1064,6 @@ export interface V2ItemCertifiedDTO {
 }
 export interface V2ItemMetaDTO {
     superplate?: V2ItemMetaSuperplateDTO;
-    featured?: V2ItemMetaFeaturedDTO;
     taxes?: Record<string, any>;
     sort_number?: number;
     menu_sort_number?: V2AmountDTO;
@@ -1027,14 +1072,6 @@ export interface V2ItemMetaSuperplateDTO {
     type_id?: number;
     type?: string;
 }
-export interface V2ItemMetaFeaturedDTO {
-    sort_number?: number;
-    dates?: V2DatesDTO;
-}
-export interface V2DatesDTO {
-    start?: string;
-    end?: string;
-}
 export interface V2AmountDTO {
     unit?: number;
     amount?: string;
@@ -1156,6 +1193,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;
@@ -1317,6 +1355,7 @@ export interface GetMenuItemsPath {
 export interface GetMenuItemsQuery {
     query: string;
     barcodes: string;
+    brand_id: string;
     _query?: string;
 }
 export type GetMenuItemsResponse = Items;
@@ -1935,6 +1974,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;
@@ -1984,6 +2024,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[];
@@ -2046,6 +2087,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;
@@ -2181,6 +2223,28 @@ export interface GetMenuV3DraftBrandModifiersReportingCategoriesResponse {
 }
 export interface GetMenuV3DraftBrandModifiersReportingCategoriesRequest extends BaseRequest, RequestQuery<GetMenuV3DraftBrandModifiersReportingCategoriesQuery>, GetMenuV3DraftBrandModifiersReportingCategoriesPath {
 }
+export interface GetMenuV3DraftBrandItemsTagsPath {
+    id: string;
+}
+export interface GetMenuV3DraftBrandItemsTagsQuery {
+    _query?: string;
+}
+export interface GetMenuV3DraftBrandItemsTagsResponse {
+    tags?: string[];
+}
+export interface GetMenuV3DraftBrandItemsTagsRequest extends BaseRequest, RequestQuery<GetMenuV3DraftBrandItemsTagsQuery>, GetMenuV3DraftBrandItemsTagsPath {
+}
+export interface GetMenuV3DraftBrandModifiersTagsPath {
+    id: string;
+}
+export interface GetMenuV3DraftBrandModifiersTagsQuery {
+    _query?: string;
+}
+export interface GetMenuV3DraftBrandModifiersTagsResponse {
+    tags?: string[];
+}
+export interface GetMenuV3DraftBrandModifiersTagsRequest extends BaseRequest, RequestQuery<GetMenuV3DraftBrandModifiersTagsQuery>, GetMenuV3DraftBrandModifiersTagsPath {
+}
 export interface PostMenuV3DraftBrandPublishPath {
     id: string;
 }
@@ -2263,6 +2327,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;
@@ -2312,6 +2377,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;
@@ -2375,6 +2441,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;
@@ -3048,6 +3115,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[];
@@ -3102,6 +3170,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;
@@ -3169,6 +3238,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[];
@@ -3236,6 +3306,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[];