@skyvern/client 1.0.24 → 1.0.56

package/dist/cjs/api/client/requests/BatchGetRunTagsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         workflow_run_ids: "workflow_run_ids"
+ *     }
+ */
+export interface BatchGetRunTagsRequest {
+    /** Comma-separated workflow run IDs */
+    workflow_run_ids?: string;
+}

package/dist/cjs/api/client/requests/BatchGetWorkflowTagsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         workflow_permanent_ids: "workflow_permanent_ids"
+ *     }
+ */
+export interface BatchGetWorkflowTagsRequest {
+    /** Comma-separated workflow permanent IDs */
+    workflow_permanent_ids?: string;
+}

package/dist/cjs/api/client/requests/BodyUploadFileV1UploadFilePost.d.ts

@@ -1,10 +1,9 @@
-import type * as core from "../../../core/index.js";
 /**
  * @example
  *     {
- *         file: fs.createReadStream("/path/to/your/file")
+ *         file: "file"
  *     }
  */
 export interface BodyUploadFileV1UploadFilePost {
-    file: core.file.Uploadable;
+    file: string;
 }

package/dist/cjs/api/client/requests/BulkCancelRunsRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         run_ids: ["run_ids"]
+ *     }
+ */
+export interface BulkCancelRunsRequest {
+    /** List of run IDs to cancel */
+    run_ids: string[];
+}

package/dist/cjs/api/client/requests/CreateBrowserProfileRequest.d.ts

@@ -1,3 +1,4 @@
+import type * as Skyvern from "../../index.js";
 /**
  * @example
  *     {
@@ -9,8 +10,18 @@ export interface CreateBrowserProfileRequest {
     name: string;
     /** Optional profile description */
     description?: string;
-    /** Persistent browser session to convert into a profile */
+    /** Persistent browser session to convert into a profile. Omit for a blank profile. */
     browser_session_id?: string;
-    /** Workflow run whose persisted session should be captured */
+    /** Workflow run whose persisted session should be captured. Omit for a blank profile. */
     workflow_run_id?: string;
+    /** Optional proxy location for this profile's pinned proxy identity. */
+    proxy_location?: CreateBrowserProfileRequest.ProxyLocation;
+    /** Explicit sticky-session id for this profile's pinned proxy identity. */
+    proxy_session_id?: string;
+}
+export declare namespace CreateBrowserProfileRequest {
+    /**
+     * Optional proxy location for this profile's pinned proxy identity.
+     */
+    type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
 }

package/dist/cjs/api/client/requests/CreateBrowserSessionRequest.d.ts

