@compassdigital/sdk.typescript 3.20.0 → 3.21.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 (71) hide show
  1. package/lib/interface/announcement.d.ts +7 -13
  2. package/lib/interface/announcement.d.ts.map +1 -1
  3. package/lib/interface/calendar.d.ts +7 -13
  4. package/lib/interface/calendar.d.ts.map +1 -1
  5. package/lib/interface/compassconnect.d.ts +2 -3
  6. package/lib/interface/compassconnect.d.ts.map +1 -1
  7. package/lib/interface/config.d.ts +10 -19
  8. package/lib/interface/config.d.ts.map +1 -1
  9. package/lib/interface/datalake.d.ts +3 -5
  10. package/lib/interface/datalake.d.ts.map +1 -1
  11. package/lib/interface/email.d.ts +2 -3
  12. package/lib/interface/email.d.ts.map +1 -1
  13. package/lib/interface/file.d.ts +3 -5
  14. package/lib/interface/file.d.ts.map +1 -1
  15. package/lib/interface/kds.d.ts +7 -13
  16. package/lib/interface/kds.d.ts.map +1 -1
  17. package/lib/interface/location.d.ts +53 -105
  18. package/lib/interface/location.d.ts.map +1 -1
  19. package/lib/interface/mealplan.d.ts +12 -23
  20. package/lib/interface/mealplan.d.ts.map +1 -1
  21. package/lib/interface/menu.d.ts +27 -53
  22. package/lib/interface/menu.d.ts.map +1 -1
  23. package/lib/interface/notification.d.ts +7 -13
  24. package/lib/interface/notification.d.ts.map +1 -1
  25. package/lib/interface/order.d.ts +15 -29
  26. package/lib/interface/order.d.ts.map +1 -1
  27. package/lib/interface/partner.d.ts +8 -15
  28. package/lib/interface/partner.d.ts.map +1 -1
  29. package/lib/interface/payment.d.ts +15 -29
  30. package/lib/interface/payment.d.ts.map +1 -1
  31. package/lib/interface/permission.d.ts +10 -19
  32. package/lib/interface/permission.d.ts.map +1 -1
  33. package/lib/interface/promo.d.ts +17 -33
  34. package/lib/interface/promo.d.ts.map +1 -1
  35. package/lib/interface/report.d.ts +8 -15
  36. package/lib/interface/report.d.ts.map +1 -1
  37. package/lib/interface/shoppingcart.d.ts +15 -29
  38. package/lib/interface/shoppingcart.d.ts.map +1 -1
  39. package/lib/interface/task.d.ts +11 -21
  40. package/lib/interface/task.d.ts.map +1 -1
  41. package/lib/interface/user.d.ts +29 -57
  42. package/lib/interface/user.d.ts.map +1 -1
  43. package/lib/interface/util.d.ts +9 -2
  44. package/lib/interface/util.d.ts.map +1 -1
  45. package/lib/interface/vendor.d.ts +17 -33
  46. package/lib/interface/vendor.d.ts.map +1 -1
  47. package/package.json +2 -2
  48. package/src/interface/announcement.ts +10 -18
  49. package/src/interface/calendar.ts +12 -19
  50. package/src/interface/compassconnect.ts +3 -4
  51. package/src/interface/config.ts +10 -24
  52. package/src/interface/datalake.ts +3 -6
  53. package/src/interface/email.ts +2 -3
  54. package/src/interface/file.ts +3 -5
  55. package/src/interface/kds.ts +7 -17
  56. package/src/interface/location.ts +105 -143
  57. package/src/interface/mealplan.ts +13 -27
  58. package/src/interface/menu.ts +42 -74
  59. package/src/interface/notification.ts +7 -16
  60. package/src/interface/order.ts +27 -43
  61. package/src/interface/partner.ts +8 -20
  62. package/src/interface/payment.ts +21 -35
  63. package/src/interface/permission.ts +14 -24
  64. package/src/interface/promo.ts +21 -41
  65. package/src/interface/report.ts +21 -23
  66. package/src/interface/shoppingcart.ts +27 -33
  67. package/src/interface/sms.ts +1 -1
  68. package/src/interface/task.ts +17 -31
  69. package/src/interface/user.ts +45 -72
  70. package/src/interface/util.ts +10 -2
  71. package/src/interface/vendor.ts +24 -42
