@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;
@@ -73,9 +73,10 @@ export interface GetCalendarQuery {
73
73
 
74
74
  export type GetCalendarResponse = Calendar;
75
75
 
76
- export interface GetCalendarRequest extends RequestQuery<GetCalendarQuery>, GetCalendarPath {
77
- context?: RequestContext;
78
- }
76
+ export interface GetCalendarRequest
77
+ extends BaseRequest,
78
+ RequestQuery<GetCalendarQuery>,
79
+ GetCalendarPath {}
79
80
 
80
81
  // PUT /calendar/{id} - Set the calendar for an id. Overrides previous record
81
82
 
@@ -88,9 +89,8 @@ export type PutCalendarBody = UpdatedCalendar;
88
89
 
89
90
  export type PutCalendarResponse = Calendar;
90
91
 
91
- export interface PutCalendarRequest extends PutCalendarPath {
92
+ export interface PutCalendarRequest extends BaseRequest, PutCalendarPath {
92
93
  body: PutCalendarBody;
93
- context?: RequestContext;
94
94
  }
95
95
 
96
96
  // DELETE /calendar/{id} - Delete a calendar.
@@ -102,9 +102,7 @@ export interface DeleteCalendarPath {
102
102
 
103
103
  export type DeleteCalendarResponse = Success;
104
104
 
105
- export interface DeleteCalendarRequest extends DeleteCalendarPath {
106
- context?: RequestContext;
107
- }
105
+ export interface DeleteCalendarRequest extends BaseRequest, DeleteCalendarPath {}
108
106
 
109
107
  // GET /calendar/{id}/cdl - Get the calendar events in a CDL compatible format for next 7 days
110
108
 
@@ -121,10 +119,9 @@ export interface GetCalendarCdlQuery {
121
119
  export type GetCalendarCdlResponse = CDLCalendar;
122
120
 
123
121
  export interface GetCalendarCdlRequest
124
- extends RequestQuery<GetCalendarCdlQuery>,
125
- GetCalendarCdlPath {
126
- context?: RequestContext;
127
- }
122
+ extends BaseRequest,
123
+ RequestQuery<GetCalendarCdlQuery>,
124
+ GetCalendarCdlPath {}
128
125
 
129
126
  // GET /calendar/swagger.json
130
127
 
@@ -132,9 +129,7 @@ export interface GetCalendarSwaggerResponse {
132
129
  [index: string]: any;
133
130
  }
134
131
 
135
- export interface GetCalendarSwaggerRequest {
136
- context?: RequestContext;
137
- }
132
+ export interface GetCalendarSwaggerRequest extends BaseRequest {}
138
133
 
139
134
  // POST /calendar/{id}/sync - Trigger synchronization of calendar to location API
140
135
 
@@ -145,6 +140,4 @@ export interface PostCalendarSyncPath {
145
140
 
146
141
  export type PostCalendarSyncResponse = Success;
147
142
 
148
- export interface PostCalendarSyncRequest extends PostCalendarSyncPath {
149
- context?: RequestContext;
150
- }
143
+ export interface PostCalendarSyncRequest extends BaseRequest, PostCalendarSyncPath {}
@@ -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 OMSRequest {
6
6
  code: string;
@@ -50,6 +50,5 @@ export interface GetCompassconnectOmsTokenQuery {
50
50
  export type GetCompassconnectOmsTokenResponse = Auth;
51
51
 
52
52
  export interface GetCompassconnectOmsTokenRequest
53
- extends RequestQuery<GetCompassconnectOmsTokenQuery> {
54
- context?: RequestContext;
55
- }
53
+ extends BaseRequest,
54
+ RequestQuery<GetCompassconnectOmsTokenQuery> {}
@@ -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 type CreateConfig = any;
6
6
 
@@ -21,9 +21,7 @@ export interface Success {
21
21
 
22
22
  export type GetConfigAppconfigResponse = Config;
23
23
 
24
- export interface GetConfigAppconfigRequest {
25
- context?: RequestContext;
26
- }
24
+ export interface GetConfigAppconfigRequest extends BaseRequest {}
27
25
 
28
26
  // GET /config/{key} - get a configuration
29
27
 
@@ -34,9 +32,7 @@ export interface GetConfigPath {
34
32
 
35
33
  export type GetConfigResponse = Config;
36
34
 
37
- export interface GetConfigRequest extends GetConfigPath {
38
- context?: RequestContext;
39
- }
35
+ export interface GetConfigRequest extends BaseRequest, GetConfigPath {}
40
36
 
41
37
  // POST /config/{key} - Create a configuration
42
38
 
@@ -49,9 +45,8 @@ export type PostConfigBody = CreateConfig;
49
45
 
50
46
  export type PostConfigResponse = Config;
51
47
 
52
- export interface PostConfigRequest extends PostConfigPath {
48
+ export interface PostConfigRequest extends BaseRequest, PostConfigPath {
53
49
  body: PostConfigBody;
54
- context?: RequestContext;
55
50
  }
56
51
 
57
52
  // PUT /config/{key} - Update a configuration
@@ -65,9 +60,8 @@ export type PutConfigBody = CreateConfig;
65
60
 
66
61
  export type PutConfigResponse = Config;
67
62
 
68
- export interface PutConfigRequest extends PutConfigPath {
63
+ export interface PutConfigRequest extends BaseRequest, PutConfigPath {
69
64
  body: PutConfigBody;
70
- context?: RequestContext;
71
65
  }
72
66
 
73
67
  // DELETE /config/{key} - Delete a configuration
@@ -79,9 +73,7 @@ export interface DeleteConfigPath {
79
73
 
80
74
  export type DeleteConfigResponse = Success;
81
75
 
82
- export interface DeleteConfigRequest extends DeleteConfigPath {
83
- context?: RequestContext;
84
- }
76
+ export interface DeleteConfigRequest extends BaseRequest, DeleteConfigPath {}
85
77
 
86
78
  // GET /config/public/{key} - get a public configuration
87
79
 
@@ -92,9 +84,7 @@ export interface GetConfigPublicPath {
92
84
 
93
85
  export type GetConfigPublicResponse = Config;
94
86
 
95
- export interface GetConfigPublicRequest extends GetConfigPublicPath {
96
- context?: RequestContext;
97
- }
87
+ export interface GetConfigPublicRequest extends BaseRequest, GetConfigPublicPath {}
98
88
 
99
89
  // POST /config/public/{key} - Create a public configuration
100
90
 
@@ -107,9 +97,8 @@ export type PostConfigPublicBody = CreateConfig;
107
97
 
108
98
  export type PostConfigPublicResponse = Config;
109
99
 
110
- export interface PostConfigPublicRequest extends PostConfigPublicPath {
100
+ export interface PostConfigPublicRequest extends BaseRequest, PostConfigPublicPath {
111
101
  body: PostConfigPublicBody;
112
- context?: RequestContext;
113
102
  }
114
103
 
115
104
  // PUT /config/public/{key} - Update a public configuration
@@ -123,9 +112,8 @@ export type PutConfigPublicBody = CreateConfig;
123
112
 
124
113
  export type PutConfigPublicResponse = Config;
125
114
 
126
- export interface PutConfigPublicRequest extends PutConfigPublicPath {
115
+ export interface PutConfigPublicRequest extends BaseRequest, PutConfigPublicPath {
127
116
  body: PutConfigPublicBody;
128
- context?: RequestContext;
129
117
  }
130
118
 
131
119
  // DELETE /config/public/{key} - Delete a public configuration
@@ -137,6 +125,4 @@ export interface DeleteConfigPublicPath {
137
125
 
138
126
  export type DeleteConfigPublicResponse = Success;
139
127
 
140
- export interface DeleteConfigPublicRequest extends DeleteConfigPublicPath {
141
- context?: RequestContext;
142
- }
128
+ export interface DeleteConfigPublicRequest extends BaseRequest, DeleteConfigPublicPath {}
@@ -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;
@@ -21,15 +21,12 @@ export interface PostDatalakeSqlResponse {
21
21
  }[];
22
22
  }
23
23
 
24
- export interface PostDatalakeSqlRequest {
24
+ export interface PostDatalakeSqlRequest extends BaseRequest {
25
25
  body: PostDatalakeSqlBody;
26
- context?: RequestContext;
27
26
  }
28
27
 
29
28
  // GET /swagger.json
30
29
 
31
30
  export type GetSwaggerResponse = any;
32
31
 
33
- export interface GetSwaggerRequest {
34
- context?: RequestContext;
35
- }
32
+ export interface GetSwaggerRequest 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 Error {
6
6
  message?: string;
@@ -27,7 +27,6 @@ export type PostEmailBody = EmailPayload;
27
27
 
28
28
  export type PostEmailResponse = Success;
29
29
 
30
- export interface PostEmailRequest {
30
+ export interface PostEmailRequest extends BaseRequest {
31
31
  body: PostEmailBody;
32
- context?: RequestContext;
33
32
  }
@@ -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;
@@ -24,9 +24,8 @@ export interface PostFileBody {
24
24
 
25
25
  export type PostFileResponse = File;
26
26
 
27
- export interface PostFileRequest {
27
+ export interface PostFileRequest extends BaseRequest {
28
28
  body: PostFileBody;
29
- context?: RequestContext;
30
29
  }
31
30
 
32
31
  // DELETE /file - Delete a file from CDL S3
@@ -42,7 +41,6 @@ export interface DeleteFileResponse {
42
41
  success?: boolean;
43
42
  }
44
43
 
45
- export interface DeleteFileRequest {
44
+ export interface DeleteFileRequest extends BaseRequest {
46
45
  body: DeleteFileBody;
47
- context?: RequestContext;
48
46
  }
@@ -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 Success {
6
6
  success: boolean;
@@ -67,9 +67,7 @@ export interface GetKdsDevicesQuery {
67
67
 
68
68
  export type GetKdsDevicesResponse = Units;
69
69
 
70
- export interface GetKdsDevicesRequest extends RequestQuery<GetKdsDevicesQuery> {
71
- context?: RequestContext;
72
- }
70
+ export interface GetKdsDevicesRequest extends BaseRequest, RequestQuery<GetKdsDevicesQuery> {}
73
71
 
74
72
  // POST /kds/device/auth - Get auth token for a device
75
73
 
@@ -77,9 +75,8 @@ export type PostKdsDeviceAuthBody = AuthPostBody;
77
75
 
78
76
  export type PostKdsDeviceAuthResponse = AuthPostBodyResponse;
79
77
 
80
- export interface PostKdsDeviceAuthRequest {
78
+ export interface PostKdsDeviceAuthRequest extends BaseRequest {
81
79
  body: PostKdsDeviceAuthBody;
82
- context?: RequestContext;
83
80
  }
84
81
 
85
82
  // DELETE /kds/device/auth/{device_id} - Delete authorization for specified serial_number
@@ -91,9 +88,7 @@ export interface DeleteKdsDeviceAuthPath {
91
88
 
92
89
  export type DeleteKdsDeviceAuthResponse = Error;
93
90
 
94
- export interface DeleteKdsDeviceAuthRequest extends DeleteKdsDeviceAuthPath {
95
- context?: RequestContext;
96
- }
91
+ export interface DeleteKdsDeviceAuthRequest extends BaseRequest, DeleteKdsDeviceAuthPath {}
97
92
 
98
93
  // PATCH /kds/device/info/{device_id} - Update additional information related to the kds
99
94
 
@@ -106,9 +101,8 @@ export type PatchKdsDeviceInfoBody = DeviceInfo;
106
101
 
107
102
  export type PatchKdsDeviceInfoResponse = DeviceInfo;
108
103
 
109
- export interface PatchKdsDeviceInfoRequest extends PatchKdsDeviceInfoPath {
104
+ export interface PatchKdsDeviceInfoRequest extends BaseRequest, PatchKdsDeviceInfoPath {
110
105
  body: PatchKdsDeviceInfoBody;
111
- context?: RequestContext;
112
106
  }
113
107
 
114
108
  // DELETE /kds/device/info/{device_id} - Delete additional information related to the kds
@@ -120,9 +114,7 @@ export interface DeleteKdsDeviceInfoPath {
120
114
 
121
115
  export type DeleteKdsDeviceInfoResponse = Success;
122
116
 
123
- export interface DeleteKdsDeviceInfoRequest extends DeleteKdsDeviceInfoPath {
124
- context?: RequestContext;
125
- }
117
+ export interface DeleteKdsDeviceInfoRequest extends BaseRequest, DeleteKdsDeviceInfoPath {}
126
118
 
127
119
  // GET /kds/swagger.json - Get a swagger for kds service
128
120
 
@@ -130,6 +122,4 @@ export interface GetKdsSwaggerResponse {
130
122
  [index: string]: any;
131
123
  }
132
124
 
133
- export interface GetKdsSwaggerRequest {
134
- context?: RequestContext;
135
- }
125
+ export interface GetKdsSwaggerRequest extends BaseRequest {}