browser-use-sdk 2.0.7 → 2.0.9

package/dist/esm/api/resources/workflows/client/Client.d.mts

@@ -1,33 +1,33 @@
 import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
 import * as core from "../../../../core/index.mjs";
 import * as BrowserUse from "../../../index.mjs";
-export declare namespace Workflows {
+export declare namespace WorkflowsClient {
     interface Options extends BaseClientOptions {
     }
     interface RequestOptions extends BaseRequestOptions {
     }
 }
-export declare class Workflows {
-    protected readonly _options: Workflows.Options;
-    constructor(_options: Workflows.Options);
+export declare class WorkflowsClient {
+    protected readonly _options: WorkflowsClient.Options;
+    constructor(options: WorkflowsClient.Options);
     /**
      * Get paginated list of workflows with optional filtering.
      *
      * @param {BrowserUse.ListWorkflowsWorkflowsGetRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.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>;
+    listWorkflows(request?: BrowserUse.ListWorkflowsWorkflowsGetRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -36,13 +36,13 @@ export declare class Workflows {
      *         name: "name"
      *     })
      */
-    createWorkflow(request: BrowserUse.WorkflowCreateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    createWorkflow(request: BrowserUse.WorkflowCreateRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -51,13 +51,13 @@ export declare class Workflows {
      *         workflow_id: "workflow_id"
      *     })
      */
-    getWorkflow(request: BrowserUse.GetWorkflowWorkflowsWorkflowIdGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    getWorkflow(request: BrowserUse.GetWorkflowWorkflowsWorkflowIdGetRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
     private __getWorkflow;
     /**
      * Archive a workflow (soft delete).
      *
      * @param {BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -66,13 +66,13 @@ export declare class Workflows {
      *         workflow_id: "workflow_id"
      *     })
      */
-    deleteWorkflow(request: BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    deleteWorkflow(request: BrowserUse.DeleteWorkflowWorkflowsWorkflowIdDeleteRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
     private __deleteWorkflow;
     /**
      * Update workflow metadata.
      *
      * @param {BrowserUse.WorkflowUpdateRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -81,8 +81,27 @@ export declare class Workflows {
      *         workflow_id: "workflow_id"
      *     })
      */
-    updateWorkflow(request: BrowserUse.WorkflowUpdateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
+    updateWorkflow(request: BrowserUse.WorkflowUpdateRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowResponse>;
     private __updateWorkflow;
+    /**
+     * Get workflow generation state with live browser URL for polling.
+     *
+     * This endpoint returns the current state of workflow generation including
+     * the live browser URL (if available). It's designed to be polled every 2 seconds
+     * during generation to show real-time browser activity in the frontend.
+     *
+     * @param {BrowserUse.GetWorkflowGenerationStateWorkflowsWorkflowIdGenerationStateGetRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getWorkflowGenerationState({
+     *         workflow_id: "workflow_id"
+     *     })
+     */
+    getWorkflowGenerationState(request: BrowserUse.GetWorkflowGenerationStateWorkflowsWorkflowIdGenerationStateGetRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowGenerationStateView>;
+    private __getWorkflowGenerationState;
     /**
      * Get a presigned URL to upload workflow YAML directly to S3 from the browser.
      *
@@ -90,7 +109,7 @@ export declare class Workflows {
      * and avoiding KMS permission issues in local development.
      *
      * @param {BrowserUse.WorkflowYamlPresignedUploadRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -100,26 +119,26 @@ export declare class Workflows {
      *         sizeBytes: 1
      *     })
      */
-    getWorkflowYamlPresignedUrl(request: BrowserUse.WorkflowYamlPresignedUploadRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowYamlPresignedUploadResponse>;
+    getWorkflowYamlPresignedUrl(request: BrowserUse.WorkflowYamlPresignedUploadRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowYamlPresignedUploadResponse>;
     private __getWorkflowYamlPresignedUrl;
     /**
-     * Execute a workflow either synchronously or asynchronously.
+     * Execute a workflow 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)
+     * Returns execution ID immediately and processes in background via Inngest.
+     * Use the GET /workflows/executions/{execution_id} endpoint to check status and retrieve results.
      *
      * @param {BrowserUse.WorkflowExecuteRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
      * @example
-     *     await client.workflows.executeWorkflow({
+     *     await client.workflows.runWorkflow({
      *         workflow_id: "workflow_id"
      *     })
      */
-    executeWorkflow(request: BrowserUse.WorkflowExecuteRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.ExecuteWorkflowWorkflowsWorkflowIdExecutePostResponse>;
-    private __executeWorkflow;
+    runWorkflow(request: BrowserUse.WorkflowExecuteRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionCreatedResponse>;
+    private __runWorkflow;
     /**
      * Generate a workflow from a natural language task description.
      *
@@ -132,7 +151,7 @@ export declare class Workflows {
      * The generation happens asynchronously via the workflow_worker Lambda.
      *
      * @param {BrowserUse.WorkflowGenerateRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -142,13 +161,13 @@ export declare class Workflows {
      *         taskPrompt: "Go to github.com and search for browser-use"
      *     })
      */
-    generateWorkflow(request: BrowserUse.WorkflowGenerateRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowGenerateResponse>;
+    generateWorkflow(request: BrowserUse.WorkflowGenerateRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -157,13 +176,13 @@ export declare class Workflows {
      *         execution_id: "execution_id"
      *     })
      */
-    getExecution(request: BrowserUse.GetExecutionWorkflowsExecutionsExecutionIdGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionResponse>;
+    getExecution(request: BrowserUse.GetExecutionWorkflowsExecutionsExecutionIdGetRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -172,26 +191,26 @@ export declare class Workflows {
      *         workflow_id: "workflow_id"
      *     })
      */
-    listWorkflowExecutions(request: BrowserUse.ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionListResponse>;
+    listWorkflowExecutions(request: BrowserUse.ListWorkflowExecutionsWorkflowsWorkflowIdExecutionsGetRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.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>;
+    listAllExecutions(request?: BrowserUse.ListAllExecutionsWorkflowsExecutionsGetRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -200,13 +219,13 @@ export declare class Workflows {
      *         execution_id: "execution_id"
      *     })
      */
-    cancelExecution(request: BrowserUse.CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionResponse>;
+    cancelExecution(request: BrowserUse.CancelExecutionWorkflowsExecutionsExecutionIdCancelPatchRequest, requestOptions?: WorkflowsClient.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.
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link BrowserUse.UnprocessableEntityError}
      *
@@ -215,7 +234,45 @@ export declare class Workflows {
      *         execution_id: "execution_id"
      *     })
      */
-    getExecutionLogs(request: BrowserUse.GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionLogResponse>;
+    getExecutionLogs(request: BrowserUse.GetExecutionLogsWorkflowsExecutionsExecutionIdLogsGetRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionLogResponse>;
     private __getExecutionLogs;
+    /**
+     * Get workflow execution state with steps for live UI polling.
+     *
+     * This endpoint returns the current state of a workflow execution including all steps
+     * with their details. It's designed to be polled every 2 seconds during execution
+     * to show real-time progress in the frontend.
+     *
+     * @param {BrowserUse.GetExecutionStateWorkflowsExecutionsExecutionIdStateGetRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getExecutionState({
+     *         execution_id: "execution_id"
+     *     })
+     */
+    getExecutionState(request: BrowserUse.GetExecutionStateWorkflowsExecutionsExecutionIdStateGetRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionStateView>;
+    private __getExecutionState;
+    /**
+     * Get workflow execution media (screenshots) with presigned URLs.
+     *
+     * This endpoint returns media URLs for completed executions. Screenshots
+     * are returned with presigned S3 URLs for direct access from the frontend.
+     * Should be called when execution status is 'completed', 'failed', or 'cancelled'.
+     *
+     * @param {BrowserUse.GetExecutionMediaWorkflowsExecutionsExecutionIdMediaGetRequest} request
+     * @param {WorkflowsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link BrowserUse.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workflows.getExecutionMedia({
+     *         execution_id: "execution_id"
+     *     })
+     */
+    getExecutionMedia(request: BrowserUse.GetExecutionMediaWorkflowsExecutionsExecutionIdMediaGetRequest, requestOptions?: WorkflowsClient.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionMediaView>;
+    private __getExecutionMedia;
     protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
 }