@compassdigital/sdk.typescript 4.417.0 → 4.418.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 (95) hide show
  1. package/lib/index.d.ts +121 -307
  2. package/lib/index.d.ts.map +1 -1
  3. package/lib/index.js.map +1 -1
  4. package/lib/interface/announcement.d.ts +1 -5
  5. package/lib/interface/announcement.d.ts.map +1 -1
  6. package/lib/interface/auth.d.ts +0 -8
  7. package/lib/interface/auth.d.ts.map +1 -1
  8. package/lib/interface/calendar.d.ts +3 -14
  9. package/lib/interface/calendar.d.ts.map +1 -1
  10. package/lib/interface/catalog.d.ts +6 -26
  11. package/lib/interface/catalog.d.ts.map +1 -1
  12. package/lib/interface/centricos.d.ts +0 -35
  13. package/lib/interface/centricos.d.ts.map +1 -1
  14. package/lib/interface/compassconnect.d.ts +0 -1
  15. package/lib/interface/compassconnect.d.ts.map +1 -1
  16. package/lib/interface/config.d.ts +5 -17
  17. package/lib/interface/config.d.ts.map +1 -1
  18. package/lib/interface/consumer.d.ts +0 -38
  19. package/lib/interface/consumer.d.ts.map +1 -1
  20. package/lib/interface/datalake.d.ts +2 -5
  21. package/lib/interface/datalake.d.ts.map +1 -1
  22. package/lib/interface/discount.d.ts +0 -7
  23. package/lib/interface/discount.d.ts.map +1 -1
  24. package/lib/interface/forecasting.d.ts +0 -5
  25. package/lib/interface/forecasting.d.ts.map +1 -1
  26. package/lib/interface/frictionless.d.ts +0 -15
  27. package/lib/interface/frictionless.d.ts.map +1 -1
  28. package/lib/interface/kds.d.ts +1 -5
  29. package/lib/interface/kds.d.ts.map +1 -1
  30. package/lib/interface/location.d.ts +2 -25
  31. package/lib/interface/location.d.ts.map +1 -1
  32. package/lib/interface/mealplan.d.ts +2 -9
  33. package/lib/interface/mealplan.d.ts.map +1 -1
  34. package/lib/interface/menu.d.ts +42 -189
  35. package/lib/interface/menu.d.ts.map +1 -1
  36. package/lib/interface/notification.d.ts +1 -5
  37. package/lib/interface/notification.d.ts.map +1 -1
  38. package/lib/interface/order.d.ts +2 -6
  39. package/lib/interface/order.d.ts.map +1 -1
  40. package/lib/interface/partner.d.ts +1 -6
  41. package/lib/interface/partner.d.ts.map +1 -1
  42. package/lib/interface/payment.d.ts +1 -8
  43. package/lib/interface/payment.d.ts.map +1 -1
  44. package/lib/interface/promo.d.ts +1 -7
  45. package/lib/interface/promo.d.ts.map +1 -1
  46. package/lib/interface/report.d.ts +3 -16
  47. package/lib/interface/report.d.ts.map +1 -1
  48. package/lib/interface/review.d.ts +0 -4
  49. package/lib/interface/review.d.ts.map +1 -1
  50. package/lib/interface/search.d.ts +0 -7
  51. package/lib/interface/search.d.ts.map +1 -1
  52. package/lib/interface/shoppingcart.d.ts +4 -16
  53. package/lib/interface/shoppingcart.d.ts.map +1 -1
  54. package/lib/interface/task.d.ts +2 -10
  55. package/lib/interface/task.d.ts.map +1 -1
  56. package/lib/interface/tax.d.ts +0 -3
  57. package/lib/interface/tax.d.ts.map +1 -1
  58. package/lib/interface/timeslots.d.ts +0 -1
  59. package/lib/interface/timeslots.d.ts.map +1 -1
  60. package/lib/interface/user.d.ts +3 -18
  61. package/lib/interface/user.d.ts.map +1 -1
  62. package/lib/interface/vendor.d.ts +5 -22
  63. package/lib/interface/vendor.d.ts.map +1 -1
  64. package/package.json +2 -2
  65. package/src/index.ts +94 -440
  66. package/src/interface/announcement.ts +1 -11
  67. package/src/interface/auth.ts +0 -14
  68. package/src/interface/calendar.ts +3 -26
  69. package/src/interface/catalog.ts +6 -47
  70. package/src/interface/centricos.ts +0 -60
  71. package/src/interface/compassconnect.ts +0 -2
  72. package/src/interface/config.ts +4 -32
  73. package/src/interface/consumer.ts +2 -69
  74. package/src/interface/datalake.ts +1 -8
  75. package/src/interface/discount.ts +0 -12
  76. package/src/interface/forecasting.ts +0 -9
  77. package/src/interface/frictionless.ts +0 -25
  78. package/src/interface/kds.ts +1 -8
  79. package/src/interface/location.ts +0 -46
  80. package/src/interface/mealplan.ts +2 -19
  81. package/src/interface/menu.ts +38 -355
  82. package/src/interface/notification.ts +1 -10
  83. package/src/interface/order.ts +2 -10
  84. package/src/interface/partner.ts +1 -12
  85. package/src/interface/payment.ts +1 -17
  86. package/src/interface/promo.ts +1 -14
  87. package/src/interface/report.ts +1 -29
  88. package/src/interface/review.ts +0 -7
  89. package/src/interface/search.ts +0 -13
  90. package/src/interface/shoppingcart.ts +3 -31
  91. package/src/interface/task.ts +2 -19
  92. package/src/interface/tax.ts +0 -5
  93. package/src/interface/timeslots.ts +0 -2
  94. package/src/interface/user.ts +3 -36
  95. package/src/interface/vendor.ts +5 -43
