bem-ai-sdk 0.3.0 → 0.4.0

package/src/resources/functions/functions.ts

@@ -87,6 +87,7 @@ export type CreateFunction =
   | CreateFunction.TransformFunction
   | CreateFunction.AnalyzeFunction
   | CreateFunction.RouteFunction
+  | CreateFunction.SendFunction
   | CreateFunction.SplitFunction
   | CreateFunction.JoinFunction
   | CreateFunction.PayloadShapingFunction
@@ -187,6 +188,56 @@ export namespace CreateFunction {
     tags?: Array<string>;
   }
 
+  export interface SendFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -491,15 +542,15 @@ export interface EnrichStep {
 }
 
 /**
- * A function that transforms and customizes input payloads using JMESPath
- * expressions. Payload shaping allows you to extract specific data, perform
- * calculations, and reshape complex input structures into simplified, standardized
- * output formats tailored to your downstream systems or business requirements.
+ * A function that delivers workflow outputs to an external destination. Send
+ * functions receive the output of an upstream workflow node and forward it to a
+ * webhook, S3 bucket, or Google Drive folder.
  */
 export type Function =
   | Function.TransformFunction
   | Function.AnalyzeFunction
   | Function.RouteFunction
+  | Function.SendFunction
   | Function.SplitFunction
   | Function.JoinFunction
   | Function.PayloadShapingFunction