@@ -4,7 +4,9 @@ import type * as Skyvern from "../../index.js";
  *     {}
  */
 export interface CreateBrowserSessionRequest {
-    /** Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 1440. Defaults to 60. */
+    /** Optional URL to open when the standalone browser session starts. */
+    url?: string;
+    /** Timeout in minutes for the session. Timeout is applied after the session is started. Must be between 5 and 240. Defaults to 60. */
     timeout?: number;
     /**
      * Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
@@ -21,6 +23,7 @@ export interface CreateBrowserSessionRequest {
      * - RESIDENTIAL_NZ: New Zealand
      * - RESIDENTIAL_PH: Philippines
      * - RESIDENTIAL_KR: South Korea
+     * - RESIDENTIAL_SA: Saudi Arabia
      * - RESIDENTIAL_ZA: South Africa
      * - RESIDENTIAL_AR: Argentina
      * - RESIDENTIAL_AU: Australia
@@ -37,12 +40,59 @@ export interface CreateBrowserSessionRequest {
      * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
      * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
      * - NONE: No proxy
+     *
+     * For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example.com:8080"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.
+     *  Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:password@proxy.example.com:8080"}
      */
-    proxy_location?: Skyvern.ProxyLocation;
+    proxy_location?: CreateBrowserSessionRequest.ProxyLocation;
+    /** Opaque Skyvern-managed proxy sticky-session id for pinned Residential ISP sessions. */
+    proxy_session_id?: string;
     /** A list of extensions to install in the browser session. */
     extensions?: Skyvern.Extensions[];
     /** The type of browser to use for the session. */
     browser_type?: Skyvern.PersistentBrowserType;
     /** ID of a browser profile to load into this session (restores cookies, localStorage, etc.). browser_profile_id starts with `bp_`. */
     browser_profile_id?: string;
+    /** When true, the session's browser profile (cookies, localStorage, etc.) is saved to storage when the session ends so it can be turned into a reusable browser profile. Defaults to false to avoid storing profiles for sessions that never need them. Sessions started with a browser_profile_id always persist their profile regardless of this flag. */
+    generate_browser_profile?: boolean;
+}
+export declare namespace CreateBrowserSessionRequest {
+    /**
+     *
+     * Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
+     *
+     * Available geotargeting options:
+     * - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
+     * - RESIDENTIAL_ES: Spain
+     * - RESIDENTIAL_IE: Ireland
+     * - RESIDENTIAL_GB: United Kingdom
+     * - RESIDENTIAL_IN: India
+     * - RESIDENTIAL_JP: Japan
+     * - RESIDENTIAL_FR: France
+     * - RESIDENTIAL_DE: Germany
+     * - RESIDENTIAL_NZ: New Zealand
+     * - RESIDENTIAL_PH: Philippines
+     * - RESIDENTIAL_KR: South Korea
+     * - RESIDENTIAL_SA: Saudi Arabia
+     * - RESIDENTIAL_ZA: South Africa
+     * - RESIDENTIAL_AR: Argentina
+     * - RESIDENTIAL_AU: Australia
+     * - RESIDENTIAL_BR: Brazil
+     * - RESIDENTIAL_TR: Turkey
+     * - RESIDENTIAL_CA: Canada
+     * - RESIDENTIAL_MX: Mexico
+     * - RESIDENTIAL_IT: Italy
+     * - RESIDENTIAL_NL: Netherlands
+     * - RESIDENTIAL_ISP: ISP proxy
+     * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
+     * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
+     * - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
+     * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
+     * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
+     * - NONE: No proxy
+     *
+     * For self-hosted deployments, you can pass a custom proxy URL as a dict: {"url": "http://user:password@proxy.example.com:8080"}. This routes the browser through your own proxy server and takes precedence over any globally configured proxy pool.
+     *  Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}, or a custom proxy URL dict for self-hosted deployments: {"url": "http://user:password@proxy.example.com:8080"}
+     */
+    type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
 }

package/dist/cjs/api/client/requests/CustomLlmCreateRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as Skyvern from "../../index.js";
+/**
+ * @example
+ *     {
+ *         config: {
+ *             display_name: "display_name",
+ *             provider: "openai_compatible",
+ *             model_name: "model_name"
+ *         }
+ *     }
+ */
+export interface CustomLlmCreateRequest {
+    config: Skyvern.CustomLlmConfig;
+}

package/dist/cjs/api/client/requests/CustomLlmUpdateRequest.d.ts

@@ -0,0 +1,14 @@
+import type * as Skyvern from "../../index.js";
+/**
+ * @example
+ *     {
+ *         config: {
+ *             display_name: "display_name",
+ *             provider: "openai_compatible",
+ *             model_name: "model_name"
+ *         }
+ *     }
+ */
+export interface CustomLlmUpdateRequest {
+    config: Skyvern.CustomLlmConfig;
+}

package/dist/cjs/api/client/requests/DownloadFilesRequest.d.ts