@@ -411,11 +411,6 @@ export interface GetDiscountPath {
411
411
  id: string;
412
412
  }
413
413
 
414
- export interface GetDiscountQuery {
415
- // Graphql query string
416
- _query?: string;
417
- }
418
-
419
414
  export type GetDiscountResponse = GetDiscountResponseDTO;
420
415
 
421
416
  // PATCH /discount/{id} - Patch a discount
@@ -442,11 +437,6 @@ export type PutDiscountResponse = PutDiscountResponseDTO;
442
437
 
443
438
  // GET /discount/all - Get all discounts
444
439
 
445
- export interface GetDiscountsAllQuery {
446
- // Graphql query string
447
- _query?: string;
448
- }
449
-
450
440
  export type GetDiscountsAllResponse = GetAllDiscountsResponseDTO;
451
441
 
452
442
  // GET /discount - Get discounts by taxonomy
@@ -455,8 +445,6 @@ export interface GetDiscountsQuery {
455
445
  taxonomyFilter: string;
456
446
  statusFilter?: string;
457
447
  validateSchedule?: boolean;
458
- // Graphql query string
459
- _query?: string;
460
448
  }
461
449
 
462
450
  export type GetDiscountsResponse = GetDiscountsResponseDTO;
@@ -127,8 +127,6 @@ export type ProductionSheetControllerCreateSheetResponse = ProductionSheetRespon
127
127
  export interface ProductionSheetControllerGetScheduledMenuDataQuery {
128
128
  siteId: string;
129
129
  date: string;
130
- // Graphql query string
131
- _query?: string;
132
130
  }
133
131
 
134
132
  export type ProductionSheetControllerGetScheduledMenuDataResponse = {};
@@ -156,19 +154,12 @@ export type ProductionSheetControllerSendChatFeedbackResponse = {};
156
154
 
157
155
  export interface ProductionSheetControllerGetForecastMetaDataQuery {
158
156
  site_id: string;
159
- // Graphql query string
160
- _query?: string;
161
157
  }
162
158
 
163
159
  export type ProductionSheetControllerGetForecastMetaDataResponse = {};
164
160
 
165
161
  // GET /forecasting/status
166
162
 
167
- export interface ProductionSheetControllerServiceStatusQuery {
168
- // Graphql query string
169
- _query?: string;
170
- }
171
-
172
163
  export type ProductionSheetControllerServiceStatusResponse = {};
173
164
 
174
165
  // POST /forecasting/chat-stream - Stream chat responses from Luna for forecasting chat
