@skyvern/client 1.0.10 → 1.0.12

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 (125) hide show
  1. package/README.md +0 -1
  2. package/dist/cjs/Client.d.ts +68 -0
  3. package/dist/cjs/Client.js +263 -2
  4. package/dist/cjs/api/client/requests/ChangeTierRequest.d.ts +10 -0
  5. package/dist/cjs/api/client/requests/ChangeTierRequest.js +3 -0
  6. package/dist/cjs/api/client/requests/CheckoutSubscriptionRequest.d.ts +10 -0
  7. package/dist/cjs/api/client/requests/CheckoutSubscriptionRequest.js +3 -0
  8. package/dist/cjs/api/client/requests/CreateBrowserSessionRequest.d.ts +10 -5
  9. package/dist/cjs/api/client/requests/TotpCodeCreate.d.ts +3 -0
  10. package/dist/cjs/api/client/requests/index.d.ts +2 -0
  11. package/dist/cjs/api/types/Action.d.ts +3 -0
  12. package/dist/cjs/api/types/ArtifactType.d.ts +1 -0
  13. package/dist/cjs/api/types/ArtifactType.js +1 -0
  14. package/dist/cjs/api/types/BillingStateResponse.d.ts +19 -0
  15. package/dist/cjs/api/types/BillingStateResponse.js +3 -0
  16. package/dist/cjs/api/types/BlockType.d.ts +1 -0
  17. package/dist/cjs/api/types/BlockType.js +1 -0
  18. package/dist/cjs/api/types/BrowserSessionResponse.d.ts +6 -0
  19. package/dist/cjs/api/types/ChangeTierResponse.d.ts +5 -0
  20. package/dist/cjs/api/types/ChangeTierResponse.js +3 -0
  21. package/dist/cjs/api/types/CheckoutSessionResponse.d.ts +4 -0
  22. package/dist/cjs/api/types/CheckoutSessionResponse.js +3 -0
  23. package/dist/cjs/api/types/Extensions.d.ts +5 -0
  24. package/dist/cjs/api/types/Extensions.js +8 -0
  25. package/dist/cjs/api/types/ForLoopBlockLoopBlocksItem.d.ts +4 -1
  26. package/dist/cjs/api/types/ForLoopBlockYamlLoopBlocksItem.d.ts +4 -1
  27. package/dist/cjs/api/types/HttpRequestBlock.d.ts +2 -0
  28. package/dist/cjs/api/types/HttpRequestBlockYaml.d.ts +2 -0
  29. package/dist/cjs/api/types/InputOrSelectContext.d.ts +1 -0
  30. package/dist/cjs/api/types/PdfFormat.d.ts +7 -0
  31. package/dist/cjs/api/types/PdfFormat.js +10 -0
  32. package/dist/cjs/api/types/PersistentBrowserType.d.ts +5 -0
  33. package/dist/cjs/api/types/PersistentBrowserType.js +8 -0
  34. package/dist/cjs/api/types/PlanTier.d.ts +7 -0
  35. package/dist/cjs/api/types/PlanTier.js +10 -0
  36. package/dist/cjs/api/types/PortalSessionResponse.d.ts +3 -0
  37. package/dist/cjs/api/types/PortalSessionResponse.js +3 -0
  38. package/dist/cjs/api/types/PrintPageBlock.d.ts +18 -0
  39. package/dist/cjs/api/types/PrintPageBlock.js +3 -0
  40. package/dist/cjs/api/types/PrintPageBlockParametersItem.d.ts +37 -0
  41. package/dist/cjs/api/types/PrintPageBlockParametersItem.js +3 -0
  42. package/dist/cjs/api/types/PrintPageBlockYaml.d.ts +16 -0
  43. package/dist/cjs/api/types/PrintPageBlockYaml.js +3 -0
  44. package/dist/cjs/api/types/ProxyLocation.d.ts +1 -0
  45. package/dist/cjs/api/types/ProxyLocation.js +1 -0
  46. package/dist/cjs/api/types/TaskRunRequest.d.ts +14 -10
  47. package/dist/cjs/api/types/TaskRunResponse.d.ts +2 -0
  48. package/dist/cjs/api/types/ThoughtScenario.d.ts +7 -0
  49. package/dist/cjs/api/types/ThoughtScenario.js +7 -0
  50. package/dist/cjs/api/types/ThoughtType.d.ts +7 -0
  51. package/dist/cjs/api/types/ThoughtType.js +7 -0
  52. package/dist/cjs/api/types/TotpCode.d.ts +2 -0
  53. package/dist/cjs/api/types/WorkflowDefinition.d.ts +1 -0
  54. package/dist/cjs/api/types/WorkflowDefinitionBlocksItem.d.ts +4 -1
  55. package/dist/cjs/api/types/WorkflowDefinitionYaml.d.ts +1 -0
  56. package/dist/cjs/api/types/WorkflowDefinitionYamlBlocksItem.d.ts +4 -1
  57. package/dist/cjs/api/types/WorkflowRunRequest.d.ts +12 -10
  58. package/dist/cjs/api/types/WorkflowRunResponse.d.ts +2 -0
  59. package/dist/cjs/api/types/index.d.ts +11 -0
  60. package/dist/cjs/api/types/index.js +11 -0
  61. package/dist/cjs/version.d.ts +1 -1
  62. package/dist/cjs/version.js +1 -1
  63. package/dist/esm/Client.d.mts +68 -0
  64. package/dist/esm/Client.mjs +263 -2
  65. package/dist/esm/api/client/requests/ChangeTierRequest.d.mts +10 -0
  66. package/dist/esm/api/client/requests/ChangeTierRequest.mjs +2 -0
  67. package/dist/esm/api/client/requests/CheckoutSubscriptionRequest.d.mts +10 -0
  68. package/dist/esm/api/client/requests/CheckoutSubscriptionRequest.mjs +2 -0
  69. package/dist/esm/api/client/requests/CreateBrowserSessionRequest.d.mts +10 -5
  70. package/dist/esm/api/client/requests/TotpCodeCreate.d.mts +3 -0
  71. package/dist/esm/api/client/requests/index.d.mts +2 -0
  72. package/dist/esm/api/types/Action.d.mts +3 -0
  73. package/dist/esm/api/types/ArtifactType.d.mts +1 -0
  74. package/dist/esm/api/types/ArtifactType.mjs +1 -0
  75. package/dist/esm/api/types/BillingStateResponse.d.mts +19 -0
  76. package/dist/esm/api/types/BillingStateResponse.mjs +2 -0
  77. package/dist/esm/api/types/BlockType.d.mts +1 -0
  78. package/dist/esm/api/types/BlockType.mjs +1 -0
  79. package/dist/esm/api/types/BrowserSessionResponse.d.mts +6 -0
  80. package/dist/esm/api/types/ChangeTierResponse.d.mts +5 -0
  81. package/dist/esm/api/types/ChangeTierResponse.mjs +2 -0
  82. package/dist/esm/api/types/CheckoutSessionResponse.d.mts +4 -0
  83. package/dist/esm/api/types/CheckoutSessionResponse.mjs +2 -0
  84. package/dist/esm/api/types/Extensions.d.mts +5 -0
  85. package/dist/esm/api/types/Extensions.mjs +5 -0
  86. package/dist/esm/api/types/ForLoopBlockLoopBlocksItem.d.mts +4 -1
  87. package/dist/esm/api/types/ForLoopBlockYamlLoopBlocksItem.d.mts +4 -1
  88. package/dist/esm/api/types/HttpRequestBlock.d.mts +2 -0
  89. package/dist/esm/api/types/HttpRequestBlockYaml.d.mts +2 -0
  90. package/dist/esm/api/types/InputOrSelectContext.d.mts +1 -0
  91. package/dist/esm/api/types/PdfFormat.d.mts +7 -0
  92. package/dist/esm/api/types/PdfFormat.mjs +7 -0
  93. package/dist/esm/api/types/PersistentBrowserType.d.mts +5 -0
  94. package/dist/esm/api/types/PersistentBrowserType.mjs +5 -0
  95. package/dist/esm/api/types/PlanTier.d.mts +7 -0
  96. package/dist/esm/api/types/PlanTier.mjs +7 -0
  97. package/dist/esm/api/types/PortalSessionResponse.d.mts +3 -0
  98. package/dist/esm/api/types/PortalSessionResponse.mjs +2 -0
  99. package/dist/esm/api/types/PrintPageBlock.d.mts +18 -0
  100. package/dist/esm/api/types/PrintPageBlock.mjs +2 -0
  101. package/dist/esm/api/types/PrintPageBlockParametersItem.d.mts +37 -0
  102. package/dist/esm/api/types/PrintPageBlockParametersItem.mjs +2 -0
  103. package/dist/esm/api/types/PrintPageBlockYaml.d.mts +16 -0
  104. package/dist/esm/api/types/PrintPageBlockYaml.mjs +2 -0
  105. package/dist/esm/api/types/ProxyLocation.d.mts +1 -0
  106. package/dist/esm/api/types/ProxyLocation.mjs +1 -0
  107. package/dist/esm/api/types/TaskRunRequest.d.mts +14 -10
  108. package/dist/esm/api/types/TaskRunResponse.d.mts +2 -0
  109. package/dist/esm/api/types/ThoughtScenario.d.mts +7 -0
  110. package/dist/esm/api/types/ThoughtScenario.mjs +7 -0
  111. package/dist/esm/api/types/ThoughtType.d.mts +7 -0
  112. package/dist/esm/api/types/ThoughtType.mjs +7 -0
  113. package/dist/esm/api/types/TotpCode.d.mts +2 -0
  114. package/dist/esm/api/types/WorkflowDefinition.d.mts +1 -0
  115. package/dist/esm/api/types/WorkflowDefinitionBlocksItem.d.mts +4 -1
  116. package/dist/esm/api/types/WorkflowDefinitionYaml.d.mts +1 -0
  117. package/dist/esm/api/types/WorkflowDefinitionYamlBlocksItem.d.mts +4 -1
  118. package/dist/esm/api/types/WorkflowRunRequest.d.mts +12 -10
  119. package/dist/esm/api/types/WorkflowRunResponse.d.mts +2 -0
  120. package/dist/esm/api/types/index.d.mts +11 -0
  121. package/dist/esm/api/types/index.mjs +11 -0
  122. package/dist/esm/version.d.mts +1 -1
  123. package/dist/esm/version.mjs +1 -1
  124. package/package.json +1 -1
  125. package/reference.md +8 -8
