@skyvern/client 0.2.21 → 0.2.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/cjs/Client.d.ts +24 -2
- package/dist/cjs/Client.js +115 -31
- package/dist/cjs/api/client/requests/GetWorkflowsRequest.d.ts +6 -1
- package/dist/cjs/api/client/requests/RunSdkActionRequest.d.ts +22 -0
- package/dist/cjs/api/client/requests/RunSdkActionRequest.js +3 -0
- package/dist/cjs/api/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/index.js +6 -1
- package/dist/cjs/api/resources/scripts/client/Client.js +1 -1
- package/dist/cjs/api/resources/workflows/client/Client.d.ts +108 -0
- package/dist/cjs/api/resources/workflows/client/Client.js +465 -0
- package/dist/cjs/api/resources/workflows/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/workflows/client/index.js +17 -0
- package/dist/cjs/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.d.ts +10 -0
- package/dist/cjs/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/FolderCreate.d.ts +12 -0
- package/dist/cjs/api/resources/workflows/client/requests/FolderCreate.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/FolderUpdate.d.ts +10 -0
- package/dist/cjs/api/resources/workflows/client/requests/FolderUpdate.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.d.ts +16 -0
- package/dist/cjs/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.d.ts +8 -0
- package/dist/cjs/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.js +3 -0
- package/dist/cjs/api/resources/workflows/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/resources/workflows/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/workflows/index.d.ts +1 -0
- package/dist/cjs/api/resources/workflows/index.js +17 -0
- package/dist/cjs/api/types/ActAction.d.ts +15 -0
- package/dist/cjs/api/types/ActAction.js +3 -0
- package/dist/cjs/api/types/Action.d.ts +1 -0
- package/dist/cjs/api/types/ClickAction.d.ts +19 -0
- package/dist/cjs/api/types/ClickAction.js +3 -0
- package/dist/cjs/api/types/ClickContext.d.ts +4 -0
- package/dist/cjs/api/types/ClickContext.js +3 -0
- package/dist/cjs/api/types/ExtractAction.d.ts +25 -0
- package/dist/cjs/api/types/ExtractAction.js +3 -0
- package/dist/cjs/api/types/Folder.d.ts +15 -0
- package/dist/cjs/api/types/Folder.js +3 -0
- package/dist/cjs/api/types/InputTextAction.d.ts +25 -0
- package/dist/cjs/api/types/InputTextAction.js +3 -0
- package/dist/cjs/api/types/RunSdkActionRequestAction.d.ts +22 -0
- package/dist/cjs/api/types/RunSdkActionRequestAction.js +3 -0
- package/dist/cjs/api/types/RunSdkActionResponse.d.ts +9 -0
- package/dist/cjs/api/types/RunSdkActionResponse.js +3 -0
- package/dist/cjs/api/types/SelectOptionAction.d.ts +21 -0
- package/dist/cjs/api/types/SelectOptionAction.js +3 -0
- package/dist/cjs/api/types/Workflow.d.ts +2 -0
- package/dist/cjs/api/types/WorkflowStatus.d.ts +2 -0
- package/dist/cjs/api/types/WorkflowStatus.js +2 -0
- package/dist/cjs/api/types/index.d.ts +9 -0
- package/dist/cjs/api/types/index.js +9 -0
- package/dist/cjs/environments.d.ts +3 -3
- package/dist/cjs/environments.js +2 -2
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +24 -2
- package/dist/esm/Client.mjs +115 -31
- package/dist/esm/api/client/requests/GetWorkflowsRequest.d.mts +6 -1
- package/dist/esm/api/client/requests/RunSdkActionRequest.d.mts +22 -0
- package/dist/esm/api/client/requests/RunSdkActionRequest.mjs +2 -0
- package/dist/esm/api/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/index.mjs +2 -0
- package/dist/esm/api/resources/scripts/client/Client.mjs +1 -1
- package/dist/esm/api/resources/workflows/client/Client.d.mts +108 -0
- package/dist/esm/api/resources/workflows/client/Client.mjs +428 -0
- package/dist/esm/api/resources/workflows/client/index.d.mts +1 -0
- package/dist/esm/api/resources/workflows/client/index.mjs +1 -0
- package/dist/esm/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.d.mts +10 -0
- package/dist/esm/api/resources/workflows/client/requests/DeleteFolderV1FoldersFolderIdDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/FolderCreate.d.mts +12 -0
- package/dist/esm/api/resources/workflows/client/requests/FolderCreate.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/FolderUpdate.d.mts +10 -0
- package/dist/esm/api/resources/workflows/client/requests/FolderUpdate.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.d.mts +16 -0
- package/dist/esm/api/resources/workflows/client/requests/GetFoldersV1FoldersGetRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.d.mts +8 -0
- package/dist/esm/api/resources/workflows/client/requests/UpdateWorkflowFolderRequest.mjs +2 -0
- package/dist/esm/api/resources/workflows/client/requests/index.d.mts +5 -0
- package/dist/esm/api/resources/workflows/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/workflows/index.d.mts +1 -0
- package/dist/esm/api/resources/workflows/index.mjs +1 -0
- package/dist/esm/api/types/ActAction.d.mts +15 -0
- package/dist/esm/api/types/ActAction.mjs +2 -0
- package/dist/esm/api/types/Action.d.mts +1 -0
- package/dist/esm/api/types/ClickAction.d.mts +19 -0
- package/dist/esm/api/types/ClickAction.mjs +2 -0
- package/dist/esm/api/types/ClickContext.d.mts +4 -0
- package/dist/esm/api/types/ClickContext.mjs +2 -0
- package/dist/esm/api/types/ExtractAction.d.mts +25 -0
- package/dist/esm/api/types/ExtractAction.mjs +2 -0
- package/dist/esm/api/types/Folder.d.mts +15 -0
- package/dist/esm/api/types/Folder.mjs +2 -0
- package/dist/esm/api/types/InputTextAction.d.mts +25 -0
- package/dist/esm/api/types/InputTextAction.mjs +2 -0
- package/dist/esm/api/types/RunSdkActionRequestAction.d.mts +22 -0
- package/dist/esm/api/types/RunSdkActionRequestAction.mjs +2 -0
- package/dist/esm/api/types/RunSdkActionResponse.d.mts +9 -0
- package/dist/esm/api/types/RunSdkActionResponse.mjs +2 -0
- package/dist/esm/api/types/SelectOptionAction.d.mts +21 -0
- package/dist/esm/api/types/SelectOptionAction.mjs +2 -0
- package/dist/esm/api/types/Workflow.d.mts +2 -0
- package/dist/esm/api/types/WorkflowStatus.d.mts +2 -0
- package/dist/esm/api/types/WorkflowStatus.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +9 -0
- package/dist/esm/api/types/index.mjs +9 -0
- package/dist/esm/environments.d.mts +3 -3
- package/dist/esm/environments.mjs +2 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +6 -2
- package/reference.md +414 -11
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Input text action parameters.
|
|
3
|
+
*/
|
|
4
|
+
export interface InputTextAction {
|
|
5
|
+
/** CSS selector for the element */
|
|
6
|
+
selector?: string;
|
|
7
|
+
/** Value to input */
|
|
8
|
+
value?: string;
|
|
9
|
+
/** The intention or goal of the input */
|
|
10
|
+
intention?: string;
|
|
11
|
+
/** Additional context data */
|
|
12
|
+
data?: InputTextAction.Data;
|
|
13
|
+
/** TOTP identifier for input_text actions */
|
|
14
|
+
totp_identifier?: string;
|
|
15
|
+
/** TOTP URL for input_text actions */
|
|
16
|
+
totp_url?: string;
|
|
17
|
+
/** Timeout in milliseconds */
|
|
18
|
+
timeout?: number;
|
|
19
|
+
}
|
|
20
|
+
export declare namespace InputTextAction {
|
|
21
|
+
/**
|
|
22
|
+
* Additional context data
|
|
23
|
+
*/
|
|
24
|
+
type Data = string | Record<string, unknown>;
|
|
25
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import type * as Skyvern from "../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* The action to execute with its specific parameters
|
|
4
|
+
*/
|
|
5
|
+
export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.Extract;
|
|
6
|
+
export declare namespace RunSdkActionRequestAction {
|
|
7
|
+
interface AiAct extends Skyvern.ActAction {
|
|
8
|
+
type: "ai_act";
|
|
9
|
+
}
|
|
10
|
+
interface AiClick extends Skyvern.ClickAction {
|
|
11
|
+
type: "ai_click";
|
|
12
|
+
}
|
|
13
|
+
interface AiInputText extends Skyvern.InputTextAction {
|
|
14
|
+
type: "ai_input_text";
|
|
15
|
+
}
|
|
16
|
+
interface AiSelectOption extends Skyvern.SelectOptionAction {
|
|
17
|
+
type: "ai_select_option";
|
|
18
|
+
}
|
|
19
|
+
interface Extract extends Skyvern.ExtractAction {
|
|
20
|
+
type: "extract";
|
|
21
|
+
}
|
|
22
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Response from running an SDK action.
|
|
3
|
+
*/
|
|
4
|
+
export interface RunSdkActionResponse {
|
|
5
|
+
/** The workflow run ID used for this action */
|
|
6
|
+
workflow_run_id: string;
|
|
7
|
+
/** The result from the action (e.g., selector, value, extracted data) */
|
|
8
|
+
result?: unknown;
|
|
9
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Select option action parameters.
|
|
3
|
+
*/
|
|
4
|
+
export interface SelectOptionAction {
|
|
5
|
+
/** CSS selector for the element */
|
|
6
|
+
selector?: string;
|
|
7
|
+
/** Value to select */
|
|
8
|
+
value?: string;
|
|
9
|
+
/** The intention or goal of the selection */
|
|
10
|
+
intention?: string;
|
|
11
|
+
/** Additional context data */
|
|
12
|
+
data?: SelectOptionAction.Data;
|
|
13
|
+
/** Timeout in milliseconds */
|
|
14
|
+
timeout?: number;
|
|
15
|
+
}
|
|
16
|
+
export declare namespace SelectOptionAction {
|
|
17
|
+
/**
|
|
18
|
+
* Additional context data
|
|
19
|
+
*/
|
|
20
|
+
type Data = string | Record<string, unknown>;
|
|
21
|
+
}
|
|
@@ -2,5 +2,7 @@ export declare const WorkflowStatus: {
|
|
|
2
2
|
readonly Published: "published";
|
|
3
3
|
readonly Draft: "draft";
|
|
4
4
|
readonly AutoGenerated: "auto_generated";
|
|
5
|
+
readonly Importing: "importing";
|
|
6
|
+
readonly ImportFailed: "import_failed";
|
|
5
7
|
};
|
|
6
8
|
export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from "./ActAction.mjs";
|
|
1
2
|
export * from "./Action.mjs";
|
|
2
3
|
export * from "./ActionBlock.mjs";
|
|
3
4
|
export * from "./ActionBlockParametersItem.mjs";
|
|
@@ -19,6 +20,8 @@ export * from "./BitwardenSensitiveInformationParameter.mjs";
|
|
|
19
20
|
export * from "./BitwardenSensitiveInformationParameterYaml.mjs";
|
|
20
21
|
export * from "./BlockType.mjs";
|
|
21
22
|
export * from "./BrowserSessionResponse.mjs";
|
|
23
|
+
export * from "./ClickAction.mjs";
|
|
24
|
+
export * from "./ClickContext.mjs";
|
|
22
25
|
export * from "./CodeBlock.mjs";
|
|
23
26
|
export * from "./CodeBlockParametersItem.mjs";
|
|
24
27
|
export * from "./CodeBlockYaml.mjs";
|
|
@@ -33,6 +36,7 @@ export * from "./CredentialTypeOutput.mjs";
|
|
|
33
36
|
export * from "./CreditCardCredentialResponse.mjs";
|
|
34
37
|
export * from "./DownloadToS3Block.mjs";
|
|
35
38
|
export * from "./DownloadToS3BlockYaml.mjs";
|
|
39
|
+
export * from "./ExtractAction.mjs";
|
|
36
40
|
export * from "./ExtractionBlock.mjs";
|
|
37
41
|
export * from "./ExtractionBlockParametersItem.mjs";
|
|
38
42
|
export * from "./ExtractionBlockYaml.mjs";
|
|
@@ -48,6 +52,7 @@ export * from "./FileStorageType.mjs";
|
|
|
48
52
|
export * from "./FileType.mjs";
|
|
49
53
|
export * from "./FileUploadBlock.mjs";
|
|
50
54
|
export * from "./FileUploadBlockYaml.mjs";
|
|
55
|
+
export * from "./Folder.mjs";
|
|
51
56
|
export * from "./ForLoopBlock.mjs";
|
|
52
57
|
export * from "./ForLoopBlockLoopBlocksItem.mjs";
|
|
53
58
|
export * from "./ForLoopBlockLoopOver.mjs";
|
|
@@ -62,6 +67,7 @@ export * from "./HumanInteractionBlock.mjs";
|
|
|
62
67
|
export * from "./HumanInteractionBlockParametersItem.mjs";
|
|
63
68
|
export * from "./HumanInteractionBlockYaml.mjs";
|
|
64
69
|
export * from "./InputOrSelectContext.mjs";
|
|
70
|
+
export * from "./InputTextAction.mjs";
|
|
65
71
|
export * from "./LoginBlock.mjs";
|
|
66
72
|
export * from "./LoginBlockParametersItem.mjs";
|
|
67
73
|
export * from "./LoginBlockYaml.mjs";
|
|
@@ -80,11 +86,14 @@ export * from "./PdfParserBlock.mjs";
|
|
|
80
86
|
export * from "./PdfParserBlockYaml.mjs";
|
|
81
87
|
export * from "./ProxyLocation.mjs";
|
|
82
88
|
export * from "./RunEngine.mjs";
|
|
89
|
+
export * from "./RunSdkActionRequestAction.mjs";
|
|
90
|
+
export * from "./RunSdkActionResponse.mjs";
|
|
83
91
|
export * from "./RunStatus.mjs";
|
|
84
92
|
export * from "./Script.mjs";
|
|
85
93
|
export * from "./ScriptFileCreate.mjs";
|
|
86
94
|
export * from "./ScriptRunResponse.mjs";
|
|
87
95
|
export * from "./SelectOption.mjs";
|
|
96
|
+
export * from "./SelectOptionAction.mjs";
|
|
88
97
|
export * from "./SendEmailBlock.mjs";
|
|
89
98
|
export * from "./SendEmailBlockYaml.mjs";
|
|
90
99
|
export * from "./SkyvernForgeSdkSchemasCredentialsCredentialType.mjs";
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from "./ActAction.mjs";
|
|
1
2
|
export * from "./Action.mjs";
|
|
2
3
|
export * from "./ActionBlock.mjs";
|
|
3
4
|
export * from "./ActionBlockParametersItem.mjs";
|
|
@@ -19,6 +20,8 @@ export * from "./BitwardenSensitiveInformationParameter.mjs";
|
|
|
19
20
|
export * from "./BitwardenSensitiveInformationParameterYaml.mjs";
|
|
20
21
|
export * from "./BlockType.mjs";
|
|
21
22
|
export * from "./BrowserSessionResponse.mjs";
|
|
23
|
+
export * from "./ClickAction.mjs";
|
|
24
|
+
export * from "./ClickContext.mjs";
|
|
22
25
|
export * from "./CodeBlock.mjs";
|
|
23
26
|
export * from "./CodeBlockParametersItem.mjs";
|
|
24
27
|
export * from "./CodeBlockYaml.mjs";
|
|
@@ -33,6 +36,7 @@ export * from "./CredentialTypeOutput.mjs";
|
|
|
33
36
|
export * from "./CreditCardCredentialResponse.mjs";
|
|
34
37
|
export * from "./DownloadToS3Block.mjs";
|
|
35
38
|
export * from "./DownloadToS3BlockYaml.mjs";
|
|
39
|
+
export * from "./ExtractAction.mjs";
|
|
36
40
|
export * from "./ExtractionBlock.mjs";
|
|
37
41
|
export * from "./ExtractionBlockParametersItem.mjs";
|
|
38
42
|
export * from "./ExtractionBlockYaml.mjs";
|
|
@@ -48,6 +52,7 @@ export * from "./FileStorageType.mjs";
|
|
|
48
52
|
export * from "./FileType.mjs";
|
|
49
53
|
export * from "./FileUploadBlock.mjs";
|
|
50
54
|
export * from "./FileUploadBlockYaml.mjs";
|
|
55
|
+
export * from "./Folder.mjs";
|
|
51
56
|
export * from "./ForLoopBlock.mjs";
|
|
52
57
|
export * from "./ForLoopBlockLoopBlocksItem.mjs";
|
|
53
58
|
export * from "./ForLoopBlockLoopOver.mjs";
|
|
@@ -62,6 +67,7 @@ export * from "./HumanInteractionBlock.mjs";
|
|
|
62
67
|
export * from "./HumanInteractionBlockParametersItem.mjs";
|
|
63
68
|
export * from "./HumanInteractionBlockYaml.mjs";
|
|
64
69
|
export * from "./InputOrSelectContext.mjs";
|
|
70
|
+
export * from "./InputTextAction.mjs";
|
|
65
71
|
export * from "./LoginBlock.mjs";
|
|
66
72
|
export * from "./LoginBlockParametersItem.mjs";
|
|
67
73
|
export * from "./LoginBlockYaml.mjs";
|
|
@@ -80,11 +86,14 @@ export * from "./PdfParserBlock.mjs";
|
|
|
80
86
|
export * from "./PdfParserBlockYaml.mjs";
|
|
81
87
|
export * from "./ProxyLocation.mjs";
|
|
82
88
|
export * from "./RunEngine.mjs";
|
|
89
|
+
export * from "./RunSdkActionRequestAction.mjs";
|
|
90
|
+
export * from "./RunSdkActionResponse.mjs";
|
|
83
91
|
export * from "./RunStatus.mjs";
|
|
84
92
|
export * from "./Script.mjs";
|
|
85
93
|
export * from "./ScriptFileCreate.mjs";
|
|
86
94
|
export * from "./ScriptRunResponse.mjs";
|
|
87
95
|
export * from "./SelectOption.mjs";
|
|
96
|
+
export * from "./SelectOptionAction.mjs";
|
|
88
97
|
export * from "./SendEmailBlock.mjs";
|
|
89
98
|
export * from "./SendEmailBlockYaml.mjs";
|
|
90
99
|
export * from "./SkyvernForgeSdkSchemasCredentialsCredentialType.mjs";
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export declare const SkyvernEnvironment: {
|
|
2
|
-
readonly
|
|
2
|
+
readonly Cloud: "https://api.skyvern.com";
|
|
3
3
|
readonly Staging: "https://api-staging.skyvern.com";
|
|
4
|
-
readonly
|
|
4
|
+
readonly Local: "http://localhost:8000";
|
|
5
5
|
};
|
|
6
|
-
export type SkyvernEnvironment = typeof SkyvernEnvironment.
|
|
6
|
+
export type SkyvernEnvironment = typeof SkyvernEnvironment.Cloud | typeof SkyvernEnvironment.Staging | typeof SkyvernEnvironment.Local;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// This file was auto-generated by Fern from our API Definition.
|
|
2
2
|
export const SkyvernEnvironment = {
|
|
3
|
-
|
|
3
|
+
Cloud: "https://api.skyvern.com",
|
|
4
4
|
Staging: "https://api-staging.skyvern.com",
|
|
5
|
-
|
|
5
|
+
Local: "http://localhost:8000",
|
|
6
6
|
};
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.2.
|
|
1
|
+
export declare const SDK_VERSION = "0.2.22";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.2.
|
|
1
|
+
export const SDK_VERSION = "0.2.22";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyvern/client",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.22",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": "github:Skyvern-AI/skyvern",
|
|
6
6
|
"type": "commonjs",
|
|
@@ -61,5 +61,9 @@
|
|
|
61
61
|
"engines": {
|
|
62
62
|
"node": ">=18.0.0"
|
|
63
63
|
},
|
|
64
|
-
"sideEffects": false
|
|
64
|
+
"sideEffects": false,
|
|
65
|
+
"description": "The Skyvern TypeScript library provides convenient access to the Skyvern APIs from TypeScript.",
|
|
66
|
+
"publishConfig": {
|
|
67
|
+
"access": "public"
|
|
68
|
+
}
|
|
65
69
|
}
|