@skyvern/client 1.0.22 → 1.0.24
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/dist/cjs/Client.d.ts +96 -13
- package/dist/cjs/Client.js +413 -61
- package/dist/cjs/api/client/requests/CreateBrowserSessionRequest.d.ts +9 -0
- package/dist/cjs/api/client/requests/DeleteFolderRequest.d.ts +10 -0
- package/dist/cjs/api/client/requests/FolderCreate.d.ts +12 -0
- package/dist/cjs/api/client/requests/FolderCreate.js +3 -0
- package/dist/cjs/api/client/requests/FolderUpdate.d.ts +10 -0
- package/dist/cjs/api/client/requests/FolderUpdate.js +3 -0
- package/dist/cjs/api/client/requests/GetFoldersRequest.d.ts +16 -0
- package/dist/cjs/api/client/requests/GetFoldersRequest.js +3 -0
- package/dist/cjs/api/client/requests/UpdateWorkflowFolderRequest.d.ts +8 -0
- package/dist/cjs/api/client/requests/UpdateWorkflowFolderRequest.js +3 -0
- package/dist/cjs/api/client/requests/index.d.ts +5 -0
- package/dist/cjs/api/types/BlockType.d.ts +1 -0
- package/dist/cjs/api/types/BlockType.js +1 -0
- package/dist/cjs/api/types/BrowserSessionResponse.d.ts +2 -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/ForLoopBlockLoopBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/ForLoopBlockYamlLoopBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/ProxyLocation.d.ts +1 -0
- package/dist/cjs/api/types/ProxyLocation.js +1 -0
- package/dist/cjs/api/types/TaskRunRequest.d.ts +14 -0
- package/dist/cjs/api/types/Workflow.d.ts +2 -0
- package/dist/cjs/api/types/WorkflowCreateYamlRequest.d.ts +2 -0
- package/dist/cjs/api/types/WorkflowDefinitionBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/WorkflowDefinitionYamlBlocksItem.d.ts +4 -1
- package/dist/cjs/api/types/WorkflowRun.d.ts +0 -3
- package/dist/cjs/api/types/WorkflowRunRequest.d.ts +15 -1
- package/dist/cjs/api/types/WorkflowRunResponse.d.ts +1 -1
- package/dist/cjs/api/types/WorkflowTriggerBlock.d.ts +18 -0
- package/dist/cjs/api/types/WorkflowTriggerBlock.js +3 -0
- package/dist/cjs/api/types/WorkflowTriggerBlockParametersItem.d.ts +37 -0
- package/dist/cjs/api/types/WorkflowTriggerBlockParametersItem.js +3 -0
- package/dist/cjs/api/types/WorkflowTriggerBlockYaml.d.ts +15 -0
- package/dist/cjs/api/types/WorkflowTriggerBlockYaml.js +3 -0
- package/dist/cjs/api/types/index.d.ts +4 -1
- package/dist/cjs/api/types/index.js +4 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.d.mts +96 -13
- package/dist/esm/Client.mjs +413 -61
- package/dist/esm/api/client/requests/CreateBrowserSessionRequest.d.mts +9 -0
- package/dist/esm/api/client/requests/DeleteFolderRequest.d.mts +10 -0
- package/dist/esm/api/client/requests/FolderCreate.d.mts +12 -0
- package/dist/esm/api/client/requests/FolderCreate.mjs +2 -0
- package/dist/esm/api/client/requests/FolderUpdate.d.mts +10 -0
- package/dist/esm/api/client/requests/FolderUpdate.mjs +2 -0
- package/dist/esm/api/client/requests/GetFoldersRequest.d.mts +16 -0
- package/dist/esm/api/client/requests/GetFoldersRequest.mjs +2 -0
- package/dist/esm/api/client/requests/UpdateWorkflowFolderRequest.d.mts +8 -0
- package/dist/esm/api/client/requests/UpdateWorkflowFolderRequest.mjs +2 -0
- package/dist/esm/api/client/requests/index.d.mts +5 -0
- package/dist/esm/api/types/BlockType.d.mts +1 -0
- package/dist/esm/api/types/BlockType.mjs +1 -0
- package/dist/esm/api/types/BrowserSessionResponse.d.mts +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/ForLoopBlockLoopBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/ForLoopBlockYamlLoopBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/ProxyLocation.d.mts +1 -0
- package/dist/esm/api/types/ProxyLocation.mjs +1 -0
- package/dist/esm/api/types/TaskRunRequest.d.mts +14 -0
- package/dist/esm/api/types/Workflow.d.mts +2 -0
- package/dist/esm/api/types/WorkflowCreateYamlRequest.d.mts +2 -0
- package/dist/esm/api/types/WorkflowDefinitionBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/WorkflowDefinitionYamlBlocksItem.d.mts +4 -1
- package/dist/esm/api/types/WorkflowRun.d.mts +0 -3
- package/dist/esm/api/types/WorkflowRunRequest.d.mts +15 -1
- package/dist/esm/api/types/WorkflowRunResponse.d.mts +1 -1
- package/dist/esm/api/types/WorkflowTriggerBlock.d.mts +18 -0
- package/dist/esm/api/types/WorkflowTriggerBlock.mjs +2 -0
- package/dist/esm/api/types/WorkflowTriggerBlockParametersItem.d.mts +37 -0
- package/dist/esm/api/types/WorkflowTriggerBlockParametersItem.mjs +2 -0
- package/dist/esm/api/types/WorkflowTriggerBlockYaml.d.mts +15 -0
- package/dist/esm/api/types/WorkflowTriggerBlockYaml.mjs +2 -0
- package/dist/esm/api/types/index.d.mts +4 -1
- package/dist/esm/api/types/index.mjs +4 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +12 -9
- package/dist/cjs/api/types/ClearCacheResponse.d.ts +0 -9
- package/dist/esm/api/types/ClearCacheResponse.d.mts +0 -9
- /package/dist/cjs/api/{types/ClearCacheResponse.js → client/requests/DeleteFolderRequest.js} +0 -0
- /package/dist/esm/api/{types/ClearCacheResponse.mjs → client/requests/DeleteFolderRequest.mjs} +0 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @example
|
|
3
|
+
* {
|
|
4
|
+
* page: 1,
|
|
5
|
+
* page_size: 1,
|
|
6
|
+
* search: "search"
|
|
7
|
+
* }
|
|
8
|
+
*/
|
|
9
|
+
export interface GetFoldersRequest {
|
|
10
|
+
/** Page number */
|
|
11
|
+
page?: number;
|
|
12
|
+
/** Number of folders per page */
|
|
13
|
+
page_size?: number;
|
|
14
|
+
/** Search folders by title or description */
|
|
15
|
+
search?: string;
|
|
16
|
+
}
|
|
@@ -5,9 +5,13 @@ export type { CreateBrowserProfileRequest } from "./CreateBrowserProfileRequest.
|
|
|
5
5
|
export type { CreateBrowserSessionRequest } from "./CreateBrowserSessionRequest.js";
|
|
6
6
|
export type { CreateScriptRequest } from "./CreateScriptRequest.js";
|
|
7
7
|
export type { CreateWorkflowRequest } from "./CreateWorkflowRequest.js";
|
|
8
|
+
export type { DeleteFolderRequest } from "./DeleteFolderRequest.js";
|
|
8
9
|
export type { DeployScriptRequest } from "./DeployScriptRequest.js";
|
|
9
10
|
export type { DownloadFilesRequest } from "./DownloadFilesRequest.js";
|
|
11
|
+
export type { FolderCreate } from "./FolderCreate.js";
|
|
12
|
+
export type { FolderUpdate } from "./FolderUpdate.js";
|
|
10
13
|
export type { GetCredentialsRequest } from "./GetCredentialsRequest.js";
|
|
14
|
+
export type { GetFoldersRequest } from "./GetFoldersRequest.js";
|
|
11
15
|
export type { GetRunArtifactsRequest } from "./GetRunArtifactsRequest.js";
|
|
12
16
|
export type { GetScriptsRequest } from "./GetScriptsRequest.js";
|
|
13
17
|
export type { GetWorkflowRequest } from "./GetWorkflowRequest.js";
|
|
@@ -20,3 +24,4 @@ export type { RunSdkActionRequest } from "./RunSdkActionRequest.js";
|
|
|
20
24
|
export type { RunTaskRequest } from "./RunTaskRequest.js";
|
|
21
25
|
export type { RunWorkflowRequest } from "./RunWorkflowRequest.js";
|
|
22
26
|
export type { TotpCodeCreate } from "./TotpCodeCreate.js";
|
|
27
|
+
export type { UpdateWorkflowFolderRequest } from "./UpdateWorkflowFolderRequest.js";
|
|
@@ -22,5 +22,6 @@ export declare const BlockType: {
|
|
|
22
22
|
readonly HttpRequest: "http_request";
|
|
23
23
|
readonly HumanInteraction: "human_interaction";
|
|
24
24
|
readonly PrintPage: "print_page";
|
|
25
|
+
readonly WorkflowTrigger: "workflow_trigger";
|
|
25
26
|
};
|
|
26
27
|
export type BlockType = (typeof BlockType)[keyof typeof BlockType];
|
|
@@ -23,6 +23,8 @@ export interface BrowserSessionResponse {
|
|
|
23
23
|
extensions?: Skyvern.Extensions[];
|
|
24
24
|
/** The type of browser used for the session. */
|
|
25
25
|
browser_type?: Skyvern.PersistentBrowserType;
|
|
26
|
+
/** ID of the browser profile loaded into this session, if any. browser_profile_id starts with `bp_`. */
|
|
27
|
+
browser_profile_id?: string;
|
|
26
28
|
/** Whether the browser session supports VNC streaming */
|
|
27
29
|
vnc_streaming_supported?: boolean;
|
|
28
30
|
/** The path where the browser session downloads files */
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Response model for a folder
|
|
3
|
+
*/
|
|
4
|
+
export interface Folder {
|
|
5
|
+
/** Folder title */
|
|
6
|
+
title: string;
|
|
7
|
+
/** Folder description */
|
|
8
|
+
description?: string;
|
|
9
|
+
folder_id: string;
|
|
10
|
+
organization_id: string;
|
|
11
|
+
/** Number of workflows in this folder */
|
|
12
|
+
workflow_count?: number;
|
|
13
|
+
created_at: string;
|
|
14
|
+
modified_at: string;
|
|
15
|
+
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Skyvern from "../index.js";
|
|
2
|
-
export type ForLoopBlockLoopBlocksItem = Skyvern.ForLoopBlockLoopBlocksItem.Action | Skyvern.ForLoopBlockLoopBlocksItem.Code | Skyvern.ForLoopBlockLoopBlocksItem.Conditional | 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.HumanInteraction | Skyvern.ForLoopBlockLoopBlocksItem.Login | Skyvern.ForLoopBlockLoopBlocksItem.Navigation | Skyvern.ForLoopBlockLoopBlocksItem.PdfParser | Skyvern.ForLoopBlockLoopBlocksItem.PrintPage | Skyvern.ForLoopBlockLoopBlocksItem.SendEmail | Skyvern.ForLoopBlockLoopBlocksItem.Task | Skyvern.ForLoopBlockLoopBlocksItem.TaskV2 | Skyvern.ForLoopBlockLoopBlocksItem.TextPrompt | Skyvern.ForLoopBlockLoopBlocksItem.UploadToS3 | Skyvern.ForLoopBlockLoopBlocksItem.Validation | Skyvern.ForLoopBlockLoopBlocksItem.Wait;
|
|
2
|
+
export type ForLoopBlockLoopBlocksItem = Skyvern.ForLoopBlockLoopBlocksItem.Action | Skyvern.ForLoopBlockLoopBlocksItem.Code | Skyvern.ForLoopBlockLoopBlocksItem.Conditional | 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.HumanInteraction | Skyvern.ForLoopBlockLoopBlocksItem.Login | Skyvern.ForLoopBlockLoopBlocksItem.Navigation | Skyvern.ForLoopBlockLoopBlocksItem.PdfParser | Skyvern.ForLoopBlockLoopBlocksItem.PrintPage | Skyvern.ForLoopBlockLoopBlocksItem.SendEmail | Skyvern.ForLoopBlockLoopBlocksItem.Task | Skyvern.ForLoopBlockLoopBlocksItem.TaskV2 | Skyvern.ForLoopBlockLoopBlocksItem.TextPrompt | Skyvern.ForLoopBlockLoopBlocksItem.UploadToS3 | Skyvern.ForLoopBlockLoopBlocksItem.Validation | Skyvern.ForLoopBlockLoopBlocksItem.Wait | Skyvern.ForLoopBlockLoopBlocksItem.WorkflowTrigger;
|
|
3
3
|
export declare namespace ForLoopBlockLoopBlocksItem {
|
|
4
4
|
interface Action extends Skyvern.ActionBlock {
|
|
5
5
|
block_type: "action";
|
|
@@ -70,4 +70,7 @@ export declare namespace ForLoopBlockLoopBlocksItem {
|
|
|
70
70
|
interface Wait extends Skyvern.WaitBlock {
|
|
71
71
|
block_type: "wait";
|
|
72
72
|
}
|
|
73
|
+
interface WorkflowTrigger extends Skyvern.WorkflowTriggerBlock {
|
|
74
|
+
block_type: "workflow_trigger";
|
|
75
|
+
}
|
|
73
76
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Skyvern from "../index.js";
|
|
2
|
-
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.HumanInteraction | Skyvern.ForLoopBlockYamlLoopBlocksItem.FileDownload | Skyvern.ForLoopBlockYamlLoopBlocksItem.GotoUrl | Skyvern.ForLoopBlockYamlLoopBlocksItem.PdfParser | Skyvern.ForLoopBlockYamlLoopBlocksItem.TaskV2 | Skyvern.ForLoopBlockYamlLoopBlocksItem.HttpRequest | Skyvern.ForLoopBlockYamlLoopBlocksItem.Conditional | Skyvern.ForLoopBlockYamlLoopBlocksItem.PrintPage;
|
|
2
|
+
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.HumanInteraction | Skyvern.ForLoopBlockYamlLoopBlocksItem.FileDownload | Skyvern.ForLoopBlockYamlLoopBlocksItem.GotoUrl | Skyvern.ForLoopBlockYamlLoopBlocksItem.PdfParser | Skyvern.ForLoopBlockYamlLoopBlocksItem.TaskV2 | Skyvern.ForLoopBlockYamlLoopBlocksItem.HttpRequest | Skyvern.ForLoopBlockYamlLoopBlocksItem.Conditional | Skyvern.ForLoopBlockYamlLoopBlocksItem.PrintPage | Skyvern.ForLoopBlockYamlLoopBlocksItem.WorkflowTrigger;
|
|
3
3
|
export declare namespace ForLoopBlockYamlLoopBlocksItem {
|
|
4
4
|
interface Task extends Skyvern.TaskBlockYaml {
|
|
5
5
|
block_type: "task";
|
|
@@ -70,4 +70,7 @@ export declare namespace ForLoopBlockYamlLoopBlocksItem {
|
|
|
70
70
|
interface PrintPage extends Skyvern.PrintPageBlockYaml {
|
|
71
71
|
block_type: "print_page";
|
|
72
72
|
}
|
|
73
|
+
interface WorkflowTrigger extends Skyvern.WorkflowTriggerBlockYaml {
|
|
74
|
+
block_type: "workflow_trigger";
|
|
75
|
+
}
|
|
73
76
|
}
|
|
@@ -23,6 +23,7 @@ export declare const ProxyLocation: {
|
|
|
23
23
|
readonly ResidentialIt: "RESIDENTIAL_IT";
|
|
24
24
|
readonly ResidentialNl: "RESIDENTIAL_NL";
|
|
25
25
|
readonly ResidentialPh: "RESIDENTIAL_PH";
|
|
26
|
+
readonly ResidentialKr: "RESIDENTIAL_KR";
|
|
26
27
|
readonly ResidentialIsp: "RESIDENTIAL_ISP";
|
|
27
28
|
readonly None: "NONE";
|
|
28
29
|
};
|
|
@@ -28,9 +28,16 @@ export interface TaskRunRequest {
|
|
|
28
28
|
* - RESIDENTIAL_DE: Germany
|
|
29
29
|
* - RESIDENTIAL_NZ: New Zealand
|
|
30
30
|
* - RESIDENTIAL_PH: Philippines
|
|
31
|
+
* - RESIDENTIAL_KR: South Korea
|
|
31
32
|
* - RESIDENTIAL_ZA: South Africa
|
|
32
33
|
* - RESIDENTIAL_AR: Argentina
|
|
33
34
|
* - RESIDENTIAL_AU: Australia
|
|
35
|
+
* - RESIDENTIAL_BR: Brazil
|
|
36
|
+
* - RESIDENTIAL_TR: Turkey
|
|
37
|
+
* - RESIDENTIAL_CA: Canada
|
|
38
|
+
* - RESIDENTIAL_MX: Mexico
|
|
39
|
+
* - RESIDENTIAL_IT: Italy
|
|
40
|
+
* - RESIDENTIAL_NL: Netherlands
|
|
34
41
|
* - RESIDENTIAL_ISP: ISP proxy
|
|
35
42
|
* - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
|
|
36
43
|
* - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
|
|
@@ -102,9 +109,16 @@ export declare namespace TaskRunRequest {
|
|
|
102
109
|
* - RESIDENTIAL_DE: Germany
|
|
103
110
|
* - RESIDENTIAL_NZ: New Zealand
|
|
104
111
|
* - RESIDENTIAL_PH: Philippines
|
|
112
|
+
* - RESIDENTIAL_KR: South Korea
|
|
105
113
|
* - RESIDENTIAL_ZA: South Africa
|
|
106
114
|
* - RESIDENTIAL_AR: Argentina
|
|
107
115
|
* - RESIDENTIAL_AU: Australia
|
|
116
|
+
* - RESIDENTIAL_BR: Brazil
|
|
117
|
+
* - RESIDENTIAL_TR: Turkey
|
|
118
|
+
* - RESIDENTIAL_CA: Canada
|
|
119
|
+
* - RESIDENTIAL_MX: Mexico
|
|
120
|
+
* - RESIDENTIAL_IT: Italy
|
|
121
|
+
* - RESIDENTIAL_NL: Netherlands
|
|
108
122
|
* - RESIDENTIAL_ISP: ISP proxy
|
|
109
123
|
* - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
|
|
110
124
|
* - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
|
|
@@ -16,6 +16,8 @@ export interface WorkflowCreateYamlRequest {
|
|
|
16
16
|
run_with?: string;
|
|
17
17
|
ai_fallback?: boolean;
|
|
18
18
|
cache_key?: string;
|
|
19
|
+
adaptive_caching?: boolean;
|
|
20
|
+
generate_script_on_terminal?: boolean;
|
|
19
21
|
run_sequentially?: boolean;
|
|
20
22
|
sequential_key?: string;
|
|
21
23
|
folder_id?: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Skyvern from "../index.js";
|
|
2
|
-
export type WorkflowDefinitionBlocksItem = Skyvern.WorkflowDefinitionBlocksItem.Action | Skyvern.WorkflowDefinitionBlocksItem.Code | Skyvern.WorkflowDefinitionBlocksItem.Conditional | Skyvern.WorkflowDefinitionBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionBlocksItem.Extraction | Skyvern.WorkflowDefinitionBlocksItem.FileDownload | Skyvern.WorkflowDefinitionBlocksItem.FileUpload | Skyvern.WorkflowDefinitionBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionBlocksItem.ForLoop | Skyvern.WorkflowDefinitionBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionBlocksItem.Login | Skyvern.WorkflowDefinitionBlocksItem.Navigation | Skyvern.WorkflowDefinitionBlocksItem.PdfParser | Skyvern.WorkflowDefinitionBlocksItem.PrintPage | Skyvern.WorkflowDefinitionBlocksItem.SendEmail | Skyvern.WorkflowDefinitionBlocksItem.Task | Skyvern.WorkflowDefinitionBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionBlocksItem.Validation | Skyvern.WorkflowDefinitionBlocksItem.Wait;
|
|
2
|
+
export type WorkflowDefinitionBlocksItem = Skyvern.WorkflowDefinitionBlocksItem.Action | Skyvern.WorkflowDefinitionBlocksItem.Code | Skyvern.WorkflowDefinitionBlocksItem.Conditional | Skyvern.WorkflowDefinitionBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionBlocksItem.Extraction | Skyvern.WorkflowDefinitionBlocksItem.FileDownload | Skyvern.WorkflowDefinitionBlocksItem.FileUpload | Skyvern.WorkflowDefinitionBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionBlocksItem.ForLoop | Skyvern.WorkflowDefinitionBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionBlocksItem.Login | Skyvern.WorkflowDefinitionBlocksItem.Navigation | Skyvern.WorkflowDefinitionBlocksItem.PdfParser | Skyvern.WorkflowDefinitionBlocksItem.PrintPage | Skyvern.WorkflowDefinitionBlocksItem.SendEmail | Skyvern.WorkflowDefinitionBlocksItem.Task | Skyvern.WorkflowDefinitionBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionBlocksItem.Validation | Skyvern.WorkflowDefinitionBlocksItem.Wait | Skyvern.WorkflowDefinitionBlocksItem.WorkflowTrigger;
|
|
3
3
|
export declare namespace WorkflowDefinitionBlocksItem {
|
|
4
4
|
interface Action extends Skyvern.ActionBlock {
|
|
5
5
|
block_type: "action";
|
|
@@ -70,4 +70,7 @@ export declare namespace WorkflowDefinitionBlocksItem {
|
|
|
70
70
|
interface Wait extends Skyvern.WaitBlock {
|
|
71
71
|
block_type: "wait";
|
|
72
72
|
}
|
|
73
|
+
interface WorkflowTrigger extends Skyvern.WorkflowTriggerBlock {
|
|
74
|
+
block_type: "workflow_trigger";
|
|
75
|
+
}
|
|
73
76
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Skyvern from "../index.js";
|
|
2
|
-
export type WorkflowDefinitionYamlBlocksItem = Skyvern.WorkflowDefinitionYamlBlocksItem.Action | Skyvern.WorkflowDefinitionYamlBlocksItem.Code | Skyvern.WorkflowDefinitionYamlBlocksItem.Conditional | Skyvern.WorkflowDefinitionYamlBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Extraction | Skyvern.WorkflowDefinitionYamlBlocksItem.FileDownload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUpload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionYamlBlocksItem.ForLoop | Skyvern.WorkflowDefinitionYamlBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionYamlBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionYamlBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionYamlBlocksItem.Login | Skyvern.WorkflowDefinitionYamlBlocksItem.Navigation | Skyvern.WorkflowDefinitionYamlBlocksItem.PdfParser | Skyvern.WorkflowDefinitionYamlBlocksItem.PrintPage | Skyvern.WorkflowDefinitionYamlBlocksItem.SendEmail | Skyvern.WorkflowDefinitionYamlBlocksItem.Task | Skyvern.WorkflowDefinitionYamlBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionYamlBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionYamlBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Validation | Skyvern.WorkflowDefinitionYamlBlocksItem.Wait;
|
|
2
|
+
export type WorkflowDefinitionYamlBlocksItem = Skyvern.WorkflowDefinitionYamlBlocksItem.Action | Skyvern.WorkflowDefinitionYamlBlocksItem.Code | Skyvern.WorkflowDefinitionYamlBlocksItem.Conditional | Skyvern.WorkflowDefinitionYamlBlocksItem.DownloadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Extraction | Skyvern.WorkflowDefinitionYamlBlocksItem.FileDownload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUpload | Skyvern.WorkflowDefinitionYamlBlocksItem.FileUrlParser | Skyvern.WorkflowDefinitionYamlBlocksItem.ForLoop | Skyvern.WorkflowDefinitionYamlBlocksItem.GotoUrl | Skyvern.WorkflowDefinitionYamlBlocksItem.HttpRequest | Skyvern.WorkflowDefinitionYamlBlocksItem.HumanInteraction | Skyvern.WorkflowDefinitionYamlBlocksItem.Login | Skyvern.WorkflowDefinitionYamlBlocksItem.Navigation | Skyvern.WorkflowDefinitionYamlBlocksItem.PdfParser | Skyvern.WorkflowDefinitionYamlBlocksItem.PrintPage | Skyvern.WorkflowDefinitionYamlBlocksItem.SendEmail | Skyvern.WorkflowDefinitionYamlBlocksItem.Task | Skyvern.WorkflowDefinitionYamlBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionYamlBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionYamlBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionYamlBlocksItem.Validation | Skyvern.WorkflowDefinitionYamlBlocksItem.Wait | Skyvern.WorkflowDefinitionYamlBlocksItem.WorkflowTrigger;
|
|
3
3
|
export declare namespace WorkflowDefinitionYamlBlocksItem {
|
|
4
4
|
interface Action extends Skyvern.ActionBlockYaml {
|
|
5
5
|
block_type: "action";
|
|
@@ -70,4 +70,7 @@ export declare namespace WorkflowDefinitionYamlBlocksItem {
|
|
|
70
70
|
interface Wait extends Skyvern.WaitBlockYaml {
|
|
71
71
|
block_type: "wait";
|
|
72
72
|
}
|
|
73
|
+
interface WorkflowTrigger extends Skyvern.WorkflowTriggerBlockYaml {
|
|
74
|
+
block_type: "workflow_trigger";
|
|
75
|
+
}
|
|
73
76
|
}
|
|
@@ -26,9 +26,6 @@ export interface WorkflowRun {
|
|
|
26
26
|
sequential_key?: string;
|
|
27
27
|
ai_fallback?: boolean;
|
|
28
28
|
code_gen?: boolean;
|
|
29
|
-
waiting_for_verification_code?: boolean;
|
|
30
|
-
verification_code_identifier?: string;
|
|
31
|
-
verification_code_polling_started_at?: string;
|
|
32
29
|
queued_at?: string;
|
|
33
30
|
started_at?: string;
|
|
34
31
|
finished_at?: string;
|
|
@@ -20,9 +20,16 @@ export interface WorkflowRunRequest {
|
|
|
20
20
|
* - RESIDENTIAL_DE: Germany
|
|
21
21
|
* - RESIDENTIAL_NZ: New Zealand
|
|
22
22
|
* - RESIDENTIAL_PH: Philippines
|
|
23
|
+
* - RESIDENTIAL_KR: South Korea
|
|
23
24
|
* - RESIDENTIAL_ZA: South Africa
|
|
24
25
|
* - RESIDENTIAL_AR: Argentina
|
|
25
26
|
* - RESIDENTIAL_AU: Australia
|
|
27
|
+
* - RESIDENTIAL_BR: Brazil
|
|
28
|
+
* - RESIDENTIAL_TR: Turkey
|
|
29
|
+
* - RESIDENTIAL_CA: Canada
|
|
30
|
+
* - RESIDENTIAL_MX: Mexico
|
|
31
|
+
* - RESIDENTIAL_IT: Italy
|
|
32
|
+
* - RESIDENTIAL_NL: Netherlands
|
|
26
33
|
* - RESIDENTIAL_ISP: ISP proxy
|
|
27
34
|
* - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
|
|
28
35
|
* - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
|
|
@@ -55,7 +62,7 @@ export interface WorkflowRunRequest {
|
|
|
55
62
|
browser_address?: string;
|
|
56
63
|
/** Whether to fallback to AI if the workflow run fails. */
|
|
57
64
|
ai_fallback?: boolean;
|
|
58
|
-
/** Whether to run the workflow with agent or
|
|
65
|
+
/** Whether to run the workflow with agent, code, or code_v2 (adaptive caching). */
|
|
59
66
|
run_with?: string;
|
|
60
67
|
}
|
|
61
68
|
export declare namespace WorkflowRunRequest {
|
|
@@ -74,9 +81,16 @@ export declare namespace WorkflowRunRequest {
|
|
|
74
81
|
* - RESIDENTIAL_DE: Germany
|
|
75
82
|
* - RESIDENTIAL_NZ: New Zealand
|
|
76
83
|
* - RESIDENTIAL_PH: Philippines
|
|
84
|
+
* - RESIDENTIAL_KR: South Korea
|
|
77
85
|
* - RESIDENTIAL_ZA: South Africa
|
|
78
86
|
* - RESIDENTIAL_AR: Argentina
|
|
79
87
|
* - RESIDENTIAL_AU: Australia
|
|
88
|
+
* - RESIDENTIAL_BR: Brazil
|
|
89
|
+
* - RESIDENTIAL_TR: Turkey
|
|
90
|
+
* - RESIDENTIAL_CA: Canada
|
|
91
|
+
* - RESIDENTIAL_MX: Mexico
|
|
92
|
+
* - RESIDENTIAL_IT: Italy
|
|
93
|
+
* - RESIDENTIAL_NL: Netherlands
|
|
80
94
|
* - RESIDENTIAL_ISP: ISP proxy
|
|
81
95
|
* - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
|
|
82
96
|
* - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
|
|
@@ -38,7 +38,7 @@ export interface WorkflowRunResponse {
|
|
|
38
38
|
errors?: Record<string, unknown>[];
|
|
39
39
|
/** Total number of steps executed in this run */
|
|
40
40
|
step_count?: number;
|
|
41
|
-
/** Whether the workflow run was executed with agent or
|
|
41
|
+
/** Whether the workflow run was executed with agent, code, or code_v2 (adaptive caching) */
|
|
42
42
|
run_with?: string;
|
|
43
43
|
/** Whether to fallback to AI if code run fails. */
|
|
44
44
|
ai_fallback?: boolean;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as Skyvern from "../index.js";
|
|
2
|
+
export interface WorkflowTriggerBlock {
|
|
3
|
+
/** Author-facing identifier for a block; unique within a workflow. */
|
|
4
|
+
label: string;
|
|
5
|
+
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
|
6
|
+
next_block_label?: string;
|
|
7
|
+
output_parameter: Skyvern.OutputParameter;
|
|
8
|
+
continue_on_failure?: boolean;
|
|
9
|
+
model?: Record<string, unknown>;
|
|
10
|
+
disable_cache?: boolean;
|
|
11
|
+
next_loop_on_failure?: boolean;
|
|
12
|
+
workflow_permanent_id: string;
|
|
13
|
+
payload?: Record<string, unknown>;
|
|
14
|
+
wait_for_completion?: boolean;
|
|
15
|
+
browser_session_id?: string;
|
|
16
|
+
use_parent_browser_session?: boolean;
|
|
17
|
+
parameters?: Skyvern.WorkflowTriggerBlockParametersItem[];
|
|
18
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type * as Skyvern from "../index.js";
|
|
2
|
+
export type WorkflowTriggerBlockParametersItem = Skyvern.WorkflowTriggerBlockParametersItem.AwsSecret | Skyvern.WorkflowTriggerBlockParametersItem.AzureSecret | Skyvern.WorkflowTriggerBlockParametersItem.AzureVaultCredential | Skyvern.WorkflowTriggerBlockParametersItem.BitwardenCreditCardData | Skyvern.WorkflowTriggerBlockParametersItem.BitwardenLoginCredential | Skyvern.WorkflowTriggerBlockParametersItem.BitwardenSensitiveInformation | Skyvern.WorkflowTriggerBlockParametersItem.Context | Skyvern.WorkflowTriggerBlockParametersItem.Credential | Skyvern.WorkflowTriggerBlockParametersItem.Onepassword | Skyvern.WorkflowTriggerBlockParametersItem.Output | Skyvern.WorkflowTriggerBlockParametersItem.Workflow;
|
|
3
|
+
export declare namespace WorkflowTriggerBlockParametersItem {
|
|
4
|
+
interface AwsSecret extends Skyvern.AwsSecretParameter {
|
|
5
|
+
parameter_type: "aws_secret";
|
|
6
|
+
}
|
|
7
|
+
interface AzureSecret extends Skyvern.AzureSecretParameter {
|
|
8
|
+
parameter_type: "azure_secret";
|
|
9
|
+
}
|
|
10
|
+
interface AzureVaultCredential extends Skyvern.AzureVaultCredentialParameter {
|
|
11
|
+
parameter_type: "azure_vault_credential";
|
|
12
|
+
}
|
|
13
|
+
interface BitwardenCreditCardData extends Skyvern.BitwardenCreditCardDataParameter {
|
|
14
|
+
parameter_type: "bitwarden_credit_card_data";
|
|
15
|
+
}
|
|
16
|
+
interface BitwardenLoginCredential extends Skyvern.BitwardenLoginCredentialParameter {
|
|
17
|
+
parameter_type: "bitwarden_login_credential";
|
|
18
|
+
}
|
|
19
|
+
interface BitwardenSensitiveInformation extends Skyvern.BitwardenSensitiveInformationParameter {
|
|
20
|
+
parameter_type: "bitwarden_sensitive_information";
|
|
21
|
+
}
|
|
22
|
+
interface Context extends Skyvern.ContextParameter {
|
|
23
|
+
parameter_type: "context";
|
|
24
|
+
}
|
|
25
|
+
interface Credential extends Skyvern.CredentialParameter {
|
|
26
|
+
parameter_type: "credential";
|
|
27
|
+
}
|
|
28
|
+
interface Onepassword extends Skyvern.OnePasswordCredentialParameter {
|
|
29
|
+
parameter_type: "onepassword";
|
|
30
|
+
}
|
|
31
|
+
interface Output extends Skyvern.OutputParameter {
|
|
32
|
+
parameter_type: "output";
|
|
33
|
+
}
|
|
34
|
+
interface Workflow extends Skyvern.WorkflowParameter {
|
|
35
|
+
parameter_type: "workflow";
|
|
36
|
+
}
|
|
37
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export interface WorkflowTriggerBlockYaml {
|
|
2
|
+
/** Author-facing identifier; must be unique per workflow. */
|
|
3
|
+
label: string;
|
|
4
|
+
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
|
5
|
+
next_block_label?: string;
|
|
6
|
+
continue_on_failure?: boolean;
|
|
7
|
+
model?: Record<string, unknown>;
|
|
8
|
+
next_loop_on_failure?: boolean;
|
|
9
|
+
workflow_permanent_id: string;
|
|
10
|
+
payload?: Record<string, unknown>;
|
|
11
|
+
wait_for_completion?: boolean;
|
|
12
|
+
browser_session_id?: string;
|
|
13
|
+
use_parent_browser_session?: boolean;
|
|
14
|
+
parameter_keys?: string[];
|
|
15
|
+
}
|
|
@@ -28,7 +28,6 @@ export * from "./BrowserProfile.js";
|
|
|
28
28
|
export * from "./BrowserSessionResponse.js";
|
|
29
29
|
export * from "./ChangeTierResponse.js";
|
|
30
30
|
export * from "./CheckoutSessionResponse.js";
|
|
31
|
-
export * from "./ClearCacheResponse.js";
|
|
32
31
|
export * from "./ClickAction.js";
|
|
33
32
|
export * from "./ClickContext.js";
|
|
34
33
|
export * from "./CodeBlock.js";
|
|
@@ -65,6 +64,7 @@ export * from "./FileStorageType.js";
|
|
|
65
64
|
export * from "./FileType.js";
|
|
66
65
|
export * from "./FileUploadBlock.js";
|
|
67
66
|
export * from "./FileUploadBlockYaml.js";
|
|
67
|
+
export * from "./Folder.js";
|
|
68
68
|
export * from "./ForLoopBlock.js";
|
|
69
69
|
export * from "./ForLoopBlockLoopBlocksItem.js";
|
|
70
70
|
export * from "./ForLoopBlockLoopOver.js";
|
|
@@ -176,3 +176,6 @@ export * from "./WorkflowRunStatus.js";
|
|
|
176
176
|
export * from "./WorkflowRunTimeline.js";
|
|
177
177
|
export * from "./WorkflowRunTimelineType.js";
|
|
178
178
|
export * from "./WorkflowStatus.js";
|
|
179
|
+
export * from "./WorkflowTriggerBlock.js";
|
|
180
|
+
export * from "./WorkflowTriggerBlockParametersItem.js";
|
|
181
|
+
export * from "./WorkflowTriggerBlockYaml.js";
|
|
@@ -44,7 +44,6 @@ __exportStar(require("./BrowserProfile.js"), exports);
|
|
|
44
44
|
__exportStar(require("./BrowserSessionResponse.js"), exports);
|
|
45
45
|
__exportStar(require("./ChangeTierResponse.js"), exports);
|
|
46
46
|
__exportStar(require("./CheckoutSessionResponse.js"), exports);
|
|
47
|
-
__exportStar(require("./ClearCacheResponse.js"), exports);
|
|
48
47
|
__exportStar(require("./ClickAction.js"), exports);
|
|
49
48
|
__exportStar(require("./ClickContext.js"), exports);
|
|
50
49
|
__exportStar(require("./CodeBlock.js"), exports);
|
|
@@ -81,6 +80,7 @@ __exportStar(require("./FileStorageType.js"), exports);
|
|
|
81
80
|
__exportStar(require("./FileType.js"), exports);
|
|
82
81
|
__exportStar(require("./FileUploadBlock.js"), exports);
|
|
83
82
|
__exportStar(require("./FileUploadBlockYaml.js"), exports);
|
|
83
|
+
__exportStar(require("./Folder.js"), exports);
|
|
84
84
|
__exportStar(require("./ForLoopBlock.js"), exports);
|
|
85
85
|
__exportStar(require("./ForLoopBlockLoopBlocksItem.js"), exports);
|
|
86
86
|
__exportStar(require("./ForLoopBlockLoopOver.js"), exports);
|
|
@@ -192,3 +192,6 @@ __exportStar(require("./WorkflowRunStatus.js"), exports);
|
|
|
192
192
|
__exportStar(require("./WorkflowRunTimeline.js"), exports);
|
|
193
193
|
__exportStar(require("./WorkflowRunTimelineType.js"), exports);
|
|
194
194
|
__exportStar(require("./WorkflowStatus.js"), exports);
|
|
195
|
+
__exportStar(require("./WorkflowTriggerBlock.js"), exports);
|
|
196
|
+
__exportStar(require("./WorkflowTriggerBlockParametersItem.js"), exports);
|
|
197
|
+
__exportStar(require("./WorkflowTriggerBlockYaml.js"), exports);
|
package/dist/cjs/version.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "1.0.
|
|
1
|
+
export declare const SDK_VERSION = "1.0.24";
|
package/dist/cjs/version.js
CHANGED
package/dist/esm/Client.d.mts
CHANGED
|
@@ -380,6 +380,7 @@ export declare class SkyvernClient {
|
|
|
380
380
|
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
381
381
|
*
|
|
382
382
|
* @throws {@link Skyvern.ForbiddenError}
|
|
383
|
+
* @throws {@link Skyvern.NotFoundError}
|
|
383
384
|
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
384
385
|
*
|
|
385
386
|
* @example
|
|
@@ -607,19 +608,6 @@ export declare class SkyvernClient {
|
|
|
607
608
|
*/
|
|
608
609
|
deployScript(scriptId: string, request: Skyvern.DeployScriptRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.CreateScriptResponse>;
|
|
609
610
|
private __deployScript;
|
|
610
|
-
/**
|
|
611
|
-
* Clear all cached scripts for a specific workflow. This will trigger script regeneration on subsequent runs.
|
|
612
|
-
*
|
|
613
|
-
* @param {string} workflowPermanentId - The workflow permanent ID to clear cache for
|
|
614
|
-
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
615
|
-
*
|
|
616
|
-
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
617
|
-
*
|
|
618
|
-
* @example
|
|
619
|
-
* await client.clearWorkflowCache("wpid_abc123")
|
|
620
|
-
*/
|
|
621
|
-
clearWorkflowCache(workflowPermanentId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.ClearCacheResponse>;
|
|
622
|
-
private __clearWorkflowCache;
|
|
623
611
|
/**
|
|
624
612
|
* Execute a single SDK action with the specified parameters
|
|
625
613
|
*
|
|
@@ -706,4 +694,99 @@ export declare class SkyvernClient {
|
|
|
706
694
|
*/
|
|
707
695
|
changeTierApiV1BillingChangeTierPost(request: Skyvern.ChangeTierRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.ChangeTierResponse>;
|
|
708
696
|
private __changeTierApiV1BillingChangeTierPost;
|
|
697
|
+
/**
|
|
698
|
+
* Get all folders for the organization
|
|
699
|
+
*
|
|
700
|
+
* @param {Skyvern.GetFoldersRequest} request
|
|
701
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
702
|
+
*
|
|
703
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
704
|
+
*
|
|
705
|
+
* @example
|
|
706
|
+
* await client.getFolders({
|
|
707
|
+
* page: 1,
|
|
708
|
+
* page_size: 1,
|
|
709
|
+
* search: "search"
|
|
710
|
+
* })
|
|
711
|
+
*/
|
|
712
|
+
getFolders(request?: Skyvern.GetFoldersRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder[]>;
|
|
713
|
+
private __getFolders;
|
|
714
|
+
/**
|
|
715
|
+
* Create a new folder to organize workflows
|
|
716
|
+
*
|
|
717
|
+
* @param {Skyvern.FolderCreate} request
|
|
718
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
719
|
+
*
|
|
720
|
+
* @throws {@link Skyvern.BadRequestError}
|
|
721
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
722
|
+
*
|
|
723
|
+
* @example
|
|
724
|
+
* await client.createFolder({
|
|
725
|
+
* title: "title"
|
|
726
|
+
* })
|
|
727
|
+
*/
|
|
728
|
+
createFolder(request: Skyvern.FolderCreate, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
|
|
729
|
+
private __createFolder;
|
|
730
|
+
/**
|
|
731
|
+
* Get a specific folder by ID
|
|
732
|
+
*
|
|
733
|
+
* @param {string} folderId - Folder ID
|
|
734
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
735
|
+
*
|
|
736
|
+
* @throws {@link Skyvern.NotFoundError}
|
|
737
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
738
|
+
*
|
|
739
|
+
* @example
|
|
740
|
+
* await client.getFolder("fld_123")
|
|
741
|
+
*/
|
|
742
|
+
getFolder(folderId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
|
|
743
|
+
private __getFolder;
|
|
744
|
+
/**
|
|
745
|
+
* Update a folder's title or description
|
|
746
|
+
*
|
|
747
|
+
* @param {string} folderId - Folder ID
|
|
748
|
+
* @param {Skyvern.FolderUpdate} request
|
|
749
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
750
|
+
*
|
|
751
|
+
* @throws {@link Skyvern.NotFoundError}
|
|
752
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
753
|
+
*
|
|
754
|
+
* @example
|
|
755
|
+
* await client.updateFolder("fld_123")
|
|
756
|
+
*/
|
|
757
|
+
updateFolder(folderId: string, request?: Skyvern.FolderUpdate, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
|
|
758
|
+
private __updateFolder;
|
|
759
|
+
/**
|
|
760
|
+
* Delete a folder. Optionally delete all workflows in the folder.
|
|
761
|
+
*
|
|
762
|
+
* @param {string} folderId - Folder ID
|
|
763
|
+
* @param {Skyvern.DeleteFolderRequest} request
|
|
764
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
765
|
+
*
|
|
766
|
+
* @throws {@link Skyvern.NotFoundError}
|
|
767
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
768
|
+
*
|
|
769
|
+
* @example
|
|
770
|
+
* await client.deleteFolder("fld_123", {
|
|
771
|
+
* delete_workflows: true
|
|
772
|
+
* })
|
|
773
|
+
*/
|
|
774
|
+
deleteFolder(folderId: string, request?: Skyvern.DeleteFolderRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
|
|
775
|
+
private __deleteFolder;
|
|
776
|
+
/**
|
|
777
|
+
* Update a workflow's folder assignment for the latest version
|
|
778
|
+
*
|
|
779
|
+
* @param {string} workflowPermanentId - Workflow permanent ID
|
|
780
|
+
* @param {Skyvern.UpdateWorkflowFolderRequest} request
|
|
781
|
+
* @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
782
|
+
*
|
|
783
|
+
* @throws {@link Skyvern.BadRequestError}
|
|
784
|
+
* @throws {@link Skyvern.NotFoundError}
|
|
785
|
+
* @throws {@link Skyvern.UnprocessableEntityError}
|
|
786
|
+
*
|
|
787
|
+
* @example
|
|
788
|
+
* await client.updateWorkflowFolder("wpid_123")
|
|
789
|
+
*/
|
|
790
|
+
updateWorkflowFolder(workflowPermanentId: string, request?: Skyvern.UpdateWorkflowFolderRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Workflow>;
|
|
791
|
+
private __updateWorkflowFolder;
|
|
709
792
|
}
|