@@ -0,0 +1,7 @@
1
+ export declare const PdfFormat: {
2
+ readonly A4: "A4";
3
+ readonly Letter: "Letter";
4
+ readonly Legal: "Legal";
5
+ readonly Tabloid: "Tabloid";
6
+ };
7
+ export type PdfFormat = (typeof PdfFormat)[keyof typeof PdfFormat];
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.PdfFormat = void 0;
5
+ exports.PdfFormat = {
6
+ A4: "A4",
7
+ Letter: "Letter",
8
+ Legal: "Legal",
9
+ Tabloid: "Tabloid",
10
+ };
@@ -0,0 +1,5 @@
1
+ export declare const PersistentBrowserType: {
2
+ readonly Msedge: "msedge";
3
+ readonly Chrome: "chrome";
4
+ };
5
+ export type PersistentBrowserType = (typeof PersistentBrowserType)[keyof typeof PersistentBrowserType];
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.PersistentBrowserType = void 0;
5
+ exports.PersistentBrowserType = {
6
+ Msedge: "msedge",
7
+ Chrome: "chrome",
8
+ };
@@ -0,0 +1,7 @@
1
+ /** Self-serve subscription tiers. Enterprise customers use manual billing (bypass). */
2
+ export declare const PlanTier: {
3
+ readonly Free: "free";
4
+ readonly Hobby: "hobby";
5
+ readonly Pro: "pro";
6
+ };
7
+ export type PlanTier = (typeof PlanTier)[keyof typeof PlanTier];
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.PlanTier = void 0;
5
+ /** Self-serve subscription tiers. Enterprise customers use manual billing (bypass). */
6
+ exports.PlanTier = {
7
+ Free: "free",
8
+ Hobby: "hobby",
9
+ Pro: "pro",
10
+ };
@@ -0,0 +1,3 @@
1
+ export interface PortalSessionResponse {
2
+ url: string;
3
+ }
@@ -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 });
@@ -0,0 +1,18 @@
1
+ import type * as Skyvern from "../index.js";
2
+ export interface PrintPageBlock {
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
+ include_timestamp?: boolean;
13
+ custom_filename?: string;
14
+ format?: string;
15
+ landscape?: boolean;
16
+ print_background?: boolean;
17
+ parameters?: Skyvern.PrintPageBlockParametersItem[];
18
+ }
@@ -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 });
@@ -0,0 +1,37 @@
1
+ import type * as Skyvern from "../index.js";
2
+ export type PrintPageBlockParametersItem = Skyvern.PrintPageBlockParametersItem.AwsSecret | Skyvern.PrintPageBlockParametersItem.AzureSecret | Skyvern.PrintPageBlockParametersItem.AzureVaultCredential | Skyvern.PrintPageBlockParametersItem.BitwardenCreditCardData | Skyvern.PrintPageBlockParametersItem.BitwardenLoginCredential | Skyvern.PrintPageBlockParametersItem.BitwardenSensitiveInformation | Skyvern.PrintPageBlockParametersItem.Context | Skyvern.PrintPageBlockParametersItem.Credential | Skyvern.PrintPageBlockParametersItem.Onepassword | Skyvern.PrintPageBlockParametersItem.Output | Skyvern.PrintPageBlockParametersItem.Workflow;
3
+ export declare namespace PrintPageBlockParametersItem {
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,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,16 @@
1
+ import type * as Skyvern from "../index.js";
2
+ export interface PrintPageBlockYaml {
3
+ /** Author-facing identifier; must be unique per workflow. */
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;
7
+ continue_on_failure?: boolean;
8
+ model?: Record<string, unknown>;
9
+ next_loop_on_failure?: boolean;
10
+ include_timestamp?: boolean;
11
+ custom_filename?: string;
12
+ format?: Skyvern.PdfFormat;
13
+ landscape?: boolean;
14
+ print_background?: boolean;
15
+ parameter_keys?: string[];
16
+ }
@@ -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 });
@@ -22,6 +22,7 @@ export declare const ProxyLocation: {
22
22
  readonly ResidentialMx: "RESIDENTIAL_MX";
23
23
  readonly ResidentialIt: "RESIDENTIAL_IT";
24
24
  readonly ResidentialNl: "RESIDENTIAL_NL";
25
+ readonly ResidentialPh: "RESIDENTIAL_PH";
25
26
  readonly ResidentialIsp: "RESIDENTIAL_ISP";
26
27
  readonly None: "NONE";
27
28
  };
