@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
|
@@ -0,0 +1,3204 @@
|
|
|
1
|
+
interface operations {
|
|
2
|
+
createProcessingUpload: {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
requestBody: {
|
|
10
|
+
content: {
|
|
11
|
+
"application/json": {
|
|
12
|
+
/** Format: uuid */
|
|
13
|
+
clientKey: string;
|
|
14
|
+
/** @enum {string} */
|
|
15
|
+
operation: "convert" | "import" | "ocr";
|
|
16
|
+
bytes: number;
|
|
17
|
+
contentType: string;
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
};
|
|
21
|
+
responses: {
|
|
22
|
+
/** @description Success */
|
|
23
|
+
200: {
|
|
24
|
+
headers: {
|
|
25
|
+
[name: string]: unknown;
|
|
26
|
+
};
|
|
27
|
+
content: {
|
|
28
|
+
"application/json": {
|
|
29
|
+
/** Format: uuid */
|
|
30
|
+
uploadId: string;
|
|
31
|
+
/** @enum {string} */
|
|
32
|
+
operation: "convert" | "import" | "ocr";
|
|
33
|
+
bytes: number;
|
|
34
|
+
partBytes: number;
|
|
35
|
+
partCount: number;
|
|
36
|
+
/** @enum {string} */
|
|
37
|
+
status: "uploading" | "claimed" | "persisted" | "deleting" | "deleted";
|
|
38
|
+
expiresAt: number;
|
|
39
|
+
/** Format: uuid */
|
|
40
|
+
jobId: string | null;
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
};
|
|
44
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
45
|
+
400: {
|
|
46
|
+
headers: {
|
|
47
|
+
[name: string]: unknown;
|
|
48
|
+
};
|
|
49
|
+
content: {
|
|
50
|
+
"application/json": {
|
|
51
|
+
error: {
|
|
52
|
+
code: string;
|
|
53
|
+
message: string;
|
|
54
|
+
};
|
|
55
|
+
requestId: string;
|
|
56
|
+
};
|
|
57
|
+
};
|
|
58
|
+
};
|
|
59
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
60
|
+
401: {
|
|
61
|
+
headers: {
|
|
62
|
+
[name: string]: unknown;
|
|
63
|
+
};
|
|
64
|
+
content: {
|
|
65
|
+
"application/json": {
|
|
66
|
+
error: {
|
|
67
|
+
code: string;
|
|
68
|
+
message: string;
|
|
69
|
+
};
|
|
70
|
+
requestId: string;
|
|
71
|
+
};
|
|
72
|
+
};
|
|
73
|
+
};
|
|
74
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
75
|
+
403: {
|
|
76
|
+
headers: {
|
|
77
|
+
[name: string]: unknown;
|
|
78
|
+
};
|
|
79
|
+
content: {
|
|
80
|
+
"application/json": {
|
|
81
|
+
error: {
|
|
82
|
+
code: string;
|
|
83
|
+
message: string;
|
|
84
|
+
};
|
|
85
|
+
requestId: string;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
90
|
+
404: {
|
|
91
|
+
headers: {
|
|
92
|
+
[name: string]: unknown;
|
|
93
|
+
};
|
|
94
|
+
content: {
|
|
95
|
+
"application/json": {
|
|
96
|
+
error: {
|
|
97
|
+
code: string;
|
|
98
|
+
message: string;
|
|
99
|
+
};
|
|
100
|
+
requestId: string;
|
|
101
|
+
};
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
105
|
+
409: {
|
|
106
|
+
headers: {
|
|
107
|
+
[name: string]: unknown;
|
|
108
|
+
};
|
|
109
|
+
content: {
|
|
110
|
+
"application/json": {
|
|
111
|
+
error: {
|
|
112
|
+
code: string;
|
|
113
|
+
message: string;
|
|
114
|
+
};
|
|
115
|
+
requestId: string;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
120
|
+
410: {
|
|
121
|
+
headers: {
|
|
122
|
+
[name: string]: unknown;
|
|
123
|
+
};
|
|
124
|
+
content: {
|
|
125
|
+
"application/json": {
|
|
126
|
+
error: {
|
|
127
|
+
code: string;
|
|
128
|
+
message: string;
|
|
129
|
+
};
|
|
130
|
+
requestId: string;
|
|
131
|
+
};
|
|
132
|
+
};
|
|
133
|
+
};
|
|
134
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
135
|
+
413: {
|
|
136
|
+
headers: {
|
|
137
|
+
[name: string]: unknown;
|
|
138
|
+
};
|
|
139
|
+
content: {
|
|
140
|
+
"application/json": {
|
|
141
|
+
error: {
|
|
142
|
+
code: string;
|
|
143
|
+
message: string;
|
|
144
|
+
};
|
|
145
|
+
requestId: string;
|
|
146
|
+
};
|
|
147
|
+
};
|
|
148
|
+
};
|
|
149
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
150
|
+
415: {
|
|
151
|
+
headers: {
|
|
152
|
+
[name: string]: unknown;
|
|
153
|
+
};
|
|
154
|
+
content: {
|
|
155
|
+
"application/json": {
|
|
156
|
+
error: {
|
|
157
|
+
code: string;
|
|
158
|
+
message: string;
|
|
159
|
+
};
|
|
160
|
+
requestId: string;
|
|
161
|
+
};
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
165
|
+
422: {
|
|
166
|
+
headers: {
|
|
167
|
+
[name: string]: unknown;
|
|
168
|
+
};
|
|
169
|
+
content: {
|
|
170
|
+
"application/json": {
|
|
171
|
+
error: {
|
|
172
|
+
code: string;
|
|
173
|
+
message: string;
|
|
174
|
+
};
|
|
175
|
+
requestId: string;
|
|
176
|
+
};
|
|
177
|
+
};
|
|
178
|
+
};
|
|
179
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
180
|
+
429: {
|
|
181
|
+
headers: {
|
|
182
|
+
[name: string]: unknown;
|
|
183
|
+
};
|
|
184
|
+
content: {
|
|
185
|
+
"application/json": {
|
|
186
|
+
error: {
|
|
187
|
+
code: string;
|
|
188
|
+
message: string;
|
|
189
|
+
};
|
|
190
|
+
requestId: string;
|
|
191
|
+
};
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
195
|
+
500: {
|
|
196
|
+
headers: {
|
|
197
|
+
[name: string]: unknown;
|
|
198
|
+
};
|
|
199
|
+
content: {
|
|
200
|
+
"application/json": {
|
|
201
|
+
error: {
|
|
202
|
+
code: string;
|
|
203
|
+
message: string;
|
|
204
|
+
};
|
|
205
|
+
requestId: string;
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
210
|
+
502: {
|
|
211
|
+
headers: {
|
|
212
|
+
[name: string]: unknown;
|
|
213
|
+
};
|
|
214
|
+
content: {
|
|
215
|
+
"application/json": {
|
|
216
|
+
error: {
|
|
217
|
+
code: string;
|
|
218
|
+
message: string;
|
|
219
|
+
};
|
|
220
|
+
requestId: string;
|
|
221
|
+
};
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
225
|
+
503: {
|
|
226
|
+
headers: {
|
|
227
|
+
[name: string]: unknown;
|
|
228
|
+
};
|
|
229
|
+
content: {
|
|
230
|
+
"application/json": {
|
|
231
|
+
error: {
|
|
232
|
+
code: string;
|
|
233
|
+
message: string;
|
|
234
|
+
};
|
|
235
|
+
requestId: string;
|
|
236
|
+
};
|
|
237
|
+
};
|
|
238
|
+
};
|
|
239
|
+
};
|
|
240
|
+
};
|
|
241
|
+
getProcessingUpload: {
|
|
242
|
+
parameters: {
|
|
243
|
+
query?: {
|
|
244
|
+
after?: number | null;
|
|
245
|
+
};
|
|
246
|
+
header?: never;
|
|
247
|
+
path: {
|
|
248
|
+
uploadId: string;
|
|
249
|
+
};
|
|
250
|
+
cookie?: never;
|
|
251
|
+
};
|
|
252
|
+
requestBody?: never;
|
|
253
|
+
responses: {
|
|
254
|
+
/** @description Success */
|
|
255
|
+
200: {
|
|
256
|
+
headers: {
|
|
257
|
+
[name: string]: unknown;
|
|
258
|
+
};
|
|
259
|
+
content: {
|
|
260
|
+
"application/json": {
|
|
261
|
+
/** Format: uuid */
|
|
262
|
+
uploadId: string;
|
|
263
|
+
/** @enum {string} */
|
|
264
|
+
operation: "convert" | "import" | "ocr";
|
|
265
|
+
bytes: number;
|
|
266
|
+
partBytes: number;
|
|
267
|
+
partCount: number;
|
|
268
|
+
/** @enum {string} */
|
|
269
|
+
status: "uploading" | "claimed" | "persisted" | "deleting" | "deleted";
|
|
270
|
+
expiresAt: number;
|
|
271
|
+
/** Format: uuid */
|
|
272
|
+
jobId: string | null;
|
|
273
|
+
parts: {
|
|
274
|
+
partNumber: number;
|
|
275
|
+
bytes: number;
|
|
276
|
+
sha256: string;
|
|
277
|
+
}[];
|
|
278
|
+
nextPart: number | null;
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
};
|
|
282
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
283
|
+
400: {
|
|
284
|
+
headers: {
|
|
285
|
+
[name: string]: unknown;
|
|
286
|
+
};
|
|
287
|
+
content: {
|
|
288
|
+
"application/json": {
|
|
289
|
+
error: {
|
|
290
|
+
code: string;
|
|
291
|
+
message: string;
|
|
292
|
+
};
|
|
293
|
+
requestId: string;
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
};
|
|
297
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
298
|
+
401: {
|
|
299
|
+
headers: {
|
|
300
|
+
[name: string]: unknown;
|
|
301
|
+
};
|
|
302
|
+
content: {
|
|
303
|
+
"application/json": {
|
|
304
|
+
error: {
|
|
305
|
+
code: string;
|
|
306
|
+
message: string;
|
|
307
|
+
};
|
|
308
|
+
requestId: string;
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
313
|
+
403: {
|
|
314
|
+
headers: {
|
|
315
|
+
[name: string]: unknown;
|
|
316
|
+
};
|
|
317
|
+
content: {
|
|
318
|
+
"application/json": {
|
|
319
|
+
error: {
|
|
320
|
+
code: string;
|
|
321
|
+
message: string;
|
|
322
|
+
};
|
|
323
|
+
requestId: string;
|
|
324
|
+
};
|
|
325
|
+
};
|
|
326
|
+
};
|
|
327
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
328
|
+
404: {
|
|
329
|
+
headers: {
|
|
330
|
+
[name: string]: unknown;
|
|
331
|
+
};
|
|
332
|
+
content: {
|
|
333
|
+
"application/json": {
|
|
334
|
+
error: {
|
|
335
|
+
code: string;
|
|
336
|
+
message: string;
|
|
337
|
+
};
|
|
338
|
+
requestId: string;
|
|
339
|
+
};
|
|
340
|
+
};
|
|
341
|
+
};
|
|
342
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
343
|
+
409: {
|
|
344
|
+
headers: {
|
|
345
|
+
[name: string]: unknown;
|
|
346
|
+
};
|
|
347
|
+
content: {
|
|
348
|
+
"application/json": {
|
|
349
|
+
error: {
|
|
350
|
+
code: string;
|
|
351
|
+
message: string;
|
|
352
|
+
};
|
|
353
|
+
requestId: string;
|
|
354
|
+
};
|
|
355
|
+
};
|
|
356
|
+
};
|
|
357
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
358
|
+
410: {
|
|
359
|
+
headers: {
|
|
360
|
+
[name: string]: unknown;
|
|
361
|
+
};
|
|
362
|
+
content: {
|
|
363
|
+
"application/json": {
|
|
364
|
+
error: {
|
|
365
|
+
code: string;
|
|
366
|
+
message: string;
|
|
367
|
+
};
|
|
368
|
+
requestId: string;
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
373
|
+
413: {
|
|
374
|
+
headers: {
|
|
375
|
+
[name: string]: unknown;
|
|
376
|
+
};
|
|
377
|
+
content: {
|
|
378
|
+
"application/json": {
|
|
379
|
+
error: {
|
|
380
|
+
code: string;
|
|
381
|
+
message: string;
|
|
382
|
+
};
|
|
383
|
+
requestId: string;
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
388
|
+
415: {
|
|
389
|
+
headers: {
|
|
390
|
+
[name: string]: unknown;
|
|
391
|
+
};
|
|
392
|
+
content: {
|
|
393
|
+
"application/json": {
|
|
394
|
+
error: {
|
|
395
|
+
code: string;
|
|
396
|
+
message: string;
|
|
397
|
+
};
|
|
398
|
+
requestId: string;
|
|
399
|
+
};
|
|
400
|
+
};
|
|
401
|
+
};
|
|
402
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
403
|
+
422: {
|
|
404
|
+
headers: {
|
|
405
|
+
[name: string]: unknown;
|
|
406
|
+
};
|
|
407
|
+
content: {
|
|
408
|
+
"application/json": {
|
|
409
|
+
error: {
|
|
410
|
+
code: string;
|
|
411
|
+
message: string;
|
|
412
|
+
};
|
|
413
|
+
requestId: string;
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
};
|
|
417
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
418
|
+
429: {
|
|
419
|
+
headers: {
|
|
420
|
+
[name: string]: unknown;
|
|
421
|
+
};
|
|
422
|
+
content: {
|
|
423
|
+
"application/json": {
|
|
424
|
+
error: {
|
|
425
|
+
code: string;
|
|
426
|
+
message: string;
|
|
427
|
+
};
|
|
428
|
+
requestId: string;
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
433
|
+
500: {
|
|
434
|
+
headers: {
|
|
435
|
+
[name: string]: unknown;
|
|
436
|
+
};
|
|
437
|
+
content: {
|
|
438
|
+
"application/json": {
|
|
439
|
+
error: {
|
|
440
|
+
code: string;
|
|
441
|
+
message: string;
|
|
442
|
+
};
|
|
443
|
+
requestId: string;
|
|
444
|
+
};
|
|
445
|
+
};
|
|
446
|
+
};
|
|
447
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
448
|
+
502: {
|
|
449
|
+
headers: {
|
|
450
|
+
[name: string]: unknown;
|
|
451
|
+
};
|
|
452
|
+
content: {
|
|
453
|
+
"application/json": {
|
|
454
|
+
error: {
|
|
455
|
+
code: string;
|
|
456
|
+
message: string;
|
|
457
|
+
};
|
|
458
|
+
requestId: string;
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
463
|
+
503: {
|
|
464
|
+
headers: {
|
|
465
|
+
[name: string]: unknown;
|
|
466
|
+
};
|
|
467
|
+
content: {
|
|
468
|
+
"application/json": {
|
|
469
|
+
error: {
|
|
470
|
+
code: string;
|
|
471
|
+
message: string;
|
|
472
|
+
};
|
|
473
|
+
requestId: string;
|
|
474
|
+
};
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
};
|
|
478
|
+
};
|
|
479
|
+
abortProcessingUpload: {
|
|
480
|
+
parameters: {
|
|
481
|
+
query?: never;
|
|
482
|
+
header?: never;
|
|
483
|
+
path: {
|
|
484
|
+
uploadId: string;
|
|
485
|
+
};
|
|
486
|
+
cookie?: never;
|
|
487
|
+
};
|
|
488
|
+
requestBody: {
|
|
489
|
+
content: {
|
|
490
|
+
"application/json": Record<string, never>;
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
responses: {
|
|
494
|
+
/** @description Success */
|
|
495
|
+
200: {
|
|
496
|
+
headers: {
|
|
497
|
+
[name: string]: unknown;
|
|
498
|
+
};
|
|
499
|
+
content: {
|
|
500
|
+
"application/json": {
|
|
501
|
+
/** @enum {boolean} */
|
|
502
|
+
ok: true;
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
};
|
|
506
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
507
|
+
400: {
|
|
508
|
+
headers: {
|
|
509
|
+
[name: string]: unknown;
|
|
510
|
+
};
|
|
511
|
+
content: {
|
|
512
|
+
"application/json": {
|
|
513
|
+
error: {
|
|
514
|
+
code: string;
|
|
515
|
+
message: string;
|
|
516
|
+
};
|
|
517
|
+
requestId: string;
|
|
518
|
+
};
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
522
|
+
401: {
|
|
523
|
+
headers: {
|
|
524
|
+
[name: string]: unknown;
|
|
525
|
+
};
|
|
526
|
+
content: {
|
|
527
|
+
"application/json": {
|
|
528
|
+
error: {
|
|
529
|
+
code: string;
|
|
530
|
+
message: string;
|
|
531
|
+
};
|
|
532
|
+
requestId: string;
|
|
533
|
+
};
|
|
534
|
+
};
|
|
535
|
+
};
|
|
536
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
537
|
+
403: {
|
|
538
|
+
headers: {
|
|
539
|
+
[name: string]: unknown;
|
|
540
|
+
};
|
|
541
|
+
content: {
|
|
542
|
+
"application/json": {
|
|
543
|
+
error: {
|
|
544
|
+
code: string;
|
|
545
|
+
message: string;
|
|
546
|
+
};
|
|
547
|
+
requestId: string;
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
552
|
+
404: {
|
|
553
|
+
headers: {
|
|
554
|
+
[name: string]: unknown;
|
|
555
|
+
};
|
|
556
|
+
content: {
|
|
557
|
+
"application/json": {
|
|
558
|
+
error: {
|
|
559
|
+
code: string;
|
|
560
|
+
message: string;
|
|
561
|
+
};
|
|
562
|
+
requestId: string;
|
|
563
|
+
};
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
567
|
+
409: {
|
|
568
|
+
headers: {
|
|
569
|
+
[name: string]: unknown;
|
|
570
|
+
};
|
|
571
|
+
content: {
|
|
572
|
+
"application/json": {
|
|
573
|
+
error: {
|
|
574
|
+
code: string;
|
|
575
|
+
message: string;
|
|
576
|
+
};
|
|
577
|
+
requestId: string;
|
|
578
|
+
};
|
|
579
|
+
};
|
|
580
|
+
};
|
|
581
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
582
|
+
410: {
|
|
583
|
+
headers: {
|
|
584
|
+
[name: string]: unknown;
|
|
585
|
+
};
|
|
586
|
+
content: {
|
|
587
|
+
"application/json": {
|
|
588
|
+
error: {
|
|
589
|
+
code: string;
|
|
590
|
+
message: string;
|
|
591
|
+
};
|
|
592
|
+
requestId: string;
|
|
593
|
+
};
|
|
594
|
+
};
|
|
595
|
+
};
|
|
596
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
597
|
+
413: {
|
|
598
|
+
headers: {
|
|
599
|
+
[name: string]: unknown;
|
|
600
|
+
};
|
|
601
|
+
content: {
|
|
602
|
+
"application/json": {
|
|
603
|
+
error: {
|
|
604
|
+
code: string;
|
|
605
|
+
message: string;
|
|
606
|
+
};
|
|
607
|
+
requestId: string;
|
|
608
|
+
};
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
612
|
+
415: {
|
|
613
|
+
headers: {
|
|
614
|
+
[name: string]: unknown;
|
|
615
|
+
};
|
|
616
|
+
content: {
|
|
617
|
+
"application/json": {
|
|
618
|
+
error: {
|
|
619
|
+
code: string;
|
|
620
|
+
message: string;
|
|
621
|
+
};
|
|
622
|
+
requestId: string;
|
|
623
|
+
};
|
|
624
|
+
};
|
|
625
|
+
};
|
|
626
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
627
|
+
422: {
|
|
628
|
+
headers: {
|
|
629
|
+
[name: string]: unknown;
|
|
630
|
+
};
|
|
631
|
+
content: {
|
|
632
|
+
"application/json": {
|
|
633
|
+
error: {
|
|
634
|
+
code: string;
|
|
635
|
+
message: string;
|
|
636
|
+
};
|
|
637
|
+
requestId: string;
|
|
638
|
+
};
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
642
|
+
429: {
|
|
643
|
+
headers: {
|
|
644
|
+
[name: string]: unknown;
|
|
645
|
+
};
|
|
646
|
+
content: {
|
|
647
|
+
"application/json": {
|
|
648
|
+
error: {
|
|
649
|
+
code: string;
|
|
650
|
+
message: string;
|
|
651
|
+
};
|
|
652
|
+
requestId: string;
|
|
653
|
+
};
|
|
654
|
+
};
|
|
655
|
+
};
|
|
656
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
657
|
+
500: {
|
|
658
|
+
headers: {
|
|
659
|
+
[name: string]: unknown;
|
|
660
|
+
};
|
|
661
|
+
content: {
|
|
662
|
+
"application/json": {
|
|
663
|
+
error: {
|
|
664
|
+
code: string;
|
|
665
|
+
message: string;
|
|
666
|
+
};
|
|
667
|
+
requestId: string;
|
|
668
|
+
};
|
|
669
|
+
};
|
|
670
|
+
};
|
|
671
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
672
|
+
502: {
|
|
673
|
+
headers: {
|
|
674
|
+
[name: string]: unknown;
|
|
675
|
+
};
|
|
676
|
+
content: {
|
|
677
|
+
"application/json": {
|
|
678
|
+
error: {
|
|
679
|
+
code: string;
|
|
680
|
+
message: string;
|
|
681
|
+
};
|
|
682
|
+
requestId: string;
|
|
683
|
+
};
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
687
|
+
503: {
|
|
688
|
+
headers: {
|
|
689
|
+
[name: string]: unknown;
|
|
690
|
+
};
|
|
691
|
+
content: {
|
|
692
|
+
"application/json": {
|
|
693
|
+
error: {
|
|
694
|
+
code: string;
|
|
695
|
+
message: string;
|
|
696
|
+
};
|
|
697
|
+
requestId: string;
|
|
698
|
+
};
|
|
699
|
+
};
|
|
700
|
+
};
|
|
701
|
+
};
|
|
702
|
+
};
|
|
703
|
+
putProcessingPart: {
|
|
704
|
+
parameters: {
|
|
705
|
+
query?: never;
|
|
706
|
+
header?: never;
|
|
707
|
+
path: {
|
|
708
|
+
uploadId: string;
|
|
709
|
+
partNumber: number;
|
|
710
|
+
};
|
|
711
|
+
cookie?: never;
|
|
712
|
+
};
|
|
713
|
+
requestBody: {
|
|
714
|
+
content: {
|
|
715
|
+
"application/octet-stream": string;
|
|
716
|
+
};
|
|
717
|
+
};
|
|
718
|
+
responses: {
|
|
719
|
+
/** @description Acknowledged part */
|
|
720
|
+
200: {
|
|
721
|
+
headers: {
|
|
722
|
+
[name: string]: unknown;
|
|
723
|
+
};
|
|
724
|
+
content: {
|
|
725
|
+
"application/json": {
|
|
726
|
+
partNumber: number;
|
|
727
|
+
bytes: number;
|
|
728
|
+
};
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
732
|
+
400: {
|
|
733
|
+
headers: {
|
|
734
|
+
[name: string]: unknown;
|
|
735
|
+
};
|
|
736
|
+
content: {
|
|
737
|
+
"application/json": {
|
|
738
|
+
error: {
|
|
739
|
+
code: string;
|
|
740
|
+
message: string;
|
|
741
|
+
};
|
|
742
|
+
requestId: string;
|
|
743
|
+
};
|
|
744
|
+
};
|
|
745
|
+
};
|
|
746
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
747
|
+
401: {
|
|
748
|
+
headers: {
|
|
749
|
+
[name: string]: unknown;
|
|
750
|
+
};
|
|
751
|
+
content: {
|
|
752
|
+
"application/json": {
|
|
753
|
+
error: {
|
|
754
|
+
code: string;
|
|
755
|
+
message: string;
|
|
756
|
+
};
|
|
757
|
+
requestId: string;
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
762
|
+
403: {
|
|
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
|
+
404: {
|
|
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
|
+
409: {
|
|
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
|
+
410: {
|
|
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
|
+
413: {
|
|
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
|
+
415: {
|
|
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
|
+
422: {
|
|
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
|
+
429: {
|
|
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
|
+
500: {
|
|
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
|
+
502: {
|
|
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
|
+
503: {
|
|
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
|
+
};
|
|
927
|
+
};
|
|
928
|
+
submitProcessingJob: {
|
|
929
|
+
parameters: {
|
|
930
|
+
query?: never;
|
|
931
|
+
header?: never;
|
|
932
|
+
path?: never;
|
|
933
|
+
cookie?: never;
|
|
934
|
+
};
|
|
935
|
+
requestBody: {
|
|
936
|
+
content: {
|
|
937
|
+
"application/json": {
|
|
938
|
+
/** @enum {string} */
|
|
939
|
+
operation: "convert";
|
|
940
|
+
/** Format: uuid */
|
|
941
|
+
uploadId: string;
|
|
942
|
+
options: {
|
|
943
|
+
/** @enum {string} */
|
|
944
|
+
inputFormat: "csv" | "tsv" | "psv" | "json" | "ndjson" | "jsonl" | "xml" | "yaml" | "xlsx" | "xls" | "ods";
|
|
945
|
+
/** @enum {string} */
|
|
946
|
+
outputFormat: "csv" | "json" | "ndjson" | "xml";
|
|
947
|
+
sheet?: string;
|
|
948
|
+
};
|
|
949
|
+
} | {
|
|
950
|
+
/** @enum {string} */
|
|
951
|
+
operation: "import";
|
|
952
|
+
/** Format: uuid */
|
|
953
|
+
uploadId: string;
|
|
954
|
+
options: {
|
|
955
|
+
/** @enum {string} */
|
|
956
|
+
inputFormat: "ndjson";
|
|
957
|
+
/** @enum {string} */
|
|
958
|
+
outputFormat: "ndjson";
|
|
959
|
+
};
|
|
960
|
+
} | {
|
|
961
|
+
/** @enum {string} */
|
|
962
|
+
operation: "ocr";
|
|
963
|
+
/** Format: uuid */
|
|
964
|
+
uploadId: string;
|
|
965
|
+
options: {
|
|
966
|
+
/** @enum {string} */
|
|
967
|
+
profile: "fast" | "balanced" | "high-accuracy";
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
};
|
|
972
|
+
responses: {
|
|
973
|
+
/** @description Success */
|
|
974
|
+
202: {
|
|
975
|
+
headers: {
|
|
976
|
+
[name: string]: unknown;
|
|
977
|
+
};
|
|
978
|
+
content: {
|
|
979
|
+
"application/json": {
|
|
980
|
+
/** Format: uuid */
|
|
981
|
+
jobId: string;
|
|
982
|
+
/** @enum {string} */
|
|
983
|
+
operation: "convert" | "import" | "ocr";
|
|
984
|
+
generation: number;
|
|
985
|
+
/** @enum {string} */
|
|
986
|
+
status: "queued" | "running" | "succeeded" | "failed" | "cancelling" | "cancelled";
|
|
987
|
+
/** @enum {string} */
|
|
988
|
+
stage: "persist-input" | "process-file";
|
|
989
|
+
revision: number;
|
|
990
|
+
createdAt: number;
|
|
991
|
+
updatedAt: number;
|
|
992
|
+
deadlineAt: number;
|
|
993
|
+
retryAt: number | null;
|
|
994
|
+
errorCode: string | null;
|
|
995
|
+
statistics: {
|
|
996
|
+
inputBytes: number;
|
|
997
|
+
outputBytes: number;
|
|
998
|
+
records: number;
|
|
999
|
+
rejected: number;
|
|
1000
|
+
};
|
|
1001
|
+
artifacts: {
|
|
1002
|
+
/** Format: uuid */
|
|
1003
|
+
artifactId: string;
|
|
1004
|
+
/** @enum {string} */
|
|
1005
|
+
kind: "result" | "report";
|
|
1006
|
+
bytes: number;
|
|
1007
|
+
contentType: string;
|
|
1008
|
+
etag: string;
|
|
1009
|
+
expiresAt: number;
|
|
1010
|
+
}[];
|
|
1011
|
+
};
|
|
1012
|
+
};
|
|
1013
|
+
};
|
|
1014
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1015
|
+
400: {
|
|
1016
|
+
headers: {
|
|
1017
|
+
[name: string]: unknown;
|
|
1018
|
+
};
|
|
1019
|
+
content: {
|
|
1020
|
+
"application/json": {
|
|
1021
|
+
error: {
|
|
1022
|
+
code: string;
|
|
1023
|
+
message: string;
|
|
1024
|
+
};
|
|
1025
|
+
requestId: string;
|
|
1026
|
+
};
|
|
1027
|
+
};
|
|
1028
|
+
};
|
|
1029
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1030
|
+
401: {
|
|
1031
|
+
headers: {
|
|
1032
|
+
[name: string]: unknown;
|
|
1033
|
+
};
|
|
1034
|
+
content: {
|
|
1035
|
+
"application/json": {
|
|
1036
|
+
error: {
|
|
1037
|
+
code: string;
|
|
1038
|
+
message: string;
|
|
1039
|
+
};
|
|
1040
|
+
requestId: string;
|
|
1041
|
+
};
|
|
1042
|
+
};
|
|
1043
|
+
};
|
|
1044
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1045
|
+
403: {
|
|
1046
|
+
headers: {
|
|
1047
|
+
[name: string]: unknown;
|
|
1048
|
+
};
|
|
1049
|
+
content: {
|
|
1050
|
+
"application/json": {
|
|
1051
|
+
error: {
|
|
1052
|
+
code: string;
|
|
1053
|
+
message: string;
|
|
1054
|
+
};
|
|
1055
|
+
requestId: string;
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
};
|
|
1059
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1060
|
+
404: {
|
|
1061
|
+
headers: {
|
|
1062
|
+
[name: string]: unknown;
|
|
1063
|
+
};
|
|
1064
|
+
content: {
|
|
1065
|
+
"application/json": {
|
|
1066
|
+
error: {
|
|
1067
|
+
code: string;
|
|
1068
|
+
message: string;
|
|
1069
|
+
};
|
|
1070
|
+
requestId: string;
|
|
1071
|
+
};
|
|
1072
|
+
};
|
|
1073
|
+
};
|
|
1074
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1075
|
+
409: {
|
|
1076
|
+
headers: {
|
|
1077
|
+
[name: string]: unknown;
|
|
1078
|
+
};
|
|
1079
|
+
content: {
|
|
1080
|
+
"application/json": {
|
|
1081
|
+
error: {
|
|
1082
|
+
code: string;
|
|
1083
|
+
message: string;
|
|
1084
|
+
};
|
|
1085
|
+
requestId: string;
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1090
|
+
410: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content: {
|
|
1095
|
+
"application/json": {
|
|
1096
|
+
error: {
|
|
1097
|
+
code: string;
|
|
1098
|
+
message: string;
|
|
1099
|
+
};
|
|
1100
|
+
requestId: string;
|
|
1101
|
+
};
|
|
1102
|
+
};
|
|
1103
|
+
};
|
|
1104
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1105
|
+
413: {
|
|
1106
|
+
headers: {
|
|
1107
|
+
[name: string]: unknown;
|
|
1108
|
+
};
|
|
1109
|
+
content: {
|
|
1110
|
+
"application/json": {
|
|
1111
|
+
error: {
|
|
1112
|
+
code: string;
|
|
1113
|
+
message: string;
|
|
1114
|
+
};
|
|
1115
|
+
requestId: string;
|
|
1116
|
+
};
|
|
1117
|
+
};
|
|
1118
|
+
};
|
|
1119
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1120
|
+
415: {
|
|
1121
|
+
headers: {
|
|
1122
|
+
[name: string]: unknown;
|
|
1123
|
+
};
|
|
1124
|
+
content: {
|
|
1125
|
+
"application/json": {
|
|
1126
|
+
error: {
|
|
1127
|
+
code: string;
|
|
1128
|
+
message: string;
|
|
1129
|
+
};
|
|
1130
|
+
requestId: string;
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
};
|
|
1134
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1135
|
+
422: {
|
|
1136
|
+
headers: {
|
|
1137
|
+
[name: string]: unknown;
|
|
1138
|
+
};
|
|
1139
|
+
content: {
|
|
1140
|
+
"application/json": {
|
|
1141
|
+
error: {
|
|
1142
|
+
code: string;
|
|
1143
|
+
message: string;
|
|
1144
|
+
};
|
|
1145
|
+
requestId: string;
|
|
1146
|
+
};
|
|
1147
|
+
};
|
|
1148
|
+
};
|
|
1149
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1150
|
+
429: {
|
|
1151
|
+
headers: {
|
|
1152
|
+
[name: string]: unknown;
|
|
1153
|
+
};
|
|
1154
|
+
content: {
|
|
1155
|
+
"application/json": {
|
|
1156
|
+
error: {
|
|
1157
|
+
code: string;
|
|
1158
|
+
message: string;
|
|
1159
|
+
};
|
|
1160
|
+
requestId: string;
|
|
1161
|
+
};
|
|
1162
|
+
};
|
|
1163
|
+
};
|
|
1164
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1165
|
+
500: {
|
|
1166
|
+
headers: {
|
|
1167
|
+
[name: string]: unknown;
|
|
1168
|
+
};
|
|
1169
|
+
content: {
|
|
1170
|
+
"application/json": {
|
|
1171
|
+
error: {
|
|
1172
|
+
code: string;
|
|
1173
|
+
message: string;
|
|
1174
|
+
};
|
|
1175
|
+
requestId: string;
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
};
|
|
1179
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1180
|
+
502: {
|
|
1181
|
+
headers: {
|
|
1182
|
+
[name: string]: unknown;
|
|
1183
|
+
};
|
|
1184
|
+
content: {
|
|
1185
|
+
"application/json": {
|
|
1186
|
+
error: {
|
|
1187
|
+
code: string;
|
|
1188
|
+
message: string;
|
|
1189
|
+
};
|
|
1190
|
+
requestId: string;
|
|
1191
|
+
};
|
|
1192
|
+
};
|
|
1193
|
+
};
|
|
1194
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1195
|
+
503: {
|
|
1196
|
+
headers: {
|
|
1197
|
+
[name: string]: unknown;
|
|
1198
|
+
};
|
|
1199
|
+
content: {
|
|
1200
|
+
"application/json": {
|
|
1201
|
+
error: {
|
|
1202
|
+
code: string;
|
|
1203
|
+
message: string;
|
|
1204
|
+
};
|
|
1205
|
+
requestId: string;
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
};
|
|
1209
|
+
};
|
|
1210
|
+
};
|
|
1211
|
+
getProcessingJob: {
|
|
1212
|
+
parameters: {
|
|
1213
|
+
query?: never;
|
|
1214
|
+
header?: never;
|
|
1215
|
+
path: {
|
|
1216
|
+
jobId: string;
|
|
1217
|
+
};
|
|
1218
|
+
cookie?: never;
|
|
1219
|
+
};
|
|
1220
|
+
requestBody?: never;
|
|
1221
|
+
responses: {
|
|
1222
|
+
/** @description Job status */
|
|
1223
|
+
200: {
|
|
1224
|
+
headers: {
|
|
1225
|
+
[name: string]: unknown;
|
|
1226
|
+
};
|
|
1227
|
+
content: {
|
|
1228
|
+
"application/json": {
|
|
1229
|
+
/** Format: uuid */
|
|
1230
|
+
jobId: string;
|
|
1231
|
+
/** @enum {string} */
|
|
1232
|
+
operation: "convert" | "import" | "ocr";
|
|
1233
|
+
generation: number;
|
|
1234
|
+
/** @enum {string} */
|
|
1235
|
+
status: "queued" | "running" | "succeeded" | "failed" | "cancelling" | "cancelled";
|
|
1236
|
+
/** @enum {string} */
|
|
1237
|
+
stage: "persist-input" | "process-file";
|
|
1238
|
+
revision: number;
|
|
1239
|
+
createdAt: number;
|
|
1240
|
+
updatedAt: number;
|
|
1241
|
+
deadlineAt: number;
|
|
1242
|
+
retryAt: number | null;
|
|
1243
|
+
errorCode: string | null;
|
|
1244
|
+
statistics: {
|
|
1245
|
+
inputBytes: number;
|
|
1246
|
+
outputBytes: number;
|
|
1247
|
+
records: number;
|
|
1248
|
+
rejected: number;
|
|
1249
|
+
};
|
|
1250
|
+
artifacts: {
|
|
1251
|
+
/** Format: uuid */
|
|
1252
|
+
artifactId: string;
|
|
1253
|
+
/** @enum {string} */
|
|
1254
|
+
kind: "result" | "report";
|
|
1255
|
+
bytes: number;
|
|
1256
|
+
contentType: string;
|
|
1257
|
+
etag: string;
|
|
1258
|
+
expiresAt: number;
|
|
1259
|
+
}[];
|
|
1260
|
+
};
|
|
1261
|
+
};
|
|
1262
|
+
};
|
|
1263
|
+
/** @description Unchanged */
|
|
1264
|
+
304: {
|
|
1265
|
+
headers: {
|
|
1266
|
+
[name: string]: unknown;
|
|
1267
|
+
};
|
|
1268
|
+
content?: never;
|
|
1269
|
+
};
|
|
1270
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1271
|
+
400: {
|
|
1272
|
+
headers: {
|
|
1273
|
+
[name: string]: unknown;
|
|
1274
|
+
};
|
|
1275
|
+
content: {
|
|
1276
|
+
"application/json": {
|
|
1277
|
+
error: {
|
|
1278
|
+
code: string;
|
|
1279
|
+
message: string;
|
|
1280
|
+
};
|
|
1281
|
+
requestId: string;
|
|
1282
|
+
};
|
|
1283
|
+
};
|
|
1284
|
+
};
|
|
1285
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1286
|
+
401: {
|
|
1287
|
+
headers: {
|
|
1288
|
+
[name: string]: unknown;
|
|
1289
|
+
};
|
|
1290
|
+
content: {
|
|
1291
|
+
"application/json": {
|
|
1292
|
+
error: {
|
|
1293
|
+
code: string;
|
|
1294
|
+
message: string;
|
|
1295
|
+
};
|
|
1296
|
+
requestId: string;
|
|
1297
|
+
};
|
|
1298
|
+
};
|
|
1299
|
+
};
|
|
1300
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1301
|
+
403: {
|
|
1302
|
+
headers: {
|
|
1303
|
+
[name: string]: unknown;
|
|
1304
|
+
};
|
|
1305
|
+
content: {
|
|
1306
|
+
"application/json": {
|
|
1307
|
+
error: {
|
|
1308
|
+
code: string;
|
|
1309
|
+
message: string;
|
|
1310
|
+
};
|
|
1311
|
+
requestId: string;
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
};
|
|
1315
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1316
|
+
404: {
|
|
1317
|
+
headers: {
|
|
1318
|
+
[name: string]: unknown;
|
|
1319
|
+
};
|
|
1320
|
+
content: {
|
|
1321
|
+
"application/json": {
|
|
1322
|
+
error: {
|
|
1323
|
+
code: string;
|
|
1324
|
+
message: string;
|
|
1325
|
+
};
|
|
1326
|
+
requestId: string;
|
|
1327
|
+
};
|
|
1328
|
+
};
|
|
1329
|
+
};
|
|
1330
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1331
|
+
409: {
|
|
1332
|
+
headers: {
|
|
1333
|
+
[name: string]: unknown;
|
|
1334
|
+
};
|
|
1335
|
+
content: {
|
|
1336
|
+
"application/json": {
|
|
1337
|
+
error: {
|
|
1338
|
+
code: string;
|
|
1339
|
+
message: string;
|
|
1340
|
+
};
|
|
1341
|
+
requestId: string;
|
|
1342
|
+
};
|
|
1343
|
+
};
|
|
1344
|
+
};
|
|
1345
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1346
|
+
410: {
|
|
1347
|
+
headers: {
|
|
1348
|
+
[name: string]: unknown;
|
|
1349
|
+
};
|
|
1350
|
+
content: {
|
|
1351
|
+
"application/json": {
|
|
1352
|
+
error: {
|
|
1353
|
+
code: string;
|
|
1354
|
+
message: string;
|
|
1355
|
+
};
|
|
1356
|
+
requestId: string;
|
|
1357
|
+
};
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1361
|
+
413: {
|
|
1362
|
+
headers: {
|
|
1363
|
+
[name: string]: unknown;
|
|
1364
|
+
};
|
|
1365
|
+
content: {
|
|
1366
|
+
"application/json": {
|
|
1367
|
+
error: {
|
|
1368
|
+
code: string;
|
|
1369
|
+
message: string;
|
|
1370
|
+
};
|
|
1371
|
+
requestId: string;
|
|
1372
|
+
};
|
|
1373
|
+
};
|
|
1374
|
+
};
|
|
1375
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1376
|
+
415: {
|
|
1377
|
+
headers: {
|
|
1378
|
+
[name: string]: unknown;
|
|
1379
|
+
};
|
|
1380
|
+
content: {
|
|
1381
|
+
"application/json": {
|
|
1382
|
+
error: {
|
|
1383
|
+
code: string;
|
|
1384
|
+
message: string;
|
|
1385
|
+
};
|
|
1386
|
+
requestId: string;
|
|
1387
|
+
};
|
|
1388
|
+
};
|
|
1389
|
+
};
|
|
1390
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1391
|
+
422: {
|
|
1392
|
+
headers: {
|
|
1393
|
+
[name: string]: unknown;
|
|
1394
|
+
};
|
|
1395
|
+
content: {
|
|
1396
|
+
"application/json": {
|
|
1397
|
+
error: {
|
|
1398
|
+
code: string;
|
|
1399
|
+
message: string;
|
|
1400
|
+
};
|
|
1401
|
+
requestId: string;
|
|
1402
|
+
};
|
|
1403
|
+
};
|
|
1404
|
+
};
|
|
1405
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1406
|
+
429: {
|
|
1407
|
+
headers: {
|
|
1408
|
+
[name: string]: unknown;
|
|
1409
|
+
};
|
|
1410
|
+
content: {
|
|
1411
|
+
"application/json": {
|
|
1412
|
+
error: {
|
|
1413
|
+
code: string;
|
|
1414
|
+
message: string;
|
|
1415
|
+
};
|
|
1416
|
+
requestId: string;
|
|
1417
|
+
};
|
|
1418
|
+
};
|
|
1419
|
+
};
|
|
1420
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1421
|
+
500: {
|
|
1422
|
+
headers: {
|
|
1423
|
+
[name: string]: unknown;
|
|
1424
|
+
};
|
|
1425
|
+
content: {
|
|
1426
|
+
"application/json": {
|
|
1427
|
+
error: {
|
|
1428
|
+
code: string;
|
|
1429
|
+
message: string;
|
|
1430
|
+
};
|
|
1431
|
+
requestId: string;
|
|
1432
|
+
};
|
|
1433
|
+
};
|
|
1434
|
+
};
|
|
1435
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1436
|
+
502: {
|
|
1437
|
+
headers: {
|
|
1438
|
+
[name: string]: unknown;
|
|
1439
|
+
};
|
|
1440
|
+
content: {
|
|
1441
|
+
"application/json": {
|
|
1442
|
+
error: {
|
|
1443
|
+
code: string;
|
|
1444
|
+
message: string;
|
|
1445
|
+
};
|
|
1446
|
+
requestId: string;
|
|
1447
|
+
};
|
|
1448
|
+
};
|
|
1449
|
+
};
|
|
1450
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1451
|
+
503: {
|
|
1452
|
+
headers: {
|
|
1453
|
+
[name: string]: unknown;
|
|
1454
|
+
};
|
|
1455
|
+
content: {
|
|
1456
|
+
"application/json": {
|
|
1457
|
+
error: {
|
|
1458
|
+
code: string;
|
|
1459
|
+
message: string;
|
|
1460
|
+
};
|
|
1461
|
+
requestId: string;
|
|
1462
|
+
};
|
|
1463
|
+
};
|
|
1464
|
+
};
|
|
1465
|
+
};
|
|
1466
|
+
};
|
|
1467
|
+
cancelProcessingJob: {
|
|
1468
|
+
parameters: {
|
|
1469
|
+
query?: never;
|
|
1470
|
+
header?: never;
|
|
1471
|
+
path: {
|
|
1472
|
+
jobId: string;
|
|
1473
|
+
};
|
|
1474
|
+
cookie?: never;
|
|
1475
|
+
};
|
|
1476
|
+
requestBody: {
|
|
1477
|
+
content: {
|
|
1478
|
+
"application/json": Record<string, never>;
|
|
1479
|
+
};
|
|
1480
|
+
};
|
|
1481
|
+
responses: {
|
|
1482
|
+
/** @description Success */
|
|
1483
|
+
200: {
|
|
1484
|
+
headers: {
|
|
1485
|
+
[name: string]: unknown;
|
|
1486
|
+
};
|
|
1487
|
+
content: {
|
|
1488
|
+
"application/json": {
|
|
1489
|
+
/** Format: uuid */
|
|
1490
|
+
jobId: string;
|
|
1491
|
+
/** @enum {string} */
|
|
1492
|
+
operation: "convert" | "import" | "ocr";
|
|
1493
|
+
generation: number;
|
|
1494
|
+
/** @enum {string} */
|
|
1495
|
+
status: "queued" | "running" | "succeeded" | "failed" | "cancelling" | "cancelled";
|
|
1496
|
+
/** @enum {string} */
|
|
1497
|
+
stage: "persist-input" | "process-file";
|
|
1498
|
+
revision: number;
|
|
1499
|
+
createdAt: number;
|
|
1500
|
+
updatedAt: number;
|
|
1501
|
+
deadlineAt: number;
|
|
1502
|
+
retryAt: number | null;
|
|
1503
|
+
errorCode: string | null;
|
|
1504
|
+
statistics: {
|
|
1505
|
+
inputBytes: number;
|
|
1506
|
+
outputBytes: number;
|
|
1507
|
+
records: number;
|
|
1508
|
+
rejected: number;
|
|
1509
|
+
};
|
|
1510
|
+
artifacts: {
|
|
1511
|
+
/** Format: uuid */
|
|
1512
|
+
artifactId: string;
|
|
1513
|
+
/** @enum {string} */
|
|
1514
|
+
kind: "result" | "report";
|
|
1515
|
+
bytes: number;
|
|
1516
|
+
contentType: string;
|
|
1517
|
+
etag: string;
|
|
1518
|
+
expiresAt: number;
|
|
1519
|
+
}[];
|
|
1520
|
+
};
|
|
1521
|
+
};
|
|
1522
|
+
};
|
|
1523
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1524
|
+
400: {
|
|
1525
|
+
headers: {
|
|
1526
|
+
[name: string]: unknown;
|
|
1527
|
+
};
|
|
1528
|
+
content: {
|
|
1529
|
+
"application/json": {
|
|
1530
|
+
error: {
|
|
1531
|
+
code: string;
|
|
1532
|
+
message: string;
|
|
1533
|
+
};
|
|
1534
|
+
requestId: string;
|
|
1535
|
+
};
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1539
|
+
401: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
"application/json": {
|
|
1545
|
+
error: {
|
|
1546
|
+
code: string;
|
|
1547
|
+
message: string;
|
|
1548
|
+
};
|
|
1549
|
+
requestId: string;
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
};
|
|
1553
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1554
|
+
403: {
|
|
1555
|
+
headers: {
|
|
1556
|
+
[name: string]: unknown;
|
|
1557
|
+
};
|
|
1558
|
+
content: {
|
|
1559
|
+
"application/json": {
|
|
1560
|
+
error: {
|
|
1561
|
+
code: string;
|
|
1562
|
+
message: string;
|
|
1563
|
+
};
|
|
1564
|
+
requestId: string;
|
|
1565
|
+
};
|
|
1566
|
+
};
|
|
1567
|
+
};
|
|
1568
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1569
|
+
404: {
|
|
1570
|
+
headers: {
|
|
1571
|
+
[name: string]: unknown;
|
|
1572
|
+
};
|
|
1573
|
+
content: {
|
|
1574
|
+
"application/json": {
|
|
1575
|
+
error: {
|
|
1576
|
+
code: string;
|
|
1577
|
+
message: string;
|
|
1578
|
+
};
|
|
1579
|
+
requestId: string;
|
|
1580
|
+
};
|
|
1581
|
+
};
|
|
1582
|
+
};
|
|
1583
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1584
|
+
409: {
|
|
1585
|
+
headers: {
|
|
1586
|
+
[name: string]: unknown;
|
|
1587
|
+
};
|
|
1588
|
+
content: {
|
|
1589
|
+
"application/json": {
|
|
1590
|
+
error: {
|
|
1591
|
+
code: string;
|
|
1592
|
+
message: string;
|
|
1593
|
+
};
|
|
1594
|
+
requestId: string;
|
|
1595
|
+
};
|
|
1596
|
+
};
|
|
1597
|
+
};
|
|
1598
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1599
|
+
410: {
|
|
1600
|
+
headers: {
|
|
1601
|
+
[name: string]: unknown;
|
|
1602
|
+
};
|
|
1603
|
+
content: {
|
|
1604
|
+
"application/json": {
|
|
1605
|
+
error: {
|
|
1606
|
+
code: string;
|
|
1607
|
+
message: string;
|
|
1608
|
+
};
|
|
1609
|
+
requestId: string;
|
|
1610
|
+
};
|
|
1611
|
+
};
|
|
1612
|
+
};
|
|
1613
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1614
|
+
413: {
|
|
1615
|
+
headers: {
|
|
1616
|
+
[name: string]: unknown;
|
|
1617
|
+
};
|
|
1618
|
+
content: {
|
|
1619
|
+
"application/json": {
|
|
1620
|
+
error: {
|
|
1621
|
+
code: string;
|
|
1622
|
+
message: string;
|
|
1623
|
+
};
|
|
1624
|
+
requestId: string;
|
|
1625
|
+
};
|
|
1626
|
+
};
|
|
1627
|
+
};
|
|
1628
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1629
|
+
415: {
|
|
1630
|
+
headers: {
|
|
1631
|
+
[name: string]: unknown;
|
|
1632
|
+
};
|
|
1633
|
+
content: {
|
|
1634
|
+
"application/json": {
|
|
1635
|
+
error: {
|
|
1636
|
+
code: string;
|
|
1637
|
+
message: string;
|
|
1638
|
+
};
|
|
1639
|
+
requestId: string;
|
|
1640
|
+
};
|
|
1641
|
+
};
|
|
1642
|
+
};
|
|
1643
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1644
|
+
422: {
|
|
1645
|
+
headers: {
|
|
1646
|
+
[name: string]: unknown;
|
|
1647
|
+
};
|
|
1648
|
+
content: {
|
|
1649
|
+
"application/json": {
|
|
1650
|
+
error: {
|
|
1651
|
+
code: string;
|
|
1652
|
+
message: string;
|
|
1653
|
+
};
|
|
1654
|
+
requestId: string;
|
|
1655
|
+
};
|
|
1656
|
+
};
|
|
1657
|
+
};
|
|
1658
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1659
|
+
429: {
|
|
1660
|
+
headers: {
|
|
1661
|
+
[name: string]: unknown;
|
|
1662
|
+
};
|
|
1663
|
+
content: {
|
|
1664
|
+
"application/json": {
|
|
1665
|
+
error: {
|
|
1666
|
+
code: string;
|
|
1667
|
+
message: string;
|
|
1668
|
+
};
|
|
1669
|
+
requestId: string;
|
|
1670
|
+
};
|
|
1671
|
+
};
|
|
1672
|
+
};
|
|
1673
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1674
|
+
500: {
|
|
1675
|
+
headers: {
|
|
1676
|
+
[name: string]: unknown;
|
|
1677
|
+
};
|
|
1678
|
+
content: {
|
|
1679
|
+
"application/json": {
|
|
1680
|
+
error: {
|
|
1681
|
+
code: string;
|
|
1682
|
+
message: string;
|
|
1683
|
+
};
|
|
1684
|
+
requestId: string;
|
|
1685
|
+
};
|
|
1686
|
+
};
|
|
1687
|
+
};
|
|
1688
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1689
|
+
502: {
|
|
1690
|
+
headers: {
|
|
1691
|
+
[name: string]: unknown;
|
|
1692
|
+
};
|
|
1693
|
+
content: {
|
|
1694
|
+
"application/json": {
|
|
1695
|
+
error: {
|
|
1696
|
+
code: string;
|
|
1697
|
+
message: string;
|
|
1698
|
+
};
|
|
1699
|
+
requestId: string;
|
|
1700
|
+
};
|
|
1701
|
+
};
|
|
1702
|
+
};
|
|
1703
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1704
|
+
503: {
|
|
1705
|
+
headers: {
|
|
1706
|
+
[name: string]: unknown;
|
|
1707
|
+
};
|
|
1708
|
+
content: {
|
|
1709
|
+
"application/json": {
|
|
1710
|
+
error: {
|
|
1711
|
+
code: string;
|
|
1712
|
+
message: string;
|
|
1713
|
+
};
|
|
1714
|
+
requestId: string;
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
};
|
|
1718
|
+
};
|
|
1719
|
+
};
|
|
1720
|
+
retryProcessingJob: {
|
|
1721
|
+
parameters: {
|
|
1722
|
+
query?: never;
|
|
1723
|
+
header?: never;
|
|
1724
|
+
path: {
|
|
1725
|
+
jobId: string;
|
|
1726
|
+
};
|
|
1727
|
+
cookie?: never;
|
|
1728
|
+
};
|
|
1729
|
+
requestBody: {
|
|
1730
|
+
content: {
|
|
1731
|
+
"application/json": {
|
|
1732
|
+
expectedGeneration: number;
|
|
1733
|
+
};
|
|
1734
|
+
};
|
|
1735
|
+
};
|
|
1736
|
+
responses: {
|
|
1737
|
+
/** @description Success */
|
|
1738
|
+
202: {
|
|
1739
|
+
headers: {
|
|
1740
|
+
[name: string]: unknown;
|
|
1741
|
+
};
|
|
1742
|
+
content: {
|
|
1743
|
+
"application/json": {
|
|
1744
|
+
/** Format: uuid */
|
|
1745
|
+
jobId: string;
|
|
1746
|
+
/** @enum {string} */
|
|
1747
|
+
operation: "convert" | "import" | "ocr";
|
|
1748
|
+
generation: number;
|
|
1749
|
+
/** @enum {string} */
|
|
1750
|
+
status: "queued" | "running" | "succeeded" | "failed" | "cancelling" | "cancelled";
|
|
1751
|
+
/** @enum {string} */
|
|
1752
|
+
stage: "persist-input" | "process-file";
|
|
1753
|
+
revision: number;
|
|
1754
|
+
createdAt: number;
|
|
1755
|
+
updatedAt: number;
|
|
1756
|
+
deadlineAt: number;
|
|
1757
|
+
retryAt: number | null;
|
|
1758
|
+
errorCode: string | null;
|
|
1759
|
+
statistics: {
|
|
1760
|
+
inputBytes: number;
|
|
1761
|
+
outputBytes: number;
|
|
1762
|
+
records: number;
|
|
1763
|
+
rejected: number;
|
|
1764
|
+
};
|
|
1765
|
+
artifacts: {
|
|
1766
|
+
/** Format: uuid */
|
|
1767
|
+
artifactId: string;
|
|
1768
|
+
/** @enum {string} */
|
|
1769
|
+
kind: "result" | "report";
|
|
1770
|
+
bytes: number;
|
|
1771
|
+
contentType: string;
|
|
1772
|
+
etag: string;
|
|
1773
|
+
expiresAt: number;
|
|
1774
|
+
}[];
|
|
1775
|
+
};
|
|
1776
|
+
};
|
|
1777
|
+
};
|
|
1778
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1779
|
+
400: {
|
|
1780
|
+
headers: {
|
|
1781
|
+
[name: string]: unknown;
|
|
1782
|
+
};
|
|
1783
|
+
content: {
|
|
1784
|
+
"application/json": {
|
|
1785
|
+
error: {
|
|
1786
|
+
code: string;
|
|
1787
|
+
message: string;
|
|
1788
|
+
};
|
|
1789
|
+
requestId: string;
|
|
1790
|
+
};
|
|
1791
|
+
};
|
|
1792
|
+
};
|
|
1793
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1794
|
+
401: {
|
|
1795
|
+
headers: {
|
|
1796
|
+
[name: string]: unknown;
|
|
1797
|
+
};
|
|
1798
|
+
content: {
|
|
1799
|
+
"application/json": {
|
|
1800
|
+
error: {
|
|
1801
|
+
code: string;
|
|
1802
|
+
message: string;
|
|
1803
|
+
};
|
|
1804
|
+
requestId: string;
|
|
1805
|
+
};
|
|
1806
|
+
};
|
|
1807
|
+
};
|
|
1808
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1809
|
+
403: {
|
|
1810
|
+
headers: {
|
|
1811
|
+
[name: string]: unknown;
|
|
1812
|
+
};
|
|
1813
|
+
content: {
|
|
1814
|
+
"application/json": {
|
|
1815
|
+
error: {
|
|
1816
|
+
code: string;
|
|
1817
|
+
message: string;
|
|
1818
|
+
};
|
|
1819
|
+
requestId: string;
|
|
1820
|
+
};
|
|
1821
|
+
};
|
|
1822
|
+
};
|
|
1823
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1824
|
+
404: {
|
|
1825
|
+
headers: {
|
|
1826
|
+
[name: string]: unknown;
|
|
1827
|
+
};
|
|
1828
|
+
content: {
|
|
1829
|
+
"application/json": {
|
|
1830
|
+
error: {
|
|
1831
|
+
code: string;
|
|
1832
|
+
message: string;
|
|
1833
|
+
};
|
|
1834
|
+
requestId: string;
|
|
1835
|
+
};
|
|
1836
|
+
};
|
|
1837
|
+
};
|
|
1838
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1839
|
+
409: {
|
|
1840
|
+
headers: {
|
|
1841
|
+
[name: string]: unknown;
|
|
1842
|
+
};
|
|
1843
|
+
content: {
|
|
1844
|
+
"application/json": {
|
|
1845
|
+
error: {
|
|
1846
|
+
code: string;
|
|
1847
|
+
message: string;
|
|
1848
|
+
};
|
|
1849
|
+
requestId: string;
|
|
1850
|
+
};
|
|
1851
|
+
};
|
|
1852
|
+
};
|
|
1853
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1854
|
+
410: {
|
|
1855
|
+
headers: {
|
|
1856
|
+
[name: string]: unknown;
|
|
1857
|
+
};
|
|
1858
|
+
content: {
|
|
1859
|
+
"application/json": {
|
|
1860
|
+
error: {
|
|
1861
|
+
code: string;
|
|
1862
|
+
message: string;
|
|
1863
|
+
};
|
|
1864
|
+
requestId: string;
|
|
1865
|
+
};
|
|
1866
|
+
};
|
|
1867
|
+
};
|
|
1868
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1869
|
+
413: {
|
|
1870
|
+
headers: {
|
|
1871
|
+
[name: string]: unknown;
|
|
1872
|
+
};
|
|
1873
|
+
content: {
|
|
1874
|
+
"application/json": {
|
|
1875
|
+
error: {
|
|
1876
|
+
code: string;
|
|
1877
|
+
message: string;
|
|
1878
|
+
};
|
|
1879
|
+
requestId: string;
|
|
1880
|
+
};
|
|
1881
|
+
};
|
|
1882
|
+
};
|
|
1883
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1884
|
+
415: {
|
|
1885
|
+
headers: {
|
|
1886
|
+
[name: string]: unknown;
|
|
1887
|
+
};
|
|
1888
|
+
content: {
|
|
1889
|
+
"application/json": {
|
|
1890
|
+
error: {
|
|
1891
|
+
code: string;
|
|
1892
|
+
message: string;
|
|
1893
|
+
};
|
|
1894
|
+
requestId: string;
|
|
1895
|
+
};
|
|
1896
|
+
};
|
|
1897
|
+
};
|
|
1898
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1899
|
+
422: {
|
|
1900
|
+
headers: {
|
|
1901
|
+
[name: string]: unknown;
|
|
1902
|
+
};
|
|
1903
|
+
content: {
|
|
1904
|
+
"application/json": {
|
|
1905
|
+
error: {
|
|
1906
|
+
code: string;
|
|
1907
|
+
message: string;
|
|
1908
|
+
};
|
|
1909
|
+
requestId: string;
|
|
1910
|
+
};
|
|
1911
|
+
};
|
|
1912
|
+
};
|
|
1913
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1914
|
+
429: {
|
|
1915
|
+
headers: {
|
|
1916
|
+
[name: string]: unknown;
|
|
1917
|
+
};
|
|
1918
|
+
content: {
|
|
1919
|
+
"application/json": {
|
|
1920
|
+
error: {
|
|
1921
|
+
code: string;
|
|
1922
|
+
message: string;
|
|
1923
|
+
};
|
|
1924
|
+
requestId: string;
|
|
1925
|
+
};
|
|
1926
|
+
};
|
|
1927
|
+
};
|
|
1928
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1929
|
+
500: {
|
|
1930
|
+
headers: {
|
|
1931
|
+
[name: string]: unknown;
|
|
1932
|
+
};
|
|
1933
|
+
content: {
|
|
1934
|
+
"application/json": {
|
|
1935
|
+
error: {
|
|
1936
|
+
code: string;
|
|
1937
|
+
message: string;
|
|
1938
|
+
};
|
|
1939
|
+
requestId: string;
|
|
1940
|
+
};
|
|
1941
|
+
};
|
|
1942
|
+
};
|
|
1943
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1944
|
+
502: {
|
|
1945
|
+
headers: {
|
|
1946
|
+
[name: string]: unknown;
|
|
1947
|
+
};
|
|
1948
|
+
content: {
|
|
1949
|
+
"application/json": {
|
|
1950
|
+
error: {
|
|
1951
|
+
code: string;
|
|
1952
|
+
message: string;
|
|
1953
|
+
};
|
|
1954
|
+
requestId: string;
|
|
1955
|
+
};
|
|
1956
|
+
};
|
|
1957
|
+
};
|
|
1958
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
1959
|
+
503: {
|
|
1960
|
+
headers: {
|
|
1961
|
+
[name: string]: unknown;
|
|
1962
|
+
};
|
|
1963
|
+
content: {
|
|
1964
|
+
"application/json": {
|
|
1965
|
+
error: {
|
|
1966
|
+
code: string;
|
|
1967
|
+
message: string;
|
|
1968
|
+
};
|
|
1969
|
+
requestId: string;
|
|
1970
|
+
};
|
|
1971
|
+
};
|
|
1972
|
+
};
|
|
1973
|
+
};
|
|
1974
|
+
};
|
|
1975
|
+
downloadProcessingArtifact: {
|
|
1976
|
+
parameters: {
|
|
1977
|
+
query?: never;
|
|
1978
|
+
header?: never;
|
|
1979
|
+
path: {
|
|
1980
|
+
jobId: string;
|
|
1981
|
+
artifactId: string;
|
|
1982
|
+
};
|
|
1983
|
+
cookie?: never;
|
|
1984
|
+
};
|
|
1985
|
+
requestBody?: never;
|
|
1986
|
+
responses: {
|
|
1987
|
+
/** @description Complete artifact */
|
|
1988
|
+
200: {
|
|
1989
|
+
headers: {
|
|
1990
|
+
[name: string]: unknown;
|
|
1991
|
+
};
|
|
1992
|
+
content: {
|
|
1993
|
+
"application/octet-stream": string;
|
|
1994
|
+
};
|
|
1995
|
+
};
|
|
1996
|
+
/** @description Partial artifact */
|
|
1997
|
+
206: {
|
|
1998
|
+
headers: {
|
|
1999
|
+
[name: string]: unknown;
|
|
2000
|
+
};
|
|
2001
|
+
content?: never;
|
|
2002
|
+
};
|
|
2003
|
+
/** @description Unchanged */
|
|
2004
|
+
304: {
|
|
2005
|
+
headers: {
|
|
2006
|
+
[name: string]: unknown;
|
|
2007
|
+
};
|
|
2008
|
+
content?: never;
|
|
2009
|
+
};
|
|
2010
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2011
|
+
400: {
|
|
2012
|
+
headers: {
|
|
2013
|
+
[name: string]: unknown;
|
|
2014
|
+
};
|
|
2015
|
+
content: {
|
|
2016
|
+
"application/json": {
|
|
2017
|
+
error: {
|
|
2018
|
+
code: string;
|
|
2019
|
+
message: string;
|
|
2020
|
+
};
|
|
2021
|
+
requestId: string;
|
|
2022
|
+
};
|
|
2023
|
+
};
|
|
2024
|
+
};
|
|
2025
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2026
|
+
401: {
|
|
2027
|
+
headers: {
|
|
2028
|
+
[name: string]: unknown;
|
|
2029
|
+
};
|
|
2030
|
+
content: {
|
|
2031
|
+
"application/json": {
|
|
2032
|
+
error: {
|
|
2033
|
+
code: string;
|
|
2034
|
+
message: string;
|
|
2035
|
+
};
|
|
2036
|
+
requestId: string;
|
|
2037
|
+
};
|
|
2038
|
+
};
|
|
2039
|
+
};
|
|
2040
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2041
|
+
403: {
|
|
2042
|
+
headers: {
|
|
2043
|
+
[name: string]: unknown;
|
|
2044
|
+
};
|
|
2045
|
+
content: {
|
|
2046
|
+
"application/json": {
|
|
2047
|
+
error: {
|
|
2048
|
+
code: string;
|
|
2049
|
+
message: string;
|
|
2050
|
+
};
|
|
2051
|
+
requestId: string;
|
|
2052
|
+
};
|
|
2053
|
+
};
|
|
2054
|
+
};
|
|
2055
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2056
|
+
404: {
|
|
2057
|
+
headers: {
|
|
2058
|
+
[name: string]: unknown;
|
|
2059
|
+
};
|
|
2060
|
+
content: {
|
|
2061
|
+
"application/json": {
|
|
2062
|
+
error: {
|
|
2063
|
+
code: string;
|
|
2064
|
+
message: string;
|
|
2065
|
+
};
|
|
2066
|
+
requestId: string;
|
|
2067
|
+
};
|
|
2068
|
+
};
|
|
2069
|
+
};
|
|
2070
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2071
|
+
409: {
|
|
2072
|
+
headers: {
|
|
2073
|
+
[name: string]: unknown;
|
|
2074
|
+
};
|
|
2075
|
+
content: {
|
|
2076
|
+
"application/json": {
|
|
2077
|
+
error: {
|
|
2078
|
+
code: string;
|
|
2079
|
+
message: string;
|
|
2080
|
+
};
|
|
2081
|
+
requestId: string;
|
|
2082
|
+
};
|
|
2083
|
+
};
|
|
2084
|
+
};
|
|
2085
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2086
|
+
410: {
|
|
2087
|
+
headers: {
|
|
2088
|
+
[name: string]: unknown;
|
|
2089
|
+
};
|
|
2090
|
+
content: {
|
|
2091
|
+
"application/json": {
|
|
2092
|
+
error: {
|
|
2093
|
+
code: string;
|
|
2094
|
+
message: string;
|
|
2095
|
+
};
|
|
2096
|
+
requestId: string;
|
|
2097
|
+
};
|
|
2098
|
+
};
|
|
2099
|
+
};
|
|
2100
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2101
|
+
413: {
|
|
2102
|
+
headers: {
|
|
2103
|
+
[name: string]: unknown;
|
|
2104
|
+
};
|
|
2105
|
+
content: {
|
|
2106
|
+
"application/json": {
|
|
2107
|
+
error: {
|
|
2108
|
+
code: string;
|
|
2109
|
+
message: string;
|
|
2110
|
+
};
|
|
2111
|
+
requestId: string;
|
|
2112
|
+
};
|
|
2113
|
+
};
|
|
2114
|
+
};
|
|
2115
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2116
|
+
415: {
|
|
2117
|
+
headers: {
|
|
2118
|
+
[name: string]: unknown;
|
|
2119
|
+
};
|
|
2120
|
+
content: {
|
|
2121
|
+
"application/json": {
|
|
2122
|
+
error: {
|
|
2123
|
+
code: string;
|
|
2124
|
+
message: string;
|
|
2125
|
+
};
|
|
2126
|
+
requestId: string;
|
|
2127
|
+
};
|
|
2128
|
+
};
|
|
2129
|
+
};
|
|
2130
|
+
/** @description Invalid range */
|
|
2131
|
+
416: {
|
|
2132
|
+
headers: {
|
|
2133
|
+
[name: string]: unknown;
|
|
2134
|
+
};
|
|
2135
|
+
content?: never;
|
|
2136
|
+
};
|
|
2137
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2138
|
+
422: {
|
|
2139
|
+
headers: {
|
|
2140
|
+
[name: string]: unknown;
|
|
2141
|
+
};
|
|
2142
|
+
content: {
|
|
2143
|
+
"application/json": {
|
|
2144
|
+
error: {
|
|
2145
|
+
code: string;
|
|
2146
|
+
message: string;
|
|
2147
|
+
};
|
|
2148
|
+
requestId: string;
|
|
2149
|
+
};
|
|
2150
|
+
};
|
|
2151
|
+
};
|
|
2152
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2153
|
+
429: {
|
|
2154
|
+
headers: {
|
|
2155
|
+
[name: string]: unknown;
|
|
2156
|
+
};
|
|
2157
|
+
content: {
|
|
2158
|
+
"application/json": {
|
|
2159
|
+
error: {
|
|
2160
|
+
code: string;
|
|
2161
|
+
message: string;
|
|
2162
|
+
};
|
|
2163
|
+
requestId: string;
|
|
2164
|
+
};
|
|
2165
|
+
};
|
|
2166
|
+
};
|
|
2167
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2168
|
+
500: {
|
|
2169
|
+
headers: {
|
|
2170
|
+
[name: string]: unknown;
|
|
2171
|
+
};
|
|
2172
|
+
content: {
|
|
2173
|
+
"application/json": {
|
|
2174
|
+
error: {
|
|
2175
|
+
code: string;
|
|
2176
|
+
message: string;
|
|
2177
|
+
};
|
|
2178
|
+
requestId: string;
|
|
2179
|
+
};
|
|
2180
|
+
};
|
|
2181
|
+
};
|
|
2182
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2183
|
+
502: {
|
|
2184
|
+
headers: {
|
|
2185
|
+
[name: string]: unknown;
|
|
2186
|
+
};
|
|
2187
|
+
content: {
|
|
2188
|
+
"application/json": {
|
|
2189
|
+
error: {
|
|
2190
|
+
code: string;
|
|
2191
|
+
message: string;
|
|
2192
|
+
};
|
|
2193
|
+
requestId: string;
|
|
2194
|
+
};
|
|
2195
|
+
};
|
|
2196
|
+
};
|
|
2197
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2198
|
+
503: {
|
|
2199
|
+
headers: {
|
|
2200
|
+
[name: string]: unknown;
|
|
2201
|
+
};
|
|
2202
|
+
content: {
|
|
2203
|
+
"application/json": {
|
|
2204
|
+
error: {
|
|
2205
|
+
code: string;
|
|
2206
|
+
message: string;
|
|
2207
|
+
};
|
|
2208
|
+
requestId: string;
|
|
2209
|
+
};
|
|
2210
|
+
};
|
|
2211
|
+
};
|
|
2212
|
+
};
|
|
2213
|
+
};
|
|
2214
|
+
setProcessingScopes: {
|
|
2215
|
+
parameters: {
|
|
2216
|
+
query?: never;
|
|
2217
|
+
header?: never;
|
|
2218
|
+
path: {
|
|
2219
|
+
credentialId: string;
|
|
2220
|
+
};
|
|
2221
|
+
cookie?: never;
|
|
2222
|
+
};
|
|
2223
|
+
requestBody: {
|
|
2224
|
+
content: {
|
|
2225
|
+
"application/json": {
|
|
2226
|
+
operations: ("convert" | "ocr")[];
|
|
2227
|
+
};
|
|
2228
|
+
};
|
|
2229
|
+
};
|
|
2230
|
+
responses: {
|
|
2231
|
+
/** @description Success */
|
|
2232
|
+
200: {
|
|
2233
|
+
headers: {
|
|
2234
|
+
[name: string]: unknown;
|
|
2235
|
+
};
|
|
2236
|
+
content: {
|
|
2237
|
+
"application/json": {
|
|
2238
|
+
/** @enum {boolean} */
|
|
2239
|
+
ok: true;
|
|
2240
|
+
};
|
|
2241
|
+
};
|
|
2242
|
+
};
|
|
2243
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2244
|
+
400: {
|
|
2245
|
+
headers: {
|
|
2246
|
+
[name: string]: unknown;
|
|
2247
|
+
};
|
|
2248
|
+
content: {
|
|
2249
|
+
"application/json": {
|
|
2250
|
+
error: {
|
|
2251
|
+
code: string;
|
|
2252
|
+
message: string;
|
|
2253
|
+
};
|
|
2254
|
+
requestId: string;
|
|
2255
|
+
};
|
|
2256
|
+
};
|
|
2257
|
+
};
|
|
2258
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2259
|
+
401: {
|
|
2260
|
+
headers: {
|
|
2261
|
+
[name: string]: unknown;
|
|
2262
|
+
};
|
|
2263
|
+
content: {
|
|
2264
|
+
"application/json": {
|
|
2265
|
+
error: {
|
|
2266
|
+
code: string;
|
|
2267
|
+
message: string;
|
|
2268
|
+
};
|
|
2269
|
+
requestId: string;
|
|
2270
|
+
};
|
|
2271
|
+
};
|
|
2272
|
+
};
|
|
2273
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2274
|
+
403: {
|
|
2275
|
+
headers: {
|
|
2276
|
+
[name: string]: unknown;
|
|
2277
|
+
};
|
|
2278
|
+
content: {
|
|
2279
|
+
"application/json": {
|
|
2280
|
+
error: {
|
|
2281
|
+
code: string;
|
|
2282
|
+
message: string;
|
|
2283
|
+
};
|
|
2284
|
+
requestId: string;
|
|
2285
|
+
};
|
|
2286
|
+
};
|
|
2287
|
+
};
|
|
2288
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2289
|
+
404: {
|
|
2290
|
+
headers: {
|
|
2291
|
+
[name: string]: unknown;
|
|
2292
|
+
};
|
|
2293
|
+
content: {
|
|
2294
|
+
"application/json": {
|
|
2295
|
+
error: {
|
|
2296
|
+
code: string;
|
|
2297
|
+
message: string;
|
|
2298
|
+
};
|
|
2299
|
+
requestId: string;
|
|
2300
|
+
};
|
|
2301
|
+
};
|
|
2302
|
+
};
|
|
2303
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2304
|
+
409: {
|
|
2305
|
+
headers: {
|
|
2306
|
+
[name: string]: unknown;
|
|
2307
|
+
};
|
|
2308
|
+
content: {
|
|
2309
|
+
"application/json": {
|
|
2310
|
+
error: {
|
|
2311
|
+
code: string;
|
|
2312
|
+
message: string;
|
|
2313
|
+
};
|
|
2314
|
+
requestId: string;
|
|
2315
|
+
};
|
|
2316
|
+
};
|
|
2317
|
+
};
|
|
2318
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2319
|
+
410: {
|
|
2320
|
+
headers: {
|
|
2321
|
+
[name: string]: unknown;
|
|
2322
|
+
};
|
|
2323
|
+
content: {
|
|
2324
|
+
"application/json": {
|
|
2325
|
+
error: {
|
|
2326
|
+
code: string;
|
|
2327
|
+
message: string;
|
|
2328
|
+
};
|
|
2329
|
+
requestId: string;
|
|
2330
|
+
};
|
|
2331
|
+
};
|
|
2332
|
+
};
|
|
2333
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2334
|
+
413: {
|
|
2335
|
+
headers: {
|
|
2336
|
+
[name: string]: unknown;
|
|
2337
|
+
};
|
|
2338
|
+
content: {
|
|
2339
|
+
"application/json": {
|
|
2340
|
+
error: {
|
|
2341
|
+
code: string;
|
|
2342
|
+
message: string;
|
|
2343
|
+
};
|
|
2344
|
+
requestId: string;
|
|
2345
|
+
};
|
|
2346
|
+
};
|
|
2347
|
+
};
|
|
2348
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2349
|
+
415: {
|
|
2350
|
+
headers: {
|
|
2351
|
+
[name: string]: unknown;
|
|
2352
|
+
};
|
|
2353
|
+
content: {
|
|
2354
|
+
"application/json": {
|
|
2355
|
+
error: {
|
|
2356
|
+
code: string;
|
|
2357
|
+
message: string;
|
|
2358
|
+
};
|
|
2359
|
+
requestId: string;
|
|
2360
|
+
};
|
|
2361
|
+
};
|
|
2362
|
+
};
|
|
2363
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2364
|
+
422: {
|
|
2365
|
+
headers: {
|
|
2366
|
+
[name: string]: unknown;
|
|
2367
|
+
};
|
|
2368
|
+
content: {
|
|
2369
|
+
"application/json": {
|
|
2370
|
+
error: {
|
|
2371
|
+
code: string;
|
|
2372
|
+
message: string;
|
|
2373
|
+
};
|
|
2374
|
+
requestId: string;
|
|
2375
|
+
};
|
|
2376
|
+
};
|
|
2377
|
+
};
|
|
2378
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2379
|
+
429: {
|
|
2380
|
+
headers: {
|
|
2381
|
+
[name: string]: unknown;
|
|
2382
|
+
};
|
|
2383
|
+
content: {
|
|
2384
|
+
"application/json": {
|
|
2385
|
+
error: {
|
|
2386
|
+
code: string;
|
|
2387
|
+
message: string;
|
|
2388
|
+
};
|
|
2389
|
+
requestId: string;
|
|
2390
|
+
};
|
|
2391
|
+
};
|
|
2392
|
+
};
|
|
2393
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2394
|
+
500: {
|
|
2395
|
+
headers: {
|
|
2396
|
+
[name: string]: unknown;
|
|
2397
|
+
};
|
|
2398
|
+
content: {
|
|
2399
|
+
"application/json": {
|
|
2400
|
+
error: {
|
|
2401
|
+
code: string;
|
|
2402
|
+
message: string;
|
|
2403
|
+
};
|
|
2404
|
+
requestId: string;
|
|
2405
|
+
};
|
|
2406
|
+
};
|
|
2407
|
+
};
|
|
2408
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2409
|
+
502: {
|
|
2410
|
+
headers: {
|
|
2411
|
+
[name: string]: unknown;
|
|
2412
|
+
};
|
|
2413
|
+
content: {
|
|
2414
|
+
"application/json": {
|
|
2415
|
+
error: {
|
|
2416
|
+
code: string;
|
|
2417
|
+
message: string;
|
|
2418
|
+
};
|
|
2419
|
+
requestId: string;
|
|
2420
|
+
};
|
|
2421
|
+
};
|
|
2422
|
+
};
|
|
2423
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2424
|
+
503: {
|
|
2425
|
+
headers: {
|
|
2426
|
+
[name: string]: unknown;
|
|
2427
|
+
};
|
|
2428
|
+
content: {
|
|
2429
|
+
"application/json": {
|
|
2430
|
+
error: {
|
|
2431
|
+
code: string;
|
|
2432
|
+
message: string;
|
|
2433
|
+
};
|
|
2434
|
+
requestId: string;
|
|
2435
|
+
};
|
|
2436
|
+
};
|
|
2437
|
+
};
|
|
2438
|
+
};
|
|
2439
|
+
};
|
|
2440
|
+
createProcessingSession: {
|
|
2441
|
+
parameters: {
|
|
2442
|
+
query?: never;
|
|
2443
|
+
header?: never;
|
|
2444
|
+
path?: never;
|
|
2445
|
+
cookie?: never;
|
|
2446
|
+
};
|
|
2447
|
+
requestBody: {
|
|
2448
|
+
content: {
|
|
2449
|
+
"application/json": {
|
|
2450
|
+
/** Format: uri */
|
|
2451
|
+
origin: string;
|
|
2452
|
+
operations: ("convert" | "import" | "ocr")[];
|
|
2453
|
+
maxBytes: number;
|
|
2454
|
+
maxJobs: number;
|
|
2455
|
+
/** @default 900 */
|
|
2456
|
+
expiresInSeconds?: number;
|
|
2457
|
+
};
|
|
2458
|
+
};
|
|
2459
|
+
};
|
|
2460
|
+
responses: {
|
|
2461
|
+
/** @description Success */
|
|
2462
|
+
200: {
|
|
2463
|
+
headers: {
|
|
2464
|
+
[name: string]: unknown;
|
|
2465
|
+
};
|
|
2466
|
+
content: {
|
|
2467
|
+
"application/json": {
|
|
2468
|
+
/** Format: uuid */
|
|
2469
|
+
sessionId: string;
|
|
2470
|
+
token: string;
|
|
2471
|
+
expiresAt: number;
|
|
2472
|
+
};
|
|
2473
|
+
};
|
|
2474
|
+
};
|
|
2475
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2476
|
+
400: {
|
|
2477
|
+
headers: {
|
|
2478
|
+
[name: string]: unknown;
|
|
2479
|
+
};
|
|
2480
|
+
content: {
|
|
2481
|
+
"application/json": {
|
|
2482
|
+
error: {
|
|
2483
|
+
code: string;
|
|
2484
|
+
message: string;
|
|
2485
|
+
};
|
|
2486
|
+
requestId: string;
|
|
2487
|
+
};
|
|
2488
|
+
};
|
|
2489
|
+
};
|
|
2490
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2491
|
+
401: {
|
|
2492
|
+
headers: {
|
|
2493
|
+
[name: string]: unknown;
|
|
2494
|
+
};
|
|
2495
|
+
content: {
|
|
2496
|
+
"application/json": {
|
|
2497
|
+
error: {
|
|
2498
|
+
code: string;
|
|
2499
|
+
message: string;
|
|
2500
|
+
};
|
|
2501
|
+
requestId: string;
|
|
2502
|
+
};
|
|
2503
|
+
};
|
|
2504
|
+
};
|
|
2505
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2506
|
+
403: {
|
|
2507
|
+
headers: {
|
|
2508
|
+
[name: string]: unknown;
|
|
2509
|
+
};
|
|
2510
|
+
content: {
|
|
2511
|
+
"application/json": {
|
|
2512
|
+
error: {
|
|
2513
|
+
code: string;
|
|
2514
|
+
message: string;
|
|
2515
|
+
};
|
|
2516
|
+
requestId: string;
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2519
|
+
};
|
|
2520
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2521
|
+
404: {
|
|
2522
|
+
headers: {
|
|
2523
|
+
[name: string]: unknown;
|
|
2524
|
+
};
|
|
2525
|
+
content: {
|
|
2526
|
+
"application/json": {
|
|
2527
|
+
error: {
|
|
2528
|
+
code: string;
|
|
2529
|
+
message: string;
|
|
2530
|
+
};
|
|
2531
|
+
requestId: string;
|
|
2532
|
+
};
|
|
2533
|
+
};
|
|
2534
|
+
};
|
|
2535
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2536
|
+
409: {
|
|
2537
|
+
headers: {
|
|
2538
|
+
[name: string]: unknown;
|
|
2539
|
+
};
|
|
2540
|
+
content: {
|
|
2541
|
+
"application/json": {
|
|
2542
|
+
error: {
|
|
2543
|
+
code: string;
|
|
2544
|
+
message: string;
|
|
2545
|
+
};
|
|
2546
|
+
requestId: string;
|
|
2547
|
+
};
|
|
2548
|
+
};
|
|
2549
|
+
};
|
|
2550
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2551
|
+
410: {
|
|
2552
|
+
headers: {
|
|
2553
|
+
[name: string]: unknown;
|
|
2554
|
+
};
|
|
2555
|
+
content: {
|
|
2556
|
+
"application/json": {
|
|
2557
|
+
error: {
|
|
2558
|
+
code: string;
|
|
2559
|
+
message: string;
|
|
2560
|
+
};
|
|
2561
|
+
requestId: string;
|
|
2562
|
+
};
|
|
2563
|
+
};
|
|
2564
|
+
};
|
|
2565
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2566
|
+
413: {
|
|
2567
|
+
headers: {
|
|
2568
|
+
[name: string]: unknown;
|
|
2569
|
+
};
|
|
2570
|
+
content: {
|
|
2571
|
+
"application/json": {
|
|
2572
|
+
error: {
|
|
2573
|
+
code: string;
|
|
2574
|
+
message: string;
|
|
2575
|
+
};
|
|
2576
|
+
requestId: string;
|
|
2577
|
+
};
|
|
2578
|
+
};
|
|
2579
|
+
};
|
|
2580
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2581
|
+
415: {
|
|
2582
|
+
headers: {
|
|
2583
|
+
[name: string]: unknown;
|
|
2584
|
+
};
|
|
2585
|
+
content: {
|
|
2586
|
+
"application/json": {
|
|
2587
|
+
error: {
|
|
2588
|
+
code: string;
|
|
2589
|
+
message: string;
|
|
2590
|
+
};
|
|
2591
|
+
requestId: string;
|
|
2592
|
+
};
|
|
2593
|
+
};
|
|
2594
|
+
};
|
|
2595
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2596
|
+
422: {
|
|
2597
|
+
headers: {
|
|
2598
|
+
[name: string]: unknown;
|
|
2599
|
+
};
|
|
2600
|
+
content: {
|
|
2601
|
+
"application/json": {
|
|
2602
|
+
error: {
|
|
2603
|
+
code: string;
|
|
2604
|
+
message: string;
|
|
2605
|
+
};
|
|
2606
|
+
requestId: string;
|
|
2607
|
+
};
|
|
2608
|
+
};
|
|
2609
|
+
};
|
|
2610
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2611
|
+
429: {
|
|
2612
|
+
headers: {
|
|
2613
|
+
[name: string]: unknown;
|
|
2614
|
+
};
|
|
2615
|
+
content: {
|
|
2616
|
+
"application/json": {
|
|
2617
|
+
error: {
|
|
2618
|
+
code: string;
|
|
2619
|
+
message: string;
|
|
2620
|
+
};
|
|
2621
|
+
requestId: string;
|
|
2622
|
+
};
|
|
2623
|
+
};
|
|
2624
|
+
};
|
|
2625
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2626
|
+
500: {
|
|
2627
|
+
headers: {
|
|
2628
|
+
[name: string]: unknown;
|
|
2629
|
+
};
|
|
2630
|
+
content: {
|
|
2631
|
+
"application/json": {
|
|
2632
|
+
error: {
|
|
2633
|
+
code: string;
|
|
2634
|
+
message: string;
|
|
2635
|
+
};
|
|
2636
|
+
requestId: string;
|
|
2637
|
+
};
|
|
2638
|
+
};
|
|
2639
|
+
};
|
|
2640
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2641
|
+
502: {
|
|
2642
|
+
headers: {
|
|
2643
|
+
[name: string]: unknown;
|
|
2644
|
+
};
|
|
2645
|
+
content: {
|
|
2646
|
+
"application/json": {
|
|
2647
|
+
error: {
|
|
2648
|
+
code: string;
|
|
2649
|
+
message: string;
|
|
2650
|
+
};
|
|
2651
|
+
requestId: string;
|
|
2652
|
+
};
|
|
2653
|
+
};
|
|
2654
|
+
};
|
|
2655
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2656
|
+
503: {
|
|
2657
|
+
headers: {
|
|
2658
|
+
[name: string]: unknown;
|
|
2659
|
+
};
|
|
2660
|
+
content: {
|
|
2661
|
+
"application/json": {
|
|
2662
|
+
error: {
|
|
2663
|
+
code: string;
|
|
2664
|
+
message: string;
|
|
2665
|
+
};
|
|
2666
|
+
requestId: string;
|
|
2667
|
+
};
|
|
2668
|
+
};
|
|
2669
|
+
};
|
|
2670
|
+
};
|
|
2671
|
+
};
|
|
2672
|
+
renewProcessingSession: {
|
|
2673
|
+
parameters: {
|
|
2674
|
+
query?: never;
|
|
2675
|
+
header?: never;
|
|
2676
|
+
path: {
|
|
2677
|
+
sessionId: string;
|
|
2678
|
+
};
|
|
2679
|
+
cookie?: never;
|
|
2680
|
+
};
|
|
2681
|
+
requestBody: {
|
|
2682
|
+
content: {
|
|
2683
|
+
"application/json": {
|
|
2684
|
+
/** Format: uri */
|
|
2685
|
+
origin: string;
|
|
2686
|
+
operations: ("convert" | "import" | "ocr")[];
|
|
2687
|
+
maxBytes: number;
|
|
2688
|
+
maxJobs: number;
|
|
2689
|
+
/** @default 900 */
|
|
2690
|
+
expiresInSeconds?: number;
|
|
2691
|
+
};
|
|
2692
|
+
};
|
|
2693
|
+
};
|
|
2694
|
+
responses: {
|
|
2695
|
+
/** @description Success */
|
|
2696
|
+
200: {
|
|
2697
|
+
headers: {
|
|
2698
|
+
[name: string]: unknown;
|
|
2699
|
+
};
|
|
2700
|
+
content: {
|
|
2701
|
+
"application/json": {
|
|
2702
|
+
/** Format: uuid */
|
|
2703
|
+
sessionId: string;
|
|
2704
|
+
token: string;
|
|
2705
|
+
expiresAt: number;
|
|
2706
|
+
};
|
|
2707
|
+
};
|
|
2708
|
+
};
|
|
2709
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2710
|
+
400: {
|
|
2711
|
+
headers: {
|
|
2712
|
+
[name: string]: unknown;
|
|
2713
|
+
};
|
|
2714
|
+
content: {
|
|
2715
|
+
"application/json": {
|
|
2716
|
+
error: {
|
|
2717
|
+
code: string;
|
|
2718
|
+
message: string;
|
|
2719
|
+
};
|
|
2720
|
+
requestId: string;
|
|
2721
|
+
};
|
|
2722
|
+
};
|
|
2723
|
+
};
|
|
2724
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2725
|
+
401: {
|
|
2726
|
+
headers: {
|
|
2727
|
+
[name: string]: unknown;
|
|
2728
|
+
};
|
|
2729
|
+
content: {
|
|
2730
|
+
"application/json": {
|
|
2731
|
+
error: {
|
|
2732
|
+
code: string;
|
|
2733
|
+
message: string;
|
|
2734
|
+
};
|
|
2735
|
+
requestId: string;
|
|
2736
|
+
};
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2740
|
+
403: {
|
|
2741
|
+
headers: {
|
|
2742
|
+
[name: string]: unknown;
|
|
2743
|
+
};
|
|
2744
|
+
content: {
|
|
2745
|
+
"application/json": {
|
|
2746
|
+
error: {
|
|
2747
|
+
code: string;
|
|
2748
|
+
message: string;
|
|
2749
|
+
};
|
|
2750
|
+
requestId: string;
|
|
2751
|
+
};
|
|
2752
|
+
};
|
|
2753
|
+
};
|
|
2754
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2755
|
+
404: {
|
|
2756
|
+
headers: {
|
|
2757
|
+
[name: string]: unknown;
|
|
2758
|
+
};
|
|
2759
|
+
content: {
|
|
2760
|
+
"application/json": {
|
|
2761
|
+
error: {
|
|
2762
|
+
code: string;
|
|
2763
|
+
message: string;
|
|
2764
|
+
};
|
|
2765
|
+
requestId: string;
|
|
2766
|
+
};
|
|
2767
|
+
};
|
|
2768
|
+
};
|
|
2769
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2770
|
+
409: {
|
|
2771
|
+
headers: {
|
|
2772
|
+
[name: string]: unknown;
|
|
2773
|
+
};
|
|
2774
|
+
content: {
|
|
2775
|
+
"application/json": {
|
|
2776
|
+
error: {
|
|
2777
|
+
code: string;
|
|
2778
|
+
message: string;
|
|
2779
|
+
};
|
|
2780
|
+
requestId: string;
|
|
2781
|
+
};
|
|
2782
|
+
};
|
|
2783
|
+
};
|
|
2784
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2785
|
+
410: {
|
|
2786
|
+
headers: {
|
|
2787
|
+
[name: string]: unknown;
|
|
2788
|
+
};
|
|
2789
|
+
content: {
|
|
2790
|
+
"application/json": {
|
|
2791
|
+
error: {
|
|
2792
|
+
code: string;
|
|
2793
|
+
message: string;
|
|
2794
|
+
};
|
|
2795
|
+
requestId: string;
|
|
2796
|
+
};
|
|
2797
|
+
};
|
|
2798
|
+
};
|
|
2799
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2800
|
+
413: {
|
|
2801
|
+
headers: {
|
|
2802
|
+
[name: string]: unknown;
|
|
2803
|
+
};
|
|
2804
|
+
content: {
|
|
2805
|
+
"application/json": {
|
|
2806
|
+
error: {
|
|
2807
|
+
code: string;
|
|
2808
|
+
message: string;
|
|
2809
|
+
};
|
|
2810
|
+
requestId: string;
|
|
2811
|
+
};
|
|
2812
|
+
};
|
|
2813
|
+
};
|
|
2814
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2815
|
+
415: {
|
|
2816
|
+
headers: {
|
|
2817
|
+
[name: string]: unknown;
|
|
2818
|
+
};
|
|
2819
|
+
content: {
|
|
2820
|
+
"application/json": {
|
|
2821
|
+
error: {
|
|
2822
|
+
code: string;
|
|
2823
|
+
message: string;
|
|
2824
|
+
};
|
|
2825
|
+
requestId: string;
|
|
2826
|
+
};
|
|
2827
|
+
};
|
|
2828
|
+
};
|
|
2829
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2830
|
+
422: {
|
|
2831
|
+
headers: {
|
|
2832
|
+
[name: string]: unknown;
|
|
2833
|
+
};
|
|
2834
|
+
content: {
|
|
2835
|
+
"application/json": {
|
|
2836
|
+
error: {
|
|
2837
|
+
code: string;
|
|
2838
|
+
message: string;
|
|
2839
|
+
};
|
|
2840
|
+
requestId: string;
|
|
2841
|
+
};
|
|
2842
|
+
};
|
|
2843
|
+
};
|
|
2844
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2845
|
+
429: {
|
|
2846
|
+
headers: {
|
|
2847
|
+
[name: string]: unknown;
|
|
2848
|
+
};
|
|
2849
|
+
content: {
|
|
2850
|
+
"application/json": {
|
|
2851
|
+
error: {
|
|
2852
|
+
code: string;
|
|
2853
|
+
message: string;
|
|
2854
|
+
};
|
|
2855
|
+
requestId: string;
|
|
2856
|
+
};
|
|
2857
|
+
};
|
|
2858
|
+
};
|
|
2859
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2860
|
+
500: {
|
|
2861
|
+
headers: {
|
|
2862
|
+
[name: string]: unknown;
|
|
2863
|
+
};
|
|
2864
|
+
content: {
|
|
2865
|
+
"application/json": {
|
|
2866
|
+
error: {
|
|
2867
|
+
code: string;
|
|
2868
|
+
message: string;
|
|
2869
|
+
};
|
|
2870
|
+
requestId: string;
|
|
2871
|
+
};
|
|
2872
|
+
};
|
|
2873
|
+
};
|
|
2874
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2875
|
+
502: {
|
|
2876
|
+
headers: {
|
|
2877
|
+
[name: string]: unknown;
|
|
2878
|
+
};
|
|
2879
|
+
content: {
|
|
2880
|
+
"application/json": {
|
|
2881
|
+
error: {
|
|
2882
|
+
code: string;
|
|
2883
|
+
message: string;
|
|
2884
|
+
};
|
|
2885
|
+
requestId: string;
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2890
|
+
503: {
|
|
2891
|
+
headers: {
|
|
2892
|
+
[name: string]: unknown;
|
|
2893
|
+
};
|
|
2894
|
+
content: {
|
|
2895
|
+
"application/json": {
|
|
2896
|
+
error: {
|
|
2897
|
+
code: string;
|
|
2898
|
+
message: string;
|
|
2899
|
+
};
|
|
2900
|
+
requestId: string;
|
|
2901
|
+
};
|
|
2902
|
+
};
|
|
2903
|
+
};
|
|
2904
|
+
};
|
|
2905
|
+
};
|
|
2906
|
+
revokeProcessingSession: {
|
|
2907
|
+
parameters: {
|
|
2908
|
+
query?: never;
|
|
2909
|
+
header?: never;
|
|
2910
|
+
path: {
|
|
2911
|
+
sessionId: string;
|
|
2912
|
+
};
|
|
2913
|
+
cookie?: never;
|
|
2914
|
+
};
|
|
2915
|
+
requestBody: {
|
|
2916
|
+
content: {
|
|
2917
|
+
"application/json": Record<string, never>;
|
|
2918
|
+
};
|
|
2919
|
+
};
|
|
2920
|
+
responses: {
|
|
2921
|
+
/** @description Success */
|
|
2922
|
+
200: {
|
|
2923
|
+
headers: {
|
|
2924
|
+
[name: string]: unknown;
|
|
2925
|
+
};
|
|
2926
|
+
content: {
|
|
2927
|
+
"application/json": {
|
|
2928
|
+
/** @enum {boolean} */
|
|
2929
|
+
ok: true;
|
|
2930
|
+
};
|
|
2931
|
+
};
|
|
2932
|
+
};
|
|
2933
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2934
|
+
400: {
|
|
2935
|
+
headers: {
|
|
2936
|
+
[name: string]: unknown;
|
|
2937
|
+
};
|
|
2938
|
+
content: {
|
|
2939
|
+
"application/json": {
|
|
2940
|
+
error: {
|
|
2941
|
+
code: string;
|
|
2942
|
+
message: string;
|
|
2943
|
+
};
|
|
2944
|
+
requestId: string;
|
|
2945
|
+
};
|
|
2946
|
+
};
|
|
2947
|
+
};
|
|
2948
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2949
|
+
401: {
|
|
2950
|
+
headers: {
|
|
2951
|
+
[name: string]: unknown;
|
|
2952
|
+
};
|
|
2953
|
+
content: {
|
|
2954
|
+
"application/json": {
|
|
2955
|
+
error: {
|
|
2956
|
+
code: string;
|
|
2957
|
+
message: string;
|
|
2958
|
+
};
|
|
2959
|
+
requestId: string;
|
|
2960
|
+
};
|
|
2961
|
+
};
|
|
2962
|
+
};
|
|
2963
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2964
|
+
403: {
|
|
2965
|
+
headers: {
|
|
2966
|
+
[name: string]: unknown;
|
|
2967
|
+
};
|
|
2968
|
+
content: {
|
|
2969
|
+
"application/json": {
|
|
2970
|
+
error: {
|
|
2971
|
+
code: string;
|
|
2972
|
+
message: string;
|
|
2973
|
+
};
|
|
2974
|
+
requestId: string;
|
|
2975
|
+
};
|
|
2976
|
+
};
|
|
2977
|
+
};
|
|
2978
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2979
|
+
404: {
|
|
2980
|
+
headers: {
|
|
2981
|
+
[name: string]: unknown;
|
|
2982
|
+
};
|
|
2983
|
+
content: {
|
|
2984
|
+
"application/json": {
|
|
2985
|
+
error: {
|
|
2986
|
+
code: string;
|
|
2987
|
+
message: string;
|
|
2988
|
+
};
|
|
2989
|
+
requestId: string;
|
|
2990
|
+
};
|
|
2991
|
+
};
|
|
2992
|
+
};
|
|
2993
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
2994
|
+
409: {
|
|
2995
|
+
headers: {
|
|
2996
|
+
[name: string]: unknown;
|
|
2997
|
+
};
|
|
2998
|
+
content: {
|
|
2999
|
+
"application/json": {
|
|
3000
|
+
error: {
|
|
3001
|
+
code: string;
|
|
3002
|
+
message: string;
|
|
3003
|
+
};
|
|
3004
|
+
requestId: string;
|
|
3005
|
+
};
|
|
3006
|
+
};
|
|
3007
|
+
};
|
|
3008
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3009
|
+
410: {
|
|
3010
|
+
headers: {
|
|
3011
|
+
[name: string]: unknown;
|
|
3012
|
+
};
|
|
3013
|
+
content: {
|
|
3014
|
+
"application/json": {
|
|
3015
|
+
error: {
|
|
3016
|
+
code: string;
|
|
3017
|
+
message: string;
|
|
3018
|
+
};
|
|
3019
|
+
requestId: string;
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3024
|
+
413: {
|
|
3025
|
+
headers: {
|
|
3026
|
+
[name: string]: unknown;
|
|
3027
|
+
};
|
|
3028
|
+
content: {
|
|
3029
|
+
"application/json": {
|
|
3030
|
+
error: {
|
|
3031
|
+
code: string;
|
|
3032
|
+
message: string;
|
|
3033
|
+
};
|
|
3034
|
+
requestId: string;
|
|
3035
|
+
};
|
|
3036
|
+
};
|
|
3037
|
+
};
|
|
3038
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3039
|
+
415: {
|
|
3040
|
+
headers: {
|
|
3041
|
+
[name: string]: unknown;
|
|
3042
|
+
};
|
|
3043
|
+
content: {
|
|
3044
|
+
"application/json": {
|
|
3045
|
+
error: {
|
|
3046
|
+
code: string;
|
|
3047
|
+
message: string;
|
|
3048
|
+
};
|
|
3049
|
+
requestId: string;
|
|
3050
|
+
};
|
|
3051
|
+
};
|
|
3052
|
+
};
|
|
3053
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3054
|
+
422: {
|
|
3055
|
+
headers: {
|
|
3056
|
+
[name: string]: unknown;
|
|
3057
|
+
};
|
|
3058
|
+
content: {
|
|
3059
|
+
"application/json": {
|
|
3060
|
+
error: {
|
|
3061
|
+
code: string;
|
|
3062
|
+
message: string;
|
|
3063
|
+
};
|
|
3064
|
+
requestId: string;
|
|
3065
|
+
};
|
|
3066
|
+
};
|
|
3067
|
+
};
|
|
3068
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3069
|
+
429: {
|
|
3070
|
+
headers: {
|
|
3071
|
+
[name: string]: unknown;
|
|
3072
|
+
};
|
|
3073
|
+
content: {
|
|
3074
|
+
"application/json": {
|
|
3075
|
+
error: {
|
|
3076
|
+
code: string;
|
|
3077
|
+
message: string;
|
|
3078
|
+
};
|
|
3079
|
+
requestId: string;
|
|
3080
|
+
};
|
|
3081
|
+
};
|
|
3082
|
+
};
|
|
3083
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3084
|
+
500: {
|
|
3085
|
+
headers: {
|
|
3086
|
+
[name: string]: unknown;
|
|
3087
|
+
};
|
|
3088
|
+
content: {
|
|
3089
|
+
"application/json": {
|
|
3090
|
+
error: {
|
|
3091
|
+
code: string;
|
|
3092
|
+
message: string;
|
|
3093
|
+
};
|
|
3094
|
+
requestId: string;
|
|
3095
|
+
};
|
|
3096
|
+
};
|
|
3097
|
+
};
|
|
3098
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3099
|
+
502: {
|
|
3100
|
+
headers: {
|
|
3101
|
+
[name: string]: unknown;
|
|
3102
|
+
};
|
|
3103
|
+
content: {
|
|
3104
|
+
"application/json": {
|
|
3105
|
+
error: {
|
|
3106
|
+
code: string;
|
|
3107
|
+
message: string;
|
|
3108
|
+
};
|
|
3109
|
+
requestId: string;
|
|
3110
|
+
};
|
|
3111
|
+
};
|
|
3112
|
+
};
|
|
3113
|
+
/** @description Structured API error; no submitted values are echoed. */
|
|
3114
|
+
503: {
|
|
3115
|
+
headers: {
|
|
3116
|
+
[name: string]: unknown;
|
|
3117
|
+
};
|
|
3118
|
+
content: {
|
|
3119
|
+
"application/json": {
|
|
3120
|
+
error: {
|
|
3121
|
+
code: string;
|
|
3122
|
+
message: string;
|
|
3123
|
+
};
|
|
3124
|
+
requestId: string;
|
|
3125
|
+
};
|
|
3126
|
+
};
|
|
3127
|
+
};
|
|
3128
|
+
};
|
|
3129
|
+
};
|
|
3130
|
+
}
|
|
3131
|
+
|
|
3132
|
+
type ProcessingJob = operations["getProcessingJob"]["responses"][200]["content"]["application/json"];
|
|
3133
|
+
type ProcessingRequest = operations["submitProcessingJob"]["requestBody"]["content"]["application/json"];
|
|
3134
|
+
type ProcessingUpload = operations["createProcessingUpload"]["responses"][200]["content"]["application/json"];
|
|
3135
|
+
type UploadPage = operations["getProcessingUpload"]["responses"][200]["content"]["application/json"];
|
|
3136
|
+
type ProcessingOperation = ProcessingRequest["operation"];
|
|
3137
|
+
type ProcessingGrant = operations["createProcessingSession"]["requestBody"]["content"]["application/json"];
|
|
3138
|
+
type ProcessingSession = operations["createProcessingSession"]["responses"][200]["content"]["application/json"];
|
|
3139
|
+
interface ReplayableFile {
|
|
3140
|
+
readonly size: number;
|
|
3141
|
+
/** Read at most the requested range. A Blob/File or a server file handle can implement this. */
|
|
3142
|
+
read(offset: number, length: number, signal?: AbortSignal): Promise<Uint8Array>;
|
|
3143
|
+
}
|
|
3144
|
+
declare function blobFile(blob: Blob): ReplayableFile;
|
|
3145
|
+
declare class ProcessingCloudError extends Error {
|
|
3146
|
+
readonly code: string;
|
|
3147
|
+
readonly status?: number | undefined;
|
|
3148
|
+
readonly requestId?: string | undefined;
|
|
3149
|
+
constructor(code: string, status?: number | undefined, requestId?: string | undefined);
|
|
3150
|
+
}
|
|
3151
|
+
interface ProcessingTransport {
|
|
3152
|
+
apiUrl: string;
|
|
3153
|
+
fetch?: typeof fetch;
|
|
3154
|
+
/** Called for every request so credential renewal retains the same upload/job ownership. */
|
|
3155
|
+
authorization(): Promise<Readonly<Record<string, string>>> | Readonly<Record<string, string>>;
|
|
3156
|
+
}
|
|
3157
|
+
/** Shared file transport. Downloads remain streams; aborting wait() never cancels a server job. */
|
|
3158
|
+
declare class ProcessingClient {
|
|
3159
|
+
#private;
|
|
3160
|
+
private readonly options;
|
|
3161
|
+
constructor(options: ProcessingTransport);
|
|
3162
|
+
getUpload(uploadId: string, after?: number, signal?: AbortSignal): Promise<UploadPage>;
|
|
3163
|
+
createSession(grant: ProcessingGrant, signal?: AbortSignal): Promise<ProcessingSession>;
|
|
3164
|
+
renewSession(id: string, grant: ProcessingGrant, signal?: AbortSignal): Promise<ProcessingSession>;
|
|
3165
|
+
revokeSession(id: string, signal?: AbortSignal): Promise<{
|
|
3166
|
+
ok: true;
|
|
3167
|
+
}>;
|
|
3168
|
+
abortUpload(uploadId: string, signal?: AbortSignal): Promise<{
|
|
3169
|
+
ok: true;
|
|
3170
|
+
}>;
|
|
3171
|
+
upload(source: ReplayableFile | Blob, options: {
|
|
3172
|
+
clientKey: string;
|
|
3173
|
+
operation: ProcessingOperation;
|
|
3174
|
+
contentType?: string;
|
|
3175
|
+
signal?: AbortSignal;
|
|
3176
|
+
onProgress?(bytes: number, total: number): void;
|
|
3177
|
+
}): Promise<ProcessingUpload>;
|
|
3178
|
+
submit(request: ProcessingRequest, idempotencyKey: string, signal?: AbortSignal): Promise<ProcessingJob>;
|
|
3179
|
+
getJob(id: string, signal?: AbortSignal): Promise<ProcessingJob>;
|
|
3180
|
+
cancel(id: string, signal?: AbortSignal): Promise<ProcessingJob>;
|
|
3181
|
+
retry(id: string, expectedGeneration: number, signal?: AbortSignal): Promise<ProcessingJob>;
|
|
3182
|
+
wait(id: string, options?: {
|
|
3183
|
+
signal?: AbortSignal;
|
|
3184
|
+
onProgress?(job: ProcessingJob): void;
|
|
3185
|
+
}): Promise<ProcessingJob>;
|
|
3186
|
+
download(jobId: string, artifactId: string, options?: {
|
|
3187
|
+
signal?: AbortSignal;
|
|
3188
|
+
offset?: number;
|
|
3189
|
+
etag?: string;
|
|
3190
|
+
}): Promise<Response>;
|
|
3191
|
+
}
|
|
3192
|
+
declare function createBrowserProcessingClient(options: {
|
|
3193
|
+
apiUrl: string;
|
|
3194
|
+
sessionToken(): string | Promise<string>;
|
|
3195
|
+
fetch?: typeof fetch;
|
|
3196
|
+
}): ProcessingClient;
|
|
3197
|
+
declare function createWidgetProcessingClient(options: {
|
|
3198
|
+
apiUrl: string;
|
|
3199
|
+
publishableKey: string;
|
|
3200
|
+
sessionToken(): string | Promise<string>;
|
|
3201
|
+
fetch?: typeof fetch;
|
|
3202
|
+
}): ProcessingClient;
|
|
3203
|
+
|
|
3204
|
+
export { ProcessingClient as P, type ReplayableFile as R, ProcessingCloudError as a, type ProcessingGrant as b, type ProcessingJob as c, type ProcessingOperation as d, type ProcessingRequest as e, type ProcessingSession as f, type ProcessingTransport as g, type ProcessingUpload as h, blobFile as i, createBrowserProcessingClient as j, createWidgetProcessingClient as k };
|