@compassdigital/sdk.typescript 3.49.0 → 3.50.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.
@@ -456,25 +456,22 @@ export interface CategoryDTO {
456
456
  is_active?: boolean;
457
457
  layout_id?: string;
458
458
  id?: string;
459
- layout?: LayoutDTO;
460
- items?: any[];
461
459
  [index: string]: any;
462
460
  }
463
461
  export interface LayoutDTO {
464
462
  name: string;
465
- categories?: any[];
463
+ categories?: CategoryDTO[];
466
464
  brand_id: string;
467
465
  station_id: string;
468
- id?: any;
466
+ id?: string;
467
+ created_at?: string;
468
+ updated_at?: string;
469
+ deleted_at?: string;
469
470
  brand?: BrandDTO;
470
- station?: any;
471
+ station?: StationDTO;
471
472
  [index: string]: any;
472
473
  }
473
474
  export interface BrandDTO {
474
- layouts?: any[];
475
- items?: ItemDTO[];
476
- modifier_groups?: any[];
477
- modifiers?: any[];
478
475
  id?: string;
479
476
  [index: string]: any;
480
477
  }
@@ -490,13 +487,9 @@ export interface ItemDTO {
490
487
  is_in_stock?: boolean;
491
488
  posid?: string;
492
489
  tax_tags?: string[];
493
- modifier_groups?: ItemToModifierGroupRelationshipDTO[];
494
490
  brand_id?: string;
495
491
  station_id?: string;
496
492
  id?: string;
497
- categories?: CategoryToItemRelationshipDTO[];
498
- brand?: any;
499
- station?: any;
500
493
  [index: string]: any;
501
494
  }
