vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Generate Fern TypeSscript SDK (#3785)

Browse Source
This commit is contained in:
Stanislav Novosad
2025-10-23 20:14:59 -06:00
committed by GitHub
parent d55b9637c4
commit 2062adac66
239 changed files with 14550 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
fern/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
.preview

2
fern/credentials/introduction.mdx
View File

@@ -4,7 +4,7 @@ subtitle: Never send your credentials to LLMs.
slug: credentials/introduction
---
Need to give Skyvern access to your credentials? Usernames and passwords, 2FA, credit cards for payments, etc. Skyvern's credential management provides a secure way to manage and use credentials. Agents can then without exposing those credentials to LLMs.
Need to give Skyvern access to your credentials? Usernames and passwords, 2FA, credit cards for payments, etc. Skyvern's credential management provides a secure way to manage and use credentials. Agents can then use them without exposing those credentials to LLMs.
### 2FA Support (TOTP)

1
fern/docs.yml
View File

@@ -158,6 +158,7 @@ navigation:
- api: API Reference
snippets:
python: skyvern
typescript: "@skyvern/client"
layout:
- section: Agent
contents:

2
fern/fern.config.json
View File

@@ -1,4 +1,4 @@
{
"organization": "skyvern",
"version": "0.63.26"
"version": "0.94.3"
}

13
fern/generators.yml
View File

@@ -17,7 +17,7 @@ groups:
generators:
- name: fernapi/fern-python-sdk
smart-casing: true
version: 4.3.17
version: 4.31.1
output:
location: pypi
package-name: skyvern
@@ -25,3 +25,14 @@ groups:
repository: Skyvern-AI/skyvern-python
config:
client_class_name: Skyvern
ts-sdk:
generators:
- name: fernapi/fern-typescript-sdk
version: 3.11.1
output:
location: npm
package-name: "@skyvern/client"
github:
repository: Skyvern-AI/skyvern-typescript
config:
namespaceExport: Skyvern

4
scripts/fern_build_python_sdk.sh Executable file
View File

@@ -0,0 +1,4 @@
#!/usr/bin/env bash
fern generate --group python-sdk --log-level debug --preview
cp -rf fern/.preview/fern-python-sdk/src/skyvern/* skyvern/client/

4
scripts/fern_build_ts_sdk.sh Executable file
View File

@@ -0,0 +1,4 @@
#!/usr/bin/env bash
fern generate --group ts-sdk --log-level debug --preview
cp -rf fern/.preview/fern-typescript-sdk/* skyvern-ts/client/

183
skyvern-ts/client/README.md Normal file
View File

@@ -0,0 +1,183 @@
# Skyvern TypeScript Library
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2FSkyvern-AI%2Fskyvern-typescript)
[![npm shield](https://img.shields.io/npm/v/@skyvern/client)](https://www.npmjs.com/package/@skyvern/client)
The Skyvern TypeScript library provides convenient access to the Skyvern APIs from TypeScript.
## Installation
```sh
npm i -s @skyvern/client
```
## Reference
A full reference for this library is available [here](https://github.com/Skyvern-AI/skyvern-typescript/blob/HEAD/./reference.md).
## Usage
Instantiate and use the client with the following:
```typescript
import { SkyvernClient } from "@skyvern/client";
const client = new SkyvernClient({ xApiKey: "YOUR_X_API_KEY", apiKey: "YOUR_API_KEY" });
await client.runTask({
"x-user-agent": "x-user-agent",
body: {
prompt: "Find the top 3 posts on Hacker News."
}
});
```
## Request And Response Types
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:
```typescript
import { Skyvern } from "@skyvern/client";
const request: Skyvern.RunTaskRequest = {
...
};
```
## Exception Handling
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.
```typescript
import { SkyvernError } from "@skyvern/client";
try {
await client.runTask(...);
} catch (err) {
if (err instanceof SkyvernError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
console.log(err.rawResponse);
}
}
```
## Advanced
### Additional Headers
If you would like to send additional headers as part of the request, use the `headers` request option.
```typescript
const response = await client.runTask(..., {
headers: {
'X-Custom-Header': 'custom value'
}
});
```
### Additional Query String Parameters
If you would like to send additional query string parameters as part of the request, use the `queryParams` request option.
```typescript
const response = await client.runTask(..., {
queryParams: {
'customQueryParamKey': 'custom query param value'
}
});
```
### Retries
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
Use the `maxRetries` request option to configure this behavior.
```typescript
const response = await client.runTask(..., {
maxRetries: 0 // override maxRetries at the request level
});
```
### Timeouts
The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
```typescript
const response = await client.runTask(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
```
### Aborting Requests
The SDK allows users to abort requests at any point by passing in an abort signal.
```typescript
const controller = new AbortController();
const response = await client.runTask(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
```
### Access Raw Response Data
The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
```typescript
const { data, rawResponse } = await client.runTask(...).withRawResponse();
console.log(data);
console.log(rawResponse.headers['X-My-Header']);
```
### Runtime Compatibility
The SDK works in the following runtimes:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
### Customizing Fetch Client
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
unsupported environment, this provides a way for you to break glass and ensure the SDK works.
```typescript
import { SkyvernClient } from "@skyvern/client";
const client = new SkyvernClient({
...
fetcher: // provide your implementation here
});
```
## Contributing
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!

69
skyvern-ts/client/biome.json Normal file
View File

@@ -0,0 +1,69 @@
{
"$schema": "https://biomejs.dev/schemas/2.2.5/schema.json",
"root": true,
"vcs": {
"enabled": false
},
"files": {
"ignoreUnknown": true,
"includes": [
"./**",
"!dist",
"!lib",
"!*.tsbuildinfo",
"!_tmp_*",
"!*.tmp",
"!.tmp/",
"!*.log",
"!.DS_Store",
"!Thumbs.db"
]
},
"formatter": {
"enabled": true,
"indentStyle": "space",
"indentWidth": 4,
"lineWidth": 120
},
"javascript": {
"formatter": {
"quoteStyle": "double"
}
},
"assist": {
"enabled": true,
"actions": {
"source": {
"organizeImports": "on"
}
}
},
"linter": {
"rules": {
"style": {
"useNodejsImportProtocol": "off"
},
"suspicious": {
"noAssignInExpressions": "warn",
"noUselessEscapeInString": {
"level": "warn",
"fix": "none",
"options": {}
},
"noThenProperty": "warn",
"useIterableCallbackReturn": "warn",
"noShadowRestrictedNames": "warn",
"noTsIgnore": {
"level": "warn",
"fix": "none",
"options": {}
},
"noConfusingVoidType": {
"level": "warn",
"fix": "none",
"options": {}
}
}
}
}
}

65
skyvern-ts/client/package.json Normal file
View File

@@ -0,0 +1,65 @@
{
"name": "@skyvern/client",
"version": "0.2.18",
"private": false,
"repository": "github:Skyvern-AI/skyvern-typescript",
"type": "commonjs",
"main": "./dist/cjs/index.js",
"module": "./dist/esm/index.mjs",
"types": "./dist/cjs/index.d.ts",
"exports": {
".": {
"types": "./dist/cjs/index.d.ts",
"import": {
"types": "./dist/esm/index.d.mts",
"default": "./dist/esm/index.mjs"
},
"require": {
"types": "./dist/cjs/index.d.ts",
"default": "./dist/cjs/index.js"
},
"default": "./dist/cjs/index.js"
},
"./package.json": "./package.json"
},
"files": [
"dist",
"reference.md",
"README.md",
"LICENSE"
],
"scripts": {
"format": "biome format --write --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"format:check": "biome format --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"lint": "biome lint --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"lint:fix": "biome lint --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"check": "biome check --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"check:fix": "biome check --fix --unsafe --skip-parse-errors --no-errors-on-unmatched --max-diagnostics=none",
"build": "pnpm build:cjs && pnpm build:esm",
"build:cjs": "tsc --project ./tsconfig.cjs.json",
"build:esm": "tsc --project ./tsconfig.esm.json && node scripts/rename-to-esm-files.js dist/esm",
"test": "vitest",
"test:unit": "vitest --project unit",
"test:wire": "vitest --project wire"
},
"devDependencies": {
"webpack": "^5.97.1",
"ts-loader": "^9.5.1",
"vitest": "^3.2.4",
"msw": "2.11.2",
"@types/node": "^18.19.70",
"typescript": "~5.7.2",
"@biomejs/biome": "2.2.5"
},
"browser": {
"fs": false,
"os": false,
"path": false,
"stream": false
},
"packageManager": "pnpm@10.14.0",
"engines": {
"node": ">=18.0.0"
},
"sideEffects": false
}

1649
skyvern-ts/client/pnpm-lock.yaml generated Normal file
View File

File diff suppressed because it is too large Load Diff

1
skyvern-ts/client/pnpm-workspace.yaml Normal file
View File

@@ -0,0 +1 @@
packages: ['.']

141
skyvern-ts/client/reference.md Normal file
View File

@@ -0,0 +1,141 @@
# Reference
<details><summary><code>client.<a href="/src/Client.ts">deployScript</a>(scriptId, { ...params }) -> Skyvern.CreateScriptResponse</code></summary>
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Deploy a script with updated files, creating a new version
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.deployScript("s_abc123", {
files: [{
path: "src/main.py",
content: "content"
}]
});
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**scriptId:** `string` — The unique identifier of the script
</dd>
</dl>
<dl>
<dd>
**request:** `Skyvern.DeployScriptRequest`
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `SkyvernClient.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>
##
## Scripts
<details><summary><code>client.scripts.<a href="/src/api/resources/scripts/client/Client.ts">runScript</a>(scriptId) -> unknown</code></summary>
<dl>
<dd>
#### 📝 Description
<dl>
<dd>
<dl>
<dd>
Run a script
</dd>
</dl>
</dd>
</dl>
#### 🔌 Usage
<dl>
<dd>
<dl>
<dd>
```typescript
await client.scripts.runScript("s_abc123");
```
</dd>
</dl>
</dd>
</dl>
#### ⚙️ Parameters
<dl>
<dd>
<dl>
<dd>
**scriptId:** `string` — The unique identifier of the script
</dd>
</dl>
<dl>
<dd>
**requestOptions:** `Scripts.RequestOptions`
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</details>

126
skyvern-ts/client/scripts/rename-to-esm-files.js Normal file
View File

@@ -0,0 +1,126 @@
#!/usr/bin/env node
const fs = require("fs").promises;
const path = require("path");
const extensionMap = {
".js": ".mjs",
".d.ts": ".d.mts",
};
const oldExtensions = Object.keys(extensionMap);
async function findFiles(rootPath) {
const files = [];
async function scan(directory) {
const entries = await fs.readdir(directory, { withFileTypes: true });
for (const entry of entries) {
const fullPath = path.join(directory, entry.name);
if (entry.isDirectory()) {
if (entry.name !== "node_modules" && !entry.name.startsWith(".")) {
await scan(fullPath);
}
} else if (entry.isFile()) {
if (oldExtensions.some((ext) => entry.name.endsWith(ext))) {
files.push(fullPath);
}
}
}
}
await scan(rootPath);
return files;
}
async function updateFiles(files) {
const updatedFiles = [];
for (const file of files) {
const updated = await updateFileContents(file);
updatedFiles.push(updated);
}
console.log(`Updated imports in ${updatedFiles.length} files.`);
}
async function updateFileContents(file) {
const content = await fs.readFile(file, "utf8");
let newContent = content;
// Update each extension type defined in the map
for (const [oldExt, newExt] of Object.entries(extensionMap)) {
// Handle static imports/exports
const staticRegex = new RegExp(
`(import|export)(.+from\\s+['"])(\\.\\.?\\/[^'"]+)(\\${oldExt})(['"])`,
"g",
);
newContent = newContent.replace(staticRegex, `$1$2$3${newExt}$5`);
// Handle dynamic imports (yield import, await import, regular import())
const dynamicRegex = new RegExp(
`(yield\\s+import|await\\s+import|import)\\s*\\(\\s*['"](\\.\\.\?\\/[^'"]+)(\\${oldExt})['"]\\s*\\)`,
"g",
);
newContent = newContent.replace(dynamicRegex, `$1("$2${newExt}")`);
}
if (content !== newContent) {
await fs.writeFile(file, newContent, "utf8");
return true;
}
return false;
}
async function renameFiles(files) {
let counter = 0;
for (const file of files) {
const ext = oldExtensions.find((ext) => file.endsWith(ext));
const newExt = extensionMap[ext];
if (newExt) {
const newPath = file.slice(0, -ext.length) + newExt;
await fs.rename(file, newPath);
counter++;
}
}
console.log(`Renamed ${counter} files.`);
}
async function main() {
try {
const targetDir = process.argv[2];
if (!targetDir) {
console.error("Please provide a target directory");
process.exit(1);
}
const targetPath = path.resolve(targetDir);
const targetStats = await fs.stat(targetPath);
if (!targetStats.isDirectory()) {
console.error("The provided path is not a directory");
process.exit(1);
}
console.log(`Scanning directory: ${targetDir}`);
const files = await findFiles(targetDir);
if (files.length === 0) {
console.log("No matching files found.");
process.exit(0);
}
console.log(`Found ${files.length} files.`);
await updateFiles(files);
await renameFiles(files);
console.log("\nDone!");
} catch (error) {
console.error("An error occurred:", error.message);
process.exit(1);
}
}
main();

34
skyvern-ts/client/src/BaseClient.ts Normal file
View File

@@ -0,0 +1,34 @@
// This file was auto-generated by Fern from our API Definition.
import type * as core from "./core/index.js";
import type * as environments from "./environments.js";
export interface BaseClientOptions {
environment?: core.Supplier<environments.SkyvernEnvironment | string>;
/** Specify a custom URL to connect the client to. */
baseUrl?: core.Supplier<string>;
xApiKey?: core.Supplier<string | undefined>;
/** Override the x-api-key header */
apiKey?: core.Supplier<string | undefined>;
/** Additional headers to include in requests. */
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
/** The default maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
/** The default number of times to retry the request. Defaults to 2. */
maxRetries?: number;
}
export interface BaseRequestOptions {
/** The maximum time to wait for a response in seconds. */
timeoutInSeconds?: number;
/** The number of times to retry the request. Defaults to 2. */
maxRetries?: number;
/** A hook to abort the request. */
abortSignal?: AbortSignal;
/** Override the x-api-key header */
apiKey?: string | undefined;
/** Additional query string parameters to include in the request. */
queryParams?: Record<string, unknown>;
/** Additional headers to include in the request. */
headers?: Record<string, string | core.Supplier<string | null | undefined> | null | undefined>;
}

