@compassdigital/sdk.typescript 4.23.0 → 4.24.0

package/src/interface/menu.ts

@@ -134,6 +134,8 @@ export interface Item {
     sort_number?: number;
     // menu sort order
     menu_sort_number?: number;
+    // barcodes of the item
+    barcodes?: string[];
     [index: string]: any;
   };
   category?: {
@@ -589,6 +591,7 @@ export interface DraftItemDTO {
   line_route?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
   menu_works?: Record<string, any>;
+  is_out_of_stock?: FilterFieldDTO;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   categories?: Record<string, any>[];
@@ -633,7 +636,9 @@ export interface DraftModifierGroupDTO {
   is_active?: boolean;
   limit?: number;
   brand_id?: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: FilterFieldDTO;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   changes?: ModifierGroupChangeDTO[];
@@ -678,8 +683,13 @@ export interface DraftModifierDTO {
   reporting?: ReportingMetadataDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: string;
-  sizing?: FilterFieldDTO[];
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   applied_diff_snapshot?: FilterFieldDTO;
   brand?: Record<string, any>;
   changes?: ModifierChangeDTO[];
@@ -729,10 +739,11 @@ export interface FileAttachmentsDTO {
 export interface MenuWorksDTO {
   MRN?: FilterFieldDTO;
   unit_id?: FilterFieldDTO;
-  GTIN?: FilterFieldDTO;
+  portion_quantity?: number;
+  portion_unit_name?: FilterFieldDTO;
+  grams?: number;
   cost?: number;
-  ingredients?: FilterFieldDTO[];
-  smart_tags?: FilterFieldDTO[];
+  calories?: number;
   id?: Record<string, any>;
   [index: string]: any;
 }
@@ -852,7 +863,12 @@ export interface DraftModifierDraftModifierDTO {
   posid?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  sizing?: FilterFieldDTO[];
+  is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: FilterFieldDTO;
+  price_for_less?: FilterFieldDTO;
+  price_for_more?: FilterFieldDTO;
+  pre_surcharge?: FilterFieldDTO;
+  post_surcharge?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -882,7 +898,9 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
   is_active?: FilterFieldDTO;
   limit?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  type?: FilterFieldDTO;
+  order_type?: FilterFieldDTO;
+  sizing?: FilterFieldDTO;
+  is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -915,6 +933,7 @@ export interface DraftItemDraftItemDTO {
   brand_id?: FilterFieldDTO;
   line_route?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
+  is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1053,6 +1072,7 @@ export interface PublishedItemDTO {
   brand_id?: string;
   line_route?: string;
   posid_segment?: string;
+  is_out_of_stock?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1078,7 +1098,9 @@ export interface PublishedModifierGroupDTO {
   is_active?: boolean;
   limit?: number;
   brand_id?: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: boolean;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1107,7 +1129,12 @@ export interface PublishedModifierDTO {
   posid?: string;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
+  is_out_of_stock?: boolean;
+  price_for_none?: number;
+  price_for_less?: number;
+  price_for_more?: number;
+  pre_surcharge?: number;
+  post_surcharge?: number;
   permissions?: Record<string, any>;
   [index: string]: any;
 }
@@ -1188,6 +1215,258 @@ export interface PublishedMenuPublishedMenuDTO {
   [index: string]: any;
 }
 
+export interface GroupStockUpdate {
+  id: string;
+  items?: ItemStockUpdate[];
+  [index: string]: any;
+}
+
+export interface ItemStockUpdate {
+  id: string;
+  is?: IsStockUpdate;
+  options?: ModifierGroupStockUpdate[];
+  [index: string]: any;
+}
+
+export interface IsStockUpdate {
+  out_of_stock?: boolean;
+}
+
+export interface ModifierGroupStockUpdate {
+  id: string;
+  is?: Record<string, any>;
+  items?: ModifierStockUpdate[];
+  [index: string]: any;
+}
+
+export interface ModifierStockUpdate {
+  id: string;
+  is?: Record<string, any>;
+  [index: string]: any;
+}
+
+export interface V2MenuDateDTO {
+  created?: string;
+  modified?: string;
+  published?: string;
+}
+
+export interface V2MenuLabelDTO {
+  en?: string;
+}
+
+export interface V2CategoryDTO {
+  id?: string;
+  label?: V2CategoryLabelDTO;
+  items?: V2ItemDTO[];
+  is_disabled?: boolean;
+  name?: string;
+  is?: V2CategoryIsDTO;
+  meta?: V2CategoryMetaDTO;
+}
+
+export interface V2CategoryLabelDTO {
+  fr?: string;
+  en?: string;
+}
+
+export interface V2ItemDTO {
+  id?: string;
+  label?: Record<string, any>;
+  description?: Record<string, any>;
+  price?: V2PriceDTO;
+  meal_value?: number;
+  sale_price?: Record<string, any>;
+  unit?: number;
+  ingredients?: Record<string, any>;
+  amount_off_exclusions?: string[];
+  nutrition?: V2ItemNutritionDTO;
+  certified?: V2ItemCertifiedDTO;
+  meta?: V2ItemMetaDTO;
+  options?: V2ModifierGroupDTO[];
+  required?: boolean;
+  special?: boolean;
+  category?: Record<string, any>;
+  location?: string;
+  sku?: number;
+  item_number?: number;
+  image?: V2ItemImageDTO;
+  weight?: Record<string, any>;
+  is_deleted?: boolean;
+  is?: V2ItemIsDTO;
+}
+
+export interface V2PriceDTO {
+  amount?: number;
+  currency?: string;
+}
+
+export interface V2ItemNutritionDTO {
+  kcal?: number;
+  calories?: number;
+  serving_size?: number;
+  total_fat?: number;
+  saturated_fat?: number;
+  trans_fat?: number;
+  cholesterol?: number;
+  sodium?: number;
+  total_carbohydrate?: number;
+  dietary_fiber?: number;
+  sugars?: number;
+  protein?: number;
+  well_being?: number;
+}
+
+export interface V2ItemCertifiedDTO {
+  vegan?: boolean;
+  vegetarian?: boolean;
+  seafood_watch?: boolean;
+  wellbeing?: boolean;
+  farm_to_fork?: boolean;
+  in_balance?: boolean;
+  organic?: boolean;
+  no_gluten_ingredients?: boolean;
+  halal?: boolean;
+  kosher?: boolean;
+  humane?: boolean;
+  locally_crafted?: boolean;
+  nuts?: boolean;
+  oracle_garden_grown?: boolean;
+  oracle_oyes?: boolean;
+  peanut_free?: boolean;
+  tree_nut_free?: boolean;
+  wheat_free?: boolean;
+  egg_free?: boolean;
+  soy_free?: boolean;
+  fair_trade?: boolean;
+  rainforest_alliance?: boolean;
+  salt_free?: boolean;
+}
+
+export interface V2ItemMetaDTO {
+  superplate?: V2ItemMetaSuperplateDTO;
+  featured?: V2ItemMetaFeaturedDTO;
+  taxes?: Record<string, any>;
+  sort_number?: number;
+  menu_sort_number?: V2AmountDTO;
+}
+
+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;
+}
+
+export interface V2ModifierGroupDTO {
+  id?: string;
+  label?: Record<string, any>;
+  unique_name?: string;
+  items?: V2ModifierDTO[];
+  min?: number;
+  max?: number;
+  is?: Record<string, any>;
+  meta?: {
+    [index: string]: any;
+  };
+}
+
+export interface V2ModifierDTO {
+  id?: string;
+  label?: Record<string, any>;
+  price?: Record<string, any>;
+  weight?: Record<string, any>;
+  sku?: string;
+  nutrition?: V2ModifierNutritionDTO;
+  certified?: V2CertifiedDTO;
+  modifier_sets?: V2ModifierSetsDTO;
+  meta?: V2ModifierMetaDTO;
+  is?: V2ModifierIsDTO;
+  amount_off_exclusions?: string[];
+}
+
+export interface V2ModifierNutritionDTO {
+  kcal?: number;
+  calories?: Record<string, any>;
+}
+
+export interface V2CertifiedDTO {
+  vegan?: boolean;
+}
+
+export interface V2ModifierSetsDTO {
+  category?: string;
+  list?: string[];
+}
+
+export interface V2ModifierMetaDTO {
+  sort_number?: number;
+  menu_sort_number?: Record<string, any>;
+}
+
+export interface V2ModifierIsDTO {
+  disabled?: boolean;
+  hidden?: boolean;
+  out_of_stock?: boolean;
+}
+
+export interface V2ItemImageDTO {
+  src?: string;
+}
+
+export interface V2ItemIsDTO {
+  meq_eligible?: boolean;
+  deleted?: boolean;
+  featured?: boolean;
+  disabled?: boolean;
+  hidden?: boolean;
+  out_of_stock?: boolean;
+}
+
+export interface V2CategoryIsDTO {
+  disabled?: boolean;
+  hidden?: boolean;
+  linked?: boolean;
+}
+
+export interface V2CategoryMetaDTO {
+  original_label?: Record<string, any>;
+  sort_number?: number;
+  menu_sort_number?: Record<string, any>;
+}
+
+export interface V2MenuIsDTO {
+  disabled?: boolean;
+  hidden?: boolean;
+  linked?: boolean;
+  promo_exemptions_enabled?: boolean;
+  plu_enabled?: boolean;
+  item_images_enabled?: boolean;
+  item_showcase_enabled?: boolean;
+  item_desc_edit_enabled?: boolean;
+  calories_edit_enabled?: boolean;
+  item_label_edit_enabled?: boolean;
+}
+
+export interface V2MetaDTO {
+  locked_by_user?: string;
+  last_modified_user?: string;
+  version?: number;
+}
+
 export interface PublishedCategoryPublishedCategoryDTO {
   parent_id?: FilterFieldDTO;
   name?: FilterFieldDTO;
@@ -1284,6 +1563,7 @@ export interface DraftItemEntityDTO {
   line_route?: string;
   posid_segment?: string;
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1311,6 +1591,7 @@ export interface PublishedItemPublishedItemDTO {
   brand_id?: FilterFieldDTO;
   line_route?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
+  is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1381,7 +1662,9 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
   is_active?: FilterFieldDTO;
   limit?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  type?: FilterFieldDTO;
+  order_type?: FilterFieldDTO;
+  sizing?: FilterFieldDTO;
+  is_out_of_stock?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -1459,8 +1742,13 @@ export interface DraftModifierEntityDTO {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   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;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -1484,7 +1772,12 @@ export interface PublishedModifierPublishedModifierDTO {
   posid?: FilterFieldDTO;
   posid_segment?: FilterFieldDTO;
   brand_id?: FilterFieldDTO;
-  sizing?: FilterFieldDTO[];
+  is_out_of_stock?: FilterFieldDTO;
+  price_for_none?: FilterFieldDTO;
+  price_for_less?: FilterFieldDTO;
+  price_for_more?: FilterFieldDTO;
+  pre_surcharge?: FilterFieldDTO;
+  post_surcharge?: FilterFieldDTO;
   id?: FilterFieldDTO;
   version?: FilterFieldDTO;
   created_at?: FilterFieldDTO;
@@ -3882,6 +4175,35 @@ export interface GetMenuV3MenuCategoriesRequest
     RequestQuery<GetMenuV3MenuCategoriesQuery>,
     GetMenuV3MenuCategoriesPath {}
 
+// PATCH /menu/v3/{id}/stock
+
+export interface PatchMenuV3StockPath {
+  id: string;
+}
+
+export interface PatchMenuV3StockBody {
+  id: string;
+  groups?: GroupStockUpdate[];
+  [index: string]: any;
+}
+
+export interface PatchMenuV3StockResponse {
+  id?: string;
+  date?: V2MenuDateDTO;
+  label?: V2MenuLabelDTO;
+  groups?: V2CategoryDTO[];
+  parent_id?: string;
+  location_brand?: string;
+  company?: string;
+  sector?: string;
+  is?: V2MenuIsDTO;
+  meta?: V2MetaDTO;
+}
+
+export interface PatchMenuV3StockRequest extends BaseRequest, PatchMenuV3StockPath {
+  body: PatchMenuV3StockBody;
+}
+
 // POST /menu/v3/draft/category
 
 export interface PostMenuV3DraftCategoryBody {
@@ -4381,6 +4703,7 @@ export interface PostMenuV3DraftItemBody {
   line_route?: string;
   posid_segment?: string;
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -4448,6 +4771,7 @@ export interface PatchMenuV3DraftItemBody {
   line_route?: string;
   posid_segment?: string;
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -4531,6 +4855,7 @@ export type PostMenuV3DraftItemsBody = {
   line_route?: string;
   posid_segment?: string;
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -4618,6 +4943,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
   line_route?: string;
   posid_segment?: string;
   menu_works?: MenuWorksDTO;
+  is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   categories?: DraftCategoryToItemRelationshipDTO[];
@@ -5061,7 +5387,9 @@ export interface PostMenuV3DraftModifierGroupBody {
   is_active?: boolean;
   limit?: number;
   brand_id: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5119,7 +5447,9 @@ export interface PatchMenuV3DraftModifierGroupBody {
   is_active?: boolean;
   limit?: number;
   brand_id?: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5197,7 +5527,9 @@ export type PostMenuV3DraftModifierGroupsBody = {
   is_active?: boolean;
   limit?: number;
   brand_id: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: boolean;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5260,7 +5592,9 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
   is_active?: boolean;
   limit?: number;
   brand_id: string;
-  type?: "normal" | "limit_enabled" | "sizing_enabled";
+  order_type?: "selection" | "option" | "quantity";
+  sizing?: string;
+  is_out_of_stock?: boolean;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5632,8 +5966,13 @@ export interface PostMenuV3DraftModifierBody {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   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;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5696,8 +6035,13 @@ export interface PatchMenuV3DraftModifierBody {
   reporting?: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
   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;
   applied_diff_snapshot?: Record<string, any>;
   version?: number;
   brand?: DraftBrandDTO;
@@ -5778,8 +6122,13 @@ export type PostMenuV3DraftModifiersBody = {
   reporting: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id: string;
-  sizing?: Record<string, any>[];
   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;
   id?: Record<string, any>;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
@@ -5841,8 +6190,13 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
   reporting?: ReportingMetadataDTO;
   posid_segment?: string;
   brand_id?: string;
-  sizing?: Record<string, any>[];
   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;
   applied_diff_snapshot?: Record<string, any>;
   brand?: DraftBrandDTO;
   changes?: ModifierChangeDTO[];
@@ -6068,3 +6422,27 @@ export interface GetMenuV3GlobalDiffsCountResponse {
 export interface GetMenuV3GlobalDiffsCountRequest
   extends BaseRequest,
     RequestQuery<GetMenuV3GlobalDiffsCountQuery> {}
+
+// GET menu/v3/menuworks
+
+export interface GetMenuV3MenuworksQuery {
+  unit_id?: string;
+  MRN?: string;
+  // Graphql query string
+  _query?: string;
+}
+
+export interface GetMenuV3MenuworksResponse {
+  MRN?: string;
+  unit_id?: string;
+  portion_quantity?: number;
+  portion_unit_name?: string;
+  grams?: number;
+  cost?: number;
+  calories?: number;
+  [index: string]: any;
+}
+
+export interface GetMenuV3MenuworksRequest
+  extends BaseRequest,
+    RequestQuery<GetMenuV3MenuworksQuery> {}

package/src/interface/task.ts

@@ -163,7 +163,7 @@ export type TaskStatus =
   | "delivered"
   | "order_is_ready";
 
-// POST /task/ - Create new Task
+// POST /task - Create new Task
 
 export type PostTaskBody = TaskCreate;