@skyvern/client 0.2.21 → 0.2.23

package/dist/cjs/api/types/BrowserProfile.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ClickAction.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Click action parameters.
+ */
+export interface ClickAction {
+    /** CSS selector for the element */
+    selector?: string;
+    /** The intention or goal of the click */
+    intention?: string;
+    /** Additional context data */
+    data?: ClickAction.Data;
+    /** Timeout in milliseconds */
+    timeout?: number;
+}
+export declare namespace ClickAction {
+    /**
+     * Additional context data
+     */
+    type Data = string | Record<string, unknown>;
+}

package/dist/cjs/api/types/ClickAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ClickContext.d.ts

@@ -0,0 +1,4 @@
+export interface ClickContext {
+    thought?: string;
+    single_option_click?: boolean;
+}

package/dist/cjs/api/types/ClickContext.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/ExtractAction.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Extract data action parameters.
+ */
+export interface ExtractAction {
+    /** Extraction prompt */
+    prompt?: string;
+    /** Schema for extraction */
+    extract_schema?: ExtractAction.ExtractSchema;
+    /** Error code mapping for extraction */
+    error_code_mapping?: Record<string, string | undefined>;
+    /** The intention or goal of the extraction */
+    intention?: string;
+    /** Additional context data */
+    data?: ExtractAction.Data;
+}
+export declare namespace ExtractAction {
+    /**
+     * Schema for extraction
+     */
+    type ExtractSchema = Record<string, unknown> | unknown[] | string;
+    /**
+     * Additional context data
+     */
+    type Data = string | Record<string, unknown>;
+}

package/dist/cjs/api/types/ExtractAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/Folder.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Response model for a folder
+ */
+export interface Folder {
+    /** Folder title */
+    title: string;
+    /** Folder description */
+    description?: string;
+    folder_id: string;
+    organization_id: string;
+    /** Number of workflows in this folder */
+    workflow_count?: number;
+    created_at: string;
+    modified_at: string;
+}

package/dist/cjs/api/types/Folder.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/InputOrSelectContext.d.ts

@@ -5,4 +5,5 @@ export interface InputOrSelectContext {
     is_search_bar?: boolean;
     is_location_input?: boolean;
     is_date_related?: boolean;
+    date_format?: string;
 }

package/dist/cjs/api/types/InputTextAction.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Input text action parameters.
+ */
+export interface InputTextAction {
+    /** CSS selector for the element */
+    selector?: string;
+    /** Value to input */
+    value?: string;
+    /** The intention or goal of the input */
+    intention?: string;
+    /** Additional context data */
+    data?: InputTextAction.Data;
+    /** TOTP identifier for input_text actions */
+    totp_identifier?: string;
+    /** TOTP URL for input_text actions */
+    totp_url?: string;
+    /** Timeout in milliseconds */
+    timeout?: number;
+}
+export declare namespace InputTextAction {
+    /**
+     * Additional context data
+     */
+    type Data = string | Record<string, unknown>;
+}

package/dist/cjs/api/types/InputTextAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/RunSdkActionRequestAction.d.ts

@@ -0,0 +1,25 @@
+import type * as Skyvern from "../index.js";
+/**
+ * The action to execute with its specific parameters
+ */
+export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.AiUploadFile | Skyvern.RunSdkActionRequestAction.Extract;
+export declare namespace RunSdkActionRequestAction {
+    interface AiAct extends Skyvern.ActAction {
+        type: "ai_act";
+    }
+    interface AiClick extends Skyvern.ClickAction {
+        type: "ai_click";
+    }
+    interface AiInputText extends Skyvern.InputTextAction {
+        type: "ai_input_text";
+    }
+    interface AiSelectOption extends Skyvern.SelectOptionAction {
+        type: "ai_select_option";
+    }
+    interface AiUploadFile extends Skyvern.UploadFileAction {
+        type: "ai_upload_file";
+    }
+    interface Extract extends Skyvern.ExtractAction {
+        type: "extract";
+    }
+}

