@compassdigital/sdk.typescript 3.10.0 → 3.12.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.
Files changed (99) hide show
  1. package/bin/gen.js +4 -1
  2. package/gen.ts +5 -2
  3. package/lib/index.d.ts +39 -2
  4. package/lib/index.d.ts.map +1 -1
  5. package/lib/index.js +45 -0
  6. package/lib/index.js.map +1 -1
  7. package/lib/interface/announcement.d.ts +3 -2
  8. package/lib/interface/announcement.d.ts.map +1 -1
  9. package/lib/interface/brand.d.ts.map +1 -1
  10. package/lib/interface/calendar.d.ts +3 -2
  11. package/lib/interface/calendar.d.ts.map +1 -1
  12. package/lib/interface/compassconnect.d.ts +2 -1
  13. package/lib/interface/compassconnect.d.ts.map +1 -1
  14. package/lib/interface/config.d.ts +2 -0
  15. package/lib/interface/config.d.ts.map +1 -1
  16. package/lib/interface/datalake.d.ts.map +1 -1
  17. package/lib/interface/delivery.d.ts.map +1 -1
  18. package/lib/interface/dh.d.ts.map +1 -1
  19. package/lib/interface/email.d.ts.map +1 -1
  20. package/lib/interface/file.d.ts.map +1 -1
  21. package/lib/interface/kds.d.ts +2 -1
  22. package/lib/interface/kds.d.ts.map +1 -1
  23. package/lib/interface/location.d.ts +24 -21
  24. package/lib/interface/location.d.ts.map +1 -1
  25. package/lib/interface/logger.d.ts +2 -1
  26. package/lib/interface/logger.d.ts.map +1 -1
  27. package/lib/interface/loyalty.d.ts +12 -11
  28. package/lib/interface/loyalty.d.ts.map +1 -1
  29. package/lib/interface/mealplan.d.ts +2 -1
  30. package/lib/interface/mealplan.d.ts.map +1 -1
  31. package/lib/interface/menu.d.ts +11 -10
  32. package/lib/interface/menu.d.ts.map +1 -1
  33. package/lib/interface/message.d.ts.map +1 -1
  34. package/lib/interface/notification.d.ts +2 -1
  35. package/lib/interface/notification.d.ts.map +1 -1
  36. package/lib/interface/order.d.ts +6 -5
  37. package/lib/interface/order.d.ts.map +1 -1
  38. package/lib/interface/partner.d.ts +4 -0
  39. package/lib/interface/partner.d.ts.map +1 -1
  40. package/lib/interface/payment.d.ts +5 -4
  41. package/lib/interface/payment.d.ts.map +1 -1
  42. package/lib/interface/permission.d.ts +3 -2
  43. package/lib/interface/permission.d.ts.map +1 -1
  44. package/lib/interface/promo.d.ts +5 -4
  45. package/lib/interface/promo.d.ts.map +1 -1
  46. package/lib/interface/report.d.ts +9 -8
  47. package/lib/interface/report.d.ts.map +1 -1
  48. package/lib/interface/schedule.d.ts +2 -1
  49. package/lib/interface/schedule.d.ts.map +1 -1
  50. package/lib/interface/shoppingcart.d.ts +4 -0
  51. package/lib/interface/shoppingcart.d.ts.map +1 -1
  52. package/lib/interface/sms.d.ts +1 -0
  53. package/lib/interface/sms.js +1 -0
  54. package/lib/interface/task.d.ts +4 -3
  55. package/lib/interface/task.d.ts.map +1 -1
  56. package/lib/interface/user.d.ts +15 -14
  57. package/lib/interface/user.d.ts.map +1 -1
  58. package/lib/interface/util.d.ts +7 -0
  59. package/lib/interface/util.d.ts.map +1 -0
  60. package/lib/interface/util.js +3 -0
  61. package/lib/interface/util.js.map +1 -0
  62. package/lib/interface/vendor.d.ts +115 -2
  63. package/lib/interface/vendor.d.ts.map +1 -1
  64. package/lib/interface/vote.d.ts +2 -1
  65. package/lib/interface/vote.d.ts.map +1 -1
  66. package/package.json +1 -1
  67. package/src/index.ts +109 -0
  68. package/src/interface/announcement.ts +5 -2
  69. package/src/interface/brand.ts +2 -0
  70. package/src/interface/calendar.ts +6 -2
  71. package/src/interface/compassconnect.ts +4 -1
  72. package/src/interface/config.ts +8 -0
  73. package/src/interface/datalake.ts +2 -0
  74. package/src/interface/delivery.ts +2 -0
  75. package/src/interface/dh.ts +2 -0
  76. package/src/interface/email.ts +2 -0
  77. package/src/interface/file.ts +2 -0
  78. package/src/interface/kds.ts +3 -1
  79. package/src/interface/location.ts +34 -21
  80. package/src/interface/logger.ts +3 -1
  81. package/src/interface/loyalty.ts +25 -11
  82. package/src/interface/mealplan.ts +5 -1
  83. package/src/interface/menu.ts +12 -10
  84. package/src/interface/message.ts +2 -0
  85. package/src/interface/notification.ts +3 -1
  86. package/src/interface/order.ts +7 -5
  87. package/src/interface/partner.ts +7 -0
  88. package/src/interface/payment.ts +8 -4
  89. package/src/interface/permission.ts +4 -2
  90. package/src/interface/promo.ts +6 -4
  91. package/src/interface/report.ts +12 -8
  92. package/src/interface/schedule.ts +3 -1
  93. package/src/interface/shoppingcart.ts +7 -0
  94. package/src/interface/sms.ts +2 -0
  95. package/src/interface/task.ts +7 -3
  96. package/src/interface/user.ts +20 -14
  97. package/src/interface/util.ts +7 -0
  98. package/src/interface/vendor.ts +157 -2
  99. package/src/interface/vote.ts +3 -1
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -71,7 +73,7 @@ export interface GetCalendarQuery {
71
73
 
72
74
  export type GetCalendarResponse = Calendar;
73
75
 
74
- export interface GetCalendarRequest extends GetCalendarQuery, GetCalendarPath {}
76
+ export interface GetCalendarRequest extends WithStringProps<GetCalendarQuery>, GetCalendarPath {}
75
77
 
76
78
  // PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
77
79
 
@@ -113,7 +115,9 @@ export interface GetCalendarCdlQuery {
113
115
 
114
116
  export type GetCalendarCdlResponse = CDLCalendar;
115
117
 
116
- export interface GetCalendarCdlRequest extends GetCalendarCdlQuery, GetCalendarCdlPath {}
118
+ export interface GetCalendarCdlRequest
119
+ extends WithStringProps<GetCalendarCdlQuery>,
120
+ GetCalendarCdlPath {}
117
121
 
118
122
  // GET /calendar/swagger.json
119
123
 
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface OMSRequest {
4
6
  code: string;
5
7
  client_id: string;
@@ -47,4 +49,5 @@ export interface GetCompassconnectOmsTokenQuery {
47
49
 
48
50
  export type GetCompassconnectOmsTokenResponse = Auth;
49
51
 
50
- export interface GetCompassconnectOmsTokenRequest extends GetCompassconnectOmsTokenQuery {}
52
+ export interface GetCompassconnectOmsTokenRequest
53
+ extends WithStringProps<GetCompassconnectOmsTokenQuery> {}
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export type CreateConfig = any;
4
6
 
5
7
  export interface Config {
@@ -15,6 +17,12 @@ export interface Success {
15
17
  success?: boolean;
16
18
  }
17
19
 
20
+ // GET /config/appconfig - get appconfig - an object with data for clients including minimum versions apps (boost, thrive, J&J) should be running and a link to the respective app store
21
+
22
+ export type GetConfigAppconfigResponse = Config;
23
+
24
+ export type GetConfigAppconfigRequest = {};
25
+
18
26
  // GET /config/{key} - get a configuration
19
27
 
20
28
  export interface GetConfigPath {
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  error?: string;
5
7
  code?: number;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  code?: number;
5
7
  message?: string;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  error?: string;
5
7
  code?: number;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Success {
4
6
  success: boolean;
5
7
  }
@@ -65,7 +67,7 @@ export interface GetKdsDevicesQuery {
65
67
 
66
68
  export type GetKdsDevicesResponse = Units;
67
69
 
68
- export interface GetKdsDevicesRequest extends GetKdsDevicesQuery {}
70
+ export interface GetKdsDevicesRequest extends WithStringProps<GetKdsDevicesQuery> {}
69
71
 
70
72
  // POST /kds/device/auth - Get auth token for a device
71
73
 
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface POS {
4
6
  // pos
5
7
  id?: string;
@@ -446,7 +448,7 @@ export interface GetLocationSearchQuery {
446
448
 
447
449
  export type GetLocationSearchResponse = Locations;
448
450
 
449
- export interface GetLocationSearchRequest extends GetLocationSearchQuery {}
451
+ export interface GetLocationSearchRequest extends WithStringProps<GetLocationSearchQuery> {}
450
452
 
451
453
  // GET /location/{id} - Get an individual Location
452
454
 
@@ -467,7 +469,7 @@ export interface GetLocationQuery {
467
469
 
468
470
  export type GetLocationResponse = Location;
469
471
 
470
- export interface GetLocationRequest extends GetLocationQuery, GetLocationPath {}
472
+ export interface GetLocationRequest extends WithStringProps<GetLocationQuery>, GetLocationPath {}
471
473
 
472
474
  // PUT /location/{id} - Override a complete Location
473
475
 
@@ -551,7 +553,8 @@ export interface GetLocationMultigroupsQuery {
551
553
 
552
554
  export type GetLocationMultigroupsResponse = Multigroups;
553
555
 
554
- export interface GetLocationMultigroupsRequest extends GetLocationMultigroupsQuery {}
556
+ export interface GetLocationMultigroupsRequest
557
+ extends WithStringProps<GetLocationMultigroupsQuery> {}
555
558
 
556
559
  // POST /location/multigroup - Create a new multigroup
557
560
 
@@ -587,13 +590,15 @@ export interface GetLocationMultigroupQuery {
587
590
  web?: boolean;
588
591
  // filters for non-marketplace locations only
589
592
  non_market_places?: boolean;
593
+ // filters for non-scan & go locations only
594
+ non_scan_go?: boolean;
590
595
  nocache?: boolean;
591
596
  }
592
597
 
593
598
  export type GetLocationMultigroupResponse = MultiGroup;
594
599
 
595
600
  export interface GetLocationMultigroupRequest
596
- extends GetLocationMultigroupQuery,
601
+ extends WithStringProps<GetLocationMultigroupQuery>,
597
602
  GetLocationMultigroupPath {}
598
603
 
599
604
  // PUT /location/multigroup/{id} - Override a complete multigroup
@@ -661,7 +666,7 @@ export interface GetLocationUserMultigroupQuery {
661
666
  export type GetLocationUserMultigroupResponse = Groups;
662
667
 
663
668
  export interface GetLocationUserMultigroupRequest
664
- extends GetLocationUserMultigroupQuery,
669
+ extends WithStringProps<GetLocationUserMultigroupQuery>,
665
670
  GetLocationUserMultigroupPath {}
666
671
 
667
672
  // POST /location/group - Create a new group
@@ -694,12 +699,16 @@ export interface GetLocationGroupQuery {
694
699
  web?: boolean;
695
700
  // return only groups with non-marketplace locations/brands
696
701
  non_market_places?: boolean;
702
+ // return only groups with non-scan & go locations/brands
703
+ non_scan_go?: boolean;
697
704
  nocache?: boolean;
698
705
  }
699
706
 
700
707
  export type GetLocationGroupResponse = Group;
701
708
 
702
- export interface GetLocationGroupRequest extends GetLocationGroupQuery, GetLocationGroupPath {}
709
+ export interface GetLocationGroupRequest
710
+ extends WithStringProps<GetLocationGroupQuery>,
711
+ GetLocationGroupPath {}
703
712
 
704
713
  // PUT /location/group/{id} - Override a complete Group
705
714
 
@@ -766,7 +775,7 @@ export interface GetLocationGroupDeliverydestinationsResponse {
766
775
  }
767
776
 
768
777
  export interface GetLocationGroupDeliverydestinationsRequest
769
- extends GetLocationGroupDeliverydestinationsQuery,
778
+ extends WithStringProps<GetLocationGroupDeliverydestinationsQuery>,
770
779
  GetLocationGroupDeliverydestinationsPath {}
771
780
 
772
781
  // POST /location/group/{id}/deliverydestination - Create a new location group delivery destination
@@ -857,7 +866,7 @@ export interface GetLocationUserGroupQuery {
857
866
  export type GetLocationUserGroupResponse = Group;
858
867
 
859
868
  export interface GetLocationUserGroupRequest
860
- extends GetLocationUserGroupQuery,
869
+ extends WithStringProps<GetLocationUserGroupQuery>,
861
870
  GetLocationUserGroupPath {}
862
871
 
863
872
  // GET /location/brands - Get all location brands
@@ -955,7 +964,7 @@ export interface GetLocationBrandTimeslotsQuery {
955
964
  export type GetLocationBrandTimeslotsResponse = TimeSlots;
956
965
 
957
966
  export interface GetLocationBrandTimeslotsRequest
958
- extends GetLocationBrandTimeslotsQuery,
967
+ extends WithStringProps<GetLocationBrandTimeslotsQuery>,
959
968
  GetLocationBrandTimeslotsPath {}
960
969
 
961
970
  // POST /location/marketplace/timeslots - Get Market Place timeslots
@@ -972,7 +981,7 @@ export type PostLocationMarketplaceTimeslotsBody = MarketPlace;
972
981
  export type PostLocationMarketplaceTimeslotsResponse = TimeSlots;
973
982
 
974
983
  export interface PostLocationMarketplaceTimeslotsRequest
975
- extends PostLocationMarketplaceTimeslotsQuery {
984
+ extends WithStringProps<PostLocationMarketplaceTimeslotsQuery> {
976
985
  body: PostLocationMarketplaceTimeslotsBody;
977
986
  }
978
987
 
@@ -990,7 +999,7 @@ export type PostLocationMarketplaceTimeslotsDeliveryBody = MarketPlace;
990
999
  export type PostLocationMarketplaceTimeslotsDeliveryResponse = TimeSlots;
991
1000
 
992
1001
  export interface PostLocationMarketplaceTimeslotsDeliveryRequest
993
- extends PostLocationMarketplaceTimeslotsDeliveryQuery {
1002
+ extends WithStringProps<PostLocationMarketplaceTimeslotsDeliveryQuery> {
994
1003
  body: PostLocationMarketplaceTimeslotsDeliveryBody;
995
1004
  }
996
1005
 
@@ -1013,7 +1022,7 @@ export interface GetLocationBrandMenuTimeslotsQuery {
1013
1022
  export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
1014
1023
 
1015
1024
  export interface GetLocationBrandMenuTimeslotsRequest
1016
- extends GetLocationBrandMenuTimeslotsQuery,
1025
+ extends WithStringProps<GetLocationBrandMenuTimeslotsQuery>,
1017
1026
  GetLocationBrandMenuTimeslotsPath {}
1018
1027
 
1019
1028
  // GET /location/brand/{id}/timeslots/delivery - Get location brand delivery timeslots
@@ -1033,7 +1042,7 @@ export interface GetLocationBrandDeliveryTimeslotsQuery {
1033
1042
  export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
1034
1043
 
1035
1044
  export interface GetLocationBrandDeliveryTimeslotsRequest
1036
- extends GetLocationBrandDeliveryTimeslotsQuery,
1045
+ extends WithStringProps<GetLocationBrandDeliveryTimeslotsQuery>,
1037
1046
  GetLocationBrandDeliveryTimeslotsPath {}
1038
1047
 
1039
1048
  // GET /location/brand/{id}/timeslots/delivery/menu/{menu} - Get location brand delivery timeslots for menu
@@ -1055,7 +1064,7 @@ export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
1055
1064
  export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
1056
1065
 
1057
1066
  export interface GetLocationBrandMenuDeliveryTimeslostsRequest
1058
- extends GetLocationBrandMenuDeliveryTimeslostsQuery,
1067
+ extends WithStringProps<GetLocationBrandMenuDeliveryTimeslostsQuery>,
1059
1068
  GetLocationBrandMenuDeliveryTimeslostsPath {}
1060
1069
 
1061
1070
  // POST /location/brand - Create a new Brand
@@ -1085,7 +1094,9 @@ export interface GetLocationBrandQuery {
1085
1094
 
1086
1095
  export type GetLocationBrandResponse = Brand;
1087
1096
 
1088
- export interface GetLocationBrandRequest extends GetLocationBrandQuery, GetLocationBrandPath {}
1097
+ export interface GetLocationBrandRequest
1098
+ extends WithStringProps<GetLocationBrandQuery>,
1099
+ GetLocationBrandPath {}
1089
1100
 
1090
1101
  // PATCH /location/brand/{id} - Update location brand
1091
1102
 
@@ -1140,7 +1151,7 @@ export interface GetLocationSectorsQuery {
1140
1151
 
1141
1152
  export type GetLocationSectorsResponse = Sectors;
1142
1153
 
1143
- export interface GetLocationSectorsRequest extends GetLocationSectorsQuery {}
1154
+ export interface GetLocationSectorsRequest extends WithStringProps<GetLocationSectorsQuery> {}
1144
1155
 
1145
1156
  // POST /location/sector - Create a new sector
1146
1157
 
@@ -1167,7 +1178,9 @@ export interface GetLocationSectorQuery {
1167
1178
 
1168
1179
  export type GetLocationSectorResponse = Sector;
1169
1180
 
1170
- export interface GetLocationSectorRequest extends GetLocationSectorQuery, GetLocationSectorPath {}
1181
+ export interface GetLocationSectorRequest
1182
+ extends WithStringProps<GetLocationSectorQuery>,
1183
+ GetLocationSectorPath {}
1171
1184
 
1172
1185
  // PATCH /location/sector/{id} - Update a sector
1173
1186
 
@@ -1186,7 +1199,7 @@ export type PatchLocationSectorBody = CreateSector;
1186
1199
  export type PatchLocationSectorResponse = Sector;
1187
1200
 
1188
1201
  export interface PatchLocationSectorRequest
1189
- extends PatchLocationSectorQuery,
1202
+ extends WithStringProps<PatchLocationSectorQuery>,
1190
1203
  PatchLocationSectorPath {
1191
1204
  body: PatchLocationSectorBody;
1192
1205
  }
@@ -1224,7 +1237,7 @@ export interface GetLocationCompanyQuery {
1224
1237
  export type GetLocationCompanyResponse = Company;
1225
1238
 
1226
1239
  export interface GetLocationCompanyRequest
1227
- extends GetLocationCompanyQuery,
1240
+ extends WithStringProps<GetLocationCompanyQuery>,
1228
1241
  GetLocationCompanyPath {}
1229
1242
 
1230
1243
  // PATCH /location/company/{id} - Update a company
@@ -1256,7 +1269,7 @@ export interface GetLocationBrandExternalQuery {
1256
1269
  export type GetLocationBrandExternalResponse = Location;
1257
1270
 
1258
1271
  export interface GetLocationBrandExternalRequest
1259
- extends GetLocationBrandExternalQuery,
1272
+ extends WithStringProps<GetLocationBrandExternalQuery>,
1260
1273
  GetLocationBrandExternalPath {}
1261
1274
 
1262
1275
  // DELETE /location/record/{id} - Delete a Brand, Location, Group, or MultiGroup
@@ -1276,5 +1289,5 @@ export interface DeleteLocationRecordResponse {
1276
1289
  }
1277
1290
 
1278
1291
  export interface DeleteLocationRecordRequest
1279
- extends DeleteLocationRecordQuery,
1292
+ extends WithStringProps<DeleteLocationRecordQuery>,
1280
1293
  DeleteLocationRecordPath {}
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  error?: string;
5
7
  code?: number;
@@ -42,5 +44,5 @@ export interface GetLoggerBrandStatusResponse {
42
44
  }
43
45
 
44
46
  export interface GetLoggerBrandStatusRequest
45
- extends GetLoggerBrandStatusQuery,
47
+ extends WithStringProps<GetLoggerBrandStatusQuery>,
46
48
  GetLoggerBrandStatusPath {}
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -173,7 +175,9 @@ export interface PostLoyaltyEnrollQuery {
173
175
 
174
176
  export type PostLoyaltyEnrollResponse = EnrollResponse;
175
177
 
176
- export interface PostLoyaltyEnrollRequest extends PostLoyaltyEnrollQuery, PostLoyaltyEnrollPath {}
178
+ export interface PostLoyaltyEnrollRequest
179
+ extends WithStringProps<PostLoyaltyEnrollQuery>,
180
+ PostLoyaltyEnrollPath {}
177
181
 
178
182
  // GET /loyalty/{id}/points - Get potential points user could earn from certain event in Loyalty program
179
183
 
@@ -191,7 +195,9 @@ export interface GetLoyaltyPointsQuery {
191
195
 
192
196
  export type GetLoyaltyPointsResponse = Points;
193
197
 
194
- export interface GetLoyaltyPointsRequest extends GetLoyaltyPointsQuery, GetLoyaltyPointsPath {}
198
+ export interface GetLoyaltyPointsRequest
199
+ extends WithStringProps<GetLoyaltyPointsQuery>,
200
+ GetLoyaltyPointsPath {}
195
201
 
196
202
  // GET /loyalty/{id}/offers/{user_id} - Get offers for the logged in user
197
203
 
@@ -253,7 +259,7 @@ export interface GetLoyaltyOpportunitiesResponse {
253
259
  }
254
260
 
255
261
  export interface GetLoyaltyOpportunitiesRequest
256
- extends GetLoyaltyOpportunitiesQuery,
262
+ extends WithStringProps<GetLoyaltyOpportunitiesQuery>,
257
263
  GetLoyaltyOpportunitiesPath {}
258
264
 
259
265
  // POST /loyalty/{id}/opportunities/{user_id} - Record an event for the logged in user
@@ -275,7 +281,7 @@ export interface PostLoyaltyOpportunitiesQuery {
275
281
  export type PostLoyaltyOpportunitiesResponse = RecordResponse;
276
282
 
277
283
  export interface PostLoyaltyOpportunitiesRequest
278
- extends PostLoyaltyOpportunitiesQuery,
284
+ extends WithStringProps<PostLoyaltyOpportunitiesQuery>,
279
285
  PostLoyaltyOpportunitiesPath {}
280
286
 
281
287
  // GET /loyalty/{id}/rewards/{user_id} - Get rewards available for the logged in user
@@ -325,7 +331,7 @@ export interface GetLoyaltyOrderpointsQuery {
325
331
  export type GetLoyaltyOrderpointsResponse = Points;
326
332
 
327
333
  export interface GetLoyaltyOrderpointsRequest
328
- extends GetLoyaltyOrderpointsQuery,
334
+ extends WithStringProps<GetLoyaltyOrderpointsQuery>,
329
335
  GetLoyaltyOrderpointsPath {}
330
336
 
331
337
  // POST /loyalty/{id}/orderpoints/{user_id} - Get potential loyalty point points for a order based on amount and items
@@ -380,7 +386,7 @@ export interface PostLoyaltyPurchaseBody {
380
386
  export type PostLoyaltyPurchaseResponse = RecordResponse;
381
387
 
382
388
  export interface PostLoyaltyPurchaseRequest
383
- extends PostLoyaltyPurchaseQuery,
389
+ extends WithStringProps<PostLoyaltyPurchaseQuery>,
384
390
  PostLoyaltyPurchasePath {
385
391
  body: PostLoyaltyPurchaseBody;
386
392
  }
@@ -406,7 +412,7 @@ export interface PostLoyaltyBuyrewardBody {
406
412
  export type PostLoyaltyBuyrewardResponse = RewardInfo;
407
413
 
408
414
  export interface PostLoyaltyBuyrewardRequest
409
- extends PostLoyaltyBuyrewardQuery,
415
+ extends WithStringProps<PostLoyaltyBuyrewardQuery>,
410
416
  PostLoyaltyBuyrewardPath {
411
417
  body: PostLoyaltyBuyrewardBody;
412
418
  }
@@ -431,7 +437,9 @@ export interface GetLoyaltyHistoryResponse {
431
437
  transactions?: HistoryTransaction[];
432
438
  }
433
439
 
434
- export interface GetLoyaltyHistoryRequest extends GetLoyaltyHistoryQuery, GetLoyaltyHistoryPath {}
440
+ export interface GetLoyaltyHistoryRequest
441
+ extends WithStringProps<GetLoyaltyHistoryQuery>,
442
+ GetLoyaltyHistoryPath {}
435
443
 
436
444
  // GET /loyalty/{id}/coupon/{user_id}/{coupon_id} - get coupon's information
437
445
 
@@ -488,7 +496,9 @@ export interface GetLoyaltySearchQuery {
488
496
 
489
497
  export type GetLoyaltySearchResponse = UserId;
490
498
 
491
- export interface GetLoyaltySearchRequest extends GetLoyaltySearchQuery, GetLoyaltySearchPath {}
499
+ export interface GetLoyaltySearchRequest
500
+ extends WithStringProps<GetLoyaltySearchQuery>,
501
+ GetLoyaltySearchPath {}
492
502
 
493
503
  // GET /loyalty/{id}/users - Get all loyalty users updated after specific date
494
504
 
@@ -508,7 +518,9 @@ export interface GetLoyaltyUsersResponse {
508
518
  users?: LoyaltyUser[];
509
519
  }
510
520
 
511
- export interface GetLoyaltyUsersRequest extends GetLoyaltyUsersQuery, GetLoyaltyUsersPath {}
521
+ export interface GetLoyaltyUsersRequest
522
+ extends WithStringProps<GetLoyaltyUsersQuery>,
523
+ GetLoyaltyUsersPath {}
512
524
 
513
525
  // GET /loyalty/{id}/events - Get all loyalty events updated after specific date
514
526
 
@@ -528,4 +540,6 @@ export interface GetLoyaltyEventsResponse {
528
540
  events?: Event[];
529
541
  }
530
542
 
531
- export interface GetLoyaltyEventsRequest extends GetLoyaltyEventsQuery, GetLoyaltyEventsPath {}
543
+ export interface GetLoyaltyEventsRequest
544
+ extends WithStringProps<GetLoyaltyEventsQuery>,
545
+ GetLoyaltyEventsPath {}
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  code?: number;
5
7
  message?: string;
@@ -215,7 +217,9 @@ export type PostMealplanVerifyBody = VerifyEmail;
215
217
 
216
218
  export type PostMealplanVerifyResponse = success;
217
219
 
218
- export interface PostMealplanVerifyRequest extends PostMealplanVerifyQuery, PostMealplanVerifyPath {
220
+ export interface PostMealplanVerifyRequest
221
+ extends WithStringProps<PostMealplanVerifyQuery>,
222
+ PostMealplanVerifyPath {
219
223
  body: PostMealplanVerifyBody;
220
224
  }
221
225
 
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Menu {
4
6
  // menu
5
7
  id?: string;
@@ -315,7 +317,7 @@ export interface GetMenusQuery {
315
317
 
316
318
  export type GetMenusResponse = Menus;
317
319
 
318
- export interface GetMenusRequest extends GetMenusQuery {}
320
+ export interface GetMenusRequest extends WithStringProps<GetMenusQuery> {}
319
321
 
320
322
  // POST /menu - Create a new Menu
321
323
 
@@ -341,7 +343,7 @@ export interface HeadMenuQuery {
341
343
 
342
344
  export type HeadMenuResponse = any;
343
345
 
344
- export interface HeadMenuRequest extends HeadMenuQuery, HeadMenuPath {}
346
+ export interface HeadMenuRequest extends WithStringProps<HeadMenuQuery>, HeadMenuPath {}
345
347
 
346
348
  // GET /menu/{id} - Get an individual Menu
347
349
 
@@ -362,7 +364,7 @@ export interface GetMenuQuery {
362
364
 
363
365
  export type GetMenuResponse = Menu;
364
366
 
365
- export interface GetMenuRequest extends GetMenuQuery, GetMenuPath {}
367
+ export interface GetMenuRequest extends WithStringProps<GetMenuQuery>, GetMenuPath {}
366
368
 
367
369
  // PUT /menu/{id} - Override a complete Menu
368
370
 
@@ -380,7 +382,7 @@ export type PutMenuBody = Menu;
380
382
 
381
383
  export type PutMenuResponse = Menu;
382
384
 
383
- export interface PutMenuRequest extends PutMenuQuery, PutMenuPath {
385
+ export interface PutMenuRequest extends WithStringProps<PutMenuQuery>, PutMenuPath {
384
386
  body: PutMenuBody;
385
387
  }
386
388
 
@@ -398,7 +400,7 @@ export interface DeleteMenuQuery {
398
400
 
399
401
  export type DeleteMenuResponse = Success;
400
402
 
401
- export interface DeleteMenuRequest extends DeleteMenuQuery, DeleteMenuPath {}
403
+ export interface DeleteMenuRequest extends WithStringProps<DeleteMenuQuery>, DeleteMenuPath {}
402
404
 
403
405
  // PATCH /menu/{id} - Update a menu
404
406
 
@@ -416,7 +418,7 @@ export type PatchMenuBody = PatchMenu;
416
418
 
417
419
  export type PatchMenuResponse = Menu;
418
420
 
419
- export interface PatchMenuRequest extends PatchMenuQuery, PatchMenuPath {
421
+ export interface PatchMenuRequest extends WithStringProps<PatchMenuQuery>, PatchMenuPath {
420
422
  body: PatchMenuBody;
421
423
  }
422
424
 
@@ -448,7 +450,7 @@ export interface GetMenuItemQuery {
448
450
 
449
451
  export type GetMenuItemResponse = Item;
450
452
 
451
- export interface GetMenuItemRequest extends GetMenuItemQuery, GetMenuItemPath {}
453
+ export interface GetMenuItemRequest extends WithStringProps<GetMenuItemQuery>, GetMenuItemPath {}
452
454
 
453
455
  // DELETE /menu/item/{id} - Delete a menu item
454
456
 
@@ -479,7 +481,7 @@ export interface GetMenuItemsQuery {
479
481
 
480
482
  export type GetMenuItemsResponse = Items;
481
483
 
482
- export interface GetMenuItemsRequest extends GetMenuItemsQuery {}
484
+ export interface GetMenuItemsRequest extends WithStringProps<GetMenuItemsQuery> {}
483
485
 
484
486
  // POST /menu/items/import/{location} - trigger import items
485
487
 
@@ -522,7 +524,7 @@ export interface GetMenuLocationItemRandomQuery {
522
524
  export type GetMenuLocationItemRandomResponse = Item;
523
525
 
524
526
  export interface GetMenuLocationItemRandomRequest
525
- extends GetMenuLocationItemRandomQuery,
527
+ extends WithStringProps<GetMenuLocationItemRandomQuery>,
526
528
  GetMenuLocationItemRandomPath {}
527
529
 
528
530
  // GET /menu/items/random/location/{location} - Get a set of random items
@@ -546,7 +548,7 @@ export interface GetMenuLocationItemsRandomQuery {
546
548
  export type GetMenuLocationItemsRandomResponse = Items;
547
549
 
548
550
  export interface GetMenuLocationItemsRandomRequest
549
- extends GetMenuLocationItemsRandomQuery,
551
+ extends WithStringProps<GetMenuLocationItemsRandomQuery>,
550
552
  GetMenuLocationItemsRandomPath {}
551
553
 
552
554
  // GET /menu/sector/{sector} - Get menus that belong to sector
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  error?: string;
5
7
  code?: number;
@@ -50,7 +52,7 @@ export interface GetNotificationsResponse {
50
52
  notifications?: Notification[];
51
53
  }
52
54
 
53
- export interface GetNotificationsRequest extends GetNotificationsQuery {}
55
+ export interface GetNotificationsRequest extends WithStringProps<GetNotificationsQuery> {}
54
56
 
55
57
  // POST /notification - Create a notification
56
58
 
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface CreateOrder {
4
6
  // brand
5
7
  location_brand?: string;
@@ -287,7 +289,7 @@ export type PostOrderBody = CreateOrder;
287
289
 
288
290
  export type PostOrderResponse = Order;
289
291
 
290
- export interface PostOrderRequest extends PostOrderQuery {
292
+ export interface PostOrderRequest extends WithStringProps<PostOrderQuery> {
291
293
  body: PostOrderBody;
292
294
  }
293
295
 
@@ -385,7 +387,7 @@ export interface GetOrderCustomerOrdersResponse {
385
387
  }
386
388
 
387
389
  export interface GetOrderCustomerOrdersRequest
388
- extends GetOrderCustomerOrdersQuery,
390
+ extends WithStringProps<GetOrderCustomerOrdersQuery>,
389
391
  GetOrderCustomerOrdersPath {}
390
392
 
391
393
  // GET /order/customer/{id}/location/brand/{location_brand} - Get all orders for a Customer for a specific Location Brand
@@ -428,7 +430,7 @@ export interface GetOrderLocationBrandQuery {
428
430
  export type GetOrderLocationBrandResponse = Orders;
429
431
 
430
432
  export interface GetOrderLocationBrandRequest
431
- extends GetOrderLocationBrandQuery,
433
+ extends WithStringProps<GetOrderLocationBrandQuery>,
432
434
  GetOrderLocationBrandPath {}
433
435
 
434
436
  // GET /order/location/{id} - Get all orders for a location
@@ -458,7 +460,7 @@ export interface GetOrderLocationOrdersQuery {
458
460
  export type GetOrderLocationOrdersResponse = Orders;
459
461
 
460
462
  export interface GetOrderLocationOrdersRequest
461
- extends GetOrderLocationOrdersQuery,
463
+ extends WithStringProps<GetOrderLocationOrdersQuery>,
462
464
  GetOrderLocationOrdersPath {}
463
465
 
464
466
  // GET /order/location/group/{id} - Get all orders for a location group
@@ -486,7 +488,7 @@ export interface GetOrderGroupOrdersResponse {
486
488
  }
487
489
 
488
490
  export interface GetOrderGroupOrdersRequest
489
- extends GetOrderGroupOrdersQuery,
491
+ extends WithStringProps<GetOrderGroupOrdersQuery>,
490
492
  GetOrderGroupOrdersPath {}
491
493
 
492
494
  // PATCH /order/{id}/checkin - Accept an order by checking in
@@ -1,5 +1,7 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
+ import { WithStringProps } from "./util";
4
+
3
5
  export interface Error {
4
6
  message?: string;
5
7
  code?: number;
@@ -163,6 +165,11 @@ export interface ShoppingCart {
163
165
  // If an order should be paid with meal exchange. If true, this will calculate meals total.
164
166
  mx_cart?: boolean;
165
167
  };
168
+ meta?: {
169
+ // Raw request from any vendor integrated with CDL
170
+ vendor?: any;
171
+ [index: string]: any;
172
+ };
166
173
  }
167
174
 
168
175
  export type Item = any;