@skyvern/client 0.2.23 → 1.0.2

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.
Files changed (184) hide show
  1. package/README.md +18 -1
  2. package/dist/cjs/Client.d.ts +60 -3
  3. package/dist/cjs/Client.js +266 -11
  4. package/dist/cjs/api/{resources/browserProfiles/client/requests/ListBrowserProfilesV1BrowserProfilesGetRequest.d.ts → client/requests/ListBrowserProfilesRequest.d.ts} +1 -1
  5. package/dist/cjs/api/client/requests/LoginRequest.d.ts +2 -0
  6. package/dist/cjs/api/client/requests/index.d.ts +2 -0
  7. package/dist/cjs/api/errors/ConflictError.d.ts +5 -0
  8. package/dist/cjs/api/errors/ConflictError.js +50 -0
  9. package/dist/cjs/api/errors/index.d.ts +1 -0
  10. package/dist/cjs/api/errors/index.js +1 -0
  11. package/dist/cjs/api/resources/index.d.ts +0 -2
  12. package/dist/cjs/api/resources/index.js +4 -6
  13. package/dist/cjs/api/types/ActionBlock.d.ts +3 -1
  14. package/dist/cjs/api/types/ActionBlockYaml.d.ts +3 -1
  15. package/dist/cjs/api/types/BlockType.d.ts +1 -0
  16. package/dist/cjs/api/types/BlockType.js +1 -0
  17. package/dist/cjs/api/types/BranchCondition.d.ts +10 -0
  18. package/dist/cjs/api/{resources/browserProfiles/client/requests/index.js → types/BranchCondition.js} +1 -0
  19. package/dist/cjs/api/types/BranchCriteria.d.ts +8 -0
  20. package/dist/cjs/api/types/BranchCriteria.js +3 -0
  21. package/dist/cjs/api/types/CodeBlock.d.ts +3 -0
  22. package/dist/cjs/api/types/CodeBlockYaml.d.ts +3 -0
  23. package/dist/cjs/api/types/ConditionalBlock.d.ts +15 -0
  24. package/dist/cjs/api/types/ConditionalBlock.js +3 -0
  25. package/dist/cjs/api/types/DownloadToS3Block.d.ts +3 -0
  26. package/dist/cjs/api/types/DownloadToS3BlockYaml.d.ts +3 -0
  27. package/dist/cjs/api/types/ExtractionBlock.d.ts +3 -1
  28. package/dist/cjs/api/types/ExtractionBlockYaml.d.ts +3 -1
  29. package/dist/cjs/api/types/FileDownloadBlock.d.ts +3 -1
  30. package/dist/cjs/api/types/FileDownloadBlockYaml.d.ts +3 -1
  31. package/dist/cjs/api/types/FileParserBlock.d.ts +3 -0
  32. package/dist/cjs/api/types/FileParserBlockYaml.d.ts +3 -0
  33. package/dist/cjs/api/types/FileUploadBlock.d.ts +3 -0
  34. package/dist/cjs/api/types/FileUploadBlockYaml.d.ts +3 -0
  35. package/dist/cjs/api/types/ForLoopBlock.d.ts +3 -0
  36. package/dist/cjs/api/types/ForLoopBlockLoopBlocksItem.d.ts +4 -1
  37. package/dist/cjs/api/types/ForLoopBlockYaml.d.ts +3 -0
  38. package/dist/cjs/api/types/GeoTarget.d.ts +21 -0
  39. package/dist/cjs/api/types/GeoTarget.js +3 -0
  40. package/dist/cjs/api/types/HttpRequestBlock.d.ts +3 -0
  41. package/dist/cjs/api/types/HttpRequestBlockYaml.d.ts +3 -0
  42. package/dist/cjs/api/types/HumanInteractionBlock.d.ts +3 -1
  43. package/dist/cjs/api/types/HumanInteractionBlockYaml.d.ts +3 -0
  44. package/dist/cjs/api/types/LocateElementAction.d.ts +7 -0
  45. package/dist/cjs/api/types/LocateElementAction.js +3 -0
  46. package/dist/cjs/api/types/LoginBlock.d.ts +3 -1
  47. package/dist/cjs/api/types/LoginBlockYaml.d.ts +3 -1
  48. package/dist/cjs/api/types/NavigationBlock.d.ts +3 -1
  49. package/dist/cjs/api/types/NavigationBlockYaml.d.ts +3 -1
  50. package/dist/cjs/api/types/NonEmptyPasswordCredential.d.ts +2 -0
  51. package/dist/cjs/api/types/PasswordCredentialResponse.d.ts +2 -0
  52. package/dist/cjs/api/types/PdfParserBlock.d.ts +3 -0
  53. package/dist/cjs/api/types/PdfParserBlockYaml.d.ts +3 -0
  54. package/dist/cjs/api/types/RunSdkActionRequestAction.d.ts +4 -1
  55. package/dist/cjs/api/types/SendEmailBlock.d.ts +3 -0
  56. package/dist/cjs/api/types/SendEmailBlockYaml.d.ts +3 -0
  57. package/dist/cjs/api/types/TaskBlock.d.ts +3 -1
  58. package/dist/cjs/api/types/TaskBlockYaml.d.ts +3 -1
  59. package/dist/cjs/api/types/TaskRunRequest.d.ts +29 -1
  60. package/dist/cjs/api/types/TaskV2Block.d.ts +3 -0
  61. package/dist/cjs/api/types/TaskV2BlockYaml.d.ts +3 -0
  62. package/dist/cjs/api/types/TextPromptBlock.d.ts +3 -0
  63. package/dist/cjs/api/types/TextPromptBlockYaml.d.ts +3 -0
  64. package/dist/cjs/api/types/UploadToS3Block.d.ts +3 -0
  65. package/dist/cjs/api/types/UploadToS3BlockYaml.d.ts +3 -0
  66. package/dist/cjs/api/types/UrlBlock.d.ts +3 -1
  67. package/dist/cjs/api/types/UrlBlockYaml.d.ts +3 -0
  68. package/dist/cjs/api/types/ValidationBlock.d.ts +3 -1
  69. package/dist/cjs/api/types/ValidationBlockYaml.d.ts +3 -0
  70. package/dist/cjs/api/types/WaitBlock.d.ts +3 -0
  71. package/dist/cjs/api/types/WaitBlockYaml.d.ts +3 -0
  72. package/dist/cjs/api/types/Workflow.d.ts +4 -1
  73. package/dist/cjs/api/types/WorkflowCreateYamlRequest.d.ts +4 -1
  74. package/dist/cjs/api/types/WorkflowDefinition.d.ts +1 -0
  75. package/dist/cjs/api/types/WorkflowDefinitionBlocksItem.d.ts +4 -1
  76. package/dist/cjs/api/types/WorkflowDefinitionYaml.d.ts +1 -0
  77. package/dist/cjs/api/types/WorkflowRunRequest.d.ts +31 -1
  78. package/dist/cjs/api/types/index.d.ts +5 -0
  79. package/dist/cjs/api/types/index.js +5 -0
  80. package/dist/cjs/version.d.ts +1 -1
  81. package/dist/cjs/version.js +1 -1
  82. package/dist/esm/Client.d.mts +60 -3
  83. package/dist/esm/Client.mjs +262 -7
  84. package/dist/esm/api/{resources/browserProfiles/client/requests/ListBrowserProfilesV1BrowserProfilesGetRequest.d.mts → client/requests/ListBrowserProfilesRequest.d.mts} +1 -1
  85. package/dist/esm/api/client/requests/LoginRequest.d.mts +2 -0
  86. package/dist/esm/api/client/requests/index.d.mts +2 -0
  87. package/dist/esm/api/errors/ConflictError.d.mts +5 -0
  88. package/dist/esm/api/errors/ConflictError.mjs +13 -0
  89. package/dist/esm/api/errors/index.d.mts +1 -0
  90. package/dist/esm/api/errors/index.mjs +1 -0
  91. package/dist/esm/api/resources/index.d.mts +0 -2
  92. package/dist/esm/api/resources/index.mjs +0 -2
  93. package/dist/esm/api/types/ActionBlock.d.mts +3 -1
  94. package/dist/esm/api/types/ActionBlockYaml.d.mts +3 -1
  95. package/dist/esm/api/types/BlockType.d.mts +1 -0
  96. package/dist/esm/api/types/BlockType.mjs +1 -0
  97. package/dist/esm/api/types/BranchCondition.d.mts +10 -0
  98. package/dist/esm/api/types/BranchCondition.mjs +2 -0
  99. package/dist/esm/api/types/BranchCriteria.d.mts +8 -0
  100. package/dist/esm/api/types/BranchCriteria.mjs +2 -0
  101. package/dist/esm/api/types/CodeBlock.d.mts +3 -0
  102. package/dist/esm/api/types/CodeBlockYaml.d.mts +3 -0
  103. package/dist/esm/api/types/ConditionalBlock.d.mts +15 -0
  104. package/dist/esm/api/types/ConditionalBlock.mjs +2 -0
  105. package/dist/esm/api/types/DownloadToS3Block.d.mts +3 -0
  106. package/dist/esm/api/types/DownloadToS3BlockYaml.d.mts +3 -0
  107. package/dist/esm/api/types/ExtractionBlock.d.mts +3 -1
  108. package/dist/esm/api/types/ExtractionBlockYaml.d.mts +3 -1
  109. package/dist/esm/api/types/FileDownloadBlock.d.mts +3 -1
  110. package/dist/esm/api/types/FileDownloadBlockYaml.d.mts +3 -1
  111. package/dist/esm/api/types/FileParserBlock.d.mts +3 -0
  112. package/dist/esm/api/types/FileParserBlockYaml.d.mts +3 -0
  113. package/dist/esm/api/types/FileUploadBlock.d.mts +3 -0
  114. package/dist/esm/api/types/FileUploadBlockYaml.d.mts +3 -0
  115. package/dist/esm/api/types/ForLoopBlock.d.mts +3 -0
  116. package/dist/esm/api/types/ForLoopBlockLoopBlocksItem.d.mts +4 -1
  117. package/dist/esm/api/types/ForLoopBlockYaml.d.mts +3 -0
  118. package/dist/esm/api/types/GeoTarget.d.mts +21 -0
  119. package/dist/esm/api/types/GeoTarget.mjs +2 -0
  120. package/dist/esm/api/types/HttpRequestBlock.d.mts +3 -0
  121. package/dist/esm/api/types/HttpRequestBlockYaml.d.mts +3 -0
  122. package/dist/esm/api/types/HumanInteractionBlock.d.mts +3 -1
  123. package/dist/esm/api/types/HumanInteractionBlockYaml.d.mts +3 -0
  124. package/dist/esm/api/types/LocateElementAction.d.mts +7 -0
  125. package/dist/esm/api/types/LocateElementAction.mjs +2 -0
  126. package/dist/esm/api/types/LoginBlock.d.mts +3 -1
  127. package/dist/esm/api/types/LoginBlockYaml.d.mts +3 -1
  128. package/dist/esm/api/types/NavigationBlock.d.mts +3 -1
  129. package/dist/esm/api/types/NavigationBlockYaml.d.mts +3 -1
  130. package/dist/esm/api/types/NonEmptyPasswordCredential.d.mts +2 -0
  131. package/dist/esm/api/types/PasswordCredentialResponse.d.mts +2 -0
  132. package/dist/esm/api/types/PdfParserBlock.d.mts +3 -0
  133. package/dist/esm/api/types/PdfParserBlockYaml.d.mts +3 -0
  134. package/dist/esm/api/types/RunSdkActionRequestAction.d.mts +4 -1
  135. package/dist/esm/api/types/SendEmailBlock.d.mts +3 -0
  136. package/dist/esm/api/types/SendEmailBlockYaml.d.mts +3 -0
  137. package/dist/esm/api/types/TaskBlock.d.mts +3 -1
  138. package/dist/esm/api/types/TaskBlockYaml.d.mts +3 -1
  139. package/dist/esm/api/types/TaskRunRequest.d.mts +29 -1
  140. package/dist/esm/api/types/TaskV2Block.d.mts +3 -0
  141. package/dist/esm/api/types/TaskV2BlockYaml.d.mts +3 -0
  142. package/dist/esm/api/types/TextPromptBlock.d.mts +3 -0
  143. package/dist/esm/api/types/TextPromptBlockYaml.d.mts +3 -0
  144. package/dist/esm/api/types/UploadToS3Block.d.mts +3 -0
  145. package/dist/esm/api/types/UploadToS3BlockYaml.d.mts +3 -0
  146. package/dist/esm/api/types/UrlBlock.d.mts +3 -1
  147. package/dist/esm/api/types/UrlBlockYaml.d.mts +3 -0
  148. package/dist/esm/api/types/ValidationBlock.d.mts +3 -1
  149. package/dist/esm/api/types/ValidationBlockYaml.d.mts +3 -0
  150. package/dist/esm/api/types/WaitBlock.d.mts +3 -0
  151. package/dist/esm/api/types/WaitBlockYaml.d.mts +3 -0
  152. package/dist/esm/api/types/Workflow.d.mts +4 -1
  153. package/dist/esm/api/types/WorkflowCreateYamlRequest.d.mts +4 -1
  154. package/dist/esm/api/types/WorkflowDefinition.d.mts +1 -0
  155. package/dist/esm/api/types/WorkflowDefinitionBlocksItem.d.mts +4 -1
  156. package/dist/esm/api/types/WorkflowDefinitionYaml.d.mts +1 -0
  157. package/dist/esm/api/types/WorkflowRunRequest.d.mts +31 -1
  158. package/dist/esm/api/types/index.d.mts +5 -0
  159. package/dist/esm/api/types/index.mjs +5 -0
  160. package/dist/esm/version.d.mts +1 -1
  161. package/dist/esm/version.mjs +1 -1
  162. package/package.json +1 -1
  163. package/reference.md +0 -243
  164. package/dist/cjs/api/resources/browserProfiles/client/Client.d.ts +0 -69
  165. package/dist/cjs/api/resources/browserProfiles/client/Client.js +0 -309
  166. package/dist/cjs/api/resources/browserProfiles/client/index.d.ts +0 -1
  167. package/dist/cjs/api/resources/browserProfiles/client/index.js +0 -17
  168. package/dist/cjs/api/resources/browserProfiles/client/requests/index.d.ts +0 -2
  169. package/dist/cjs/api/resources/browserProfiles/index.d.ts +0 -1
  170. package/dist/cjs/api/resources/browserProfiles/index.js +0 -17
  171. package/dist/esm/api/resources/browserProfiles/client/Client.d.mts +0 -69
  172. package/dist/esm/api/resources/browserProfiles/client/Client.mjs +0 -272
  173. package/dist/esm/api/resources/browserProfiles/client/index.d.mts +0 -1
  174. package/dist/esm/api/resources/browserProfiles/client/index.mjs +0 -1
  175. package/dist/esm/api/resources/browserProfiles/client/requests/index.d.mts +0 -2
  176. package/dist/esm/api/resources/browserProfiles/client/requests/index.mjs +0 -1
  177. package/dist/esm/api/resources/browserProfiles/index.d.mts +0 -1
  178. package/dist/esm/api/resources/browserProfiles/index.mjs +0 -1
  179. /package/dist/cjs/api/{resources/browserProfiles/client → client}/requests/CreateBrowserProfileRequest.d.ts +0 -0
  180. /package/dist/cjs/api/{resources/browserProfiles/client → client}/requests/CreateBrowserProfileRequest.js +0 -0
  181. /package/dist/cjs/api/{resources/browserProfiles/client/requests/ListBrowserProfilesV1BrowserProfilesGetRequest.js → client/requests/ListBrowserProfilesRequest.js} +0 -0
  182. /package/dist/esm/api/{resources/browserProfiles/client → client}/requests/CreateBrowserProfileRequest.d.mts +0 -0
  183. /package/dist/esm/api/{resources/browserProfiles/client → client}/requests/CreateBrowserProfileRequest.mjs +0 -0
  184. /package/dist/esm/api/{resources/browserProfiles/client/requests/ListBrowserProfilesV1BrowserProfilesGetRequest.mjs → client/requests/ListBrowserProfilesRequest.mjs} +0 -0
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface CodeBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface CodeBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  code: string;
@@ -0,0 +1,15 @@
1
+ import type * as Skyvern from "../index.js";
2
+ /**
3
+ * Branching block that selects the next block label based on list-ordered conditions.
4
+ */
5
+ export interface ConditionalBlock {
6
+ /** Author-facing identifier for a block; unique within a workflow. */
7
+ label: string;
8
+ /** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
9
+ next_block_label?: string;
10
+ output_parameter: Skyvern.OutputParameter;
11
+ continue_on_failure?: boolean;
12
+ model?: Record<string, unknown>;
13
+ disable_cache?: boolean;
14
+ branch_conditions?: Skyvern.BranchCondition[];
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface DownloadToS3Block {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface DownloadToS3BlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  url: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface ExtractionBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface ExtractionBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface ExtractionBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  data_extraction_goal: string;
@@ -11,7 +14,6 @@ export interface ExtractionBlockYaml {
11
14
  max_retries?: number;
12
15
  max_steps_per_run?: number;
13
16
  parameter_keys?: string[];
14
- cache_actions?: boolean;
15
17
  disable_cache?: boolean;
16
18
  }
17
19
  export declare namespace ExtractionBlockYaml {
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileDownloadBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface FileDownloadBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileDownloadBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  navigation_goal: string;
@@ -14,7 +17,6 @@ export interface FileDownloadBlockYaml {
14
17
  download_suffix?: string;
15
18
  totp_verification_url?: string;
16
19
  totp_identifier?: string;
17
- cache_actions?: boolean;
18
20
  disable_cache?: boolean;
19
21
  download_timeout?: number;
20
22
  }
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileParserBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileParserBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  file_url: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileUploadBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface FileUploadBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  storage_type?: Skyvern.FileStorageType;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface ForLoopBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -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.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.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.SendEmail | Skyvern.ForLoopBlockLoopBlocksItem.Task | Skyvern.ForLoopBlockLoopBlocksItem.TaskV2 | Skyvern.ForLoopBlockLoopBlocksItem.TextPrompt | Skyvern.ForLoopBlockLoopBlocksItem.UploadToS3 | Skyvern.ForLoopBlockLoopBlocksItem.Validation | Skyvern.ForLoopBlockLoopBlocksItem.Wait;
3
3
  export declare namespace ForLoopBlockLoopBlocksItem {
4
4
  interface Action extends Skyvern.ActionBlock {
5
5
  block_type: "action";
@@ -7,6 +7,9 @@ export declare namespace ForLoopBlockLoopBlocksItem {
7
7
  interface Code extends Skyvern.CodeBlock {
8
8
  block_type: "code";
9
9
  }
10
+ interface Conditional extends Skyvern.ConditionalBlock {
11
+ block_type: "conditional";
12
+ }
10
13
  interface DownloadToS3 extends Skyvern.DownloadToS3Block {
11
14
  block_type: "download_to_s3";
12
15
  }
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface ForLoopBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  loop_blocks: Skyvern.ForLoopBlockYamlLoopBlocksItem[];
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Granular geographic targeting for proxy selection.
3
+ *
4
+ * Supports country, subdivision (state/region), and city level targeting.
5
+ * Uses ISO 3166-1 alpha-2 for countries, ISO 3166-2 for subdivisions,
6
+ * and GeoNames English names for cities.
7
+ *
8
+ * Examples:
9
+ * - {"country": "US"} - United States (same as RESIDENTIAL)
10
+ * - {"country": "US", "subdivision": "CA"} - California, US
11
+ * - {"country": "US", "subdivision": "NY", "city": "New York"} - New York City
12
+ * - {"country": "GB", "city": "London"} - London, UK
13
+ */
14
+ export interface GeoTarget {
15
+ /** ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE') */
16
+ country: string;
17
+ /** ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York) */
18
+ subdivision?: string;
19
+ /** City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London') */
20
+ city?: string;
21
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface HttpRequestBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface HttpRequestBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  method?: string;
@@ -11,7 +11,10 @@ import type * as Skyvern from "../index.js";
11
11
  * - does not respond within the timeout period, the workflow terminates
12
12
  */
13
13
  export interface HumanInteractionBlock {
14
+ /** Author-facing identifier for a block; unique within a workflow. */
14
15
  label: string;
16
+ /** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
17
+ next_block_label?: string;
15
18
  output_parameter: Skyvern.OutputParameter;
16
19
  continue_on_failure?: boolean;
17
20
  model?: Record<string, unknown>;
@@ -33,7 +36,6 @@ export interface HumanInteractionBlock {
33
36
  download_suffix?: string;
34
37
  totp_verification_url?: string;
35
38
  totp_identifier?: string;
36
- cache_actions?: boolean;
37
39
  complete_verification?: boolean;
38
40
  include_action_history_in_verification?: boolean;
39
41
  download_timeout?: number;
@@ -1,5 +1,8 @@
1
1
  export interface HumanInteractionBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  instructions?: string;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Locate element action parameters.
3
+ */
4
+ export interface LocateElementAction {
5
+ /** Natural language prompt to locate an element */
6
+ prompt?: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface LoginBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface LoginBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface LoginBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  url?: string;
@@ -13,7 +16,6 @@ export interface LoginBlockYaml {
13
16
  parameter_keys?: string[];
14
17
  totp_verification_url?: string;
15
18
  totp_identifier?: string;
16
- cache_actions?: boolean;
17
19
  disable_cache?: boolean;
18
20
  complete_criterion?: string;
19
21
  terminate_criterion?: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface NavigationBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface NavigationBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface NavigationBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  navigation_goal: string;
@@ -15,7 +18,6 @@ export interface NavigationBlockYaml {
15
18
  download_suffix?: string;
16
19
  totp_verification_url?: string;
17
20
  totp_identifier?: string;
18
- cache_actions?: boolean;
19
21
  disable_cache?: boolean;
20
22
  complete_criterion?: string;
21
23
  terminate_criterion?: string;
@@ -11,4 +11,6 @@ export interface NonEmptyPasswordCredential {
11
11
  totp?: string;
12
12
  /** Type of 2FA method used for this credential */
13
13
  totp_type?: Skyvern.TotpType;
14
+ /** Identifier (email or phone number) used to fetch TOTP codes */
15
+ totp_identifier?: string;
14
16
  }
@@ -7,4 +7,6 @@ export interface PasswordCredentialResponse {
7
7
  username: string;
8
8
  /** Type of 2FA method used for this credential */
9
9
  totp_type?: Skyvern.TotpType;
10
+ /** Identifier (email or phone number) used to fetch TOTP codes */
11
+ totp_identifier?: string;
10
12
  }
@@ -4,7 +4,10 @@ import type * as Skyvern from "../index.js";
4
4
  * This block will be removed in a future version.
5
5
  */
6
6
  export interface PdfParserBlock {
7
+ /** Author-facing identifier for a block; unique within a workflow. */
7
8
  label: string;
9
+ /** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
10
+ next_block_label?: string;
8
11
  output_parameter: Skyvern.OutputParameter;
9
12
  continue_on_failure?: boolean;
10
13
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface PdfParserBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  file_url: string;
@@ -2,7 +2,7 @@ import type * as Skyvern from "../index.js";
2
2
  /**
3
3
  * The action to execute with its specific parameters
4
4
  */
5
- export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.AiUploadFile | Skyvern.RunSdkActionRequestAction.Extract;
5
+ export type RunSdkActionRequestAction = Skyvern.RunSdkActionRequestAction.AiAct | Skyvern.RunSdkActionRequestAction.AiClick | Skyvern.RunSdkActionRequestAction.AiInputText | Skyvern.RunSdkActionRequestAction.AiSelectOption | Skyvern.RunSdkActionRequestAction.AiUploadFile | Skyvern.RunSdkActionRequestAction.Extract | Skyvern.RunSdkActionRequestAction.LocateElement;
6
6
  export declare namespace RunSdkActionRequestAction {
7
7
  interface AiAct extends Skyvern.ActAction {
8
8
  type: "ai_act";
@@ -22,4 +22,7 @@ export declare namespace RunSdkActionRequestAction {
22
22
  interface Extract extends Skyvern.ExtractAction {
23
23
  type: "extract";
24
24
  }
25
+ interface LocateElement extends Skyvern.LocateElementAction {
26
+ type: "locate_element";
27
+ }
25
28
  }
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface SendEmailBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface SendEmailBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  smtp_host_secret_parameter_key: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface TaskBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface TaskBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface TaskBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
3
4
  label: string;
5
+ /** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
6
+ next_block_label?: string;
4
7
  continue_on_failure?: boolean;
5
8
  model?: Record<string, unknown>;
6
9
  url?: string;
@@ -17,7 +20,6 @@ export interface TaskBlockYaml {
17
20
  download_suffix?: string;
18
21
  totp_verification_url?: string;
19
22
  totp_identifier?: string;
20
- cache_actions?: boolean;
21
23
  disable_cache?: boolean;
22
24
  complete_criterion?: string;
23
25
  terminate_criterion?: string;
@@ -37,8 +37,9 @@ export interface TaskRunRequest {
37
37
  * - US-FL: Florida
38
38
  * - US-WA: Washington
39
39
  * - NONE: No proxy
40
+ * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
40
41
  */
41
- proxy_location?: Skyvern.ProxyLocation;
42
+ proxy_location?: TaskRunRequest.ProxyLocation;
42
43
  /**
43
44
  * The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
44
45
  */
@@ -83,6 +84,33 @@ export interface TaskRunRequest {
83
84
  browser_address?: string;
84
85
  }
85
86
  export declare namespace TaskRunRequest {
87
+ /**
88
+ *
89
+ * Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
90
+ *
91
+ * Available geotargeting options:
92
+ * - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
93
+ * - RESIDENTIAL_ES: Spain
94
+ * - RESIDENTIAL_IE: Ireland
95
+ * - RESIDENTIAL_GB: United Kingdom
96
+ * - RESIDENTIAL_IN: India
97
+ * - RESIDENTIAL_JP: Japan
98
+ * - RESIDENTIAL_FR: France
99
+ * - RESIDENTIAL_DE: Germany
100
+ * - RESIDENTIAL_NZ: New Zealand
101
+ * - RESIDENTIAL_ZA: South Africa
102
+ * - RESIDENTIAL_AR: Argentina
103
+ * - RESIDENTIAL_AU: Australia
104
+ * - RESIDENTIAL_ISP: ISP proxy
105
+ * - US-CA: California
106
+ * - US-NY: New York
107
+ * - US-TX: Texas
108
+ * - US-FL: Florida
109
+ * - US-WA: Washington
110
+ * - NONE: No proxy
111
+ * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
112
+ */
113
+ type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
86
114
  /**
87
115
  *
88
116
  * The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface TaskV2Block {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface TaskV2BlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  prompt: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface TextPromptBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface TextPromptBlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  llm_key?: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface UploadToS3Block {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -1,5 +1,8 @@
1
1
  export interface UploadToS3BlockYaml {
2
+ /** Author-facing identifier; must be unique per workflow. */
2
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;
3
6
  continue_on_failure?: boolean;
4
7
  model?: Record<string, unknown>;
5
8
  path?: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.js";
2
2
  export interface UrlBlock {
3
+ /** Author-facing identifier for a block; unique within a workflow. */
3
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;
4
7
  output_parameter: Skyvern.OutputParameter;
5
8
  continue_on_failure?: boolean;
6
9
  model?: Record<string, unknown>;
@@ -22,7 +25,6 @@ export interface UrlBlock {
22
25
  download_suffix?: string;
23
26
  totp_verification_url?: string;
24
27
  totp_identifier?: string;
25
- cache_actions?: boolean;
26
28
  complete_verification?: boolean;
27
29
  include_action_history_in_verification?: boolean;
28
30
  download_timeout?: number;