browser-use-sdk 2.0.15 → 3.0.2

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

@@ -1,306 +0,0 @@
-import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
-import * as core from "../../../../core/index.mjs";
-import * as BrowserUse from "../../../index.mjs";
-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 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 {Workflows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link BrowserUse.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.workflows.getWorkflowGenerationState({
-     *         workflow_id: "workflow_id"
-     *     })
-     */
-    getWorkflowGenerationState(request: BrowserUse.GetWorkflowGenerationStateWorkflowsWorkflowIdGenerationStateGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowGenerationStateView>;
-    private __getWorkflowGenerationState;
-    /**
-     * Create a workflow from an existing agent task's recorded history.
-     *
-     * This endpoint creates a workflow by using the browser-use rerun history
-     * feature. The task must have completed with history stored in S3.
-     *
-     * The workflow creation process:
-     * 1. Creates a new workflow record in pending state
-     * 2. Triggers an Inngest event to process the task history
-     * 3. The Inngest handler downloads history, detects variables, and updates the workflow
-     *
-     * Use GET /workflows/{workflow_id} to poll for creation completion.
-     *
-     * @param {BrowserUse.WorkflowCreateFromTaskRequest} request
-     * @param {Workflows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link BrowserUse.NotFoundError}
-     * @throws {@link BrowserUse.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.workflows.createWorkflowFromTask({
-     *         name: "name",
-     *         taskId: "taskId",
-     *         sessionId: "sessionId"
-     *     })
-     */
-    createWorkflowFromTask(request: BrowserUse.WorkflowCreateFromTaskRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowCreateFromTaskResponse>;
-    private __createWorkflowFromTask;
-    /**
-     * 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 asynchronously.
-     *
-     * 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.
-     *
-     * @throws {@link BrowserUse.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.workflows.runWorkflow({
-     *         workflow_id: "workflow_id"
-     *     })
-     */
-    runWorkflow(request: BrowserUse.WorkflowExecuteRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionCreatedResponse>;
-    private __runWorkflow;
-    /**
-     * 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;
-    /**
-     * 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 {Workflows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link BrowserUse.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.workflows.getExecutionState({
-     *         execution_id: "execution_id"
-     *     })
-     */
-    getExecutionState(request: BrowserUse.GetExecutionStateWorkflowsExecutionsExecutionIdStateGetRequest, requestOptions?: Workflows.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 {Workflows.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link BrowserUse.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.workflows.getExecutionMedia({
-     *         execution_id: "execution_id"
-     *     })
-     */
-    getExecutionMedia(request: BrowserUse.GetExecutionMediaWorkflowsExecutionsExecutionIdMediaGetRequest, requestOptions?: Workflows.RequestOptions): core.HttpResponsePromise<BrowserUse.WorkflowExecutionMediaView>;
-    private __getExecutionMedia;
-    protected _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>>;
-}