@@ -26,6 +26,7 @@ exports.ProxyLocation = {
26
26
  ResidentialMx: "RESIDENTIAL_MX",
27
27
  ResidentialIt: "RESIDENTIAL_IT",
28
28
  ResidentialNl: "RESIDENTIAL_NL",
29
+ ResidentialPh: "RESIDENTIAL_PH",
29
30
  ResidentialIsp: "RESIDENTIAL_ISP",
30
31
  None: "NONE",
31
32
  };
@@ -27,15 +27,16 @@ export interface TaskRunRequest {
27
27
  * - RESIDENTIAL_FR: France
28
28
  * - RESIDENTIAL_DE: Germany
29
29
  * - RESIDENTIAL_NZ: New Zealand
30
+ * - RESIDENTIAL_PH: Philippines
30
31
  * - RESIDENTIAL_ZA: South Africa
31
32
  * - RESIDENTIAL_AR: Argentina
32
33
  * - RESIDENTIAL_AU: Australia
33
34
  * - RESIDENTIAL_ISP: ISP proxy
34
- * - US-CA: California
35
- * - US-NY: New York
36
- * - US-TX: Texas
37
- * - US-FL: Florida
38
- * - US-WA: Washington
35
+ * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
36
+ * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
37
+ * - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
38
+ * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
39
+ * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
39
40
  * - NONE: No proxy
40
41
  * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
41
42
  */
@@ -82,6 +83,8 @@ export interface TaskRunRequest {
82
83
  max_screenshot_scrolls?: number;
83
84
  /** The CDP address for the task. */
84
85
  browser_address?: string;
86
+ /** Whether to run the task with agent or code. */
87
+ run_with?: string;
85
88
  }
86
89
  export declare namespace TaskRunRequest {
87
90
  /**
@@ -98,15 +101,16 @@ export declare namespace TaskRunRequest {
98
101
  * - RESIDENTIAL_FR: France
99
102
  * - RESIDENTIAL_DE: Germany
100
103
  * - RESIDENTIAL_NZ: New Zealand
104
+ * - RESIDENTIAL_PH: Philippines
101
105
  * - RESIDENTIAL_ZA: South Africa
102
106
  * - RESIDENTIAL_AR: Argentina
103
107
  * - RESIDENTIAL_AU: Australia
104
108
  * - 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
109
+ * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
110
+ * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
111
+ * - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
112
+ * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
113
+ * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
110
114
  * - NONE: No proxy
111
115
  * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
112
116
  */
@@ -36,6 +36,8 @@ export interface TaskRunResponse {
36
36
  script_run?: Skyvern.ScriptRunResponse;
37
37
  /** The errors for the run */
38
38
  errors?: Record<string, unknown>[];
39
+ /** Total number of steps executed in this run */
40
+ step_count?: number;
39
41
  /** The original request parameters used to start this task run */
40
42
  run_request?: Skyvern.TaskRunRequest;
41
43
  }
@@ -1,3 +1,9 @@
1
+ /**
2
+ * Scenario in which a thought was generated.
3
+ *
4
+ * Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values
5
+ * can be added without database migrations. See observer_thoughts.observer_thought_scenario column.
6
+ */
1
7
  export declare const ThoughtScenario: {
2
8
  readonly GeneratePlan: "generate_plan";
3
9
  readonly UserGoalCheck: "user_goal_check";
@@ -7,5 +13,6 @@ export declare const ThoughtScenario: {
7
13
  readonly ExtractLoopValues: "extract_loop_values";
8
14
  readonly GenerateTaskInLoop: "generate_task_in_loop";
9
15
  readonly GenerateGeneralTask: "generate_general_task";
16
+ readonly Termination: "termination";
10
17
  };
11
18
  export type ThoughtScenario = (typeof ThoughtScenario)[keyof typeof ThoughtScenario];
@@ -2,6 +2,12 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.ThoughtScenario = void 0;
5
+ /**
6
+ * Scenario in which a thought was generated.
7
+ *
8
+ * Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values
9
+ * can be added without database migrations. See observer_thoughts.observer_thought_scenario column.
10
+ */
5
11
  exports.ThoughtScenario = {
6
12
  GeneratePlan: "generate_plan",
7
13
  UserGoalCheck: "user_goal_check",
@@ -11,4 +17,5 @@ exports.ThoughtScenario = {
11
17
  ExtractLoopValues: "extract_loop_values",
12
18
  GenerateTaskInLoop: "generate_task_in_loop",
13
19
  GenerateGeneralTask: "generate_general_task",
20
+ Termination: "termination",
14
21
  };
@@ -1,8 +1,15 @@
1
+ /**
2
+ * Type of thought recorded during task execution.
3
+ *
4
+ * Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values
5
+ * can be added without database migrations. See observer_thoughts.observer_thought_type column.
6
+ */
1
7
  export declare const ThoughtType: {
2
8
  readonly Plan: "plan";
3
9
  readonly Metadata: "metadata";
4
10
  readonly UserGoalCheck: "user_goal_check";
5
11
  readonly InternalPlan: "internal_plan";
6
12
  readonly FailureDescribe: "failure_describe";
13
+ readonly Termination: "termination";
7
14
  };
8
15
  export type ThoughtType = (typeof ThoughtType)[keyof typeof ThoughtType];
@@ -2,10 +2,17 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.ThoughtType = void 0;
5
+ /**
6
+ * Type of thought recorded during task execution.
7
+ *
8
+ * Note: Stored as VARCHAR in the database (not a PostgreSQL ENUM), so new values
9
+ * can be added without database migrations. See observer_thoughts.observer_thought_type column.
10
+ */
5
11
  exports.ThoughtType = {
6
12
  Plan: "plan",
7
13
  Metadata: "metadata",
8
14
  UserGoalCheck: "user_goal_check",
9
15
  InternalPlan: "internal_plan",
10
16
  FailureDescribe: "failure_describe",
17
+ Termination: "termination",
11
18
  };
@@ -14,6 +14,8 @@ export interface TotpCode {
14
14
  content: string;
15
15
  /** The timestamp when the TOTP code expires */
16
16
  expired_at?: string;
17
+ /** Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract. */
18
+ type?: Skyvern.OtpType;
17
19
  /** The skyvern ID of the TOTP code. */
18
20
  totp_code_id: string;
19
21
  /** The TOTP code extracted from the content. */
@@ -3,4 +3,5 @@ export interface WorkflowDefinition {
3
3
  version?: number;
4
4
  parameters: Skyvern.WorkflowDefinitionParametersItem[];
5
5
  blocks: Skyvern.WorkflowDefinitionBlocksItem[];
6
+ finally_block_label?: string;
6
7
  }
@@ -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.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;
3
3
  export declare namespace WorkflowDefinitionBlocksItem {
4
4
  interface Action extends Skyvern.ActionBlock {
5
5
  block_type: "action";
@@ -46,6 +46,9 @@ export declare namespace WorkflowDefinitionBlocksItem {
46
46
  interface PdfParser extends Skyvern.PdfParserBlock {
47
47
  block_type: "pdf_parser";
48
48
  }
49
+ interface PrintPage extends Skyvern.PrintPageBlock {
50
+ block_type: "print_page";
51
+ }
49
52
  interface SendEmail extends Skyvern.SendEmailBlock {
50
53
  block_type: "send_email";
51
54
  }
@@ -3,4 +3,5 @@ export interface WorkflowDefinitionYaml {
3
3
  version?: number;
4
4
  parameters: Skyvern.WorkflowDefinitionYamlParametersItem[];
5
5
  blocks: Skyvern.WorkflowDefinitionYamlBlocksItem[];
6
+ finally_block_label?: string;
6
7
  }
@@ -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.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;
3
3
  export declare namespace WorkflowDefinitionYamlBlocksItem {
4
4
  interface Action extends Skyvern.ActionBlockYaml {
5
5
  block_type: "action";
@@ -46,6 +46,9 @@ export declare namespace WorkflowDefinitionYamlBlocksItem {
46
46
  interface PdfParser extends Skyvern.PdfParserBlockYaml {
47
47
  block_type: "pdf_parser";
48
48
  }
49
+ interface PrintPage extends Skyvern.PrintPageBlockYaml {
50
+ block_type: "print_page";
51
+ }
49
52
  interface SendEmail extends Skyvern.SendEmailBlockYaml {
50
53
  block_type: "send_email";
51
54
  }
@@ -19,15 +19,16 @@ export interface WorkflowRunRequest {
19
19
  * - RESIDENTIAL_FR: France
20
20
  * - RESIDENTIAL_DE: Germany
21
21
  * - RESIDENTIAL_NZ: New Zealand
22
+ * - RESIDENTIAL_PH: Philippines
22
23
  * - RESIDENTIAL_ZA: South Africa
23
24
  * - RESIDENTIAL_AR: Argentina
24
25
  * - RESIDENTIAL_AU: Australia
25
26
  * - RESIDENTIAL_ISP: ISP proxy
26
- * - US-CA: California
27
- * - US-NY: New York
28
- * - US-TX: Texas
29
- * - US-FL: Florida
30
- * - US-WA: Washington
27
+ * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
28
+ * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
29
+ * - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
30
+ * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
31
+ * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
31
32
  * - NONE: No proxy
32
33
  * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
33
34
  */
@@ -72,15 +73,16 @@ export declare namespace WorkflowRunRequest {
72
73
  * - RESIDENTIAL_FR: France
73
74
  * - RESIDENTIAL_DE: Germany
74
75
  * - RESIDENTIAL_NZ: New Zealand
76
+ * - RESIDENTIAL_PH: Philippines
75
77
  * - RESIDENTIAL_ZA: South Africa
76
78
  * - RESIDENTIAL_AR: Argentina
77
79
  * - RESIDENTIAL_AU: Australia
78
80
  * - 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
81
+ * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
82
+ * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
83
+ * - US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
84
+ * - US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
85
+ * - US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
84
86
  * - NONE: No proxy
85
87
  * Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
86
88
  */
@@ -36,6 +36,8 @@ export interface WorkflowRunResponse {
36
36
  script_run?: Skyvern.ScriptRunResponse;
37
37
  /** The errors for the run */
38
38
  errors?: Record<string, unknown>[];
39
+ /** Total number of steps executed in this run */
40
+ step_count?: number;
39
41
  /** Whether the workflow run was executed with agent or code */
40
42
  run_with?: string;
41
43
  /** Whether to fallback to AI if code run fails. */
@@ -12,6 +12,7 @@ export * from "./AwsSecretParameterYaml.js";
12
12
  export * from "./AzureSecretParameter.js";
13
13
  export * from "./AzureVaultCredentialParameter.js";
14
14
  export * from "./AzureVaultCredentialParameterYaml.js";
15
+ export * from "./BillingStateResponse.js";
15
16
  export * from "./BitwardenCreditCardDataParameter.js";
16
17
  export * from "./BitwardenCreditCardDataParameterYaml.js";
17
18
  export * from "./BitwardenLoginCredentialParameter.js";
@@ -25,6 +26,8 @@ export * from "./BranchConditionYaml.js";
25
26
  export * from "./BranchCriteriaYaml.js";
26
27
  export * from "./BrowserProfile.js";
27
28
  export * from "./BrowserSessionResponse.js";
29
+ export * from "./ChangeTierResponse.js";
30
+ export * from "./CheckoutSessionResponse.js";
28
31
  export * from "./ClickAction.js";
29
32
  export * from "./ClickContext.js";
30
33
  export * from "./CodeBlock.js";
@@ -43,6 +46,7 @@ export * from "./CredentialTypeOutput.js";
43
46
  export * from "./CreditCardCredentialResponse.js";
44
47
  export * from "./DownloadToS3Block.js";
45
48
  export * from "./DownloadToS3BlockYaml.js";
49
+ export * from "./Extensions.js";
46
50
  export * from "./ExtractAction.js";
47
51
  export * from "./ExtractionBlock.js";
48
52
  export * from "./ExtractionBlockParametersItem.js";
@@ -91,8 +95,15 @@ export * from "./OtpType.js";
91
95
  export * from "./OutputParameter.js";
92
96
  export * from "./OutputParameterYaml.js";
93
97
  export * from "./PasswordCredentialResponse.js";
98
+ export * from "./PdfFormat.js";
94
99
  export * from "./PdfParserBlock.js";
95
100
  export * from "./PdfParserBlockYaml.js";
101
+ export * from "./PersistentBrowserType.js";
102
+ export * from "./PlanTier.js";
103
+ export * from "./PortalSessionResponse.js";
104
+ export * from "./PrintPageBlock.js";
105
+ export * from "./PrintPageBlockParametersItem.js";
106
+ export * from "./PrintPageBlockYaml.js";
96
107
  export * from "./PromptAction.js";
97
108
  export * from "./PromptBranchCriteria.js";
98
109
  export * from "./ProxyLocation.js";
@@ -28,6 +28,7 @@ __exportStar(require("./AwsSecretParameterYaml.js"), exports);
28
28
  __exportStar(require("./AzureSecretParameter.js"), exports);
29
29
  __exportStar(require("./AzureVaultCredentialParameter.js"), exports);
30
30
  __exportStar(require("./AzureVaultCredentialParameterYaml.js"), exports);
31
+ __exportStar(require("./BillingStateResponse.js"), exports);
31
32
  __exportStar(require("./BitwardenCreditCardDataParameter.js"), exports);
32
33
  __exportStar(require("./BitwardenCreditCardDataParameterYaml.js"), exports);
33
34
  __exportStar(require("./BitwardenLoginCredentialParameter.js"), exports);
@@ -41,6 +42,8 @@ __exportStar(require("./BranchConditionYaml.js"), exports);
41
42
  __exportStar(require("./BranchCriteriaYaml.js"), exports);
42
43
  __exportStar(require("./BrowserProfile.js"), exports);
43
44
  __exportStar(require("./BrowserSessionResponse.js"), exports);
45
+ __exportStar(require("./ChangeTierResponse.js"), exports);
46
+ __exportStar(require("./CheckoutSessionResponse.js"), exports);
44
47
  __exportStar(require("./ClickAction.js"), exports);
45
48
  __exportStar(require("./ClickContext.js"), exports);
46
49
  __exportStar(require("./CodeBlock.js"), exports);
@@ -59,6 +62,7 @@ __exportStar(require("./CredentialTypeOutput.js"), exports);
59
62
  __exportStar(require("./CreditCardCredentialResponse.js"), exports);
60
63
  __exportStar(require("./DownloadToS3Block.js"), exports);
61
64
  __exportStar(require("./DownloadToS3BlockYaml.js"), exports);
65
+ __exportStar(require("./Extensions.js"), exports);
62
66
  __exportStar(require("./ExtractAction.js"), exports);
63
67
  __exportStar(require("./ExtractionBlock.js"), exports);
64
68
  __exportStar(require("./ExtractionBlockParametersItem.js"), exports);
@@ -107,8 +111,15 @@ __exportStar(require("./OtpType.js"), exports);
107
111
  __exportStar(require("./OutputParameter.js"), exports);
108
112
  __exportStar(require("./OutputParameterYaml.js"), exports);
109
113
  __exportStar(require("./PasswordCredentialResponse.js"), exports);
114
+ __exportStar(require("./PdfFormat.js"), exports);
110
115
  __exportStar(require("./PdfParserBlock.js"), exports);
111
116
  __exportStar(require("./PdfParserBlockYaml.js"), exports);
117
+ __exportStar(require("./PersistentBrowserType.js"), exports);
118
+ __exportStar(require("./PlanTier.js"), exports);
119
+ __exportStar(require("./PortalSessionResponse.js"), exports);
120
+ __exportStar(require("./PrintPageBlock.js"), exports);
121
+ __exportStar(require("./PrintPageBlockParametersItem.js"), exports);
122
+ __exportStar(require("./PrintPageBlockYaml.js"), exports);
112
123
  __exportStar(require("./PromptAction.js"), exports);
113
124
  __exportStar(require("./PromptBranchCriteria.js"), exports);
114
125
  __exportStar(require("./ProxyLocation.js"), exports);
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.10";
1
+ export declare const SDK_VERSION = "1.0.12";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.0.10";
4
+ exports.SDK_VERSION = "1.0.12";
@@ -528,4 +528,72 @@ export declare class SkyvernClient {
528
528
  */
529
529
  runSdkAction(request: Skyvern.RunSdkActionRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.RunSdkActionResponse>;
530
530
  private __runSdkAction;
531
+ /**
532
+ * Create a Stripe Checkout Session for subscribing to a tier.
533
+ *
534
+ * Frontend should redirect the user to the returned URL.
535
+ * After successful checkout, Stripe will send a webhook that we handle
536
+ * to store the subscription and initialize billing state.
537
+ *
538
+ * Returns 400 if org already has an active subscription (use portal instead).
539
+ *
540
+ * @param {Skyvern.CheckoutSubscriptionRequest} request
541
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
542
+ *
543
+ * @throws {@link Skyvern.UnprocessableEntityError}
544
+ *
545
+ * @example
546
+ * await client.createCheckoutSessionApiV1BillingCheckoutPost({
547
+ * tier: "free"
548
+ * })
549
+ */
550
+ createCheckoutSessionApiV1BillingCheckoutPost(request: Skyvern.CheckoutSubscriptionRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.CheckoutSessionResponse>;
551
+ private __createCheckoutSessionApiV1BillingCheckoutPost;
552
+ /**
553
+ * Create a Stripe Customer Portal session for managing subscription.
554
+ *
555
+ * Frontend should redirect the user to the returned URL.
556
+ * The portal allows users to:
557
+ * - Update payment methods
558
+ * - Upgrade/downgrade plans
559
+ * - Cancel subscription
560
+ * - View invoices
561
+ *
562
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
563
+ *
564
+ * @throws {@link Skyvern.UnprocessableEntityError}
565
+ *
566
+ * @example
567
+ * await client.createPortalSessionApiV1BillingPortalPost()
568
+ */
569
+ createPortalSessionApiV1BillingPortalPost(requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.PortalSessionResponse>;
570
+ private __createPortalSessionApiV1BillingPortalPost;
571
+ /**
572
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
573
+ *
574
+ * @throws {@link Skyvern.UnprocessableEntityError}
575
+ *
576
+ * @example
577
+ * await client.getOrganizationBillingApiV1BillingStateGet()
578
+ */
579
+ getOrganizationBillingApiV1BillingStateGet(requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.BillingStateResponse | undefined>;
580
+ private __getOrganizationBillingApiV1BillingStateGet;
581
+ /**
582
+ * Redirect to Stripe Portal for tier changes.
583
+ * Portal handles proration based on configured settings:
584
+ * - Upgrades: Immediate proration charge
585
+ * - Downgrades: Apply at end of billing period
586
+ *
587
+ * @param {Skyvern.ChangeTierRequest} request
588
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
589
+ *
590
+ * @throws {@link Skyvern.UnprocessableEntityError}
591
+ *
592
+ * @example
593
+ * await client.changeTierApiV1BillingChangeTierPost({
594
+ * tier: "free"
595
+ * })
596
+ */
597
+ changeTierApiV1BillingChangeTierPost(request: Skyvern.ChangeTierRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.ChangeTierResponse>;
598
+ private __changeTierApiV1BillingChangeTierPost;
531
599
  }