@compassdigital/sdk.typescript 4.45.0 → 4.47.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;
   };
@@ -151,11 +155,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 +186,7 @@ export interface Item {
 export interface Group {
   // group
   id?: string;
+  name?: string;
   label?: {
     en?: string;
     fr?: string;
@@ -178,11 +194,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 +206,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 +221,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 +264,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 +290,7 @@ export interface OptionsGroup {
     en?: string;
   };
   unique_name?: string;
+  name?: string;
   items?: Option[];
   min?: number;
   max?: number;
@@ -252,6 +298,7 @@ export interface OptionsGroup {
     disabled?: boolean;
     hidden?: boolean;
     out_of_stock?: boolean;
+    incremental?: boolean;
   };
   meta?: {
     // chit sort order
@@ -260,6 +307,7 @@ export interface OptionsGroup {
     menu_sort_number?: number;
     [index: string]: any;
   };
+  limit?: number;
   [index: string]: any;
 }
 
@@ -343,6 +391,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;
 }
@@ -555,6 +604,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>;
@@ -571,6 +622,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>[];
@@ -653,6 +705,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;
@@ -671,6 +725,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[];
@@ -921,6 +976,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;
@@ -935,6 +992,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;
 }
@@ -983,6 +1041,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;
@@ -999,6 +1059,7 @@ export interface PublishedModifierDTO {
   pre_surcharge?: number;
   post_surcharge?: number;
   tax_tag_code?: string;
+  tags?: string[];
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1271,6 +1332,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;
@@ -1287,6 +1350,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;
@@ -1309,6 +1373,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;
@@ -1327,6 +1393,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;
@@ -2562,6 +2629,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;
@@ -2627,6 +2695,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;
@@ -2714,6 +2783,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;
@@ -2937,6 +3007,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 {
@@ -4238,6 +4348,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;
@@ -4254,6 +4366,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[];
@@ -4306,6 +4419,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;
@@ -4322,6 +4437,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;
@@ -4396,6 +4512,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;
@@ -4412,6 +4530,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[];
@@ -4482,6 +4601,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;
@@ -4498,6 +4619,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[];
@@ -5495,6 +5617,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;
@@ -5513,6 +5637,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[];
@@ -5564,6 +5689,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;
@@ -5582,6 +5709,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;
@@ -5655,6 +5783,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;
@@ -5673,6 +5803,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[];
@@ -5721,6 +5852,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;
@@ -5739,6 +5872,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[];

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?: {

package/test/client.test.ts

@@ -28,7 +28,7 @@ describe('ServiceClient', () => {
 		expect(req).toEqual({
 			name: 'get_task',
 			service: 'task',
-			url: 'https://api.compassdigital.org/dev/task/some_id',
+			url: 'https://dev.api.compassdigital.org/task/some_id',
 			method: 'get',
 			headers: {
 				'User-Agent': 'CDL/ServiceClient',