@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
  code?: number;
@@ -76,9 +76,8 @@ export interface PostMealplanResponse {
76
76
  tenders?: Tender[];
77
77
  }
78
78
 
79
- export interface PostMealplanRequest extends PostMealplanPath {
79
+ export interface PostMealplanRequest extends BaseRequest, PostMealplanPath {
80
80
  body: PostMealplanBody;
81
- context?: RequestContext;
82
81
  }
83
82
 
84
83
  // PUT /mealplan/{id} - Save a token for access to the meal plan
@@ -96,9 +95,8 @@ export interface PutMealplanResponse {
96
95
  tenders?: Tender[];
97
96
  }
98
97
 
99
- export interface PutMealplanRequest extends PutMealplanPath {
98
+ export interface PutMealplanRequest extends BaseRequest, PutMealplanPath {
100
99
  body: PutMealplanBody;
101
- context?: RequestContext;
102
100
  }
103
101
 
104
102
  // GET /mealplan/{id} - Check the user's meal plan tenders and get the authentication configuration
@@ -110,9 +108,7 @@ export interface GetMealplanPath {
110
108
 
111
109
  export type GetMealplanResponse = TendersAndAuth;
112
110
 
113
- export interface GetMealplanRequest extends GetMealplanPath {
114
- context?: RequestContext;
115
- }
111
+ export interface GetMealplanRequest extends BaseRequest, GetMealplanPath {}
116
112
 
117
113
  // DELETE /mealplan/{id} - Delete a mealplan or a tender from the user's account
118
114
 
@@ -127,9 +123,8 @@ export interface DeleteMealplanBody {
127
123
 
128
124
  export type DeleteMealplanResponse = TendersAndAuth;
129
125
 
130
- export interface DeleteMealplanRequest extends DeleteMealplanPath {
126
+ export interface DeleteMealplanRequest extends BaseRequest, DeleteMealplanPath {
131
127
  body: DeleteMealplanBody;
132
- context?: RequestContext;
133
128
  }
134
129
 
135
130
  // POST /mealplan/{id}/callback - Callback endpoint for meal plans that make a call back from a webview workflow
@@ -145,9 +140,7 @@ export interface PostMealplanCallbackResponse {
145
140
  cardNumber?: string;
146
141
  }
147
142
 
148
- export interface PostMealplanCallbackRequest extends PostMealplanCallbackPath {
149
- context?: RequestContext;
150
- }
143
+ export interface PostMealplanCallbackRequest extends BaseRequest, PostMealplanCallbackPath {}
151
144
 
152
145
  // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
153
146
 
@@ -160,9 +153,7 @@ export interface GetMealplanTenderPath {
160
153
 
161
154
  export type GetMealplanTenderResponse = Tender;
162
155
 
163
- export interface GetMealplanTenderRequest extends GetMealplanTenderPath {
164
- context?: RequestContext;
165
- }
156
+ export interface GetMealplanTenderRequest extends BaseRequest, GetMealplanTenderPath {}
166
157
 
167
158
  // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
168
159
 
@@ -185,9 +176,7 @@ export interface DeleteMealplanTenderResponse {
185
176
  transaction_amount?: number;
186
177
  }
187
178
 
188
- export interface DeleteMealplanTenderRequest extends DeleteMealplanTenderPath {
189
- context?: RequestContext;
190
- }
179
+ export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {}
191
180
 
192
181
  // PATCH /mealplan/{id}/tender/{tender} - Refund an amount to the tender balance
193
182
 
@@ -208,9 +197,8 @@ export interface PatchMealplanTenderBody {
208
197
 
209
198
  export type PatchMealplanTenderResponse = Tender;
210
199
 
211
- export interface PatchMealplanTenderRequest extends PatchMealplanTenderPath {
200
+ export interface PatchMealplanTenderRequest extends BaseRequest, PatchMealplanTenderPath {
212
201
  body: PatchMealplanTenderBody;
213
- context?: RequestContext;
214
202
  }
215
203
 
216
204
  // POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
@@ -230,10 +218,10 @@ export type PostMealplanVerifyBody = VerifyEmail;
230
218
  export type PostMealplanVerifyResponse = success;
231
219
 
232
220
  export interface PostMealplanVerifyRequest
233
- extends RequestQuery<PostMealplanVerifyQuery>,
221
+ extends BaseRequest,
222
+ RequestQuery<PostMealplanVerifyQuery>,
234
223
  PostMealplanVerifyPath {
235
224
  body: PostMealplanVerifyBody;
236
- context?: RequestContext;
237
225
  }
238
226
 
239
227
  // PUT /mealplan/{id}/verify - Verify email address using provided payload
@@ -247,9 +235,8 @@ export type PutMealplanVerifyBody = string;
247
235
 
248
236
  export type PutMealplanVerifyResponse = success;
249
237
 
250
- export interface PutMealplanVerifyRequest extends PutMealplanVerifyPath {
238
+ export interface PutMealplanVerifyRequest extends BaseRequest, PutMealplanVerifyPath {
251
239
  body: PutMealplanVerifyBody;
252
- context?: RequestContext;
253
240
  }
254
241
 
255
242
  // POST /mealplan/{id}/authorize - Authorize Transaction
@@ -277,7 +264,6 @@ export interface PostMealplanAuthorizeResponse {
277
264
  currency?: string;
278
265
  }
279
266
 
280
- export interface PostMealplanAuthorizeRequest extends PostMealplanAuthorizePath {
267
+ export interface PostMealplanAuthorizeRequest extends BaseRequest, PostMealplanAuthorizePath {
281
268
  body: PostMealplanAuthorizeBody;
282
- context?: RequestContext;
283
269
  }
@@ -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 Menu {
6
6
  // menu
@@ -307,9 +307,7 @@ export interface GetMenuClientPath {
307
307
 
308
308
  export type GetMenuClientResponse = Menus;
309
309
 
310
- export interface GetMenuClientRequest extends GetMenuClientPath {
311
- context?: RequestContext;
312
- }
310
+ export interface GetMenuClientRequest extends BaseRequest, GetMenuClientPath {}
313
311
 
314
312
  // GET /menu - Get Menus or search for Menus
315
313
 
@@ -319,9 +317,7 @@ export interface GetMenusQuery {
319
317
 
320
318
  export type GetMenusResponse = Menus;
321
319
 
322
- export interface GetMenusRequest extends RequestQuery<GetMenusQuery> {
323
- context?: RequestContext;
324
- }
320
+ export interface GetMenusRequest extends BaseRequest, RequestQuery<GetMenusQuery> {}
325
321
 
326
322
  // POST /menu - Create a new Menu
327
323
 
@@ -329,9 +325,8 @@ export type PostMenuBody = Menu;
329
325
 
330
326
  export type PostMenuResponse = Menu;
331
327
 
332
- export interface PostMenuRequest {
328
+ export interface PostMenuRequest extends BaseRequest {
333
329
  body: PostMenuBody;
334
- context?: RequestContext;
335
330
  }
336
331
 
337
332
  // HEAD /menu/{id} - Get an individual Menu
@@ -348,9 +343,7 @@ export interface HeadMenuQuery {
348
343
 
349
344
  export type HeadMenuResponse = any;
350
345
 
351
- export interface HeadMenuRequest extends RequestQuery<HeadMenuQuery>, HeadMenuPath {
352
- context?: RequestContext;
353
- }
346
+ export interface HeadMenuRequest extends BaseRequest, RequestQuery<HeadMenuQuery>, HeadMenuPath {}
354
347
 
355
348
  // GET /menu/{id} - Get an individual Menu
356
349
 
@@ -371,9 +364,7 @@ export interface GetMenuQuery {
371
364
 
372
365
  export type GetMenuResponse = Menu;
373
366
 
374
- export interface GetMenuRequest extends RequestQuery<GetMenuQuery>, GetMenuPath {
375
- context?: RequestContext;
376
- }
367
+ export interface GetMenuRequest extends BaseRequest, RequestQuery<GetMenuQuery>, GetMenuPath {}
377
368
 
378
369
  // PUT /menu/{id} - Override a complete Menu
379
370
 
@@ -391,9 +382,8 @@ export type PutMenuBody = Menu;
391
382
 
392
383
  export type PutMenuResponse = Menu;
393
384
 
394
- export interface PutMenuRequest extends RequestQuery<PutMenuQuery>, PutMenuPath {
385
+ export interface PutMenuRequest extends BaseRequest, RequestQuery<PutMenuQuery>, PutMenuPath {
395
386
  body: PutMenuBody;
396
- context?: RequestContext;
397
387
  }
398
388
 
399
389
  // DELETE /menu/{id} - Delete a Menu
@@ -410,9 +400,10 @@ export interface DeleteMenuQuery {
410
400
 
411
401
  export type DeleteMenuResponse = Success;
412
402
 
413
- export interface DeleteMenuRequest extends RequestQuery<DeleteMenuQuery>, DeleteMenuPath {
414
- context?: RequestContext;
415
- }
403
+ export interface DeleteMenuRequest
404
+ extends BaseRequest,
405
+ RequestQuery<DeleteMenuQuery>,
406
+ DeleteMenuPath {}
416
407
 
417
408
  // PATCH /menu/{id} - Update a menu
418
409
 
@@ -430,9 +421,8 @@ export type PatchMenuBody = PatchMenu;
430
421
 
431
422
  export type PatchMenuResponse = Menu;
432
423
 
433
- export interface PatchMenuRequest extends RequestQuery<PatchMenuQuery>, PatchMenuPath {
424
+ export interface PatchMenuRequest extends BaseRequest, RequestQuery<PatchMenuQuery>, PatchMenuPath {
434
425
  body: PatchMenuBody;
435
- context?: RequestContext;
436
426
  }
437
427
 
438
428
  // POST /menu/import - Import an existing Menu
@@ -446,9 +436,8 @@ export interface PostMenuImportMenuBody {
446
436
 
447
437
  export type PostMenuImportMenuResponse = Menu;
448
438
 
449
- export interface PostMenuImportMenuRequest {
439
+ export interface PostMenuImportMenuRequest extends BaseRequest {
450
440
  body: PostMenuImportMenuBody;
451
- context?: RequestContext;
452
441
  }
453
442
 
454
443
  // GET /menu/item/{id} - Get menu item
@@ -464,9 +453,10 @@ export interface GetMenuItemQuery {
464
453
 
465
454
  export type GetMenuItemResponse = Item;
466
455
 
467
- export interface GetMenuItemRequest extends RequestQuery<GetMenuItemQuery>, GetMenuItemPath {
468
- context?: RequestContext;
469
- }
456
+ export interface GetMenuItemRequest
457
+ extends BaseRequest,
458
+ RequestQuery<GetMenuItemQuery>,
459
+ GetMenuItemPath {}
470
460
 
471
461
  // DELETE /menu/item/{id} - Delete a menu item
472
462
 
@@ -477,9 +467,7 @@ export interface DeleteMenuItemPath {
477
467
 
478
468
  export type DeleteMenuItemResponse = Success;
479
469
 
480
- export interface DeleteMenuItemRequest extends DeleteMenuItemPath {
481
- context?: RequestContext;
482
- }
470
+ export interface DeleteMenuItemRequest extends BaseRequest, DeleteMenuItemPath {}
483
471
 
484
472
  // POST /menu/item - Create a menu item
485
473
 
@@ -487,9 +475,8 @@ export type PostMenuItemBody = Item;
487
475
 
488
476
  export type PostMenuItemResponse = Item;
489
477
 
490
- export interface PostMenuItemRequest {
478
+ export interface PostMenuItemRequest extends BaseRequest {
491
479
  body: PostMenuItemBody;
492
- context?: RequestContext;
493
480
  }
494
481
 
495
482
  // GET /menu/items - Search for menu items
@@ -500,9 +487,7 @@ export interface GetMenuItemsQuery {
500
487
 
501
488
  export type GetMenuItemsResponse = Items;
502
489
 
503
- export interface GetMenuItemsRequest extends RequestQuery<GetMenuItemsQuery> {
504
- context?: RequestContext;
505
- }
490
+ export interface GetMenuItemsRequest extends BaseRequest, RequestQuery<GetMenuItemsQuery> {}
506
491
 
507
492
  // POST /menu/items/import/{location} - trigger import items
508
493
 
@@ -513,9 +498,9 @@ export interface PostMenuImportItemsCanteenPath {
513
498
 
514
499
  export type PostMenuImportItemsCanteenResponse = Success;
515
500
 
516
- export interface PostMenuImportItemsCanteenRequest extends PostMenuImportItemsCanteenPath {
517
- context?: RequestContext;
518
- }
501
+ export interface PostMenuImportItemsCanteenRequest
502
+ extends BaseRequest,
503
+ PostMenuImportItemsCanteenPath {}
519
504
 
520
505
  // GET /menu/items/location/{location} - Get all menu items for a location
521
506
 
@@ -526,9 +511,7 @@ export interface GetMenuLocationItemsPath {
526
511
 
527
512
  export type GetMenuLocationItemsResponse = Items;
528
513
 
529
- export interface GetMenuLocationItemsRequest extends GetMenuLocationItemsPath {
530
- context?: RequestContext;
531
- }
514
+ export interface GetMenuLocationItemsRequest extends BaseRequest, GetMenuLocationItemsPath {}
532
515
 
533
516
  // GET /menu/item/random/location/{location} - Get a random item
534
517
 
@@ -549,10 +532,9 @@ export interface GetMenuLocationItemRandomQuery {
549
532
  export type GetMenuLocationItemRandomResponse = Item;
550
533
 
551
534
  export interface GetMenuLocationItemRandomRequest
552
- extends RequestQuery<GetMenuLocationItemRandomQuery>,
553
- GetMenuLocationItemRandomPath {
554
- context?: RequestContext;
555
- }
535
+ extends BaseRequest,
536
+ RequestQuery<GetMenuLocationItemRandomQuery>,
537
+ GetMenuLocationItemRandomPath {}
556
538
 
557
539
  // GET /menu/items/random/location/{location} - Get a set of random items
558
540
 
@@ -575,10 +557,9 @@ export interface GetMenuLocationItemsRandomQuery {
575
557
  export type GetMenuLocationItemsRandomResponse = Items;
576
558
 
577
559
  export interface GetMenuLocationItemsRandomRequest
578
- extends RequestQuery<GetMenuLocationItemsRandomQuery>,
579
- GetMenuLocationItemsRandomPath {
580
- context?: RequestContext;
581
- }
560
+ extends BaseRequest,
561
+ RequestQuery<GetMenuLocationItemsRandomQuery>,
562
+ GetMenuLocationItemsRandomPath {}
582
563
 
583
564
  // GET /menu/sector/{sector} - Get menus that belong to sector
584
565
 
@@ -589,9 +570,7 @@ export interface GetMenuSectorMenusPath {
589
570
 
590
571
  export type GetMenuSectorMenusResponse = Menus;
591
572
 
592
- export interface GetMenuSectorMenusRequest extends GetMenuSectorMenusPath {
593
- context?: RequestContext;
594
- }
573
+ export interface GetMenuSectorMenusRequest extends BaseRequest, GetMenuSectorMenusPath {}
595
574
 
596
575
  // GET /menu/company/{company} - Get menus that belong to company
597
576
 
@@ -602,9 +581,7 @@ export interface GetMenuCompanyMenusPath {
602
581
 
603
582
  export type GetMenuCompanyMenusResponse = Menus;
604
583
 
605
- export interface GetMenuCompanyMenusRequest extends GetMenuCompanyMenusPath {
606
- context?: RequestContext;
607
- }
584
+ export interface GetMenuCompanyMenusRequest extends BaseRequest, GetMenuCompanyMenusPath {}
608
585
 
609
586
  // POST /menu/modifier/group - Create a new Menu Modifier Group
610
587
 
@@ -612,9 +589,8 @@ export type PostMenuModifierGroupBody = CreateOptionsGroup;
612
589
 
613
590
  export type PostMenuModifierGroupResponse = OptionsGroup;
614
591
 
615
- export interface PostMenuModifierGroupRequest {
592
+ export interface PostMenuModifierGroupRequest extends BaseRequest {
616
593
  body: PostMenuModifierGroupBody;
617
- context?: RequestContext;
618
594
  }
619
595
 
620
596
  // GET /menu/modifier/group/{id} - Get a Menu Modifier Group
@@ -626,9 +602,7 @@ export interface GetMenuModifierGroupPath {
626
602
 
627
603
  export type GetMenuModifierGroupResponse = OptionsGroup;
628
604
 
629
- export interface GetMenuModifierGroupRequest extends GetMenuModifierGroupPath {
630
- context?: RequestContext;
631
- }
605
+ export interface GetMenuModifierGroupRequest extends BaseRequest, GetMenuModifierGroupPath {}
632
606
 
633
607
  // PUT /menu/modifier/group/{id} - Update a Menu Modifier Group
634
608
 
@@ -641,9 +615,8 @@ export type PutMenuModifierGroupBody = OptionsGroup;
641
615
 
642
616
  export type PutMenuModifierGroupResponse = OptionsGroup;
643
617
 
644
- export interface PutMenuModifierGroupRequest extends PutMenuModifierGroupPath {
618
+ export interface PutMenuModifierGroupRequest extends BaseRequest, PutMenuModifierGroupPath {
645
619
  body: PutMenuModifierGroupBody;
646
- context?: RequestContext;
647
620
  }
648
621
 
649
622
  // DELETE /menu/modifier/group/{id} - Delete a Menu Modifier Group
@@ -655,9 +628,7 @@ export interface DeleteMenuModifierGroupPath {
655
628
 
656
629
  export type DeleteMenuModifierGroupResponse = Success;
657
630
 
658
- export interface DeleteMenuModifierGroupRequest extends DeleteMenuModifierGroupPath {
659
- context?: RequestContext;
660
- }
631
+ export interface DeleteMenuModifierGroupRequest extends BaseRequest, DeleteMenuModifierGroupPath {}
661
632
 
662
633
  // GET /menu/modifier/group/company/{company} - Get the modifier groups that belong to company
663
634
 
@@ -668,9 +639,9 @@ export interface GetMenuCompanyModifierGroupsPath {
668
639
 
669
640
  export type GetMenuCompanyModifierGroupsResponse = OptionsGroupList;
670
641
 
671
- export interface GetMenuCompanyModifierGroupsRequest extends GetMenuCompanyModifierGroupsPath {
672
- context?: RequestContext;
673
- }
642
+ export interface GetMenuCompanyModifierGroupsRequest
643
+ extends BaseRequest,
644
+ GetMenuCompanyModifierGroupsPath {}
674
645
 
675
646
  // GET /menu/modifier/group/company/{company}/export - Export company modifier groups to zipped excel file.
676
647
 
@@ -682,9 +653,8 @@ export interface GetMenuCompanyModifierGroupsExportPath {
682
653
  export type GetMenuCompanyModifierGroupsExportResponse = ZippedExcelExport;
683
654
 
684
655
  export interface GetMenuCompanyModifierGroupsExportRequest
685
- extends GetMenuCompanyModifierGroupsExportPath {
686
- context?: RequestContext;
687
- }
656
+ extends BaseRequest,
657
+ GetMenuCompanyModifierGroupsExportPath {}
688
658
 
689
659
  // GET /menu/{id}/export - Export menu set to zipped excel file.
690
660
 
@@ -695,6 +665,4 @@ export interface GetMenuExportPath {
695
665
 
696
666
  export type GetMenuExportResponse = ZippedExcelExport;
697
667
 
698
- export interface GetMenuExportRequest extends GetMenuExportPath {
699
- context?: RequestContext;
700
- }
668
+ export interface GetMenuExportRequest extends BaseRequest, GetMenuExportPath {}
@@ -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
  error?: string;
@@ -52,9 +52,7 @@ export interface GetNotificationsResponse {
52
52
  notifications?: Notification[];
53
53
  }
54
54
 
55
- export interface GetNotificationsRequest extends RequestQuery<GetNotificationsQuery> {
56
- context?: RequestContext;
57
- }
55
+ export interface GetNotificationsRequest extends BaseRequest, RequestQuery<GetNotificationsQuery> {}
58
56
 
59
57
  // POST /notification - Create a notification
60
58
 
@@ -62,9 +60,8 @@ export type PostNotificationBody = NotificationBody;
62
60
 
63
61
  export type PostNotificationResponse = Notification;
64
62
 
65
- export interface PostNotificationRequest {
63
+ export interface PostNotificationRequest extends BaseRequest {
66
64
  body: PostNotificationBody;
67
- context?: RequestContext;
68
65
  }
69
66
 
70
67
  // PATCH /notification/{id} - Update a notification
@@ -78,9 +75,8 @@ export type PatchNotificationBody = NotificationBody;
78
75
 
79
76
  export type PatchNotificationResponse = Notification;
80
77
 
81
- export interface PatchNotificationRequest extends PatchNotificationPath {
78
+ export interface PatchNotificationRequest extends BaseRequest, PatchNotificationPath {
82
79
  body: PatchNotificationBody;
83
- context?: RequestContext;
84
80
  }
85
81
 
86
82
  // DELETE /notification/{id} - Delete a notification
@@ -92,9 +88,7 @@ export interface DeleteNotificationPath {
92
88
 
93
89
  export type DeleteNotificationResponse = Success;
94
90
 
95
- export interface DeleteNotificationRequest extends DeleteNotificationPath {
96
- context?: RequestContext;
97
- }
91
+ export interface DeleteNotificationRequest extends BaseRequest, DeleteNotificationPath {}
98
92
 
99
93
  // POST /notification/{id}/status - Set a notification status for request user
100
94
 
@@ -110,9 +104,8 @@ export interface PostNotificationStatusBody {
110
104
 
111
105
  export type PostNotificationStatusResponse = NotificationStatus;
112
106
 
113
- export interface PostNotificationStatusRequest extends PostNotificationStatusPath {
107
+ export interface PostNotificationStatusRequest extends BaseRequest, PostNotificationStatusPath {
114
108
  body: PostNotificationStatusBody;
115
- context?: RequestContext;
116
109
  }
117
110
 
118
111
  // GET /notification/swagger.json - Get a swagger for notification service
@@ -121,6 +114,4 @@ export interface GetNotificationSwaggerResponse {
121
114
  [index: string]: any;
122
115
  }
123
116
 
124
- export interface GetNotificationSwaggerRequest {
125
- context?: RequestContext;
126
- }
117
+ export interface GetNotificationSwaggerRequest extends BaseRequest {}
@@ -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 CreateOrder {
6
6
  // brand
@@ -291,9 +291,8 @@ export type PostOrderBody = CreateOrder;
291
291
 
292
292
  export type PostOrderResponse = Order;
293
293
 
294
- export interface PostOrderRequest extends RequestQuery<PostOrderQuery> {
294
+ export interface PostOrderRequest extends BaseRequest, RequestQuery<PostOrderQuery> {
295
295
  body: PostOrderBody;
296
- context?: RequestContext;
297
296
  }
298
297
 
299
298
  // GET /order/{id} - Get an individual order
@@ -305,9 +304,7 @@ export interface GetOrderPath {
305
304
 
306
305
  export type GetOrderResponse = Order;
307
306
 
308
- export interface GetOrderRequest extends GetOrderPath {
309
- context?: RequestContext;
310
- }
307
+ export interface GetOrderRequest extends BaseRequest, GetOrderPath {}
311
308
 
312
309
  // PUT /order/{id} - Update an individual order
313
310
 
@@ -318,9 +315,7 @@ export interface PutOrderPath {
318
315
 
319
316
  export type PutOrderResponse = Order;
320
317
 
321
- export interface PutOrderRequest extends PutOrderPath {
322
- context?: RequestContext;
323
- }
318
+ export interface PutOrderRequest extends BaseRequest, PutOrderPath {}
324
319
 
325
320
  // PATCH /order/{id} - Update an existing order
326
321
 
@@ -333,9 +328,8 @@ export type PatchOrderBody = Order;
333
328
 
334
329
  export type PatchOrderResponse = Order;
335
330
 
336
- export interface PatchOrderRequest extends PatchOrderPath {
331
+ export interface PatchOrderRequest extends BaseRequest, PatchOrderPath {
337
332
  body: PatchOrderBody;
338
- context?: RequestContext;
339
333
  }
340
334
 
341
335
  // POST /order/{id}/issue - Create an issue with an order
@@ -349,9 +343,8 @@ export type PostOrderIssueBody = OrderIssue;
349
343
 
350
344
  export type PostOrderIssueResponse = Issue;
351
345
 
352
- export interface PostOrderIssueRequest extends PostOrderIssuePath {
346
+ export interface PostOrderIssueRequest extends BaseRequest, PostOrderIssuePath {
353
347
  body: PostOrderIssueBody;
354
- context?: RequestContext;
355
348
  }
356
349
 
357
350
  // PATCH /order/{id}/refund - Issue a refund on an existing order
@@ -365,9 +358,8 @@ export type PatchOrderRefundBody = Refund;
365
358
 
366
359
  export type PatchOrderRefundResponse = Order;
367
360
 
368
- export interface PatchOrderRefundRequest extends PatchOrderRefundPath {
361
+ export interface PatchOrderRefundRequest extends BaseRequest, PatchOrderRefundPath {
369
362
  body: PatchOrderRefundBody;
370
- context?: RequestContext;
371
363
  }
372
364
 
373
365
  // GET /order/customer/{id} - Get all orders for a Customer
@@ -397,10 +389,9 @@ export interface GetOrderCustomerOrdersResponse {
397
389
  }
398
390
 
399
391
  export interface GetOrderCustomerOrdersRequest
400
- extends RequestQuery<GetOrderCustomerOrdersQuery>,
401
- GetOrderCustomerOrdersPath {
402
- context?: RequestContext;
403
- }
392
+ extends BaseRequest,
393
+ RequestQuery<GetOrderCustomerOrdersQuery>,
394
+ GetOrderCustomerOrdersPath {}
404
395
 
405
396
  // GET /order/customer/{id}/location/brand/{location_brand} - Get all orders for a Customer for a specific Location Brand
406
397
 
@@ -413,9 +404,9 @@ export interface GetOrderCustomerOrdersBrandPath {
413
404
 
414
405
  export type GetOrderCustomerOrdersBrandResponse = Orders;
415
406
 
416
- export interface GetOrderCustomerOrdersBrandRequest extends GetOrderCustomerOrdersBrandPath {
417
- context?: RequestContext;
418
- }
407
+ export interface GetOrderCustomerOrdersBrandRequest
408
+ extends BaseRequest,
409
+ GetOrderCustomerOrdersBrandPath {}
419
410
 
420
411
  // GET /order/location/brand/{id} - Get all orders for a location Brand
421
412
 
@@ -444,10 +435,9 @@ export interface GetOrderLocationBrandQuery {
444
435
  export type GetOrderLocationBrandResponse = Orders;
445
436
 
446
437
  export interface GetOrderLocationBrandRequest
447
- extends RequestQuery<GetOrderLocationBrandQuery>,
448
- GetOrderLocationBrandPath {
449
- context?: RequestContext;
450
- }
438
+ extends BaseRequest,
439
+ RequestQuery<GetOrderLocationBrandQuery>,
440
+ GetOrderLocationBrandPath {}
451
441
 
452
442
  // GET /order/location/{id} - Get all orders for a location
453
443
 
@@ -476,10 +466,9 @@ export interface GetOrderLocationOrdersQuery {
476
466
  export type GetOrderLocationOrdersResponse = Orders;
477
467
 
478
468
  export interface GetOrderLocationOrdersRequest
479
- extends RequestQuery<GetOrderLocationOrdersQuery>,
480
- GetOrderLocationOrdersPath {
481
- context?: RequestContext;
482
- }
469
+ extends BaseRequest,
470
+ RequestQuery<GetOrderLocationOrdersQuery>,
471
+ GetOrderLocationOrdersPath {}
483
472
 
484
473
  // GET /order/location/group/{id} - Get all orders for a location group
485
474
 
@@ -506,10 +495,9 @@ export interface GetOrderGroupOrdersResponse {
506
495
  }
507
496
 
508
497
  export interface GetOrderGroupOrdersRequest
509
- extends RequestQuery<GetOrderGroupOrdersQuery>,
510
- GetOrderGroupOrdersPath {
511
- context?: RequestContext;
512
- }
498
+ extends BaseRequest,
499
+ RequestQuery<GetOrderGroupOrdersQuery>,
500
+ GetOrderGroupOrdersPath {}
513
501
 
514
502
  // GET /order/user/{id} - Get all delivery orders for a User related to the order in the details (Runner)
515
503
 
@@ -532,10 +520,9 @@ export interface GetOrderUserOrdersResponse {
532
520
  }
533
521
 
534
522
  export interface GetOrderUserOrdersRequest
535
- extends RequestQuery<GetOrderUserOrdersQuery>,
536
- GetOrderUserOrdersPath {
537
- context?: RequestContext;
538
- }
523
+ extends BaseRequest,
524
+ RequestQuery<GetOrderUserOrdersQuery>,
525
+ GetOrderUserOrdersPath {}
539
526
 
540
527
  // PATCH /order/{id}/checkin - Accept an order by checking in
541
528
 
@@ -546,9 +533,7 @@ export interface PatchOrderCheckinPath {
546
533
 
547
534
  export type PatchOrderCheckinResponse = Order;
548
535
 
549
- export interface PatchOrderCheckinRequest extends PatchOrderCheckinPath {
550
- context?: RequestContext;
551
- }
536
+ export interface PatchOrderCheckinRequest extends BaseRequest, PatchOrderCheckinPath {}
552
537
 
553
538
  // POST /order/apex/sns - Update apex integrated order
554
539
 
@@ -556,7 +541,6 @@ export type PostOrderApexSnsBody = SNSMessage;
556
541
 
557
542
  export type PostOrderApexSnsResponse = ActionResponse;
558
543
 
559
- export interface PostOrderApexSnsRequest {
544
+ export interface PostOrderApexSnsRequest extends BaseRequest {
560
545
  body: PostOrderApexSnsBody;
561
- context?: RequestContext;
562
546
  }