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