Skip to content

Commit 7ed3165

Browse files
committed
Update API types
1 parent 1270dcf commit 7ed3165

2 files changed

Lines changed: 74 additions & 26 deletions

File tree

lib/JobsResource.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,4 +135,5 @@ interface TaskContainer {
135135
export interface JobTemplate {
136136
tasks: TaskContainer;
137137
tag?: string;
138+
webhook_url?: string;
138139
}

lib/TasksResource.ts

Lines changed: 73 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,25 @@ export interface TaskEventData {
1212

1313
export type Operation = ImportOperation | TaskOperation | ExportOperation;
1414
export type ImportOperation =
15-
| ImportUpload
1615
| ImportUrl
16+
| ImportUpload
17+
| ImportBase64
18+
| ImportRaw
1719
| ImportS3
1820
| ImportAzureBlob
1921
| ImportGoogleCloudStorage
2022
| ImportOpenStack
2123
| ImportSFTP;
2224
export type TaskOperation =
2325
| TaskConvert
24-
| TaskCapture
2526
| TaskOptimize
27+
| TaskCapture
2628
| TaskThumbnail
2729
| TaskMerge
2830
| TaskArchive
2931
| TaskCommand
30-
| TaskMetadata;
32+
| TaskMetadata
33+
| TaskMetadataWrite;
3134
export type ExportOperation =
3235
| ExportUrl
3336
| ExportS3
@@ -36,6 +39,17 @@ export type ExportOperation =
3639
| ExportOpenStack
3740
| ExportSFTP;
3841

42+
interface ImportUrl {
43+
operation: 'import/url';
44+
data: ImportUrlData;
45+
}
46+
47+
export interface ImportUrlData {
48+
url: string;
49+
filename?: string;
50+
headers?: { [key: string]: string };
51+
}
52+
3953
interface ImportUpload {
4054
operation: 'import/upload';
4155
data: ImportUploadData;
@@ -45,15 +59,24 @@ export interface ImportUploadData {
4559
redirect?: string;
4660
}
4761

48-
interface ImportUrl {
49-
operation: 'import/url';
50-
data: ImportUrlData;
62+
interface ImportBase64 {
63+
operation: 'import/base64';
64+
data: ImportBase64Data;
5165
}
5266

53-
export interface ImportUrlData {
54-
url: string;
55-
filename?: string;
56-
headers?: { [key: string]: string };
67+
export interface ImportBase64Data {
68+
file: string;
69+
filename: string;
70+
}
71+
72+
interface ImportRaw {
73+
operation: 'import/raw';
74+
data: ImportRawData;
75+
}
76+
77+
export interface ImportRawData {
78+
file: string;
79+
filename: string;
5780
}
5881

5982
interface ImportS3 {
@@ -147,6 +170,25 @@ export interface TaskConvertData {
147170
engine?: string;
148171
engine_version?: string;
149172
filename?: string;
173+
timeout?: number;
174+
175+
[option: string]: any;
176+
}
177+
178+
interface TaskOptimize {
179+
operation: 'optimize';
180+
data: TaskOptimizeData;
181+
}
182+
183+
export interface TaskOptimizeData {
184+
input: string | string[];
185+
input_format?: 'jpg' | 'png' | 'pdf';
186+
engine?: string;
187+
engine_version?: string;
188+
filename?: string;
189+
timeout?: number;
190+
quality?: number;
191+
profile?: 'web' | 'print' | 'archive' | 'mrc' | 'max';
150192

151193
[option: string]: any;
152194
}
@@ -162,6 +204,7 @@ export interface TaskCaptureData {
162204
engine?: string;
163205
engine_version?: string;
164206
filename?: string;
207+
timeout?: number;
165208
pages?: string;
166209
zoom?: number;
167210
page_width?: number;
@@ -180,49 +223,50 @@ export interface TaskCaptureData {
180223
headers?: { [header: string]: string };
181224
}
182225

183-
interface TaskOptimize {
184-
operation: 'optimize';
185-
data: TaskOptimizeData;
226+
interface TaskThumbnail {
227+
operation: 'thumbnail';
228+
data: TaskThumbnailData;
186229
}
187230

188-
export interface TaskOptimizeData {
231+
export interface TaskThumbnailData {
189232
input: string | string[];
190-
input_format?: 'jpg' | 'png' | 'pdf';
233+
input_format?: string;
234+
output_format: 'png' | 'jpg';
191235
engine?: string;
192236
engine_version?: string;
193237
filename?: string;
194-
quality?: number;
195-
profile?: 'web' | 'print' | 'archive' | 'mrc' | 'max';
238+
timeout?: number;
196239

197240
[option: string]: any;
198241
}
199242

200-
interface TaskThumbnail {
201-
operation: 'thumbnail';
202-
data: TaskThumbnailData;
203-
}
204-
205243
interface TaskMetadata {
206244
operation: 'metadata';
207245
data: TaskMetadataData;
208246
}
209247

210-
export interface TaskThumbnailData {
248+
export interface TaskMetadataData {
211249
input: string | string[];
212250
input_format?: string;
213-
output_format: 'png' | 'jpg';
214251
engine?: string;
215252
engine_version?: string;
216-
filename?: string;
253+
timeout?: number;
217254

218255
[option: string]: any;
219256
}
220257

221-
export interface TaskMetadataData {
258+
interface TaskMetadataWrite {
259+
operation: 'metadata/write';
260+
data: TaskMetadataWriteData;
261+
}
262+
263+
export interface TaskMetadataWriteData {
222264
input: string | string[];
223265
input_format?: string;
224266
engine?: string;
225267
engine_version?: string;
268+
metadata: Record<string, string | number>;
269+
filename?: string;
226270
timeout?: number;
227271

228272
[option: string]: any;
@@ -239,6 +283,7 @@ export interface TaskMergeData {
239283
engine?: string;
240284
engine_version?: string;
241285
filename?: string;
286+
timeout?: number;
242287
}
243288

244289
interface TaskArchive {
@@ -252,6 +297,7 @@ export interface TaskArchiveData {
252297
engine?: string;
253298
engine_version?: string;
254299
filename?: string;
300+
timeout?: number;
255301
}
256302

257303
interface TaskCommand {
@@ -263,6 +309,7 @@ interface TaskCommandBaseData {
263309
input: string | string[];
264310
engine_version?: string;
265311
capture_output?: boolean;
312+
timeout?: number;
266313
arguments: string;
267314
}
268315

0 commit comments

Comments
 (0)