2284
skyvern-ts/client/src/Client.ts Normal file
View File

File diff suppressed because it is too large Load Diff

1
skyvern-ts/client/src/api/client/index.ts Normal file
View File

@@ -0,0 +1 @@
export * from "./requests/index.js";

37
skyvern-ts/client/src/api/client/requests/CreateBrowserSessionRequest.ts Normal file
View File

@@ -0,0 +1,37 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {}
*/
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. */
timeout?: number;
/**
* 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_ZA: South Africa
* - RESIDENTIAL_AR: Argentina
* - RESIDENTIAL_AU: Australia
* - RESIDENTIAL_ISP: ISP proxy
* - US-CA: California
* - US-NY: New York
* - US-TX: Texas
* - US-FL: Florida
* - US-WA: Washington
* - NONE: No proxy
*/
proxy_location?: Skyvern.ProxyLocation;
}

31
skyvern-ts/client/src/api/client/requests/CreateCredentialRequest.ts Normal file
View File

@@ -0,0 +1,31 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {
* name: "My Credential",
* credential_type: "password",
* credential: {
* password: "securepassword123",
* username: "user@example.com",
* totp: "JBSWY3DPEHPK3PXP"
* }
* }
*/
export interface CreateCredentialRequest {
/** Name of the credential */
name: string;
/** Type of credential to create */
credential_type: Skyvern.SkyvernForgeSdkSchemasCredentialsCredentialType;
/** The credential data to store */
credential: CreateCredentialRequest.Credential;
}
export namespace CreateCredentialRequest {
/**
* The credential data to store
*/
export type Credential = Skyvern.NonEmptyPasswordCredential | Skyvern.NonEmptyCreditCardCredential;
}

16
skyvern-ts/client/src/api/client/requests/CreateScriptRequest.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {}
*/
export interface CreateScriptRequest {
/** Associated workflow ID */
workflow_id?: string;
/** Associated run ID */
run_id?: string;
/** Array of files to include in the script */
files?: Skyvern.ScriptFileCreate[];
}

17
skyvern-ts/client/src/api/client/requests/DeployScriptRequest.ts Normal file
View File

@@ -0,0 +1,17 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {
* files: [{
* path: "src/main.py",
* content: "content"
* }]
* }
*/
export interface DeployScriptRequest {
/** Array of files to include in the script */
files: Skyvern.ScriptFileCreate[];
}

15
skyvern-ts/client/src/api/client/requests/GetCredentialsRequest.ts Normal file
View File