package/dist/cjs/api/types/RunSdkActionRequestAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/RunSdkActionResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Response from running an SDK action.
+ */
+export interface RunSdkActionResponse {
+    /** The workflow run ID used for this action */
+    workflow_run_id: string;
+    /** The result from the action (e.g., selector, value, extracted data) */
+    result?: unknown;
+}

package/dist/cjs/api/types/RunSdkActionResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/SelectOptionAction.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Select option action parameters.
+ */
+export interface SelectOptionAction {
+    /** CSS selector for the element */
+    selector?: string;
+    /** Value to select */
+    value?: string;
+    /** The intention or goal of the selection */
+    intention?: string;
+    /** Additional context data */
+    data?: SelectOptionAction.Data;
+    /** Timeout in milliseconds */
+    timeout?: number;
+}
+export declare namespace SelectOptionAction {
+    /**
+     * Additional context data
+     */
+    type Data = string | Record<string, unknown>;
+}

package/dist/cjs/api/types/SelectOptionAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/TaskRunResponse.d.ts

@@ -28,6 +28,8 @@ export interface TaskRunResponse {
     app_url?: string;
     /** ID of the Skyvern persistent browser session used for this run */
     browser_session_id?: string;
+    /** ID of the browser profile used for this run */
+    browser_profile_id?: string;
     /** The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot */
     max_screenshot_scrolls?: number;
     /** The script run result */

package/dist/cjs/api/types/UploadFileAction.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Upload file action parameters.
+ */
+export interface UploadFileAction {
+    /** CSS selector for the element */
+    selector?: string;
+    /** File URL for upload */
+    file_url?: string;
+    /** The intention or goal of the upload */
+    intention?: string;
+    /** Additional context data */
+    data?: UploadFileAction.Data;
+    /** Timeout in milliseconds */
+    timeout?: number;
+}
+export declare namespace UploadFileAction {
+    /**
+     * Additional context data
+     */
+    type Data = string | Record<string, unknown>;
+}

package/dist/cjs/api/types/UploadFileAction.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/types/Workflow.d.ts

@@ -22,6 +22,8 @@ export interface Workflow {
     cache_key?: string;
     run_sequentially?: boolean;
     sequential_key?: string;
+    folder_id?: string;
+    import_error?: string;
     created_at: string;
     modified_at: string;
     deleted_at?: string;

package/dist/cjs/api/types/WorkflowCreateYamlRequest.d.ts

@@ -18,4 +18,5 @@ export interface WorkflowCreateYamlRequest {
     cache_key?: string;
     run_sequentially?: boolean;
     sequential_key?: string;
+    folder_id?: string;
 }

package/dist/cjs/api/types/WorkflowRunRequest.d.ts

@@ -43,6 +43,8 @@ export interface WorkflowRunRequest {
     totp_identifier?: string;
     /** ID of a Skyvern browser session to reuse, having it continue from the current screen state */
     browser_session_id?: string;
+    /** ID of a browser profile to reuse for this workflow run */
+    browser_profile_id?: string;
     /** The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot. */
     max_screenshot_scrolls?: number;
     /** The extra HTTP headers for the requests in browser. */

package/dist/cjs/api/types/WorkflowRunResponse.d.ts

@@ -28,6 +28,8 @@ export interface WorkflowRunResponse {
     app_url?: string;
     /** ID of the Skyvern persistent browser session used for this run */
     browser_session_id?: string;
+    /** ID of the browser profile used for this run */
+    browser_profile_id?: string;
     /** The maximum number of scrolls for the post action screenshot. When it's None or 0, it takes the current viewpoint screenshot */
     max_screenshot_scrolls?: number;
     /** The script run result */

package/dist/cjs/api/types/WorkflowStatus.d.ts

@@ -2,5 +2,7 @@ export declare const WorkflowStatus: {
     readonly Published: "published";
     readonly Draft: "draft";
     readonly AutoGenerated: "auto_generated";
+    readonly Importing: "importing";
+    readonly ImportFailed: "import_failed";
 };
 export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];

package/dist/cjs/api/types/WorkflowStatus.js

@@ -6,4 +6,6 @@ exports.WorkflowStatus = {
     Published: "published",
     Draft: "draft",
     AutoGenerated: "auto_generated",
+    Importing: "importing",
+    ImportFailed: "import_failed",
 };

package/dist/cjs/api/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ActAction.js";
 export * from "./Action.js";
 export * from "./ActionBlock.js";
 export * from "./ActionBlockParametersItem.js";
@@ -18,7 +19,10 @@ export * from "./BitwardenLoginCredentialParameterYaml.js";
 export * from "./BitwardenSensitiveInformationParameter.js";
 export * from "./BitwardenSensitiveInformationParameterYaml.js";
 export * from "./BlockType.js";
+export * from "./BrowserProfile.js";
 export * from "./BrowserSessionResponse.js";
+export * from "./ClickAction.js";
+export * from "./ClickContext.js";
 export * from "./CodeBlock.js";
 export * from "./CodeBlockParametersItem.js";
 export * from "./CodeBlockYaml.js";
@@ -33,6 +37,7 @@ export * from "./CredentialTypeOutput.js";
 export * from "./CreditCardCredentialResponse.js";
 export * from "./DownloadToS3Block.js";
 export * from "./DownloadToS3BlockYaml.js";
+export * from "./ExtractAction.js";
 export * from "./ExtractionBlock.js";
 export * from "./ExtractionBlockParametersItem.js";
 export * from "./ExtractionBlockYaml.js";
@@ -48,6 +53,7 @@ export * from "./FileStorageType.js";
 export * from "./FileType.js";
 export * from "./FileUploadBlock.js";
 export * from "./FileUploadBlockYaml.js";
+export * from "./Folder.js";
 export * from "./ForLoopBlock.js";
 export * from "./ForLoopBlockLoopBlocksItem.js";
 export * from "./ForLoopBlockLoopOver.js";
@@ -62,6 +68,7 @@ export * from "./HumanInteractionBlock.js";
 export * from "./HumanInteractionBlockParametersItem.js";
 export * from "./HumanInteractionBlockYaml.js";
 export * from "./InputOrSelectContext.js";
+export * from "./InputTextAction.js";
 export * from "./LoginBlock.js";
 export * from "./LoginBlockParametersItem.js";
 export * from "./LoginBlockYaml.js";
@@ -80,11 +87,14 @@ export * from "./PdfParserBlock.js";
 export * from "./PdfParserBlockYaml.js";
 export * from "./ProxyLocation.js";
 export * from "./RunEngine.js";
+export * from "./RunSdkActionRequestAction.js";
+export * from "./RunSdkActionResponse.js";
 export * from "./RunStatus.js";
 export * from "./Script.js";
 export * from "./ScriptFileCreate.js";
 export * from "./ScriptRunResponse.js";
 export * from "./SelectOption.js";
+export * from "./SelectOptionAction.js";
 export * from "./SendEmailBlock.js";
 export * from "./SendEmailBlockYaml.js";
 export * from "./SkyvernForgeSdkSchemasCredentialsCredentialType.js";
@@ -104,6 +114,7 @@ export * from "./ThoughtScenario.js";
 export * from "./ThoughtType.js";
 export * from "./TotpCode.js";
 export * from "./TotpType.js";
+export * from "./UploadFileAction.js";
 export * from "./UploadToS3Block.js";
 export * from "./UploadToS3BlockYaml.js";
 export * from "./UrlBlock.js";

package/dist/cjs/api/types/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActAction.js"), exports);
 __exportStar(require("./Action.js"), exports);
 __exportStar(require("./ActionBlock.js"), exports);
 __exportStar(require("./ActionBlockParametersItem.js"), exports);
@@ -34,7 +35,10 @@ __exportStar(require("./BitwardenLoginCredentialParameterYaml.js"), exports);
 __exportStar(require("./BitwardenSensitiveInformationParameter.js"), exports);
 __exportStar(require("./BitwardenSensitiveInformationParameterYaml.js"), exports);
 __exportStar(require("./BlockType.js"), exports);
+__exportStar(require("./BrowserProfile.js"), exports);
 __exportStar(require("./BrowserSessionResponse.js"), exports);
+__exportStar(require("./ClickAction.js"), exports);
+__exportStar(require("./ClickContext.js"), exports);
 __exportStar(require("./CodeBlock.js"), exports);
 __exportStar(require("./CodeBlockParametersItem.js"), exports);
 __exportStar(require("./CodeBlockYaml.js"), exports);
@@ -49,6 +53,7 @@ __exportStar(require("./CredentialTypeOutput.js"), exports);
 __exportStar(require("./CreditCardCredentialResponse.js"), exports);
 __exportStar(require("./DownloadToS3Block.js"), exports);
 __exportStar(require("./DownloadToS3BlockYaml.js"), exports);
+__exportStar(require("./ExtractAction.js"), exports);
 __exportStar(require("./ExtractionBlock.js"), exports);
 __exportStar(require("./ExtractionBlockParametersItem.js"), exports);
 __exportStar(require("./ExtractionBlockYaml.js"), exports);
@@ -64,6 +69,7 @@ __exportStar(require("./FileStorageType.js"), exports);
 __exportStar(require("./FileType.js"), exports);
 __exportStar(require("./FileUploadBlock.js"), exports);
 __exportStar(require("./FileUploadBlockYaml.js"), exports);
+__exportStar(require("./Folder.js"), exports);
 __exportStar(require("./ForLoopBlock.js"), exports);
 __exportStar(require("./ForLoopBlockLoopBlocksItem.js"), exports);
 __exportStar(require("./ForLoopBlockLoopOver.js"), exports);
@@ -78,6 +84,7 @@ __exportStar(require("./HumanInteractionBlock.js"), exports);
 __exportStar(require("./HumanInteractionBlockParametersItem.js"), exports);
 __exportStar(require("./HumanInteractionBlockYaml.js"), exports);
 __exportStar(require("./InputOrSelectContext.js"), exports);
+__exportStar(require("./InputTextAction.js"), exports);
 __exportStar(require("./LoginBlock.js"), exports);
 __exportStar(require("./LoginBlockParametersItem.js"), exports);
 __exportStar(require("./LoginBlockYaml.js"), exports);
@@ -96,11 +103,14 @@ __exportStar(require("./PdfParserBlock.js"), exports);
 __exportStar(require("./PdfParserBlockYaml.js"), exports);
 __exportStar(require("./ProxyLocation.js"), exports);
 __exportStar(require("./RunEngine.js"), exports);
+__exportStar(require("./RunSdkActionRequestAction.js"), exports);
+__exportStar(require("./RunSdkActionResponse.js"), exports);
 __exportStar(require("./RunStatus.js"), exports);
 __exportStar(require("./Script.js"), exports);
 __exportStar(require("./ScriptFileCreate.js"), exports);
 __exportStar(require("./ScriptRunResponse.js"), exports);
 __exportStar(require("./SelectOption.js"), exports);
+__exportStar(require("./SelectOptionAction.js"), exports);
 __exportStar(require("./SendEmailBlock.js"), exports);
 __exportStar(require("./SendEmailBlockYaml.js"), exports);
 __exportStar(require("./SkyvernForgeSdkSchemasCredentialsCredentialType.js"), exports);
@@ -120,6 +130,7 @@ __exportStar(require("./ThoughtScenario.js"), exports);
 __exportStar(require("./ThoughtType.js"), exports);
 __exportStar(require("./TotpCode.js"), exports);
 __exportStar(require("./TotpType.js"), exports);
+__exportStar(require("./UploadFileAction.js"), exports);
 __exportStar(require("./UploadToS3Block.js"), exports);
 __exportStar(require("./UploadToS3BlockYaml.js"), exports);
 __exportStar(require("./UrlBlock.js"), exports);

package/dist/cjs/environments.d.ts

@@ -1,6 +1,6 @@
 export declare const SkyvernEnvironment: {
-    readonly Production: "https://api.skyvern.com";
+    readonly Cloud: "https://api.skyvern.com";
     readonly Staging: "https://api-staging.skyvern.com";
-    readonly Development: "http://localhost:8000";
+    readonly Local: "http://localhost:8000";
 };
-export type SkyvernEnvironment = typeof SkyvernEnvironment.Production | typeof SkyvernEnvironment.Staging | typeof SkyvernEnvironment.Development;
+export type SkyvernEnvironment = typeof SkyvernEnvironment.Cloud | typeof SkyvernEnvironment.Staging | typeof SkyvernEnvironment.Local;

package/dist/cjs/environments.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SkyvernEnvironment = void 0;
 exports.SkyvernEnvironment = {
-    Production: "https://api.skyvern.com",
+    Cloud: "https://api.skyvern.com",
     Staging: "https://api-staging.skyvern.com",
-    Development: "http://localhost:8000",
+    Local: "http://localhost:8000",
 };

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.2.21";
+export declare const SDK_VERSION = "0.2.23";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.2.21";
+exports.SDK_VERSION = "0.2.23";

package/dist/esm/Client.d.mts

@@ -1,5 +1,7 @@
 import * as Skyvern from "./api/index.mjs";
+import { BrowserProfiles } from "./api/resources/browserProfiles/client/Client.mjs";
 import { Scripts } from "./api/resources/scripts/client/Client.mjs";
+import { Workflows } from "./api/resources/workflows/client/Client.mjs";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient.mjs";
 import * as core from "./core/index.mjs";
 export declare namespace SkyvernClient {
@@ -10,8 +12,12 @@ export declare namespace SkyvernClient {
 }
 export declare class SkyvernClient {
     protected readonly _options: SkyvernClient.Options;
+    protected _workflows: Workflows | undefined;
+    protected _browserProfiles: BrowserProfiles | undefined;
     protected _scripts: Scripts | undefined;
     constructor(_options?: SkyvernClient.Options);
+    get workflows(): Workflows;
+    get browserProfiles(): BrowserProfiles;
     get scripts(): Scripts;
     /**
      * Run a task
@@ -84,8 +90,8 @@ export declare class SkyvernClient {
      * Get all workflows with the latest version for the organization.
      *
      * Search semantics:
-     * - If `search_key` is provided, its value is used as a unified search term for both
-     *   `workflows.title` and workflow parameter metadata (key, description, and default_value for
+     * - If `search_key` is provided, its value is used as a unified search term for
+     *   `workflows.title`, `folders.title`, and workflow parameter metadata (key, description, and default_value for
      *   `WorkflowParameterModel`).
      * - Falls back to deprecated `title` (title-only search) if `search_key` is not provided.
      * - Parameter metadata search excludes soft-deleted parameter rows across all parameter tables.
@@ -103,6 +109,7 @@ export declare class SkyvernClient {
      *         only_workflows: true,
      *         search_key: "search_key",
      *         title: "title",
+     *         folder_id: "folder_id",
      *         template: true
      *     })
      */
@@ -111,15 +118,18 @@ export declare class SkyvernClient {
     /**
      * Create a new workflow
      *
-     * @param {Skyvern.WorkflowRequest} request
+     * @param {Skyvern.CreateWorkflowRequest} request
      * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Skyvern.UnprocessableEntityError}
      *
      * @example
-     *     await client.createWorkflow({})
+     *     await client.createWorkflow({
+     *         folder_id: "folder_id",
+     *         body: {}
+     *     })
      */
-    createWorkflow(request: Skyvern.WorkflowRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Workflow>;
+    createWorkflow(request: Skyvern.CreateWorkflowRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Workflow>;
     private __createWorkflow;
     /**
      * Update a workflow
@@ -415,4 +425,22 @@ export declare class SkyvernClient {
      */
     deployScript(scriptId: string, request: Skyvern.DeployScriptRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.CreateScriptResponse>;
     private __deployScript;
+    /**
+     * Execute a single SDK action with the specified parameters
+     *
+     * @param {Skyvern.RunSdkActionRequest} request
+     * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Skyvern.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.runSdkAction({
+     *         url: "url",
+     *         action: {
+     *             type: "ai_act"
+     *         }
+     *     })
+     */
+    runSdkAction(request: Skyvern.RunSdkActionRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.RunSdkActionResponse>;
+    private __runSdkAction;
 }