@@ -200,11 +200,6 @@ export interface GetFrictionlessBrandFrictionlessStatusPath {
200
200
  id_brand: string;
201
201
  }
202
202
 
203
- export interface GetFrictionlessBrandFrictionlessStatusQuery {
204
- // Graphql query string
205
- _query?: string;
206
- }
207
-
208
203
  export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
209
204
 
210
205
  // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
@@ -219,11 +214,6 @@ export interface GetFrictionlessCheckinStatusPath {
219
214
  id_checkin: string;
220
215
  }
221
216
 
222
- export interface GetFrictionlessCheckinStatusQuery {
223
- // Graphql query string
224
- _query?: string;
225
- }
226
-
227
217
  export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
228
218
 
229
219
  // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
@@ -232,11 +222,6 @@ export interface GetFrictionlessCheckinPath {
232
222
  id_checkin: string;
233
223
  }
234
224
 
235
- export interface GetFrictionlessCheckinQuery {
236
- // Graphql query string
237
- _query?: string;
238
- }
239
-
240
225
  export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
241
226
 
242
227
  // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
@@ -245,20 +230,10 @@ export interface GetFrictionlessUsersPaymentIssuesPath {
245
230
  user_id: string;
246
231
  }
247
232
 
248
- export interface GetFrictionlessUsersPaymentIssuesQuery {
249
- // Graphql query string
250
- _query?: string;
251
- }
252
-
253
233
  export type GetFrictionlessUsersPaymentIssuesResponse = CheckInPaymentRequiredDTO[];
254
234
 
255
235
  // GET /frictionless/failed-checkins - List check-ins on error
256
236
 
257
- export interface GetFrictionlessFailedCheckinsQuery {
258
- // Graphql query string
259
- _query?: string;
260
- }
261
-
262
237
  export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
263
238
 
264
239
  // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error
@@ -65,8 +65,6 @@ export interface GetKdsDevicesQuery {
65
65
  unitNumber: string;
66
66
  // Do not return cached device information
67
67
  nocache?: boolean;
68
- // Graphql query string
69
- _query?: string;
70
68
  }
71
69
 
72
70
  export type GetKdsDevicesResponse = Units;
@@ -122,13 +120,8 @@ export interface DeleteKdsDeviceInfoRequest extends BaseRequest, DeleteKdsDevice
122
120
 
123
121
  // GET /kds/swagger.json - Get a swagger for kds service
124
122
 
125
- export interface GetKdsSwaggerQuery {
126
- // Graphql query string
127
- _query?: string;
128
- }
129
-
130
123
  export interface GetKdsSwaggerResponse {
131
124
  [index: string]: any;
132
125
  }
133
126
 
134
- export interface GetKdsSwaggerRequest extends BaseRequest, RequestQuery<GetKdsSwaggerQuery> {}
127
+ export interface GetKdsSwaggerRequest extends BaseRequest {}
@@ -563,8 +563,6 @@ export interface GetLocationSearchQuery {
563
563
  long?: number;
564
564
  // Operation id to be used
565
565
  operation_id?: number;
566
- // Graphql query string
567
- _query?: string;
568
566
  }
569
567
 
570
568
  export type GetLocationSearchResponse = Locations;
@@ -588,8 +586,6 @@ export interface GetLocationQuery {
588
586
  active_cafes?: string[];
589
587
  // show additional hidden properties/entities
590
588
  extended?: boolean;
591
- // Graphql query string
592
- _query?: string;
593
589
  nocache?: boolean;
594
590
  }
595
591
 