@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.
/**
* @example
* {
* page: 1,
* page_size: 10
* }
*/
export interface GetCredentialsRequest {
/** Page number for pagination */
page?: number;
/** Number of items per page */
page_size?: number;
}

11
skyvern-ts/client/src/api/client/requests/GetRunArtifactsRequest.ts Normal file
View File

@@ -0,0 +1,11 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {}
*/
export interface GetRunArtifactsRequest {
artifact_type?: Skyvern.ArtifactType | Skyvern.ArtifactType[];
}

15
skyvern-ts/client/src/api/client/requests/GetScriptsRequest.ts Normal file
View File

@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.
/**
* @example
* {
* page: 1,
* page_size: 10
* }
*/
export interface GetScriptsRequest {
/** Page number for pagination */
page?: number;
/** Number of items per page */
page_size?: number;
}

25
skyvern-ts/client/src/api/client/requests/GetWorkflowsRequest.ts Normal file
View File

@@ -0,0 +1,25 @@
// This file was auto-generated by Fern from our API Definition.
/**
* @example
* {
* page: 1,
* page_size: 1,
* only_saved_tasks: true,
* only_workflows: true,
* search_key: "search_key",
* title: "title",
* template: true
* }
*/
export interface GetWorkflowsRequest {
page?: number;
page_size?: number;
only_saved_tasks?: boolean;
only_workflows?: boolean;
/** Unified search across workflow title and parameter metadata (key, description, default_value). */
search_key?: string;
/** Deprecated: use search_key instead. */
title?: string;
template?: boolean;
}

52
skyvern-ts/client/src/api/client/requests/LoginRequest.ts Normal file
View File

@@ -0,0 +1,52 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {
* credential_type: "skyvern"
* }
*/
export interface LoginRequest {
/** Where to get the credential from */
credential_type: Skyvern.SkyvernSchemasRunBlocksCredentialType;
/** Website url */
url?: string;
/** Login instructions. Skyvern has default prompt/instruction for login if this field is not provided. */
prompt?: string;
/** Webhook URL to send login status updates */
webhook_url?: string;
/** Proxy location to use */
proxy_location?: Skyvern.ProxyLocation;
/** Identifier for TOTP (Time-based One-Time Password) if required */
totp_identifier?: string;
/** TOTP URL to fetch one-time passwords */
totp_url?: string;
/** ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456` */
browser_session_id?: string;
/** The CDP address for the task. */
browser_address?: string;
/** Additional HTTP headers to include in requests */
extra_http_headers?: Record<string, string | undefined>;
/** Maximum number of times to scroll for screenshots */
max_screenshot_scrolling_times?: number;
/** ID of the Skyvern credential to use for login. */
credential_id?: string;
/** Bitwarden collection ID. You can find it in the Bitwarden collection URL. e.g. `https://vault.bitwarden.com/vaults/collection_id/items` */
bitwarden_collection_id?: string;
/** Bitwarden item ID */
bitwarden_item_id?: string;
/** 1Password vault ID */
onepassword_vault_id?: string;
/** 1Password item ID */
onepassword_item_id?: string;
/** Azure Vault Name */
azure_vault_name?: string;
/** Azure Vault username key */
azure_vault_username_key?: string;
/** Azure Vault password key */
azure_vault_password_key?: string;
/** Azure Vault TOTP secret key */
azure_vault_totp_secret_key?: string;
}

17
skyvern-ts/client/src/api/client/requests/RunTaskRequest.ts Normal file
View File

@@ -0,0 +1,17 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {
* "x-user-agent": "x-user-agent",
* body: {
* prompt: "Find the top 3 posts on Hacker News."
* }
* }
*/
export interface RunTaskRequest {
"x-user-agent"?: string;
body: Skyvern.TaskRunRequest;
}

21
skyvern-ts/client/src/api/client/requests/RunWorkflowRequest.ts Normal file
View File

@@ -0,0 +1,21 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../../index.js";
/**
* @example
* {
* "x-max-steps-override": 1,
* "x-user-agent": "x-user-agent",
* template: true,
* body: {
* workflow_id: "wpid_123"
* }
* }
*/
export interface RunWorkflowRequest {
template?: boolean;
"x-max-steps-override"?: number;
"x-user-agent"?: string;
body: Skyvern.WorkflowRunRequest;
}

25
skyvern-ts/client/src/api/client/requests/TotpCodeCreate.ts Normal file
View File

@@ -0,0 +1,25 @@
// This file was auto-generated by Fern from our API Definition.
/**
* @example
* {
* totp_identifier: "john.doe@example.com",
* content: "Hello, your verification code is 123456"
* }
*/
export interface TotpCodeCreate {
/** The identifier of the TOTP code. It can be the email address, phone number, or the identifier of the user. */
totp_identifier: string;
/** The task_id the totp code is for. It can be the task_id of the task that the TOTP code is for. */
task_id?: string;
/** The workflow ID the TOTP code is for. It can be the workflow ID of the workflow that the TOTP code is for. */
workflow_id?: string;
/** The workflow run id that the TOTP code is for. It can be the workflow run id of the workflow run that the TOTP code is for. */
workflow_run_id?: string;
/** An optional field. The source of the TOTP code. e.g. email, sms, etc. */
source?: string;
/** The content of the TOTP code. It can be the email content that contains the TOTP code, or the sms message that contains the TOTP code. Skyvern will automatically extract the TOTP code from the content. */
content: string;
/** The timestamp when the TOTP code expires */
expired_at?: string;
}

12
skyvern-ts/client/src/api/client/requests/index.ts Normal file
View File

@@ -0,0 +1,12 @@
export type { CreateBrowserSessionRequest } from "./CreateBrowserSessionRequest.js";
export type { CreateCredentialRequest } from "./CreateCredentialRequest.js";
export type { CreateScriptRequest } from "./CreateScriptRequest.js";
export type { DeployScriptRequest } from "./DeployScriptRequest.js";
export type { GetCredentialsRequest } from "./GetCredentialsRequest.js";
export type { GetRunArtifactsRequest } from "./GetRunArtifactsRequest.js";
export type { GetScriptsRequest } from "./GetScriptsRequest.js";
export type { GetWorkflowsRequest } from "./GetWorkflowsRequest.js";
export type { LoginRequest } from "./LoginRequest.js";
export type { RunTaskRequest } from "./RunTaskRequest.js";
export type { RunWorkflowRequest } from "./RunWorkflowRequest.js";
export type { TotpCodeCreate } from "./TotpCodeCreate.js";

16
skyvern-ts/client/src/api/errors/BadRequestError.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
import type * as core from "../../core/index.js";
import * as errors from "../../errors/index.js";
export class BadRequestError extends errors.SkyvernError {
constructor(body?: unknown, rawResponse?: core.RawResponse) {
super({
message: "BadRequestError",
statusCode: 400,
body: body,
rawResponse: rawResponse,
});
Object.setPrototypeOf(this, BadRequestError.prototype);
}
}

16
skyvern-ts/client/src/api/errors/ForbiddenError.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
import type * as core from "../../core/index.js";
import * as errors from "../../errors/index.js";
export class ForbiddenError extends errors.SkyvernError {
constructor(body?: unknown, rawResponse?: core.RawResponse) {
super({
message: "ForbiddenError",
statusCode: 403,
body: body,
rawResponse: rawResponse,
});
Object.setPrototypeOf(this, ForbiddenError.prototype);
}
}

16
skyvern-ts/client/src/api/errors/NotFoundError.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
import type * as core from "../../core/index.js";
import * as errors from "../../errors/index.js";
export class NotFoundError extends errors.SkyvernError {
constructor(body?: unknown, rawResponse?: core.RawResponse) {
super({
message: "NotFoundError",
statusCode: 404,
body: body,
rawResponse: rawResponse,
});
Object.setPrototypeOf(this, NotFoundError.prototype);
}
}

16
skyvern-ts/client/src/api/errors/UnprocessableEntityError.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
import type * as core from "../../core/index.js";
import * as errors from "../../errors/index.js";
export class UnprocessableEntityError extends errors.SkyvernError {
constructor(body?: unknown, rawResponse?: core.RawResponse) {
super({
message: "UnprocessableEntityError",
statusCode: 422,
body: body,
rawResponse: rawResponse,
});
Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
}
}

4
skyvern-ts/client/src/api/errors/index.ts Normal file
View File

@@ -0,0 +1,4 @@
export * from "./BadRequestError.js";
export * from "./ForbiddenError.js";
export * from "./NotFoundError.js";
export * from "./UnprocessableEntityError.js";

4
skyvern-ts/client/src/api/index.ts Normal file
View File

