@compassdigital/sdk.typescript 4.93.0 → 4.94.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.
@@ -159,13 +159,13 @@ export interface Item {
159
159
  // menuworks unit id
160
160
  unit_id?: string;
161
161
  // menuworks portion quantity
162
- portion_quantity?: string;
162
+ portion_quantity?: number;
163
163
  // menuworks portion unit name
164
164
  portion_unit_name?: string;
165
165
  // menuworks grams
166
- grams?: string;
166
+ grams?: number;
167
167
  // menuworks cost (per serving)
168
- cost?: string;
168
+ cost?: number;
169
169
  // menuworks ingredients
170
170
  ingredients?: string[];
171
171
  // menuworks smart tags
@@ -173,6 +173,8 @@ export interface Item {
173
173
  // menuworks allergen tags
174
174
  allergen_tags?: string[];
175
175
  };
176
+ // unique id of the entity
177
+ unique_id?: number;
176
178
  [index: string]: any;
177
179
  };
178
180
  category?: {
@@ -306,13 +308,13 @@ export interface Option {
306
308
  // menuworks unit id
307
309
  unit_id?: string;
308
310
  // menuworks portion quantity
309
- portion_quantity?: string;
311
+ portion_quantity?: number;
310
312
  // menuworks portion unit name
311
313
  portion_unit_name?: string;
312
314
  // menuworks grams
313
- grams?: string;
315
+ grams?: number;
314
316
  // menuworks cost (per serving)
315
- cost?: string;
317
+ cost?: number;
316
318
  // menuworks ingredients
317
319
  ingredients?: string[];
318
320
  // menuworks smart tags
@@ -320,6 +322,8 @@ export interface Option {
320
322
  // menuworks allergen tags
321
323
  allergen_tags?: string[];
322
324
  };
325
+ // unique id of the entity
326
+ unique_id?: number;
323
327
  [index: string]: any;
324
328
  };
325
329
  is?: {
@@ -347,10 +351,15 @@ export interface OptionsGroup {
347
351
  hidden?: boolean;
348
352
  out_of_stock?: boolean;
349
353
  incremental?: boolean;
354
+ surcharge_limit?: boolean;
350
355
  };
351
356
  meta?: {
352
357
  // chit sort order
353
358
  sort_number?: number;
359
+ // Type of mod group
360
+ order_type?: 'selection' | 'option' | 'quantity';
361
+ // # of modifiers before surcharge apply
362
+ surcharge_limit_value?: number;
354
363
  // menu sort order
355
364
  menu_sort_number?: number;
356
365
  [index: string]: any;
@@ -442,11 +451,17 @@ export interface DraftBrandDTO {
442
451
  posid_segment?: string;
443
452
  is_simplified_view?: boolean;
444
453
  frictionless_partner?: string;
454
+ catalog_id?: number;
455
+ meta?: BrandMeta;
445
456
  applied_diff_snapshot?: Record<string, any>;
446
457
  permissions?: Record<string, any>;
447
458
  [index: string]: any;
448
459
  }
449
460
 
461
+ export interface BrandMeta {
462
+ jde_category?: string;
463
+ }
464
+
450
465
  export interface PublishedBrandDTO {
451
466
  id?: string;
452
467
  name?: string;
@@ -459,6 +474,8 @@ export interface PublishedBrandDTO {
459
474
  posid_segment?: string;
460
475
  is_simplified_view?: boolean;
461
476
  frictionless_partner?: string;
477
+ catalog_id?: number;
478
+ meta?: Record<string, any>;
462
479
  permissions?: Record<string, any>;
463
480
  [index: string]: any;
464
481
  }
@@ -678,6 +695,7 @@ export interface DraftItemDTO {
678
695
  tags?: string[];
679
696
  is_featured?: boolean;
680
697
  tax_jwo_code?: string;
698
+ unique_id?: number;
681
699
  applied_diff_snapshot?: Record<string, any>;
682
700
  brand?: DraftBrandDTO;
683
701
  categories?: Record<string, any>[];
@@ -782,6 +800,7 @@ export interface DraftModifierDTO {
782
800
  post_surcharge?: number;
783
801
  tax_tag_code?: string;
784
802
  tags?: string[];
803
+ unique_id?: number;
785
804
  applied_diff_snapshot?: Record<string, any>;
786
805
  brand?: DraftBrandDTO;
787
806
  changes?: ModifierChangeDTO[];
@@ -1076,6 +1095,7 @@ export interface PublishedCategoryToItemRelationshipDTO {
1076
1095
  }
1077
1096
 
1078
1097
  export interface PublishedItemDTO {
1098
+ unique_id?: number;
1079
1099
  id?: string;
1080
1100
  parent_id?: string;
1081
1101
  name?: string;
@@ -1143,6 +1163,7 @@ export interface PublishedModifierGroupToModifierRelationshipDTO {
1143
1163
  }
1144
1164
 
1145
1165
  export interface PublishedModifierDTO {
1166
+ unique_id?: number;
1146
1167
  id?: string;
1147
1168
  parent_id?: string;
1148
1169
  name?: string;
@@ -1461,6 +1482,7 @@ export interface DraftItemEntityDTO {
1461
1482
  tags?: string[];
1462
1483
  is_featured?: boolean;
1463
1484
  tax_jwo_code?: string;
1485
+ unique_id?: number;
1464
1486
  applied_diff_snapshot?: Record<string, any>;
1465
1487
  version?: number;
1466
1488
  brand?: DraftBrandDTO;
@@ -1505,6 +1527,7 @@ export interface DraftModifierEntityDTO {
1505
1527
  post_surcharge?: number;
1506
1528
  tax_tag_code?: string;
1507
1529
  tags?: string[];
1530
+ unique_id?: number;
1508
1531
  applied_diff_snapshot?: Record<string, any>;
1509
1532
  version?: number;
1510
1533
  brand?: DraftBrandDTO;
@@ -1561,6 +1584,59 @@ export interface PutUniversalItemEntity {
1561
1584
  price?: number;
1562
1585
  }
1563
1586
 
1587
+ export interface DraftModifierGroupEntityDTO {
1588
+ parent?: DraftModifierGroupDTO;
1589
+ children?: DraftModifierGroupDTO[];
1590
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
1591
+ items?: DraftItemToModifierGroupRelationshipDTO[];
1592
+ id: string;
1593
+ created_at?: string;
1594
+ updated_at?: string;
1595
+ deleted_at?: string;
1596
+ parent_id?: string;
1597
+ name: string;
1598
+ label?: string;
1599
+ min?: number;
1600
+ max?: number;
1601
+ is_active?: boolean;
1602
+ limit?: number;
1603
+ brand_id: string;
1604
+ order_type?: 'selection' | 'option' | 'quantity';
1605
+ sizing?: string;
1606
+ is_out_of_stock?: boolean;
1607
+ is_incremental?: boolean;
1608
+ applied_diff_snapshot?: Record<string, any>;
1609
+ version?: number;
1610
+ brand?: DraftBrandDTO;
1611
+ changes?: ModifierGroupChangeDTO[];
1612
+ vendor_metadata?: VendorMetadataDTO[];
1613
+ permissions?: Record<string, any>;
1614
+ [index: string]: any;
1615
+ }
1616
+
1617
+ export interface CategoryItemRelationshipDTO {
1618
+ parent?: DraftCategoryToItemRelationshipDTO;
1619
+ children?: DraftCategoryToItemRelationshipDTO[];
1620
+ id: string;
1621
+ created_at?: string;
1622
+ updated_at?: string;
1623
+ deleted_at?: string;
1624
+ parent_id?: string;
1625
+ item_id: string;
1626
+ category_id: string;
1627
+ brand_id: string;
1628
+ sequence?: number;
1629
+ applied_diff_snapshot?: Record<string, any>;
1630
+ version?: number;
1631
+ category?: DraftCategoryDTO;
1632
+ item?: DraftItemDTO;
1633
+ brand?: DraftBrandDTO;
1634
+ changes?: CategoryToItemRelationshipChangeDTO[];
1635
+ vendor_metadata?: VendorMetadataDTO[];
1636
+ permissions?: Record<string, any>;
1637
+ [index: string]: any;
1638
+ }
1639
+
1564
1640
  // GET /menu - Get Menus or search for Menus
1565
1641
 
1566
1642
  export interface GetMenusQuery {
@@ -2770,6 +2846,8 @@ export interface PostMenuV3DraftBrandBody {
2770
2846
  posid_segment?: string;
2771
2847
  is_simplified_view?: boolean;
2772
2848
  frictionless_partner?: string;
2849
+ catalog_id?: number;
2850
+ meta?: BrandMeta;
2773
2851
  applied_diff_snapshot?: Record<string, any>;
2774
2852
  changes?: BrandChangeDTO[];
2775
2853
  local_menu_group?: LocalMenuGroupDTO;
@@ -2838,6 +2916,8 @@ export interface PatchMenuV3DraftBrandBody {
2838
2916
  posid_segment?: string;
2839
2917
  is_simplified_view?: boolean;
2840
2918
  frictionless_partner?: string;
2919
+ catalog_id?: number;
2920
+ meta?: BrandMeta;
2841
2921
  applied_diff_snapshot?: Record<string, any>;
2842
2922
  version?: number;
2843
2923
  changes?: BrandChangeDTO[];
@@ -2928,6 +3008,8 @@ export type PostMenuV3DraftBrandsBody = {
2928
3008
  posid_segment?: string;
2929
3009
  is_simplified_view?: boolean;
2930
3010
  frictionless_partner?: string;
3011
+ catalog_id?: number;
3012
+ meta?: BrandMeta;
2931
3013
  applied_diff_snapshot?: Record<string, any>;
2932
3014
  changes?: BrandChangeDTO[];
2933
3015
  local_menu_group?: LocalMenuGroupDTO;
@@ -3373,6 +3455,8 @@ export interface PostMenuV3BrandBody {
3373
3455
  posid_segment?: string;
3374
3456
  is_simplified_view?: boolean;
3375
3457
  frictionless_partner?: string;
3458
+ catalog_id?: number;
3459
+ meta?: BrandMeta;
3376
3460
  local_menu_group?: LocalMenuGroupDTO;
3377
3461
  global_menu_group?: GlobalMenuGroupDTO;
3378
3462
  attachments?: FileAttachmentsDTO;
@@ -3441,6 +3525,8 @@ export interface PatchMenuV3BrandBody {
3441
3525
  posid_segment?: string;
3442
3526
  is_simplified_view?: boolean;
3443
3527
  frictionless_partner?: string;
3528
+ catalog_id?: number;
3529
+ meta?: BrandMeta;
3444
3530
  version?: number;
3445
3531
  local_menu_group?: LocalMenuGroupDTO;
3446
3532
  global_menu_group?: GlobalMenuGroupDTO;
@@ -3533,6 +3619,8 @@ export type PostMenuV3BrandsBody = {
3533
3619
  posid_segment?: string;
3534
3620
  is_simplified_view?: boolean;
3535
3621
  frictionless_partner?: string;
3622
+ catalog_id?: number;
3623
+ meta?: BrandMeta;
3536
3624
  local_menu_group?: LocalMenuGroupDTO;
3537
3625
  global_menu_group?: GlobalMenuGroupDTO;
3538
3626
  attachments?: FileAttachmentsDTO;
@@ -3979,6 +4067,43 @@ export interface GetMenuV3DraftMenusVerifyPublishRequest
3979
4067
  extends BaseRequest,
3980
4068
  RequestQuery<GetMenuV3DraftMenusVerifyPublishQuery> {}
3981
4069
 
4070
+ // POST /menu/v3/draft/menu/{id}/duplicate
4071
+
4072
+ export interface PostMenuV3DraftMenuDuplicatePath {
4073
+ id: string;
4074
+ }
4075
+
4076
+ export interface PostMenuV3DraftMenuDuplicateBody {
4077
+ name?: string;
4078
+ [index: string]: any;
4079
+ }
4080
+
4081
+ export interface PostMenuV3DraftMenuDuplicateResponse {
4082
+ parent?: DraftMenuDTO;
4083
+ children?: DraftMenuDTO[];
4084
+ categories?: DraftCategoryDTO[];
4085
+ id: string;
4086
+ created_at?: string;
4087
+ updated_at?: string;
4088
+ deleted_at?: string;
4089
+ parent_id?: string;
4090
+ name: string;
4091
+ brand_id: string;
4092
+ applied_diff_snapshot?: Record<string, any>;
4093
+ version?: number;
4094
+ brand?: DraftBrandDTO;
4095
+ changes?: MenuChangeDTO[];
4096
+ vendor_metadata?: VendorMetadataDTO[];
4097
+ permissions?: Record<string, any>;
4098
+ [index: string]: any;
4099
+ }
4100
+
4101
+ export interface PostMenuV3DraftMenuDuplicateRequest
4102
+ extends BaseRequest,
4103
+ PostMenuV3DraftMenuDuplicatePath {
4104
+ body: PostMenuV3DraftMenuDuplicateBody;
4105
+ }
4106
+
3982
4107
  // GET /menu/v3/menu/{id}
3983
4108
 
3984
4109
  export interface GetMenuV3MenuPath {
@@ -4321,6 +4446,53 @@ export interface PostMenuV3DraftCategoryAttachmentRequest
4321
4446
  RequestQuery<PostMenuV3DraftCategoryAttachmentQuery>,
4322
4447
  PostMenuV3DraftCategoryAttachmentPath {}
4323
4448
 
4449
+ // POST /menu/v3/draft/category/{id}/duplicate
4450
+
4451
+ export interface PostMenuV3DraftCategoryDuplicatePath {
4452
+ id: string;
4453
+ }
4454
+
4455
+ export interface PostMenuV3DraftCategoryDuplicateBody {
4456
+ name?: string;
4457
+ label?: string;
4458
+ sequence?: number;
4459
+ is_active?: boolean;
4460
+ menu_id?: string;
4461
+ [index: string]: any;
4462
+ }
4463
+
4464
+ export interface PostMenuV3DraftCategoryDuplicateResponse {
4465
+ parent?: DraftCategoryDTO;
4466
+ children?: DraftCategoryDTO[];
4467
+ id: string;
4468
+ created_at?: string;
4469
+ updated_at?: string;
4470
+ deleted_at?: string;
4471
+ parent_id?: string;
4472
+ name: string;
4473
+ label?: string;
4474
+ sequence?: number;
4475
+ is_active?: boolean;
4476
+ brand_id: string;
4477
+ menu_id: string;
4478
+ applied_diff_snapshot?: Record<string, any>;
4479
+ version?: number;
4480
+ menu?: DraftMenuDTO;
4481
+ items?: DraftCategoryToItemRelationshipDTO[];
4482
+ brand?: DraftBrandDTO;
4483
+ changes?: CategoryChangeDTO[];
4484
+ vendor_metadata?: VendorMetadataDTO[];
4485
+ attachments?: FileAttachmentsDTO;
4486
+ permissions?: Record<string, any>;
4487
+ [index: string]: any;
4488
+ }
4489
+
4490
+ export interface PostMenuV3DraftCategoryDuplicateRequest
4491
+ extends BaseRequest,
4492
+ PostMenuV3DraftCategoryDuplicatePath {
4493
+ body: PostMenuV3DraftCategoryDuplicateBody;
4494
+ }
4495
+
4324
4496
  // GET /menu/v3/category/{id}
4325
4497
 
4326
4498
  export interface GetMenuV3CategoryPath {
@@ -4692,6 +4864,7 @@ export interface PostMenuV3DraftItemBody {
4692
4864
  tags?: string[];
4693
4865
  is_featured?: boolean;
4694
4866
  tax_jwo_code?: string;
4867
+ unique_id?: number;
4695
4868
  applied_diff_snapshot?: Record<string, any>;
4696
4869
  brand?: DraftBrandDTO;
4697
4870
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4765,6 +4938,7 @@ export interface PatchMenuV3DraftItemBody {
4765
4938
  tags?: string[];
4766
4939
  is_featured?: boolean;
4767
4940
  tax_jwo_code?: string;
4941
+ unique_id?: number;
4768
4942
  applied_diff_snapshot?: Record<string, any>;
4769
4943
  version?: number;
4770
4944
  brand?: DraftBrandDTO;
@@ -4877,6 +5051,7 @@ export type PostMenuV3DraftItemsBody = {
4877
5051
  tags?: string[];
4878
5052
  is_featured?: boolean;
4879
5053
  tax_jwo_code?: string;
5054
+ unique_id?: number;
4880
5055
  applied_diff_snapshot?: Record<string, any>;
4881
5056
  brand?: DraftBrandDTO;
4882
5057
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -4980,6 +5155,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
4980
5155
  tags?: string[];
4981
5156
  is_featured?: boolean;
4982
5157
  tax_jwo_code?: string;
5158
+ unique_id?: number;
4983
5159
  applied_diff_snapshot?: Record<string, any>;
4984
5160
  brand?: DraftBrandDTO;
4985
5161
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -6112,6 +6288,7 @@ export interface PostMenuV3DraftModifierBody {
6112
6288
  post_surcharge?: number;
6113
6289
  tax_tag_code?: string;
6114
6290
  tags?: string[];
6291
+ unique_id?: number;
6115
6292
  applied_diff_snapshot?: Record<string, any>;
6116
6293
  brand?: DraftBrandDTO;
6117
6294
  changes?: ModifierChangeDTO[];
@@ -6185,6 +6362,7 @@ export interface PatchMenuV3DraftModifierBody {
6185
6362
  post_surcharge?: number;
6186
6363
  tax_tag_code?: string;
6187
6364
  tags?: string[];
6365
+ unique_id?: number;
6188
6366
  applied_diff_snapshot?: Record<string, any>;
6189
6367
  version?: number;
6190
6368
  brand?: DraftBrandDTO;
@@ -6297,6 +6475,7 @@ export type PostMenuV3DraftModifiersBody = {
6297
6475
  post_surcharge?: number;
6298
6476
  tax_tag_code?: string;
6299
6477
  tags?: string[];
6478
+ unique_id?: number;
6300
6479
  applied_diff_snapshot?: Record<string, any>;
6301
6480
  brand?: DraftBrandDTO;
6302
6481
  changes?: ModifierChangeDTO[];
@@ -6400,6 +6579,7 @@ export interface PatchMenuV3DraftModifiersBulkUpdateBody {
6400
6579
  post_surcharge?: number;
6401
6580
  tax_tag_code?: string;
6402
6581
  tags?: string[];
6582
+ unique_id?: number;
6403
6583
  applied_diff_snapshot?: Record<string, any>;
6404
6584
  brand?: DraftBrandDTO;
6405
6585
  changes?: ModifierChangeDTO[];
@@ -6794,7 +6974,38 @@ export interface PostMenuV3TriggerUpdateRequest extends BaseRequest {}
6794
6974
  // POST /menu/v4/brand
6795
6975
 
6796
6976
  export interface PostMenuV4BrandBody {
6797
- name?: string;
6977
+ parent?: DraftBrandDTO;
6978
+ children?: DraftBrandDTO[];
6979
+ menus?: DraftMenuDTO[];
6980
+ categories?: DraftCategoryDTO[];
6981
+ category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
6982
+ items?: DraftItemDTO[];
6983
+ item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
6984
+ modifier_groups?: DraftModifierGroupDTO[];
6985
+ modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
6986
+ modifiers?: DraftModifierDTO[];
6987
+ statuses?: BrandStatusDTO[];
6988
+ audit_logs?: AuditDTO[];
6989
+ name: string;
6990
+ description?: string;
6991
+ is_active?: boolean;
6992
+ type?: 'global' | 'local';
6993
+ parent_id?: string;
6994
+ local_menu_group_id?: string;
6995
+ global_menu_group_id?: string;
6996
+ posid_segment?: string;
6997
+ is_simplified_view?: boolean;
6998
+ frictionless_partner?: string;
6999
+ catalog_id?: number;
7000
+ meta?: BrandMeta;
7001
+ applied_diff_snapshot?: Record<string, any>;
7002
+ changes?: BrandChangeDTO[];
7003
+ local_menu_group?: LocalMenuGroupDTO;
7004
+ global_menu_group?: GlobalMenuGroupDTO;
7005
+ vendor_metadata?: VendorMetadataDTO[];
7006
+ attachments?: FileAttachmentsDTO;
7007
+ permissions?: Record<string, any>;
7008
+ [index: string]: any;
6798
7009
  }
6799
7010
 
6800
7011
  export interface PostMenuV4BrandResponse {
@@ -6824,6 +7035,8 @@ export interface PostMenuV4BrandResponse {
6824
7035
  posid_segment?: string;
6825
7036
  is_simplified_view?: boolean;
6826
7037
  frictionless_partner?: string;
7038
+ catalog_id?: number;
7039
+ meta?: BrandMeta;
6827
7040
  applied_diff_snapshot?: Record<string, any>;
6828
7041
  version?: number;
6829
7042
  changes?: BrandChangeDTO[];
@@ -6877,6 +7090,8 @@ export interface GetMenuV4BrandResponse {
6877
7090
  posid_segment?: string;
6878
7091
  is_simplified_view?: boolean;
6879
7092
  frictionless_partner?: string;
7093
+ catalog_id?: number;
7094
+ meta?: BrandMeta;
6880
7095
  applied_diff_snapshot?: Record<string, any>;
6881
7096
  version?: number;
6882
7097
  changes?: BrandChangeDTO[];
@@ -6892,3 +7107,1052 @@ export interface GetMenuV4BrandRequest
6892
7107
  extends BaseRequest,
6893
7108
  RequestQuery<GetMenuV4BrandQuery>,
6894
7109
  GetMenuV4BrandPath {}
7110
+
7111
+ // POST /menu/v4/brand/{id}/menu
7112
+
7113
+ export interface PostMenuV4BrandMenuPath {
7114
+ id: string;
7115
+ }
7116
+
7117
+ export interface PostMenuV4BrandMenuBody {
7118
+ parent?: DraftMenuDTO;
7119
+ children?: DraftMenuDTO[];
7120
+ categories?: DraftCategoryDTO[];
7121
+ parent_id?: string;
7122
+ name: string;
7123
+ brand_id: string;
7124
+ applied_diff_snapshot?: Record<string, any>;
7125
+ brand?: DraftBrandDTO;
7126
+ changes?: MenuChangeDTO[];
7127
+ vendor_metadata?: VendorMetadataDTO[];
7128
+ permissions?: Record<string, any>;
7129
+ [index: string]: any;
7130
+ }
7131
+
7132
+ export interface PostMenuV4BrandMenuResponse {
7133
+ parent?: DraftMenuDTO;
7134
+ children?: DraftMenuDTO[];
7135
+ categories?: DraftCategoryDTO[];
7136
+ id: string;
7137
+ created_at?: string;
7138
+ updated_at?: string;
7139
+ deleted_at?: string;
7140
+ parent_id?: string;
7141
+ name: string;
7142
+ brand_id: string;
7143
+ applied_diff_snapshot?: Record<string, any>;
7144
+ version?: number;
7145
+ brand?: DraftBrandDTO;
7146
+ changes?: MenuChangeDTO[];
7147
+ vendor_metadata?: VendorMetadataDTO[];
7148
+ permissions?: Record<string, any>;
7149
+ [index: string]: any;
7150
+ }
7151
+
7152
+ export interface PostMenuV4BrandMenuRequest extends BaseRequest, PostMenuV4BrandMenuPath {
7153
+ body: PostMenuV4BrandMenuBody;
7154
+ }
7155
+
7156
+ // GET /menu/v4/brand/{id}/items
7157
+
7158
+ export interface GetMenuV4BrandItemsPath {
7159
+ id: string;
7160
+ }
7161
+
7162
+ export interface GetMenuV4BrandItemsQuery {
7163
+ filter?: string;
7164
+ // If specified, only the selected fields will be returned
7165
+ select?: string[];
7166
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
7167
+ relationships?: string[];
7168
+ // Number of records to load per page
7169
+ limit?: number;
7170
+ page?: number;
7171
+ // A field to sort the results based on
7172
+ sort_by?: string;
7173
+ sort_order?: 'DESC' | 'ASC';
7174
+ // How soft deleted records should be shown in the list
7175
+ soft_deleted?: 'include' | 'exclude' | 'only';
7176
+ // Graphql query string
7177
+ _query?: string;
7178
+ }
7179
+
7180
+ export interface GetMenuV4BrandItemsResponse {
7181
+ results: DraftItemEntityDTO[];
7182
+ meta?: ListResponseMetadataDTO;
7183
+ [index: string]: any;
7184
+ }
7185
+
7186
+ export interface GetMenuV4BrandItemsRequest
7187
+ extends BaseRequest,
7188
+ RequestQuery<GetMenuV4BrandItemsQuery>,
7189
+ GetMenuV4BrandItemsPath {}
7190
+
7191
+ // GET /menu/v4/brand/{id}/modifier-groups
7192
+
7193
+ export interface GetMenuV4BrandModifierGroupsPath {
7194
+ id: string;
7195
+ }
7196
+
7197
+ export interface GetMenuV4BrandModifierGroupsQuery {
7198
+ filter?: string;
7199
+ // If specified, only the selected fields will be returned
7200
+ select?: string[];
7201
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
7202
+ relationships?: string[];
7203
+ // Number of records to load per page
7204
+ limit?: number;
7205
+ page?: number;
7206
+ // A field to sort the results based on
7207
+ sort_by?: string;
7208
+ sort_order?: 'DESC' | 'ASC';
7209
+ // How soft deleted records should be shown in the list
7210
+ soft_deleted?: 'include' | 'exclude' | 'only';
7211
+ // Graphql query string
7212
+ _query?: string;
7213
+ }
7214
+
7215
+ export interface GetMenuV4BrandModifierGroupsResponse {
7216
+ results: DraftModifierGroupEntityDTO[];
7217
+ meta?: ListResponseMetadataDTO;
7218
+ [index: string]: any;
7219
+ }
7220
+
7221
+ export interface GetMenuV4BrandModifierGroupsRequest
7222
+ extends BaseRequest,
7223
+ RequestQuery<GetMenuV4BrandModifierGroupsQuery>,
7224
+ GetMenuV4BrandModifierGroupsPath {}
7225
+
7226
+ // GET /menu/v4/brand/{id}/modifiers
7227
+
7228
+ export interface GetMenuV4BrandModifiersPath {
7229
+ id: string;
7230
+ }
7231
+
7232
+ export interface GetMenuV4BrandModifiersQuery {
7233
+ filter?: string;
7234
+ // If specified, only the selected fields will be returned
7235
+ select?: string[];
7236
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
7237
+ relationships?: string[];
7238
+ // Number of records to load per page
7239
+ limit?: number;
7240
+ page?: number;
7241
+ // A field to sort the results based on
7242
+ sort_by?: string;
7243
+ sort_order?: 'DESC' | 'ASC';
7244
+ // How soft deleted records should be shown in the list
7245
+ soft_deleted?: 'include' | 'exclude' | 'only';
7246
+ // Graphql query string
7247
+ _query?: string;
7248
+ }
7249
+
7250
+ export interface GetMenuV4BrandModifiersResponse {
7251
+ results: DraftModifierEntityDTO[];
7252
+ meta?: ListResponseMetadataDTO;
7253
+ [index: string]: any;
7254
+ }
7255
+
7256
+ export interface GetMenuV4BrandModifiersRequest
7257
+ extends BaseRequest,
7258
+ RequestQuery<GetMenuV4BrandModifiersQuery>,
7259
+ GetMenuV4BrandModifiersPath {}
7260
+
7261
+ // GET /menu/v4/brand/{id}/category/{category_id}/items
7262
+
7263
+ export interface GetMenuV4BrandCategoryItemsPath {
7264
+ id: string;
7265
+ category_id: string;
7266
+ }
7267
+
7268
+ export interface GetMenuV4BrandCategoryItemsQuery {
7269
+ filter?: string;
7270
+ // If specified, only the selected fields will be returned
7271
+ select?: string[];
7272
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
7273
+ relationships?: string[];
7274
+ // Number of records to load per page
7275
+ limit?: number;
7276
+ page?: number;
7277
+ // A field to sort the results based on
7278
+ sort_by?: string;
7279
+ sort_order?: 'DESC' | 'ASC';
7280
+ // How soft deleted records should be shown in the list
7281
+ soft_deleted?: 'include' | 'exclude' | 'only';
7282
+ // Graphql query string
7283
+ _query?: string;
7284
+ }
7285
+
7286
+ export interface GetMenuV4BrandCategoryItemsResponse {
7287
+ results: CategoryItemRelationshipDTO[];
7288
+ meta?: ListResponseMetadataDTO;
7289
+ [index: string]: any;
7290
+ }
7291
+
7292
+ export interface GetMenuV4BrandCategoryItemsRequest
7293
+ extends BaseRequest,
7294
+ RequestQuery<GetMenuV4BrandCategoryItemsQuery>,
7295
+ GetMenuV4BrandCategoryItemsPath {}
7296
+
7297
+ // POST /menu/v4/brand/{id}/category
7298
+
7299
+ export interface PostMenuV4BrandCategoryPath {
7300
+ id: string;
7301
+ }
7302
+
7303
+ export interface PostMenuV4BrandCategoryBody {
7304
+ parent?: DraftCategoryDTO;
7305
+ children?: DraftCategoryDTO[];
7306
+ parent_id?: string;
7307
+ name: string;
7308
+ label?: string;
7309
+ sequence?: number;
7310
+ is_active?: boolean;
7311
+ brand_id: string;
7312
+ menu_id: string;
7313
+ applied_diff_snapshot?: Record<string, any>;
7314
+ menu?: DraftMenuDTO;
7315
+ items?: DraftCategoryToItemRelationshipDTO[];
7316
+ brand?: DraftBrandDTO;
7317
+ changes?: CategoryChangeDTO[];
7318
+ vendor_metadata?: VendorMetadataDTO[];
7319
+ attachments?: FileAttachmentsDTO;
7320
+ permissions?: Record<string, any>;
7321
+ [index: string]: any;
7322
+ }
7323
+
7324
+ export interface PostMenuV4BrandCategoryResponse {
7325
+ parent?: DraftCategoryDTO;
7326
+ children?: DraftCategoryDTO[];
7327
+ id: string;
7328
+ created_at?: string;
7329
+ updated_at?: string;
7330
+ deleted_at?: string;
7331
+ parent_id?: string;
7332
+ name: string;
7333
+ label?: string;
7334
+ sequence?: number;
7335
+ is_active?: boolean;
7336
+ brand_id: string;
7337
+ menu_id: string;
7338
+ applied_diff_snapshot?: Record<string, any>;
7339
+ version?: number;
7340
+ menu?: DraftMenuDTO;
7341
+ items?: DraftCategoryToItemRelationshipDTO[];
7342
+ brand?: DraftBrandDTO;
7343
+ changes?: CategoryChangeDTO[];
7344
+ vendor_metadata?: VendorMetadataDTO[];
7345
+ attachments?: FileAttachmentsDTO;
7346
+ permissions?: Record<string, any>;
7347
+ [index: string]: any;
7348
+ }
7349
+
7350
+ export interface PostMenuV4BrandCategoryRequest extends BaseRequest, PostMenuV4BrandCategoryPath {
7351
+ body: PostMenuV4BrandCategoryBody;
7352
+ }
7353
+
7354
+ // PATCH /menu/v4/brand/{brand_id}/category/{category_id}
7355
+
7356
+ export interface PatchMenuV4BrandCategoryPath {
7357
+ brand_id: string;
7358
+ category_id: string;
7359
+ }
7360
+
7361
+ export interface PatchMenuV4BrandCategoryBody {
7362
+ parent?: DraftCategoryDTO;
7363
+ children?: DraftCategoryDTO[];
7364
+ id?: string;
7365
+ parent_id?: string;
7366
+ name?: string;
7367
+ label?: string;
7368
+ sequence?: number;
7369
+ is_active?: boolean;
7370
+ brand_id?: string;
7371
+ menu_id?: string;
7372
+ applied_diff_snapshot?: Record<string, any>;
7373
+ version?: number;
7374
+ menu?: DraftMenuDTO;
7375
+ items?: DraftCategoryToItemRelationshipDTO[];
7376
+ brand?: DraftBrandDTO;
7377
+ changes?: CategoryChangeDTO[];
7378
+ vendor_metadata?: VendorMetadataDTO[];
7379
+ attachments?: FileAttachmentsDTO;
7380
+ permissions?: Record<string, any>;
7381
+ [index: string]: any;
7382
+ }
7383
+
7384
+ export interface PatchMenuV4BrandCategoryResponse {
7385
+ parent?: DraftCategoryDTO;
7386
+ children?: DraftCategoryDTO[];
7387
+ parent_id?: string;
7388
+ name: string;
7389
+ label?: string;
7390
+ sequence?: number;
7391
+ is_active?: boolean;
7392
+ brand_id: string;
7393
+ menu_id: string;
7394
+ applied_diff_snapshot?: Record<string, any>;
7395
+ menu?: DraftMenuDTO;
7396
+ items?: DraftCategoryToItemRelationshipDTO[];
7397
+ brand?: DraftBrandDTO;
7398
+ changes?: CategoryChangeDTO[];
7399
+ vendor_metadata?: VendorMetadataDTO[];
7400
+ attachments?: FileAttachmentsDTO;
7401
+ permissions?: Record<string, any>;
7402
+ [index: string]: any;
7403
+ }
7404
+
7405
+ export interface PatchMenuV4BrandCategoryRequest extends BaseRequest, PatchMenuV4BrandCategoryPath {
7406
+ body: PatchMenuV4BrandCategoryBody;
7407
+ }
7408
+
7409
+ // POST /menu/v4/brand/{id}/category/attach-items
7410
+
7411
+ export interface PostMenuV4BrandCategoryAttachItemsPath {
7412
+ id: string;
7413
+ }
7414
+
7415
+ export type PostMenuV4BrandCategoryAttachItemsBody = {
7416
+ parent?: DraftCategoryToItemRelationshipDTO;
7417
+ children?: DraftCategoryToItemRelationshipDTO[];
7418
+ parent_id?: string;
7419
+ item_id: string;
7420
+ category_id: string;
7421
+ brand_id: string;
7422
+ sequence?: number;
7423
+ applied_diff_snapshot?: Record<string, any>;
7424
+ category?: DraftCategoryDTO;
7425
+ item?: DraftItemDTO;
7426
+ brand?: DraftBrandDTO;
7427
+ changes?: CategoryToItemRelationshipChangeDTO[];
7428
+ vendor_metadata?: VendorMetadataDTO[];
7429
+ permissions?: Record<string, any>;
7430
+ [index: string]: any;
7431
+ }[];
7432
+
7433
+ export interface PostMenuV4BrandCategoryAttachItemsResponse {
7434
+ status?: string;
7435
+ }
7436
+
7437
+ export interface PostMenuV4BrandCategoryAttachItemsRequest
7438
+ extends BaseRequest,
7439
+ PostMenuV4BrandCategoryAttachItemsPath {
7440
+ body: PostMenuV4BrandCategoryAttachItemsBody;
7441
+ }
7442
+
7443
+ // POST menu/v4/brand/{id}/publish
7444
+
7445
+ export interface PostMenuV4BrandPublishPath {
7446
+ id: string;
7447
+ }
7448
+
7449
+ export interface PostMenuV4BrandPublishResponse {
7450
+ status?: string;
7451
+ }
7452
+
7453
+ export interface PostMenuV4BrandPublishRequest extends BaseRequest, PostMenuV4BrandPublishPath {}
7454
+
7455
+ // POST menu/v4/brand/{id}/v3-to-v4
7456
+
7457
+ export interface PostMenuV4BrandV3ToV4Path {
7458
+ id: string;
7459
+ }
7460
+
7461
+ export interface PostMenuV4BrandV3ToV4Response {
7462
+ status?: string;
7463
+ }
7464
+
7465
+ export interface PostMenuV4BrandV3ToV4Request extends BaseRequest, PostMenuV4BrandV3ToV4Path {}
7466
+
7467
+ // POST /menu/v4/item
7468
+
7469
+ export interface PostMenuV4ItemBody {
7470
+ parent?: DraftItemDTO;
7471
+ children?: DraftItemDTO[];
7472
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
7473
+ parent_id?: string;
7474
+ name: string;
7475
+ name_on_receipt?: string;
7476
+ name_on_kds?: string;
7477
+ label?: string;
7478
+ description?: string;
7479
+ reporting: ReportingMetadataDTO;
7480
+ price: number;
7481
+ barcode?: string;
7482
+ calories?: number;
7483
+ meal_value?: number;
7484
+ is_active?: boolean;
7485
+ posid?: string;
7486
+ tax_tags?: string[];
7487
+ brand_id: string;
7488
+ line_route?: string;
7489
+ posid_segment?: number;
7490
+ menu_works?: MenuWorksDTO;
7491
+ is_out_of_stock?: boolean;
7492
+ tax_tag_code?: string;
7493
+ tags?: string[];
7494
+ is_featured?: boolean;
7495
+ tax_jwo_code?: string;
7496
+ unique_id?: number;
7497
+ base_item_id?: string;
7498
+ applied_diff_snapshot?: Record<string, any>;
7499
+ brand?: DraftBrandDTO;
7500
+ categories?: DraftCategoryToItemRelationshipDTO[];
7501
+ changes?: ItemChangeDTO[];
7502
+ vendor_metadata?: VendorMetadataDTO[];
7503
+ attachments?: FileAttachmentsDTO;
7504
+ weight?: WeightDTO;
7505
+ permissions?: Record<string, any>;
7506
+ [index: string]: any;
7507
+ }
7508
+
7509
+ export interface PostMenuV4ItemResponse {
7510
+ parent?: DraftItemDTO;
7511
+ children?: DraftItemDTO[];
7512
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
7513
+ id: string;
7514
+ created_at?: string;
7515
+ updated_at?: string;
7516
+ deleted_at?: string;
7517
+ parent_id?: string;
7518
+ name: string;
7519
+ name_on_receipt?: string;
7520
+ name_on_kds?: string;
7521
+ label?: string;
7522
+ description?: string;
7523
+ reporting: ReportingMetadataDTO;
7524
+ price: number;
7525
+ barcode?: string;
7526
+ calories?: number;
7527
+ meal_value?: number;
7528
+ is_active?: boolean;
7529
+ posid?: string;
7530
+ tax_tags?: string[];
7531
+ brand_id: string;
7532
+ line_route?: string;
7533
+ posid_segment?: number;
7534
+ menu_works?: MenuWorksDTO;
7535
+ is_out_of_stock?: boolean;
7536
+ tax_tag_code?: string;
7537
+ tags?: string[];
7538
+ is_featured?: boolean;
7539
+ tax_jwo_code?: string;
7540
+ unique_id?: number;
7541
+ applied_diff_snapshot?: Record<string, any>;
7542
+ version?: number;
7543
+ brand?: DraftBrandDTO;
7544
+ categories?: DraftCategoryToItemRelationshipDTO[];
7545
+ changes?: ItemChangeDTO[];
7546
+ vendor_metadata?: VendorMetadataDTO[];
7547
+ attachments?: FileAttachmentsDTO;
7548
+ weight?: WeightDTO;
7549
+ permissions?: Record<string, any>;
7550
+ [index: string]: any;
7551
+ }
7552
+
7553
+ export interface PostMenuV4ItemRequest extends BaseRequest {
7554
+ body: PostMenuV4ItemBody;
7555
+ }
7556
+
7557
+ // GET /menu/v4/item/{id}
7558
+
7559
+ export interface GetMenuV4ItemPath {
7560
+ id: string;
7561
+ }
7562
+
7563
+ export interface GetMenuV4ItemQuery {
7564
+ // Graphql query string
7565
+ _query?: string;
7566
+ }
7567
+
7568
+ export interface GetMenuV4ItemResponse {
7569
+ parent?: DraftItemDTO;
7570
+ children?: DraftItemDTO[];
7571
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
7572
+ id: string;
7573
+ created_at?: string;
7574
+ updated_at?: string;
7575
+ deleted_at?: string;
7576
+ parent_id?: string;
7577
+ name: string;
7578
+ name_on_receipt?: string;
7579
+ name_on_kds?: string;
7580
+ label?: string;
7581
+ description?: string;
7582
+ reporting: ReportingMetadataDTO;
7583
+ price: number;
7584
+ barcode?: string;
7585
+ calories?: number;
7586
+ meal_value?: number;
7587
+ is_active?: boolean;
7588
+ posid?: string;
7589
+ tax_tags?: string[];
7590
+ brand_id: string;
7591
+ line_route?: string;
7592
+ posid_segment?: number;
7593
+ menu_works?: MenuWorksDTO;
7594
+ is_out_of_stock?: boolean;
7595
+ tax_tag_code?: string;
7596
+ tags?: string[];
7597
+ is_featured?: boolean;
7598
+ tax_jwo_code?: string;
7599
+ unique_id?: number;
7600
+ applied_diff_snapshot?: Record<string, any>;
7601
+ version?: number;
7602
+ brand?: DraftBrandDTO;
7603
+ categories?: DraftCategoryToItemRelationshipDTO[];
7604
+ changes?: ItemChangeDTO[];
7605
+ vendor_metadata?: VendorMetadataDTO[];
7606
+ attachments?: FileAttachmentsDTO;
7607
+ weight?: WeightDTO;
7608
+ permissions?: Record<string, any>;
7609
+ [index: string]: any;
7610
+ }
7611
+
7612
+ export interface GetMenuV4ItemRequest
7613
+ extends BaseRequest,
7614
+ RequestQuery<GetMenuV4ItemQuery>,
7615
+ GetMenuV4ItemPath {}
7616
+
7617
+ // PATCH /menu/v4/item/{id}
7618
+
7619
+ export interface PatchMenuV4ItemPath {
7620
+ id: string;
7621
+ }
7622
+
7623
+ export interface PatchMenuV4ItemBody {
7624
+ base_item_id?: string;
7625
+ parent?: DraftItemDTO;
7626
+ children?: DraftItemDTO[];
7627
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
7628
+ parent_id?: string;
7629
+ name?: string;
7630
+ name_on_receipt?: string;
7631
+ name_on_kds?: string;
7632
+ label?: string;
7633
+ description?: string;
7634
+ reporting?: ReportingMetadataDTO;
7635
+ price?: number;
7636
+ barcode?: string;
7637
+ calories?: number;
7638
+ meal_value?: number;
7639
+ is_active?: boolean;
7640
+ posid?: string;
7641
+ tax_tags?: string[];
7642
+ brand_id?: string;
7643
+ line_route?: string;
7644
+ posid_segment?: number;
7645
+ menu_works?: MenuWorksDTO;
7646
+ is_out_of_stock?: boolean;
7647
+ tax_tag_code?: string;
7648
+ tags?: string[];
7649
+ is_featured?: boolean;
7650
+ tax_jwo_code?: string;
7651
+ unique_id?: number;
7652
+ applied_diff_snapshot?: Record<string, any>;
7653
+ brand?: DraftBrandDTO;
7654
+ categories?: DraftCategoryToItemRelationshipDTO[];
7655
+ changes?: ItemChangeDTO[];
7656
+ vendor_metadata?: VendorMetadataDTO[];
7657
+ attachments?: FileAttachmentsDTO;
7658
+ weight?: WeightDTO;
7659
+ permissions?: Record<string, any>;
7660
+ [index: string]: any;
7661
+ }
7662
+
7663
+ export interface PatchMenuV4ItemResponse {
7664
+ parent?: DraftItemDTO;
7665
+ children?: DraftItemDTO[];
7666
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
7667
+ id: string;
7668
+ created_at?: string;
7669
+ updated_at?: string;
7670
+ deleted_at?: string;
7671
+ parent_id?: string;
7672
+ name: string;
7673
+ name_on_receipt?: string;
7674
+ name_on_kds?: string;
7675
+ label?: string;
7676
+ description?: string;
7677
+ reporting: ReportingMetadataDTO;
7678
+ price: number;
7679
+ barcode?: string;
7680
+ calories?: number;
7681
+ meal_value?: number;
7682
+ is_active?: boolean;
7683
+ posid?: string;
7684
+ tax_tags?: string[];
7685
+ brand_id: string;
7686
+ line_route?: string;
7687
+ posid_segment?: number;
7688
+ menu_works?: MenuWorksDTO;
7689
+ is_out_of_stock?: boolean;
7690
+ tax_tag_code?: string;
7691
+ tags?: string[];
7692
+ is_featured?: boolean;
7693
+ tax_jwo_code?: string;
7694
+ unique_id?: number;
7695
+ applied_diff_snapshot?: Record<string, any>;
7696
+ version?: number;
7697
+ brand?: DraftBrandDTO;
7698
+ categories?: DraftCategoryToItemRelationshipDTO[];
7699
+ changes?: ItemChangeDTO[];
7700
+ vendor_metadata?: VendorMetadataDTO[];
7701
+ attachments?: FileAttachmentsDTO;
7702
+ weight?: WeightDTO;
7703
+ permissions?: Record<string, any>;
7704
+ [index: string]: any;
7705
+ }
7706
+
7707
+ export interface PatchMenuV4ItemRequest extends BaseRequest, PatchMenuV4ItemPath {
7708
+ body: PatchMenuV4ItemBody;
7709
+ }
7710
+
7711
+ // POST /menu/v4/modifier
7712
+
7713
+ export interface PostMenuV4ModifierBody {
7714
+ base_item_id: string;
7715
+ parent?: DraftModifierDTO;
7716
+ children?: DraftModifierDTO[];
7717
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
7718
+ parent_id?: string;
7719
+ name: string;
7720
+ name_on_receipt?: string;
7721
+ name_on_kds?: string;
7722
+ label?: string;
7723
+ description?: string;
7724
+ price: number;
7725
+ calories?: number;
7726
+ tax_tags?: string[];
7727
+ is_active?: boolean;
7728
+ posid?: string;
7729
+ reporting: ReportingMetadataDTO;
7730
+ posid_segment?: number;
7731
+ brand_id: string;
7732
+ line_route?: string;
7733
+ menu_works?: MenuWorksDTO;
7734
+ is_out_of_stock?: boolean;
7735
+ price_for_none?: number;
7736
+ price_for_less?: number;
7737
+ price_for_more?: number;
7738
+ pre_surcharge?: number;
7739
+ post_surcharge?: number;
7740
+ tax_tag_code?: string;
7741
+ tags?: string[];
7742
+ unique_id?: number;
7743
+ applied_diff_snapshot?: Record<string, any>;
7744
+ brand?: DraftBrandDTO;
7745
+ changes?: ModifierChangeDTO[];
7746
+ vendor_metadata?: VendorMetadataDTO[];
7747
+ weight?: WeightDTO;
7748
+ attachments?: FileAttachmentsDTO;
7749
+ permissions?: Record<string, any>;
7750
+ [index: string]: any;
7751
+ }
7752
+
7753
+ export interface PostMenuV4ModifierResponse {
7754
+ parent?: DraftModifierDTO;
7755
+ children?: DraftModifierDTO[];
7756
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
7757
+ id: string;
7758
+ created_at?: string;
7759
+ updated_at?: string;
7760
+ deleted_at?: string;
7761
+ parent_id?: string;
7762
+ name: string;
7763
+ name_on_receipt?: string;
7764
+ name_on_kds?: string;
7765
+ label?: string;
7766
+ description?: string;
7767
+ price: number;
7768
+ calories?: number;
7769
+ tax_tags?: string[];
7770
+ is_active?: boolean;
7771
+ posid?: string;
7772
+ reporting: ReportingMetadataDTO;
7773
+ posid_segment?: number;
7774
+ brand_id: string;
7775
+ line_route?: string;
7776
+ menu_works?: MenuWorksDTO;
7777
+ is_out_of_stock?: boolean;
7778
+ price_for_none?: number;
7779
+ price_for_less?: number;
7780
+ price_for_more?: number;
7781
+ pre_surcharge?: number;
7782
+ post_surcharge?: number;
7783
+ tax_tag_code?: string;
7784
+ tags?: string[];
7785
+ unique_id?: number;
7786
+ applied_diff_snapshot?: Record<string, any>;
7787
+ version?: number;
7788
+ brand?: DraftBrandDTO;
7789
+ changes?: ModifierChangeDTO[];
7790
+ vendor_metadata?: VendorMetadataDTO[];
7791
+ weight?: WeightDTO;
7792
+ attachments?: FileAttachmentsDTO;
7793
+ permissions?: Record<string, any>;
7794
+ [index: string]: any;
7795
+ }
7796
+
7797
+ export interface PostMenuV4ModifierRequest extends BaseRequest {
7798
+ body: PostMenuV4ModifierBody;
7799
+ }
7800
+
7801
+ // GET /menu/v4/modifier/{id}
7802
+
7803
+ export interface GetMenuV4ModifierPath {
7804
+ id: string;
7805
+ }
7806
+
7807
+ export interface GetMenuV4ModifierQuery {
7808
+ // Graphql query string
7809
+ _query?: string;
7810
+ }
7811
+
7812
+ export interface GetMenuV4ModifierResponse {
7813
+ parent?: DraftModifierDTO;
7814
+ children?: DraftModifierDTO[];
7815
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
7816
+ id: string;
7817
+ created_at?: string;
7818
+ updated_at?: string;
7819
+ deleted_at?: string;
7820
+ parent_id?: string;
7821
+ name: string;
7822
+ name_on_receipt?: string;
7823
+ name_on_kds?: string;
7824
+ label?: string;
7825
+ description?: string;
7826
+ price: number;
7827
+ calories?: number;
7828
+ tax_tags?: string[];
7829
+ is_active?: boolean;
7830
+ posid?: string;
7831
+ reporting: ReportingMetadataDTO;
7832
+ posid_segment?: number;
7833
+ brand_id: string;
7834
+ line_route?: string;
7835
+ menu_works?: MenuWorksDTO;
7836
+ is_out_of_stock?: boolean;
7837
+ price_for_none?: number;
7838
+ price_for_less?: number;
7839
+ price_for_more?: number;
7840
+ pre_surcharge?: number;
7841
+ post_surcharge?: number;
7842
+ tax_tag_code?: string;
7843
+ tags?: string[];
7844
+ unique_id?: number;
7845
+ applied_diff_snapshot?: Record<string, any>;
7846
+ version?: number;
7847
+ brand?: DraftBrandDTO;
7848
+ changes?: ModifierChangeDTO[];
7849
+ vendor_metadata?: VendorMetadataDTO[];
7850
+ weight?: WeightDTO;
7851
+ attachments?: FileAttachmentsDTO;
7852
+ permissions?: Record<string, any>;
7853
+ [index: string]: any;
7854
+ }
7855
+
7856
+ export interface GetMenuV4ModifierRequest
7857
+ extends BaseRequest,
7858
+ RequestQuery<GetMenuV4ModifierQuery>,
7859
+ GetMenuV4ModifierPath {}
7860
+
7861
+ // PATCH /menu/v4/modifier/{id}
7862
+
7863
+ export interface PatchMenuV4ModifierPath {
7864
+ id: string;
7865
+ }
7866
+
7867
+ export interface PatchMenuV4ModifierBody {
7868
+ parent?: DraftModifierDTO;
7869
+ children?: DraftModifierDTO[];
7870
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
7871
+ parent_id?: string;
7872
+ name?: string;
7873
+ name_on_receipt?: string;
7874
+ name_on_kds?: string;
7875
+ label?: string;
7876
+ description?: string;
7877
+ price?: number;
7878
+ calories?: number;
7879
+ tax_tags?: string[];
7880
+ is_active?: boolean;
7881
+ posid?: string;
7882
+ reporting?: ReportingMetadataDTO;
7883
+ posid_segment?: number;
7884
+ brand_id?: string;
7885
+ line_route?: string;
7886
+ menu_works?: MenuWorksDTO;
7887
+ is_out_of_stock?: boolean;
7888
+ price_for_none?: number;
7889
+ price_for_less?: number;
7890
+ price_for_more?: number;
7891
+ pre_surcharge?: number;
7892
+ post_surcharge?: number;
7893
+ tax_tag_code?: string;
7894
+ tags?: string[];
7895
+ unique_id?: number;
7896
+ applied_diff_snapshot?: Record<string, any>;
7897
+ brand?: DraftBrandDTO;
7898
+ changes?: ModifierChangeDTO[];
7899
+ vendor_metadata?: VendorMetadataDTO[];
7900
+ weight?: WeightDTO;
7901
+ attachments?: FileAttachmentsDTO;
7902
+ permissions?: Record<string, any>;
7903
+ [index: string]: any;
7904
+ }
7905
+
7906
+ export interface PatchMenuV4ModifierResponse {
7907
+ parent?: DraftModifierDTO;
7908
+ children?: DraftModifierDTO[];
7909
+ modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
7910
+ id: string;
7911
+ created_at?: string;
7912
+ updated_at?: string;
7913
+ deleted_at?: string;
7914
+ parent_id?: string;
7915
+ name: string;
7916
+ name_on_receipt?: string;
7917
+ name_on_kds?: string;
7918
+ label?: string;
7919
+ description?: string;
7920
+ price: number;
7921
+ calories?: number;
7922
+ tax_tags?: string[];
7923
+ is_active?: boolean;
7924
+ posid?: string;
7925
+ reporting: ReportingMetadataDTO;
7926
+ posid_segment?: number;
7927
+ brand_id: string;
7928
+ line_route?: string;
7929
+ menu_works?: MenuWorksDTO;
7930
+ is_out_of_stock?: boolean;
7931
+ price_for_none?: number;
7932
+ price_for_less?: number;
7933
+ price_for_more?: number;
7934
+ pre_surcharge?: number;
7935
+ post_surcharge?: number;
7936
+ tax_tag_code?: string;
7937
+ tags?: string[];
7938
+ unique_id?: number;
7939
+ applied_diff_snapshot?: Record<string, any>;
7940
+ version?: number;
7941
+ brand?: DraftBrandDTO;
7942
+ changes?: ModifierChangeDTO[];
7943
+ vendor_metadata?: VendorMetadataDTO[];
7944
+ weight?: WeightDTO;
7945
+ attachments?: FileAttachmentsDTO;
7946
+ permissions?: Record<string, any>;
7947
+ [index: string]: any;
7948
+ }
7949
+
7950
+ export interface PatchMenuV4ModifierRequest extends BaseRequest, PatchMenuV4ModifierPath {
7951
+ body: PatchMenuV4ModifierBody;
7952
+ }
7953
+
7954
+ // POST /menu/v4/modifier-group
7955
+
7956
+ export interface PostMenuV4ModifierGroupBody {
7957
+ parent?: DraftModifierGroupDTO;
7958
+ children?: DraftModifierGroupDTO[];
7959
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
7960
+ items?: DraftItemToModifierGroupRelationshipDTO[];
7961
+ parent_id?: string;
7962
+ name: string;
7963
+ label?: string;
7964
+ min?: number;
7965
+ max?: number;
7966
+ is_active?: boolean;
7967
+ limit?: number;
7968
+ brand_id: string;
7969
+ order_type?: 'selection' | 'option' | 'quantity';
7970
+ sizing?: string;
7971
+ is_out_of_stock?: boolean;
7972
+ is_incremental?: boolean;
7973
+ applied_diff_snapshot?: Record<string, any>;
7974
+ brand?: DraftBrandDTO;
7975
+ changes?: ModifierGroupChangeDTO[];
7976
+ vendor_metadata?: VendorMetadataDTO[];
7977
+ permissions?: Record<string, any>;
7978
+ [index: string]: any;
7979
+ }
7980
+
7981
+ export interface PostMenuV4ModifierGroupResponse {
7982
+ parent?: DraftModifierGroupDTO;
7983
+ children?: DraftModifierGroupDTO[];
7984
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
7985
+ items?: DraftItemToModifierGroupRelationshipDTO[];
7986
+ id: string;
7987
+ created_at?: string;
7988
+ updated_at?: string;
7989
+ deleted_at?: string;
7990
+ parent_id?: string;
7991
+ name: string;
7992
+ label?: string;
7993
+ min?: number;
7994
+ max?: number;
7995
+ is_active?: boolean;
7996
+ limit?: number;
7997
+ brand_id: string;
7998
+ order_type?: 'selection' | 'option' | 'quantity';
7999
+ sizing?: string;
8000
+ is_out_of_stock?: boolean;
8001
+ is_incremental?: boolean;
8002
+ applied_diff_snapshot?: Record<string, any>;
8003
+ version?: number;
8004
+ brand?: DraftBrandDTO;
8005
+ changes?: ModifierGroupChangeDTO[];
8006
+ vendor_metadata?: VendorMetadataDTO[];
8007
+ permissions?: Record<string, any>;
8008
+ [index: string]: any;
8009
+ }
8010
+
8011
+ export interface PostMenuV4ModifierGroupRequest extends BaseRequest {
8012
+ body: PostMenuV4ModifierGroupBody;
8013
+ }
8014
+
8015
+ // GET /menu/v4/modifier-group/{id}
8016
+
8017
+ export interface GetMenuV4ModifierGroupPath {
8018
+ id: string;
8019
+ }
8020
+
8021
+ export interface GetMenuV4ModifierGroupQuery {
8022
+ // Graphql query string
8023
+ _query?: string;
8024
+ }
8025
+
8026
+ export interface GetMenuV4ModifierGroupResponse {
8027
+ parent?: DraftModifierGroupDTO;
8028
+ children?: DraftModifierGroupDTO[];
8029
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
8030
+ items?: DraftItemToModifierGroupRelationshipDTO[];
8031
+ id: string;
8032
+ created_at?: string;
8033
+ updated_at?: string;
8034
+ deleted_at?: string;
8035
+ parent_id?: string;
8036
+ name: string;
8037
+ label?: string;
8038
+ min?: number;
8039
+ max?: number;
8040
+ is_active?: boolean;
8041
+ limit?: number;
8042
+ brand_id: string;
8043
+ order_type?: 'selection' | 'option' | 'quantity';
8044
+ sizing?: string;
8045
+ is_out_of_stock?: boolean;
8046
+ is_incremental?: boolean;
8047
+ applied_diff_snapshot?: Record<string, any>;
8048
+ version?: number;
8049
+ brand?: DraftBrandDTO;
8050
+ changes?: ModifierGroupChangeDTO[];
8051
+ vendor_metadata?: VendorMetadataDTO[];
8052
+ permissions?: Record<string, any>;
8053
+ [index: string]: any;
8054
+ }
8055
+
8056
+ export interface GetMenuV4ModifierGroupRequest
8057
+ extends BaseRequest,
8058
+ RequestQuery<GetMenuV4ModifierGroupQuery>,
8059
+ GetMenuV4ModifierGroupPath {}
8060
+
8061
+ // PATCH /menu/v4/modifier-group/{id}
8062
+
8063
+ export interface PatchMenuV4ModifierGroupPath {
8064
+ id: string;
8065
+ }
8066
+
8067
+ export interface PatchMenuV4ModifierGroupBody {
8068
+ parent?: DraftModifierGroupDTO;
8069
+ children?: DraftModifierGroupDTO[];
8070
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
8071
+ items?: DraftItemToModifierGroupRelationshipDTO[];
8072
+ parent_id?: string;
8073
+ name?: string;
8074
+ label?: string;
8075
+ min?: number;
8076
+ max?: number;
8077
+ is_active?: boolean;
8078
+ limit?: number;
8079
+ brand_id?: string;
8080
+ order_type?: 'selection' | 'option' | 'quantity';
8081
+ sizing?: string;
8082
+ is_out_of_stock?: boolean;
8083
+ is_incremental?: boolean;
8084
+ applied_diff_snapshot?: Record<string, any>;
8085
+ brand?: DraftBrandDTO;
8086
+ changes?: ModifierGroupChangeDTO[];
8087
+ vendor_metadata?: VendorMetadataDTO[];
8088
+ permissions?: Record<string, any>;
8089
+ [index: string]: any;
8090
+ }
8091
+
8092
+ export interface PatchMenuV4ModifierGroupResponse {
8093
+ parent?: DraftModifierGroupDTO;
8094
+ children?: DraftModifierGroupDTO[];
8095
+ modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
8096
+ items?: DraftItemToModifierGroupRelationshipDTO[];
8097
+ id: string;
8098
+ created_at?: string;
8099
+ updated_at?: string;
8100
+ deleted_at?: string;
8101
+ parent_id?: string;
8102
+ name: string;
8103
+ label?: string;
8104
+ min?: number;
8105
+ max?: number;
8106
+ is_active?: boolean;
8107
+ limit?: number;
8108
+ brand_id: string;
8109
+ order_type?: 'selection' | 'option' | 'quantity';
8110
+ sizing?: string;
8111
+ is_out_of_stock?: boolean;
8112
+ is_incremental?: boolean;
8113
+ applied_diff_snapshot?: Record<string, any>;
8114
+ version?: number;
8115
+ brand?: DraftBrandDTO;
8116
+ changes?: ModifierGroupChangeDTO[];
8117
+ vendor_metadata?: VendorMetadataDTO[];
8118
+ permissions?: Record<string, any>;
8119
+ [index: string]: any;
8120
+ }
8121
+
8122
+ export interface PatchMenuV4ModifierGroupRequest extends BaseRequest, PatchMenuV4ModifierGroupPath {
8123
+ body: PatchMenuV4ModifierGroupBody;
8124
+ }
8125
+
8126
+ // POST /menu/v4/modifier-group/{id}/attach-modifiers
8127
+
8128
+ export interface PostMenuV4ModifierGroupAttachModifiersPath {
8129
+ id: string;
8130
+ }
8131
+
8132
+ export type PostMenuV4ModifierGroupAttachModifiersBody = {
8133
+ parent?: DraftModifierGroupToModifierRelationshipDTO;
8134
+ children?: DraftModifierGroupToModifierRelationshipDTO[];
8135
+ parent_id?: string;
8136
+ modifier_id: string;
8137
+ modifier_group_id: string;
8138
+ brand_id: string;
8139
+ sequence?: number;
8140
+ applied_diff_snapshot?: Record<string, any>;
8141
+ modifier?: DraftModifierDTO;
8142
+ modifier_group?: DraftModifierGroupDTO;
8143
+ brand?: DraftBrandDTO;
8144
+ changes?: ModifierGroupToModifierRelationshipChangeDTO[];
8145
+ vendor_metadata?: VendorMetadataDTO[];
8146
+ permissions?: Record<string, any>;
8147
+ [index: string]: any;
8148
+ }[];
8149
+
8150
+ export interface PostMenuV4ModifierGroupAttachModifiersResponse {
8151
+ status?: string;
8152
+ }
8153
+
8154
+ export interface PostMenuV4ModifierGroupAttachModifiersRequest
8155
+ extends BaseRequest,
8156
+ PostMenuV4ModifierGroupAttachModifiersPath {
8157
+ body: PostMenuV4ModifierGroupAttachModifiersBody;
8158
+ }