@@ -1,6 +1,6 @@
1
1
  // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
2
2
 
3
- import { RequestQuery, RequestContext } from "./util";
3
+ import { RequestQuery, BaseRequest } from "./util";
4
4
 
5
5
  export interface Error {
6
6
  message?: string;
@@ -202,9 +202,8 @@ export type PostVendorApplicationBody = ApplicationPostBody;
202
202
 
203
203
  export type PostVendorApplicationResponse = Application;
204
204
 
205
- export interface PostVendorApplicationRequest {
205
+ export interface PostVendorApplicationRequest extends BaseRequest {
206
206
  body: PostVendorApplicationBody;
207
- context?: RequestContext;
208
207
  }
209
208
 
210
209
  // GET /vendor/application - Get a list of all applications
@@ -217,9 +216,9 @@ export interface GetVendorApplicationQuery {
217
216
 
218
217
  export type GetVendorApplicationResponse = Applications;
219
218
 
220
- export interface GetVendorApplicationRequest extends RequestQuery<GetVendorApplicationQuery> {
221
- context?: RequestContext;
222
- }
219
+ export interface GetVendorApplicationRequest
220
+ extends BaseRequest,
221
+ RequestQuery<GetVendorApplicationQuery> {}
223
222
 
224
223
  // PATCH /vendor/application/{id} - Update an application (or update status)
225
224
 
@@ -232,9 +231,8 @@ export type PatchVendorApplicationBody = ApplicationPatchBody;
232
231
 
233
232
  export type PatchVendorApplicationResponse = Application;
234
233
 
235
- export interface PatchVendorApplicationRequest extends PatchVendorApplicationPath {
234
+ export interface PatchVendorApplicationRequest extends BaseRequest, PatchVendorApplicationPath {
236
235
  body: PatchVendorApplicationBody;
237
- context?: RequestContext;
238
236
  }
239
237
 
240
238
  // POST /vendor - Create new vendor
@@ -243,18 +241,15 @@ export type PostVendorBody = VendorPostBody;
243
241
 
244
242
  export type PostVendorResponse = Vendor;
245
243
 
246
- export interface PostVendorRequest {
244
+ export interface PostVendorRequest extends BaseRequest {
247
245
  body: PostVendorBody;
248
- context?: RequestContext;
249
246
  }
250
247
 
251
248
  // GET /vendor - Get all Vendors
252
249
 
253
250
  export type GetVendorsResponse = Vendors;
254
251
 
255
- export interface GetVendorsRequest {
256
- context?: RequestContext;
257
- }
252
+ export interface GetVendorsRequest extends BaseRequest {}
258
253
 
259
254
  // GET /vendor/{id} - Get info about the Vendor
260
255
 
@@ -265,9 +260,7 @@ export interface GetVendorPath {
265
260
 
266
261
  export type GetVendorResponse = Vendor;
267
262
 
268
- export interface GetVendorRequest extends GetVendorPath {
269
- context?: RequestContext;
270
- }
263
+ export interface GetVendorRequest extends BaseRequest, GetVendorPath {}
271
264
 
272
265
  // PATCH /vendor/{id} - Update info about the Vendor
273
266
 
@@ -280,18 +273,15 @@ export type PatchVendorBody = Vendor;
280
273
 
281
274
  export type PatchVendorResponse = Vendor;
282
275
 
283
- export interface PatchVendorRequest extends PatchVendorPath {
276
+ export interface PatchVendorRequest extends BaseRequest, PatchVendorPath {
284
277
  body: PatchVendorBody;
285
- context?: RequestContext;
286
278
  }
287
279
 
288
280
  // GET /vendor/auth - Get access/refresh tokens for accessing our APIs
289
281
 
290
282
  export type GetVendorAuthResponse = Auth;
291
283
 
292
- export interface GetVendorAuthRequest {
293
- context?: RequestContext;
294
- }
284
+ export interface GetVendorAuthRequest extends BaseRequest {}
295
285
 
296
286
  // POST /vendor/auth - Get new access token using refresh token and previous token
297
287
 
@@ -299,9 +289,8 @@ export type PostVendorAuthBody = RefreshPayload;
299
289
 
300
290
  export type PostVendorAuthResponse = Auth;
301
291
 
302
- export interface PostVendorAuthRequest {
292
+ export interface PostVendorAuthRequest extends BaseRequest {
303
293
  body: PostVendorAuthBody;
304
- context?: RequestContext;
305
294
  }
306
295
 
307
296
  // GET /vendor/{id}/key - Get list of Vendor keys
@@ -313,9 +302,7 @@ export interface GetVendorKeysPath {
313
302
 
314
303
  export type GetVendorKeysResponse = Keys;
315
304
 
316
- export interface GetVendorKeysRequest extends GetVendorKeysPath {
317
- context?: RequestContext;
318
- }
305
+ export interface GetVendorKeysRequest extends BaseRequest, GetVendorKeysPath {}
319
306
 
320
307
  // POST /vendor/{id}/key - Create new key for the vendor
321
308
 
@@ -328,9 +315,8 @@ export type PostVendorKeyBody = KeyPostBody;
328
315
 
329
316
  export type PostVendorKeyResponse = Key;
330
317
 
331
- export interface PostVendorKeyRequest extends PostVendorKeyPath {
318
+ export interface PostVendorKeyRequest extends BaseRequest, PostVendorKeyPath {
332
319
  body: PostVendorKeyBody;
333
- context?: RequestContext;
334
320
  }
335
321
 
336
322
  // GET /vendor/{id}/key/{key} - Get info about vendor key
@@ -349,9 +335,10 @@ export interface GetVendorKeyQuery {
349
335
 
350
336
  export type GetVendorKeyResponse = Key;
351
337
 
352
- export interface GetVendorKeyRequest extends RequestQuery<GetVendorKeyQuery>, GetVendorKeyPath {
353
- context?: RequestContext;
354
- }
338
+ export interface GetVendorKeyRequest
339
+ extends BaseRequest,
340
+ RequestQuery<GetVendorKeyQuery>,
341
+ GetVendorKeyPath {}
355
342
 
356
343
  // PATCH /vendor/{id}/key/{key} - Update info for vendor key
357
344
 
@@ -366,9 +353,8 @@ export type PatchVendorKeyBody = KeyPatchBody;
366
353
 
367
354
  export type PatchVendorKeyResponse = Key;
368
355
 
369
- export interface PatchVendorKeyRequest extends PatchVendorKeyPath {
356
+ export interface PatchVendorKeyRequest extends BaseRequest, PatchVendorKeyPath {
370
357
  body: PatchVendorKeyBody;
371
- context?: RequestContext;
372
358
  }
373
359
 
374
360
  // DELETE /vendor/{id}/key/{key} - Mark key as expired
@@ -382,9 +368,7 @@ export interface DeleteVendorKeyPath {
382
368
 
383
369
  export type DeleteVendorKeyResponse = Key;
384
370
 
385
- export interface DeleteVendorKeyRequest extends DeleteVendorKeyPath {
386
- context?: RequestContext;
387
- }
371
+ export interface DeleteVendorKeyRequest extends BaseRequest, DeleteVendorKeyPath {}
388
372
 
389
373
  // POST /vendor/{id}/key/{key}/rotate - Rotate vendor key
390
374
 
@@ -402,10 +386,9 @@ export interface PostVendorKeyRotateQuery {
402
386
  export type PostVendorKeyRotateResponse = Success;
403
387
 
404
388
  export interface PostVendorKeyRotateRequest
405
- extends RequestQuery<PostVendorKeyRotateQuery>,
406
- PostVendorKeyRotatePath {
407
- context?: RequestContext;
408
- }
389
+ extends BaseRequest,
390
+ RequestQuery<PostVendorKeyRotateQuery>,
391
+ PostVendorKeyRotatePath {}
409
392
 
410
393
  // POST /vendor/{id}/reset/password - Reset the existing password for vendor
411
394
 
@@ -418,7 +401,6 @@ export type PostVendorResetPasswordBody = ResetPassword;
418
401
 
419
402
  export type PostVendorResetPasswordResponse = Success;
420
403
 
421
- export interface PostVendorResetPasswordRequest extends PostVendorResetPasswordPath {
404
+ export interface PostVendorResetPasswordRequest extends BaseRequest, PostVendorResetPasswordPath {
422
405
  body: PostVendorResetPasswordBody;
423
- context?: RequestContext;
424
406
  }