@convert-buddy/cloud-client 0.1.0-beta.1
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/LICENSE +64 -0
- package/NOTICE +33 -0
- package/README.md +13 -0
- package/dist/chunk-DIBGYTC7.js +372 -0
- package/dist/index.d.ts +1471 -0
- package/dist/index.js +158 -0
- package/dist/processing-DFE8ktWi.d.ts +3204 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.js +21 -0
- package/package.json +53 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,1471 @@
|
|
|
1
|
+
import { P as ProcessingClient, R as ReplayableFile } from './processing-DFE8ktWi.js';
|
|
2
|
+
export { a as ProcessingCloudError, b as ProcessingGrant, c as ProcessingJob, d as ProcessingOperation, e as ProcessingRequest, f as ProcessingSession, g as ProcessingTransport, h as ProcessingUpload, i as blobFile, j as createBrowserProcessingClient, k as createWidgetProcessingClient } from './processing-DFE8ktWi.js';
|
|
3
|
+
import { SourceFormatV1, JsonValue } from '@convert-buddy/importer-contracts';
|
|
4
|
+
|
|
5
|
+
interface operations {
|
|
6
|
+
getWidgetConfig: {
|
|
7
|
+
parameters: {
|
|
8
|
+
query?: never;
|
|
9
|
+
header?: never;
|
|
10
|
+
path?: never;
|
|
11
|
+
cookie?: never;
|
|
12
|
+
};
|
|
13
|
+
requestBody?: never;
|
|
14
|
+
responses: {
|
|
15
|
+
/** @description Success */
|
|
16
|
+
200: {
|
|
17
|
+
headers: {
|
|
18
|
+
[name: string]: unknown;
|
|
19
|
+
};
|
|
20
|
+
content: {
|
|
21
|
+
"application/json": {
|
|
22
|
+
/** Format: uuid */
|
|
23
|
+
sessionId: string;
|
|
24
|
+
/** Format: uuid */
|
|
25
|
+
importerId: string;
|
|
26
|
+
/** Format: uuid */
|
|
27
|
+
versionId: string;
|
|
28
|
+
config: {
|
|
29
|
+
schema: {
|
|
30
|
+
/** @enum {number} */
|
|
31
|
+
version: 1;
|
|
32
|
+
id: string;
|
|
33
|
+
name: string;
|
|
34
|
+
fields: {
|
|
35
|
+
key: string;
|
|
36
|
+
label: string;
|
|
37
|
+
/** @enum {string} */
|
|
38
|
+
type: "string" | "integer" | "number" | "boolean" | "date" | "datetime" | "enum";
|
|
39
|
+
required?: boolean;
|
|
40
|
+
aliases?: string[];
|
|
41
|
+
description?: string;
|
|
42
|
+
constraints?: {
|
|
43
|
+
min?: number;
|
|
44
|
+
max?: number;
|
|
45
|
+
minLength?: number;
|
|
46
|
+
maxLength?: number;
|
|
47
|
+
values?: string[];
|
|
48
|
+
};
|
|
49
|
+
}[];
|
|
50
|
+
/** @enum {string} */
|
|
51
|
+
unknownFields: "ignore" | "reject" | "preserve";
|
|
52
|
+
};
|
|
53
|
+
experience: {
|
|
54
|
+
title: string;
|
|
55
|
+
description: string;
|
|
56
|
+
allowMappingRevision: boolean;
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
limits: {
|
|
60
|
+
maximumBatchBytes: number;
|
|
61
|
+
maximumBatchRecords: number;
|
|
62
|
+
maximumSessionBytes: number;
|
|
63
|
+
maximumSessionRecords: number;
|
|
64
|
+
};
|
|
65
|
+
};
|
|
66
|
+
};
|
|
67
|
+
};
|
|
68
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
69
|
+
400: {
|
|
70
|
+
headers: {
|
|
71
|
+
[name: string]: unknown;
|
|
72
|
+
};
|
|
73
|
+
content: {
|
|
74
|
+
"application/json": {
|
|
75
|
+
error: {
|
|
76
|
+
code: string;
|
|
77
|
+
message: string;
|
|
78
|
+
};
|
|
79
|
+
requestId: string;
|
|
80
|
+
};
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
84
|
+
401: {
|
|
85
|
+
headers: {
|
|
86
|
+
[name: string]: unknown;
|
|
87
|
+
};
|
|
88
|
+
content: {
|
|
89
|
+
"application/json": {
|
|
90
|
+
error: {
|
|
91
|
+
code: string;
|
|
92
|
+
message: string;
|
|
93
|
+
};
|
|
94
|
+
requestId: string;
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
99
|
+
403: {
|
|
100
|
+
headers: {
|
|
101
|
+
[name: string]: unknown;
|
|
102
|
+
};
|
|
103
|
+
content: {
|
|
104
|
+
"application/json": {
|
|
105
|
+
error: {
|
|
106
|
+
code: string;
|
|
107
|
+
message: string;
|
|
108
|
+
};
|
|
109
|
+
requestId: string;
|
|
110
|
+
};
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
114
|
+
404: {
|
|
115
|
+
headers: {
|
|
116
|
+
[name: string]: unknown;
|
|
117
|
+
};
|
|
118
|
+
content: {
|
|
119
|
+
"application/json": {
|
|
120
|
+
error: {
|
|
121
|
+
code: string;
|
|
122
|
+
message: string;
|
|
123
|
+
};
|
|
124
|
+
requestId: string;
|
|
125
|
+
};
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
129
|
+
409: {
|
|
130
|
+
headers: {
|
|
131
|
+
[name: string]: unknown;
|
|
132
|
+
};
|
|
133
|
+
content: {
|
|
134
|
+
"application/json": {
|
|
135
|
+
error: {
|
|
136
|
+
code: string;
|
|
137
|
+
message: string;
|
|
138
|
+
};
|
|
139
|
+
requestId: string;
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
};
|
|
143
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
144
|
+
410: {
|
|
145
|
+
headers: {
|
|
146
|
+
[name: string]: unknown;
|
|
147
|
+
};
|
|
148
|
+
content: {
|
|
149
|
+
"application/json": {
|
|
150
|
+
error: {
|
|
151
|
+
code: string;
|
|
152
|
+
message: string;
|
|
153
|
+
};
|
|
154
|
+
requestId: string;
|
|
155
|
+
};
|
|
156
|
+
};
|
|
157
|
+
};
|
|
158
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
159
|
+
413: {
|
|
160
|
+
headers: {
|
|
161
|
+
[name: string]: unknown;
|
|
162
|
+
};
|
|
163
|
+
content: {
|
|
164
|
+
"application/json": {
|
|
165
|
+
error: {
|
|
166
|
+
code: string;
|
|
167
|
+
message: string;
|
|
168
|
+
};
|
|
169
|
+
requestId: string;
|
|
170
|
+
};
|
|
171
|
+
};
|
|
172
|
+
};
|
|
173
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
174
|
+
415: {
|
|
175
|
+
headers: {
|
|
176
|
+
[name: string]: unknown;
|
|
177
|
+
};
|
|
178
|
+
content: {
|
|
179
|
+
"application/json": {
|
|
180
|
+
error: {
|
|
181
|
+
code: string;
|
|
182
|
+
message: string;
|
|
183
|
+
};
|
|
184
|
+
requestId: string;
|
|
185
|
+
};
|
|
186
|
+
};
|
|
187
|
+
};
|
|
188
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
189
|
+
422: {
|
|
190
|
+
headers: {
|
|
191
|
+
[name: string]: unknown;
|
|
192
|
+
};
|
|
193
|
+
content: {
|
|
194
|
+
"application/json": {
|
|
195
|
+
error: {
|
|
196
|
+
code: string;
|
|
197
|
+
message: string;
|
|
198
|
+
};
|
|
199
|
+
requestId: string;
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
};
|
|
203
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
204
|
+
429: {
|
|
205
|
+
headers: {
|
|
206
|
+
[name: string]: unknown;
|
|
207
|
+
};
|
|
208
|
+
content: {
|
|
209
|
+
"application/json": {
|
|
210
|
+
error: {
|
|
211
|
+
code: string;
|
|
212
|
+
message: string;
|
|
213
|
+
};
|
|
214
|
+
requestId: string;
|
|
215
|
+
};
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
219
|
+
500: {
|
|
220
|
+
headers: {
|
|
221
|
+
[name: string]: unknown;
|
|
222
|
+
};
|
|
223
|
+
content: {
|
|
224
|
+
"application/json": {
|
|
225
|
+
error: {
|
|
226
|
+
code: string;
|
|
227
|
+
message: string;
|
|
228
|
+
};
|
|
229
|
+
requestId: string;
|
|
230
|
+
};
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
234
|
+
502: {
|
|
235
|
+
headers: {
|
|
236
|
+
[name: string]: unknown;
|
|
237
|
+
};
|
|
238
|
+
content: {
|
|
239
|
+
"application/json": {
|
|
240
|
+
error: {
|
|
241
|
+
code: string;
|
|
242
|
+
message: string;
|
|
243
|
+
};
|
|
244
|
+
requestId: string;
|
|
245
|
+
};
|
|
246
|
+
};
|
|
247
|
+
};
|
|
248
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
249
|
+
503: {
|
|
250
|
+
headers: {
|
|
251
|
+
[name: string]: unknown;
|
|
252
|
+
};
|
|
253
|
+
content: {
|
|
254
|
+
"application/json": {
|
|
255
|
+
error: {
|
|
256
|
+
code: string;
|
|
257
|
+
message: string;
|
|
258
|
+
};
|
|
259
|
+
requestId: string;
|
|
260
|
+
};
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
};
|
|
264
|
+
};
|
|
265
|
+
createWidgetImport: {
|
|
266
|
+
parameters: {
|
|
267
|
+
query?: never;
|
|
268
|
+
header?: never;
|
|
269
|
+
path?: never;
|
|
270
|
+
cookie?: never;
|
|
271
|
+
};
|
|
272
|
+
requestBody: {
|
|
273
|
+
content: {
|
|
274
|
+
"application/json": {
|
|
275
|
+
/** Format: uuid */
|
|
276
|
+
clientKey: string;
|
|
277
|
+
/** @enum {string} */
|
|
278
|
+
format: "csv" | "json" | "ndjson" | "xml" | "xlsx";
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
};
|
|
282
|
+
responses: {
|
|
283
|
+
/** @description Success */
|
|
284
|
+
200: {
|
|
285
|
+
headers: {
|
|
286
|
+
[name: string]: unknown;
|
|
287
|
+
};
|
|
288
|
+
content: {
|
|
289
|
+
"application/json": {
|
|
290
|
+
/** Format: uuid */
|
|
291
|
+
importId: string;
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
296
|
+
400: {
|
|
297
|
+
headers: {
|
|
298
|
+
[name: string]: unknown;
|
|
299
|
+
};
|
|
300
|
+
content: {
|
|
301
|
+
"application/json": {
|
|
302
|
+
error: {
|
|
303
|
+
code: string;
|
|
304
|
+
message: string;
|
|
305
|
+
};
|
|
306
|
+
requestId: string;
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
311
|
+
401: {
|
|
312
|
+
headers: {
|
|
313
|
+
[name: string]: unknown;
|
|
314
|
+
};
|
|
315
|
+
content: {
|
|
316
|
+
"application/json": {
|
|
317
|
+
error: {
|
|
318
|
+
code: string;
|
|
319
|
+
message: string;
|
|
320
|
+
};
|
|
321
|
+
requestId: string;
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
326
|
+
403: {
|
|
327
|
+
headers: {
|
|
328
|
+
[name: string]: unknown;
|
|
329
|
+
};
|
|
330
|
+
content: {
|
|
331
|
+
"application/json": {
|
|
332
|
+
error: {
|
|
333
|
+
code: string;
|
|
334
|
+
message: string;
|
|
335
|
+
};
|
|
336
|
+
requestId: string;
|
|
337
|
+
};
|
|
338
|
+
};
|
|
339
|
+
};
|
|
340
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
341
|
+
404: {
|
|
342
|
+
headers: {
|
|
343
|
+
[name: string]: unknown;
|
|
344
|
+
};
|
|
345
|
+
content: {
|
|
346
|
+
"application/json": {
|
|
347
|
+
error: {
|
|
348
|
+
code: string;
|
|
349
|
+
message: string;
|
|
350
|
+
};
|
|
351
|
+
requestId: string;
|
|
352
|
+
};
|
|
353
|
+
};
|
|
354
|
+
};
|
|
355
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
356
|
+
409: {
|
|
357
|
+
headers: {
|
|
358
|
+
[name: string]: unknown;
|
|
359
|
+
};
|
|
360
|
+
content: {
|
|
361
|
+
"application/json": {
|
|
362
|
+
error: {
|
|
363
|
+
code: string;
|
|
364
|
+
message: string;
|
|
365
|
+
};
|
|
366
|
+
requestId: string;
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
};
|
|
370
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
371
|
+
410: {
|
|
372
|
+
headers: {
|
|
373
|
+
[name: string]: unknown;
|
|
374
|
+
};
|
|
375
|
+
content: {
|
|
376
|
+
"application/json": {
|
|
377
|
+
error: {
|
|
378
|
+
code: string;
|
|
379
|
+
message: string;
|
|
380
|
+
};
|
|
381
|
+
requestId: string;
|
|
382
|
+
};
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
386
|
+
413: {
|
|
387
|
+
headers: {
|
|
388
|
+
[name: string]: unknown;
|
|
389
|
+
};
|
|
390
|
+
content: {
|
|
391
|
+
"application/json": {
|
|
392
|
+
error: {
|
|
393
|
+
code: string;
|
|
394
|
+
message: string;
|
|
395
|
+
};
|
|
396
|
+
requestId: string;
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
};
|
|
400
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
401
|
+
415: {
|
|
402
|
+
headers: {
|
|
403
|
+
[name: string]: unknown;
|
|
404
|
+
};
|
|
405
|
+
content: {
|
|
406
|
+
"application/json": {
|
|
407
|
+
error: {
|
|
408
|
+
code: string;
|
|
409
|
+
message: string;
|
|
410
|
+
};
|
|
411
|
+
requestId: string;
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
};
|
|
415
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
416
|
+
422: {
|
|
417
|
+
headers: {
|
|
418
|
+
[name: string]: unknown;
|
|
419
|
+
};
|
|
420
|
+
content: {
|
|
421
|
+
"application/json": {
|
|
422
|
+
error: {
|
|
423
|
+
code: string;
|
|
424
|
+
message: string;
|
|
425
|
+
};
|
|
426
|
+
requestId: string;
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
431
|
+
429: {
|
|
432
|
+
headers: {
|
|
433
|
+
[name: string]: unknown;
|
|
434
|
+
};
|
|
435
|
+
content: {
|
|
436
|
+
"application/json": {
|
|
437
|
+
error: {
|
|
438
|
+
code: string;
|
|
439
|
+
message: string;
|
|
440
|
+
};
|
|
441
|
+
requestId: string;
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
};
|
|
445
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
446
|
+
500: {
|
|
447
|
+
headers: {
|
|
448
|
+
[name: string]: unknown;
|
|
449
|
+
};
|
|
450
|
+
content: {
|
|
451
|
+
"application/json": {
|
|
452
|
+
error: {
|
|
453
|
+
code: string;
|
|
454
|
+
message: string;
|
|
455
|
+
};
|
|
456
|
+
requestId: string;
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
};
|
|
460
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
461
|
+
502: {
|
|
462
|
+
headers: {
|
|
463
|
+
[name: string]: unknown;
|
|
464
|
+
};
|
|
465
|
+
content: {
|
|
466
|
+
"application/json": {
|
|
467
|
+
error: {
|
|
468
|
+
code: string;
|
|
469
|
+
message: string;
|
|
470
|
+
};
|
|
471
|
+
requestId: string;
|
|
472
|
+
};
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
476
|
+
503: {
|
|
477
|
+
headers: {
|
|
478
|
+
[name: string]: unknown;
|
|
479
|
+
};
|
|
480
|
+
content: {
|
|
481
|
+
"application/json": {
|
|
482
|
+
error: {
|
|
483
|
+
code: string;
|
|
484
|
+
message: string;
|
|
485
|
+
};
|
|
486
|
+
requestId: string;
|
|
487
|
+
};
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
};
|
|
492
|
+
getWidgetImport: {
|
|
493
|
+
parameters: {
|
|
494
|
+
query?: never;
|
|
495
|
+
header?: never;
|
|
496
|
+
path: {
|
|
497
|
+
importId: string;
|
|
498
|
+
};
|
|
499
|
+
cookie?: never;
|
|
500
|
+
};
|
|
501
|
+
requestBody?: never;
|
|
502
|
+
responses: {
|
|
503
|
+
/** @description Success */
|
|
504
|
+
200: {
|
|
505
|
+
headers: {
|
|
506
|
+
[name: string]: unknown;
|
|
507
|
+
};
|
|
508
|
+
content: {
|
|
509
|
+
"application/json": {
|
|
510
|
+
/** Format: uuid */
|
|
511
|
+
id: string;
|
|
512
|
+
/** Format: uuid */
|
|
513
|
+
importer_id: string;
|
|
514
|
+
/** Format: uuid */
|
|
515
|
+
environment_id: string;
|
|
516
|
+
/** Format: uuid */
|
|
517
|
+
version_id: string;
|
|
518
|
+
/** @enum {string} */
|
|
519
|
+
status: "created" | "running" | "completed" | "cancelled";
|
|
520
|
+
format: string;
|
|
521
|
+
bytes: number;
|
|
522
|
+
records_delivered: number;
|
|
523
|
+
records_rejected: number;
|
|
524
|
+
records_deduplicated: number;
|
|
525
|
+
created_at: string;
|
|
526
|
+
completed_at: string | null;
|
|
527
|
+
};
|
|
528
|
+
};
|
|
529
|
+
};
|
|
530
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
531
|
+
400: {
|
|
532
|
+
headers: {
|
|
533
|
+
[name: string]: unknown;
|
|
534
|
+
};
|
|
535
|
+
content: {
|
|
536
|
+
"application/json": {
|
|
537
|
+
error: {
|
|
538
|
+
code: string;
|
|
539
|
+
message: string;
|
|
540
|
+
};
|
|
541
|
+
requestId: string;
|
|
542
|
+
};
|
|
543
|
+
};
|
|
544
|
+
};
|
|
545
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
546
|
+
401: {
|
|
547
|
+
headers: {
|
|
548
|
+
[name: string]: unknown;
|
|
549
|
+
};
|
|
550
|
+
content: {
|
|
551
|
+
"application/json": {
|
|
552
|
+
error: {
|
|
553
|
+
code: string;
|
|
554
|
+
message: string;
|
|
555
|
+
};
|
|
556
|
+
requestId: string;
|
|
557
|
+
};
|
|
558
|
+
};
|
|
559
|
+
};
|
|
560
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
561
|
+
403: {
|
|
562
|
+
headers: {
|
|
563
|
+
[name: string]: unknown;
|
|
564
|
+
};
|
|
565
|
+
content: {
|
|
566
|
+
"application/json": {
|
|
567
|
+
error: {
|
|
568
|
+
code: string;
|
|
569
|
+
message: string;
|
|
570
|
+
};
|
|
571
|
+
requestId: string;
|
|
572
|
+
};
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
576
|
+
404: {
|
|
577
|
+
headers: {
|
|
578
|
+
[name: string]: unknown;
|
|
579
|
+
};
|
|
580
|
+
content: {
|
|
581
|
+
"application/json": {
|
|
582
|
+
error: {
|
|
583
|
+
code: string;
|
|
584
|
+
message: string;
|
|
585
|
+
};
|
|
586
|
+
requestId: string;
|
|
587
|
+
};
|
|
588
|
+
};
|
|
589
|
+
};
|
|
590
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
591
|
+
409: {
|
|
592
|
+
headers: {
|
|
593
|
+
[name: string]: unknown;
|
|
594
|
+
};
|
|
595
|
+
content: {
|
|
596
|
+
"application/json": {
|
|
597
|
+
error: {
|
|
598
|
+
code: string;
|
|
599
|
+
message: string;
|
|
600
|
+
};
|
|
601
|
+
requestId: string;
|
|
602
|
+
};
|
|
603
|
+
};
|
|
604
|
+
};
|
|
605
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
606
|
+
410: {
|
|
607
|
+
headers: {
|
|
608
|
+
[name: string]: unknown;
|
|
609
|
+
};
|
|
610
|
+
content: {
|
|
611
|
+
"application/json": {
|
|
612
|
+
error: {
|
|
613
|
+
code: string;
|
|
614
|
+
message: string;
|
|
615
|
+
};
|
|
616
|
+
requestId: string;
|
|
617
|
+
};
|
|
618
|
+
};
|
|
619
|
+
};
|
|
620
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
621
|
+
413: {
|
|
622
|
+
headers: {
|
|
623
|
+
[name: string]: unknown;
|
|
624
|
+
};
|
|
625
|
+
content: {
|
|
626
|
+
"application/json": {
|
|
627
|
+
error: {
|
|
628
|
+
code: string;
|
|
629
|
+
message: string;
|
|
630
|
+
};
|
|
631
|
+
requestId: string;
|
|
632
|
+
};
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
636
|
+
415: {
|
|
637
|
+
headers: {
|
|
638
|
+
[name: string]: unknown;
|
|
639
|
+
};
|
|
640
|
+
content: {
|
|
641
|
+
"application/json": {
|
|
642
|
+
error: {
|
|
643
|
+
code: string;
|
|
644
|
+
message: string;
|
|
645
|
+
};
|
|
646
|
+
requestId: string;
|
|
647
|
+
};
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
651
|
+
422: {
|
|
652
|
+
headers: {
|
|
653
|
+
[name: string]: unknown;
|
|
654
|
+
};
|
|
655
|
+
content: {
|
|
656
|
+
"application/json": {
|
|
657
|
+
error: {
|
|
658
|
+
code: string;
|
|
659
|
+
message: string;
|
|
660
|
+
};
|
|
661
|
+
requestId: string;
|
|
662
|
+
};
|
|
663
|
+
};
|
|
664
|
+
};
|
|
665
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
666
|
+
429: {
|
|
667
|
+
headers: {
|
|
668
|
+
[name: string]: unknown;
|
|
669
|
+
};
|
|
670
|
+
content: {
|
|
671
|
+
"application/json": {
|
|
672
|
+
error: {
|
|
673
|
+
code: string;
|
|
674
|
+
message: string;
|
|
675
|
+
};
|
|
676
|
+
requestId: string;
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
};
|
|
680
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
681
|
+
500: {
|
|
682
|
+
headers: {
|
|
683
|
+
[name: string]: unknown;
|
|
684
|
+
};
|
|
685
|
+
content: {
|
|
686
|
+
"application/json": {
|
|
687
|
+
error: {
|
|
688
|
+
code: string;
|
|
689
|
+
message: string;
|
|
690
|
+
};
|
|
691
|
+
requestId: string;
|
|
692
|
+
};
|
|
693
|
+
};
|
|
694
|
+
};
|
|
695
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
696
|
+
502: {
|
|
697
|
+
headers: {
|
|
698
|
+
[name: string]: unknown;
|
|
699
|
+
};
|
|
700
|
+
content: {
|
|
701
|
+
"application/json": {
|
|
702
|
+
error: {
|
|
703
|
+
code: string;
|
|
704
|
+
message: string;
|
|
705
|
+
};
|
|
706
|
+
requestId: string;
|
|
707
|
+
};
|
|
708
|
+
};
|
|
709
|
+
};
|
|
710
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
711
|
+
503: {
|
|
712
|
+
headers: {
|
|
713
|
+
[name: string]: unknown;
|
|
714
|
+
};
|
|
715
|
+
content: {
|
|
716
|
+
"application/json": {
|
|
717
|
+
error: {
|
|
718
|
+
code: string;
|
|
719
|
+
message: string;
|
|
720
|
+
};
|
|
721
|
+
requestId: string;
|
|
722
|
+
};
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
};
|
|
726
|
+
};
|
|
727
|
+
deliverWidgetBatch: {
|
|
728
|
+
parameters: {
|
|
729
|
+
query?: never;
|
|
730
|
+
header?: never;
|
|
731
|
+
path: {
|
|
732
|
+
importId: string;
|
|
733
|
+
};
|
|
734
|
+
cookie?: never;
|
|
735
|
+
};
|
|
736
|
+
requestBody: {
|
|
737
|
+
content: {
|
|
738
|
+
"application/json": {
|
|
739
|
+
batchId: string;
|
|
740
|
+
records: {
|
|
741
|
+
[key: string]: unknown;
|
|
742
|
+
}[];
|
|
743
|
+
};
|
|
744
|
+
};
|
|
745
|
+
};
|
|
746
|
+
responses: {
|
|
747
|
+
/** @description Success */
|
|
748
|
+
200: {
|
|
749
|
+
headers: {
|
|
750
|
+
[name: string]: unknown;
|
|
751
|
+
};
|
|
752
|
+
content: {
|
|
753
|
+
"application/json": {
|
|
754
|
+
batchId: string;
|
|
755
|
+
recordCount: number;
|
|
756
|
+
/** @enum {string} */
|
|
757
|
+
status: "delivered" | "duplicate";
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
762
|
+
400: {
|
|
763
|
+
headers: {
|
|
764
|
+
[name: string]: unknown;
|
|
765
|
+
};
|
|
766
|
+
content: {
|
|
767
|
+
"application/json": {
|
|
768
|
+
error: {
|
|
769
|
+
code: string;
|
|
770
|
+
message: string;
|
|
771
|
+
};
|
|
772
|
+
requestId: string;
|
|
773
|
+
};
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
777
|
+
401: {
|
|
778
|
+
headers: {
|
|
779
|
+
[name: string]: unknown;
|
|
780
|
+
};
|
|
781
|
+
content: {
|
|
782
|
+
"application/json": {
|
|
783
|
+
error: {
|
|
784
|
+
code: string;
|
|
785
|
+
message: string;
|
|
786
|
+
};
|
|
787
|
+
requestId: string;
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
792
|
+
403: {
|
|
793
|
+
headers: {
|
|
794
|
+
[name: string]: unknown;
|
|
795
|
+
};
|
|
796
|
+
content: {
|
|
797
|
+
"application/json": {
|
|
798
|
+
error: {
|
|
799
|
+
code: string;
|
|
800
|
+
message: string;
|
|
801
|
+
};
|
|
802
|
+
requestId: string;
|
|
803
|
+
};
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
807
|
+
404: {
|
|
808
|
+
headers: {
|
|
809
|
+
[name: string]: unknown;
|
|
810
|
+
};
|
|
811
|
+
content: {
|
|
812
|
+
"application/json": {
|
|
813
|
+
error: {
|
|
814
|
+
code: string;
|
|
815
|
+
message: string;
|
|
816
|
+
};
|
|
817
|
+
requestId: string;
|
|
818
|
+
};
|
|
819
|
+
};
|
|
820
|
+
};
|
|
821
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
822
|
+
409: {
|
|
823
|
+
headers: {
|
|
824
|
+
[name: string]: unknown;
|
|
825
|
+
};
|
|
826
|
+
content: {
|
|
827
|
+
"application/json": {
|
|
828
|
+
error: {
|
|
829
|
+
code: string;
|
|
830
|
+
message: string;
|
|
831
|
+
};
|
|
832
|
+
requestId: string;
|
|
833
|
+
};
|
|
834
|
+
};
|
|
835
|
+
};
|
|
836
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
837
|
+
410: {
|
|
838
|
+
headers: {
|
|
839
|
+
[name: string]: unknown;
|
|
840
|
+
};
|
|
841
|
+
content: {
|
|
842
|
+
"application/json": {
|
|
843
|
+
error: {
|
|
844
|
+
code: string;
|
|
845
|
+
message: string;
|
|
846
|
+
};
|
|
847
|
+
requestId: string;
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
852
|
+
413: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content: {
|
|
857
|
+
"application/json": {
|
|
858
|
+
error: {
|
|
859
|
+
code: string;
|
|
860
|
+
message: string;
|
|
861
|
+
};
|
|
862
|
+
requestId: string;
|
|
863
|
+
};
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
867
|
+
415: {
|
|
868
|
+
headers: {
|
|
869
|
+
[name: string]: unknown;
|
|
870
|
+
};
|
|
871
|
+
content: {
|
|
872
|
+
"application/json": {
|
|
873
|
+
error: {
|
|
874
|
+
code: string;
|
|
875
|
+
message: string;
|
|
876
|
+
};
|
|
877
|
+
requestId: string;
|
|
878
|
+
};
|
|
879
|
+
};
|
|
880
|
+
};
|
|
881
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
882
|
+
422: {
|
|
883
|
+
headers: {
|
|
884
|
+
[name: string]: unknown;
|
|
885
|
+
};
|
|
886
|
+
content: {
|
|
887
|
+
"application/json": {
|
|
888
|
+
error: {
|
|
889
|
+
code: string;
|
|
890
|
+
message: string;
|
|
891
|
+
};
|
|
892
|
+
requestId: string;
|
|
893
|
+
};
|
|
894
|
+
};
|
|
895
|
+
};
|
|
896
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
897
|
+
429: {
|
|
898
|
+
headers: {
|
|
899
|
+
[name: string]: unknown;
|
|
900
|
+
};
|
|
901
|
+
content: {
|
|
902
|
+
"application/json": {
|
|
903
|
+
error: {
|
|
904
|
+
code: string;
|
|
905
|
+
message: string;
|
|
906
|
+
};
|
|
907
|
+
requestId: string;
|
|
908
|
+
};
|
|
909
|
+
};
|
|
910
|
+
};
|
|
911
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
912
|
+
500: {
|
|
913
|
+
headers: {
|
|
914
|
+
[name: string]: unknown;
|
|
915
|
+
};
|
|
916
|
+
content: {
|
|
917
|
+
"application/json": {
|
|
918
|
+
error: {
|
|
919
|
+
code: string;
|
|
920
|
+
message: string;
|
|
921
|
+
};
|
|
922
|
+
requestId: string;
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
};
|
|
926
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
927
|
+
502: {
|
|
928
|
+
headers: {
|
|
929
|
+
[name: string]: unknown;
|
|
930
|
+
};
|
|
931
|
+
content: {
|
|
932
|
+
"application/json": {
|
|
933
|
+
error: {
|
|
934
|
+
code: string;
|
|
935
|
+
message: string;
|
|
936
|
+
};
|
|
937
|
+
requestId: string;
|
|
938
|
+
};
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
942
|
+
503: {
|
|
943
|
+
headers: {
|
|
944
|
+
[name: string]: unknown;
|
|
945
|
+
};
|
|
946
|
+
content: {
|
|
947
|
+
"application/json": {
|
|
948
|
+
error: {
|
|
949
|
+
code: string;
|
|
950
|
+
message: string;
|
|
951
|
+
};
|
|
952
|
+
requestId: string;
|
|
953
|
+
};
|
|
954
|
+
};
|
|
955
|
+
};
|
|
956
|
+
};
|
|
957
|
+
};
|
|
958
|
+
completeWidgetImport: {
|
|
959
|
+
parameters: {
|
|
960
|
+
query?: never;
|
|
961
|
+
header?: never;
|
|
962
|
+
path: {
|
|
963
|
+
importId: string;
|
|
964
|
+
};
|
|
965
|
+
cookie?: never;
|
|
966
|
+
};
|
|
967
|
+
requestBody: {
|
|
968
|
+
content: {
|
|
969
|
+
"application/json": {
|
|
970
|
+
recordsRejected: number;
|
|
971
|
+
/** @default 0 */
|
|
972
|
+
recordsDeduplicated?: number;
|
|
973
|
+
};
|
|
974
|
+
};
|
|
975
|
+
};
|
|
976
|
+
responses: {
|
|
977
|
+
/** @description Success */
|
|
978
|
+
200: {
|
|
979
|
+
headers: {
|
|
980
|
+
[name: string]: unknown;
|
|
981
|
+
};
|
|
982
|
+
content: {
|
|
983
|
+
"application/json": {
|
|
984
|
+
/** @enum {boolean} */
|
|
985
|
+
ok: true;
|
|
986
|
+
};
|
|
987
|
+
};
|
|
988
|
+
};
|
|
989
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
990
|
+
400: {
|
|
991
|
+
headers: {
|
|
992
|
+
[name: string]: unknown;
|
|
993
|
+
};
|
|
994
|
+
content: {
|
|
995
|
+
"application/json": {
|
|
996
|
+
error: {
|
|
997
|
+
code: string;
|
|
998
|
+
message: string;
|
|
999
|
+
};
|
|
1000
|
+
requestId: string;
|
|
1001
|
+
};
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1005
|
+
401: {
|
|
1006
|
+
headers: {
|
|
1007
|
+
[name: string]: unknown;
|
|
1008
|
+
};
|
|
1009
|
+
content: {
|
|
1010
|
+
"application/json": {
|
|
1011
|
+
error: {
|
|
1012
|
+
code: string;
|
|
1013
|
+
message: string;
|
|
1014
|
+
};
|
|
1015
|
+
requestId: string;
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
};
|
|
1019
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1020
|
+
403: {
|
|
1021
|
+
headers: {
|
|
1022
|
+
[name: string]: unknown;
|
|
1023
|
+
};
|
|
1024
|
+
content: {
|
|
1025
|
+
"application/json": {
|
|
1026
|
+
error: {
|
|
1027
|
+
code: string;
|
|
1028
|
+
message: string;
|
|
1029
|
+
};
|
|
1030
|
+
requestId: string;
|
|
1031
|
+
};
|
|
1032
|
+
};
|
|
1033
|
+
};
|
|
1034
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1035
|
+
404: {
|
|
1036
|
+
headers: {
|
|
1037
|
+
[name: string]: unknown;
|
|
1038
|
+
};
|
|
1039
|
+
content: {
|
|
1040
|
+
"application/json": {
|
|
1041
|
+
error: {
|
|
1042
|
+
code: string;
|
|
1043
|
+
message: string;
|
|
1044
|
+
};
|
|
1045
|
+
requestId: string;
|
|
1046
|
+
};
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1050
|
+
409: {
|
|
1051
|
+
headers: {
|
|
1052
|
+
[name: string]: unknown;
|
|
1053
|
+
};
|
|
1054
|
+
content: {
|
|
1055
|
+
"application/json": {
|
|
1056
|
+
error: {
|
|
1057
|
+
code: string;
|
|
1058
|
+
message: string;
|
|
1059
|
+
};
|
|
1060
|
+
requestId: string;
|
|
1061
|
+
};
|
|
1062
|
+
};
|
|
1063
|
+
};
|
|
1064
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1065
|
+
410: {
|
|
1066
|
+
headers: {
|
|
1067
|
+
[name: string]: unknown;
|
|
1068
|
+
};
|
|
1069
|
+
content: {
|
|
1070
|
+
"application/json": {
|
|
1071
|
+
error: {
|
|
1072
|
+
code: string;
|
|
1073
|
+
message: string;
|
|
1074
|
+
};
|
|
1075
|
+
requestId: string;
|
|
1076
|
+
};
|
|
1077
|
+
};
|
|
1078
|
+
};
|
|
1079
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1080
|
+
413: {
|
|
1081
|
+
headers: {
|
|
1082
|
+
[name: string]: unknown;
|
|
1083
|
+
};
|
|
1084
|
+
content: {
|
|
1085
|
+
"application/json": {
|
|
1086
|
+
error: {
|
|
1087
|
+
code: string;
|
|
1088
|
+
message: string;
|
|
1089
|
+
};
|
|
1090
|
+
requestId: string;
|
|
1091
|
+
};
|
|
1092
|
+
};
|
|
1093
|
+
};
|
|
1094
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1095
|
+
415: {
|
|
1096
|
+
headers: {
|
|
1097
|
+
[name: string]: unknown;
|
|
1098
|
+
};
|
|
1099
|
+
content: {
|
|
1100
|
+
"application/json": {
|
|
1101
|
+
error: {
|
|
1102
|
+
code: string;
|
|
1103
|
+
message: string;
|
|
1104
|
+
};
|
|
1105
|
+
requestId: string;
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1110
|
+
422: {
|
|
1111
|
+
headers: {
|
|
1112
|
+
[name: string]: unknown;
|
|
1113
|
+
};
|
|
1114
|
+
content: {
|
|
1115
|
+
"application/json": {
|
|
1116
|
+
error: {
|
|
1117
|
+
code: string;
|
|
1118
|
+
message: string;
|
|
1119
|
+
};
|
|
1120
|
+
requestId: string;
|
|
1121
|
+
};
|
|
1122
|
+
};
|
|
1123
|
+
};
|
|
1124
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1125
|
+
429: {
|
|
1126
|
+
headers: {
|
|
1127
|
+
[name: string]: unknown;
|
|
1128
|
+
};
|
|
1129
|
+
content: {
|
|
1130
|
+
"application/json": {
|
|
1131
|
+
error: {
|
|
1132
|
+
code: string;
|
|
1133
|
+
message: string;
|
|
1134
|
+
};
|
|
1135
|
+
requestId: string;
|
|
1136
|
+
};
|
|
1137
|
+
};
|
|
1138
|
+
};
|
|
1139
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1140
|
+
500: {
|
|
1141
|
+
headers: {
|
|
1142
|
+
[name: string]: unknown;
|
|
1143
|
+
};
|
|
1144
|
+
content: {
|
|
1145
|
+
"application/json": {
|
|
1146
|
+
error: {
|
|
1147
|
+
code: string;
|
|
1148
|
+
message: string;
|
|
1149
|
+
};
|
|
1150
|
+
requestId: string;
|
|
1151
|
+
};
|
|
1152
|
+
};
|
|
1153
|
+
};
|
|
1154
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1155
|
+
502: {
|
|
1156
|
+
headers: {
|
|
1157
|
+
[name: string]: unknown;
|
|
1158
|
+
};
|
|
1159
|
+
content: {
|
|
1160
|
+
"application/json": {
|
|
1161
|
+
error: {
|
|
1162
|
+
code: string;
|
|
1163
|
+
message: string;
|
|
1164
|
+
};
|
|
1165
|
+
requestId: string;
|
|
1166
|
+
};
|
|
1167
|
+
};
|
|
1168
|
+
};
|
|
1169
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1170
|
+
503: {
|
|
1171
|
+
headers: {
|
|
1172
|
+
[name: string]: unknown;
|
|
1173
|
+
};
|
|
1174
|
+
content: {
|
|
1175
|
+
"application/json": {
|
|
1176
|
+
error: {
|
|
1177
|
+
code: string;
|
|
1178
|
+
message: string;
|
|
1179
|
+
};
|
|
1180
|
+
requestId: string;
|
|
1181
|
+
};
|
|
1182
|
+
};
|
|
1183
|
+
};
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
cancelWidgetImport: {
|
|
1187
|
+
parameters: {
|
|
1188
|
+
query?: never;
|
|
1189
|
+
header?: never;
|
|
1190
|
+
path: {
|
|
1191
|
+
importId: string;
|
|
1192
|
+
};
|
|
1193
|
+
cookie?: never;
|
|
1194
|
+
};
|
|
1195
|
+
requestBody: {
|
|
1196
|
+
content: {
|
|
1197
|
+
"application/json": Record<string, never>;
|
|
1198
|
+
};
|
|
1199
|
+
};
|
|
1200
|
+
responses: {
|
|
1201
|
+
/** @description Success */
|
|
1202
|
+
200: {
|
|
1203
|
+
headers: {
|
|
1204
|
+
[name: string]: unknown;
|
|
1205
|
+
};
|
|
1206
|
+
content: {
|
|
1207
|
+
"application/json": {
|
|
1208
|
+
/** @enum {boolean} */
|
|
1209
|
+
ok: true;
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
};
|
|
1213
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1214
|
+
400: {
|
|
1215
|
+
headers: {
|
|
1216
|
+
[name: string]: unknown;
|
|
1217
|
+
};
|
|
1218
|
+
content: {
|
|
1219
|
+
"application/json": {
|
|
1220
|
+
error: {
|
|
1221
|
+
code: string;
|
|
1222
|
+
message: string;
|
|
1223
|
+
};
|
|
1224
|
+
requestId: string;
|
|
1225
|
+
};
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1229
|
+
401: {
|
|
1230
|
+
headers: {
|
|
1231
|
+
[name: string]: unknown;
|
|
1232
|
+
};
|
|
1233
|
+
content: {
|
|
1234
|
+
"application/json": {
|
|
1235
|
+
error: {
|
|
1236
|
+
code: string;
|
|
1237
|
+
message: string;
|
|
1238
|
+
};
|
|
1239
|
+
requestId: string;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
};
|
|
1243
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1244
|
+
403: {
|
|
1245
|
+
headers: {
|
|
1246
|
+
[name: string]: unknown;
|
|
1247
|
+
};
|
|
1248
|
+
content: {
|
|
1249
|
+
"application/json": {
|
|
1250
|
+
error: {
|
|
1251
|
+
code: string;
|
|
1252
|
+
message: string;
|
|
1253
|
+
};
|
|
1254
|
+
requestId: string;
|
|
1255
|
+
};
|
|
1256
|
+
};
|
|
1257
|
+
};
|
|
1258
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1259
|
+
404: {
|
|
1260
|
+
headers: {
|
|
1261
|
+
[name: string]: unknown;
|
|
1262
|
+
};
|
|
1263
|
+
content: {
|
|
1264
|
+
"application/json": {
|
|
1265
|
+
error: {
|
|
1266
|
+
code: string;
|
|
1267
|
+
message: string;
|
|
1268
|
+
};
|
|
1269
|
+
requestId: string;
|
|
1270
|
+
};
|
|
1271
|
+
};
|
|
1272
|
+
};
|
|
1273
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1274
|
+
409: {
|
|
1275
|
+
headers: {
|
|
1276
|
+
[name: string]: unknown;
|
|
1277
|
+
};
|
|
1278
|
+
content: {
|
|
1279
|
+
"application/json": {
|
|
1280
|
+
error: {
|
|
1281
|
+
code: string;
|
|
1282
|
+
message: string;
|
|
1283
|
+
};
|
|
1284
|
+
requestId: string;
|
|
1285
|
+
};
|
|
1286
|
+
};
|
|
1287
|
+
};
|
|
1288
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1289
|
+
410: {
|
|
1290
|
+
headers: {
|
|
1291
|
+
[name: string]: unknown;
|
|
1292
|
+
};
|
|
1293
|
+
content: {
|
|
1294
|
+
"application/json": {
|
|
1295
|
+
error: {
|
|
1296
|
+
code: string;
|
|
1297
|
+
message: string;
|
|
1298
|
+
};
|
|
1299
|
+
requestId: string;
|
|
1300
|
+
};
|
|
1301
|
+
};
|
|
1302
|
+
};
|
|
1303
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1304
|
+
413: {
|
|
1305
|
+
headers: {
|
|
1306
|
+
[name: string]: unknown;
|
|
1307
|
+
};
|
|
1308
|
+
content: {
|
|
1309
|
+
"application/json": {
|
|
1310
|
+
error: {
|
|
1311
|
+
code: string;
|
|
1312
|
+
message: string;
|
|
1313
|
+
};
|
|
1314
|
+
requestId: string;
|
|
1315
|
+
};
|
|
1316
|
+
};
|
|
1317
|
+
};
|
|
1318
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1319
|
+
415: {
|
|
1320
|
+
headers: {
|
|
1321
|
+
[name: string]: unknown;
|
|
1322
|
+
};
|
|
1323
|
+
content: {
|
|
1324
|
+
"application/json": {
|
|
1325
|
+
error: {
|
|
1326
|
+
code: string;
|
|
1327
|
+
message: string;
|
|
1328
|
+
};
|
|
1329
|
+
requestId: string;
|
|
1330
|
+
};
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1334
|
+
422: {
|
|
1335
|
+
headers: {
|
|
1336
|
+
[name: string]: unknown;
|
|
1337
|
+
};
|
|
1338
|
+
content: {
|
|
1339
|
+
"application/json": {
|
|
1340
|
+
error: {
|
|
1341
|
+
code: string;
|
|
1342
|
+
message: string;
|
|
1343
|
+
};
|
|
1344
|
+
requestId: string;
|
|
1345
|
+
};
|
|
1346
|
+
};
|
|
1347
|
+
};
|
|
1348
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1349
|
+
429: {
|
|
1350
|
+
headers: {
|
|
1351
|
+
[name: string]: unknown;
|
|
1352
|
+
};
|
|
1353
|
+
content: {
|
|
1354
|
+
"application/json": {
|
|
1355
|
+
error: {
|
|
1356
|
+
code: string;
|
|
1357
|
+
message: string;
|
|
1358
|
+
};
|
|
1359
|
+
requestId: string;
|
|
1360
|
+
};
|
|
1361
|
+
};
|
|
1362
|
+
};
|
|
1363
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1364
|
+
500: {
|
|
1365
|
+
headers: {
|
|
1366
|
+
[name: string]: unknown;
|
|
1367
|
+
};
|
|
1368
|
+
content: {
|
|
1369
|
+
"application/json": {
|
|
1370
|
+
error: {
|
|
1371
|
+
code: string;
|
|
1372
|
+
message: string;
|
|
1373
|
+
};
|
|
1374
|
+
requestId: string;
|
|
1375
|
+
};
|
|
1376
|
+
};
|
|
1377
|
+
};
|
|
1378
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1379
|
+
502: {
|
|
1380
|
+
headers: {
|
|
1381
|
+
[name: string]: unknown;
|
|
1382
|
+
};
|
|
1383
|
+
content: {
|
|
1384
|
+
"application/json": {
|
|
1385
|
+
error: {
|
|
1386
|
+
code: string;
|
|
1387
|
+
message: string;
|
|
1388
|
+
};
|
|
1389
|
+
requestId: string;
|
|
1390
|
+
};
|
|
1391
|
+
};
|
|
1392
|
+
};
|
|
1393
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1394
|
+
503: {
|
|
1395
|
+
headers: {
|
|
1396
|
+
[name: string]: unknown;
|
|
1397
|
+
};
|
|
1398
|
+
content: {
|
|
1399
|
+
"application/json": {
|
|
1400
|
+
error: {
|
|
1401
|
+
code: string;
|
|
1402
|
+
message: string;
|
|
1403
|
+
};
|
|
1404
|
+
requestId: string;
|
|
1405
|
+
};
|
|
1406
|
+
};
|
|
1407
|
+
};
|
|
1408
|
+
};
|
|
1409
|
+
};
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1412
|
+
type WidgetConfigV2 = operations['getWidgetConfig']['responses'][200]['content']['application/json'];
|
|
1413
|
+
type WidgetImportV2 = operations['getWidgetImport']['responses'][200]['content']['application/json'];
|
|
1414
|
+
interface WidgetSessionV2 {
|
|
1415
|
+
sessionId: string;
|
|
1416
|
+
token: string;
|
|
1417
|
+
}
|
|
1418
|
+
declare class WidgetCloudError extends Error {
|
|
1419
|
+
readonly code: string;
|
|
1420
|
+
readonly status?: number | undefined;
|
|
1421
|
+
readonly requestId?: string | undefined;
|
|
1422
|
+
constructor(code: string, message: string, status?: number | undefined, requestId?: string | undefined);
|
|
1423
|
+
}
|
|
1424
|
+
/** Only widget credentials and widget routes. Server credentials never enter this client. */
|
|
1425
|
+
declare class ConvertBuddyWidgetClient {
|
|
1426
|
+
#private;
|
|
1427
|
+
private readonly options;
|
|
1428
|
+
/** Explicitly retain prepared/corrected records as a downloadable hosted dataset. */
|
|
1429
|
+
processing(): ProcessingClient;
|
|
1430
|
+
archive(file: ReplayableFile | Blob, clientKey: string, signal?: AbortSignal): Promise<{
|
|
1431
|
+
jobId: string;
|
|
1432
|
+
operation: "convert" | "import" | "ocr";
|
|
1433
|
+
generation: number;
|
|
1434
|
+
status: "queued" | "running" | "succeeded" | "failed" | "cancelling" | "cancelled";
|
|
1435
|
+
stage: "persist-input" | "process-file";
|
|
1436
|
+
revision: number;
|
|
1437
|
+
createdAt: number;
|
|
1438
|
+
updatedAt: number;
|
|
1439
|
+
deadlineAt: number;
|
|
1440
|
+
retryAt: number | null;
|
|
1441
|
+
errorCode: string | null;
|
|
1442
|
+
statistics: {
|
|
1443
|
+
inputBytes: number;
|
|
1444
|
+
outputBytes: number;
|
|
1445
|
+
records: number;
|
|
1446
|
+
rejected: number;
|
|
1447
|
+
};
|
|
1448
|
+
artifacts: {
|
|
1449
|
+
artifactId: string;
|
|
1450
|
+
kind: "result" | "report";
|
|
1451
|
+
bytes: number;
|
|
1452
|
+
contentType: string;
|
|
1453
|
+
etag: string;
|
|
1454
|
+
expiresAt: number;
|
|
1455
|
+
}[];
|
|
1456
|
+
}>;
|
|
1457
|
+
constructor(options: {
|
|
1458
|
+
apiUrl: string;
|
|
1459
|
+
publishableKey: string;
|
|
1460
|
+
sessionToken: string;
|
|
1461
|
+
fetch?: typeof fetch;
|
|
1462
|
+
});
|
|
1463
|
+
getConfig(signal?: AbortSignal): Promise<WidgetConfigV2>;
|
|
1464
|
+
createImport(clientKey: string, format: SourceFormatV1, signal?: AbortSignal): Promise<string>;
|
|
1465
|
+
getImport(id: string, signal?: AbortSignal): Promise<WidgetImportV2>;
|
|
1466
|
+
deliverBatch(id: string, batchId: string, records: readonly Record<string, JsonValue>[], signal?: AbortSignal): Promise<void>;
|
|
1467
|
+
completeImport(id: string, recordsRejected: number, recordsDeduplicated: number, signal?: AbortSignal): Promise<void>;
|
|
1468
|
+
cancelImport(id: string, signal?: AbortSignal): Promise<void>;
|
|
1469
|
+
}
|
|
1470
|
+
|
|
1471
|
+
export { ConvertBuddyWidgetClient, ProcessingClient, ReplayableFile, WidgetCloudError, type WidgetConfigV2, type WidgetImportV2, type WidgetSessionV2 };
|