bem-ai-sdk 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/package.json +1 -1
- package/resources/functions/functions.d.mts +233 -14
- package/resources/functions/functions.d.mts.map +1 -1
- package/resources/functions/functions.d.ts +233 -14
- package/resources/functions/functions.d.ts.map +1 -1
- package/resources/functions/functions.js.map +1 -1
- package/resources/functions/functions.mjs.map +1 -1
- package/resources/functions/versions.d.mts +45 -1
- package/resources/functions/versions.d.mts.map +1 -1
- package/resources/functions/versions.d.ts +45 -1
- package/resources/functions/versions.d.ts.map +1 -1
- package/resources/workflows/workflows.d.mts +58 -15
- package/resources/workflows/workflows.d.mts.map +1 -1
- package/resources/workflows/workflows.d.ts +58 -15
- package/resources/workflows/workflows.d.ts.map +1 -1
- package/resources/workflows/workflows.js +17 -7
- package/resources/workflows/workflows.js.map +1 -1
- package/resources/workflows/workflows.mjs +18 -8
- package/resources/workflows/workflows.mjs.map +1 -1
- package/src/resources/functions/functions.ts +287 -8
- package/src/resources/functions/versions.ts +60 -0
- package/src/resources/workflows/workflows.ts +104 -17
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -33,16 +33,25 @@ export declare class Workflows extends APIResource {
|
|
|
33
33
|
*/
|
|
34
34
|
delete(workflowName: string, options?: RequestOptions): APIPromise<void>;
|
|
35
35
|
/**
|
|
36
|
-
* **Invoke a workflow
|
|
36
|
+
* **Invoke a workflow.**
|
|
37
37
|
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* Submit the input file as either a multipart form request or a JSON request with
|
|
39
|
+
* base64-encoded file content. The workflow name is derived from the URL path.
|
|
40
|
+
*
|
|
41
|
+
* ## Input Formats
|
|
42
|
+
*
|
|
43
|
+
* - **Multipart form** (`multipart/form-data`): attach the file directly via the
|
|
44
|
+
* `file` or `files` fields. Set `wait` in the form body to control synchronous
|
|
45
|
+
* behaviour.
|
|
46
|
+
* - **JSON** (`application/json`): base64-encode the file content and set it in
|
|
47
|
+
* `input.singleFile.inputContent` or `input.batchFiles.inputs[*].inputContent`.
|
|
48
|
+
* Pass `wait=true` as a query parameter to control synchronous behaviour.
|
|
40
49
|
*
|
|
41
50
|
* ## Synchronous vs Asynchronous
|
|
42
51
|
*
|
|
43
52
|
* By default the call is created asynchronously and this endpoint returns
|
|
44
|
-
* `202 Accepted` immediately with a `pending` call object. Set
|
|
45
|
-
*
|
|
53
|
+
* `202 Accepted` immediately with a `pending` call object. Set `wait` to `true` to
|
|
54
|
+
* block until the call completes (up to 30 seconds):
|
|
46
55
|
*
|
|
47
56
|
* - On success: returns `200 OK` with the completed call, `outputs` populated
|
|
48
57
|
* - On failure: returns `500 Internal Server Error` with the call and an `error`
|
|
@@ -54,7 +63,7 @@ export declare class Workflows extends APIResource {
|
|
|
54
63
|
* Poll `GET /v3/calls/{callID}` to check status, or configure a webhook
|
|
55
64
|
* subscription to receive events when the call finishes.
|
|
56
65
|
*/
|
|
57
|
-
call(workflowName: string,
|
|
66
|
+
call(workflowName: string, params: WorkflowCallParams, options?: RequestOptions): APIPromise<CallsAPI.CallGetResponse>;
|
|
58
67
|
/**
|
|
59
68
|
* Copy a Workflow
|
|
60
69
|
*/
|
|
@@ -378,22 +387,56 @@ export interface WorkflowListParams extends WorkflowsPageParams {
|
|
|
378
387
|
}
|
|
379
388
|
export interface WorkflowCallParams {
|
|
380
389
|
/**
|
|
381
|
-
*
|
|
390
|
+
* Body param: Input to the workflow call. Provide exactly one of `singleFile` or
|
|
391
|
+
* `batchFiles`.
|
|
382
392
|
*/
|
|
383
|
-
|
|
393
|
+
input: WorkflowCallParams.Input;
|
|
384
394
|
/**
|
|
385
|
-
*
|
|
395
|
+
* Query param: When `true`, the endpoint blocks until the call completes (up to 30
|
|
396
|
+
* seconds) and returns the finished call object. Default: `false`.
|
|
386
397
|
*/
|
|
387
|
-
|
|
398
|
+
wait?: boolean;
|
|
388
399
|
/**
|
|
389
|
-
*
|
|
400
|
+
* Body param: Your reference ID for tracking this call.
|
|
390
401
|
*/
|
|
391
|
-
|
|
402
|
+
callReferenceID?: string;
|
|
403
|
+
}
|
|
404
|
+
export declare namespace WorkflowCallParams {
|
|
392
405
|
/**
|
|
393
|
-
*
|
|
394
|
-
* returns the finished call object. Default: `false`.
|
|
406
|
+
* Input to the workflow call. Provide exactly one of `singleFile` or `batchFiles`.
|
|
395
407
|
*/
|
|
396
|
-
|
|
408
|
+
interface Input {
|
|
409
|
+
batchFiles?: Input.BatchFiles;
|
|
410
|
+
singleFile?: Input.SingleFile;
|
|
411
|
+
}
|
|
412
|
+
namespace Input {
|
|
413
|
+
interface BatchFiles {
|
|
414
|
+
inputs?: Array<BatchFiles.Input>;
|
|
415
|
+
}
|
|
416
|
+
namespace BatchFiles {
|
|
417
|
+
interface Input {
|
|
418
|
+
/**
|
|
419
|
+
* Base64-encoded file content
|
|
420
|
+
*/
|
|
421
|
+
inputContent: string;
|
|
422
|
+
/**
|
|
423
|
+
* The input type of the content you're sending for transformation.
|
|
424
|
+
*/
|
|
425
|
+
inputType: 'csv' | 'docx' | 'email' | 'heic' | 'html' | 'jpeg' | 'json' | 'heif' | 'm4a' | 'mp3' | 'pdf' | 'png' | 'text' | 'wav' | 'webp' | 'xls' | 'xlsx' | 'xml';
|
|
426
|
+
itemReferenceID?: string;
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
interface SingleFile {
|
|
430
|
+
/**
|
|
431
|
+
* Base64-encoded file content
|
|
432
|
+
*/
|
|
433
|
+
inputContent: string;
|
|
434
|
+
/**
|
|
435
|
+
* The input type of the content you're sending for transformation.
|
|
436
|
+
*/
|
|
437
|
+
inputType: 'csv' | 'docx' | 'email' | 'heic' | 'html' | 'jpeg' | 'json' | 'heif' | 'm4a' | 'mp3' | 'pdf' | 'png' | 'text' | 'wav' | 'webp' | 'xls' | 'xlsx' | 'xml';
|
|
438
|
+
}
|
|
439
|
+
}
|
|
397
440
|
}
|
|
398
441
|
export interface WorkflowCopyParams {
|
|
399
442
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,QAAQ,EAAE;OAC/E,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,oBAAoB,EACpB,aAAa,EACb,KAAK,mBAAmB,EACzB;OAEM,EAAE,cAAc,EAAE;AAIzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIhD;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOxE
|
|
1
|
+
{"version":3,"file":"workflows.d.mts","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,QAAQ,EAAE;OAC/E,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,oBAAoB,EACpB,aAAa,EACb,KAAK,mBAAmB,EACzB;OAEM,EAAE,cAAc,EAAE;AAIzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIhD;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC;IAQvC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG3F;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAE3E,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;IAElD;;OAEG;IACH,iBAAiB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE7D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,cAAc;QAC7B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,YAAY,CAAC,yBAAyB,CAAC;QAEjD;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,YAAY,CAAC,yBAAyB,CAAC;QAEjD;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAEhC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,KAAK;QACpB,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;QAE9B,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;KAC/B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,UAAU;YACzB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAClC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,SAAS,EACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,CAAC;gBAEV,eAAe,CAAC,EAAE,MAAM,CAAC;aAC1B;SACF;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,CAAC;SACX;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -33,16 +33,25 @@ export declare class Workflows extends APIResource {
|
|
|
33
33
|
*/
|
|
34
34
|
delete(workflowName: string, options?: RequestOptions): APIPromise<void>;
|
|
35
35
|
/**
|
|
36
|
-
* **Invoke a workflow
|
|
36
|
+
* **Invoke a workflow.**
|
|
37
37
|
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
38
|
+
* Submit the input file as either a multipart form request or a JSON request with
|
|
39
|
+
* base64-encoded file content. The workflow name is derived from the URL path.
|
|
40
|
+
*
|
|
41
|
+
* ## Input Formats
|
|
42
|
+
*
|
|
43
|
+
* - **Multipart form** (`multipart/form-data`): attach the file directly via the
|
|
44
|
+
* `file` or `files` fields. Set `wait` in the form body to control synchronous
|
|
45
|
+
* behaviour.
|
|
46
|
+
* - **JSON** (`application/json`): base64-encode the file content and set it in
|
|
47
|
+
* `input.singleFile.inputContent` or `input.batchFiles.inputs[*].inputContent`.
|
|
48
|
+
* Pass `wait=true` as a query parameter to control synchronous behaviour.
|
|
40
49
|
*
|
|
41
50
|
* ## Synchronous vs Asynchronous
|
|
42
51
|
*
|
|
43
52
|
* By default the call is created asynchronously and this endpoint returns
|
|
44
|
-
* `202 Accepted` immediately with a `pending` call object. Set
|
|
45
|
-
*
|
|
53
|
+
* `202 Accepted` immediately with a `pending` call object. Set `wait` to `true` to
|
|
54
|
+
* block until the call completes (up to 30 seconds):
|
|
46
55
|
*
|
|
47
56
|
* - On success: returns `200 OK` with the completed call, `outputs` populated
|
|
48
57
|
* - On failure: returns `500 Internal Server Error` with the call and an `error`
|
|
@@ -54,7 +63,7 @@ export declare class Workflows extends APIResource {
|
|
|
54
63
|
* Poll `GET /v3/calls/{callID}` to check status, or configure a webhook
|
|
55
64
|
* subscription to receive events when the call finishes.
|
|
56
65
|
*/
|
|
57
|
-
call(workflowName: string,
|
|
66
|
+
call(workflowName: string, params: WorkflowCallParams, options?: RequestOptions): APIPromise<CallsAPI.CallGetResponse>;
|
|
58
67
|
/**
|
|
59
68
|
* Copy a Workflow
|
|
60
69
|
*/
|
|
@@ -378,22 +387,56 @@ export interface WorkflowListParams extends WorkflowsPageParams {
|
|
|
378
387
|
}
|
|
379
388
|
export interface WorkflowCallParams {
|
|
380
389
|
/**
|
|
381
|
-
*
|
|
390
|
+
* Body param: Input to the workflow call. Provide exactly one of `singleFile` or
|
|
391
|
+
* `batchFiles`.
|
|
382
392
|
*/
|
|
383
|
-
|
|
393
|
+
input: WorkflowCallParams.Input;
|
|
384
394
|
/**
|
|
385
|
-
*
|
|
395
|
+
* Query param: When `true`, the endpoint blocks until the call completes (up to 30
|
|
396
|
+
* seconds) and returns the finished call object. Default: `false`.
|
|
386
397
|
*/
|
|
387
|
-
|
|
398
|
+
wait?: boolean;
|
|
388
399
|
/**
|
|
389
|
-
*
|
|
400
|
+
* Body param: Your reference ID for tracking this call.
|
|
390
401
|
*/
|
|
391
|
-
|
|
402
|
+
callReferenceID?: string;
|
|
403
|
+
}
|
|
404
|
+
export declare namespace WorkflowCallParams {
|
|
392
405
|
/**
|
|
393
|
-
*
|
|
394
|
-
* returns the finished call object. Default: `false`.
|
|
406
|
+
* Input to the workflow call. Provide exactly one of `singleFile` or `batchFiles`.
|
|
395
407
|
*/
|
|
396
|
-
|
|
408
|
+
interface Input {
|
|
409
|
+
batchFiles?: Input.BatchFiles;
|
|
410
|
+
singleFile?: Input.SingleFile;
|
|
411
|
+
}
|
|
412
|
+
namespace Input {
|
|
413
|
+
interface BatchFiles {
|
|
414
|
+
inputs?: Array<BatchFiles.Input>;
|
|
415
|
+
}
|
|
416
|
+
namespace BatchFiles {
|
|
417
|
+
interface Input {
|
|
418
|
+
/**
|
|
419
|
+
* Base64-encoded file content
|
|
420
|
+
*/
|
|
421
|
+
inputContent: string;
|
|
422
|
+
/**
|
|
423
|
+
* The input type of the content you're sending for transformation.
|
|
424
|
+
*/
|
|
425
|
+
inputType: 'csv' | 'docx' | 'email' | 'heic' | 'html' | 'jpeg' | 'json' | 'heif' | 'm4a' | 'mp3' | 'pdf' | 'png' | 'text' | 'wav' | 'webp' | 'xls' | 'xlsx' | 'xml';
|
|
426
|
+
itemReferenceID?: string;
|
|
427
|
+
}
|
|
428
|
+
}
|
|
429
|
+
interface SingleFile {
|
|
430
|
+
/**
|
|
431
|
+
* Base64-encoded file content
|
|
432
|
+
*/
|
|
433
|
+
inputContent: string;
|
|
434
|
+
/**
|
|
435
|
+
* The input type of the content you're sending for transformation.
|
|
436
|
+
*/
|
|
437
|
+
inputType: 'csv' | 'docx' | 'email' | 'heic' | 'html' | 'jpeg' | 'json' | 'heif' | 'm4a' | 'mp3' | 'pdf' | 'png' | 'text' | 'wav' | 'webp' | 'xls' | 'xlsx' | 'xml';
|
|
438
|
+
}
|
|
439
|
+
}
|
|
397
440
|
}
|
|
398
441
|
export interface WorkflowCopyParams {
|
|
399
442
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,QAAQ,EAAE;OAC/E,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,oBAAoB,EACpB,aAAa,EACb,KAAK,mBAAmB,EACzB;OAEM,EAAE,cAAc,EAAE;AAIzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIhD;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOxE
|
|
1
|
+
{"version":3,"file":"workflows.d.ts","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,YAAY;OACjB,KAAK,QAAQ;OACb,KAAK,YAAY;OACjB,KAAK,WAAW;OAChB,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,uBAAuB,EAAE,QAAQ,EAAE;OAC/E,EAAE,UAAU,EAAE;OACd,EACL,WAAW,EACX,oBAAoB,EACpB,aAAa,EACb,KAAK,mBAAmB,EACzB;OAEM,EAAE,cAAc,EAAE;AAIzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,sBAAsB,CAAC;IAIhG;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI9F;;OAEG;IACH,MAAM,CACJ,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,oBAAoB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;IAIrC;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,sBAAsB,EAAE,QAAQ,CAAC;IAIhD;;OAEG;IACH,MAAM,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CACF,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,QAAQ,CAAC,eAAe,CAAC;IAQvC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG3F;AAED,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;AAE7D,MAAM,MAAM,6BAA6B,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;AAE3E,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,KAAK,CAAC,EAAE,aAAa,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;IAElD;;OAEG;IACH,iBAAiB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;IAEnD;;OAEG;IACH,qBAAqB,CAAC,EAAE,YAAY,CAAC,iBAAiB,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,yBAAyB,CAAC;IAEpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,cAAc,CAAC,CAAC;IAE7D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,cAAc;QAC7B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,YAAY,CAAC,yBAAyB,CAAC;QAEjD;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,KAAK,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;IAEzC;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,EAAE,YAAY,CAAC,yBAAyB,CAAC;QAEjD;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE9B,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE3B,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,EAAE,kBAAkB,CAAC,KAAK,CAAC;IAEhC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,KAAK;QACpB,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;QAE9B,UAAU,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC;KAC/B;IAED,UAAiB,KAAK,CAAC;QACrB,UAAiB,UAAU;YACzB,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAClC;QAED,UAAiB,UAAU,CAAC;YAC1B,UAAiB,KAAK;gBACpB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,SAAS,EACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,CAAC;gBAEV,eAAe,CAAC,EAAE,MAAM,CAAC;aAC1B;SACF;QAED,UAAiB,UAAU;YACzB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EACL,KAAK,GACL,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,MAAM,GACN,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,GACL,MAAM,GACN,KAAK,CAAC;SACX;KACF;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;OAGG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAID,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -52,16 +52,25 @@ class Workflows extends resource_1.APIResource {
|
|
|
52
52
|
});
|
|
53
53
|
}
|
|
54
54
|
/**
|
|
55
|
-
* **Invoke a workflow
|
|
55
|
+
* **Invoke a workflow.**
|
|
56
56
|
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
57
|
+
* Submit the input file as either a multipart form request or a JSON request with
|
|
58
|
+
* base64-encoded file content. The workflow name is derived from the URL path.
|
|
59
|
+
*
|
|
60
|
+
* ## Input Formats
|
|
61
|
+
*
|
|
62
|
+
* - **Multipart form** (`multipart/form-data`): attach the file directly via the
|
|
63
|
+
* `file` or `files` fields. Set `wait` in the form body to control synchronous
|
|
64
|
+
* behaviour.
|
|
65
|
+
* - **JSON** (`application/json`): base64-encode the file content and set it in
|
|
66
|
+
* `input.singleFile.inputContent` or `input.batchFiles.inputs[*].inputContent`.
|
|
67
|
+
* Pass `wait=true` as a query parameter to control synchronous behaviour.
|
|
59
68
|
*
|
|
60
69
|
* ## Synchronous vs Asynchronous
|
|
61
70
|
*
|
|
62
71
|
* By default the call is created asynchronously and this endpoint returns
|
|
63
|
-
* `202 Accepted` immediately with a `pending` call object. Set
|
|
64
|
-
*
|
|
72
|
+
* `202 Accepted` immediately with a `pending` call object. Set `wait` to `true` to
|
|
73
|
+
* block until the call completes (up to 30 seconds):
|
|
65
74
|
*
|
|
66
75
|
* - On success: returns `200 OK` with the completed call, `outputs` populated
|
|
67
76
|
* - On failure: returns `500 Internal Server Error` with the call and an `error`
|
|
@@ -73,8 +82,9 @@ class Workflows extends resource_1.APIResource {
|
|
|
73
82
|
* Poll `GET /v3/calls/{callID}` to check status, or configure a webhook
|
|
74
83
|
* subscription to receive events when the call finishes.
|
|
75
84
|
*/
|
|
76
|
-
call(workflowName,
|
|
77
|
-
|
|
85
|
+
call(workflowName, params, options) {
|
|
86
|
+
const { wait, ...body } = params;
|
|
87
|
+
return this._client.post((0, path_1.path) `/v3/workflows/${workflowName}/call`, (0, uploads_1.maybeMultipartFormRequestOptions)({ query: { wait }, body, ...options }, this._client));
|
|
78
88
|
}
|
|
79
89
|
/**
|
|
80
90
|
* Copy a Workflow
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAIlD,mEAA0C;AAC1C,4CAAyG;AAEzG,yDAK+B;AAC/B,uDAAsD;AAEtD,
|
|
1
|
+
{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAIlD,mEAA0C;AAC1C,4CAAyG;AAEzG,yDAK+B;AAC/B,uDAAsD;AAEtD,uDAA0E;AAC1E,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgG1E,CAAC;IA9FC;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,YAAoB,EACpB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,0BAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,iBAAiB,YAAY,EAAE,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CACF,YAAoB,EACpB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAA,WAAI,EAAA,iBAAiB,YAAY,OAAO,EACxC,IAAA,0CAAgC,EAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACtF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAwB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AAjGD,8BAiGC;AA6gBD,SAAS,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
|
|
@@ -4,7 +4,7 @@ import * as VersionsAPI from "./versions.mjs";
|
|
|
4
4
|
import { Versions } from "./versions.mjs";
|
|
5
5
|
import { WorkflowsPage, } from "../../core/pagination.mjs";
|
|
6
6
|
import { buildHeaders } from "../../internal/headers.mjs";
|
|
7
|
-
import {
|
|
7
|
+
import { maybeMultipartFormRequestOptions } from "../../internal/uploads.mjs";
|
|
8
8
|
import { path } from "../../internal/utils/path.mjs";
|
|
9
9
|
/**
|
|
10
10
|
* Workflow operations
|
|
@@ -48,16 +48,25 @@ export class Workflows extends APIResource {
|
|
|
48
48
|
});
|
|
49
49
|
}
|
|
50
50
|
/**
|
|
51
|
-
* **Invoke a workflow
|
|
51
|
+
* **Invoke a workflow.**
|
|
52
52
|
*
|
|
53
|
-
*
|
|
54
|
-
*
|
|
53
|
+
* Submit the input file as either a multipart form request or a JSON request with
|
|
54
|
+
* base64-encoded file content. The workflow name is derived from the URL path.
|
|
55
|
+
*
|
|
56
|
+
* ## Input Formats
|
|
57
|
+
*
|
|
58
|
+
* - **Multipart form** (`multipart/form-data`): attach the file directly via the
|
|
59
|
+
* `file` or `files` fields. Set `wait` in the form body to control synchronous
|
|
60
|
+
* behaviour.
|
|
61
|
+
* - **JSON** (`application/json`): base64-encode the file content and set it in
|
|
62
|
+
* `input.singleFile.inputContent` or `input.batchFiles.inputs[*].inputContent`.
|
|
63
|
+
* Pass `wait=true` as a query parameter to control synchronous behaviour.
|
|
55
64
|
*
|
|
56
65
|
* ## Synchronous vs Asynchronous
|
|
57
66
|
*
|
|
58
67
|
* By default the call is created asynchronously and this endpoint returns
|
|
59
|
-
* `202 Accepted` immediately with a `pending` call object. Set
|
|
60
|
-
*
|
|
68
|
+
* `202 Accepted` immediately with a `pending` call object. Set `wait` to `true` to
|
|
69
|
+
* block until the call completes (up to 30 seconds):
|
|
61
70
|
*
|
|
62
71
|
* - On success: returns `200 OK` with the completed call, `outputs` populated
|
|
63
72
|
* - On failure: returns `500 Internal Server Error` with the call and an `error`
|
|
@@ -69,8 +78,9 @@ export class Workflows extends APIResource {
|
|
|
69
78
|
* Poll `GET /v3/calls/{callID}` to check status, or configure a webhook
|
|
70
79
|
* subscription to receive events when the call finishes.
|
|
71
80
|
*/
|
|
72
|
-
call(workflowName,
|
|
73
|
-
|
|
81
|
+
call(workflowName, params, options) {
|
|
82
|
+
const { wait, ...body } = params;
|
|
83
|
+
return this._client.post(path `/v3/workflows/${workflowName}/call`, maybeMultipartFormRequestOptions({ query: { wait }, body, ...options }, this._client));
|
|
74
84
|
}
|
|
75
85
|
/**
|
|
76
86
|
* Copy a Workflow
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"workflows.mjs","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,KAAK,WAAW;OAChB,EAAqE,QAAQ,EAAE;OAE/E,EAGL,aAAa,GAEd;OACM,EAAE,YAAY,EAAE;OAEhB,EAAE,
|
|
1
|
+
{"version":3,"file":"workflows.mjs","sourceRoot":"","sources":["../../src/resources/workflows/workflows.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,KAAK,WAAW;OAChB,EAAqE,QAAQ,EAAE;OAE/E,EAGL,aAAa,GAEd;OACM,EAAE,YAAY,EAAE;OAEhB,EAAE,gCAAgC,EAAE;OACpC,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IAA1C;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAgG1E,CAAC;IA9FC;;OAEG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,YAAoB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,YAAoB,EACpB,IAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,EAAE,CAAA,aAAuB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClG,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAoB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,iBAAiB,YAAY,EAAE,EAAE;YAC9D,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CACF,YAAoB,EACpB,MAA0B,EAC1B,OAAwB;QAExB,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACjC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,IAAI,CAAA,iBAAiB,YAAY,OAAO,EACxC,gCAAgC,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACtF,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,IAAwB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;CACF;AA6gBD,SAAS,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
|