@@ -0,0 +1,4 @@
export * from "./client/index.js";
export * from "./errors/index.js";
export * from "./resources/index.js";
export * from "./types/index.js";

1
skyvern-ts/client/src/api/resources/index.ts Normal file
View File

@@ -0,0 +1 @@
export * as scripts from "./scripts/index.js";

102
skyvern-ts/client/src/api/resources/scripts/client/Client.ts Normal file
View File

@@ -0,0 +1,102 @@
// This file was auto-generated by Fern from our API Definition.
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
import * as core from "../../../../core/index.js";
import * as environments from "../../../../environments.js";
import * as errors from "../../../../errors/index.js";
import * as Skyvern from "../../../index.js";
export declare namespace Scripts {
export interface Options extends BaseClientOptions {}
export interface RequestOptions extends BaseRequestOptions {}
}
export class Scripts {
protected readonly _options: Scripts.Options;
constructor(_options: Scripts.Options = {}) {
this._options = _options;
}
/**
* Run a script
*
* @param {string} scriptId - The unique identifier of the script
* @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
*
* @throws {@link Skyvern.UnprocessableEntityError}
*
* @example
* await client.scripts.runScript("s_abc123")
*/
public runScript(scriptId: string, requestOptions?: Scripts.RequestOptions): core.HttpResponsePromise<unknown> {
return core.HttpResponsePromise.fromPromise(this.__runScript(scriptId, requestOptions));
}
private async __runScript(
scriptId: string,
requestOptions?: Scripts.RequestOptions,
): Promise<core.WithRawResponse<unknown>> {
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
this._options?.headers,
mergeOnlyDefinedHeaders({
"x-api-key": requestOptions?.apiKey ?? this._options?.apiKey,
...(await this._getCustomAuthorizationHeaders()),
}),
requestOptions?.headers,
);
const _response = await core.fetcher({
url: core.url.join(
(await core.Supplier.get(this._options.baseUrl)) ??
(await core.Supplier.get(this._options.environment)) ??
environments.SkyvernEnvironment.Production,
`v1/scripts/${core.url.encodePathParam(scriptId)}/run`,
),
method: "POST",
headers: _headers,
queryParameters: requestOptions?.queryParams,
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
abortSignal: requestOptions?.abortSignal,
});
if (_response.ok) {
return { data: _response.body, rawResponse: _response.rawResponse };
}
if (_response.error.reason === "status-code") {
switch (_response.error.statusCode) {
case 422:
throw new Skyvern.UnprocessableEntityError(_response.error.body as unknown, _response.rawResponse);
default:
throw new errors.SkyvernError({
statusCode: _response.error.statusCode,
body: _response.error.body,
rawResponse: _response.rawResponse,
});
}
}
switch (_response.error.reason) {
case "non-json":
throw new errors.SkyvernError({
statusCode: _response.error.statusCode,
body: _response.error.rawBody,
rawResponse: _response.rawResponse,
});
case "timeout":
throw new errors.SkyvernTimeoutError("Timeout exceeded when calling POST /v1/scripts/{script_id}/run.");
case "unknown":
throw new errors.SkyvernError({
message: _response.error.errorMessage,
rawResponse: _response.rawResponse,
});
}
}
protected async _getCustomAuthorizationHeaders(): Promise<Record<string, string | undefined>> {
const xApiKeyValue = await core.Supplier.get(this._options.xApiKey);
return { "x-api-key": xApiKeyValue };
}
}

1
skyvern-ts/client/src/api/resources/scripts/client/index.ts Normal file
View File

@@ -0,0 +1 @@
export {};

1
skyvern-ts/client/src/api/resources/scripts/index.ts Normal file
View File

@@ -0,0 +1 @@
export * from "./client/index.js";

41
skyvern-ts/client/src/api/types/Action.ts Normal file
View File

@@ -0,0 +1,41 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface Action {
action_type: Skyvern.ActionType;
status?: Skyvern.ActionStatus;
action_id?: string;
source_action_id?: string;
organization_id?: string;
workflow_run_id?: string;
task_id?: string;
step_id?: string;
step_order?: number;
action_order?: number;
confidence_float?: number;
description?: string;
reasoning?: string;
intention?: string;
response?: string;
element_id?: string;
skyvern_element_hash?: string;
skyvern_element_data?: Record<string, unknown>;
tool_call_id?: string;
xpath?: string;
errors?: Skyvern.UserDefinedError[];
data_extraction_goal?: string;
file_name?: string;
file_url?: string;
download?: boolean;
is_upload_file_tag?: boolean;
text?: string;
input_or_select_context?: Skyvern.InputOrSelectContext;
option?: Skyvern.SelectOption;
is_checked?: boolean;
verified?: boolean;
totp_timing_info?: Record<string, unknown>;
created_at?: string;
modified_at?: string;
created_by?: string;
}

36
skyvern-ts/client/src/api/types/ActionBlock.ts Normal file
View File

@@ -0,0 +1,36 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ActionBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
task_type?: string;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
complete_criterion?: string;
terminate_criterion?: string;
navigation_goal?: string;
data_extraction_goal?: string;
data_schema?: ActionBlock.DataSchema;
error_code_mapping?: Record<string, string | undefined>;
max_retries?: number;
max_steps_per_run?: number;
parameters?: Skyvern.ActionBlockParametersItem[];
complete_on_download?: boolean;
download_suffix?: string;
totp_verification_url?: string;
totp_identifier?: string;
cache_actions?: boolean;
complete_verification?: boolean;
include_action_history_in_verification?: boolean;
download_timeout?: number;
}
export namespace ActionBlock {
export type DataSchema = Record<string, unknown> | unknown[] | string;
}

62
skyvern-ts/client/src/api/types/ActionBlockParametersItem.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ActionBlockParametersItem =
| Skyvern.ActionBlockParametersItem.AwsSecret
| Skyvern.ActionBlockParametersItem.AzureSecret
| Skyvern.ActionBlockParametersItem.AzureVaultCredential
| Skyvern.ActionBlockParametersItem.BitwardenCreditCardData
| Skyvern.ActionBlockParametersItem.BitwardenLoginCredential
| Skyvern.ActionBlockParametersItem.BitwardenSensitiveInformation
| Skyvern.ActionBlockParametersItem.Context
| Skyvern.ActionBlockParametersItem.Credential
| Skyvern.ActionBlockParametersItem.Onepassword
| Skyvern.ActionBlockParametersItem.Output
| Skyvern.ActionBlockParametersItem.Workflow;
export namespace ActionBlockParametersItem {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

22
skyvern-ts/client/src/api/types/ActionBlockYaml.ts Normal file
View File

@@ -0,0 +1,22 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ActionBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
navigation_goal?: string;
error_code_mapping?: Record<string, string | undefined>;
max_retries?: number;
parameter_keys?: string[];
complete_on_download?: boolean;
download_suffix?: string;
totp_verification_url?: string;
totp_identifier?: string;
cache_actions?: boolean;
disable_cache?: boolean;
}

9
skyvern-ts/client/src/api/types/ActionStatus.ts Normal file
View File

@@ -0,0 +1,9 @@
// This file was auto-generated by Fern from our API Definition.
export const ActionStatus = {
Pending: "pending",
Skipped: "skipped",
Failed: "failed",
Completed: "completed",
} as const;
export type ActionStatus = (typeof ActionStatus)[keyof typeof ActionStatus];

25
skyvern-ts/client/src/api/types/ActionType.ts Normal file
View File

@@ -0,0 +1,25 @@
// This file was auto-generated by Fern from our API Definition.
export const ActionType = {
Click: "click",
InputText: "input_text",
UploadFile: "upload_file",
DownloadFile: "download_file",
SelectOption: "select_option",
Checkbox: "checkbox",
Wait: "wait",
NullAction: "null_action",
SolveCaptcha: "solve_captcha",
Terminate: "terminate",
Complete: "complete",
ReloadPage: "reload_page",
Extract: "extract",
VerificationCode: "verification_code",
GotoUrl: "goto_url",
Scroll: "scroll",
Keypress: "keypress",
Move: "move",
Drag: "drag",
LeftMouse: "left_mouse",
} as const;
export type ActionType = (typeof ActionType)[keyof typeof ActionType];

22
skyvern-ts/client/src/api/types/Artifact.ts Normal file
View File

@@ -0,0 +1,22 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface Artifact {
/** The creation datetime of the task. */
created_at: string;
/** The modification datetime of the task. */
modified_at: string;
artifact_id: string;
artifact_type: Skyvern.ArtifactType;
uri: string;
task_id?: string;
step_id?: string;
workflow_run_id?: string;
workflow_run_block_id?: string;
observer_cruise_id?: string;
observer_thought_id?: string;
ai_suggestion_id?: string;
signed_url?: string;
organization_id: string;
}