@@ -2,10 +2,12 @@ import type * as Skyvern from "../../index.js";
 /**
  * @example
  *     {
+ *         "x-user-agent": "x-user-agent",
  *         navigation_goal: "navigation_goal"
  *     }
  */
 export interface DownloadFilesRequest {
+    "x-user-agent"?: string;
     /** Website URL */
     url?: string;
     /** Webhook URL to send status updates */
@@ -24,6 +26,8 @@ export interface DownloadFilesRequest {
     browser_address?: string;
     /** Additional HTTP headers to include in requests */
     extra_http_headers?: Record<string, string | undefined>;
+    /** HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites. */
+    cdp_connect_headers?: Record<string, string | undefined>;
     /** Maximum number of times to scroll for screenshots */
     max_screenshot_scrolling_times?: number;
     /** Instructions for navigating to and downloading the file */

package/dist/cjs/api/client/requests/ExtendBrowserSessionRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         additional_minutes: 1
+ *     }
+ */
+export interface ExtendBrowserSessionRequest {
+    /** Minutes to add to the session's current deadline. A session can be extended, one or more times, up to a total lifetime of 360 minutes (6 hours) counted from when it started; a request for more than the remaining headroom is granted the remainder and the response carries a warning. */
+    additional_minutes: number;
+}

package/dist/cjs/api/client/requests/GetCredentialsRequest.d.ts

@@ -1,8 +1,12 @@
+import type * as Skyvern from "../../index.js";
 /**
  * @example
  *     {
  *         page: 1,
- *         page_size: 10
+ *         page_size: 10,
+ *         vault_type: "skyvern",
+ *         credential_type: "password",
+ *         search: "search"
  *     }
  */
 export interface GetCredentialsRequest {
@@ -10,4 +14,10 @@ export interface GetCredentialsRequest {
     page?: number;
     /** Number of items per page */
     page_size?: number;
+    /** Filter credentials by vault type (e.g. 'skyvern', 'custom', 'bitwarden', 'azure_vault') */
+    vault_type?: Skyvern.CredentialVaultType;
+    /** Filter credentials by type (e.g. 'password', 'credit_card', 'secret') */
+    credential_type?: Skyvern.SkyvernForgeSdkSchemasCredentialsCredentialType;
+    /** Case-insensitive search across credential name, username, secret label, and card details */
+    search?: string;
 }

package/dist/cjs/api/client/requests/GetRunTagHistoryRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         limit: 1,
+ *         since: "2024-01-15T09:30:00Z",
+ *         key: "key"
+ *     }
+ */
+export interface GetRunTagHistoryRequest {
+    /** Max events to return */
+    limit?: number;
+    /** Only return events at or after this timestamp */
+    since?: string;
+    /** Filter to events for a single tag key */
+    key?: string;
+}

package/dist/cjs/api/client/requests/GetRunsV2Request.d.ts

@@ -0,0 +1,17 @@
+import type * as Skyvern from "../../index.js";
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         page_size: 1,
+ *         search_key: "search_key"
+ *     }
+ */
+export interface GetRunsV2Request {
+    page?: number;
+    page_size?: number;
+    status?: Skyvern.RunStatus | Skyvern.RunStatus[];
+    /** Case-insensitive substring search (min 3 chars for trigram index). */
+    search_key?: string;
+    run_type?: Skyvern.RunType | Skyvern.RunType[];
+}

package/dist/cjs/api/client/requests/GetWorkflowRunsByIdRequest.d.ts

@@ -0,0 +1,28 @@
+import type * as Skyvern from "../../index.js";
+/**
+ * @example
+ *     {
+ *         page: 1,
+ *         page_size: 1,
+ *         search_key: "search_key",
+ *         error_code: "error_code",
+ *         created_at_start: "2024-01-15T09:30:00Z",
+ *         created_at_end: "2024-01-15T09:30:00Z"
+ *     }
+ */
+export interface GetWorkflowRunsByIdRequest {
+    /** Page number for pagination. */
+    page?: number;
+    /** Number of runs to return per page. */
+    page_size?: number;
+    /** Filter by one or more run statuses. */
+    status?: Skyvern.WorkflowRunStatus | Skyvern.WorkflowRunStatus[];
+    /** Case-insensitive substring search across: workflow run ID, parameter key, parameter description, run parameter value, and extra HTTP headers. A run is returned if any of these fields match. Soft-deleted parameter definitions are excluded from key/description matching. */
+    search_key?: string;
+    /** Exact-match filter on the error_code field inside each task's errors JSON array. A run matches if any of its tasks contains an error with a matching error_code. Error codes are user-defined strings set during workflow execution. */
+    error_code?: string;
+    /** Only include runs created at or after this UTC timestamp (ISO 8601). */
+    created_at_start?: string;
+    /** Only include runs created strictly before this UTC timestamp (ISO 8601). */
+    created_at_end?: string;
+}

package/dist/cjs/api/client/requests/GetWorkflowTagHistoryRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         limit: 1,
+ *         since: "2024-01-15T09:30:00Z",
+ *         key: "key"
+ *     }
+ */
+export interface GetWorkflowTagHistoryRequest {
+    /** Max events to return */
+    limit?: number;
+    /** Only return events at or after this timestamp */
+    since?: string;
+    /** Filter to events for a single tag key */
+    key?: string;
+}

package/dist/cjs/api/client/requests/GetWorkflowsRequest.d.ts

@@ -26,5 +26,7 @@ export interface GetWorkflowsRequest {
     /** Filter workflows by folder ID */
     folder_id?: string;
     status?: Skyvern.WorkflowStatus | Skyvern.WorkflowStatus[];
+    /** Filter by tags. Each term is a label (`production`), a group (`env:*`), or a group:label (`env:prod`). Repeat the param or comma-separate (`?tags=env:prod,env:staging`). AND across distinct terms, OR within a group's labels (`?tags=customer:acme,env:prod,env:staging` -> customer=acme AND env in (prod, staging)). A label term matches the value across any/no group. Matches current tag values only. Not supported with `template=true`. */
+    tags?: string | string[];
     template?: boolean;
 }

