@compassdigital/sdk.typescript 4.101.0 → 4.103.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.
@@ -454,6 +454,7 @@ export interface BrandMeta {
454
454
  }
455
455
 
456
456
  export interface PublishedBrandDTO {
457
+ published_catalog_id?: number;
457
458
  id?: string;
458
459
  name?: string;
459
460
  description?: string;
@@ -604,6 +605,9 @@ export interface DraftMenuDTO {
604
605
  parent?: Record<string, any>;
605
606
  children?: Record<string, any>[];
606
607
  categories?: DraftCategoryDTO[];
608
+ stocks?: Record<string, any>[];
609
+ station_id?: string;
610
+ price_level_id?: string;
607
611
  id?: string;
608
612
  parent_id?: string;
609
613
  name?: string;
@@ -662,6 +666,8 @@ export interface DraftItemDTO {
662
666
  parent?: Record<string, any>;
663
667
  children?: Record<string, any>[];
664
668
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
669
+ cpg_item?: UniversalItemDTO;
670
+ stocks?: StockDTO[];
665
671
  id?: string;
666
672
  parent_id?: string;
667
673
  name?: string;
@@ -687,6 +693,7 @@ export interface DraftItemDTO {
687
693
  is_featured?: boolean;
688
694
  tax_jwo_code?: string;
689
695
  unique_id?: number;
696
+ cpg_item_id?: string;
690
697
  applied_diff_snapshot?: Record<string, any>;
691
698
  brand?: DraftBrandDTO;
692
699
  categories?: Record<string, any>[];
@@ -887,6 +894,36 @@ export interface ItemChangeDTO {
887
894
  [index: string]: any;
888
895
  }
889
896
 
897
+ export interface UniversalItemDTO {
898
+ id?: string;
899
+ barcode?: string;
900
+ name?: string;
901
+ description?: string;
902
+ is_verified?: boolean;
903
+ verified_at?: string;
904
+ verified_by?: string;
905
+ price?: number;
906
+ product_number?: number;
907
+ images?: Record<string, any>;
908
+ metadata?: Record<string, any>;
909
+ [index: string]: any;
910
+ }
911
+
912
+ export interface StockDTO {
913
+ is_in_stock?: boolean;
914
+ draft_is_in_stock?: boolean;
915
+ item_id?: string;
916
+ menu_id?: string;
917
+ brand_id?: string;
918
+ id?: string;
919
+ business_unit_id?: string;
920
+ item?: Record<string, any>;
921
+ menu?: Record<string, any>;
922
+ brand?: DraftBrandDTO;
923
+ permissions?: Record<string, any>;
924
+ [index: string]: any;
925
+ }
926
+
890
927
  export interface CategoryToItemRelationshipChangeDTO {
891
928
  id?: string;
892
929
  insert?: Record<string, any>;
@@ -1109,6 +1146,7 @@ export interface PublishedItemDTO {
1109
1146
  tags?: string[];
1110
1147
  is_featured?: boolean;
1111
1148
  tax_jwo_code?: string;
1149
+ cpg_item_id?: string;
1112
1150
  permissions?: Record<string, any>;
1113
1151
  [index: string]: any;
1114
1152
  }
@@ -1442,6 +1480,8 @@ export interface DraftItemEntityDTO {
1442
1480
  parent?: DraftItemDTO;
1443
1481
  children?: DraftItemDTO[];
1444
1482
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
1483
+ cpg_item?: UniversalItemDTO;
1484
+ stocks?: StockDTO[];
1445
1485
  id: string;
1446
1486
  created_at?: string;
1447
1487
  updated_at?: string;
@@ -1470,6 +1510,7 @@ export interface DraftItemEntityDTO {
1470
1510
  is_featured?: boolean;
1471
1511
  tax_jwo_code?: string;
1472
1512
  unique_id?: number;
1513
+ cpg_item_id?: string;
1473
1514
  applied_diff_snapshot?: Record<string, any>;
1474
1515
  version?: number;
1475
1516
  brand?: DraftBrandDTO;
@@ -2869,6 +2910,7 @@ export interface PostMenuV3DraftBrandBody {
2869
2910
  audit_logs?: AuditDTO[];
2870
2911
  catalog_id?: number;
2871
2912
  published_catalog_id?: number;
2913
+ stocks?: StockDTO[];
2872
2914
  name: string;
2873
2915
  description?: string;
2874
2916
  is_active?: boolean;
@@ -2939,6 +2981,7 @@ export interface PatchMenuV3DraftBrandBody {
2939
2981
  audit_logs?: AuditDTO[];
2940
2982
  catalog_id?: number;
2941
2983
  published_catalog_id?: number;
2984
+ stocks?: StockDTO[];
2942
2985
  id?: string;
2943
2986
  name?: string;
2944
2987
  description?: string;
@@ -3033,6 +3076,7 @@ export type PostMenuV3DraftBrandsBody = {
3033
3076
  audit_logs?: AuditDTO[];
3034
3077
  catalog_id?: number;
3035
3078
  published_catalog_id?: number;
3079
+ stocks?: StockDTO[];
3036
3080
  name: string;
3037
3081
  description?: string;
3038
3082
  is_active?: boolean;
@@ -3505,6 +3549,22 @@ export interface GetMenuV3DraftBrandImportLinkRequest
3505
3549
  RequestQuery<GetMenuV3DraftBrandImportLinkQuery>,
3506
3550
  GetMenuV3DraftBrandImportLinkPath {}
3507
3551
 
3552
+ // POST /menu/v3/draft/brand/{id}/import
3553
+
3554
+ export interface PostMenuV3DraftBrandImportPath {
3555
+ id: string;
3556
+ }
3557
+
3558
+ export interface PostMenuV3DraftBrandImportResponse {
3559
+ success: boolean;
3560
+ errors_report_link?: string;
3561
+ [index: string]: any;
3562
+ }
3563
+
3564
+ export interface PostMenuV3DraftBrandImportRequest
3565
+ extends BaseRequest,
3566
+ PostMenuV3DraftBrandImportPath {}
3567
+
3508
3568
  // POST /menu/v3/brand
3509
3569
 
3510
3570
  export interface PostMenuV3BrandQuery {
@@ -3522,6 +3582,7 @@ export interface PostMenuV3BrandBody {
3522
3582
  modifier_groups?: PublishedModifierGroupDTO[];
3523
3583
  modifier_group_to_modifier_relationships?: PublishedModifierGroupToModifierRelationshipDTO[];
3524
3584
  modifiers?: PublishedModifierDTO[];
3585
+ published_catalog_id?: number;
3525
3586
  name: string;
3526
3587
  description?: string;
3527
3588
  is_active?: boolean;
@@ -3590,6 +3651,7 @@ export interface PatchMenuV3BrandBody {
3590
3651
  modifier_groups?: PublishedModifierGroupDTO[];
3591
3652
  modifier_group_to_modifier_relationships?: PublishedModifierGroupToModifierRelationshipDTO[];
3592
3653
  modifiers?: PublishedModifierDTO[];
3654
+ published_catalog_id?: number;
3593
3655
  id?: string;
3594
3656
  name?: string;
3595
3657
  description?: string;
@@ -3684,6 +3746,7 @@ export type PostMenuV3BrandsBody = {
3684
3746
  modifier_groups?: PublishedModifierGroupDTO[];
3685
3747
  modifier_group_to_modifier_relationships?: PublishedModifierGroupToModifierRelationshipDTO[];
3686
3748
  modifiers?: PublishedModifierDTO[];
3749
+ published_catalog_id?: number;
3687
3750
  name: string;
3688
3751
  description?: string;
3689
3752
  is_active?: boolean;
@@ -3902,6 +3965,9 @@ export interface PostMenuV3DraftMenuBody {
3902
3965
  parent?: DraftMenuDTO;
3903
3966
  children?: DraftMenuDTO[];
3904
3967
  categories?: DraftCategoryDTO[];
3968
+ stocks?: StockDTO[];
3969
+ station_id?: string;
3970
+ price_level_id?: string;
3905
3971
  parent_id?: string;
3906
3972
  name: string;
3907
3973
  brand_id: string;
@@ -3951,6 +4017,9 @@ export interface PatchMenuV3DraftMenuBody {
3951
4017
  parent?: DraftMenuDTO;
3952
4018
  children?: DraftMenuDTO[];
3953
4019
  categories?: DraftCategoryDTO[];
4020
+ stocks?: StockDTO[];
4021
+ station_id?: string;
4022
+ price_level_id?: string;
3954
4023
  id?: string;
3955
4024
  parent_id?: string;
3956
4025
  name?: string;
@@ -4024,6 +4093,9 @@ export type PostMenuV3DraftMenusBody = {
4024
4093
  parent?: DraftMenuDTO;
4025
4094
  children?: DraftMenuDTO[];
4026
4095
  categories?: DraftCategoryDTO[];
4096
+ stocks?: StockDTO[];
4097
+ station_id?: string;
4098
+ price_level_id?: string;
4027
4099
  parent_id?: string;
4028
4100
  name: string;
4029
4101
  brand_id: string;
@@ -4156,6 +4228,9 @@ export interface PostMenuV3DraftMenuDuplicateResponse {
4156
4228
  parent?: DraftMenuDTO;
4157
4229
  children?: DraftMenuDTO[];
4158
4230
  categories?: DraftCategoryDTO[];
4231
+ stocks?: StockDTO[];
4232
+ station_id?: string;
4233
+ price_level_id?: string;
4159
4234
  id: string;
4160
4235
  created_at?: string;
4161
4236
  updated_at?: string;
@@ -4951,6 +5026,8 @@ export interface PostMenuV3DraftItemBody {
4951
5026
  parent?: DraftItemDTO;
4952
5027
  children?: DraftItemDTO[];
4953
5028
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
5029
+ cpg_item?: UniversalItemDTO;
5030
+ stocks?: StockDTO[];
4954
5031
  parent_id?: string;
4955
5032
  name: string;
4956
5033
  name_on_receipt?: string;
@@ -4975,6 +5052,7 @@ export interface PostMenuV3DraftItemBody {
4975
5052
  is_featured?: boolean;
4976
5053
  tax_jwo_code?: string;
4977
5054
  unique_id?: number;
5055
+ cpg_item_id?: string;
4978
5056
  applied_diff_snapshot?: Record<string, any>;
4979
5057
  brand?: DraftBrandDTO;
4980
5058
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -5025,6 +5103,8 @@ export interface PatchMenuV3DraftItemBody {
5025
5103
  parent?: DraftItemDTO;
5026
5104
  children?: DraftItemDTO[];
5027
5105
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
5106
+ cpg_item?: UniversalItemDTO;
5107
+ stocks?: StockDTO[];
5028
5108
  id?: string;
5029
5109
  parent_id?: string;
5030
5110
  name?: string;
@@ -5050,6 +5130,7 @@ export interface PatchMenuV3DraftItemBody {
5050
5130
  is_featured?: boolean;
5051
5131
  tax_jwo_code?: string;
5052
5132
  unique_id?: number;
5133
+ cpg_item_id?: string;
5053
5134
  applied_diff_snapshot?: Record<string, any>;
5054
5135
  version?: number;
5055
5136
  brand?: DraftBrandDTO;
@@ -5140,6 +5221,8 @@ export type PostMenuV3DraftItemsBody = {
5140
5221
  parent?: DraftItemDTO;
5141
5222
  children?: DraftItemDTO[];
5142
5223
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
5224
+ cpg_item?: UniversalItemDTO;
5225
+ stocks?: StockDTO[];
5143
5226
  parent_id?: string;
5144
5227
  name: string;
5145
5228
  name_on_receipt?: string;
@@ -5164,6 +5247,7 @@ export type PostMenuV3DraftItemsBody = {
5164
5247
  is_featured?: boolean;
5165
5248
  tax_jwo_code?: string;
5166
5249
  unique_id?: number;
5250
+ cpg_item_id?: string;
5167
5251
  applied_diff_snapshot?: Record<string, any>;
5168
5252
  brand?: DraftBrandDTO;
5169
5253
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -5244,6 +5328,8 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
5244
5328
  parent?: DraftItemDTO;
5245
5329
  children?: DraftItemDTO[];
5246
5330
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
5331
+ cpg_item?: UniversalItemDTO;
5332
+ stocks?: StockDTO[];
5247
5333
  id?: string;
5248
5334
  parent_id?: string;
5249
5335
  name?: string;
@@ -5269,6 +5355,7 @@ export interface PatchMenuV3DraftItemsBulkUpdateBody {
5269
5355
  is_featured?: boolean;
5270
5356
  tax_jwo_code?: string;
5271
5357
  unique_id?: number;
5358
+ cpg_item_id?: string;
5272
5359
  applied_diff_snapshot?: Record<string, any>;
5273
5360
  brand?: DraftBrandDTO;
5274
5361
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -6933,6 +7020,7 @@ export interface GetMenuV3MenuworksResponse {
6933
7020
  calories?: number;
6934
7021
  unit_id?: string;
6935
7022
  name?: string;
7023
+ short_name?: string;
6936
7024
  description?: string;
6937
7025
  MRN?: string;
6938
7026
  portion_quantity?: number;
@@ -7101,6 +7189,7 @@ export interface PostMenuV4BrandBody {
7101
7189
  audit_logs?: AuditDTO[];
7102
7190
  catalog_id?: number;
7103
7191
  published_catalog_id?: number;
7192
+ stocks?: StockDTO[];
7104
7193
  name: string;
7105
7194
  description?: string;
7106
7195
  is_active?: boolean;
@@ -7137,6 +7226,7 @@ export interface PostMenuV4BrandResponse {
7137
7226
  audit_logs?: AuditDTO[];
7138
7227
  catalog_id?: number;
7139
7228
  published_catalog_id?: number;
7229
+ stocks?: StockDTO[];
7140
7230
  id: string;
7141
7231
  created_at?: string;
7142
7232
  updated_at?: string;
@@ -7193,6 +7283,7 @@ export interface GetMenuV4BrandResponse {
7193
7283
  audit_logs?: AuditDTO[];
7194
7284
  catalog_id?: number;
7195
7285
  published_catalog_id?: number;
7286
+ stocks?: StockDTO[];
7196
7287
  id: string;
7197
7288
  created_at?: string;
7198
7289
  updated_at?: string;
@@ -7245,6 +7336,7 @@ export interface DeleteMenuV4BrandResponse {
7245
7336
  audit_logs?: AuditDTO[];
7246
7337
  catalog_id?: number;
7247
7338
  published_catalog_id?: number;
7339
+ stocks?: StockDTO[];
7248
7340
  id: string;
7249
7341
  created_at?: string;
7250
7342
  updated_at?: string;
@@ -7283,6 +7375,9 @@ export interface PostMenuV4BrandMenuBody {
7283
7375
  parent?: DraftMenuDTO;
7284
7376
  children?: DraftMenuDTO[];
7285
7377
  categories?: DraftCategoryDTO[];
7378
+ stocks?: StockDTO[];
7379
+ station_id?: string;
7380
+ price_level_id?: string;
7286
7381
  parent_id?: string;
7287
7382
  name: string;
7288
7383
  brand_id: string;
@@ -7298,6 +7393,9 @@ export interface PostMenuV4BrandMenuResponse {
7298
7393
  parent?: DraftMenuDTO;
7299
7394
  children?: DraftMenuDTO[];
7300
7395
  categories?: DraftCategoryDTO[];
7396
+ stocks?: StockDTO[];
7397
+ station_id?: string;
7398
+ price_level_id?: string;
7301
7399
  id: string;
7302
7400
  created_at?: string;
7303
7401
  updated_at?: string;
@@ -7329,6 +7427,9 @@ export interface PatchMenuV4BrandMenuBody {
7329
7427
  parent?: DraftMenuDTO;
7330
7428
  children?: DraftMenuDTO[];
7331
7429
  categories?: DraftCategoryDTO[];
7430
+ stocks?: StockDTO[];
7431
+ station_id?: string;
7432
+ price_level_id?: string;
7332
7433
  id?: string;
7333
7434
  parent_id?: string;
7334
7435
  name?: string;
@@ -7346,6 +7447,9 @@ export interface PatchMenuV4BrandMenuResponse {
7346
7447
  parent?: DraftMenuDTO;
7347
7448
  children?: DraftMenuDTO[];
7348
7449
  categories?: DraftCategoryDTO[];
7450
+ stocks?: StockDTO[];
7451
+ station_id?: string;
7452
+ price_level_id?: string;
7349
7453
  id: string;
7350
7454
  created_at?: string;
7351
7455
  updated_at?: string;
@@ -7377,6 +7481,9 @@ export interface DeleteMenuV4BrandMenuResponse {
7377
7481
  parent?: DraftMenuDTO;
7378
7482
  children?: DraftMenuDTO[];
7379
7483
  categories?: DraftCategoryDTO[];
7484
+ stocks?: StockDTO[];
7485
+ station_id?: string;
7486
+ price_level_id?: string;
7380
7487
  id: string;
7381
7488
  created_at?: string;
7382
7489
  updated_at?: string;
@@ -7816,6 +7923,9 @@ export interface PostMenuV4BrandMenuDuplicateBody {
7816
7923
  parent?: DraftMenuDTO;
7817
7924
  children?: DraftMenuDTO[];
7818
7925
  categories?: DraftCategoryDTO[];
7926
+ stocks?: StockDTO[];
7927
+ station_id?: string;
7928
+ price_level_id?: string;
7819
7929
  id?: string;
7820
7930
  parent_id?: string;
7821
7931
  name?: string;
@@ -7833,6 +7943,9 @@ export interface PostMenuV4BrandMenuDuplicateResponse {
7833
7943
  parent?: DraftMenuDTO;
7834
7944
  children?: DraftMenuDTO[];
7835
7945
  categories?: DraftCategoryDTO[];
7946
+ stocks?: StockDTO[];
7947
+ station_id?: string;
7948
+ price_level_id?: string;
7836
7949
  id: string;
7837
7950
  created_at?: string;
7838
7951
  updated_at?: string;
@@ -7903,6 +8016,8 @@ export interface PostMenuV4ItemBody {
7903
8016
  parent?: DraftItemDTO;
7904
8017
  children?: DraftItemDTO[];
7905
8018
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8019
+ cpg_item?: UniversalItemDTO;
8020
+ stocks?: StockDTO[];
7906
8021
  parent_id?: string;
7907
8022
  name: string;
7908
8023
  name_on_receipt?: string;
@@ -7927,6 +8042,7 @@ export interface PostMenuV4ItemBody {
7927
8042
  is_featured?: boolean;
7928
8043
  tax_jwo_code?: string;
7929
8044
  unique_id?: number;
8045
+ cpg_item_id?: string;
7930
8046
  base_item_id?: string;
7931
8047
  applied_diff_snapshot?: Record<string, any>;
7932
8048
  brand?: DraftBrandDTO;
@@ -7944,6 +8060,8 @@ export interface PostMenuV4ItemResponse {
7944
8060
  parent?: DraftItemDTO;
7945
8061
  children?: DraftItemDTO[];
7946
8062
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8063
+ cpg_item?: UniversalItemDTO;
8064
+ stocks?: StockDTO[];
7947
8065
  id: string;
7948
8066
  created_at?: string;
7949
8067
  updated_at?: string;
@@ -7972,6 +8090,7 @@ export interface PostMenuV4ItemResponse {
7972
8090
  is_featured?: boolean;
7973
8091
  tax_jwo_code?: string;
7974
8092
  unique_id?: number;
8093
+ cpg_item_id?: string;
7975
8094
  applied_diff_snapshot?: Record<string, any>;
7976
8095
  version?: number;
7977
8096
  brand?: DraftBrandDTO;
@@ -7988,6 +8107,61 @@ export interface PostMenuV4ItemRequest extends BaseRequest {
7988
8107
  body: PostMenuV4ItemBody;
7989
8108
  }
7990
8109
 
8110
+ // POST /menu/v4/items/bulk-create
8111
+
8112
+ export type PostMenuV4ItemsBulkCreateBody = {
8113
+ is_published?: boolean;
8114
+ parent?: DraftItemDTO;
8115
+ children?: DraftItemDTO[];
8116
+ modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8117
+ cpg_item?: UniversalItemDTO;
8118
+ stocks?: StockDTO[];
8119
+ parent_id?: string;
8120
+ name: string;
8121
+ name_on_receipt?: string;
8122
+ name_on_kds?: string;
8123
+ label?: string;
8124
+ description?: string;
8125
+ reporting: ReportingMetadataDTO;
8126
+ price: number;
8127
+ barcode?: string;
8128
+ calories?: number;
8129
+ meal_value?: number;
8130
+ is_active?: boolean;
8131
+ posid?: string;
8132
+ tax_tags?: string[];
8133
+ brand_id: string;
8134
+ line_route?: string;
8135
+ posid_segment?: number;
8136
+ menu_works?: MenuWorksDTO;
8137
+ is_out_of_stock?: boolean;
8138
+ tax_tag_code?: string;
8139
+ tags?: string[];
8140
+ is_featured?: boolean;
8141
+ tax_jwo_code?: string;
8142
+ unique_id?: number;
8143
+ cpg_item_id?: string;
8144
+ base_item_id?: string;
8145
+ applied_diff_snapshot?: Record<string, any>;
8146
+ brand?: DraftBrandDTO;
8147
+ categories?: DraftCategoryToItemRelationshipDTO[];
8148
+ changes?: ItemChangeDTO[];
8149
+ vendor_metadata?: VendorMetadataDTO[];
8150
+ attachments?: FileAttachmentsDTO;
8151
+ weight?: WeightDTO;
8152
+ permissions?: Record<string, any>;
8153
+ [index: string]: any;
8154
+ }[];
8155
+
8156
+ export interface PostMenuV4ItemsBulkCreateResponse {
8157
+ meta?: Record<string, any>;
8158
+ results?: DraftItemEntityDTO[];
8159
+ }
8160
+
8161
+ export interface PostMenuV4ItemsBulkCreateRequest extends BaseRequest {
8162
+ body: PostMenuV4ItemsBulkCreateBody;
8163
+ }
8164
+
7991
8165
  // GET /menu/v4/item/{id}
7992
8166
 
7993
8167
  export interface GetMenuV4ItemPath {
@@ -8004,6 +8178,8 @@ export interface GetMenuV4ItemResponse {
8004
8178
  parent?: DraftItemDTO;
8005
8179
  children?: DraftItemDTO[];
8006
8180
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8181
+ cpg_item?: UniversalItemDTO;
8182
+ stocks?: StockDTO[];
8007
8183
  id: string;
8008
8184
  created_at?: string;
8009
8185
  updated_at?: string;
@@ -8032,6 +8208,7 @@ export interface GetMenuV4ItemResponse {
8032
8208
  is_featured?: boolean;
8033
8209
  tax_jwo_code?: string;
8034
8210
  unique_id?: number;
8211
+ cpg_item_id?: string;
8035
8212
  applied_diff_snapshot?: Record<string, any>;
8036
8213
  version?: number;
8037
8214
  brand?: DraftBrandDTO;
@@ -8061,6 +8238,8 @@ export interface PatchMenuV4ItemBody {
8061
8238
  parent?: DraftItemDTO;
8062
8239
  children?: DraftItemDTO[];
8063
8240
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8241
+ cpg_item?: UniversalItemDTO;
8242
+ stocks?: StockDTO[];
8064
8243
  parent_id?: string;
8065
8244
  name?: string;
8066
8245
  name_on_receipt?: string;
@@ -8085,6 +8264,7 @@ export interface PatchMenuV4ItemBody {
8085
8264
  is_featured?: boolean;
8086
8265
  tax_jwo_code?: string;
8087
8266
  unique_id?: number;
8267
+ cpg_item_id?: string;
8088
8268
  applied_diff_snapshot?: Record<string, any>;
8089
8269
  brand?: DraftBrandDTO;
8090
8270
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -8101,6 +8281,8 @@ export interface PatchMenuV4ItemResponse {
8101
8281
  parent?: DraftItemDTO;
8102
8282
  children?: DraftItemDTO[];
8103
8283
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8284
+ cpg_item?: UniversalItemDTO;
8285
+ stocks?: StockDTO[];
8104
8286
  id: string;
8105
8287
  created_at?: string;
8106
8288
  updated_at?: string;
@@ -8129,6 +8311,7 @@ export interface PatchMenuV4ItemResponse {
8129
8311
  is_featured?: boolean;
8130
8312
  tax_jwo_code?: string;
8131
8313
  unique_id?: number;
8314
+ cpg_item_id?: string;
8132
8315
  applied_diff_snapshot?: Record<string, any>;
8133
8316
  version?: number;
8134
8317
  brand?: DraftBrandDTO;
@@ -8156,6 +8339,8 @@ export interface DeleteMenuV4ItemResponse {
8156
8339
  parent?: DraftItemDTO;
8157
8340
  children?: DraftItemDTO[];
8158
8341
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8342
+ cpg_item?: UniversalItemDTO;
8343
+ stocks?: StockDTO[];
8159
8344
  id: string;
8160
8345
  created_at?: string;
8161
8346
  updated_at?: string;
@@ -8184,6 +8369,7 @@ export interface DeleteMenuV4ItemResponse {
8184
8369
  is_featured?: boolean;
8185
8370
  tax_jwo_code?: string;
8186
8371
  unique_id?: number;
8372
+ cpg_item_id?: string;
8187
8373
  applied_diff_snapshot?: Record<string, any>;
8188
8374
  version?: number;
8189
8375
  brand?: DraftBrandDTO;
@@ -8206,6 +8392,8 @@ export interface PatchMenuV4ItemsBulkUpdateBody {
8206
8392
  parent?: DraftItemDTO;
8207
8393
  children?: DraftItemDTO[];
8208
8394
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8395
+ cpg_item?: UniversalItemDTO;
8396
+ stocks?: StockDTO[];
8209
8397
  id?: string;
8210
8398
  parent_id?: string;
8211
8399
  name?: string;
@@ -8231,6 +8419,7 @@ export interface PatchMenuV4ItemsBulkUpdateBody {
8231
8419
  is_featured?: boolean;
8232
8420
  tax_jwo_code?: string;
8233
8421
  unique_id?: number;
8422
+ cpg_item_id?: string;
8234
8423
  applied_diff_snapshot?: Record<string, any>;
8235
8424
  brand?: DraftBrandDTO;
8236
8425
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -8262,6 +8451,8 @@ export interface PostMenuV4ItemDuplicateBody {
8262
8451
  parent?: DraftItemDTO;
8263
8452
  children?: DraftItemDTO[];
8264
8453
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8454
+ cpg_item?: UniversalItemDTO;
8455
+ stocks?: StockDTO[];
8265
8456
  parent_id?: string;
8266
8457
  name?: string;
8267
8458
  name_on_receipt?: string;
@@ -8286,6 +8477,7 @@ export interface PostMenuV4ItemDuplicateBody {
8286
8477
  is_featured?: boolean;
8287
8478
  tax_jwo_code?: string;
8288
8479
  unique_id?: number;
8480
+ cpg_item_id?: string;
8289
8481
  applied_diff_snapshot?: Record<string, any>;
8290
8482
  brand?: DraftBrandDTO;
8291
8483
  categories?: DraftCategoryToItemRelationshipDTO[];
@@ -8302,6 +8494,8 @@ export interface PostMenuV4ItemDuplicateResponse {
8302
8494
  parent?: DraftItemDTO;
8303
8495
  children?: DraftItemDTO[];
8304
8496
  modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
8497
+ cpg_item?: UniversalItemDTO;
8498
+ stocks?: StockDTO[];
8305
8499
  id: string;
8306
8500
  created_at?: string;
8307
8501
  updated_at?: string;
@@ -8330,6 +8524,7 @@ export interface PostMenuV4ItemDuplicateResponse {
8330
8524
  is_featured?: boolean;
8331
8525
  tax_jwo_code?: string;
8332
8526
  unique_id?: number;
8527
+ cpg_item_id?: string;
8333
8528
  applied_diff_snapshot?: Record<string, any>;
8334
8529
  version?: number;
8335
8530
  brand?: DraftBrandDTO;
@@ -9124,3 +9319,204 @@ export interface PostMenuV4ModifierGroupDuplicateRequest
9124
9319
  PostMenuV4ModifierGroupDuplicatePath {
9125
9320
  body: PostMenuV4ModifierGroupDuplicateBody;
9126
9321
  }
9322
+
9323
+ // PATCH /menu/v4/stock/business-unit
9324
+
9325
+ export interface PatchMenuV4StockBusinessUnitBody {
9326
+ draft_is_in_stock: boolean;
9327
+ business_unit_id: string;
9328
+ item_ids: string[];
9329
+ [index: string]: any;
9330
+ }
9331
+
9332
+ export interface PatchMenuV4StockBusinessUnitResponse {
9333
+ results?: StockDTO[];
9334
+ }
9335
+
9336
+ export interface PatchMenuV4StockBusinessUnitRequest extends BaseRequest {
9337
+ body: PatchMenuV4StockBusinessUnitBody;
9338
+ }
9339
+
9340
+ // PATCH /menu/v4/stock/{id}
9341
+
9342
+ export interface PatchMenuV4StockPath {
9343
+ id: string;
9344
+ }
9345
+
9346
+ export interface PatchMenuV4StockBody {
9347
+ draft_is_in_stock?: boolean;
9348
+ }
9349
+
9350
+ export interface PatchMenuV4StockResponse {
9351
+ is_in_stock: boolean;
9352
+ draft_is_in_stock: boolean;
9353
+ item_id: string;
9354
+ menu_id: string;
9355
+ brand_id: string;
9356
+ id: string;
9357
+ created_at?: string;
9358
+ updated_at?: string;
9359
+ deleted_at?: string;
9360
+ business_unit_id?: string;
9361
+ version?: number;
9362
+ item?: DraftItemDTO;
9363
+ menu?: DraftMenuDTO;
9364
+ brand?: DraftBrandDTO;
9365
+ permissions?: Record<string, any>;
9366
+ [index: string]: any;
9367
+ }
9368
+
9369
+ export interface PatchMenuV4StockRequest extends BaseRequest, PatchMenuV4StockPath {
9370
+ body: PatchMenuV4StockBody;
9371
+ }
9372
+
9373
+ // POST /menu/v4/stock/menu-business-unit
9374
+
9375
+ export interface PostMenuV4StockMenuBusinessUnitBody {
9376
+ menu_id?: string;
9377
+ business_unit_id?: string;
9378
+ }
9379
+
9380
+ export interface PostMenuV4StockMenuBusinessUnitResponse {
9381
+ status?: string;
9382
+ }
9383
+
9384
+ export interface PostMenuV4StockMenuBusinessUnitRequest extends BaseRequest {
9385
+ body: PostMenuV4StockMenuBusinessUnitBody;
9386
+ }
9387
+
9388
+ // DELETE /menu/v4/stock/menu-business-unit
9389
+
9390
+ export interface DeleteMenuV4StockMenuBusinessUnitBody {
9391
+ menu_id?: string;
9392
+ business_unit_id?: string;
9393
+ }
9394
+
9395
+ export interface DeleteMenuV4StockMenuBusinessUnitResponse {
9396
+ status?: string;
9397
+ }
9398
+
9399
+ export interface DeleteMenuV4StockMenuBusinessUnitRequest extends BaseRequest {
9400
+ body: DeleteMenuV4StockMenuBusinessUnitBody;
9401
+ }
9402
+
9403
+ // GET /menu/v4/stock/business-unit/{business_unit_id}
9404
+
9405
+ export interface GetMenuV4StockBusinessUnitPath {
9406
+ business_unit_id: string;
9407
+ }
9408
+
9409
+ export interface GetMenuV4StockBusinessUnitQuery {
9410
+ filter?: string;
9411
+ // If specified, only the selected fields will be returned
9412
+ select?: string[];
9413
+ // List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
9414
+ relationships?: string[];
9415
+ // Number of records to load per page
9416
+ limit?: number;
9417
+ page?: number;
9418
+ // A field to sort the results based on
9419
+ sort_by?: string;
9420
+ sort_order?: 'DESC' | 'ASC';
9421
+ // How soft deleted records should be shown in the list
9422
+ soft_deleted?: 'include' | 'exclude' | 'only';
9423
+ // Graphql query string
9424
+ _query?: string;
9425
+ }
9426
+
9427
+ export interface GetMenuV4StockBusinessUnitResponse {
9428
+ results: StockDTO[];
9429
+ meta?: ListResponseMetadataDTO;
9430
+ [index: string]: any;
9431
+ }
9432
+
9433
+ export interface GetMenuV4StockBusinessUnitRequest
9434
+ extends BaseRequest,
9435
+ RequestQuery<GetMenuV4StockBusinessUnitQuery>,
9436
+ GetMenuV4StockBusinessUnitPath {}
9437
+
9438
+ // POST /menu/v4/stock/publish
9439
+
9440
+ export interface PostMenuV4StockPublishBody {
9441
+ reset_time?: string;
9442
+ business_unit_id?: string;
9443
+ [index: string]: any;
9444
+ }
9445
+
9446
+ export interface PostMenuV4StockPublishResponse {
9447
+ status?: string;
9448
+ }
9449
+
9450
+ export interface PostMenuV4StockPublishRequest extends BaseRequest {
9451
+ body: PostMenuV4StockPublishBody;
9452
+ }
9453
+
9454
+ // POST /menu/v4/schedule-menu
9455
+
9456
+ export interface PostMenuV4ScheduleMenuBody {
9457
+ station_id: string;
9458
+ menu_id: string;
9459
+ price_level_id: string;
9460
+ [index: string]: any;
9461
+ }
9462
+
9463
+ export interface PostMenuV4ScheduleMenuResponse {
9464
+ parent?: DraftMenuDTO;
9465
+ children?: DraftMenuDTO[];
9466
+ categories?: DraftCategoryDTO[];
9467
+ stocks?: StockDTO[];
9468
+ station_id?: string;
9469
+ price_level_id?: string;
9470
+ id: string;
9471
+ created_at?: string;
9472
+ updated_at?: string;
9473
+ deleted_at?: string;
9474
+ parent_id?: string;
9475
+ name: string;
9476
+ brand_id: string;
9477
+ applied_diff_snapshot?: Record<string, any>;
9478
+ version?: number;
9479
+ brand?: DraftBrandDTO;
9480
+ changes?: MenuChangeDTO[];
9481
+ vendor_metadata?: VendorMetadataDTO[];
9482
+ permissions?: Record<string, any>;
9483
+ [index: string]: any;
9484
+ }
9485
+
9486
+ export interface PostMenuV4ScheduleMenuRequest extends BaseRequest {
9487
+ body: PostMenuV4ScheduleMenuBody;
9488
+ }
9489
+
9490
+ // POST /menu/v4/unschedule-menu
9491
+
9492
+ export interface PostMenuV4UnscheduleMenuBody {
9493
+ menu_id: string;
9494
+ [index: string]: any;
9495
+ }
9496
+
9497
+ export interface PostMenuV4UnscheduleMenuResponse {
9498
+ parent?: DraftMenuDTO;
9499
+ children?: DraftMenuDTO[];
9500
+ categories?: DraftCategoryDTO[];
9501
+ stocks?: StockDTO[];
9502
+ station_id?: string;
9503
+ price_level_id?: string;
9504
+ id: string;
9505
+ created_at?: string;
9506
+ updated_at?: string;
9507
+ deleted_at?: string;
9508
+ parent_id?: string;
9509
+ name: string;
9510
+ brand_id: string;
9511
+ applied_diff_snapshot?: Record<string, any>;
9512
+ version?: number;
9513
+ brand?: DraftBrandDTO;
9514
+ changes?: MenuChangeDTO[];
9515
+ vendor_metadata?: VendorMetadataDTO[];
9516
+ permissions?: Record<string, any>;
9517
+ [index: string]: any;
9518
+ }
9519
+
9520
+ export interface PostMenuV4UnscheduleMenuRequest extends BaseRequest {
9521
+ body: PostMenuV4UnscheduleMenuBody;
9522
+ }