@@ -648,8 +644,6 @@ export interface PostLocationBatchGetRequest extends BaseRequest {
648
644
  // GET /location/multigroup - Get all the top level multigroups
649
645
 
650
646
  export interface GetLocationMultigroupsQuery {
651
- // Graphql query string
652
- _query?: string;
653
647
  nocache?: boolean;
654
648
  }
655
649
 
@@ -701,8 +695,6 @@ export interface GetLocationMultigroupQuery {
701
695
  paginate?: boolean;
702
696
  // The last key from the previous response for pagination
703
697
  last_key?: string;
704
- // Graphql query string
705
- _query?: string;
706
698
  nocache?: boolean;
707
699
  }
708
700
 
@@ -757,8 +749,6 @@ export interface GetLocationUserMultigroupPath {
757
749
 
758
750
  export interface GetLocationUserMultigroupQuery {
759
751
  expanded?: boolean;
760
- // Graphql query string
761
- _query?: string;
762
752
  nocache?: boolean;
763
753
  }
764
754
 
@@ -804,8 +794,6 @@ export interface GetLocationGroupQuery {
804
794
  non_scan_go?: boolean;
805
795
  // @deprecated
806
796
  include_estimated_wait_time?: boolean;
807
- // Graphql query string
808
- _query?: string;
809
797
  nocache?: boolean;
810
798
  }
811
799
 
@@ -856,16 +844,10 @@ export interface GetLocationGroupAppThemePath {
856
844
  id: string;
857
845
  }
858
846
 
859
- export interface GetLocationGroupAppThemeQuery {
860
- // Graphql query string
861
- _query?: string;
862
- }
863
-
864
847
  export type GetLocationGroupAppThemeResponse = AppTheme;
865
848
 
866
849
  export interface GetLocationGroupAppThemeRequest
867
850
  extends BaseRequest,
868
- RequestQuery<GetLocationGroupAppThemeQuery>,
869
851
  GetLocationGroupAppThemePath {}
870
852
 
871
853
  // POST /location/group/batch-get - Get multiple location groups by their IDs
@@ -888,8 +870,6 @@ export interface GetLocationGroupWaittimesPath {
888
870
  }
889
871
 
890
872
  export interface GetLocationGroupWaittimesQuery {
891
- // Graphql query string
892
- _query?: string;
893
873
  nocache?: boolean;
894
874
  }
895
875
 
@@ -912,8 +892,6 @@ export interface GetLocationGroupDeliverydestinationsQuery {
912
892
  name?: string;
913
893
  // Only return in-use delivery destinations
914
894
  active?: boolean;
915
- // Graphql query string
916
- _query?: string;
917
895
  }
918
896
 
919
897
  export interface GetLocationGroupDeliverydestinationsResponse {
@@ -996,8 +974,6 @@ export interface GetLocationGroupDeliverydestinationPath {
996
974
  export interface GetLocationGroupDeliverydestinationQuery {
997
975
  // Return only in-use destinations
998
976
  active?: boolean;
999
- // Graphql query string
1000
- _query?: string;
1001
977
  }
1002
978
 
1003
979
  export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
@@ -1019,8 +995,6 @@ export interface GetLocationBrandTimeslotsQuery {
1019
995
  date?: number;
1020
996
  // Limit the number of timeslots returned
1021
997
  limit?: number;
1022
- // Graphql query string
1023
- _query?: string;
1024
998
  }
1025
999
 
1026
1000
  export type GetLocationBrandTimeslotsResponse = TimeSlots;
@@ -1082,8 +1056,6 @@ export interface GetLocationBrandMenuTimeslotsQuery {
1082
1056
  date?: number;
1083
1057
  // Limit the number of timeslots returned
1084
1058
  limit?: number;
1085
- // Graphql query string
1086
- _query?: string;
1087
1059
  }
1088
1060
 
1089
1061
  export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
@@ -1105,8 +1077,6 @@ export interface GetLocationBrandDeliveryTimeslotsQuery {
1105
1077
  date?: number;
1106
1078
  // Limit the number of timeslots returned
1107
1079
  limit?: number;
1108
- // Graphql query string
1109
- _query?: string;
1110
1080
  }
1111
1081
 
1112
1082
  export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
@@ -1130,8 +1100,6 @@ export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
1130
1100
  date?: number;
1131
1101
  // Limit the number of timeslots returned
1132
1102
  limit?: number;
1133
- // Graphql query string
1134
- _query?: string;
1135
1103
  }
1136
1104
 
1137
1105
  export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
@@ -1264,8 +1232,6 @@ export interface PutLocationBrandRequest extends BaseRequest, PutLocationBrandPa
1264
1232
  // GET /location/sector - Get list of all the sectors
1265
1233
 
1266
1234
  export interface GetLocationSectorsQuery {
1267
- // Graphql query string
1268
- _query?: string;
1269
1235
  nocache?: boolean;
1270
1236
  }
1271
1237
 
@@ -1295,8 +1261,6 @@ export interface GetLocationSectorPath {
1295
1261
  export interface GetLocationSectorQuery {
1296
1262
  // Omits nested children of a sector if false
1297
1263
  expanded?: boolean;
1298
- // Graphql query string
1299
- _query?: string;
1300
1264
  nocache?: boolean;
1301
1265
  }
1302
1266
 
@@ -1358,8 +1322,6 @@ export interface GetLocationCompanyPath {
1358
1322
 
1359
1323
  export interface GetLocationCompanyQuery {
1360
1324
  expanded?: boolean;
1361
- // Graphql query string
1362
- _query?: string;
1363
1325
  }
1364
1326
 
1365
1327
  export type GetLocationCompanyResponse = Company;
@@ -1424,8 +1386,6 @@ export interface GetLocationV2GroupsQuery {
1424
1386
  include_hidden?: boolean;
1425
1387
  // Include deleted brands in expanded query
1426
1388
  include_deleted?: boolean;
1427
- // Graphql query string
1428
- _query?: string;
1429
1389
  }
1430
1390
 
1431
1391
  export interface GetLocationV2GroupsResponse {
@@ -1453,16 +1413,10 @@ export interface GetLocationMenuAssociationBrandPath {
1453
1413
  id: string;
1454
1414
  }
1455
1415
 
1456
- export interface GetLocationMenuAssociationBrandQuery {
1457
- // Graphql query string
1458
- _query?: string;
1459
- }
1460
-
1461
1416
  export type GetLocationMenuAssociationBrandResponse = MenuAssociations;
1462
1417
 
1463
1418
  export interface GetLocationMenuAssociationBrandRequest
1464
1419
  extends BaseRequest,
1465
- RequestQuery<GetLocationMenuAssociationBrandQuery>,
1466
1420
  GetLocationMenuAssociationBrandPath {}
1467
1421
 
1468
1422
  // GET /location/menu_association/{id}/menu - Get menu association for a brand
@@ -135,8 +135,6 @@ export interface GetMealplanPath {
135
135
  export interface GetMealplanQuery {
136
136
  // Retrieve all tenders from the get_mealplan call. Defaults to false
137
137
  all_tenders?: boolean;
138
- // Graphql query string
139
- _query?: string;
140
138
  }
141
139
 
142
140
  export type GetMealplanResponse = TendersAndAuth;
@@ -204,17 +202,9 @@ export interface GetMealplanTenderPath {
204
202
  tender: string;
205
203
  }
206
204
 
207
- export interface GetMealplanTenderQuery {
208
- // Graphql query string
209
- _query?: string;
210
- }
211
-
212
205
  export type GetMealplanTenderResponse = Tender;
213
206
 
214
- export interface GetMealplanTenderRequest
215
- extends BaseRequest,
216
- RequestQuery<GetMealplanTenderQuery>,
217
- GetMealplanTenderPath {}
207
+ export interface GetMealplanTenderRequest extends BaseRequest, GetMealplanTenderPath {}
218
208
 
219
209
  // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
220
210
 
@@ -391,18 +381,11 @@ export interface PostMealplanInternalDebitRequest
391
381
 
392
382
  // GET /mealplan/institutions - Get list of institutions
393
383
 
394
- export interface GetMealplanInstitutionsQuery {
395
- // Graphql query string
396
- _query?: string;
397
- }
398
-
399
384
  export interface GetMealplanInstitutionsResponse {
400
385
  institutions?: EAccountInstitutionListResponse;
401
386
  }
402
387
 
403
- export interface GetMealplanInstitutionsRequest
404
- extends BaseRequest,
405
- RequestQuery<GetMealplanInstitutionsQuery> {}
388
+ export interface GetMealplanInstitutionsRequest extends BaseRequest {}
406
389
 
407
390
  // POST /mealplan/{id}/internal/refund - Refund an amount to the tender balance
408
391