@compassdigital/sdk.typescript 4.22.1 → 4.23.1

package/lib/interface/menu.d.ts

@@ -116,6 +116,7 @@ export interface Item {
         };
         sort_number?: number;
         menu_sort_number?: number;
+        barcodes?: string[];
         [index: string]: any;
     };
     category?: {
@@ -512,6 +513,8 @@ export interface DraftItemDTO {
     brand_id?: string;
     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>[];
@@ -554,6 +557,8 @@ export interface DraftModifierGroupDTO {
     is_active?: boolean;
     limit?: number;
     brand_id?: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: FilterFieldDTO;
     applied_diff_snapshot?: FilterFieldDTO;
     brand?: Record<string, any>;
     changes?: ModifierGroupChangeDTO[];
@@ -597,6 +602,8 @@ export interface DraftModifierDTO {
     posid_segment?: FilterFieldDTO;
     brand_id?: string;
     sizing?: FilterFieldDTO[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: FilterFieldDTO;
     applied_diff_snapshot?: FilterFieldDTO;
     brand?: Record<string, any>;
     changes?: ModifierChangeDTO[];
@@ -637,6 +644,17 @@ export interface FileAttachmentsDTO {
     id?: Record<string, any>;
     [index: string]: any;
 }
+export interface MenuWorksDTO {
+    MRN?: FilterFieldDTO;
+    unit_id?: FilterFieldDTO;
+    portion_quantity?: number;
+    portion_unit_name?: FilterFieldDTO;
+    grams?: number;
+    cost?: number;
+    calories?: number;
+    id?: Record<string, any>;
+    [index: string]: any;
+}
 export interface ModifierGroupToModifierRelationshipChangeDTO {
     id?: string;
     insert?: FilterFieldDTO;
@@ -744,6 +762,7 @@ export interface DraftModifierDraftModifierDTO {
     posid_segment?: FilterFieldDTO;
     brand_id?: FilterFieldDTO;
     sizing?: FilterFieldDTO[];
+    is_out_of_stock?: FilterFieldDTO;
     id?: FilterFieldDTO;
     version?: FilterFieldDTO;
     created_at?: FilterFieldDTO;
@@ -758,6 +777,7 @@ export interface DraftModifierDraftModifierDTO {
     reporting?: ReportingMetadataDTO;
     weight?: WeightDTO;
     attachments?: FileAttachmentsDTO;
+    menu_works?: MenuWorksDTO;
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
@@ -771,6 +791,8 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
     is_active?: FilterFieldDTO;
     limit?: FilterFieldDTO;
     brand_id?: FilterFieldDTO;
+    order_type?: FilterFieldDTO;
+    is_out_of_stock?: FilterFieldDTO;
     id?: FilterFieldDTO;
     version?: FilterFieldDTO;
     created_at?: FilterFieldDTO;
@@ -802,6 +824,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;
@@ -817,6 +840,7 @@ export interface DraftItemDraftItemDTO {
     reporting?: ReportingMetadataDTO;
     attachments?: FileAttachmentsDTO;
     weight?: WeightDTO;
+    menu_works?: MenuWorksDTO;
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
@@ -930,6 +954,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;
 }
@@ -953,6 +978,8 @@ export interface PublishedModifierGroupDTO {
     is_active?: boolean;
     limit?: number;
     brand_id?: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: boolean;
     permissions?: Record<string, any>;
     [index: string]: any;
 }
@@ -980,6 +1007,7 @@ export interface PublishedModifierDTO {
     posid_segment?: string;
     brand_id?: string;
     sizing?: Record<string, any>[];
+    is_out_of_stock?: boolean;
     permissions?: Record<string, any>;
     [index: string]: any;
 }
@@ -1056,6 +1084,227 @@ export interface PublishedMenuPublishedMenuDTO {
     permissions?: FilterFieldDTO;
     [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;
@@ -1147,6 +1396,8 @@ export interface DraftItemEntityDTO {
     brand_id: string;
     line_route?: string;
     posid_segment?: string;
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -1173,6 +1424,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;
@@ -1186,6 +1438,7 @@ export interface PublishedItemPublishedItemDTO {
     reporting?: ReportingMetadataDTO;
     attachments?: FileAttachmentsDTO;
     weight?: WeightDTO;
+    menu_works?: MenuWorksDTO;
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
@@ -1239,6 +1492,8 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
     is_active?: FilterFieldDTO;
     limit?: FilterFieldDTO;
     brand_id?: FilterFieldDTO;
+    order_type?: FilterFieldDTO;
+    is_out_of_stock?: FilterFieldDTO;
     id?: FilterFieldDTO;
     version?: FilterFieldDTO;
     created_at?: FilterFieldDTO;
@@ -1314,6 +1569,8 @@ export interface DraftModifierEntityDTO {
     posid_segment?: string;
     brand_id: string;
     sizing?: Record<string, any>[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -1337,6 +1594,7 @@ export interface PublishedModifierPublishedModifierDTO {
     posid_segment?: FilterFieldDTO;
     brand_id?: FilterFieldDTO;
     sizing?: FilterFieldDTO[];
+    is_out_of_stock?: FilterFieldDTO;
     id?: FilterFieldDTO;
     version?: FilterFieldDTO;
     created_at?: FilterFieldDTO;
@@ -1349,6 +1607,7 @@ export interface PublishedModifierPublishedModifierDTO {
     reporting?: ReportingMetadataDTO;
     weight?: WeightDTO;
     attachments?: FileAttachmentsDTO;
+    menu_works?: MenuWorksDTO;
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
@@ -2860,6 +3119,29 @@ export interface GetMenuV3MenuCategoriesResponse {
 }
 export interface GetMenuV3MenuCategoriesRequest extends BaseRequest, RequestQuery<GetMenuV3MenuCategoriesQuery>, GetMenuV3MenuCategoriesPath {
 }
+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;
+}
 export interface PostMenuV3DraftCategoryBody {
     parent?: DraftCategoryDTO;
     children?: DraftCategoryDTO[];
@@ -3200,6 +3482,8 @@ export interface PostMenuV3DraftItemBody {
     brand_id: string;
     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;
@@ -3249,6 +3533,8 @@ export interface PatchMenuV3DraftItemBody {
     brand_id?: string;
     line_route?: string;
     posid_segment?: string;
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -3309,6 +3595,8 @@ export type PostMenuV3DraftItemsBody = {
     brand_id: string;
     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;
@@ -3373,6 +3661,8 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
     brand_id?: string;
     line_route?: string;
     posid_segment?: string;
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
@@ -3665,6 +3955,8 @@ export interface PostMenuV3DraftModifierGroupBody {
     is_active?: boolean;
     limit?: number;
     brand_id: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: boolean;
     id?: Record<string, any>;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
@@ -3705,6 +3997,8 @@ export interface PatchMenuV3DraftModifierGroupBody {
     is_active?: boolean;
     limit?: number;
     brand_id?: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -3756,6 +4050,8 @@ export type PostMenuV3DraftModifierGroupsBody = {
     is_active?: boolean;
     limit?: number;
     brand_id: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: boolean;
     id?: Record<string, any>;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
@@ -3804,6 +4100,8 @@ export interface PostMenuV3DraftModifierGroupDuplicateResponse {
     is_active?: boolean;
     limit?: number;
     brand_id: string;
+    order_type?: "selection" | "option" | "quantity";
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -4046,6 +4344,8 @@ export interface PostMenuV3DraftModifierBody {
     posid_segment?: string;
     brand_id: string;
     sizing?: Record<string, any>[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     id?: Record<string, any>;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
@@ -4092,6 +4392,8 @@ export interface PatchMenuV3DraftModifierBody {
     posid_segment?: string;
     brand_id?: string;
     sizing?: Record<string, any>[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     version?: number;
     brand?: DraftBrandDTO;
@@ -4149,6 +4451,8 @@ export type PostMenuV3DraftModifiersBody = {
     posid_segment?: string;
     brand_id: string;
     sizing?: Record<string, any>[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     id?: Record<string, any>;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
@@ -4198,6 +4502,8 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
     posid_segment?: string;
     brand_id?: string;
     sizing?: Record<string, any>[];
+    menu_works?: MenuWorksDTO;
+    is_out_of_stock?: boolean;
     applied_diff_snapshot?: Record<string, any>;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
@@ -4343,4 +4649,21 @@ export interface GetMenuV3GlobalDiffsCountResponse {
 }
 export interface GetMenuV3GlobalDiffsCountRequest extends BaseRequest, RequestQuery<GetMenuV3GlobalDiffsCountQuery> {
 }
+export interface GetMenuV3MenuworksQuery {
+    unit_id?: string;
+    MRN?: 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> {
+}
 //# sourceMappingURL=menu.d.ts.map