package/dist/cjs/api/client/requests/ListBrowserProfilesRequest.d.ts

@@ -1,10 +1,20 @@
 /**
  * @example
  *     {
- *         include_deleted: true
+ *         page: 1,
+ *         page_size: 1,
+ *         include_deleted: true,
+ *         search_key: "search_key",
+ *         managed: true
  *     }
  */
 export interface ListBrowserProfilesRequest {
+    page?: number;
+    page_size?: number;
     /** Include deleted browser profiles */
     include_deleted?: boolean;
+    /** Case-insensitive substring search across: browser profile name and description. A profile is returned if either field matches. */
+    search_key?: string;
+    /** Omit to return all profiles; false returns only user-created profiles; true returns only auto-managed profiles. */
+    managed?: boolean;
 }

package/dist/cjs/api/client/requests/ListTagValuesRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         key: "key"
+ *     }
+ */
+export interface ListTagValuesRequest {
+    /** Filter to values for a single tag key */
+    key?: string;
+}

package/dist/cjs/api/client/requests/ListTagValuesRequest.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/client/requests/LoginRequest.d.ts

@@ -2,10 +2,12 @@ import type * as Skyvern from "../../index.js";
 /**
  * @example
  *     {
+ *         "x-user-agent": "x-user-agent",
  *         credential_type: "skyvern"
  *     }
  */
 export interface LoginRequest {
+    "x-user-agent"?: string;
     /** Website URL */
     url?: string;
     /** Webhook URL to send status updates */
@@ -24,10 +26,12 @@ export interface LoginRequest {
     browser_address?: string;
     /** Additional HTTP headers to include in requests */
     extra_http_headers?: Record<string, string | undefined>;
+    /** HTTP headers attached ONLY to the CDP WebSocket handshake when connecting to a remote browser via browser_address. Never forwarded to target websites. */
+    cdp_connect_headers?: Record<string, string | undefined>;
     /** Maximum number of times to scroll for screenshots */
     max_screenshot_scrolling_times?: number;
     /** Where to get the credential from */
-    credential_type: Skyvern.SkyvernSchemasRunBlocksCredentialType;
+    credential_type: Skyvern.SkyvernSchemasCredentialTypeCredentialType;
     /** Login instructions. Skyvern has default prompt/instruction for login if this field is not provided. */
     prompt?: string;
     /** ID of the Skyvern credential to use for login. */

package/dist/cjs/api/client/requests/RetryWorkflowRunRequest.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @example
+ *     {
+ *         "x-max-steps-override": 1,
+ *         "x-user-agent": "x-user-agent"
+ *     }
+ */
+export interface RetryWorkflowRunRequest {
+    "x-max-steps-override"?: number;
+    "x-user-agent"?: string;
+}

package/dist/cjs/api/client/requests/RetryWorkflowRunRequest.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/client/requests/RunTagsBatchRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @example
+ *     {}
+ */
+export interface RunTagsBatchRequest {
+    /** Workflow run IDs to fetch tags for. */
+    workflow_run_ids?: string[];
+}

package/dist/cjs/api/client/requests/RunTagsBatchRequest.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/client/requests/TagKeyUpdate.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @example
+ *     {}
+ */
+export interface TagKeyUpdate {
+    /** Free-form description (max 500 chars). Pass null to clear. */
+    description?: string;
+}

package/dist/cjs/api/client/requests/TagKeyUpdate.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/client/requests/TagValueDelete.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         value: "value"
+ *     }
+ */
+export interface TagValueDelete {
+    /** Tag value (label) under the key to soft-delete. */
+    value: string;
+}

package/dist/cjs/api/client/requests/TagValueDelete.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/client/requests/TagValueRename.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         value: "value",
+ *         new_value: "new_value"
+ *     }
+ */
+export interface TagValueRename {
+    /** Current tag value (label) under the key to rename. */
+    value: string;
+    /** New tag value (label) to rename it to. */
+    new_value: string;
+}

package/dist/cjs/api/client/requests/TagValueRename.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/client/requests/TagValueUpdate.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         value: "value",
+ *         color: "color"
+ *     }
+ */
+export interface TagValueUpdate {
+    /** Tag value (label) under the key to recolor. */
+    value: string;
+    /** Palette color name to assign to this (key, value). */
+    color: string;
+}

package/dist/cjs/api/client/requests/TagValueUpdate.js

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