31
skyvern-ts/client/src/api/types/ArtifactType.ts Normal file
View File

@@ -0,0 +1,31 @@
// This file was auto-generated by Fern from our API Definition.
export const ArtifactType = {
Recording: "recording",
BrowserConsoleLog: "browser_console_log",
SkyvernLog: "skyvern_log",
SkyvernLogRaw: "skyvern_log_raw",
Screenshot: "screenshot",
ScreenshotLlm: "screenshot_llm",
ScreenshotAction: "screenshot_action",
ScreenshotFinal: "screenshot_final",
LlmPrompt: "llm_prompt",
LlmRequest: "llm_request",
LlmResponse: "llm_response",
LlmResponseParsed: "llm_response_parsed",
LlmResponseRendered: "llm_response_rendered",
VisibleElementsIdCssMap: "visible_elements_id_css_map",
VisibleElementsIdFrameMap: "visible_elements_id_frame_map",
VisibleElementsTree: "visible_elements_tree",
VisibleElementsTreeTrimmed: "visible_elements_tree_trimmed",
VisibleElementsTreeInPrompt: "visible_elements_tree_in_prompt",
HashedHrefMap: "hashed_href_map",
VisibleElementsIdXpathMap: "visible_elements_id_xpath_map",
Html: "html",
HtmlScrape: "html_scrape",
HtmlAction: "html_action",
Trace: "trace",
Har: "har",
ScriptFile: "script_file",
} as const;
export type ArtifactType = (typeof ArtifactType)[keyof typeof ArtifactType];

