browser-use-sdk 2.0.4 → 2.0.5

package/dist/cjs/api/resources/workflows/client/Client.d.ts

@@ -0,0 +1,221 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as BrowserUse from "../../../index.js";
+export declare namespace Workflows {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Workflows {
+    protected readonly _options: Workflows.Options;
+    constructor(_options: Workflows.Options);
+    /**
+     * Get paginated list of workflows with optional filtering.
+     *
+     * @param {BrowserUse.ListWorkflowsWorkflowsGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.listWorkflows()
+     */
+    listWorkflows(request?: BrowserUse.ListWorkflowsWorkflowsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowListResponse>;
+    private __listWorkflows;
+    /**
+     * Create a new workflow. The workflow YAML should be uploaded separately via the update endpoint.
+     *
+     * @param {BrowserUse.WorkflowCreateRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.createWorkflow({
+     *         name: "name"
+     *     })
+     */
+    createWorkflow(request: BrowserUse.WorkflowCreateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    private __createWorkflow;
+    /**
+     * Get detailed workflow information including presigned URL to download YAML.
+     *
+     * @param {BrowserUse.GetWorkflowWorkflowsWorkflowIdGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getWorkflow({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    getWorkflow(request: BrowserUse.GetWorkflowWorkflowsWorkflowIdGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    private __getWorkflow;
+    /**
+     * Archive a workflow (soft delete).
+     *
+     * @param {BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.deleteWorkflow({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    deleteWorkflow(request: BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    private __deleteWorkflow;
+    /**
+     * Update workflow metadata.
+     *
+     * @param {BrowserUse.WorkflowUpdateRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.updateWorkflow({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    updateWorkflow(request: BrowserUse.WorkflowUpdateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    private __updateWorkflow;
+    /**
+     * Get a presigned URL to upload workflow YAML directly to S3 from the browser.
+     *
+     * This avoids sending the YAML content through the backend, reducing latency
+     * and avoiding KMS permission issues in local development.
+     *
+     * @param {BrowserUse.WorkflowYamlPresignedUploadRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getWorkflowYamlPresignedUrl({
+     *         workflow_id: "workflow_id",
+     *         sizeBytes: 1
+     *     })
+     */
+    getWorkflowYamlPresignedUrl(request: BrowserUse.WorkflowYamlPresignedUploadRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowYamlPresignedUploadResponse>;
+    private __getWorkflowYamlPresignedUrl;
+    /**
+     * Execute a workflow either synchronously or asynchronously.
+     *
+     * - ASYNC mode: Returns execution ID immediately and processes in background via Lambda
+     * - SYNC mode: Waits for execution to complete and returns results inline (max 5 min timeout)
+     *
+     * @param {BrowserUse.WorkflowExecuteRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.executeWorkflow({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    executeWorkflow(request: BrowserUse.WorkflowExecuteRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse>;
+    private __executeWorkflow;
+    /**
+     * Generate a workflow from a natural language task description.
+     *
+     * This endpoint uses the workflow-use library's HealingService to:
+     * 1. Record browser interactions for the task
+     * 2. Convert interactions to a reusable workflow
+     * 3. Extract variables for parameterization
+     * 4. Save the generated YAML to S3
+     *
+     * The generation happens asynchronously via the workflow_worker Lambda.
+     *
+     * @param {BrowserUse.WorkflowGenerateRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.generateWorkflow({
+     *         workflow_id: "workflow_id",
+     *         taskPrompt: "Go to github.com and search for browser-use"
+     *     })
+     */
+    generateWorkflow(request: BrowserUse.WorkflowGenerateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowGenerateResponse>;
+    private __generateWorkflow;
+    /**
+     * Get detailed execution information including status, results, and costs.
+     *
+     * @param {BrowserUse.GetExecutionWorkflowsExecutionsExecutionIdGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getExecution({
+     *         execution_id: "execution_id"
+     *     })
+     */
+    getExecution(request: BrowserUse.GetExecutionWorkflowsExecutionsExecutionIdGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionResponse>;
+    private __getExecution;
+    /**
+     * Get paginated list of executions for a specific workflow.
+     *
+     * @param {BrowserUse.ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.listWorkflowExecutions({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    listWorkflowExecutions(request: BrowserUse.ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionListResponse>;
+    private __listWorkflowExecutions;
+    /**
+     * Get paginated list of all workflow executions for a project.
+     *
+     * @param {BrowserUse.ListAllExecutionsWorkflowsExecutionsGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.listAllExecutions()
+     */
+    listAllExecutions(request?: BrowserUse.ListAllExecutionsWorkflowsExecutionsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionListResponse>;
+    private __listAllExecutions;
+    /**
+     * Cancel a pending or running workflow execution.
+     *
+     * @param {BrowserUse.CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.cancelExecution({
+     *         execution_id: "execution_id"
+     *     })
+     */
+    cancelExecution(request: BrowserUse.CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionResponse>;
+    private __cancelExecution;
+    /**
+     * Get presigned URL to download execution logs.
+     *
+     * @param {BrowserUse.GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest} request
+     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getExecutionLogs({
+     *         execution_id: "execution_id"
+     *     })
+     */
+    getExecutionLogs(request: BrowserUse.GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionLogResponse>;
+    private __getExecutionLogs;
+    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
+}