@compassdigital/sdk.typescript 4.115.0 → 4.117.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.
@@ -725,7 +725,6 @@ export interface DraftItemToModifierGroupRelationshipDTO {
725
725
  brand?: DraftBrandDTO;
726
726
  changes?: ItemToModifierGroupRelationshipChangeDTO[];
727
727
  vendor_metadata?: VendorMetadataDTO[];
728
- is_global?: boolean;
729
728
  permissions?: Record<string, any>;
730
729
  [index: string]: any;
731
730
  }
@@ -771,7 +770,6 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
771
770
  brand?: DraftBrandDTO;
772
771
  changes?: ModifierGroupToModifierRelationshipChangeDTO[];
773
772
  vendor_metadata?: VendorMetadataDTO[];
774
- is_global?: boolean;
775
773
  permissions?: Record<string, any>;
776
774
  [index: string]: any;
777
775
  }
@@ -1096,6 +1094,20 @@ export interface ApplyDiffDTO {
1096
1094
  [index: string]: any;
1097
1095
  }
1098
1096
 
1097
+ export interface WarningDTO {
1098
+ barcode?: string;
1099
+ brand_id?: string;
1100
+ brand_name?: string;
1101
+ type?: string;
1102
+ items?: WarningItemDTO[];
1103
+ }
1104
+
1105
+ export interface WarningItemDTO {
1106
+ id?: string;
1107
+ item_name?: string;
1108
+ posid?: string;
1109
+ }
1110
+
1099
1111
  export interface PublishedMenuDTO {
1100
1112
  id?: string;
1101
1113
  parent_id?: string;
@@ -1166,7 +1178,6 @@ export interface PublishedItemToModifierGroupRelationshipDTO {
1166
1178
  item_id?: string;
1167
1179
  brand_id?: string;
1168
1180
  sequence?: number;
1169
- is_global?: boolean;
1170
1181
  permissions?: Record<string, any>;
1171
1182
  [index: string]: any;
1172
1183
  }
@@ -1196,7 +1207,6 @@ export interface PublishedModifierGroupToModifierRelationshipDTO {
1196
1207
  modifier_group_id?: string;
1197
1208
  brand_id?: string;
1198
1209
  sequence?: number;
1199
- is_global?: boolean;
1200
1210
  permissions?: Record<string, any>;
1201
1211
  [index: string]: any;
1202
1212
  }
@@ -1231,21 +1241,6 @@ export interface PublishedModifierDTO {
1231
1241
  [index: string]: any;
1232
1242
  }
1233
1243
 
1234
- export interface WarningDTO {
1235
- barcode?: string;
1236
- type?: string;
1237
- items?: WarningItemDTO[];
1238
- }
1239
-
1240
- export interface WarningItemDTO {
1241
- id?: string;
1242
- item_name?: string;
1243
- barcode?: string;
1244
- posid?: string;
1245
- brand_id?: string;
1246
- brand_name?: string;
1247
- }
1248
-
1249
1244
  export interface GroupStockUpdate {
1250
1245
  id: string;
1251
1246
  items?: ItemStockUpdate[];
@@ -3592,6 +3587,26 @@ export interface PostMenuV3DraftBrandImportRequest
3592
3587
  extends BaseRequest,
3593
3588
  PostMenuV3DraftBrandImportPath {}
3594
3589
 
3590
+ // GET /menu/v3/draft/brand/{id}/verify-publish
3591
+
3592
+ export interface GetMenuV3DraftBrandVerifyPublishPath {
3593
+ id: string;
3594
+ }
3595
+
3596
+ export interface GetMenuV3DraftBrandVerifyPublishQuery {
3597
+ // Graphql query string
3598
+ _query?: string;
3599
+ }
3600
+
3601
+ export interface GetMenuV3DraftBrandVerifyPublishResponse {
3602
+ warnings?: WarningDTO[];
3603
+ }
3604
+
3605
+ export interface GetMenuV3DraftBrandVerifyPublishRequest
3606
+ extends BaseRequest,
3607
+ RequestQuery<GetMenuV3DraftBrandVerifyPublishQuery>,
3608
+ GetMenuV3DraftBrandVerifyPublishPath {}
3609
+
3595
3610
  // POST /menu/v3/brand
3596
3611
 
3597
3612
  export interface PostMenuV3BrandQuery {
@@ -5585,7 +5600,6 @@ export interface PostMenuV3DraftItemRelationshipsModifierGroupBody {
5585
5600
  brand?: DraftBrandDTO;
5586
5601
  changes?: ItemToModifierGroupRelationshipChangeDTO[];
5587
5602
  vendor_metadata?: VendorMetadataDTO[];
5588
- is_global?: boolean;
5589
5603
  permissions?: Record<string, any>;
5590
5604
  [index: string]: any;
5591
5605
  }
@@ -5642,7 +5656,6 @@ export interface PatchMenuV3DraftItemRelationshipsModifierGroupBody {
5642
5656
  brand?: DraftBrandDTO;
5643
5657
  changes?: ItemToModifierGroupRelationshipChangeDTO[];
5644
5658
  vendor_metadata?: VendorMetadataDTO[];
5645
- is_global?: boolean;
5646
5659
  permissions?: Record<string, any>;
5647
5660
  [index: string]: any;
5648
5661
  }
@@ -5721,7 +5734,6 @@ export type PostMenuV3DraftItemRelationshipsModifierGroupsBody = {
5721
5734
  brand?: DraftBrandDTO;
5722
5735
  changes?: ItemToModifierGroupRelationshipChangeDTO[];
5723
5736
  vendor_metadata?: VendorMetadataDTO[];
5724
- is_global?: boolean;
5725
5737
  permissions?: Record<string, any>;
5726
5738
  [index: string]: any;
5727
5739
  }[];
@@ -6223,7 +6235,6 @@ export interface PostMenuV3DraftModifierGroupRelationshipsModifierBody {
6223
6235
  brand?: DraftBrandDTO;
6224
6236
  changes?: ModifierGroupToModifierRelationshipChangeDTO[];
6225
6237
  vendor_metadata?: VendorMetadataDTO[];
6226
- is_global?: boolean;
6227
6238
  permissions?: Record<string, any>;
6228
6239
  [index: string]: any;
6229
6240
  }
@@ -6280,7 +6291,6 @@ export interface PatchMenuV3DraftModifierGroupRelationshipsModifierBody {
6280
6291
  brand?: DraftBrandDTO;
6281
6292
  changes?: ModifierGroupToModifierRelationshipChangeDTO[];
6282
6293
  vendor_metadata?: VendorMetadataDTO[];
6283
- is_global?: boolean;
6284
6294
  permissions?: Record<string, any>;
6285
6295
  [index: string]: any;
6286
6296
  }
@@ -6359,7 +6369,6 @@ export type PostMenuV3DraftModifierGroupRelationshipsModifiersBody = {
6359
6369
  brand?: DraftBrandDTO;
6360
6370
  changes?: ModifierGroupToModifierRelationshipChangeDTO[];
6361
6371
  vendor_metadata?: VendorMetadataDTO[];
6362
- is_global?: boolean;
6363
6372
  permissions?: Record<string, any>;
6364
6373
  [index: string]: any;
6365
6374
  }[];
@@ -9303,7 +9312,6 @@ export type PostMenuV4ModifierGroupAttachModifiersBody = {
9303
9312
  brand?: DraftBrandDTO;
9304
9313
  changes?: ModifierGroupToModifierRelationshipChangeDTO[];
9305
9314
  vendor_metadata?: VendorMetadataDTO[];
9306
- is_global?: boolean;
9307
9315
  permissions?: Record<string, any>;
9308
9316
  [index: string]: any;
9309
9317
  }[];
@@ -62,6 +62,43 @@ export interface ShoppingCartResponse {
62
62
  order_loyalty_points?: boolean;
63
63
  };
64
64
  discount?: ShoppingCartResponse['promo'];
65
+ discounts?: {
66
+ id: string;
67
+ // unix epoch timestamp of discount creation in UTC
68
+ createdAt: string;
69
+ // unix epoch timestamp of discount update in UTC
70
+ updatedAt: string;
71
+ // id of the user who created the discount
72
+ createdBy: string;
73
+ // id of the user who updated the discount most recently
74
+ updatedBy: string;
75
+ name: string;
76
+ is?: {
77
+ badgepayPromo?: boolean;
78
+ mealplanPromo?: boolean;
79
+ decliningBalancePromo?: boolean;
80
+ voucherPromo?: boolean;
81
+ };
82
+ status?: {
83
+ live?: boolean;
84
+ publishedTo3rdParty?: boolean;
85
+ readyToPublish?: boolean;
86
+ };
87
+ meta?: {
88
+ provider: {
89
+ // Voucherify metadata
90
+ voucherify?: {
91
+ id?: string;
92
+ code?: string;
93
+ discount?: {
94
+ type: string;
95
+ amountOff?: number;
96
+ percentOff?: number;
97
+ };
98
+ };
99
+ };
100
+ };
101
+ }[];
65
102
  payment_method?: {
66
103
  // Mealplan payment details
67
104
  mealplan?: {
@@ -373,6 +410,14 @@ export interface LocationGroup {
373
410
  alt_logo?: string | null;
374
411
  };
375
412
  timezone?: string;
413
+ device_mapping?: Record<
414
+ string,
415
+ {
416
+ device_type?: string;
417
+ site_device_id?: string;
418
+ name?: string;
419
+ }[]
420
+ >;
376
421
  [index: string]: any;
377
422
  }
378
423
 
@@ -476,7 +521,7 @@ export interface Brand {
476
521
  {
477
522
  device_type: string;
478
523
  site_device_id: string;
479
- business_units: string[];
524
+ business_units?: string[];
480
525
  }[]
481
526
  >;
482
527
  timeslots?: {
@@ -566,11 +611,21 @@ export interface Brand {
566
611
  jwo?: string;
567
612
  time2eat?: {
568
613
  enabled?: boolean;
614
+ use_timeslots?: boolean;
615
+ ignore_station_hours?: boolean;
569
616
  };
570
617
  nextep?: {
571
618
  mobile_app?: boolean;
619
+ web?: boolean;
572
620
  };
573
621
  };
622
+ type_of_kds?: {
623
+ cdl?: boolean;
624
+ nextep?: boolean;
625
+ volante?: boolean;
626
+ agilysys?: boolean;
627
+ [index: string]: any;
628
+ };
574
629
  [index: string]: any;
575
630
  };
576
631
  descriptions?: {
@@ -658,7 +713,6 @@ export interface WaitTime {
658
713
  }
659
714
 
660
715
  export interface Menu {
661
- // menu
662
716
  id?: string;
663
717
  date?: {
664
718
  created?: string;
@@ -669,13 +723,9 @@ export interface Menu {
669
723
  en?: string;
670
724
  };
671
725
  groups?: Group[];
672
- // menu
673
726
  parent_id?: string;
674
- // brand
675
727
  location_brand?: string;
676
- // company
677
728
  company?: string;
678
- // sector
679
729
  sector?: string;
680
730
  is?: {
681
731
  disabled?: boolean;
@@ -713,7 +763,6 @@ export interface Menu {
713
763
  }
714
764
 
715
765
  export interface Group {
716
- // group
717
766
  id?: string;
718
767
  name?: string;
719
768
  label?: {
@@ -721,7 +770,6 @@ export interface Group {
721
770
  fr?: string;
722
771
  };
723
772
  items?: {
724
- // item
725
773
  id?: string;
726
774
  label?: {
727
775
  en?: string;
@@ -791,7 +839,6 @@ export interface Group {
791
839
  salt_free?: boolean;
792
840
  };
793
841
  options?: {
794
- // modifier_group
795
842
  id?: string;
796
843
  label?: {
797
844
  en?: string;
@@ -799,7 +846,6 @@ export interface Group {
799
846
  unique_name?: string;
800
847
  name?: string;
801
848
  items?: {
802
- // option
803
849
  id?: string;
804
850
  label?: {
805
851
  en?: string;