@@ -672,6 +723,81 @@ export namespace Function {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  /**
+   * A function that delivers workflow outputs to an external destination. Send
+   * functions receive the output of an upstream workflow node and forward it to a
+   * webhook, S3 bucket, or Google Drive folder.
+   */
+  export interface SendFunction {
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Version number of function.
+     */
+    versionNum: number;
+
+    /**
+     * Audit trail information for the function.
+     */
+    audit?: FunctionsAPI.FunctionAudit;
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Google Drive folder ID. Present when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Present when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * S3 key prefix (folder path). Optional, present when destinationType is s3.
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+
+    /**
+     * Whether webhook payloads are signed with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Present when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     /**
      * Unique identifier of function.
@@ -948,10 +1074,9 @@ export interface FunctionAudit {
  */
 export interface FunctionResponse {
   /**
-   * A function that transforms and customizes input payloads using JMESPath
-   * expressions. Payload shaping allows you to extract specific data, perform
-   * calculations, and reshape complex input structures into simplified, standardized
-   * output formats tailored to your downstream systems or business requirements.
+   * A function that delivers workflow outputs to an external destination. Send
+   * functions receive the output of an upstream workflow node and forward it to a
+   * webhook, S3 bucket, or Google Drive folder.
    */
   function: Function;
 }
@@ -962,6 +1087,7 @@ export interface FunctionResponse {
 export type FunctionType =
   | 'transform'
   | 'route'
+  | 'send'
   | 'split'
   | 'join'
   | 'analyze'
@@ -1035,6 +1161,7 @@ export type UpdateFunction =
   | UpdateFunction.TransformFunction
   | UpdateFunction.AnalyzeFunction
   | UpdateFunction.RouteFunction
+  | UpdateFunction.SendFunction
   | UpdateFunction.SplitFunction
   | UpdateFunction.JoinFunction
   | UpdateFunction.PayloadShapingFunction
@@ -1135,6 +1262,56 @@ export namespace UpdateFunction {
     tags?: Array<string>;
   }
 
+  export interface SendFunction {
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface SplitFunction {
     type: 'split';
 
@@ -1339,6 +1516,7 @@ export type FunctionCreateParams =
   | FunctionCreateParams.CreateTransformFunction
   | FunctionCreateParams.CreateAnalyzeFunction
   | FunctionCreateParams.CreateRouteFunction
+  | FunctionCreateParams.CreateSendFunction
   | FunctionCreateParams.CreateSplitFunction
   | FunctionCreateParams.CreateJoinFunction
   | FunctionCreateParams.CreatePayloadShapingFunction
@@ -1439,6 +1617,56 @@ export declare namespace FunctionCreateParams {
     tags?: Array<string>;
   }
 
+  export interface CreateSendFunction {
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface CreateSplitFunction {
     /**
      * Name of function. Must be UNIQUE on a per-environment basis.
@@ -1596,6 +1824,7 @@ export type FunctionUpdateParams =
   | FunctionUpdateParams.UpsertTransformFunction
   | FunctionUpdateParams.UpsertAnalyzeFunction
   | FunctionUpdateParams.UpsertRouteFunction
+  | FunctionUpdateParams.UpsertSendFunction
   | FunctionUpdateParams.UpsertSplitFunction
   | FunctionUpdateParams.UpsertJoinFunction
   | FunctionUpdateParams.UpsertPayloadShapingFunction
@@ -1696,6 +1925,56 @@ export declare namespace FunctionUpdateParams {
     tags?: Array<string>;
   }
 
+  export interface UpsertSendFunction {
+    type: 'send';
+
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType?: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName?: string;
+
+    /**
+     * Google Drive folder ID. Required when destinationType is google_drive. Managed
+     * via Paragon OAuth.
+     */
+    googleDriveFolderId?: string;
+
+    /**
+     * S3 bucket to upload the payload to. Required when destinationType is s3.
+     */
+    s3Bucket?: string;
+
+    /**
+     * Optional S3 key prefix (folder path).
+     */
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Whether to sign webhook payloads with an HMAC-SHA256 signature.
+     */
+    webhookSigningEnabled?: boolean;
+
+    /**
+     * Webhook URL to POST the payload to. Required when destinationType is webhook.
+     */
+    webhookUrl?: string;
+  }
+
   export interface UpsertSplitFunction {
     type: 'split';
 

package/src/resources/functions/versions.ts

@@ -51,6 +51,7 @@ export type FunctionVersion =
   | FunctionVersion.TransformFunctionVersion
   | FunctionVersion.AnalyzeFunctionVersion
   | FunctionVersion.RouteFunctionVersion
+  | FunctionVersion.SendFunctionVersion
   | FunctionVersion.SplitFunctionVersion
   | FunctionVersion.JoinFunctionVersion
   | FunctionVersion.EnrichFunctionVersion
@@ -238,6 +239,65 @@ export namespace FunctionVersion {
     usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
   }
 
+  export interface SendFunctionVersion {
+    /**
+     * Destination type for a Send function.
+     */
+    destinationType: 'webhook' | 's3' | 'google_drive';
+
+    /**
+     * Unique identifier of function.
+     */
+    functionID: string;
+
+    /**
+     * Name of function. Must be UNIQUE on a per-environment basis.
+     */
+    functionName: string;
+
+    type: 'send';
+
+    /**
+     * Version number of function.
+     */
+    versionNum: number;
+
+    /**
+     * Audit trail information for the function version.
+     */
+    audit?: FunctionsAPI.FunctionAudit;
+
+    /**
+     * The date and time the function version was created.
+     */
+    createdAt?: string;
+
+    /**
+     * Display name of function. Human-readable name to help you identify the function.
+     */
+    displayName?: string;
+
+    googleDriveFolderId?: string;
+
+    s3Bucket?: string;
+
+    s3Prefix?: string;
+
+    /**
+     * Array of tags to categorize and organize functions.
+     */
+    tags?: Array<string>;
+
+    /**
+     * List of workflows that use this function.
+     */
+    usedInWorkflows?: Array<FunctionsAPI.WorkflowUsageInfo>;
+
+    webhookSigningEnabled?: boolean;
+
+    webhookUrl?: string;
+  }
+
   export interface SplitFunctionVersion {
     /**
      * Unique identifier of function.

package/src/resources/workflows/workflows.ts

@@ -15,7 +15,7 @@ import {
 } from '../../core/pagination';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
-import { multipartFormRequestOptions } from '../../internal/uploads';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
 /**
@@ -70,16 +70,25 @@ export class Workflows extends APIResource {
   }
 
   /**
-   * **Invoke a workflow by submitting a multipart form request.**
+   * **Invoke a workflow.**
    *
-   * Workflows can only be called via multipart form in V3. Submit the input file
-   * along with an optional reference ID for tracking.
+   * Submit the input file as either a multipart form request or a JSON request with
+   * base64-encoded file content. The workflow name is derived from the URL path.
+   *
+   * ## Input Formats
+   *
+   * - **Multipart form** (`multipart/form-data`): attach the file directly via the
+   *   `file` or `files` fields. Set `wait` in the form body to control synchronous
+   *   behaviour.
+   * - **JSON** (`application/json`): base64-encode the file content and set it in
+   *   `input.singleFile.inputContent` or `input.batchFiles.inputs[*].inputContent`.
+   *   Pass `wait=true` as a query parameter to control synchronous behaviour.
    *
    * ## Synchronous vs Asynchronous
    *
    * By default the call is created asynchronously and this endpoint returns
-   * `202 Accepted` immediately with a `pending` call object. Set the `wait` field to
-   * `true` to block until the call completes (up to 30 seconds):
+   * `202 Accepted` immediately with a `pending` call object. Set `wait` to `true` to
+   * block until the call completes (up to 30 seconds):
    *
    * - On success: returns `200 OK` with the completed call, `outputs` populated
    * - On failure: returns `500 Internal Server Error` with the call and an `error`
@@ -93,12 +102,13 @@ export class Workflows extends APIResource {
    */
   call(
     workflowName: string,
-    body: WorkflowCallParams,
+    params: WorkflowCallParams,
     options?: RequestOptions,
   ): APIPromise<CallsAPI.CallGetResponse> {
+    const { wait, ...body } = params;
     return this._client.post(
       path`/v3/workflows/${workflowName}/call`,
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      maybeMultipartFormRequestOptions({ query: { wait }, body, ...options }, this._client),
     );
   }
 
@@ -498,25 +508,102 @@ export interface WorkflowListParams extends WorkflowsPageParams {
 
 export interface WorkflowCallParams {
   /**
-   * Your reference ID for tracking this call.
+   * Body param: Input to the workflow call. Provide exactly one of `singleFile` or
+   * `batchFiles`.
    */
-  callReferenceID?: string;
+  input: WorkflowCallParams.Input;
 
   /**
-   * Single input file (for transform, analyze, route, and split functions).
+   * Query param: When `true`, the endpoint blocks until the call completes (up to 30
+   * seconds) and returns the finished call object. Default: `false`.
    */
-  file?: unknown;
+  wait?: boolean;
 
   /**
-   * Multiple input files (for join functions).
+   * Body param: Your reference ID for tracking this call.
    */
-  files?: Array<unknown>;
+  callReferenceID?: string;
+}
 
+export namespace WorkflowCallParams {
   /**
-   * When `true`, the endpoint blocks until the call completes (up to 30 seconds) and
-   * returns the finished call object. Default: `false`.
+   * Input to the workflow call. Provide exactly one of `singleFile` or `batchFiles`.
    */
-  wait?: string;
+  export interface Input {
+    batchFiles?: Input.BatchFiles;
+
+    singleFile?: Input.SingleFile;
+  }
+
+  export namespace Input {
+    export interface BatchFiles {
+      inputs?: Array<BatchFiles.Input>;
+    }
+
+    export namespace BatchFiles {
+      export interface Input {
+        /**
+         * Base64-encoded file content
+         */
+        inputContent: string;
+
+        /**
+         * The input type of the content you're sending for transformation.
+         */
+        inputType:
+          | 'csv'
+          | 'docx'
+          | 'email'
+          | 'heic'
+          | 'html'
+          | 'jpeg'
+          | 'json'
+          | 'heif'
+          | 'm4a'
+          | 'mp3'
+          | 'pdf'
+          | 'png'
+          | 'text'
+          | 'wav'
+          | 'webp'
+          | 'xls'
+          | 'xlsx'
+          | 'xml';
+
+        itemReferenceID?: string;
+      }
+    }
+
+    export interface SingleFile {
+      /**
+       * Base64-encoded file content
+       */
+      inputContent: string;
+
+      /**
+       * The input type of the content you're sending for transformation.
+       */
+      inputType:
+        | 'csv'
+        | 'docx'
+        | 'email'
+        | 'heic'
+        | 'html'
+        | 'jpeg'
+        | 'json'
+        | 'heif'
+        | 'm4a'
+        | 'mp3'
+        | 'pdf'
+        | 'png'
+        | 'text'
+        | 'wav'
+        | 'webp'
+        | 'xls'
+        | 'xlsx'
+        | 'xml';
+    }
+  }
 }
 
 export interface WorkflowCopyParams {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.4.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.0'; // x-release-please-version
+exports.VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.4.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map