@compassdigital/sdk.typescript 4.45.0 → 4.47.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;
     };
@@ -131,11 +135,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 +163,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 +233,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 +257,7 @@ export interface OptionsGroup {
         en?: string;
     };
     unique_name?: string;
+    name?: string;
     items?: Option[];
     min?: number;
     max?: number;
@@ -218,12 +265,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 +341,7 @@ export interface DraftBrandDTO {
     global_menu_group_id?: string;
     posid_segment?: string;
     is_simplified_view?: boolean;
+    applied_diff_snapshot?: Record<string, any>;
     permissions?: Record<string, any>;
     [index: string]: any;
 }
@@ -474,6 +524,8 @@ export interface DraftItemDTO {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting?: Record<string, any>;
@@ -490,6 +542,7 @@ export interface DraftItemDTO {
     menu_works?: Record<string, any>;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     categories?: Record<string, any>[];
@@ -568,6 +621,8 @@ export interface DraftModifierDTO {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price?: number;
@@ -586,6 +641,7 @@ export interface DraftModifierDTO {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
@@ -811,6 +867,8 @@ export interface PublishedItemDTO {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price?: number;
@@ -825,6 +883,7 @@ export interface PublishedItemDTO {
     posid_segment?: string;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     permissions?: Record<string, any>;
     [index: string]: any;
 }
@@ -869,6 +928,8 @@ export interface PublishedModifierDTO {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price?: number;
@@ -885,6 +946,7 @@ export interface PublishedModifierDTO {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     permissions?: Record<string, any>;
     [index: string]: any;
 }
@@ -1124,6 +1186,8 @@ export interface DraftItemEntityDTO {
     deleted_at?: string;
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting: ReportingMetadataDTO;
@@ -1140,6 +1204,7 @@ export interface DraftItemEntityDTO {
     menu_works?: MenuWorksDTO;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -1161,6 +1226,8 @@ export interface DraftModifierEntityDTO {
     deleted_at?: string;
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price: number;
@@ -1179,6 +1246,7 @@ export interface DraftModifierEntityDTO {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -1916,6 +1984,7 @@ export interface PostMenuV3DraftBrandBody {
     global_menu_group_id?: string;
     posid_segment?: string;
     is_simplified_view?: boolean;
+    applied_diff_snapshot?: Record<string, any>;
     changes?: BrandChangeDTO[];
     local_menu_group?: LocalMenuGroupDTO;
     global_menu_group?: GlobalMenuGroupDTO;
@@ -1964,6 +2033,7 @@ export interface PatchMenuV3DraftBrandBody {
     global_menu_group_id?: string;
     posid_segment?: string;
     is_simplified_view?: boolean;
+    applied_diff_snapshot?: Record<string, any>;
     version?: number;
     changes?: BrandChangeDTO[];
     local_menu_group?: LocalMenuGroupDTO;
@@ -2025,6 +2095,7 @@ export type PostMenuV3DraftBrandsBody = {
     global_menu_group_id?: string;
     posid_segment?: string;
     is_simplified_view?: boolean;
+    applied_diff_snapshot?: Record<string, any>;
     changes?: BrandChangeDTO[];
     local_menu_group?: LocalMenuGroupDTO;
     global_menu_group?: GlobalMenuGroupDTO;
@@ -2159,6 +2230,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;
 }
@@ -3007,6 +3100,8 @@ export interface PostMenuV3DraftItemBody {
     modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting: ReportingMetadataDTO;
@@ -3023,6 +3118,7 @@ export interface PostMenuV3DraftItemBody {
     menu_works?: MenuWorksDTO;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
@@ -3058,6 +3154,8 @@ export interface PatchMenuV3DraftItemBody {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting?: ReportingMetadataDTO;
@@ -3074,6 +3172,7 @@ export interface PatchMenuV3DraftItemBody {
     menu_works?: MenuWorksDTO;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -3122,6 +3221,8 @@ export type PostMenuV3DraftItemsBody = {
     modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting: ReportingMetadataDTO;
@@ -3138,6 +3239,7 @@ export type PostMenuV3DraftItemsBody = {
     menu_works?: MenuWorksDTO;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
@@ -3186,6 +3288,8 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     reporting?: ReportingMetadataDTO;
@@ -3202,6 +3306,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
     menu_works?: MenuWorksDTO;
     is_out_of_stock?: boolean;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
@@ -3855,6 +3960,8 @@ export interface PostMenuV3DraftModifierBody {
     modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price: number;
@@ -3873,6 +3980,7 @@ export interface PostMenuV3DraftModifierBody {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
@@ -3907,6 +4015,8 @@ export interface PatchMenuV3DraftModifierBody {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price?: number;
@@ -3925,6 +4035,7 @@ export interface PatchMenuV3DraftModifierBody {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -3972,6 +4083,8 @@ export type PostMenuV3DraftModifiersBody = {
     modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
     parent_id?: string;
     name: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price: number;
@@ -3990,6 +4103,7 @@ export type PostMenuV3DraftModifiersBody = {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
@@ -4025,6 +4139,8 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
     id?: string;
     parent_id?: string;
     name?: string;
+    name_on_receipt?: string;
+    name_on_kds?: string;
     label?: string;
     description?: string;
     price?: number;
@@ -4043,6 +4159,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
     pre_surcharge?: number;
     post_surcharge?: number;
     tax_tag_code?: string;
+    tags?: string[];
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];