@compassdigital/sdk.typescript 4.96.0 → 4.98.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
@@ -1447,11 +1436,6 @@ export interface V2MetaDTO {
1447
1436
  version?: number;
1448
1437
  }
1449
1438
 
1450
- export interface LineRouteSuggestion {
1451
- line_route?: string;
1452
- occurrences?: number;
1453
- }
1454
-
1455
1439
  export interface DraftItemEntityDTO {
1456
1440
  is_published?: boolean;
1457
1441
  parent?: DraftItemDTO;
@@ -1497,6 +1481,11 @@ export interface DraftItemEntityDTO {
1497
1481
  [index: string]: any;
1498
1482
  }
1499
1483
 
1484
+ export interface LineRouteSuggestion {
1485
+ line_route?: string;
1486
+ occurrences?: number;
1487
+ }
1488
+
1500
1489
  export interface DraftModifierEntityDTO {
1501
1490
  parent?: DraftModifierDTO;
1502
1491
  children?: DraftModifierDTO[];
@@ -4573,6 +4562,41 @@ export interface PostMenuV3DraftCategoryDuplicateRequest
4573
4562
  body: PostMenuV3DraftCategoryDuplicateBody;
4574
4563
  }
4575
4564
 
4565
+ // GET /menu/v3/draft/category/{id}/unattached_items
4566
+
4567
+ export interface GetMenuV3DraftCategoryUnattachedItemsPath {
4568
+ id: string;
4569
+ }
4570
+
4571
+ export interface GetMenuV3DraftCategoryUnattachedItemsQuery {
4572
+ filter?: string;
4573
+ // If specified, only the selected fields will be returned
4574
+ select?: string[];
4575
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
4576
+ relationships?: string[];
4577
+ // Number of records to load per page
4578
+ limit?: number;
4579
+ page?: number;
4580
+ // A field to sort the results based on
4581
+ sort_by?: string;
4582
+ sort_order?: 'DESC' | 'ASC';
4583
+ // How soft deleted records should be shown in the list
4584
+ soft_deleted?: 'include' | 'exclude' | 'only';
4585
+ // Graphql query string
4586
+ _query?: string;
4587
+ }
4588
+
4589
+ export interface GetMenuV3DraftCategoryUnattachedItemsResponse {
4590
+ results: DraftItemEntityDTO[];
4591
+ meta?: ListResponseMetadataDTO;
4592
+ [index: string]: any;
4593
+ }
4594
+
4595
+ export interface GetMenuV3DraftCategoryUnattachedItemsRequest
4596
+ extends BaseRequest,
4597
+ RequestQuery<GetMenuV3DraftCategoryUnattachedItemsQuery>,
4598
+ GetMenuV3DraftCategoryUnattachedItemsPath {}
4599
+
4576
4600
  // GET /menu/v3/category/{id}
4577
4601
 
4578
4602
  export interface GetMenuV3CategoryPath {
@@ -7192,6 +7216,54 @@ export interface GetMenuV4BrandRequest
7192
7216
  RequestQuery<GetMenuV4BrandQuery>,
7193
7217
  GetMenuV4BrandPath {}
7194
7218
 
7219
+ // DELETE /menu/v4/brand/{id}
7220
+
7221
+ export interface DeleteMenuV4BrandPath {
7222
+ id: string;
7223
+ }
7224
+
7225
+ export interface DeleteMenuV4BrandResponse {
7226
+ parent?: DraftBrandDTO;
7227
+ children?: DraftBrandDTO[];
7228
+ menus?: DraftMenuDTO[];
7229
+ categories?: DraftCategoryDTO[];
7230
+ category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
7231
+ items?: DraftItemDTO[];
7232
+ item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
7233
+ modifier_groups?: DraftModifierGroupDTO[];
7234
+ modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
7235
+ modifiers?: DraftModifierDTO[];
7236
+ statuses?: BrandStatusDTO[];
7237
+ audit_logs?: AuditDTO[];
7238
+ id: string;
7239
+ created_at?: string;
7240
+ updated_at?: string;
7241
+ deleted_at?: string;
7242
+ name: string;
7243
+ description?: string;
7244
+ is_active?: boolean;
7245
+ type?: 'global' | 'local';
7246
+ parent_id?: string;
7247
+ local_menu_group_id?: string;
7248
+ global_menu_group_id?: string;
7249
+ posid_segment?: string;
7250
+ is_simplified_view?: boolean;
7251
+ frictionless_partner?: string;
7252
+ catalog_id?: number;
7253
+ meta?: BrandMeta;
7254
+ applied_diff_snapshot?: Record<string, any>;
7255
+ version?: number;
7256
+ changes?: BrandChangeDTO[];
7257
+ local_menu_group?: LocalMenuGroupDTO;
7258
+ global_menu_group?: GlobalMenuGroupDTO;
7259
+ vendor_metadata?: VendorMetadataDTO[];
7260
+ attachments?: FileAttachmentsDTO;
7261
+ permissions?: Record<string, any>;
7262
+ [index: string]: any;
7263
+ }
7264
+
7265
+ export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
7266
+
7195
7267
  // POST /menu/v4/brand/{id}/menu
7196
7268
 
7197
7269
  export interface PostMenuV4BrandMenuPath {
@@ -7285,6 +7357,35 @@ export interface PatchMenuV4BrandMenuRequest extends BaseRequest, PatchMenuV4Bra
7285
7357
  body: PatchMenuV4BrandMenuBody;
7286
7358
  }
7287
7359
 
7360
+ // DELETE /menu/v4/brand/{brand_id}/menu/{menu_id}
7361
+
7362
+ export interface DeleteMenuV4BrandMenuPath {
7363
+ brand_id: string;
7364
+ menu_id: string;
7365
+ }
7366
+
7367
+ export interface DeleteMenuV4BrandMenuResponse {
7368
+ parent?: DraftMenuDTO;
7369
+ children?: DraftMenuDTO[];
7370
+ categories?: DraftCategoryDTO[];
7371
+ id: string;
7372
+ created_at?: string;
7373
+ updated_at?: string;
7374
+ deleted_at?: string;
7375
+ parent_id?: string;
7376
+ name: string;
7377
+ brand_id: string;
7378
+ applied_diff_snapshot?: Record<string, any>;
7379
+ version?: number;
7380
+ brand?: DraftBrandDTO;
7381
+ changes?: MenuChangeDTO[];
7382
+ vendor_metadata?: VendorMetadataDTO[];
7383
+ permissions?: Record<string, any>;
7384
+ [index: string]: any;
7385
+ }
7386
+
7387
+ export interface DeleteMenuV4BrandMenuRequest extends BaseRequest, DeleteMenuV4BrandMenuPath {}
7388
+
7288
7389
  // GET /menu/v4/brand/{id}/items
7289
7390
 
7290
7391
  export interface GetMenuV4BrandItemsPath {
@@ -7538,6 +7639,43 @@ export interface PatchMenuV4BrandCategoryRequest extends BaseRequest, PatchMenuV
7538
7639
  body: PatchMenuV4BrandCategoryBody;
7539
7640
  }
7540
7641
 
7642
+ // DELETE /menu/v4/brand/{brand_id}/category/{category_id}
7643
+
7644
+ export interface DeleteMenuV4BrandCategoryPath {
7645
+ brand_id: string;
7646
+ category_id: string;
7647
+ }
7648
+
7649
+ export interface DeleteMenuV4BrandCategoryResponse {
7650
+ parent?: DraftCategoryDTO;
7651
+ children?: DraftCategoryDTO[];
7652
+ id: string;
7653
+ created_at?: string;
7654
+ updated_at?: string;
7655
+ deleted_at?: string;
7656
+ parent_id?: string;
7657
+ name: string;
7658
+ label?: string;
7659
+ sequence?: number;
7660
+ is_active?: boolean;
7661
+ brand_id: string;
7662
+ menu_id: string;
7663
+ applied_diff_snapshot?: Record<string, any>;
7664
+ version?: number;
7665
+ menu?: DraftMenuDTO;
7666
+ items?: DraftCategoryToItemRelationshipDTO[];
7667
+ brand?: DraftBrandDTO;
7668
+ changes?: CategoryChangeDTO[];
7669
+ vendor_metadata?: VendorMetadataDTO[];
7670
+ attachments?: FileAttachmentsDTO;
7671
+ permissions?: Record<string, any>;
7672
+ [index: string]: any;
7673
+ }
7674
+
7675
+ export interface DeleteMenuV4BrandCategoryRequest
7676
+ extends BaseRequest,
7677
+ DeleteMenuV4BrandCategoryPath {}
7678
+
7541
7679
  // POST /menu/v4/brand/{id}/category/attach-items
7542
7680
 
7543
7681
  export interface PostMenuV4BrandCategoryAttachItemsPath {
@@ -7572,7 +7710,7 @@ export interface PostMenuV4BrandCategoryAttachItemsRequest
7572
7710
  body: PostMenuV4BrandCategoryAttachItemsBody;
7573
7711
  }
7574
7712
 
7575
- // POST menu/v4/brand/{id}/publish
7713
+ // POST /menu/v4/brand/{id}/publish
7576
7714
 
7577
7715
  export interface PostMenuV4BrandPublishPath {
7578
7716
  id: string;
@@ -7584,7 +7722,7 @@ export interface PostMenuV4BrandPublishResponse {
7584
7722
 
7585
7723
  export interface PostMenuV4BrandPublishRequest extends BaseRequest, PostMenuV4BrandPublishPath {}
7586
7724
 
7587
- // POST menu/v4/brand/{id}/v3-to-v4
7725
+ // POST /menu/v4/brand/{id}/v3-to-v4
7588
7726
 
7589
7727
  export interface PostMenuV4BrandV3ToV4Path {
7590
7728
  id: string;
@@ -7596,72 +7734,83 @@ export interface PostMenuV4BrandV3ToV4Response {
7596
7734
 
7597
7735
  export interface PostMenuV4BrandV3ToV4Request extends BaseRequest, PostMenuV4BrandV3ToV4Path {}
7598
7736
 
7599
- // DELETE menu/v4/brand/{id}
7737
+ // POST /menu/v4/brand/{brand_id}/category/{category_id}/duplicate
7600
7738
 
7601
- export interface DeleteMenuV4BrandPath {
7602
- id: string;
7739
+ export interface PostMenuV4BrandCategoryDuplicatePath {
7740
+ brand_id: string;
7741
+ category_id: string;
7603
7742
  }
7604
7743
 
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[];
7744
+ export interface PostMenuV4BrandCategoryDuplicateBody {
7745
+ parent?: DraftCategoryDTO;
7746
+ children?: DraftCategoryDTO[];
7747
+ id?: string;
7748
+ parent_id?: string;
7749
+ name?: string;
7750
+ label?: string;
7751
+ sequence?: number;
7752
+ is_active?: boolean;
7753
+ brand_id?: string;
7754
+ menu_id?: string;
7755
+ applied_diff_snapshot?: Record<string, any>;
7756
+ version?: number;
7757
+ menu?: DraftMenuDTO;
7758
+ items?: DraftCategoryToItemRelationshipDTO[];
7759
+ brand?: DraftBrandDTO;
7760
+ changes?: CategoryChangeDTO[];
7761
+ vendor_metadata?: VendorMetadataDTO[];
7762
+ attachments?: FileAttachmentsDTO;
7763
+ permissions?: Record<string, any>;
7764
+ [index: string]: any;
7765
+ }
7766
+
7767
+ export interface PostMenuV4BrandCategoryDuplicateResponse {
7768
+ parent?: DraftCategoryDTO;
7769
+ children?: DraftCategoryDTO[];
7618
7770
  id: string;
7619
7771
  created_at?: string;
7620
7772
  updated_at?: string;
7621
7773
  deleted_at?: string;
7774
+ parent_id?: string;
7622
7775
  name: string;
7623
- description?: string;
7776
+ label?: string;
7777
+ sequence?: number;
7624
7778
  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;
7779
+ brand_id: string;
7780
+ menu_id: string;
7634
7781
  applied_diff_snapshot?: Record<string, any>;
7635
7782
  version?: number;
7636
- changes?: BrandChangeDTO[];
7637
- local_menu_group?: LocalMenuGroupDTO;
7638
- global_menu_group?: GlobalMenuGroupDTO;
7783
+ menu?: DraftMenuDTO;
7784
+ items?: DraftCategoryToItemRelationshipDTO[];
7785
+ brand?: DraftBrandDTO;
7786
+ changes?: CategoryChangeDTO[];
7639
7787
  vendor_metadata?: VendorMetadataDTO[];
7640
7788
  attachments?: FileAttachmentsDTO;
7641
7789
  permissions?: Record<string, any>;
7642
7790
  [index: string]: any;
7643
7791
  }
7644
7792
 
7645
- export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
7793
+ export interface PostMenuV4BrandCategoryDuplicateRequest
7794
+ extends BaseRequest,
7795
+ PostMenuV4BrandCategoryDuplicatePath {
7796
+ body: PostMenuV4BrandCategoryDuplicateBody;
7797
+ }
7646
7798
 
7647
- // DELETE menu/v4/brand/{brand_id}/menu/{menu_id}
7799
+ // POST /menu/v4/brand/{brand_id}/menu/{menu_id}/duplicate
7648
7800
 
7649
- export interface DeleteMenuV4BrandMenuPath {
7801
+ export interface PostMenuV4BrandMenuDuplicatePath {
7650
7802
  brand_id: string;
7651
7803
  menu_id: string;
7652
7804
  }
7653
7805
 
7654
- export interface DeleteMenuV4BrandMenuResponse {
7806
+ export interface PostMenuV4BrandMenuDuplicateBody {
7655
7807
  parent?: DraftMenuDTO;
7656
7808
  children?: DraftMenuDTO[];
7657
7809
  categories?: DraftCategoryDTO[];
7658
- id: string;
7659
- created_at?: string;
7660
- updated_at?: string;
7661
- deleted_at?: string;
7810
+ id?: string;
7662
7811
  parent_id?: string;
7663
- name: string;
7664
- brand_id: string;
7812
+ name?: string;
7813
+ brand_id?: string;
7665
7814
  applied_diff_snapshot?: Record<string, any>;
7666
7815
  version?: number;
7667
7816
  brand?: DraftBrandDTO;
@@ -7671,44 +7820,72 @@ export interface DeleteMenuV4BrandMenuResponse {
7671
7820
  [index: string]: any;
7672
7821
  }
7673
7822
 
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[];
7823
+ export interface PostMenuV4BrandMenuDuplicateResponse {
7824
+ parent?: DraftMenuDTO;
7825
+ children?: DraftMenuDTO[];
7826
+ categories?: DraftCategoryDTO[];
7686
7827
  id: string;
7687
7828
  created_at?: string;
7688
7829
  updated_at?: string;
7689
7830
  deleted_at?: string;
7690
7831
  parent_id?: string;
7691
7832
  name: string;
7692
- label?: string;
7693
- sequence?: number;
7694
- is_active?: boolean;
7695
7833
  brand_id: string;
7696
- menu_id: string;
7697
7834
  applied_diff_snapshot?: Record<string, any>;
7698
7835
  version?: number;
7699
- menu?: DraftMenuDTO;
7700
- items?: DraftCategoryToItemRelationshipDTO[];
7701
7836
  brand?: DraftBrandDTO;
7702
- changes?: CategoryChangeDTO[];
7837
+ changes?: MenuChangeDTO[];
7703
7838
  vendor_metadata?: VendorMetadataDTO[];
7704
- attachments?: FileAttachmentsDTO;
7705
7839
  permissions?: Record<string, any>;
7706
7840
  [index: string]: any;
7707
7841
  }
7708
7842
 
7709
- export interface DeleteMenuV4BrandCategoryRequest
7843
+ export interface PostMenuV4BrandMenuDuplicateRequest
7710
7844
  extends BaseRequest,
7711
- DeleteMenuV4BrandCategoryPath {}
7845
+ PostMenuV4BrandMenuDuplicatePath {
7846
+ body: PostMenuV4BrandMenuDuplicateBody;
7847
+ }
7848
+
7849
+ // POST /menu/v4/category/{id}/attachment/{name}
7850
+
7851
+ export interface PostMenuV4CategoryAttachmentPath {
7852
+ id: string;
7853
+ name: 'thumbnail';
7854
+ }
7855
+
7856
+ export interface PostMenuV4CategoryAttachmentQuery {
7857
+ 'body.data'?: string;
7858
+ 'body.brand_id'?: string;
7859
+ }
7860
+
7861
+ export interface PostMenuV4CategoryAttachmentResponse {
7862
+ status?: string;
7863
+ }
7864
+
7865
+ export interface PostMenuV4CategoryAttachmentRequest
7866
+ extends BaseRequest,
7867
+ RequestQuery<PostMenuV4CategoryAttachmentQuery>,
7868
+ PostMenuV4CategoryAttachmentPath {}
7869
+
7870
+ // POST /menu/v4/item/{id}/attachment/{name}
7871
+
7872
+ export interface PostMenuV4ItemAttachmentPath {
7873
+ id: string;
7874
+ name: 'thumbnail';
7875
+ }
7876
+
7877
+ export interface PostMenuV4ItemAttachmentQuery {
7878
+ 'body.data'?: string;
7879
+ }
7880
+
7881
+ export interface PostMenuV4ItemAttachmentResponse {
7882
+ status?: string;
7883
+ }
7884
+
7885
+ export interface PostMenuV4ItemAttachmentRequest
7886
+ extends BaseRequest,
7887
+ RequestQuery<PostMenuV4ItemAttachmentQuery>,
7888
+ PostMenuV4ItemAttachmentPath {}
7712
7889
 
7713
7890
  // POST /menu/v4/item
7714
7891
 
@@ -7966,6 +8143,7 @@ export interface DeleteMenuV4ItemPath {
7966
8143
  }
7967
8144
 
7968
8145
  export interface DeleteMenuV4ItemResponse {
8146
+ is_published?: boolean;
7969
8147
  parent?: DraftItemDTO;
7970
8148
  children?: DraftItemDTO[];
7971
8149
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -8011,10 +8189,158 @@ export interface DeleteMenuV4ItemResponse {
8011
8189
 
8012
8190
  export interface DeleteMenuV4ItemRequest extends BaseRequest, DeleteMenuV4ItemPath {}
8013
8191
 
8192
+ // PATCH /menu/v4/items/bulk-update
8193
+
8194
+ export interface PatchMenuV4ItemsBulkUpdateBody {
8195
+ id_list: string[];
8196
+ is_published?: boolean;
8197
+ parent?: DraftItemDTO;
8198
+ children?: DraftItemDTO[];
8199
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8200
+ id?: string;
8201
+ parent_id?: string;
8202
+ name?: string;
8203
+ name_on_receipt?: string;
8204
+ name_on_kds?: string;
8205
+ label?: string;
8206
+ description?: string;
8207
+ reporting?: ReportingMetadataDTO;
8208
+ price?: number;
8209
+ barcode?: string;
8210
+ calories?: number;
8211
+ meal_value?: number;
8212
+ is_active?: boolean;
8213
+ posid?: string;
8214
+ tax_tags?: string[];
8215
+ brand_id?: string;
8216
+ line_route?: string;
8217
+ posid_segment?: number;
8218
+ menu_works?: MenuWorksDTO;
8219
+ is_out_of_stock?: boolean;
8220
+ tax_tag_code?: string;
8221
+ tags?: string[];
8222
+ is_featured?: boolean;
8223
+ tax_jwo_code?: string;
8224
+ unique_id?: number;
8225
+ applied_diff_snapshot?: Record<string, any>;
8226
+ brand?: DraftBrandDTO;
8227
+ categories?: DraftCategoryToItemRelationshipDTO[];
8228
+ changes?: ItemChangeDTO[];
8229
+ vendor_metadata?: VendorMetadataDTO[];
8230
+ attachments?: FileAttachmentsDTO;
8231
+ weight?: WeightDTO;
8232
+ permissions?: Record<string, any>;
8233
+ [index: string]: any;
8234
+ }
8235
+
8236
+ export interface PatchMenuV4ItemsBulkUpdateResponse {
8237
+ results?: DraftItemEntityDTO[];
8238
+ }
8239
+
8240
+ export interface PatchMenuV4ItemsBulkUpdateRequest extends BaseRequest {
8241
+ body: PatchMenuV4ItemsBulkUpdateBody;
8242
+ }
8243
+
8244
+ // POST /menu/v4/item/{id}/duplicate
8245
+
8246
+ export interface PostMenuV4ItemDuplicatePath {
8247
+ id: string;
8248
+ }
8249
+
8250
+ export interface PostMenuV4ItemDuplicateBody {
8251
+ base_item_id?: string;
8252
+ is_published?: boolean;
8253
+ parent?: DraftItemDTO;
8254
+ children?: DraftItemDTO[];
8255
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8256
+ parent_id?: string;
8257
+ name?: string;
8258
+ name_on_receipt?: string;
8259
+ name_on_kds?: string;
8260
+ label?: string;
8261
+ description?: string;
8262
+ reporting?: ReportingMetadataDTO;
8263
+ price?: number;
8264
+ barcode?: string;
8265
+ calories?: number;
8266
+ meal_value?: number;
8267
+ is_active?: boolean;
8268
+ posid?: string;
8269
+ tax_tags?: string[];
8270
+ brand_id?: string;
8271
+ line_route?: string;
8272
+ posid_segment?: number;
8273
+ menu_works?: MenuWorksDTO;
8274
+ is_out_of_stock?: boolean;
8275
+ tax_tag_code?: string;
8276
+ tags?: string[];
8277
+ is_featured?: boolean;
8278
+ tax_jwo_code?: string;
8279
+ unique_id?: number;
8280
+ applied_diff_snapshot?: Record<string, any>;
8281
+ brand?: DraftBrandDTO;
8282
+ categories?: DraftCategoryToItemRelationshipDTO[];
8283
+ changes?: ItemChangeDTO[];
8284
+ vendor_metadata?: VendorMetadataDTO[];
8285
+ attachments?: FileAttachmentsDTO;
8286
+ weight?: WeightDTO;
8287
+ permissions?: Record<string, any>;
8288
+ [index: string]: any;
8289
+ }
8290
+
8291
+ export interface PostMenuV4ItemDuplicateResponse {
8292
+ is_published?: boolean;
8293
+ parent?: DraftItemDTO;
8294
+ children?: DraftItemDTO[];
8295
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8296
+ id: string;
8297
+ created_at?: string;
8298
+ updated_at?: string;
8299
+ deleted_at?: string;
8300
+ parent_id?: string;
8301
+ name: string;
8302
+ name_on_receipt?: string;
8303
+ name_on_kds?: string;
8304
+ label?: string;
8305
+ description?: string;
8306
+ reporting: ReportingMetadataDTO;
8307
+ price: number;
8308
+ barcode?: string;
8309
+ calories?: number;
8310
+ meal_value?: number;
8311
+ is_active?: boolean;
8312
+ posid?: string;
8313
+ tax_tags?: string[];
8314
+ brand_id: string;
8315
+ line_route?: string;
8316
+ posid_segment?: number;
8317
+ menu_works?: MenuWorksDTO;
8318
+ is_out_of_stock?: boolean;
8319
+ tax_tag_code?: string;
8320
+ tags?: string[];
8321
+ is_featured?: boolean;
8322
+ tax_jwo_code?: string;
8323
+ unique_id?: number;
8324
+ applied_diff_snapshot?: Record<string, any>;
8325
+ version?: number;
8326
+ brand?: DraftBrandDTO;
8327
+ categories?: DraftCategoryToItemRelationshipDTO[];
8328
+ changes?: ItemChangeDTO[];
8329
+ vendor_metadata?: VendorMetadataDTO[];
8330
+ attachments?: FileAttachmentsDTO;
8331
+ weight?: WeightDTO;
8332
+ permissions?: Record<string, any>;
8333
+ [index: string]: any;
8334
+ }
8335
+
8336
+ export interface PostMenuV4ItemDuplicateRequest extends BaseRequest, PostMenuV4ItemDuplicatePath {
8337
+ body: PostMenuV4ItemDuplicateBody;
8338
+ }
8339
+
8014
8340
  // POST /menu/v4/modifier
8015
8341
 
8016
8342
  export interface PostMenuV4ModifierBody {
8017
- base_item_id: string;
8343
+ base_item_id?: string;
8018
8344
  parent?: DraftModifierDTO;
8019
8345
  children?: DraftModifierDTO[];
8020
8346
  modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
@@ -8306,6 +8632,172 @@ export interface DeleteMenuV4ModifierResponse {
8306
8632
 
8307
8633
  export interface DeleteMenuV4ModifierRequest extends BaseRequest, DeleteMenuV4ModifierPath {}
8308
8634
 
8635
+ // POST /menu/v4/modifier/{id}/duplicate
8636
+
8637
+ export interface PostMenuV4ModifierDuplicatePath {
8638
+ id: string;
8639
+ }
8640
+
8641
+ export interface PostMenuV4ModifierDuplicateBody {
8642
+ parent?: DraftModifierDTO;
8643
+ children?: DraftModifierDTO[];
8644
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8645
+ parent_id?: string;
8646
+ name?: string;
8647
+ name_on_receipt?: string;
8648
+ name_on_kds?: string;
8649
+ label?: string;
8650
+ description?: string;
8651
+ price?: number;
8652
+ calories?: number;
8653
+ tax_tags?: string[];
8654
+ is_active?: boolean;
8655
+ posid?: string;
8656
+ reporting?: ReportingMetadataDTO;
8657
+ posid_segment?: number;
8658
+ brand_id?: string;
8659
+ line_route?: string;
8660
+ menu_works?: MenuWorksDTO;
8661
+ is_out_of_stock?: boolean;
8662
+ price_for_none?: number;
8663
+ price_for_less?: number;
8664
+ price_for_more?: number;
8665
+ pre_surcharge?: number;
8666
+ post_surcharge?: number;
8667
+ tax_tag_code?: string;
8668
+ tags?: string[];
8669
+ unique_id?: number;
8670
+ applied_diff_snapshot?: Record<string, any>;
8671
+ brand?: DraftBrandDTO;
8672
+ changes?: ModifierChangeDTO[];
8673
+ vendor_metadata?: VendorMetadataDTO[];
8674
+ weight?: WeightDTO;
8675
+ attachments?: FileAttachmentsDTO;
8676
+ permissions?: Record<string, any>;
8677
+ [index: string]: any;
8678
+ }
8679
+
8680
+ export interface PostMenuV4ModifierDuplicateResponse {
8681
+ parent?: DraftModifierDTO;
8682
+ children?: DraftModifierDTO[];
8683
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8684
+ id: string;
8685
+ created_at?: string;
8686
+ updated_at?: string;
8687
+ deleted_at?: string;
8688
+ parent_id?: string;
8689
+ name: string;
8690
+ name_on_receipt?: string;
8691
+ name_on_kds?: string;
8692
+ label?: string;
8693
+ description?: string;
8694
+ price: number;
8695
+ calories?: number;
8696
+ tax_tags?: string[];
8697
+ is_active?: boolean;
8698
+ posid?: string;
8699
+ reporting: ReportingMetadataDTO;
8700
+ posid_segment?: number;
8701
+ brand_id: string;
8702
+ line_route?: string;
8703
+ menu_works?: MenuWorksDTO;
8704
+ is_out_of_stock?: boolean;
8705
+ price_for_none?: number;
8706
+ price_for_less?: number;
8707
+ price_for_more?: number;
8708
+ pre_surcharge?: number;
8709
+ post_surcharge?: number;
8710
+ tax_tag_code?: string;
8711
+ tags?: string[];
8712
+ unique_id?: number;
8713
+ applied_diff_snapshot?: Record<string, any>;
8714
+ version?: number;
8715
+ brand?: DraftBrandDTO;
8716
+ changes?: ModifierChangeDTO[];
8717
+ vendor_metadata?: VendorMetadataDTO[];
8718
+ weight?: WeightDTO;
8719
+ attachments?: FileAttachmentsDTO;
8720
+ permissions?: Record<string, any>;
8721
+ [index: string]: any;
8722
+ }
8723
+
8724
+ export interface PostMenuV4ModifierDuplicateRequest
8725
+ extends BaseRequest,
8726
+ PostMenuV4ModifierDuplicatePath {
8727
+ body: PostMenuV4ModifierDuplicateBody;
8728
+ }
8729
+
8730
+ // PATCH /menu/v4/modifiers/bulk-update
8731
+
8732
+ export interface PatchMenuV4ModifiersBulkUpdateBody {
8733
+ id_list: string[];
8734
+ parent?: DraftModifierDTO;
8735
+ children?: DraftModifierDTO[];
8736
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
8737
+ id?: string;
8738
+ parent_id?: string;
8739
+ name?: string;
8740
+ name_on_receipt?: string;
8741
+ name_on_kds?: string;
8742
+ label?: string;
8743
+ description?: string;
8744
+ price?: number;
8745
+ calories?: number;
8746
+ tax_tags?: string[];
8747
+ is_active?: boolean;
8748
+ posid?: string;
8749
+ reporting?: ReportingMetadataDTO;
8750
+ posid_segment?: number;
8751
+ brand_id?: string;
8752
+ line_route?: string;
8753
+ menu_works?: MenuWorksDTO;
8754
+ is_out_of_stock?: boolean;
8755
+ price_for_none?: number;
8756
+ price_for_less?: number;
8757
+ price_for_more?: number;
8758
+ pre_surcharge?: number;
8759
+ post_surcharge?: number;
8760
+ tax_tag_code?: string;
8761
+ tags?: string[];
8762
+ unique_id?: number;
8763
+ applied_diff_snapshot?: Record<string, any>;
8764
+ brand?: DraftBrandDTO;
8765
+ changes?: ModifierChangeDTO[];
8766
+ vendor_metadata?: VendorMetadataDTO[];
8767
+ weight?: WeightDTO;
8768
+ attachments?: FileAttachmentsDTO;
8769
+ permissions?: Record<string, any>;
8770
+ [index: string]: any;
8771
+ }
8772
+
8773
+ export interface PatchMenuV4ModifiersBulkUpdateResponse {
8774
+ results?: DraftModifierEntityDTO[];
8775
+ }
8776
+
8777
+ export interface PatchMenuV4ModifiersBulkUpdateRequest extends BaseRequest {
8778
+ body: PatchMenuV4ModifiersBulkUpdateBody;
8779
+ }
8780
+
8781
+ // POST /menu/v4/modifier/{id}/attachment/{name}
8782
+
8783
+ export interface PostMenuV4ModifierAttachmentPath {
8784
+ id: string;
8785
+ name: 'thumbnail';
8786
+ }
8787
+
8788
+ export interface PostMenuV4ModifierAttachmentQuery {
8789
+ 'body.data'?: string;
8790
+ }
8791
+
8792
+ export interface PostMenuV4ModifierAttachmentResponse {
8793
+ status?: string;
8794
+ }
8795
+
8796
+ export interface PostMenuV4ModifierAttachmentRequest
8797
+ extends BaseRequest,
8798
+ RequestQuery<PostMenuV4ModifierAttachmentQuery>,
8799
+ PostMenuV4ModifierAttachmentPath {}
8800
+
8309
8801
  // POST /menu/v4/modifier-group
8310
8802
 
8311
8803
  export interface PostMenuV4ModifierGroupBody {
@@ -8551,3 +9043,75 @@ export interface PostMenuV4ModifierGroupAttachModifiersRequest
8551
9043
  PostMenuV4ModifierGroupAttachModifiersPath {
8552
9044
  body: PostMenuV4ModifierGroupAttachModifiersBody;
8553
9045
  }
9046
+
9047
+ // POST /menu/v4/modifier-group/{id}/duplicate
9048
+
9049
+ export interface PostMenuV4ModifierGroupDuplicatePath {
9050
+ id: string;
9051
+ }
9052
+
9053
+ export interface PostMenuV4ModifierGroupDuplicateQuery {
9054
+ duplicate_modifiers?: boolean;
9055
+ }
9056
+
9057
+ export interface PostMenuV4ModifierGroupDuplicateBody {
9058
+ parent?: DraftModifierGroupDTO;
9059
+ children?: DraftModifierGroupDTO[];
9060
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
9061
+ items?: DraftItemToModifierGroupRelationshipDTO[];
9062
+ parent_id?: string;
9063
+ name?: string;
9064
+ label?: string;
9065
+ min?: number;
9066
+ max?: number;
9067
+ is_active?: boolean;
9068
+ limit?: number;
9069
+ brand_id?: string;
9070
+ order_type?: 'selection' | 'option' | 'quantity';
9071
+ sizing?: string;
9072
+ is_out_of_stock?: boolean;
9073
+ is_incremental?: boolean;
9074
+ applied_diff_snapshot?: Record<string, any>;
9075
+ brand?: DraftBrandDTO;
9076
+ changes?: ModifierGroupChangeDTO[];
9077
+ vendor_metadata?: VendorMetadataDTO[];
9078
+ permissions?: Record<string, any>;
9079
+ [index: string]: any;
9080
+ }
9081
+
9082
+ export interface PostMenuV4ModifierGroupDuplicateResponse {
9083
+ parent?: DraftModifierGroupDTO;
9084
+ children?: DraftModifierGroupDTO[];
9085
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
9086
+ items?: DraftItemToModifierGroupRelationshipDTO[];
9087
+ id: string;
9088
+ created_at?: string;
9089
+ updated_at?: string;
9090
+ deleted_at?: string;
9091
+ parent_id?: string;
9092
+ name: string;
9093
+ label?: string;
9094
+ min?: number;
9095
+ max?: number;
9096
+ is_active?: boolean;
9097
+ limit?: number;
9098
+ brand_id: string;
9099
+ order_type?: 'selection' | 'option' | 'quantity';
9100
+ sizing?: string;
9101
+ is_out_of_stock?: boolean;
9102
+ is_incremental?: boolean;
9103
+ applied_diff_snapshot?: Record<string, any>;
9104
+ version?: number;
9105
+ brand?: DraftBrandDTO;
9106
+ changes?: ModifierGroupChangeDTO[];
9107
+ vendor_metadata?: VendorMetadataDTO[];
9108
+ permissions?: Record<string, any>;
9109
+ [index: string]: any;
9110
+ }
9111
+
9112
+ export interface PostMenuV4ModifierGroupDuplicateRequest
9113
+ extends BaseRequest,
9114
+ RequestQuery<PostMenuV4ModifierGroupDuplicateQuery>,
9115
+ PostMenuV4ModifierGroupDuplicatePath {
9116
+ body: PostMenuV4ModifierGroupDuplicateBody;
9117
+ }