@compassdigital/sdk.typescript 4.97.0 → 4.99.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,7 +4,6 @@
4
4
  import { RequestQuery, BaseRequest } from './util';
5
5
 
6
6
  export interface Menu {
7
- // menu
8
7
  id?: string;
9
8
  date?: {
10
9
  created?: string;
@@ -15,13 +14,9 @@ export interface Menu {
15
14
  en?: string;
16
15
  };
17
16
  groups?: Group[];
18
- // menu
19
17
  parent_id?: string;
20
- // brand
21
18
  location_brand?: string;
22
- // company
23
19
  company?: string;
24
- // sector
25
20
  sector?: string;
26
21
  is?: {
27
22
  disabled?: boolean;
@@ -64,7 +59,6 @@ export interface Nutrition {
64
59
  }
65
60
 
66
61
  export interface Item {
67
- // item
68
62
  id?: string;
69
63
  label?: {
70
64
  en?: string;
@@ -214,7 +208,6 @@ export interface Item {
214
208
  }
215
209
 
216
210
  export interface Group {
217
- // group
218
211
  id?: string;
219
212
  name?: string;
220
213
  label?: {
@@ -246,7 +239,6 @@ export interface Group {
246
239
  }
247
240
 
248
241
  export interface Option {
249
- // option
250
242
  id?: string;
251
243
  label?: {
252
244
  en?: string;
@@ -336,7 +328,6 @@ export interface Option {
336
328
  }
337
329
 
338
330
  export interface OptionsGroup {
339
- // modifier_group
340
331
  id?: string;
341
332
  label?: {
342
333
  en?: string;
@@ -386,7 +377,6 @@ export interface CreateOptionsGroup {
386
377
  out_of_stock?: boolean;
387
378
  };
388
379
  meta?: Record<string, any>;
389
- // company
390
380
  company: string;
391
381
  }
392
382
 
@@ -415,7 +405,6 @@ export interface Items {
415
405
  }
416
406
 
417
407
  export interface PatchMenu {
418
- // menu
419
408
  id?: string;
420
409
  meta?: {
421
410
  // User ID
@@ -434,6 +423,7 @@ export interface GlobalMenuGroupDTO {
434
423
  name?: string;
435
424
  is_active?: boolean;
436
425
  posid_segment?: string;
426
+ auto_push_to_local?: boolean;
437
427
  id?: string;
438
428
  permissions?: Record<string, any>;
439
429
  [index: string]: any;
@@ -1447,11 +1437,6 @@ export interface V2MetaDTO {
1447
1437
  version?: number;
1448
1438
  }
1449
1439
 
1450
- export interface LineRouteSuggestion {
1451
- line_route?: string;
1452
- occurrences?: number;
1453
- }
1454
-
1455
1440
  export interface DraftItemEntityDTO {
1456
1441
  is_published?: boolean;
1457
1442
  parent?: DraftItemDTO;
@@ -1497,6 +1482,11 @@ export interface DraftItemEntityDTO {
1497
1482
  [index: string]: any;
1498
1483
  }
1499
1484
 
1485
+ export interface LineRouteSuggestion {
1486
+ line_route?: string;
1487
+ occurrences?: number;
1488
+ }
1489
+
1500
1490
  export interface DraftModifierEntityDTO {
1501
1491
  parent?: DraftModifierDTO;
1502
1492
  children?: DraftModifierDTO[];
@@ -2607,6 +2597,7 @@ export interface PostMenuV3GlobalMenuGroupBody {
2607
2597
  draft_brands?: DraftBrandDTO[];
2608
2598
  published_brands?: PublishedBrandDTO[];
2609
2599
  posid_segment: string;
2600
+ auto_push_to_local?: boolean;
2610
2601
  vendor_metadata?: VendorMetadataDTO[];
2611
2602
  permissions?: Record<string, any>;
2612
2603
  [index: string]: any;
@@ -2653,6 +2644,7 @@ export interface PatchMenuV3GlobalMenuGroupBody {
2653
2644
  draft_brands?: DraftBrandDTO[];
2654
2645
  published_brands?: PublishedBrandDTO[];
2655
2646
  posid_segment?: string;
2647
+ auto_push_to_local?: boolean;
2656
2648
  id?: string;
2657
2649
  version?: number;
2658
2650
  vendor_metadata?: VendorMetadataDTO[];
@@ -2686,6 +2678,7 @@ export interface DeleteMenuV3GlobalMenuGroupResponse {
2686
2678
  draft_brands?: DraftBrandDTO[];
2687
2679
  published_brands?: PublishedBrandDTO[];
2688
2680
  posid_segment: string;
2681
+ auto_push_to_local?: boolean;
2689
2682
  id: string;
2690
2683
  created_at?: string;
2691
2684
  updated_at?: string;
@@ -2741,6 +2734,7 @@ export type PostMenuV3GlobalMenuGroupsBody = {
2741
2734
  draft_brands?: DraftBrandDTO[];
2742
2735
  published_brands?: PublishedBrandDTO[];
2743
2736
  posid_segment: string;
2737
+ auto_push_to_local?: boolean;
2744
2738
  vendor_metadata?: VendorMetadataDTO[];
2745
2739
  permissions?: Record<string, any>;
2746
2740
  [index: string]: any;
@@ -4573,6 +4567,41 @@ export interface PostMenuV3DraftCategoryDuplicateRequest
4573
4567
  body: PostMenuV3DraftCategoryDuplicateBody;
4574
4568
  }
4575
4569
 
4570
+ // GET /menu/v3/draft/category/{id}/unattached_items
4571
+
4572
+ export interface GetMenuV3DraftCategoryUnattachedItemsPath {
4573
+ id: string;
4574
+ }
4575
+
4576
+ export interface GetMenuV3DraftCategoryUnattachedItemsQuery {
4577
+ filter?: string;
4578
+ // If specified, only the selected fields will be returned
4579
+ select?: string[];
4580
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
4581
+ relationships?: string[];
4582
+ // Number of records to load per page
4583
+ limit?: number;
4584
+ page?: number;
4585
+ // A field to sort the results based on
4586
+ sort_by?: string;
4587
+ sort_order?: 'DESC' | 'ASC';
4588
+ // How soft deleted records should be shown in the list
4589
+ soft_deleted?: 'include' | 'exclude' | 'only';
4590
+ // Graphql query string
4591
+ _query?: string;
4592
+ }
4593
+
4594
+ export interface GetMenuV3DraftCategoryUnattachedItemsResponse {
4595
+ results: DraftItemEntityDTO[];
4596
+ meta?: ListResponseMetadataDTO;
4597
+ [index: string]: any;
4598
+ }
4599
+
4600
+ export interface GetMenuV3DraftCategoryUnattachedItemsRequest
4601
+ extends BaseRequest,
4602
+ RequestQuery<GetMenuV3DraftCategoryUnattachedItemsQuery>,
4603
+ GetMenuV3DraftCategoryUnattachedItemsPath {}
4604
+
4576
4605
  // GET /menu/v3/category/{id}
4577
4606
 
4578
4607
  export interface GetMenuV3CategoryPath {
@@ -7192,6 +7221,54 @@ export interface GetMenuV4BrandRequest
7192
7221
  RequestQuery<GetMenuV4BrandQuery>,
7193
7222
  GetMenuV4BrandPath {}
7194
7223
 
7224
+ // DELETE /menu/v4/brand/{id}
7225
+
7226
+ export interface DeleteMenuV4BrandPath {
7227
+ id: string;
7228
+ }
7229
+
7230
+ export interface DeleteMenuV4BrandResponse {
7231
+ parent?: DraftBrandDTO;
7232
+ children?: DraftBrandDTO[];
7233
+ menus?: DraftMenuDTO[];
7234
+ categories?: DraftCategoryDTO[];
7235
+ category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
7236
+ items?: DraftItemDTO[];
7237
+ item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
7238
+ modifier_groups?: DraftModifierGroupDTO[];
7239
+ modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
7240
+ modifiers?: DraftModifierDTO[];
7241
+ statuses?: BrandStatusDTO[];
7242
+ audit_logs?: AuditDTO[];
7243
+ id: string;
7244
+ created_at?: string;
7245
+ updated_at?: string;
7246
+ deleted_at?: string;
7247
+ name: string;
7248
+ description?: string;
7249
+ is_active?: boolean;
7250
+ type?: 'global' | 'local';
7251
+ parent_id?: string;
7252
+ local_menu_group_id?: string;
7253
+ global_menu_group_id?: string;
7254
+ posid_segment?: string;
7255
+ is_simplified_view?: boolean;
7256
+ frictionless_partner?: string;
7257
+ catalog_id?: number;
7258
+ meta?: BrandMeta;
7259
+ applied_diff_snapshot?: Record<string, any>;
7260
+ version?: number;
7261
+ changes?: BrandChangeDTO[];
7262
+ local_menu_group?: LocalMenuGroupDTO;
7263
+ global_menu_group?: GlobalMenuGroupDTO;
7264
+ vendor_metadata?: VendorMetadataDTO[];
7265
+ attachments?: FileAttachmentsDTO;
7266
+ permissions?: Record<string, any>;
7267
+ [index: string]: any;
7268
+ }
7269
+
7270
+ export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
7271
+
7195
7272
  // POST /menu/v4/brand/{id}/menu
7196
7273
 
7197
7274
  export interface PostMenuV4BrandMenuPath {
@@ -7285,6 +7362,35 @@ export interface PatchMenuV4BrandMenuRequest extends BaseRequest, PatchMenuV4Bra
7285
7362
  body: PatchMenuV4BrandMenuBody;
7286
7363
  }
7287
7364
 
7365
+ // DELETE /menu/v4/brand/{brand_id}/menu/{menu_id}
7366
+
7367
+ export interface DeleteMenuV4BrandMenuPath {
7368
+ brand_id: string;
7369
+ menu_id: string;
7370
+ }
7371
+
7372
+ export interface DeleteMenuV4BrandMenuResponse {
7373
+ parent?: DraftMenuDTO;
7374
+ children?: DraftMenuDTO[];
7375
+ categories?: DraftCategoryDTO[];
7376
+ id: string;
7377
+ created_at?: string;
7378
+ updated_at?: string;
7379
+ deleted_at?: string;
7380
+ parent_id?: string;
7381
+ name: string;
7382
+ brand_id: string;
7383
+ applied_diff_snapshot?: Record<string, any>;
7384
+ version?: number;
7385
+ brand?: DraftBrandDTO;
7386
+ changes?: MenuChangeDTO[];
7387
+ vendor_metadata?: VendorMetadataDTO[];
7388
+ permissions?: Record<string, any>;
7389
+ [index: string]: any;
7390
+ }
7391
+
7392
+ export interface DeleteMenuV4BrandMenuRequest extends BaseRequest, DeleteMenuV4BrandMenuPath {}
7393
+
7288
7394
  // GET /menu/v4/brand/{id}/items
7289
7395
 
7290
7396
  export interface GetMenuV4BrandItemsPath {
@@ -7538,6 +7644,43 @@ export interface PatchMenuV4BrandCategoryRequest extends BaseRequest, PatchMenuV
7538
7644
  body: PatchMenuV4BrandCategoryBody;
7539
7645
  }
7540
7646
 
7647
+ // DELETE /menu/v4/brand/{brand_id}/category/{category_id}
7648
+
7649
+ export interface DeleteMenuV4BrandCategoryPath {
7650
+ brand_id: string;
7651
+ category_id: string;
7652
+ }
7653
+
7654
+ export interface DeleteMenuV4BrandCategoryResponse {
7655
+ parent?: DraftCategoryDTO;
7656
+ children?: DraftCategoryDTO[];
7657
+ id: string;
7658
+ created_at?: string;
7659
+ updated_at?: string;
7660
+ deleted_at?: string;
7661
+ parent_id?: string;
7662
+ name: string;
7663
+ label?: string;
7664
+ sequence?: number;
7665
+ is_active?: boolean;
7666
+ brand_id: string;
7667
+ menu_id: string;
7668
+ applied_diff_snapshot?: Record<string, any>;
7669
+ version?: number;
7670
+ menu?: DraftMenuDTO;
7671
+ items?: DraftCategoryToItemRelationshipDTO[];
7672
+ brand?: DraftBrandDTO;
7673
+ changes?: CategoryChangeDTO[];
7674
+ vendor_metadata?: VendorMetadataDTO[];
7675
+ attachments?: FileAttachmentsDTO;
7676
+ permissions?: Record<string, any>;
7677
+ [index: string]: any;
7678
+ }
7679
+
7680
+ export interface DeleteMenuV4BrandCategoryRequest
7681
+ extends BaseRequest,
7682
+ DeleteMenuV4BrandCategoryPath {}
7683
+
7541
7684
  // POST /menu/v4/brand/{id}/category/attach-items
7542
7685
 
7543
7686
  export interface PostMenuV4BrandCategoryAttachItemsPath {
@@ -7572,7 +7715,7 @@ export interface PostMenuV4BrandCategoryAttachItemsRequest
7572
7715
  body: PostMenuV4BrandCategoryAttachItemsBody;
7573
7716
  }
7574
7717
 
7575
- // POST menu/v4/brand/{id}/publish
7718
+ // POST /menu/v4/brand/{id}/publish
7576
7719
 
7577
7720
  export interface PostMenuV4BrandPublishPath {
7578
7721
  id: string;
@@ -7584,7 +7727,7 @@ export interface PostMenuV4BrandPublishResponse {
7584
7727
 
7585
7728
  export interface PostMenuV4BrandPublishRequest extends BaseRequest, PostMenuV4BrandPublishPath {}
7586
7729
 
7587
- // POST menu/v4/brand/{id}/v3-to-v4
7730
+ // POST /menu/v4/brand/{id}/v3-to-v4
7588
7731
 
7589
7732
  export interface PostMenuV4BrandV3ToV4Path {
7590
7733
  id: string;
@@ -7596,72 +7739,83 @@ export interface PostMenuV4BrandV3ToV4Response {
7596
7739
 
7597
7740
  export interface PostMenuV4BrandV3ToV4Request extends BaseRequest, PostMenuV4BrandV3ToV4Path {}
7598
7741
 
7599
- // DELETE menu/v4/brand/{id}
7742
+ // POST /menu/v4/brand/{brand_id}/category/{category_id}/duplicate
7600
7743
 
7601
- export interface DeleteMenuV4BrandPath {
7602
- id: string;
7744
+ export interface PostMenuV4BrandCategoryDuplicatePath {
7745
+ brand_id: string;
7746
+ category_id: string;
7603
7747
  }
7604
7748
 
7605
- export interface DeleteMenuV4BrandResponse {
7606
- parent?: DraftBrandDTO;
7607
- children?: DraftBrandDTO[];
7608
- menus?: DraftMenuDTO[];
7609
- categories?: DraftCategoryDTO[];
7610
- category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
7611
- items?: DraftItemDTO[];
7612
- item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
7613
- modifier_groups?: DraftModifierGroupDTO[];
7614
- modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
7615
- modifiers?: DraftModifierDTO[];
7616
- statuses?: BrandStatusDTO[];
7617
- audit_logs?: AuditDTO[];
7749
+ export interface PostMenuV4BrandCategoryDuplicateBody {
7750
+ parent?: DraftCategoryDTO;
7751
+ children?: DraftCategoryDTO[];
7752
+ id?: string;
7753
+ parent_id?: string;
7754
+ name?: string;
7755
+ label?: string;
7756
+ sequence?: number;
7757
+ is_active?: boolean;
7758
+ brand_id?: string;
7759
+ menu_id?: string;
7760
+ applied_diff_snapshot?: Record<string, any>;
7761
+ version?: number;
7762
+ menu?: DraftMenuDTO;
7763
+ items?: DraftCategoryToItemRelationshipDTO[];
7764
+ brand?: DraftBrandDTO;
7765
+ changes?: CategoryChangeDTO[];
7766
+ vendor_metadata?: VendorMetadataDTO[];
7767
+ attachments?: FileAttachmentsDTO;
7768
+ permissions?: Record<string, any>;
7769
+ [index: string]: any;
7770
+ }
7771
+
7772
+ export interface PostMenuV4BrandCategoryDuplicateResponse {
7773
+ parent?: DraftCategoryDTO;
7774
+ children?: DraftCategoryDTO[];
7618
7775
  id: string;
7619
7776
  created_at?: string;
7620
7777
  updated_at?: string;
7621
7778
  deleted_at?: string;
7779
+ parent_id?: string;
7622
7780
  name: string;
7623
- description?: string;
7781
+ label?: string;
7782
+ sequence?: number;
7624
7783
  is_active?: boolean;
7625
- type?: 'global' | 'local';
7626
- parent_id?: string;
7627
- local_menu_group_id?: string;
7628
- global_menu_group_id?: string;
7629
- posid_segment?: string;
7630
- is_simplified_view?: boolean;
7631
- frictionless_partner?: string;
7632
- catalog_id?: number;
7633
- meta?: BrandMeta;
7784
+ brand_id: string;
7785
+ menu_id: string;
7634
7786
  applied_diff_snapshot?: Record<string, any>;
7635
7787
  version?: number;
7636
- changes?: BrandChangeDTO[];
7637
- local_menu_group?: LocalMenuGroupDTO;
7638
- global_menu_group?: GlobalMenuGroupDTO;
7788
+ menu?: DraftMenuDTO;
7789
+ items?: DraftCategoryToItemRelationshipDTO[];
7790
+ brand?: DraftBrandDTO;
7791
+ changes?: CategoryChangeDTO[];
7639
7792
  vendor_metadata?: VendorMetadataDTO[];
7640
7793
  attachments?: FileAttachmentsDTO;
7641
7794
  permissions?: Record<string, any>;
7642
7795
  [index: string]: any;
7643
7796
  }
7644
7797
 
7645
- export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
7798
+ export interface PostMenuV4BrandCategoryDuplicateRequest
7799
+ extends BaseRequest,
7800
+ PostMenuV4BrandCategoryDuplicatePath {
7801
+ body: PostMenuV4BrandCategoryDuplicateBody;
7802
+ }
7646
7803
 
7647
- // DELETE menu/v4/brand/{brand_id}/menu/{menu_id}
7804
+ // POST /menu/v4/brand/{brand_id}/menu/{menu_id}/duplicate
7648
7805
 
7649
- export interface DeleteMenuV4BrandMenuPath {
7806
+ export interface PostMenuV4BrandMenuDuplicatePath {
7650
7807
  brand_id: string;
7651
7808
  menu_id: string;
7652
7809
  }
7653
7810
 
7654
- export interface DeleteMenuV4BrandMenuResponse {
7811
+ export interface PostMenuV4BrandMenuDuplicateBody {
7655
7812
  parent?: DraftMenuDTO;
7656
7813
  children?: DraftMenuDTO[];
7657
7814
  categories?: DraftCategoryDTO[];
7658
- id: string;
7659
- created_at?: string;
7660
- updated_at?: string;
7661
- deleted_at?: string;
7815
+ id?: string;
7662
7816
  parent_id?: string;
7663
- name: string;
7664
- brand_id: string;
7817
+ name?: string;
7818
+ brand_id?: string;
7665
7819
  applied_diff_snapshot?: Record<string, any>;
7666
7820
  version?: number;
7667
7821
  brand?: DraftBrandDTO;
@@ -7671,44 +7825,72 @@ export interface DeleteMenuV4BrandMenuResponse {
7671
7825
  [index: string]: any;
7672
7826
  }
7673
7827
 
7674
- export interface DeleteMenuV4BrandMenuRequest extends BaseRequest, DeleteMenuV4BrandMenuPath {}
7675
-
7676
- // DELETE menu/v4/brand/{brand_id}/category/{category_id}
7677
-
7678
- export interface DeleteMenuV4BrandCategoryPath {
7679
- brand_id: string;
7680
- category_id: string;
7681
- }
7682
-
7683
- export interface DeleteMenuV4BrandCategoryResponse {
7684
- parent?: DraftCategoryDTO;
7685
- children?: DraftCategoryDTO[];
7828
+ export interface PostMenuV4BrandMenuDuplicateResponse {
7829
+ parent?: DraftMenuDTO;
7830
+ children?: DraftMenuDTO[];
7831
+ categories?: DraftCategoryDTO[];
7686
7832
  id: string;
7687
7833
  created_at?: string;
7688
7834
  updated_at?: string;
7689
7835
  deleted_at?: string;
7690
7836
  parent_id?: string;
7691
7837
  name: string;
7692
- label?: string;
7693
- sequence?: number;
7694
- is_active?: boolean;
7695
7838
  brand_id: string;
7696
- menu_id: string;
7697
7839
  applied_diff_snapshot?: Record<string, any>;
7698
7840
  version?: number;
7699
- menu?: DraftMenuDTO;
7700
- items?: DraftCategoryToItemRelationshipDTO[];
7701
7841
  brand?: DraftBrandDTO;
7702
- changes?: CategoryChangeDTO[];
7842
+ changes?: MenuChangeDTO[];
7703
7843
  vendor_metadata?: VendorMetadataDTO[];
7704
- attachments?: FileAttachmentsDTO;
7705
7844
  permissions?: Record<string, any>;
7706
7845
  [index: string]: any;
7707
7846
  }
7708
7847
 
7709
- export interface DeleteMenuV4BrandCategoryRequest
7848
+ export interface PostMenuV4BrandMenuDuplicateRequest
7710
7849
  extends BaseRequest,
7711
- DeleteMenuV4BrandCategoryPath {}
7850
+ PostMenuV4BrandMenuDuplicatePath {
7851
+ body: PostMenuV4BrandMenuDuplicateBody;
7852
+ }
7853
+
7854
+ // POST /menu/v4/category/{id}/attachment/{name}
7855
+
7856
+ export interface PostMenuV4CategoryAttachmentPath {
7857
+ id: string;
7858
+ name: 'thumbnail';
7859
+ }
7860
+
7861
+ export interface PostMenuV4CategoryAttachmentQuery {
7862
+ 'body.data'?: string;
7863
+ 'body.brand_id'?: string;
7864
+ }
7865
+
7866
+ export interface PostMenuV4CategoryAttachmentResponse {
7867
+ status?: string;
7868
+ }
7869
+
7870
+ export interface PostMenuV4CategoryAttachmentRequest
7871
+ extends BaseRequest,
7872
+ RequestQuery<PostMenuV4CategoryAttachmentQuery>,
7873
+ PostMenuV4CategoryAttachmentPath {}
7874
+
7875
+ // POST /menu/v4/item/{id}/attachment/{name}
7876
+
7877
+ export interface PostMenuV4ItemAttachmentPath {
7878
+ id: string;
7879
+ name: 'thumbnail';
7880
+ }
7881
+
7882
+ export interface PostMenuV4ItemAttachmentQuery {
7883
+ 'body.data'?: string;
7884
+ }
7885
+
7886
+ export interface PostMenuV4ItemAttachmentResponse {
7887
+ status?: string;
7888
+ }
7889
+
7890
+ export interface PostMenuV4ItemAttachmentRequest
7891
+ extends BaseRequest,
7892
+ RequestQuery<PostMenuV4ItemAttachmentQuery>,
7893
+ PostMenuV4ItemAttachmentPath {}
7712
7894
 
7713
7895
  // POST /menu/v4/item
7714
7896
 
@@ -7966,6 +8148,7 @@ export interface DeleteMenuV4ItemPath {
7966
8148
  }
7967
8149
 
7968
8150
  export interface DeleteMenuV4ItemResponse {
8151
+ is_published?: boolean;
7969
8152
  parent?: DraftItemDTO;
7970
8153
  children?: DraftItemDTO[];
7971
8154
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -8011,10 +8194,158 @@ export interface DeleteMenuV4ItemResponse {
8011
8194
 
8012
8195
  export interface DeleteMenuV4ItemRequest extends BaseRequest, DeleteMenuV4ItemPath {}
8013
8196
 
8197
+ // PATCH /menu/v4/items/bulk-update
8198
+
8199
+ export interface PatchMenuV4ItemsBulkUpdateBody {
8200
+ id_list: string[];
8201
+ is_published?: boolean;
8202
+ parent?: DraftItemDTO;
8203
+ children?: DraftItemDTO[];
8204
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8205
+ id?: string;
8206
+ parent_id?: string;
8207
+ name?: string;
8208
+ name_on_receipt?: string;
8209
+ name_on_kds?: string;
8210
+ label?: string;
8211
+ description?: string;
8212
+ reporting?: ReportingMetadataDTO;
8213
+ price?: number;
8214
+ barcode?: string;
8215
+ calories?: number;
8216
+ meal_value?: number;
8217
+ is_active?: boolean;
8218
+ posid?: string;
8219
+ tax_tags?: string[];
8220
+ brand_id?: string;
8221
+ line_route?: string;
8222
+ posid_segment?: number;
8223
+ menu_works?: MenuWorksDTO;
8224
+ is_out_of_stock?: boolean;
8225
+ tax_tag_code?: string;
8226
+ tags?: string[];
8227
+ is_featured?: boolean;
8228
+ tax_jwo_code?: string;
8229
+ unique_id?: number;
8230
+ applied_diff_snapshot?: Record<string, any>;
8231
+ brand?: DraftBrandDTO;
8232
+ categories?: DraftCategoryToItemRelationshipDTO[];
8233
+ changes?: ItemChangeDTO[];
8234
+ vendor_metadata?: VendorMetadataDTO[];
8235
+ attachments?: FileAttachmentsDTO;
8236
+ weight?: WeightDTO;
8237
+ permissions?: Record<string, any>;
8238
+ [index: string]: any;
8239
+ }
8240
+
8241
+ export interface PatchMenuV4ItemsBulkUpdateResponse {
8242
+ results?: DraftItemEntityDTO[];
8243
+ }
8244
+
8245
+ export interface PatchMenuV4ItemsBulkUpdateRequest extends BaseRequest {
8246
+ body: PatchMenuV4ItemsBulkUpdateBody;
8247
+ }
8248
+
8249
+ // POST /menu/v4/item/{id}/duplicate
8250
+
8251
+ export interface PostMenuV4ItemDuplicatePath {
8252
+ id: string;
8253
+ }
8254
+
8255
+ export interface PostMenuV4ItemDuplicateBody {
8256
+ base_item_id?: string;
8257
+ is_published?: boolean;
8258
+ parent?: DraftItemDTO;
8259
+ children?: DraftItemDTO[];
8260
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8261
+ parent_id?: string;
8262
+ name?: string;
8263
+ name_on_receipt?: string;
8264
+ name_on_kds?: string;
8265
+ label?: string;
8266
+ description?: string;
8267
+ reporting?: ReportingMetadataDTO;
8268
+ price?: number;
8269
+ barcode?: string;
8270
+ calories?: number;
8271
+ meal_value?: number;
8272
+ is_active?: boolean;
8273
+ posid?: string;
8274
+ tax_tags?: string[];
8275
+ brand_id?: string;
8276
+ line_route?: string;
8277
+ posid_segment?: number;
8278
+ menu_works?: MenuWorksDTO;
8279
+ is_out_of_stock?: boolean;
8280
+ tax_tag_code?: string;
8281
+ tags?: string[];
8282
+ is_featured?: boolean;
8283
+ tax_jwo_code?: string;
8284
+ unique_id?: number;
8285
+ applied_diff_snapshot?: Record<string, any>;
8286
+ brand?: DraftBrandDTO;
8287
+ categories?: DraftCategoryToItemRelationshipDTO[];
8288
+ changes?: ItemChangeDTO[];
8289
+ vendor_metadata?: VendorMetadataDTO[];
8290
+ attachments?: FileAttachmentsDTO;
8291
+ weight?: WeightDTO;
8292
+ permissions?: Record<string, any>;
8293
+ [index: string]: any;
8294
+ }
8295
+
8296
+ export interface PostMenuV4ItemDuplicateResponse {
8297
+ is_published?: boolean;
8298
+ parent?: DraftItemDTO;
8299
+ children?: DraftItemDTO[];
8300
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8301
+ id: string;
8302
+ created_at?: string;
8303
+ updated_at?: string;
8304
+ deleted_at?: string;
8305
+ parent_id?: string;
8306
+ name: string;
8307
+ name_on_receipt?: string;
8308
+ name_on_kds?: string;
8309
+ label?: string;
8310
+ description?: string;
8311
+ reporting: ReportingMetadataDTO;
8312
+ price: number;
8313
+ barcode?: string;
8314
+ calories?: number;
8315
+ meal_value?: number;
8316
+ is_active?: boolean;
8317
+ posid?: string;
8318
+ tax_tags?: string[];
8319
+ brand_id: string;
8320
+ line_route?: string;
8321
+ posid_segment?: number;
8322
+ menu_works?: MenuWorksDTO;
8323
+ is_out_of_stock?: boolean;
8324
+ tax_tag_code?: string;
8325
+ tags?: string[];
8326
+ is_featured?: boolean;
8327
+ tax_jwo_code?: string;
8328
+ unique_id?: number;
8329
+ applied_diff_snapshot?: Record<string, any>;
8330
+ version?: number;
8331
+ brand?: DraftBrandDTO;
8332
+ categories?: DraftCategoryToItemRelationshipDTO[];
8333
+ changes?: ItemChangeDTO[];
8334
+ vendor_metadata?: VendorMetadataDTO[];
8335
+ attachments?: FileAttachmentsDTO;
8336
+ weight?: WeightDTO;
8337
+ permissions?: Record<string, any>;
8338
+ [index: string]: any;
8339
+ }
8340
+
8341
+ export interface PostMenuV4ItemDuplicateRequest extends BaseRequest, PostMenuV4ItemDuplicatePath {
8342
+ body: PostMenuV4ItemDuplicateBody;
8343
+ }
8344
+
8014
8345
  // POST /menu/v4/modifier
8015
8346
 
8016
8347
  export interface PostMenuV4ModifierBody {
8017
- base_item_id: string;
8348
+ base_item_id?: string;
8018
8349
  parent?: DraftModifierDTO;
8019
8350
  children?: DraftModifierDTO[];
8020
8351
  modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
@@ -8306,6 +8637,172 @@ export interface DeleteMenuV4ModifierResponse {
8306
8637
 
8307
8638
  export interface DeleteMenuV4ModifierRequest extends BaseRequest, DeleteMenuV4ModifierPath {}
8308
8639
 
8640
+ // POST /menu/v4/modifier/{id}/duplicate
8641
+
8642
+ export interface PostMenuV4ModifierDuplicatePath {
8643
+ id: string;
8644
+ }
8645
+
8646
+ export interface PostMenuV4ModifierDuplicateBody {
8647
+ parent?: DraftModifierDTO;
8648
+ children?: DraftModifierDTO[];
8649
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8650
+ parent_id?: string;
8651
+ name?: string;
8652
+ name_on_receipt?: string;
8653
+ name_on_kds?: string;
8654
+ label?: string;
8655
+ description?: string;
8656
+ price?: number;
8657
+ calories?: number;
8658
+ tax_tags?: string[];
8659
+ is_active?: boolean;
8660
+ posid?: string;
8661
+ reporting?: ReportingMetadataDTO;
8662
+ posid_segment?: number;
8663
+ brand_id?: string;
8664
+ line_route?: string;
8665
+ menu_works?: MenuWorksDTO;
8666
+ is_out_of_stock?: boolean;
8667
+ price_for_none?: number;
8668
+ price_for_less?: number;
8669
+ price_for_more?: number;
8670
+ pre_surcharge?: number;
8671
+ post_surcharge?: number;
8672
+ tax_tag_code?: string;
8673
+ tags?: string[];
8674
+ unique_id?: number;
8675
+ applied_diff_snapshot?: Record<string, any>;
8676
+ brand?: DraftBrandDTO;
8677
+ changes?: ModifierChangeDTO[];
8678
+ vendor_metadata?: VendorMetadataDTO[];
8679
+ weight?: WeightDTO;
8680
+ attachments?: FileAttachmentsDTO;
8681
+ permissions?: Record<string, any>;
8682
+ [index: string]: any;
8683
+ }
8684
+
8685
+ export interface PostMenuV4ModifierDuplicateResponse {
8686
+ parent?: DraftModifierDTO;
8687
+ children?: DraftModifierDTO[];
8688
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8689
+ id: string;
8690
+ created_at?: string;
8691
+ updated_at?: string;
8692
+ deleted_at?: string;
8693
+ parent_id?: string;
8694
+ name: string;
8695
+ name_on_receipt?: string;
8696
+ name_on_kds?: string;
8697
+ label?: string;
8698
+ description?: string;
8699
+ price: number;
8700
+ calories?: number;
8701
+ tax_tags?: string[];
8702
+ is_active?: boolean;
8703
+ posid?: string;
8704
+ reporting: ReportingMetadataDTO;
8705
+ posid_segment?: number;
8706
+ brand_id: string;
8707
+ line_route?: string;
8708
+ menu_works?: MenuWorksDTO;
8709
+ is_out_of_stock?: boolean;
8710
+ price_for_none?: number;
8711
+ price_for_less?: number;
8712
+ price_for_more?: number;
8713
+ pre_surcharge?: number;
8714
+ post_surcharge?: number;
8715
+ tax_tag_code?: string;
8716
+ tags?: string[];
8717
+ unique_id?: number;
8718
+ applied_diff_snapshot?: Record<string, any>;
8719
+ version?: number;
8720
+ brand?: DraftBrandDTO;
8721
+ changes?: ModifierChangeDTO[];
8722
+ vendor_metadata?: VendorMetadataDTO[];
8723
+ weight?: WeightDTO;
8724
+ attachments?: FileAttachmentsDTO;
8725
+ permissions?: Record<string, any>;
8726
+ [index: string]: any;
8727
+ }
8728
+
8729
+ export interface PostMenuV4ModifierDuplicateRequest
8730
+ extends BaseRequest,
8731
+ PostMenuV4ModifierDuplicatePath {
8732
+ body: PostMenuV4ModifierDuplicateBody;
8733
+ }
8734
+
8735
+ // PATCH /menu/v4/modifiers/bulk-update
8736
+
8737
+ export interface PatchMenuV4ModifiersBulkUpdateBody {
8738
+ id_list: string[];
8739
+ parent?: DraftModifierDTO;
8740
+ children?: DraftModifierDTO[];
8741
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8742
+ id?: string;
8743
+ parent_id?: string;
8744
+ name?: string;
8745
+ name_on_receipt?: string;
8746
+ name_on_kds?: string;
8747
+ label?: string;
8748
+ description?: string;
8749
+ price?: number;
8750
+ calories?: number;
8751
+ tax_tags?: string[];
8752
+ is_active?: boolean;
8753
+ posid?: string;
8754
+ reporting?: ReportingMetadataDTO;
8755
+ posid_segment?: number;
8756
+ brand_id?: string;
8757
+ line_route?: string;
8758
+ menu_works?: MenuWorksDTO;
8759
+ is_out_of_stock?: boolean;
8760
+ price_for_none?: number;
8761
+ price_for_less?: number;
8762
+ price_for_more?: number;
8763
+ pre_surcharge?: number;
8764
+ post_surcharge?: number;
8765
+ tax_tag_code?: string;
8766
+ tags?: string[];
8767
+ unique_id?: number;
8768
+ applied_diff_snapshot?: Record<string, any>;
8769
+ brand?: DraftBrandDTO;
8770
+ changes?: ModifierChangeDTO[];
8771
+ vendor_metadata?: VendorMetadataDTO[];
8772
+ weight?: WeightDTO;
8773
+ attachments?: FileAttachmentsDTO;
8774
+ permissions?: Record<string, any>;
8775
+ [index: string]: any;
8776
+ }
8777
+
8778
+ export interface PatchMenuV4ModifiersBulkUpdateResponse {
8779
+ results?: DraftModifierEntityDTO[];
8780
+ }
8781
+
8782
+ export interface PatchMenuV4ModifiersBulkUpdateRequest extends BaseRequest {
8783
+ body: PatchMenuV4ModifiersBulkUpdateBody;
8784
+ }
8785
+
8786
+ // POST /menu/v4/modifier/{id}/attachment/{name}
8787
+
8788
+ export interface PostMenuV4ModifierAttachmentPath {
8789
+ id: string;
8790
+ name: 'thumbnail';
8791
+ }
8792
+
8793
+ export interface PostMenuV4ModifierAttachmentQuery {
8794
+ 'body.data'?: string;
8795
+ }
8796
+
8797
+ export interface PostMenuV4ModifierAttachmentResponse {
8798
+ status?: string;
8799
+ }
8800
+
8801
+ export interface PostMenuV4ModifierAttachmentRequest
8802
+ extends BaseRequest,
8803
+ RequestQuery<PostMenuV4ModifierAttachmentQuery>,
8804
+ PostMenuV4ModifierAttachmentPath {}
8805
+
8309
8806
  // POST /menu/v4/modifier-group
8310
8807
 
8311
8808
  export interface PostMenuV4ModifierGroupBody {
@@ -8551,3 +9048,75 @@ export interface PostMenuV4ModifierGroupAttachModifiersRequest
8551
9048
  PostMenuV4ModifierGroupAttachModifiersPath {
8552
9049
  body: PostMenuV4ModifierGroupAttachModifiersBody;
8553
9050
  }
9051
+
9052
+ // POST /menu/v4/modifier-group/{id}/duplicate
9053
+
9054
+ export interface PostMenuV4ModifierGroupDuplicatePath {
9055
+ id: string;
9056
+ }
9057
+
9058
+ export interface PostMenuV4ModifierGroupDuplicateQuery {
9059
+ duplicate_modifiers?: boolean;
9060
+ }
9061
+
9062
+ export interface PostMenuV4ModifierGroupDuplicateBody {
9063
+ parent?: DraftModifierGroupDTO;
9064
+ children?: DraftModifierGroupDTO[];
9065
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
9066
+ items?: DraftItemToModifierGroupRelationshipDTO[];
9067
+ parent_id?: string;
9068
+ name?: string;
9069
+ label?: string;
9070
+ min?: number;
9071
+ max?: number;
9072
+ is_active?: boolean;
9073
+ limit?: number;
9074
+ brand_id?: string;
9075
+ order_type?: 'selection' | 'option' | 'quantity';
9076
+ sizing?: string;
9077
+ is_out_of_stock?: boolean;
9078
+ is_incremental?: boolean;
9079
+ applied_diff_snapshot?: Record<string, any>;
9080
+ brand?: DraftBrandDTO;
9081
+ changes?: ModifierGroupChangeDTO[];
9082
+ vendor_metadata?: VendorMetadataDTO[];
9083
+ permissions?: Record<string, any>;
9084
+ [index: string]: any;
9085
+ }
9086
+
9087
+ export interface PostMenuV4ModifierGroupDuplicateResponse {
9088
+ parent?: DraftModifierGroupDTO;
9089
+ children?: DraftModifierGroupDTO[];
9090
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
9091
+ items?: DraftItemToModifierGroupRelationshipDTO[];
9092
+ id: string;
9093
+ created_at?: string;
9094
+ updated_at?: string;
9095
+ deleted_at?: string;
9096
+ parent_id?: string;
9097
+ name: string;
9098
+ label?: string;
9099
+ min?: number;
9100
+ max?: number;
9101
+ is_active?: boolean;
9102
+ limit?: number;
9103
+ brand_id: string;
9104
+ order_type?: 'selection' | 'option' | 'quantity';
9105
+ sizing?: string;
9106
+ is_out_of_stock?: boolean;
9107
+ is_incremental?: boolean;
9108
+ applied_diff_snapshot?: Record<string, any>;
9109
+ version?: number;
9110
+ brand?: DraftBrandDTO;
9111
+ changes?: ModifierGroupChangeDTO[];
9112
+ vendor_metadata?: VendorMetadataDTO[];
9113
+ permissions?: Record<string, any>;
9114
+ [index: string]: any;
9115
+ }
9116
+
9117
+ export interface PostMenuV4ModifierGroupDuplicateRequest
9118
+ extends BaseRequest,
9119
+ RequestQuery<PostMenuV4ModifierGroupDuplicateQuery>,
9120
+ PostMenuV4ModifierGroupDuplicatePath {
9121
+ body: PostMenuV4ModifierGroupDuplicateBody;
9122
+ }