12
skyvern-ts/client/src/api/types/AwsSecretParameter.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
export interface AwsSecretParameter {
key: string;
description?: string;
aws_secret_parameter_id: string;
workflow_id: string;
aws_key: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

7
skyvern-ts/client/src/api/types/AwsSecretParameterYaml.ts Normal file
View File

@@ -0,0 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
export interface AwsSecretParameterYaml {
key: string;
description?: string;
aws_key: string;
}

12
skyvern-ts/client/src/api/types/AzureSecretParameter.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
export interface AzureSecretParameter {
key: string;
description?: string;
azure_secret_parameter_id: string;
workflow_id: string;
azure_key: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

15
skyvern-ts/client/src/api/types/AzureVaultCredentialParameter.ts Normal file
View File

@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.
export interface AzureVaultCredentialParameter {
key: string;
description?: string;
azure_vault_credential_parameter_id: string;
workflow_id: string;
vault_name: string;
username_key: string;
password_key: string;
totp_secret_key?: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

10
skyvern-ts/client/src/api/types/AzureVaultCredentialParameterYaml.ts Normal file
View File

@@ -0,0 +1,10 @@
// This file was auto-generated by Fern from our API Definition.
export interface AzureVaultCredentialParameterYaml {
key: string;
description?: string;
vault_name: string;
username_key: string;
password_key: string;
totp_secret_key?: string;
}

16
skyvern-ts/client/src/api/types/BitwardenCreditCardDataParameter.ts Normal file
View File

@@ -0,0 +1,16 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenCreditCardDataParameter {
key: string;
description?: string;
bitwarden_credit_card_data_parameter_id: string;
workflow_id: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
bitwarden_collection_id: string;
bitwarden_item_id: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

11
skyvern-ts/client/src/api/types/BitwardenCreditCardDataParameterYaml.ts Normal file
View File

@@ -0,0 +1,11 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenCreditCardDataParameterYaml {
key: string;
description?: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
bitwarden_collection_id: string;
bitwarden_item_id: string;
}

17
skyvern-ts/client/src/api/types/BitwardenLoginCredentialParameter.ts Normal file
View File

@@ -0,0 +1,17 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenLoginCredentialParameter {
key: string;
description?: string;
bitwarden_login_credential_parameter_id: string;
workflow_id: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
url_parameter_key?: string;
bitwarden_collection_id?: string;
bitwarden_item_id?: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

12
skyvern-ts/client/src/api/types/BitwardenLoginCredentialParameterYaml.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenLoginCredentialParameterYaml {
key: string;
description?: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
url_parameter_key?: string;
bitwarden_collection_id?: string;
bitwarden_item_id?: string;
}

17
skyvern-ts/client/src/api/types/BitwardenSensitiveInformationParameter.ts Normal file
View File

@@ -0,0 +1,17 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenSensitiveInformationParameter {
key: string;
description?: string;
bitwarden_sensitive_information_parameter_id: string;
workflow_id: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
bitwarden_collection_id: string;
bitwarden_identity_key: string;
bitwarden_identity_fields: string[];
created_at: string;
modified_at: string;
deleted_at?: string;
}

12
skyvern-ts/client/src/api/types/BitwardenSensitiveInformationParameterYaml.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
export interface BitwardenSensitiveInformationParameterYaml {
key: string;
description?: string;
bitwarden_client_id_aws_secret_key: string;
bitwarden_client_secret_aws_secret_key: string;
bitwarden_master_password_aws_secret_key: string;
bitwarden_collection_id: string;
bitwarden_identity_key: string;
bitwarden_identity_fields: string[];
}

25
skyvern-ts/client/src/api/types/BlockType.ts Normal file
View File

@@ -0,0 +1,25 @@
// This file was auto-generated by Fern from our API Definition.
export const BlockType = {
Task: "task",
TaskV2: "task_v2",
ForLoop: "for_loop",
Code: "code",
TextPrompt: "text_prompt",
DownloadToS3: "download_to_s3",
UploadToS3: "upload_to_s3",
FileUpload: "file_upload",
SendEmail: "send_email",
FileUrlParser: "file_url_parser",
Validation: "validation",
Action: "action",
Navigation: "navigation",
Extraction: "extraction",
Login: "login",
Wait: "wait",
FileDownload: "file_download",
GotoUrl: "goto_url",
PdfParser: "pdf_parser",
HttpRequest: "http_request",
} as const;
export type BlockType = (typeof BlockType)[keyof typeof BlockType];

41
skyvern-ts/client/src/api/types/BrowserSessionResponse.ts Normal file
View File

@@ -0,0 +1,41 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
/**
* Response model for browser session information.
*/
export interface BrowserSessionResponse {
/** Unique identifier for the browser session. browser_session_id starts with `pbs_`. */
browser_session_id: string;
/** ID of the organization that owns this session */
organization_id: string;
/** Type of the current runnable associated with this session (workflow, task etc) */
runnable_type?: string;
/** ID of the current runnable */
runnable_id?: string;
/** Timeout in minutes for the session. Timeout is applied after the session is started. Defaults to 60 minutes. */
timeout?: number;
/** Url for connecting to the browser */
browser_address?: string;
/** Url for the browser session page */
app_url?: string;
/** Whether the browser session supports VNC streaming */
vnc_streaming_supported?: boolean;
/** The path where the browser session downloads files */
download_path?: string;
/** The list of files downloaded by the browser session */
downloaded_files?: Skyvern.FileInfo[];
/** The list of video recordings from the browser session */
recordings?: Skyvern.FileInfo[];
/** Timestamp when the session was started */
started_at?: string;
/** Timestamp when the session was completed */
completed_at?: string;
/** Timestamp when the session was created (the timestamp for the initial request) */
created_at: string;
/** Timestamp when the session was last modified */
modified_at: string;
/** Timestamp when the session was deleted, if applicable */
deleted_at?: string;
}

13
skyvern-ts/client/src/api/types/CodeBlock.ts Normal file
View File

@@ -0,0 +1,13 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface CodeBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
code: string;
parameters?: Skyvern.CodeBlockParametersItem[];
}

62
skyvern-ts/client/src/api/types/CodeBlockParametersItem.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type CodeBlockParametersItem =
| Skyvern.CodeBlockParametersItem.AwsSecret
| Skyvern.CodeBlockParametersItem.AzureSecret
| Skyvern.CodeBlockParametersItem.AzureVaultCredential
| Skyvern.CodeBlockParametersItem.BitwardenCreditCardData
| Skyvern.CodeBlockParametersItem.BitwardenLoginCredential
| Skyvern.CodeBlockParametersItem.BitwardenSensitiveInformation
| Skyvern.CodeBlockParametersItem.Context
| Skyvern.CodeBlockParametersItem.Credential
| Skyvern.CodeBlockParametersItem.Onepassword
| Skyvern.CodeBlockParametersItem.Output
| Skyvern.CodeBlockParametersItem.Workflow;
export namespace CodeBlockParametersItem {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

9
skyvern-ts/client/src/api/types/CodeBlockYaml.ts Normal file
View File

@@ -0,0 +1,9 @@
// This file was auto-generated by Fern from our API Definition.
export interface CodeBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
code: string;
parameter_keys?: string[];
}

14
skyvern-ts/client/src/api/types/ContextParameter.ts Normal file
View File

@@ -0,0 +1,14 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ContextParameter {
key: string;
description?: string;
source: Skyvern.ContextParameterSource;
value?: ContextParameter.Value;
}
export namespace ContextParameter {
export type Value = string | number | number | boolean | Record<string, unknown> | unknown[];
}

62
skyvern-ts/client/src/api/types/ContextParameterSource.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ContextParameterSource =
| Skyvern.ContextParameterSource.Workflow
| Skyvern.ContextParameterSource.Context
| Skyvern.ContextParameterSource.AwsSecret
| Skyvern.ContextParameterSource.AzureSecret
| Skyvern.ContextParameterSource.BitwardenLoginCredential
| Skyvern.ContextParameterSource.BitwardenSensitiveInformation
| Skyvern.ContextParameterSource.BitwardenCreditCardData
| Skyvern.ContextParameterSource.Onepassword
| Skyvern.ContextParameterSource.AzureVaultCredential
| Skyvern.ContextParameterSource.Output
| Skyvern.ContextParameterSource.Credential;
export namespace ContextParameterSource {
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
}

7
skyvern-ts/client/src/api/types/ContextParameterYaml.ts Normal file
View File

@@ -0,0 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
export interface ContextParameterYaml {
key: string;
description?: string;
source_parameter_key: string;
}

18
skyvern-ts/client/src/api/types/CreateScriptResponse.ts Normal file
View File

@@ -0,0 +1,18 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface CreateScriptResponse {
/** Unique script identifier */
script_id: string;
/** Script version number */
version: number;
/** ID of the workflow run or task run that generated this script */
run_id?: string;
/** Total number of files in the script */
file_count: number;
/** Hierarchical file tree structure */
file_tree: Record<string, Skyvern.FileNode>;
/** Timestamp when the script was created */
created_at: string;
}

12
skyvern-ts/client/src/api/types/CredentialParameter.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
export interface CredentialParameter {
key: string;
description?: string;
credential_parameter_id: string;
workflow_id: string;
credential_id: string;
created_at: string;
modified_at: string;
deleted_at?: string;
}

7
skyvern-ts/client/src/api/types/CredentialParameterYaml.ts Normal file
View File

@@ -0,0 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
export interface CredentialParameterYaml {
key: string;
description?: string;
credential_id: string;
}

24
skyvern-ts/client/src/api/types/CredentialResponse.ts Normal file
View File

@@ -0,0 +1,24 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
/**
* Response model for credential operations.
*/
export interface CredentialResponse {
/** Unique identifier for the credential */
credential_id: string;
/** The credential data */
credential: CredentialResponse.Credential;
/** Type of the credential */
credential_type: Skyvern.CredentialTypeOutput;
/** Name of the credential */
name: string;
}
export namespace CredentialResponse {
/**
* The credential data
*/
export type Credential = Skyvern.PasswordCredentialResponse | Skyvern.CreditCardCredentialResponse;
}

8
skyvern-ts/client/src/api/types/CredentialTypeOutput.ts Normal file
View File

@@ -0,0 +1,8 @@
// This file was auto-generated by Fern from our API Definition.
/** Type of credential stored in the system. */
export const CredentialTypeOutput = {
Password: "password",
CreditCard: "credit_card",
} as const;
export type CredentialTypeOutput = (typeof CredentialTypeOutput)[keyof typeof CredentialTypeOutput];

11
skyvern-ts/client/src/api/types/CreditCardCredentialResponse.ts Normal file
View File

@@ -0,0 +1,11 @@
// This file was auto-generated by Fern from our API Definition.
/**
* Response model for credit card credentials, containing only the last four digits and brand.
*/
export interface CreditCardCredentialResponse {
/** Last four digits of the credit card number */
last_four: string;
/** Brand of the credit card */
brand: string;
}

12
skyvern-ts/client/src/api/types/DownloadToS3Block.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface DownloadToS3Block {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
url: string;
}

8
skyvern-ts/client/src/api/types/DownloadToS3BlockYaml.ts Normal file
View File

@@ -0,0 +1,8 @@
// This file was auto-generated by Fern from our API Definition.
export interface DownloadToS3BlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
url: string;
}

36
skyvern-ts/client/src/api/types/ExtractionBlock.ts Normal file
View File

@@ -0,0 +1,36 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ExtractionBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
task_type?: string;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
complete_criterion?: string;
terminate_criterion?: string;
navigation_goal?: string;
data_extraction_goal: string;
data_schema?: ExtractionBlock.DataSchema;
error_code_mapping?: Record<string, string | undefined>;
max_retries?: number;
max_steps_per_run?: number;
parameters?: Skyvern.ExtractionBlockParametersItem[];
complete_on_download?: boolean;
download_suffix?: string;
totp_verification_url?: string;
totp_identifier?: string;
cache_actions?: boolean;
complete_verification?: boolean;
include_action_history_in_verification?: boolean;
download_timeout?: number;
}
export namespace ExtractionBlock {
export type DataSchema = Record<string, unknown> | unknown[] | string;
}

62
skyvern-ts/client/src/api/types/ExtractionBlockParametersItem.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ExtractionBlockParametersItem =
| Skyvern.ExtractionBlockParametersItem.AwsSecret
| Skyvern.ExtractionBlockParametersItem.AzureSecret
| Skyvern.ExtractionBlockParametersItem.AzureVaultCredential
| Skyvern.ExtractionBlockParametersItem.BitwardenCreditCardData
| Skyvern.ExtractionBlockParametersItem.BitwardenLoginCredential
| Skyvern.ExtractionBlockParametersItem.BitwardenSensitiveInformation
| Skyvern.ExtractionBlockParametersItem.Context
| Skyvern.ExtractionBlockParametersItem.Credential
| Skyvern.ExtractionBlockParametersItem.Onepassword
| Skyvern.ExtractionBlockParametersItem.Output
| Skyvern.ExtractionBlockParametersItem.Workflow;
export namespace ExtractionBlockParametersItem {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

23
skyvern-ts/client/src/api/types/ExtractionBlockYaml.ts Normal file
View File

@@ -0,0 +1,23 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ExtractionBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
data_extraction_goal: string;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
data_schema?: ExtractionBlockYaml.DataSchema;
max_retries?: number;
max_steps_per_run?: number;
parameter_keys?: string[];
cache_actions?: boolean;
disable_cache?: boolean;
}
export namespace ExtractionBlockYaml {
export type DataSchema = Record<string, unknown> | unknown[] | string;
}

36
skyvern-ts/client/src/api/types/FileDownloadBlock.ts Normal file
View File

@@ -0,0 +1,36 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileDownloadBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
task_type?: string;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
complete_criterion?: string;
terminate_criterion?: string;
navigation_goal?: string;
data_extraction_goal?: string;
data_schema?: FileDownloadBlock.DataSchema;
error_code_mapping?: Record<string, string | undefined>;
max_retries?: number;
max_steps_per_run?: number;
parameters?: Skyvern.FileDownloadBlockParametersItem[];
complete_on_download?: boolean;
download_suffix?: string;
totp_verification_url?: string;
totp_identifier?: string;
cache_actions?: boolean;
complete_verification?: boolean;
include_action_history_in_verification?: boolean;
download_timeout?: number;
}
export namespace FileDownloadBlock {
export type DataSchema = Record<string, unknown> | unknown[] | string;
}

62
skyvern-ts/client/src/api/types/FileDownloadBlockParametersItem.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type FileDownloadBlockParametersItem =
| Skyvern.FileDownloadBlockParametersItem.AwsSecret
| Skyvern.FileDownloadBlockParametersItem.AzureSecret
| Skyvern.FileDownloadBlockParametersItem.AzureVaultCredential
| Skyvern.FileDownloadBlockParametersItem.BitwardenCreditCardData
| Skyvern.FileDownloadBlockParametersItem.BitwardenLoginCredential
| Skyvern.FileDownloadBlockParametersItem.BitwardenSensitiveInformation
| Skyvern.FileDownloadBlockParametersItem.Context
| Skyvern.FileDownloadBlockParametersItem.Credential
| Skyvern.FileDownloadBlockParametersItem.Onepassword
| Skyvern.FileDownloadBlockParametersItem.Output
| Skyvern.FileDownloadBlockParametersItem.Workflow;
export namespace FileDownloadBlockParametersItem {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

23
skyvern-ts/client/src/api/types/FileDownloadBlockYaml.ts Normal file
View File

@@ -0,0 +1,23 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileDownloadBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
navigation_goal: string;
url?: string;
title?: string;
engine?: Skyvern.RunEngine;
error_code_mapping?: Record<string, string | undefined>;
max_retries?: number;
max_steps_per_run?: number;
parameter_keys?: string[];
download_suffix?: string;
totp_verification_url?: string;
totp_identifier?: string;
cache_actions?: boolean;
disable_cache?: boolean;
download_timeout?: number;
}

8
skyvern-ts/client/src/api/types/FileEncoding.ts Normal file
View File

@@ -0,0 +1,8 @@
// This file was auto-generated by Fern from our API Definition.
/** Supported file content encodings. */
export const FileEncoding = {
Base64: "base64",
Utf8: "utf-8",
} as const;
export type FileEncoding = (typeof FileEncoding)[keyof typeof FileEncoding];

15
skyvern-ts/client/src/api/types/FileInfo.ts Normal file
View File

@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.
/**
* Information about a downloaded file, including URL and checksum.
*/
export interface FileInfo {
/** URL to access the file */
url: string;
/** SHA-256 checksum of the file */
checksum?: string;
/** Original filename */
filename?: string;
/** Modified time of the file */
modified_at?: string;
}

21
skyvern-ts/client/src/api/types/FileNode.ts Normal file
View File

@@ -0,0 +1,21 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
/**
* Model representing a file or directory in the file tree.
*/
export interface FileNode {
/** Type of node: 'file' or 'directory' */
type: string;
/** File size in bytes */
size?: number;
/** MIME type of the file */
mime_type?: string;
/** SHA256 hash of file content */
content_hash?: string;
/** Timestamp when the file was created */
created_at: string;
/** Child nodes for directories */
children?: Record<string, Skyvern.FileNode | undefined>;
}

14
skyvern-ts/client/src/api/types/FileParserBlock.ts Normal file
View File

@@ -0,0 +1,14 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileParserBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
file_url: string;
file_type: Skyvern.FileType;
json_schema?: Record<string, unknown>;
}

