@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.mjs";
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.mjs";
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.mjs";
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.mjs";
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.mjs";
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;
@@ -1,5 +1,8 @@
1
1
  export interface UrlBlockYaml {
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.mjs";
2
2
  export interface ValidationBlock {
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 ValidationBlock {
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,5 +1,8 @@
1
1
  export interface ValidationBlockYaml {
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
  complete_criterion?: string;
@@ -1,6 +1,9 @@
1
1
  import type * as Skyvern from "../index.mjs";
2
2
  export interface WaitBlock {
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 WaitBlockYaml {
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
  wait_sec?: number;
@@ -8,7 +8,7 @@ export interface Workflow {
8
8
  is_saved_task: boolean;
9
9
  description?: string;
10
10
  workflow_definition: Skyvern.WorkflowDefinition;
11
- proxy_location?: Skyvern.ProxyLocation;
11
+ proxy_location?: Workflow.ProxyLocation;
12
12
  webhook_callback_url?: string;
13
13
  totp_verification_url?: string;
14
14
  totp_identifier?: string;
@@ -28,3 +28,6 @@ export interface Workflow {
28
28
  modified_at: string;
29
29
  deleted_at?: string;
30
30
  }
31
+ export declare namespace Workflow {
32
+ type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
33
+ }
@@ -2,7 +2,7 @@ import type * as Skyvern from "../index.mjs";
2
2
  export interface WorkflowCreateYamlRequest {
3
3
  title: string;
4
4
  description?: string;
5
- proxy_location?: Skyvern.ProxyLocation;
5
+ proxy_location?: WorkflowCreateYamlRequest.ProxyLocation;
6
6
  webhook_callback_url?: string;
7
7
  totp_verification_url?: string;
8
8
  totp_identifier?: string;
@@ -20,3 +20,6 @@ export interface WorkflowCreateYamlRequest {
20
20
  sequential_key?: string;
21
21
  folder_id?: string;
22
22
  }
23
+ export declare namespace WorkflowCreateYamlRequest {
24
+ type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
25
+ }
@@ -1,5 +1,6 @@
1
1
  import type * as Skyvern from "../index.mjs";
2
2
  export interface WorkflowDefinition {
3
+ version?: number;
3
4
  parameters: Skyvern.WorkflowDefinitionParametersItem[];
4
5
  blocks: Skyvern.WorkflowDefinitionBlocksItem[];
5
6
  }
@@ -1,5 +1,5 @@
1
1
  import type * as Skyvern from "../index.mjs";
2
- export type WorkflowDefinitionBlocksItem = Skyvern.WorkflowDefinitionBlocksItem.Action | Skyvern.WorkflowDefinitionBlocksItem.Code | 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.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.SendEmail | Skyvern.WorkflowDefinitionBlocksItem.Task | Skyvern.WorkflowDefinitionBlocksItem.TaskV2 | Skyvern.WorkflowDefinitionBlocksItem.TextPrompt | Skyvern.WorkflowDefinitionBlocksItem.UploadToS3 | Skyvern.WorkflowDefinitionBlocksItem.Validation | Skyvern.WorkflowDefinitionBlocksItem.Wait;
3
3
  export declare namespace WorkflowDefinitionBlocksItem {
4
4
  interface Action extends Skyvern.ActionBlock {
5
5
  block_type: "action";
@@ -7,6 +7,9 @@ export declare namespace WorkflowDefinitionBlocksItem {
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,5 +1,6 @@
1
1
  import type * as Skyvern from "../index.mjs";
2
2
  export interface WorkflowDefinitionYaml {
3
+ version?: number;
3
4
  parameters: Skyvern.WorkflowDefinitionYamlParametersItem[];
4
5
  blocks: Skyvern.WorkflowDefinitionYamlBlocksItem[];
5
6
  }
@@ -29,8 +29,9 @@ export interface WorkflowRunRequest {
29
29
  * - US-FL: Florida
30
30
  * - US-WA: Washington
31
31
  * - NONE: No proxy
32
+ * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
32
33
  */
33
- proxy_location?: Skyvern.ProxyLocation;
34
+ proxy_location?: WorkflowRunRequest.ProxyLocation;
34
35
  /** URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions. */
35
36
  webhook_url?: string;
36
37
  /**
@@ -56,3 +57,32 @@ export interface WorkflowRunRequest {
56
57
  /** Whether to run the workflow with agent or code. */
57
58
  run_with?: string;
58
59
  }
60
+ export declare namespace WorkflowRunRequest {
61
+ /**
62
+ *
63
+ * Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
64
+ *
65
+ * Available geotargeting options:
66
+ * - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
67
+ * - RESIDENTIAL_ES: Spain
68
+ * - RESIDENTIAL_IE: Ireland
69
+ * - RESIDENTIAL_GB: United Kingdom
70
+ * - RESIDENTIAL_IN: India
71
+ * - RESIDENTIAL_JP: Japan
72
+ * - RESIDENTIAL_FR: France
73
+ * - RESIDENTIAL_DE: Germany
74
+ * - RESIDENTIAL_NZ: New Zealand
75
+ * - RESIDENTIAL_ZA: South Africa
76
+ * - RESIDENTIAL_AR: Argentina
77
+ * - RESIDENTIAL_AU: Australia
78
+ * - RESIDENTIAL_ISP: ISP proxy
79
+ * - US-CA: California
80
+ * - US-NY: New York
81
+ * - US-TX: Texas
82
+ * - US-FL: Florida
83
+ * - US-WA: Washington
84
+ * - NONE: No proxy
85
+ * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
86
+ */
87
+ type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
88
+ }
@@ -19,6 +19,8 @@ export * from "./BitwardenLoginCredentialParameterYaml.mjs";
19
19
  export * from "./BitwardenSensitiveInformationParameter.mjs";
20
20
  export * from "./BitwardenSensitiveInformationParameterYaml.mjs";
21
21
  export * from "./BlockType.mjs";
22
+ export * from "./BranchCondition.mjs";
23
+ export * from "./BranchCriteria.mjs";
22
24
  export * from "./BrowserProfile.mjs";
23
25
  export * from "./BrowserSessionResponse.mjs";
24
26
  export * from "./ClickAction.mjs";
@@ -26,6 +28,7 @@ export * from "./ClickContext.mjs";
26
28
  export * from "./CodeBlock.mjs";
27
29
  export * from "./CodeBlockParametersItem.mjs";
28
30
  export * from "./CodeBlockYaml.mjs";
31
+ export * from "./ConditionalBlock.mjs";
29
32
  export * from "./ContextParameter.mjs";
30
33
  export * from "./ContextParameterSource.mjs";
31
34
  export * from "./ContextParameterYaml.mjs";
@@ -59,6 +62,7 @@ export * from "./ForLoopBlockLoopBlocksItem.mjs";
59
62
  export * from "./ForLoopBlockLoopOver.mjs";
60
63
  export * from "./ForLoopBlockYaml.mjs";
61
64
  export * from "./ForLoopBlockYamlLoopBlocksItem.mjs";
65
+ export * from "./GeoTarget.mjs";
62
66
  export * from "./GetRunResponse.mjs";
63
67
  export * from "./HttpRequestBlock.mjs";
64
68
  export * from "./HttpRequestBlockParametersItem.mjs";
@@ -69,6 +73,7 @@ export * from "./HumanInteractionBlockParametersItem.mjs";
69
73
  export * from "./HumanInteractionBlockYaml.mjs";
70
74
  export * from "./InputOrSelectContext.mjs";
71
75
  export * from "./InputTextAction.mjs";
76
+ export * from "./LocateElementAction.mjs";
72
77
  export * from "./LoginBlock.mjs";
73
78
  export * from "./LoginBlockParametersItem.mjs";
74
79
  export * from "./LoginBlockYaml.mjs";
@@ -19,6 +19,8 @@ export * from "./BitwardenLoginCredentialParameterYaml.mjs";
19
19
  export * from "./BitwardenSensitiveInformationParameter.mjs";
20
20
  export * from "./BitwardenSensitiveInformationParameterYaml.mjs";
21
21
  export * from "./BlockType.mjs";
22
+ export * from "./BranchCondition.mjs";
23
+ export * from "./BranchCriteria.mjs";
22
24
  export * from "./BrowserProfile.mjs";
23
25
  export * from "./BrowserSessionResponse.mjs";
24
26
  export * from "./ClickAction.mjs";
@@ -26,6 +28,7 @@ export * from "./ClickContext.mjs";
26
28
  export * from "./CodeBlock.mjs";
27
29
  export * from "./CodeBlockParametersItem.mjs";
28
30
  export * from "./CodeBlockYaml.mjs";
31
+ export * from "./ConditionalBlock.mjs";
29
32
  export * from "./ContextParameter.mjs";
30
33
  export * from "./ContextParameterSource.mjs";
31
34
  export * from "./ContextParameterYaml.mjs";
@@ -59,6 +62,7 @@ export * from "./ForLoopBlockLoopBlocksItem.mjs";
59
62
  export * from "./ForLoopBlockLoopOver.mjs";
60
63
  export * from "./ForLoopBlockYaml.mjs";
61
64
  export * from "./ForLoopBlockYamlLoopBlocksItem.mjs";
65
+ export * from "./GeoTarget.mjs";
62
66
  export * from "./GetRunResponse.mjs";
63
67
  export * from "./HttpRequestBlock.mjs";
64
68
  export * from "./HttpRequestBlockParametersItem.mjs";
@@ -69,6 +73,7 @@ export * from "./HumanInteractionBlockParametersItem.mjs";
69
73
  export * from "./HumanInteractionBlockYaml.mjs";
70
74
  export * from "./InputOrSelectContext.mjs";
71
75
  export * from "./InputTextAction.mjs";
76
+ export * from "./LocateElementAction.mjs";
72
77
  export * from "./LoginBlock.mjs";
73
78
  export * from "./LoginBlockParametersItem.mjs";
74
79
  export * from "./LoginBlockYaml.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.2.23";
1
+ export declare const SDK_VERSION = "1.0.2";
@@ -1 +1 @@
1
- export const SDK_VERSION = "0.2.23";
1
+ export const SDK_VERSION = "1.0.2";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyvern/client",
3
- "version": "0.2.23",
3
+ "version": "1.0.2",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
package/reference.md CHANGED
@@ -475,249 +475,6 @@ await client.workflows.updateWorkflowFolder("wpid_123");
475
475
  </dl>
476
476
 
477
477
 
478
- </dd>
479
- </dl>
480
- </details>
481
-
482
- ## BrowserProfiles
483
- <details><summary><code>client.browserProfiles.<a href="/src/api/resources/browserProfiles/client/Client.ts">listBrowserProfiles</a>({ ...params }) -> Skyvern.BrowserProfile[]</code></summary>
484
- <dl>
485
- <dd>
486
-
487
- #### 📝 Description
488
-
489
- <dl>
490
- <dd>
491
-
492
- <dl>
493
- <dd>
494
-
495
- Get all browser profiles for the organization
496
- </dd>
497
- </dl>
498
- </dd>
499
- </dl>
500
-
501
- #### 🔌 Usage
502
-
503
- <dl>
504
- <dd>
505
-
506
- <dl>
507
- <dd>
508
-
509
- ```typescript
510
- await client.browserProfiles.listBrowserProfiles({
511
- include_deleted: true
512
- });
513
-
514
- ```
515
- </dd>
516
- </dl>
517
- </dd>
518
- </dl>
519
-
520
- #### ⚙️ Parameters
521
-
522
- <dl>
523
- <dd>
524
-
525
- <dl>
526
- <dd>
527
-
528
- **request:** `Skyvern.ListBrowserProfilesV1BrowserProfilesGetRequest`
529
-
530
- </dd>
531
- </dl>
532
-
533
- <dl>
534
- <dd>
535
-
536
- **requestOptions:** `BrowserProfiles.RequestOptions`
537
-
538
- </dd>
539
- </dl>
540
- </dd>
541
- </dl>
542
-
543
-
544
- </dd>
545
- </dl>
546
- </details>
547
-
548
- <details><summary><code>client.browserProfiles.<a href="/src/api/resources/browserProfiles/client/Client.ts">createBrowserProfile</a>({ ...params }) -> Skyvern.BrowserProfile</code></summary>
549
- <dl>
550
- <dd>
551
-
552
- #### 🔌 Usage
553
-
554
- <dl>
555
- <dd>
556
-
557
- <dl>
558
- <dd>
559
-
560
- ```typescript
561
- await client.browserProfiles.createBrowserProfile({
562
- name: "name"
563
- });
564
-
565
- ```
566
- </dd>
567
- </dl>
568
- </dd>
569
- </dl>
570
-
571
- #### ⚙️ Parameters
572
-
573
- <dl>
574
- <dd>
575
-
576
- <dl>
577
- <dd>
578
-
579
- **request:** `Skyvern.CreateBrowserProfileRequest`
580
-
581
- </dd>
582
- </dl>
583
-
584
- <dl>
585
- <dd>
586
-
587
- **requestOptions:** `BrowserProfiles.RequestOptions`
588
-
589
- </dd>
590
- </dl>
591
- </dd>
592
- </dl>
593
-
594
-
595
- </dd>
596
- </dl>
597
- </details>
598
-
599
- <details><summary><code>client.browserProfiles.<a href="/src/api/resources/browserProfiles/client/Client.ts">getBrowserProfile</a>(profileId) -> Skyvern.BrowserProfile</code></summary>
600
- <dl>
601
- <dd>
602
-
603
- #### 📝 Description
604
-
605
- <dl>
606
- <dd>
607
-
608
- <dl>
609
- <dd>
610
-
611
- Get a specific browser profile by ID
612
- </dd>
613
- </dl>
614
- </dd>
615
- </dl>
616
-
617
- #### 🔌 Usage
618
-
619
- <dl>
620
- <dd>
621
-
622
- <dl>
623
- <dd>
624
-
625
- ```typescript
626
- await client.browserProfiles.getBrowserProfile("bp_123456");
627
-
628
- ```
629
- </dd>
630
- </dl>
631
- </dd>
632
- </dl>
633
-
634
- #### ⚙️ Parameters
635
-
636
- <dl>
637
- <dd>
638
-
639
- <dl>
640
- <dd>
641
-
642
- **profileId:** `string` — The ID of the browser profile. browser_profile_id starts with `bp_`
643
-
644
- </dd>
645
- </dl>
646
-
647
- <dl>
648
- <dd>
649
-
650
- **requestOptions:** `BrowserProfiles.RequestOptions`
651
-
652
- </dd>
653
- </dl>
654
- </dd>
655
- </dl>
656
-
657
-
658
- </dd>
659
- </dl>
660
- </details>
661
-
662
- <details><summary><code>client.browserProfiles.<a href="/src/api/resources/browserProfiles/client/Client.ts">deleteBrowserProfile</a>(profileId) -> void</code></summary>
663
- <dl>
664
- <dd>
665
-
666
- #### 📝 Description
667
-
668
- <dl>
669
- <dd>
670
-
671
- <dl>
672
- <dd>
673
-
674
- Delete a browser profile (soft delete)
675
- </dd>
676
- </dl>
677
- </dd>
678
- </dl>
679
-
680
- #### 🔌 Usage
681
-
682
- <dl>
683
- <dd>
684
-
685
- <dl>
686
- <dd>
687
-
688
- ```typescript
689
- await client.browserProfiles.deleteBrowserProfile("bp_123456");
690
-
691
- ```
692
- </dd>
693
- </dl>
694
- </dd>
695
- </dl>
696
-
697
- #### ⚙️ Parameters
698
-
699
- <dl>
700
- <dd>
701
-
702
- <dl>
703
- <dd>
704
-
705
- **profileId:** `string` — The ID of the browser profile to delete. browser_profile_id starts with `bp_`
706
-
707
- </dd>
708
- </dl>
709
-
710
- <dl>
711
- <dd>
712
-
713
- **requestOptions:** `BrowserProfiles.RequestOptions`
714
-
715
- </dd>
716
- </dl>
717
- </dd>
718
- </dl>
719
-
720
-
721
478
  </dd>
722
479
  </dl>
723
480
  </details>