@compassdigital/sdk.typescript 3.75.0 → 3.77.0

package/lib/interface/menu.d.ts

@@ -340,6 +340,11 @@ export interface NotFoundErrorDTO {
     message: string;
     [index: string]: any;
 }
+export interface VersionMismatchErrorDTO {
+    number: number;
+    message: string;
+    [index: string]: any;
+}
 export interface FilterFieldDTO {
     $equals?: string;
     $more_than?: string;
@@ -601,7 +606,7 @@ export interface FileAttachmentsDTO {
     [index: string]: any;
 }
 export interface WeightDTO {
-    unit?: string;
+    unit?: FilterFieldDTO;
     amount?: FilterFieldDTO;
     id?: any;
     [index: string]: any;
@@ -623,6 +628,7 @@ export interface DraftModifierDTO {
     posid?: FilterFieldDTO;
     reporting?: any;
     brand_id?: string;
+    applied_diff_snapshot?: FilterFieldDTO;
     brand?: any;
     changes?: ModifierChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -639,6 +645,7 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
     modifier_group_id?: string;
     brand_id?: FilterFieldDTO;
     sequence?: number;
+    applied_diff_snapshot?: FilterFieldDTO;
     modifier?: any;
     modifier_group?: DraftModifierGroupDTO;
     brand?: any;
@@ -660,6 +667,7 @@ export interface DraftModifierGroupDTO {
     max?: number;
     is_active?: boolean;
     brand_id?: string;
+    applied_diff_snapshot?: FilterFieldDTO;
     brand?: any;
     changes?: ModifierGroupChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -675,6 +683,7 @@ export interface DraftItemToModifierGroupRelationshipDTO {
     item_id?: string;
     brand_id?: FilterFieldDTO;
     sequence?: number;
+    applied_diff_snapshot?: FilterFieldDTO;
     item?: DraftItemDTO;
     modifier_group?: any;
     brand?: any;
@@ -702,6 +711,7 @@ export interface DraftItemDTO {
     tax_tags?: FilterFieldDTO[];
     brand_id?: string;
     line_route?: FilterFieldDTO;
+    applied_diff_snapshot?: FilterFieldDTO;
     brand?: any;
     categories?: DraftCategoryToItemRelationshipDTO[];
     changes?: ItemChangeDTO[];
@@ -720,6 +730,7 @@ export interface DraftCategoryToItemRelationshipDTO {
     category_id?: string;
     brand_id?: FilterFieldDTO;
     sequence?: number;
+    applied_diff_snapshot?: FilterFieldDTO;
     category?: DraftCategoryDTO;
     item?: any;
     brand?: any;
@@ -739,6 +750,7 @@ export interface DraftCategoryDTO {
     is_active?: boolean;
     brand_id?: string;
     menu_id?: string;
+    applied_diff_snapshot?: FilterFieldDTO;
     menu?: DraftMenuDTO;
     items?: any[];
     brand?: any;
@@ -755,6 +767,7 @@ export interface DraftMenuDTO {
     parent_id?: string;
     name?: string;
     brand_id?: string;
+    applied_diff_snapshot?: FilterFieldDTO;
     brand?: any;
     changes?: MenuChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -843,6 +856,7 @@ export interface BrandStatusDTO {
     [index: string]: any;
 }
 export interface DraftMenuDraftMenuDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
     brand_id?: FilterFieldDTO;
@@ -861,6 +875,7 @@ export interface DraftMenuDraftMenuDTO {
     [index: string]: any;
 }
 export interface DraftModifierDraftModifierDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
     label?: FilterFieldDTO;
@@ -889,6 +904,7 @@ export interface DraftModifierDraftModifierDTO {
     [index: string]: any;
 }
 export interface DraftModifierGroupDraftModifierGroupDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
     label?: FilterFieldDTO;
@@ -912,6 +928,7 @@ export interface DraftModifierGroupDraftModifierGroupDTO {
     [index: string]: any;
 }
 export interface DraftItemDraftItemDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
     label?: FilterFieldDTO;
@@ -961,6 +978,7 @@ export interface GlobalDiffGlobalDiffDTO {
     entity_type?: FilterFieldDTO;
     local_id?: FilterFieldDTO;
     changes?: FilterFieldDTO;
+    local_changes?: FilterFieldDTO;
     local_snapshot?: FilterFieldDTO;
     global_id?: FilterFieldDTO;
     global_snapshot?: FilterFieldDTO;
@@ -987,6 +1005,7 @@ export interface DiffDTO {
     entity_type?: string;
     local_id?: string;
     changes?: any;
+    local_changes?: any;
     local_snapshot?: any;
     global_id?: string;
     global_snapshot?: any;
@@ -998,6 +1017,11 @@ export interface DiffDTO {
     permissions?: any;
     [index: string]: any;
 }
+export interface ApplyDiffDTO {
+    overwrite?: boolean;
+    id: string;
+    [index: string]: any;
+}
 export interface PublishedBrandPublishedBrandDTO {
     name?: FilterFieldDTO;
     description?: FilterFieldDTO;
@@ -1029,6 +1053,7 @@ export interface PublishedBrandPublishedBrandDTO {
     [index: string]: any;
 }
 export interface DraftCategoryDraftCategoryDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
     label?: FilterFieldDTO;
@@ -1089,6 +1114,7 @@ export interface PublishedCategoryPublishedCategoryDTO {
     [index: string]: any;
 }
 export interface DraftCategoryToItemRelationshipDraftCategoryToItemRelationshipDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     deleted_at?: FilterFieldDTO;
     item_id?: FilterFieldDTO;
@@ -1128,6 +1154,39 @@ export interface PublishedCategoryToItemRelationshipPublishedCategoryToItemRelat
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
+export interface DraftItemEntityDTO {
+    parent?: DraftItemDTO;
+    children?: DraftItemDTO[];
+    posid_segment?: POSIDSegmentDTO;
+    modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
+    id?: string;
+    created_at?: string;
+    updated_at?: string;
+    deleted_at?: string;
+    parent_id?: string;
+    name: string;
+    label?: string;
+    description?: string;
+    reporting: ReportingMetadataDTO;
+    price: number;
+    barcode?: string;
+    calories?: number;
+    is_active?: boolean;
+    posid?: string;
+    tax_tags?: any[];
+    brand_id: string;
+    line_route?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
+    brand?: DraftBrandDTO;
+    categories?: DraftCategoryToItemRelationshipDTO[];
+    changes?: ItemChangeDTO[];
+    vendor_metadata?: VendorMetadataDTO[];
+    attachments?: FileAttachmentsDTO;
+    weight?: WeightDTO;
+    permissions?: any;
+    [index: string]: any;
+}
 export interface PublishedItemPublishedItemDTO {
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
@@ -1159,6 +1218,7 @@ export interface PublishedItemPublishedItemDTO {
     [index: string]: any;
 }
 export interface DraftItemToModifierGroupRelationshipDraftItemToModifierGroupRelationshipDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     deleted_at?: FilterFieldDTO;
     modifier_group_id?: FilterFieldDTO;
@@ -1220,6 +1280,7 @@ export interface PublishedModifierGroupPublishedModifierGroupDTO {
     [index: string]: any;
 }
 export interface DraftModifierGroupToModifierRelationshipDraftModifierGroupToModifierRelationshipDTO {
+    applied_diff_snapshot?: FilterFieldDTO;
     parent_id?: FilterFieldDTO;
     deleted_at?: FilterFieldDTO;
     modifier_id?: FilterFieldDTO;
@@ -1259,6 +1320,35 @@ export interface PublishedModifierGroupToModifierRelationshipPublishedModifierGr
     permissions?: FilterFieldDTO;
     [index: string]: any;
 }
+export interface DraftModifierEntityDTO {
+    parent?: DraftModifierDTO;
+    children?: DraftModifierDTO[];
+    posid_segment?: POSIDSegmentDTO;
+    modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
+    id?: string;
+    created_at?: string;
+    updated_at?: string;
+    deleted_at?: string;
+    parent_id?: string;
+    name: string;
+    label?: string;
+    description?: string;
+    price: number;
+    calories?: number;
+    tax_tags?: any[];
+    is_active?: boolean;
+    posid?: string;
+    reporting: ReportingMetadataDTO;
+    brand_id: string;
+    applied_diff_snapshot?: any;
+    version?: number;
+    brand?: DraftBrandDTO;
+    changes?: ModifierChangeDTO[];
+    vendor_metadata?: VendorMetadataDTO[];
+    weight?: WeightDTO;
+    permissions?: any;
+    [index: string]: any;
+}
 export interface PublishedModifierPublishedModifierDTO {
     parent_id?: FilterFieldDTO;
     name?: FilterFieldDTO;
@@ -1294,6 +1384,7 @@ export interface GlobalDiffDTO {
     entity_type?: string;
     local_id?: string;
     changes?: any;
+    local_changes?: any;
     local_snapshot?: any;
     global_id?: string;
     global_snapshot?: any;
@@ -1627,6 +1718,7 @@ export interface PatchMenuV3LocalMenuGroupBody {
     draft_brands?: DraftBrandDTO[];
     published_brands?: PublishedBrandDTO[];
     id?: string;
+    version?: number;
     vendor_metadata?: VendorMetadataDTO[];
     permissions?: any;
     [index: string]: any;
@@ -1837,6 +1929,7 @@ export interface PatchMenuV3GlobalMenuGroupBody {
     published_brands?: PublishedBrandDTO[];
     posid_segment?: POSIDSegmentDTO;
     id?: string;
+    version?: number;
     vendor_metadata?: VendorMetadataDTO[];
     permissions?: any;
     [index: string]: any;
@@ -2027,6 +2120,7 @@ export interface PatchMenuV3DraftBrandBody {
     parent_id?: string;
     local_menu_group_id?: string;
     global_menu_group_id?: string;
+    version?: number;
     changes?: BrandChangeDTO[];
     local_menu_group?: LocalMenuGroupDTO;
     global_menu_group?: GlobalMenuGroupDTO;
@@ -2257,7 +2351,7 @@ export interface PostMenuV3DraftBrandGlobalDiffsApplyPath {
     id: string;
 }
 export interface PostMenuV3DraftBrandGlobalDiffsApplyQuery {
-    "body.diff_ids"?: any[];
+    "body.diffs"?: ApplyDiffDTO[];
 }
 export interface PostMenuV3DraftBrandGlobalDiffsApplyResponse {
     status?: string;
@@ -2347,6 +2441,7 @@ export interface PatchMenuV3BrandBody {
     parent_id?: string;
     local_menu_group_id?: string;
     global_menu_group_id?: string;
+    version?: number;
     local_menu_group?: LocalMenuGroupDTO;
     global_menu_group?: GlobalMenuGroupDTO;
     attachments?: FileAttachmentsDTO;
@@ -2570,6 +2665,7 @@ export interface PostMenuV3DraftMenuBody {
     name: string;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: MenuChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -2602,6 +2698,8 @@ export interface PatchMenuV3DraftMenuBody {
     parent_id?: string;
     name?: string;
     brand_id?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
     brand?: DraftBrandDTO;
     changes?: MenuChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -2644,6 +2742,7 @@ export type PostMenuV3DraftMenusBody = {
     name: string;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: MenuChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -2772,6 +2871,7 @@ export interface PostMenuV3DraftCategoryBody {
     brand_id: string;
     menu_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     menu?: DraftMenuDTO;
     items?: DraftCategoryToItemRelationshipDTO[];
     brand?: DraftBrandDTO;
@@ -2809,6 +2909,8 @@ export interface PatchMenuV3DraftCategoryBody {
     is_active?: boolean;
     brand_id?: string;
     menu_id?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
     menu?: DraftMenuDTO;
     items?: DraftCategoryToItemRelationshipDTO[];
     brand?: DraftBrandDTO;
@@ -2848,6 +2950,7 @@ export type PostMenuV3DraftCategoriesBody = {
     brand_id: string;
     menu_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     menu?: DraftMenuDTO;
     items?: DraftCategoryToItemRelationshipDTO[];
     brand?: DraftBrandDTO;
@@ -2893,9 +2996,10 @@ export interface PostMenuV3DraftCategoryRelationshipsItemBody {
     parent_id?: string;
     item_id: string;
     category_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     category?: DraftCategoryDTO;
     item?: DraftItemDTO;
     brand?: DraftBrandDTO;
@@ -2931,6 +3035,8 @@ export interface PatchMenuV3DraftCategoryRelationshipsItemBody {
     category_id?: string;
     brand_id?: string;
     sequence?: number;
+    applied_diff_snapshot?: any;
+    version?: number;
     category?: DraftCategoryDTO;
     item?: DraftItemDTO;
     brand?: DraftBrandDTO;
@@ -2973,9 +3079,10 @@ export type PostMenuV3DraftCategoryRelationshipsItemsBody = {
     parent_id?: string;
     item_id: string;
     category_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     category?: DraftCategoryDTO;
     item?: DraftItemDTO;
     brand?: DraftBrandDTO;
@@ -3063,6 +3170,7 @@ export interface PostMenuV3DraftItemBody {
     brand_id: string;
     line_route?: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
     changes?: ItemChangeDTO[];
@@ -3109,6 +3217,8 @@ export interface PatchMenuV3DraftItemBody {
     tax_tags?: any[];
     brand_id?: string;
     line_route?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
     changes?: ItemChangeDTO[];
@@ -3165,6 +3275,7 @@ export type PostMenuV3DraftItemsBody = {
     brand_id: string;
     line_route?: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
     changes?: ItemChangeDTO[];
@@ -3212,6 +3323,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
     tax_tags?: any[];
     brand_id?: string;
     line_route?: string;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     categories?: DraftCategoryToItemRelationshipDTO[];
     changes?: ItemChangeDTO[];
@@ -3222,8 +3334,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
     [index: string]: any;
 }
 export interface PatchMenuV3DraftItemsBulkUpdateResponse {
-    results: any[];
-    [index: string]: any;
+    results?: DraftItemEntityDTO[];
 }
 export interface PatchMenuV3DraftItemsBulkUpdateRequest extends BaseRequest {
     body: PatchMenuV3DraftItemsBulkUpdateBody;
@@ -3245,8 +3356,7 @@ export interface PostMenuV3ItemsImportQuery {
     "body.data"?: string;
 }
 export interface PostMenuV3ItemsImportResponse {
-    results: any[];
-    [index: string]: any;
+    results?: DraftItemEntityDTO[];
 }
 export interface PostMenuV3ItemsImportRequest extends BaseRequest, RequestQuery<PostMenuV3ItemsImportQuery> {
 }
@@ -3298,9 +3408,10 @@ export interface PostMenuV3DraftItemRelationshipsModifierGroupBody {
     parent_id?: string;
     modifier_group_id: string;
     item_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     item?: DraftItemDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3336,6 +3447,8 @@ export interface PatchMenuV3DraftItemRelationshipsModifierGroupBody {
     item_id?: string;
     brand_id?: string;
     sequence?: number;
+    applied_diff_snapshot?: any;
+    version?: number;
     item?: DraftItemDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3378,9 +3491,10 @@ export type PostMenuV3DraftItemRelationshipsModifierGroupsBody = {
     parent_id?: string;
     modifier_group_id: string;
     item_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     item?: DraftItemDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3462,6 +3576,7 @@ export interface PostMenuV3DraftModifierGroupBody {
     is_active?: boolean;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: ModifierGroupChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3499,6 +3614,8 @@ export interface PatchMenuV3DraftModifierGroupBody {
     max?: number;
     is_active?: boolean;
     brand_id?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
     brand?: DraftBrandDTO;
     changes?: ModifierGroupChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3546,6 +3663,7 @@ export type PostMenuV3DraftModifierGroupsBody = {
     is_active?: boolean;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: ModifierGroupChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3618,9 +3736,10 @@ export interface PostMenuV3DraftModifierGroupRelationshipsModifierBody {
     parent_id?: string;
     modifier_id: string;
     modifier_group_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     modifier?: DraftModifierDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3656,6 +3775,8 @@ export interface PatchMenuV3DraftModifierGroupRelationshipsModifierBody {
     modifier_group_id?: string;
     brand_id?: string;
     sequence?: number;
+    applied_diff_snapshot?: any;
+    version?: number;
     modifier?: DraftModifierDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3698,9 +3819,10 @@ export type PostMenuV3DraftModifierGroupRelationshipsModifiersBody = {
     parent_id?: string;
     modifier_id: string;
     modifier_group_id: string;
-    brand_id?: string;
+    brand_id: string;
     sequence?: number;
     id?: any;
+    applied_diff_snapshot?: any;
     modifier?: DraftModifierDTO;
     modifier_group?: DraftModifierGroupDTO;
     brand?: DraftBrandDTO;
@@ -3786,6 +3908,7 @@ export interface PostMenuV3DraftModifierBody {
     reporting: ReportingMetadataDTO;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3828,6 +3951,8 @@ export interface PatchMenuV3DraftModifierBody {
     posid?: string;
     reporting?: ReportingMetadataDTO;
     brand_id?: string;
+    applied_diff_snapshot?: any;
+    version?: number;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3880,6 +4005,7 @@ export type PostMenuV3DraftModifiersBody = {
     reporting: ReportingMetadataDTO;
     brand_id: string;
     id?: any;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3923,6 +4049,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
     posid?: string;
     reporting?: ReportingMetadataDTO;
     brand_id?: string;
+    applied_diff_snapshot?: any;
     brand?: DraftBrandDTO;
     changes?: ModifierChangeDTO[];
     vendor_metadata?: VendorMetadataDTO[];
@@ -3931,8 +4058,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
     [index: string]: any;
 }
 export interface PatchMenuV3DraftModifiersBulkUpdateResponse {
-    results: any[];
-    [index: string]: any;
+    results?: DraftModifierEntityDTO[];
 }
 export interface PatchMenuV3DraftModifiersBulkUpdateRequest extends BaseRequest {
     body: PatchMenuV3DraftModifiersBulkUpdateBody;
@@ -4005,6 +4131,7 @@ export interface GetMenuV3GlobalDiffResponse {
     entity_type?: string;
     local_id?: string;
     changes?: any;
+    local_changes?: any;
     local_snapshot?: any;
     global_id?: string;
     global_snapshot?: any;