502
495
  export interface ItemToModifierGroupRelationshipDTO {
@@ -504,8 +497,6 @@ export interface ItemToModifierGroupRelationshipDTO {
504
497
  item_id?: string;
505
498
  sequence?: number;
506
499
  id?: string;
507
- modifier_group?: ModifierGroupDTO;
508
- item?: any;
509
500
  [index: string]: any;
510
501
  }
511
502
  export interface ModifierGroupDTO {
@@ -515,13 +506,9 @@ export interface ModifierGroupDTO {
515
506
  max?: number;
516
507
  is_active?: boolean;
517
508
  priority?: number;
518
- modifiers?: ModifierGroupToModifierRelationshipDTO[];
519
- items?: any[];
520
509
  brand_id?: string;
521
510
  station_id?: string;
522
511
  id?: string;
523
- brand?: any;
524
- station?: any;
525
512
  [index: string]: any;
526
513
  }
527
514
  export interface ModifierGroupToModifierRelationshipDTO {
@@ -529,8 +516,6 @@ export interface ModifierGroupToModifierRelationshipDTO {
529
516
  modifier_group_id?: string;
530
517
  sequence?: number;
531
518
  id?: string;
532
- modifier?: ModifierDTO;
533
- modifier_group?: any;
534
519
  [index: string]: any;
535
520
  }
536
521
  export interface ModifierDTO {
@@ -544,20 +529,14 @@ export interface ModifierDTO {
544
529
  is_active?: boolean;
545
530
  is_in_stock?: boolean;
546
531
  posid?: string;
547
- modifier_groups?: any[];
548
532
  brand_id?: string;
549
533
  station_id?: string;
550
534
  id?: string;
551
- brand?: any;
552
- station?: StationDTO;
553
535
  [index: string]: any;
554
536
  }
555
537
  export interface StationDTO {
556
- layouts?: any[];
557
- items?: any[];
558
- modifier_groups?: any[];
559
- modifiers?: any[];
560
538
  id?: string;
539
+ name?: string;
561
540
  [index: string]: any;
562
541
  }
563
542
  export interface CategoryToItemRelationshipDTO {
@@ -565,8 +544,6 @@ export interface CategoryToItemRelationshipDTO {
565
544
  item_id?: string;
566
545
  sequence?: number;
567
546
  id?: string;
568
- category?: any;
569
- item?: any;
570
547
  [index: string]: any;
571
548
  }
572
549
  export interface InvalidInputErrorDTO {
@@ -590,7 +567,7 @@ export interface NotFoundErrorDTO {
590
567
  [index: string]: any;
591
568
  }
592
569
  export interface FilterFieldDTO {
593
- $equal?: string;
570
+ $equals?: string;
594
571
  $more_than?: string;
595
572
  $more_than_or_equal?: string;
596
573
  $less_than?: string;
@@ -624,6 +601,74 @@ export interface PaginationMetaDTO {
624
601
  soft_deleted?: string;
625
602
  [index: string]: any;
626
603
  }
604
+ export interface UnauthorizedErrorDTO {
605
+ number: number;
606
+ message: string;
607
+ [index: string]: any;
608
+ }
609
+ export interface ModifierEntityDTO {
610
+ name: string;
611
+ label?: string;
612
+ description?: string;
613
+ price: number;
614
+ calories?: number;
615
+ priority?: number;
616
+ tax_tags?: string[];
617
+ is_active?: boolean;
618
+ is_in_stock?: boolean;
619
+ posid: string;
620
+ modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
621
+ brand_id: string;
622
+ station_id?: string;
623
+ id?: string;
624
+ created_at?: string;
625
+ updated_at?: string;
626
+ deleted_at?: string;
627
+ brand?: BrandDTO;
628
+ station?: StationDTO;
629
+ [index: string]: any;
630
+ }
631
+ export interface ModifierGroupEntityDTO {
632
+ name: string;
633
+ label?: string;
634
+ min?: number;
635
+ max?: number;
636
+ is_active?: boolean;
637
+ priority?: number;
638
+ modifiers?: ModifierGroupToModifierRelationshipDTO[];
639
+ items?: ItemToModifierGroupRelationshipDTO[];
640
+ brand_id: string;
641
+ station_id?: string;
642
+ id?: string;
643
+ created_at?: string;
644
+ updated_at?: string;
645
+ deleted_at?: string;
646
+ brand?: BrandDTO;
647
+ station?: StationDTO;
648
+ [index: string]: any;
649
+ }
650
+ export interface ItemEntityDTO {
651
+ name: string;
652
+ label?: string;
653
+ description?: string;
654
+ price: number;
655
+ calories?: number;
656
+ priority?: number;
657
+ tax_tags?: string[];
658
+ is_active?: boolean;
659
+ is_in_stock?: boolean;
660
+ posid: string;
661
+ modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
662
+ brand_id: string;
663
+ station_id?: string;
664
+ id?: string;
665
+ created_at?: string;
666
+ updated_at?: string;
667
+ deleted_at?: string;
668
+ brand?: BrandDTO;
669
+ station?: StationDTO;
670
+ [index: string]: any;
671
+ }
627
672
  export interface GetMenuV3ModifiersQuery {
628
673
  filter?: any;
629
674
  limit?: number;
@@ -726,7 +771,6 @@ export interface PostMenuV3ModifierBody {
726
771
  modifier_groups?: ModifierGroupToModifierRelationshipDTO[];
727
772
  brand_id: string;
728
773
  station_id?: string;
729
- id?: any;
730
774
  brand?: BrandDTO;
731
775
  station?: StationDTO;
732
776
  [index: string]: any;
@@ -796,7 +840,6 @@ export interface PostMenuV3ModifierGroupBody {
796
840
  items?: ItemToModifierGroupRelationshipDTO[];
797
841
  brand_id: string;
798
842
  station_id?: string;
799
- id?: any;
800
843
  brand?: BrandDTO;
801
844
  station?: StationDTO;
802
845
  [index: string]: any;
@@ -892,7 +935,6 @@ export interface PostMenuV3ModifierGroupRelationshipsModifierBody {
892
935
  modifier_id: string;
893
936
  modifier_group_id: string;
894
937
  sequence?: number;
895
- id?: any;
896
938
  modifier?: ModifierDTO;
897
939
  modifier_group?: ModifierGroupDTO;
898
940
  [index: string]: any;
@@ -1041,7 +1083,6 @@ export interface PostMenuV3ItemBody {
1041
1083
  modifier_groups?: ItemToModifierGroupRelationshipDTO[];
1042
1084
  brand_id: string;
1043
1085
  station_id?: string;
1044
- id?: any;
1045
1086
  categories?: CategoryToItemRelationshipDTO[];
1046
1087
  brand?: BrandDTO;
1047
1088
  station?: StationDTO;
@@ -1100,7 +1141,6 @@ export interface PostMenuV3ItemRelationshipsModifierGroupBody {
1100
1141
  modifier_group_id: string;
1101
1142
  item_id: string;
1102
1143
  sequence?: number;
1103
- id?: any;
1104
1144
  modifier_group?: ModifierGroupDTO;
1105
1145
  item?: ItemDTO;
1106
1146
  [index: string]: any;
@@ -1207,7 +1247,19 @@ export interface GetMenuV3LayoutQuery {
1207
1247
  relationships?: string[];
1208
1248
  _query?: string;
1209
1249
  }
1210
- export type GetMenuV3LayoutResponse = LayoutDTO;
1250
+ export interface GetMenuV3LayoutResponse {
1251
+ name: string;
1252
+ categories?: CategoryDTO[];
1253
+ brand_id: string;
1254
+ station_id: string;
1255
+ id?: string;
1256
+ created_at?: string;
1257
+ updated_at?: string;
1258
+ deleted_at?: string;
1259
+ brand?: BrandDTO;
1260
+ station?: StationDTO;
1261
+ [index: string]: any;
1262
+ }
1211
1263
  export interface GetMenuV3LayoutRequest extends BaseRequest, RequestQuery<GetMenuV3LayoutQuery>, GetMenuV3LayoutPath {
1212
1264
  }
1213
1265
  export interface PatchMenuV3LayoutPath {
@@ -1223,14 +1275,38 @@ export interface PatchMenuV3LayoutBody {
1223
1275
  station?: StationDTO;
1224
1276
  [index: string]: any;
1225
1277
  }
1226
- export type PatchMenuV3LayoutResponse = LayoutDTO;
1278
+ export interface PatchMenuV3LayoutResponse {
1279
+ name: string;
1280
+ categories?: CategoryDTO[];
1281
+ brand_id: string;
1282
+ station_id: string;
1283
+ id?: string;
1284
+ created_at?: string;
1285
+ updated_at?: string;
1286
+ deleted_at?: string;
1287
+ brand?: BrandDTO;
1288
+ station?: StationDTO;
1289
+ [index: string]: any;
1290
+ }
1227
1291
  export interface PatchMenuV3LayoutRequest extends BaseRequest, PatchMenuV3LayoutPath {
1228
1292
  body: PatchMenuV3LayoutBody;
1229
1293
  }
1230
1294
  export interface DeleteMenuV3LayoutPath {
1231
1295
  id: string;
1232
1296
  }
1233
- export type DeleteMenuV3LayoutResponse = LayoutDTO;
1297
+ export interface DeleteMenuV3LayoutResponse {
1298
+ name: string;
1299
+ categories?: CategoryDTO[];
1300
+ brand_id: string;
1301
+ station_id: string;
1302
+ id?: string;
1303
+ created_at?: string;
1304
+ updated_at?: string;
1305
+ deleted_at?: string;
1306
+ brand?: BrandDTO;
1307
+ station?: StationDTO;
1308
+ [index: string]: any;
1309
+ }
1234
1310
  export interface DeleteMenuV3LayoutRequest extends BaseRequest, DeleteMenuV3LayoutPath {
1235
1311
  }
1236
1312
  export interface PostMenuV3LayoutBody {
@@ -1238,12 +1314,23 @@ export interface PostMenuV3LayoutBody {
1238
1314
  categories?: CategoryDTO[];
1239
1315
  brand_id: string;
1240
1316
  station_id: string;
1241
- id?: any;
1242
- brand?: any;
1243
- station?: any;
1317
+ brand?: BrandDTO;
1318
+ station?: StationDTO;
1319
+ [index: string]: any;
1320
+ }
1321
+ export interface PostMenuV3LayoutResponse {
1322
+ name: string;
1323
+ categories?: CategoryDTO[];
1324
+ brand_id: string;
1325
+ station_id: string;
1326
+ id?: string;
1327
+ created_at?: string;
1328
+ updated_at?: string;
1329
+ deleted_at?: string;
1330
+ brand?: BrandDTO;
1331
+ station?: StationDTO;
1244
1332
  [index: string]: any;
1245
1333
  }
1246
- export type PostMenuV3LayoutResponse = LayoutDTO;
1247
1334
  export interface PostMenuV3LayoutRequest extends BaseRequest {
1248
1335
  body: PostMenuV3LayoutBody;
1249
1336
  }
@@ -1257,24 +1344,6 @@ export interface GetMenuV3LayoutsCountResponse {
1257
1344
  }
1258
1345
  export interface GetMenuV3LayoutsCountRequest extends BaseRequest, RequestQuery<GetMenuV3LayoutsCountQuery> {
1259
1346
  }
1260
- export interface GetMenuV3CategoriesQuery {
1261
- filter?: any;
1262
- limit?: number;
1263
- page?: number;
1264
- sort_by?: string;
1265
- sort_order?: string;
1266
- soft_deleted?: string;
1267
- select?: string[];
1268
- relationships?: string[];
1269
- _query?: string;
1270
- }
1271
- export interface GetMenuV3CategoriesResponse {
1272
- meta: PaginationMetaDTO;
1273
- results: CategoryDTO[];
1274
- [index: string]: any;
1275
- }
1276
- export interface GetMenuV3CategoriesRequest extends BaseRequest, RequestQuery<GetMenuV3CategoriesQuery> {
1277
- }
1278
1347
  export interface GetMenuV3CategoryPath {
1279
1348
  id: string;
1280
1349
  }
@@ -1318,7 +1387,6 @@ export interface PostMenuV3CategoryBody {
1318
1387
  priority?: number;
1319
1388
  is_active?: boolean;
1320
1389
  layout_id: string;
1321
- id?: any;
1322
1390
  layout?: LayoutDTO;
1323
1391
  items?: CategoryToItemRelationshipDTO[];
1324
1392
  [index: string]: any;
@@ -1376,7 +1444,6 @@ export interface PostMenuV3CategoryRelationshipsItemBody {
1376
1444
  category_id: string;
1377
1445
  item_id: string;
1378
1446
  sequence?: number;
1379
- id?: any;
1380
1447
  category?: CategoryDTO;
1381
1448
  item?: ItemDTO;
1382
1449
  [index: string]: any;
@@ -1552,7 +1619,6 @@ export interface PostMenuV3BrandBody {
1552
1619
  items?: ItemDTO[];
1553
1620
  modifier_groups?: ModifierGroupDTO[];
1554
1621
  modifiers?: ModifierDTO[];
1555
- id?: any;
1556
1622
  [index: string]: any;
1557
1623
  }
1558
1624
  export type PostMenuV3BrandResponse = BrandDTO;
@@ -1593,6 +1659,7 @@ export type PostMenuV3StationsBody = {
1593
1659
  modifier_groups?: ModifierGroupDTO[];
1594
1660
  modifiers?: ModifierDTO[];
1595
1661
  id?: any;
1662
+ name?: string;
1596
1663
  [index: string]: any;
1597
1664
  }[];
1598
1665
  export interface PostMenuV3StationsResponse {
@@ -1623,6 +1690,7 @@ export interface PatchMenuV3StationBody {
1623
1690
  modifier_groups?: ModifierGroupDTO[];
1624
1691
  modifiers?: ModifierDTO[];
1625
1692
  id?: string;
1693
+ name?: string;
1626
1694
  [index: string]: any;
1627
1695
  }
1628
1696
  export type PatchMenuV3StationResponse = StationDTO;
@@ -1640,7 +1708,7 @@ export interface PostMenuV3StationBody {
1640
1708
  items?: ItemDTO[];
1641
1709
  modifier_groups?: ModifierGroupDTO[];
1642
1710
  modifiers?: ModifierDTO[];
1643
- id?: any;
1711
+ name?: string;
1644
1712
  [index: string]: any;
1645
1713
  }
1646
1714
  export type PostMenuV3StationResponse = StationDTO;
@@ -2018,7 +2086,7 @@ export interface GetMenuV3StationModifiersQuery {
2018
2086
  }
2019
2087
  export interface GetMenuV3StationModifiersResponse {
2020
2088
  meta: PaginationMetaDTO;
2021
- results: ModifierDTO[];
2089
+ results: ModifierEntityDTO[];
2022
2090
  [index: string]: any;
2023
2091
  }
2024
2092
  export interface GetMenuV3StationModifiersRequest extends BaseRequest, RequestQuery<GetMenuV3StationModifiersQuery>, GetMenuV3StationModifiersPath {
@@ -2039,7 +2107,7 @@ export interface GetMenuV3StationModifierGroupsQuery {
2039
2107
  }
2040
2108
  export interface GetMenuV3StationModifierGroupsResponse {
2041
2109
  meta: PaginationMetaDTO;
2042
- results: ModifierGroupDTO[];
2110
+ results: ModifierGroupEntityDTO[];
2043
2111
  [index: string]: any;
2044
2112
  }
2045
2113
  export interface GetMenuV3StationModifierGroupsRequest extends BaseRequest, RequestQuery<GetMenuV3StationModifierGroupsQuery>, GetMenuV3StationModifierGroupsPath {
@@ -2060,7 +2128,7 @@ export interface GetMenuV3StationItemsQuery {
2060
2128
  }
2061
2129
  export interface GetMenuV3StationItemsResponse {
2062
2130
  meta: PaginationMetaDTO;
2063
- results: ItemDTO[];
2131
+ results: ItemEntityDTO[];
2064
2132
  [index: string]: any;
2065
2133
  }
2066
2134
  export interface GetMenuV3StationItemsRequest extends BaseRequest, RequestQuery<GetMenuV3StationItemsQuery>, GetMenuV3StationItemsPath {