Release 1.0.0 (#4003)
This commit is contained in:
committed by
GitHub
parent
9814f9803a
commit
aefc86a453
@@ -1,6 +1,6 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "skyvern"
|
name = "skyvern"
|
||||||
version = "0.2.23"
|
version = "1.0.0"
|
||||||
description = ""
|
description = ""
|
||||||
authors = [{ name = "Skyvern AI", email = "info@skyvern.com" }]
|
authors = [{ name = "Skyvern AI", email = "info@skyvern.com" }]
|
||||||
requires-python = ">=3.11,<3.14"
|
requires-python = ">=3.11,<3.14"
|
||||||
|
|||||||
@@ -5,6 +5,23 @@
|
|||||||
|
|
||||||
The Skyvern TypeScript library provides convenient access to the Skyvern APIs from TypeScript.
|
The Skyvern TypeScript library provides convenient access to the Skyvern APIs from TypeScript.
|
||||||
|
|
||||||
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Installation](#installation)
|
||||||
|
- [Reference](#reference)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Request and Response Types](#request-and-response-types)
|
||||||
|
- [Exception Handling](#exception-handling)
|
||||||
|
- [Advanced](#advanced)
|
||||||
|
- [Additional Headers](#additional-headers)
|
||||||
|
- [Additional Query String Parameters](#additional-query-string-parameters)
|
||||||
|
- [Retries](#retries)
|
||||||
|
- [Timeouts](#timeouts)
|
||||||
|
- [Aborting Requests](#aborting-requests)
|
||||||
|
- [Access Raw Response Data](#access-raw-response-data)
|
||||||
|
- [Runtime Compatibility](#runtime-compatibility)
|
||||||
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -31,7 +48,7 @@ await client.runTask({
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
## Request And Response Types
|
## Request and Response Types
|
||||||
|
|
||||||
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
|
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
|
||||||
following namespace:
|
following namespace:
|
||||||
|
|||||||
46
skyvern-ts/client/package-lock.json
generated
46
skyvern-ts/client/package-lock.json
generated
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@skyvern/client",
|
"name": "@skyvern/client",
|
||||||
"version": "0.2.23",
|
"version": "1.0.0",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@skyvern/client",
|
"name": "@skyvern/client",
|
||||||
"version": "0.2.23",
|
"version": "1.0.0",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@biomejs/biome": "2.2.5",
|
"@biomejs/biome": "2.2.5",
|
||||||
"@types/node": "^18.19.70",
|
"@types/node": "^18.19.70",
|
||||||
@@ -656,13 +656,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@inquirer/confirm": {
|
"node_modules/@inquirer/confirm": {
|
||||||
"version": "5.1.20",
|
"version": "5.1.21",
|
||||||
"resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.20.tgz",
|
"resolved": "https://registry.npmjs.org/@inquirer/confirm/-/confirm-5.1.21.tgz",
|
||||||
"integrity": "sha512-HDGiWh2tyRZa0M1ZnEIUCQro25gW/mN8ODByicQrbR1yHx4hT+IOpozCMi5TgBtUdklLwRI2mv14eNpftDluEw==",
|
"integrity": "sha512-KR8edRkIsUayMXV+o3Gv+q4jlhENF9nMYUZs9PA2HzrXeHI8M5uDag70U7RJn9yyiMZSbtF5/UexBtAVtZGSbQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@inquirer/core": "^10.3.1",
|
"@inquirer/core": "^10.3.2",
|
||||||
"@inquirer/type": "^3.0.10"
|
"@inquirer/type": "^3.0.10"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
@@ -678,9 +678,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@inquirer/core": {
|
"node_modules/@inquirer/core": {
|
||||||
"version": "10.3.1",
|
"version": "10.3.2",
|
||||||
"resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.3.1.tgz",
|
"resolved": "https://registry.npmjs.org/@inquirer/core/-/core-10.3.2.tgz",
|
||||||
"integrity": "sha512-hzGKIkfomGFPgxKmnKEKeA+uCYBqC+TKtRx5LgyHRCrF6S2MliwRIjp3sUaWwVzMp7ZXVs8elB0Tfe682Rpg4w==",
|
"integrity": "sha512-43RTuEbfP8MbKzedNqBrlhhNKVwoK//vUFNW3Q3vZ88BLcrs4kYpGg+B2mm5p2K/HfygoCxuKwJJiv8PbGmE0A==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
@@ -688,7 +688,7 @@
|
|||||||
"@inquirer/figures": "^1.0.15",
|
"@inquirer/figures": "^1.0.15",
|
||||||
"@inquirer/type": "^3.0.10",
|
"@inquirer/type": "^3.0.10",
|
||||||
"cli-width": "^4.1.0",
|
"cli-width": "^4.1.0",
|
||||||
"mute-stream": "^3.0.0",
|
"mute-stream": "^2.0.0",
|
||||||
"signal-exit": "^4.1.0",
|
"signal-exit": "^4.1.0",
|
||||||
"wrap-ansi": "^6.2.0",
|
"wrap-ansi": "^6.2.0",
|
||||||
"yoctocolors-cjs": "^2.1.3"
|
"yoctocolors-cjs": "^2.1.3"
|
||||||
@@ -1586,9 +1586,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/baseline-browser-mapping": {
|
"node_modules/baseline-browser-mapping": {
|
||||||
"version": "2.8.26",
|
"version": "2.8.28",
|
||||||
"resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.8.26.tgz",
|
"resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.8.28.tgz",
|
||||||
"integrity": "sha512-73lC1ugzwoaWCLJ1LvOgrR5xsMLTqSKIEoMHVtL9E/HNk0PXtTM76ZIm84856/SF7Nv8mPZxKoBsgpm0tR1u1Q==",
|
"integrity": "sha512-gYjt7OIqdM0PcttNYP2aVrr2G0bMALkBaoehD4BuRGjAOtipg0b6wHg1yNL+s5zSnLZZrGHOw4IrND8CD+3oIQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "Apache-2.0",
|
"license": "Apache-2.0",
|
||||||
"bin": {
|
"bin": {
|
||||||
@@ -1843,9 +1843,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/electron-to-chromium": {
|
"node_modules/electron-to-chromium": {
|
||||||
"version": "1.5.250",
|
"version": "1.5.253",
|
||||||
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.250.tgz",
|
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.253.tgz",
|
||||||
"integrity": "sha512-/5UMj9IiGDMOFBnN4i7/Ry5onJrAGSbOGo3s9FEKmwobGq6xw832ccET0CE3CkkMBZ8GJSlUIesZofpyurqDXw==",
|
"integrity": "sha512-O0tpQ/35rrgdiGQ0/OFWhy1itmd9A6TY9uQzlqj3hKSu/aYpe7UIn5d7CU2N9myH6biZiWF3VMZVuup8pw5U9w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "ISC"
|
"license": "ISC"
|
||||||
},
|
},
|
||||||
@@ -2317,13 +2317,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/mute-stream": {
|
"node_modules/mute-stream": {
|
||||||
"version": "3.0.0",
|
"version": "2.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-3.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/mute-stream/-/mute-stream-2.0.0.tgz",
|
||||||
"integrity": "sha512-dkEJPVvun4FryqBmZ5KhDo0K9iDXAwn08tMLDinNdRBNPcYEDiWYysLcc6k3mjTMlbP9KyylvRpd4wFtwrT9rw==",
|
"integrity": "sha512-WWdIxpyjEn+FhQJQQv9aQAYlHoNVdzIzUySNV1gHUPDSdZJ3yZn7pAAbQcV7B56Mvu881q9FZV+0Vx2xC44VWA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "^20.17.0 || >=22.9.0"
|
"node": "^18.17.0 || >=20.5.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/nanoid": {
|
"node_modules/nanoid": {
|
||||||
@@ -3044,9 +3044,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/vite-node/node_modules/@types/node": {
|
"node_modules/vite-node/node_modules/@types/node": {
|
||||||
"version": "24.10.0",
|
"version": "24.10.1",
|
||||||
"resolved": "https://registry.npmjs.org/@types/node/-/node-24.10.0.tgz",
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-24.10.1.tgz",
|
||||||
"integrity": "sha512-qzQZRBqkFsYyaSWXuEHc2WR9c0a0CXwiE5FWUvn7ZM+vdy1uZLfCunD38UzhuB7YN/J11ndbDBcTmOdxJo9Q7A==",
|
"integrity": "sha512-GNWcUTRBgIRJD5zj+Tq0fKOJ5XZajIiBroOF0yvj2bSU1WvNdYS/dn9UxwsujGW4JX06dnHyjV2y9rRaybH0iQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"optional": true,
|
"optional": true,
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@skyvern/client",
|
"name": "@skyvern/client",
|
||||||
"version": "0.2.23",
|
"version": "1.0.0",
|
||||||
"private": false,
|
"private": false,
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
|
|||||||
@@ -30,8 +30,8 @@ export class SkyvernClient {
|
|||||||
"x-api-key": _options?.apiKey,
|
"x-api-key": _options?.apiKey,
|
||||||
"X-Fern-Language": "JavaScript",
|
"X-Fern-Language": "JavaScript",
|
||||||
"X-Fern-SDK-Name": "@skyvern/client",
|
"X-Fern-SDK-Name": "@skyvern/client",
|
||||||
"X-Fern-SDK-Version": "0.2.23",
|
"X-Fern-SDK-Version": "1.0.0",
|
||||||
"User-Agent": "@skyvern/client/0.2.23",
|
"User-Agent": "@skyvern/client/1.0.0",
|
||||||
"X-Fern-Runtime": core.RUNTIME.type,
|
"X-Fern-Runtime": core.RUNTIME.type,
|
||||||
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
"X-Fern-Runtime-Version": core.RUNTIME.version,
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
export const SDK_VERSION = "0.2.23";
|
export const SDK_VERSION = "1.0.0";
|
||||||
|
|||||||
@@ -100,11 +100,8 @@ class BrowserProfilesClient:
|
|||||||
client = Skyvern(
|
client = Skyvern(
|
||||||
api_key="YOUR_API_KEY",
|
api_key="YOUR_API_KEY",
|
||||||
)
|
)
|
||||||
session = client.browser_sessions.create_browser_session()
|
|
||||||
client.browser_sessions.close_browser_session(session.browser_session_id)
|
|
||||||
client.browser_profiles.create_browser_profile(
|
client.browser_profiles.create_browser_profile(
|
||||||
name="name",
|
name="name",
|
||||||
browser_session_id=session.browser_session_id,
|
|
||||||
)
|
)
|
||||||
"""
|
"""
|
||||||
_response = self._raw_client.create_browser_profile(
|
_response = self._raw_client.create_browser_profile(
|
||||||
|
|||||||
@@ -22,10 +22,10 @@ class BaseClientWrapper:
|
|||||||
|
|
||||||
def get_headers(self) -> typing.Dict[str, str]:
|
def get_headers(self) -> typing.Dict[str, str]:
|
||||||
headers: typing.Dict[str, str] = {
|
headers: typing.Dict[str, str] = {
|
||||||
"User-Agent": "skyvern/0.2.23",
|
"User-Agent": "skyvern/1.0.0",
|
||||||
"X-Fern-Language": "Python",
|
"X-Fern-Language": "Python",
|
||||||
"X-Fern-SDK-Name": "skyvern",
|
"X-Fern-SDK-Name": "skyvern",
|
||||||
"X-Fern-SDK-Version": "0.2.23",
|
"X-Fern-SDK-Version": "1.0.0",
|
||||||
**(self.get_custom_headers() or {}),
|
**(self.get_custom_headers() or {}),
|
||||||
}
|
}
|
||||||
if self._api_key is not None:
|
if self._api_key is not None:
|
||||||
|
|||||||
Reference in New Issue
Block a user