12
skyvern-ts/client/src/api/types/FileParserBlockYaml.ts Normal file
View File

@@ -0,0 +1,12 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileParserBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
file_url: string;
file_type: Skyvern.FileType;
json_schema?: Record<string, unknown>;
}

7
skyvern-ts/client/src/api/types/FileStorageType.ts Normal file
View File

@@ -0,0 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
export const FileStorageType = {
S3: "s3",
Azure: "azure",
} as const;
export type FileStorageType = (typeof FileStorageType)[keyof typeof FileStorageType];

8
skyvern-ts/client/src/api/types/FileType.ts Normal file
View File

@@ -0,0 +1,8 @@
// This file was auto-generated by Fern from our API Definition.
export const FileType = {
Csv: "csv",
Excel: "excel",
Pdf: "pdf",
} as const;
export type FileType = (typeof FileType)[keyof typeof FileType];

20
skyvern-ts/client/src/api/types/FileUploadBlock.ts Normal file
View File

@@ -0,0 +1,20 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileUploadBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
storage_type?: Skyvern.FileStorageType;
s3_bucket?: string;
aws_access_key_id?: string;
aws_secret_access_key?: string;
region_name?: string;
azure_storage_account_name?: string;
azure_storage_account_key?: string;
azure_blob_container_name?: string;
path?: string;
}

19
skyvern-ts/client/src/api/types/FileUploadBlockYaml.ts Normal file
View File

@@ -0,0 +1,19 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface FileUploadBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
storage_type?: Skyvern.FileStorageType;
s3_bucket?: string;
aws_access_key_id?: string;
aws_secret_access_key?: string;
region_name?: string;
azure_storage_account_name?: string;
azure_storage_account_key?: string;
azure_blob_container_name?: string;
azure_folder_path?: string;
path?: string;
}

15
skyvern-ts/client/src/api/types/ForLoopBlock.ts Normal file
View File

@@ -0,0 +1,15 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ForLoopBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
loop_blocks: Skyvern.ForLoopBlockLoopBlocksItem[];
loop_over?: Skyvern.ForLoopBlockLoopOver;
loop_variable_reference?: string;
complete_if_empty?: boolean;
}

107
skyvern-ts/client/src/api/types/ForLoopBlockLoopBlocksItem.ts Normal file
View File

@@ -0,0 +1,107 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ForLoopBlockLoopBlocksItem =
| Skyvern.ForLoopBlockLoopBlocksItem.Action
| Skyvern.ForLoopBlockLoopBlocksItem.Code
| Skyvern.ForLoopBlockLoopBlocksItem.DownloadToS3
| Skyvern.ForLoopBlockLoopBlocksItem.Extraction
| Skyvern.ForLoopBlockLoopBlocksItem.FileDownload
| Skyvern.ForLoopBlockLoopBlocksItem.FileUpload
| Skyvern.ForLoopBlockLoopBlocksItem.FileUrlParser
| Skyvern.ForLoopBlockLoopBlocksItem.ForLoop
| Skyvern.ForLoopBlockLoopBlocksItem.GotoUrl
| Skyvern.ForLoopBlockLoopBlocksItem.HttpRequest
| Skyvern.ForLoopBlockLoopBlocksItem.Login
| Skyvern.ForLoopBlockLoopBlocksItem.Navigation
| Skyvern.ForLoopBlockLoopBlocksItem.PdfParser
| Skyvern.ForLoopBlockLoopBlocksItem.SendEmail
| Skyvern.ForLoopBlockLoopBlocksItem.Task
| Skyvern.ForLoopBlockLoopBlocksItem.TaskV2
| Skyvern.ForLoopBlockLoopBlocksItem.TextPrompt
| Skyvern.ForLoopBlockLoopBlocksItem.UploadToS3
| Skyvern.ForLoopBlockLoopBlocksItem.Validation
| Skyvern.ForLoopBlockLoopBlocksItem.Wait;
export namespace ForLoopBlockLoopBlocksItem {
export interface Action extends Skyvern.ActionBlock {
block_type: "action";
}
export interface Code extends Skyvern.CodeBlock {
block_type: "code";
}
export interface DownloadToS3 extends Skyvern.DownloadToS3Block {
block_type: "download_to_s3";
}
export interface Extraction extends Skyvern.ExtractionBlock {
block_type: "extraction";
}
export interface FileDownload extends Skyvern.FileDownloadBlock {
block_type: "file_download";
}
export interface FileUpload extends Skyvern.FileUploadBlock {
block_type: "file_upload";
}
export interface FileUrlParser extends Skyvern.FileParserBlock {
block_type: "file_url_parser";
}
export interface ForLoop extends Skyvern.ForLoopBlock {
block_type: "for_loop";
}
export interface GotoUrl extends Skyvern.UrlBlock {
block_type: "goto_url";
}
export interface HttpRequest extends Skyvern.HttpRequestBlock {
block_type: "http_request";
}
export interface Login extends Skyvern.LoginBlock {
block_type: "login";
}
export interface Navigation extends Skyvern.NavigationBlock {
block_type: "navigation";
}
export interface PdfParser extends Skyvern.PdfParserBlock {
block_type: "pdf_parser";
}
export interface SendEmail extends Skyvern.SendEmailBlock {
block_type: "send_email";
}
export interface Task extends Skyvern.TaskBlock {
block_type: "task";
}
export interface TaskV2 extends Skyvern.TaskV2Block {
block_type: "task_v2";
}
export interface TextPrompt extends Skyvern.TextPromptBlock {
block_type: "text_prompt";
}
export interface UploadToS3 extends Skyvern.UploadToS3Block {
block_type: "upload_to_s3";
}
export interface Validation extends Skyvern.ValidationBlock {
block_type: "validation";
}
export interface Wait extends Skyvern.WaitBlock {
block_type: "wait";
}
}

