@compassdigital/sdk.typescript 4.67.0 → 4.68.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/index.d.ts +58 -57
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +503 -501
- package/lib/index.js.map +1 -1
- package/lib/interface/ai.d.ts +1 -1
- package/lib/interface/ai.d.ts.map +1 -1
- package/lib/interface/announcement.d.ts +1 -1
- package/lib/interface/announcement.d.ts.map +1 -1
- package/lib/interface/auth.d.ts +3 -3
- package/lib/interface/auth.d.ts.map +1 -1
- package/lib/interface/calendar.d.ts +2 -2
- package/lib/interface/calendar.d.ts.map +1 -1
- package/lib/interface/centricos.d.ts +11 -11
- package/lib/interface/centricos.d.ts.map +1 -1
- package/lib/interface/compassconnect.d.ts +1 -1
- package/lib/interface/compassconnect.d.ts.map +1 -1
- package/lib/interface/config.d.ts +1 -1
- package/lib/interface/config.d.ts.map +1 -1
- package/lib/interface/datalake.d.ts +1 -1
- package/lib/interface/datalake.d.ts.map +1 -1
- package/lib/interface/email.d.ts +1 -1
- package/lib/interface/email.d.ts.map +1 -1
- package/lib/interface/file.d.ts +2 -2
- package/lib/interface/file.d.ts.map +1 -1
- package/lib/interface/frictionless.d.ts +9 -9
- package/lib/interface/frictionless.d.ts.map +1 -1
- package/lib/interface/kds.d.ts +1 -1
- package/lib/interface/kds.d.ts.map +1 -1
- package/lib/interface/location.d.ts +5 -3
- package/lib/interface/location.d.ts.map +1 -1
- package/lib/interface/mealplan.d.ts +2 -1
- package/lib/interface/mealplan.d.ts.map +1 -1
- package/lib/interface/menu.d.ts +149 -109
- package/lib/interface/menu.d.ts.map +1 -1
- package/lib/interface/notification.d.ts +3 -3
- package/lib/interface/notification.d.ts.map +1 -1
- package/lib/interface/order.d.ts +7 -7
- package/lib/interface/order.d.ts.map +1 -1
- package/lib/interface/partner.d.ts +10 -10
- package/lib/interface/partner.d.ts.map +1 -1
- package/lib/interface/payment.d.ts +3 -3
- package/lib/interface/payment.d.ts.map +1 -1
- package/lib/interface/promo.d.ts +8 -8
- package/lib/interface/promo.d.ts.map +1 -1
- package/lib/interface/report.d.ts +10 -10
- package/lib/interface/report.d.ts.map +1 -1
- package/lib/interface/search.d.ts +8 -8
- package/lib/interface/search.d.ts.map +1 -1
- package/lib/interface/shoppingcart.d.ts +7 -7
- package/lib/interface/shoppingcart.d.ts.map +1 -1
- package/lib/interface/task.d.ts +8 -8
- package/lib/interface/task.d.ts.map +1 -1
- package/lib/interface/tax.d.ts +2 -2
- package/lib/interface/tax.d.ts.map +1 -1
- package/lib/interface/user.d.ts +16 -16
- package/lib/interface/user.d.ts.map +1 -1
- package/lib/interface/vendor.d.ts +6 -6
- package/lib/interface/vendor.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/index.ts +10395 -10394
- package/src/interface/ai.ts +22 -22
- package/src/interface/announcement.ts +60 -60
- package/src/interface/auth.ts +68 -68
- package/src/interface/calendar.ts +94 -94
- package/src/interface/centricos.ts +145 -145
- package/src/interface/compassconnect.ts +59 -59
- package/src/interface/config.ts +166 -166
- package/src/interface/datalake.ts +13 -13
- package/src/interface/email.ts +13 -13
- package/src/interface/file.ts +18 -18
- package/src/interface/frictionless.ts +177 -177
- package/src/interface/kds.ts +49 -49
- package/src/interface/location.ts +771 -769
- package/src/interface/mealplan.ts +155 -154
- package/src/interface/menu.ts +4079 -4018
- package/src/interface/notification.ts +51 -51
- package/src/interface/order.ts +464 -464
- package/src/interface/partner.ts +823 -823
- package/src/interface/payment.ts +278 -278
- package/src/interface/promo.ts +373 -373
- package/src/interface/report.ts +348 -348
- package/src/interface/search.ts +135 -135
- package/src/interface/shoppingcart.ts +429 -429
- package/src/interface/task.ts +212 -212
- package/src/interface/tax.ts +69 -69
- package/src/interface/user.ts +410 -410
- package/src/interface/vendor.ts +215 -215
package/src/interface/config.ts
CHANGED
|
@@ -1,214 +1,214 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export type CreateConfig = Record<string, any>;
|
|
7
7
|
|
|
8
8
|
export interface Config {
|
|
9
|
-
|
|
9
|
+
[index: string]: any;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
export interface Error {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
13
|
+
error?: string;
|
|
14
|
+
code?: number;
|
|
15
|
+
data?: Record<string, any>;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
18
|
export interface Success {
|
|
19
|
-
|
|
19
|
+
success?: boolean;
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
export interface PublicBrandConfig {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
23
|
+
global_item_search?: string;
|
|
24
|
+
canadian_calorie_disclaimer?: string;
|
|
25
|
+
email_subscriptions?: string;
|
|
26
|
+
brand_location_description?: string;
|
|
27
|
+
description_label?: {
|
|
28
|
+
en?: string;
|
|
29
|
+
fr?: string;
|
|
30
|
+
};
|
|
31
|
+
description?: string;
|
|
32
|
+
delivery_destinations?: string[];
|
|
33
|
+
display_calories?: boolean;
|
|
34
|
+
pickup_asap?: {
|
|
35
|
+
enabled?: boolean;
|
|
36
|
+
};
|
|
37
|
+
show_instructions?: boolean;
|
|
38
|
+
has_kds?: boolean;
|
|
39
|
+
runner_app_enabled?: boolean;
|
|
40
|
+
show_single_timeslot?: boolean;
|
|
41
|
+
[index: string]: any;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
44
|
export interface PublicLocationConfig {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
45
|
+
mealplan?: PublicMealplanConfig[];
|
|
46
|
+
badge_pay?: {
|
|
47
|
+
id?: string;
|
|
48
|
+
type?: string;
|
|
49
|
+
webview?: string;
|
|
50
|
+
name?: string;
|
|
51
|
+
};
|
|
52
|
+
cashless?: {
|
|
53
|
+
id?: string;
|
|
54
|
+
type?: string;
|
|
55
|
+
webview?: string;
|
|
56
|
+
name?: string;
|
|
57
|
+
voucher_webview?: string;
|
|
58
|
+
tenders?: {
|
|
59
|
+
tender_type?: string;
|
|
60
|
+
name?: string;
|
|
61
|
+
tax_exempt?: string;
|
|
62
|
+
}[];
|
|
63
|
+
};
|
|
64
|
+
has_kds?: boolean;
|
|
65
|
+
runner_app_enabled?: boolean;
|
|
66
|
+
show_single_timeslot?: boolean;
|
|
67
|
+
is_checkin_enabled?: boolean;
|
|
68
68
|
}
|
|
69
69
|
|
|
70
70
|
export interface AppConfig {
|
|
71
|
-
|
|
72
|
-
|
|
71
|
+
min?: string;
|
|
72
|
+
url?: string;
|
|
73
73
|
}
|
|
74
74
|
|
|
75
75
|
export interface PrivateConfig {
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
76
|
+
payment?: {
|
|
77
|
+
refund?: boolean;
|
|
78
|
+
freedompay?: {
|
|
79
|
+
id?: string;
|
|
80
|
+
// backwards compatibility placeholder for mobile
|
|
81
|
+
freedompay_store_id?: string;
|
|
82
|
+
// backwards compatibility placeholder for mobile
|
|
83
|
+
freedompay_terminal_id?: string;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
loyalty?: {
|
|
87
|
+
provider_id?: string;
|
|
88
|
+
enabled?: boolean;
|
|
89
|
+
loyalty_emails?: {
|
|
90
|
+
email?: string;
|
|
91
|
+
}[];
|
|
92
|
+
};
|
|
93
|
+
mealplan?: PrivateMealplanConfig[];
|
|
94
|
+
keystore?: Keystore;
|
|
95
|
+
[index: string]: any;
|
|
96
96
|
}
|
|
97
97
|
|
|
98
98
|
export interface PublicMealplanConfig {
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
99
|
+
id?: string;
|
|
100
|
+
type?: string;
|
|
101
|
+
name?: string;
|
|
102
|
+
tenders?: Tender[];
|
|
103
|
+
valid_email_domains?: string[];
|
|
104
|
+
note?: string;
|
|
105
105
|
}
|
|
106
106
|
|
|
107
107
|
export interface PrivateMealplanConfig {
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
108
|
+
id?: string;
|
|
109
|
+
name?: string;
|
|
110
|
+
type?: string;
|
|
111
|
+
version?: number;
|
|
112
|
+
config?: {
|
|
113
|
+
tenders?: Tender[];
|
|
114
|
+
terminal_id?: string;
|
|
115
|
+
version?: string;
|
|
116
|
+
};
|
|
117
|
+
keystore?: {
|
|
118
|
+
API_URL?: string;
|
|
119
|
+
api_url?: string;
|
|
120
|
+
key?: string;
|
|
121
|
+
operator_id?: string;
|
|
122
|
+
operator_password?: string;
|
|
123
|
+
certificate?: {
|
|
124
|
+
name?: string;
|
|
125
|
+
encoded_file?: string;
|
|
126
|
+
password?: string;
|
|
127
|
+
};
|
|
128
|
+
device_id?: number;
|
|
129
|
+
endpoint?: string;
|
|
130
|
+
vendor_id?: string;
|
|
131
|
+
webview?: string;
|
|
132
|
+
aes_key?: string;
|
|
133
|
+
host?: string;
|
|
134
|
+
manual_id_entry?: string;
|
|
135
|
+
port?: number;
|
|
136
|
+
vendor_number?: number;
|
|
137
|
+
};
|
|
138
138
|
}
|
|
139
139
|
|
|
140
140
|
export interface Keystore {
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
141
|
+
mealplan?: CbordMealplanConfig;
|
|
142
|
+
payment?: {
|
|
143
|
+
freedompay?: {
|
|
144
|
+
id?: string;
|
|
145
|
+
freedompay_store_id?: string;
|
|
146
|
+
freedompay_terminal_id?: string;
|
|
147
|
+
};
|
|
148
|
+
};
|
|
149
149
|
}
|
|
150
150
|
|
|
151
151
|
export interface CbordMealplanConfig {
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
152
|
+
auth_type?: number;
|
|
153
|
+
auth_url?: string;
|
|
154
|
+
name?: string;
|
|
155
|
+
type?: string;
|
|
156
|
+
uuid?: string;
|
|
157
|
+
short_name?: string;
|
|
158
|
+
primary_color?: string;
|
|
159
|
+
[index: string]: any;
|
|
160
160
|
}
|
|
161
161
|
|
|
162
162
|
export interface Tender {
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
163
|
+
max_swipes_per_transaction?: number;
|
|
164
|
+
name?: string;
|
|
165
|
+
rates?: {
|
|
166
|
+
amount?: number;
|
|
167
|
+
hours?: string;
|
|
168
|
+
}[];
|
|
169
|
+
tender_number?: string;
|
|
170
|
+
type?: string;
|
|
171
|
+
id?: string;
|
|
172
|
+
tax_exempt?: boolean;
|
|
173
173
|
}
|
|
174
174
|
|
|
175
175
|
// GET /config/appconfig - get appconfig - an object with data for clients including minimum versions apps (boost, thrive, J&J) should be running and a link to the respective app store
|
|
176
176
|
|
|
177
177
|
export interface GetConfigAppconfigQuery {
|
|
178
|
-
|
|
179
|
-
|
|
178
|
+
// Graphql query string
|
|
179
|
+
_query?: string;
|
|
180
180
|
}
|
|
181
181
|
|
|
182
182
|
export type GetConfigAppconfigResponse = AppConfig;
|
|
183
183
|
|
|
184
184
|
export interface GetConfigAppconfigRequest
|
|
185
|
-
|
|
186
|
-
|
|
185
|
+
extends BaseRequest,
|
|
186
|
+
RequestQuery<GetConfigAppconfigQuery> {}
|
|
187
187
|
|
|
188
188
|
// GET /config/{key} - get a configuration
|
|
189
189
|
|
|
190
190
|
export interface GetConfigPath {
|
|
191
|
-
|
|
192
|
-
|
|
191
|
+
// configuration key
|
|
192
|
+
key: string;
|
|
193
193
|
}
|
|
194
194
|
|
|
195
195
|
export interface GetConfigQuery {
|
|
196
|
-
|
|
197
|
-
|
|
196
|
+
// Graphql query string
|
|
197
|
+
_query?: string;
|
|
198
198
|
}
|
|
199
199
|
|
|
200
200
|
export type GetConfigResponse = Config;
|
|
201
201
|
|
|
202
202
|
export interface GetConfigRequest
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
203
|
+
extends BaseRequest,
|
|
204
|
+
RequestQuery<GetConfigQuery>,
|
|
205
|
+
GetConfigPath {}
|
|
206
206
|
|
|
207
207
|
// POST /config/{key} - Create a configuration
|
|
208
208
|
|
|
209
209
|
export interface PostConfigPath {
|
|
210
|
-
|
|
211
|
-
|
|
210
|
+
// configuration key
|
|
211
|
+
key: string;
|
|
212
212
|
}
|
|
213
213
|
|
|
214
214
|
export type PostConfigBody = CreateConfig;
|
|
@@ -216,14 +216,14 @@ export type PostConfigBody = CreateConfig;
|
|
|
216
216
|
export type PostConfigResponse = Config;
|
|
217
217
|
|
|
218
218
|
export interface PostConfigRequest extends BaseRequest, PostConfigPath {
|
|
219
|
-
|
|
219
|
+
body: PostConfigBody;
|
|
220
220
|
}
|
|
221
221
|
|
|
222
222
|
// PUT /config/{key} - Update a configuration
|
|
223
223
|
|
|
224
224
|
export interface PutConfigPath {
|
|
225
|
-
|
|
226
|
-
|
|
225
|
+
// configuration key
|
|
226
|
+
key: string;
|
|
227
227
|
}
|
|
228
228
|
|
|
229
229
|
export type PutConfigBody = CreateConfig;
|
|
@@ -231,14 +231,14 @@ export type PutConfigBody = CreateConfig;
|
|
|
231
231
|
export type PutConfigResponse = Config;
|
|
232
232
|
|
|
233
233
|
export interface PutConfigRequest extends BaseRequest, PutConfigPath {
|
|
234
|
-
|
|
234
|
+
body: PutConfigBody;
|
|
235
235
|
}
|
|
236
236
|
|
|
237
237
|
// DELETE /config/{key} - Delete a configuration
|
|
238
238
|
|
|
239
239
|
export interface DeleteConfigPath {
|
|
240
|
-
|
|
241
|
-
|
|
240
|
+
// configuration key
|
|
241
|
+
key: string;
|
|
242
242
|
}
|
|
243
243
|
|
|
244
244
|
export type DeleteConfigResponse = Success;
|
|
@@ -248,27 +248,27 @@ export interface DeleteConfigRequest extends BaseRequest, DeleteConfigPath {}
|
|
|
248
248
|
// GET /config/public/{key} - get a public configuration
|
|
249
249
|
|
|
250
250
|
export interface GetConfigPublicPath {
|
|
251
|
-
|
|
252
|
-
|
|
251
|
+
// configuration key
|
|
252
|
+
key: string;
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
export interface GetConfigPublicQuery {
|
|
256
|
-
|
|
257
|
-
|
|
256
|
+
// Graphql query string
|
|
257
|
+
_query?: string;
|
|
258
258
|
}
|
|
259
259
|
|
|
260
260
|
export type GetConfigPublicResponse = Config;
|
|
261
261
|
|
|
262
262
|
export interface GetConfigPublicRequest
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
263
|
+
extends BaseRequest,
|
|
264
|
+
RequestQuery<GetConfigPublicQuery>,
|
|
265
|
+
GetConfigPublicPath {}
|
|
266
266
|
|
|
267
267
|
// POST /config/public/{key} - Create a public configuration
|
|
268
268
|
|
|
269
269
|
export interface PostConfigPublicPath {
|
|
270
|
-
|
|
271
|
-
|
|
270
|
+
// configuration key
|
|
271
|
+
key: string;
|
|
272
272
|
}
|
|
273
273
|
|
|
274
274
|
export type PostConfigPublicBody = CreateConfig;
|
|
@@ -276,14 +276,14 @@ export type PostConfigPublicBody = CreateConfig;
|
|
|
276
276
|
export type PostConfigPublicResponse = Config;
|
|
277
277
|
|
|
278
278
|
export interface PostConfigPublicRequest extends BaseRequest, PostConfigPublicPath {
|
|
279
|
-
|
|
279
|
+
body: PostConfigPublicBody;
|
|
280
280
|
}
|
|
281
281
|
|
|
282
282
|
// PUT /config/public/{key} - Update a public configuration
|
|
283
283
|
|
|
284
284
|
export interface PutConfigPublicPath {
|
|
285
|
-
|
|
286
|
-
|
|
285
|
+
// configuration key
|
|
286
|
+
key: string;
|
|
287
287
|
}
|
|
288
288
|
|
|
289
289
|
export type PutConfigPublicBody = CreateConfig;
|
|
@@ -291,14 +291,14 @@ export type PutConfigPublicBody = CreateConfig;
|
|
|
291
291
|
export type PutConfigPublicResponse = Config;
|
|
292
292
|
|
|
293
293
|
export interface PutConfigPublicRequest extends BaseRequest, PutConfigPublicPath {
|
|
294
|
-
|
|
294
|
+
body: PutConfigPublicBody;
|
|
295
295
|
}
|
|
296
296
|
|
|
297
297
|
// DELETE /config/public/{key} - Delete a public configuration
|
|
298
298
|
|
|
299
299
|
export interface DeleteConfigPublicPath {
|
|
300
|
-
|
|
301
|
-
|
|
300
|
+
// configuration key
|
|
301
|
+
key: string;
|
|
302
302
|
}
|
|
303
303
|
|
|
304
304
|
export type DeleteConfigPublicResponse = Success;
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface Error {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
error?: string;
|
|
8
|
+
code?: number;
|
|
9
|
+
data?: Record<string, any>;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
export interface QueryBody {
|
|
13
|
-
|
|
13
|
+
query?: string;
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
// POST /datalake/sql - Query datalake for data
|
|
@@ -18,24 +18,24 @@ export interface QueryBody {
|
|
|
18
18
|
export type PostDatalakeSqlBody = QueryBody;
|
|
19
19
|
|
|
20
20
|
export interface PostDatalakeSqlResponse {
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
rows?: {
|
|
22
|
+
[index: string]: any;
|
|
23
|
+
}[];
|
|
24
24
|
}
|
|
25
25
|
|
|
26
26
|
export interface PostDatalakeSqlRequest extends BaseRequest {
|
|
27
|
-
|
|
27
|
+
body: PostDatalakeSqlBody;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
// GET /swagger.json
|
|
31
31
|
|
|
32
32
|
export interface GetDatalakeSwaggerQuery {
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
// Graphql query string
|
|
34
|
+
_query?: string;
|
|
35
35
|
}
|
|
36
36
|
|
|
37
37
|
export type GetDatalakeSwaggerResponse = Record<string, any>;
|
|
38
38
|
|
|
39
39
|
export interface GetDatalakeSwaggerRequest
|
|
40
|
-
|
|
41
|
-
|
|
40
|
+
extends BaseRequest,
|
|
41
|
+
RequestQuery<GetDatalakeSwaggerQuery> {}
|
package/src/interface/email.ts
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface Error {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
message?: string;
|
|
8
|
+
code?: number;
|
|
9
|
+
data?: Record<string, any>;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
export interface Success {
|
|
13
|
-
|
|
13
|
+
success?: boolean;
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
export interface EmailPayload {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
17
|
+
from: string;
|
|
18
|
+
to: string;
|
|
19
|
+
subject?: string;
|
|
20
|
+
// Text of an email instead of template_id/data
|
|
21
|
+
text?: string;
|
|
22
|
+
template_id?: string;
|
|
23
|
+
data?: Record<string, any>;
|
|
24
24
|
}
|
|
25
25
|
|
|
26
26
|
// POST /email - Send an email
|
|
@@ -30,5 +30,5 @@ export type PostEmailBody = EmailPayload;
|
|
|
30
30
|
export type PostEmailResponse = Success;
|
|
31
31
|
|
|
32
32
|
export interface PostEmailRequest extends BaseRequest {
|
|
33
|
-
|
|
33
|
+
body: PostEmailBody;
|
|
34
34
|
}
|
package/src/interface/file.ts
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
1
|
/* eslint-disable */
|
|
2
2
|
// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
|
|
3
3
|
|
|
4
|
-
import { RequestQuery, BaseRequest } from
|
|
4
|
+
import { RequestQuery, BaseRequest } from './util';
|
|
5
5
|
|
|
6
6
|
export interface Error {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
message?: string;
|
|
8
|
+
code?: number;
|
|
9
|
+
data?: Record<string, any>;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
12
|
export interface File {
|
|
13
|
-
|
|
13
|
+
url?: string;
|
|
14
14
|
}
|
|
15
15
|
|
|
16
16
|
// POST /file - Upload a file to CDL S3
|
|
17
17
|
|
|
18
18
|
export interface PostFileBody {
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
19
|
+
// base64 encoded string of a file
|
|
20
|
+
file_base64: string;
|
|
21
|
+
// If not specified, random name+timestamp will be generated, otherwise filename+timestamp format is used
|
|
22
|
+
file_name?: string;
|
|
23
|
+
// Set custom bucket to save in. Defaults to images.compassdigital.org
|
|
24
|
+
bucket_name?: 'images.compassdigital.org' | 'assets.compassdigital.org';
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
export type PostFileResponse = File;
|
|
28
28
|
|
|
29
29
|
export interface PostFileRequest extends BaseRequest {
|
|
30
|
-
|
|
30
|
+
body: PostFileBody;
|
|
31
31
|
}
|
|
32
32
|
|
|
33
33
|
// DELETE /file - Delete a file from CDL S3
|
|
34
34
|
|
|
35
35
|
export interface DeleteFileBody {
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
36
|
+
// Specify the bucket name
|
|
37
|
+
bucket_name: string;
|
|
38
|
+
// Specify the full S3 file path
|
|
39
|
+
file_path: string;
|
|
40
40
|
}
|
|
41
41
|
|
|
42
42
|
export interface DeleteFileResponse {
|
|
43
|
-
|
|
43
|
+
success?: boolean;
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
export interface DeleteFileRequest extends BaseRequest {
|
|
47
|
-
|
|
47
|
+
body: DeleteFileBody;
|
|
48
48
|
}
|