62
skyvern-ts/client/src/api/types/ForLoopBlockLoopOver.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ForLoopBlockLoopOver =
| Skyvern.ForLoopBlockLoopOver.AwsSecret
| Skyvern.ForLoopBlockLoopOver.AzureSecret
| Skyvern.ForLoopBlockLoopOver.AzureVaultCredential
| Skyvern.ForLoopBlockLoopOver.BitwardenCreditCardData
| Skyvern.ForLoopBlockLoopOver.BitwardenLoginCredential
| Skyvern.ForLoopBlockLoopOver.BitwardenSensitiveInformation
| Skyvern.ForLoopBlockLoopOver.Context
| Skyvern.ForLoopBlockLoopOver.Credential
| Skyvern.ForLoopBlockLoopOver.Onepassword
| Skyvern.ForLoopBlockLoopOver.Output
| Skyvern.ForLoopBlockLoopOver.Workflow;
export namespace ForLoopBlockLoopOver {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

13
skyvern-ts/client/src/api/types/ForLoopBlockYaml.ts Normal file
View File

@@ -0,0 +1,13 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface ForLoopBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
loop_blocks: Skyvern.ForLoopBlockYamlLoopBlocksItem[];
loop_over_parameter_key?: string;
loop_variable_reference?: string;
complete_if_empty?: boolean;
}

107
skyvern-ts/client/src/api/types/ForLoopBlockYamlLoopBlocksItem.ts Normal file
View File

@@ -0,0 +1,107 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type ForLoopBlockYamlLoopBlocksItem =
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Task
| Skyvern.ForLoopBlockYamlLoopBlocksItem.ForLoop
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Code
| Skyvern.ForLoopBlockYamlLoopBlocksItem.TextPrompt
| Skyvern.ForLoopBlockYamlLoopBlocksItem.DownloadToS3
| Skyvern.ForLoopBlockYamlLoopBlocksItem.UploadToS3
| Skyvern.ForLoopBlockYamlLoopBlocksItem.FileUpload
| Skyvern.ForLoopBlockYamlLoopBlocksItem.SendEmail
| Skyvern.ForLoopBlockYamlLoopBlocksItem.FileUrlParser
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Validation
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Action
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Navigation
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Extraction
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Login
| Skyvern.ForLoopBlockYamlLoopBlocksItem.Wait
| Skyvern.ForLoopBlockYamlLoopBlocksItem.FileDownload
| Skyvern.ForLoopBlockYamlLoopBlocksItem.GotoUrl
| Skyvern.ForLoopBlockYamlLoopBlocksItem.PdfParser
| Skyvern.ForLoopBlockYamlLoopBlocksItem.TaskV2
| Skyvern.ForLoopBlockYamlLoopBlocksItem.HttpRequest;
export namespace ForLoopBlockYamlLoopBlocksItem {
export interface Task extends Skyvern.TaskBlockYaml {
block_type: "task";
}
export interface ForLoop extends Skyvern.ForLoopBlockYaml {
block_type: "for_loop";
}
export interface Code extends Skyvern.CodeBlockYaml {
block_type: "code";
}
export interface TextPrompt extends Skyvern.TextPromptBlockYaml {
block_type: "text_prompt";
}
export interface DownloadToS3 extends Skyvern.DownloadToS3BlockYaml {
block_type: "download_to_s3";
}
export interface UploadToS3 extends Skyvern.UploadToS3BlockYaml {
block_type: "upload_to_s3";
}
export interface FileUpload extends Skyvern.FileUploadBlockYaml {
block_type: "file_upload";
}
export interface SendEmail extends Skyvern.SendEmailBlockYaml {
block_type: "send_email";
}
export interface FileUrlParser extends Skyvern.FileParserBlockYaml {
block_type: "file_url_parser";
}
export interface Validation extends Skyvern.ValidationBlockYaml {
block_type: "validation";
}
export interface Action extends Skyvern.ActionBlockYaml {
block_type: "action";
}
export interface Navigation extends Skyvern.NavigationBlockYaml {
block_type: "navigation";
}
export interface Extraction extends Skyvern.ExtractionBlockYaml {
block_type: "extraction";
}
export interface Login extends Skyvern.LoginBlockYaml {
block_type: "login";
}
export interface Wait extends Skyvern.WaitBlockYaml {
block_type: "wait";
}
export interface FileDownload extends Skyvern.FileDownloadBlockYaml {
block_type: "file_download";
}
export interface GotoUrl extends Skyvern.UrlBlockYaml {
block_type: "goto_url";
}
export interface PdfParser extends Skyvern.PdfParserBlockYaml {
block_type: "pdf_parser";
}
export interface TaskV2 extends Skyvern.TaskV2BlockYaml {
block_type: "task_v2";
}
export interface HttpRequest extends Skyvern.HttpRequestBlockYaml {
block_type: "http_request";
}
}

37
skyvern-ts/client/src/api/types/GetRunResponse.ts Normal file
View File

@@ -0,0 +1,37 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type GetRunResponse =
| Skyvern.GetRunResponse.TaskV1
| Skyvern.GetRunResponse.TaskV2
| Skyvern.GetRunResponse.OpenaiCua
| Skyvern.GetRunResponse.AnthropicCua
| Skyvern.GetRunResponse.UiTars
| Skyvern.GetRunResponse.WorkflowRun;
export namespace GetRunResponse {
export interface TaskV1 extends Skyvern.TaskRunResponse {
run_type: "task_v1";
}
export interface TaskV2 extends Skyvern.TaskRunResponse {
run_type: "task_v2";
}
export interface OpenaiCua extends Skyvern.TaskRunResponse {
run_type: "openai_cua";
}
export interface AnthropicCua extends Skyvern.TaskRunResponse {
run_type: "anthropic_cua";
}
export interface UiTars extends Skyvern.TaskRunResponse {
run_type: "ui_tars";
}
export interface WorkflowRun extends Skyvern.WorkflowRunResponse {
run_type: "workflow_run";
}
}

18
skyvern-ts/client/src/api/types/HttpRequestBlock.ts Normal file
View File

@@ -0,0 +1,18 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface HttpRequestBlock {
label: string;
output_parameter: Skyvern.OutputParameter;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
disable_cache?: boolean;
method?: string;
url?: string;
headers?: Record<string, string | undefined>;
body?: Record<string, unknown>;
timeout?: number;
follow_redirects?: boolean;
parameters?: Skyvern.HttpRequestBlockParametersItem[];
}

62
skyvern-ts/client/src/api/types/HttpRequestBlockParametersItem.ts Normal file
View File

@@ -0,0 +1,62 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export type HttpRequestBlockParametersItem =
| Skyvern.HttpRequestBlockParametersItem.AwsSecret
| Skyvern.HttpRequestBlockParametersItem.AzureSecret
| Skyvern.HttpRequestBlockParametersItem.AzureVaultCredential
| Skyvern.HttpRequestBlockParametersItem.BitwardenCreditCardData
| Skyvern.HttpRequestBlockParametersItem.BitwardenLoginCredential
| Skyvern.HttpRequestBlockParametersItem.BitwardenSensitiveInformation
| Skyvern.HttpRequestBlockParametersItem.Context
| Skyvern.HttpRequestBlockParametersItem.Credential
| Skyvern.HttpRequestBlockParametersItem.Onepassword
| Skyvern.HttpRequestBlockParametersItem.Output
| Skyvern.HttpRequestBlockParametersItem.Workflow;
export namespace HttpRequestBlockParametersItem {
export interface AwsSecret extends Skyvern.AwsSecretParameter {
parameter_type: "aws_secret";
}
export interface AzureSecret extends Skyvern.AzureSecretParameter {
parameter_type: "azure_secret";
}
export interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
parameter_type: "azure_vault_credential";
}
export interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
parameter_type: "bitwarden_credit_card_data";
}
export interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
parameter_type: "bitwarden_login_credential";
}
export interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
parameter_type: "bitwarden_sensitive_information";
}
export interface Context extends Skyvern.ContextParameter {
parameter_type: "context";
}
export interface Credential extends Skyvern.CredentialParameter {
parameter_type: "credential";
}
export interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
parameter_type: "onepassword";
}
export interface Output extends Skyvern.OutputParameter {
parameter_type: "output";
}
export interface Workflow extends Skyvern.WorkflowParameter {
parameter_type: "workflow";
}
}

14
skyvern-ts/client/src/api/types/HttpRequestBlockYaml.ts Normal file
View File

@@ -0,0 +1,14 @@
// This file was auto-generated by Fern from our API Definition.
export interface HttpRequestBlockYaml {
label: string;
continue_on_failure?: boolean;
model?: Record<string, unknown>;
method?: string;
url?: string;
headers?: Record<string, string | undefined>;
body?: Record<string, unknown>;
timeout?: number;
follow_redirects?: boolean;
parameter_keys?: string[];
}

7
skyvern-ts/client/src/api/types/HttpValidationError.ts Normal file
View File

@@ -0,0 +1,7 @@
// This file was auto-generated by Fern from our API Definition.
import type * as Skyvern from "../index.js";
export interface HttpValidationError {
detail?: Skyvern.ValidationError[];
}

Some files were not shown because too many files have changed in this diff Show More