@skyvern/client 1.0.55 → 1.0.57

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 (76) hide show
  1. package/dist/cjs/Client.d.ts +19 -0
  2. package/dist/cjs/Client.js +76 -2
  3. package/dist/cjs/api/client/requests/CreateBrowserSessionRequest.d.ts +1 -1
  4. package/dist/cjs/api/client/requests/ExtendBrowserSessionRequest.d.ts +10 -0
  5. package/dist/cjs/api/client/requests/ExtendBrowserSessionRequest.js +3 -0
  6. package/dist/cjs/api/client/requests/TotpCodeCreate.d.ts +1 -1
  7. package/dist/cjs/api/client/requests/index.d.ts +1 -0
  8. package/dist/cjs/api/resources/schedules/client/Client.d.ts +20 -2
  9. package/dist/cjs/api/resources/schedules/client/Client.js +66 -2
  10. package/dist/cjs/api/types/ArtifactType.d.ts +8 -0
  11. package/dist/cjs/api/types/ArtifactType.js +8 -0
  12. package/dist/cjs/api/types/ClickContext.d.ts +1 -0
  13. package/dist/cjs/api/types/CodeBlock.d.ts +8 -0
  14. package/dist/cjs/api/types/CodeBlockYaml.d.ts +8 -0
  15. package/dist/cjs/api/types/CreateCredentialRequest.d.ts +2 -0
  16. package/dist/cjs/api/types/GetRunResponse.d.ts +4 -1
  17. package/dist/cjs/api/types/HumanInteractionBlockYaml.d.ts +4 -4
  18. package/dist/cjs/api/types/OneTimeDispatchStatus.d.ts +7 -0
  19. package/dist/cjs/api/types/OneTimeDispatchStatus.js +10 -0
  20. package/dist/cjs/api/types/OrganizationScheduleItem.d.ts +7 -1
  21. package/dist/cjs/api/types/RunEngine.d.ts +1 -0
  22. package/dist/cjs/api/types/RunEngine.js +1 -0
  23. package/dist/cjs/api/types/RunStatus.d.ts +1 -0
  24. package/dist/cjs/api/types/RunStatus.js +1 -0
  25. package/dist/cjs/api/types/RunType.d.ts +1 -0
  26. package/dist/cjs/api/types/RunType.js +1 -0
  27. package/dist/cjs/api/types/SendEmailBlock.d.ts +4 -0
  28. package/dist/cjs/api/types/SendEmailBlockYaml.d.ts +8 -4
  29. package/dist/cjs/api/types/TotpCode.d.ts +1 -1
  30. package/dist/cjs/api/types/TotpType.d.ts +1 -0
  31. package/dist/cjs/api/types/TotpType.js +1 -0
  32. package/dist/cjs/api/types/WorkflowSchedule.d.ts +7 -1
  33. package/dist/cjs/api/types/WorkflowScheduleUpsertRequest.d.ts +7 -1
  34. package/dist/cjs/api/types/index.d.ts +1 -0
  35. package/dist/cjs/api/types/index.js +1 -0
  36. package/dist/cjs/version.d.ts +1 -1
  37. package/dist/cjs/version.js +1 -1
  38. package/dist/esm/Client.d.mts +19 -0
  39. package/dist/esm/Client.mjs +76 -2
  40. package/dist/esm/api/client/requests/CreateBrowserSessionRequest.d.mts +1 -1
  41. package/dist/esm/api/client/requests/ExtendBrowserSessionRequest.d.mts +10 -0
  42. package/dist/esm/api/client/requests/ExtendBrowserSessionRequest.mjs +2 -0
  43. package/dist/esm/api/client/requests/TotpCodeCreate.d.mts +1 -1
  44. package/dist/esm/api/client/requests/index.d.mts +1 -0
  45. package/dist/esm/api/resources/schedules/client/Client.d.mts +20 -2
  46. package/dist/esm/api/resources/schedules/client/Client.mjs +66 -2
  47. package/dist/esm/api/types/ArtifactType.d.mts +8 -0
  48. package/dist/esm/api/types/ArtifactType.mjs +8 -0
  49. package/dist/esm/api/types/ClickContext.d.mts +1 -0
  50. package/dist/esm/api/types/CodeBlock.d.mts +8 -0
  51. package/dist/esm/api/types/CodeBlockYaml.d.mts +8 -0
  52. package/dist/esm/api/types/CreateCredentialRequest.d.mts +2 -0
  53. package/dist/esm/api/types/GetRunResponse.d.mts +4 -1
  54. package/dist/esm/api/types/HumanInteractionBlockYaml.d.mts +4 -4
  55. package/dist/esm/api/types/OneTimeDispatchStatus.d.mts +7 -0
  56. package/dist/esm/api/types/OneTimeDispatchStatus.mjs +7 -0
  57. package/dist/esm/api/types/OrganizationScheduleItem.d.mts +7 -1
  58. package/dist/esm/api/types/RunEngine.d.mts +1 -0
  59. package/dist/esm/api/types/RunEngine.mjs +1 -0
  60. package/dist/esm/api/types/RunStatus.d.mts +1 -0
  61. package/dist/esm/api/types/RunStatus.mjs +1 -0
  62. package/dist/esm/api/types/RunType.d.mts +1 -0
  63. package/dist/esm/api/types/RunType.mjs +1 -0
  64. package/dist/esm/api/types/SendEmailBlock.d.mts +4 -0
  65. package/dist/esm/api/types/SendEmailBlockYaml.d.mts +8 -4
  66. package/dist/esm/api/types/TotpCode.d.mts +1 -1
  67. package/dist/esm/api/types/TotpType.d.mts +1 -0
  68. package/dist/esm/api/types/TotpType.mjs +1 -0
  69. package/dist/esm/api/types/WorkflowSchedule.d.mts +7 -1
  70. package/dist/esm/api/types/WorkflowScheduleUpsertRequest.d.mts +7 -1
  71. package/dist/esm/api/types/index.d.mts +1 -0
  72. package/dist/esm/api/types/index.mjs +1 -0
  73. package/dist/esm/version.d.mts +1 -1
  74. package/dist/esm/version.mjs +1 -1
  75. package/package.json +9 -6
  76. package/reference.md +113 -2
@@ -7,10 +7,14 @@ export interface SendEmailBlockYaml {
7
7
  model?: Record<string, unknown>;
8
8
  ignore_workflow_system_prompt?: boolean;
9
9
  next_loop_on_failure?: boolean;
10
- smtp_host_secret_parameter_key: string;
11
- smtp_port_secret_parameter_key: string;
12
- smtp_username_secret_parameter_key: string;
13
- smtp_password_secret_parameter_key: string;
10
+ smtp_host_secret_parameter_key?: string;
11
+ smtp_port_secret_parameter_key?: string;
12
+ smtp_username_secret_parameter_key?: string;
13
+ smtp_password_secret_parameter_key?: string;
14
+ custom_smtp_host?: string;
15
+ custom_smtp_port?: number;
16
+ custom_smtp_username?: string;
17
+ custom_smtp_password?: string;
14
18
  sender: string;
15
19
  recipients: string[];
16
20
  subject: string;
@@ -14,7 +14,7 @@ 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. */
17
+ /** Deprecated compatibility field. Skyvern auto-detects the OTP type from content, so this value does not constrain extraction. */
18
18
  type?: Skyvern.OtpType;
19
19
  /** The skyvern ID of the TOTP code. */
20
20
  totp_code_id: string;
@@ -3,6 +3,7 @@ export declare const TotpType: {
3
3
  readonly Authenticator: "authenticator";
4
4
  readonly Email: "email";
5
5
  readonly Text: "text";
6
+ readonly Passkey: "passkey";
6
7
  readonly None: "none";
7
8
  };
8
9
  export type TotpType = (typeof TotpType)[keyof typeof TotpType];
@@ -4,5 +4,6 @@ export const TotpType = {
4
4
  Authenticator: "authenticator",
5
5
  Email: "email",
6
6
  Text: "text",
7
+ Passkey: "passkey",
7
8
  None: "none",
8
9
  };
@@ -1,8 +1,14 @@
1
+ import type * as Skyvern from "../index.mjs";
1
2
  export interface WorkflowSchedule {
2
3
  workflow_schedule_id: string;
3
4
  organization_id: string;
4
5
  workflow_permanent_id: string;
5
- cron_expression: string;
6
+ cron_expression?: string;
7
+ interval_seconds?: number;
8
+ first_fire_at?: string;
9
+ run_at?: string;
10
+ dispatch_status?: Skyvern.OneTimeDispatchStatus;
11
+ workflow_run_id?: string;
6
12
  timezone: string;
7
13
  enabled: boolean;
8
14
  parameters?: Record<string, unknown>;
@@ -1,5 +1,11 @@
1
1
  export interface WorkflowScheduleUpsertRequest {
2
- cron_expression: string;
2
+ cron_expression?: string;
3
+ /** Fixed elapsed interval between runs, in seconds. Mutually exclusive with cron_expression. */
4
+ interval_seconds?: number;
5
+ /** First run of an interval schedule; later runs follow every interval_seconds from it. Must be in the future when changed. Defaults to one interval after creation. */
6
+ first_fire_at?: string;
7
+ /** Run the agent once at this instant, ISO 8601 with a UTC offset, at least 60 seconds in the future. Mutually exclusive with cron_expression and interval_seconds; the schedule can be edited or canceled only until it fires. */
8
+ run_at?: string;
3
9
  timezone: string;
4
10
  enabled?: boolean;
5
11
  parameters?: Record<string, unknown>;
@@ -112,6 +112,7 @@ export * from "./NonEmptyCreditCardCredential.mjs";
112
112
  export * from "./NonEmptyPasswordCredential.mjs";
113
113
  export * from "./OnePasswordCredentialParameter.mjs";
114
114
  export * from "./OnePasswordCredentialParameterYaml.mjs";
115
+ export * from "./OneTimeDispatchStatus.mjs";
115
116
  export * from "./OrganizationScheduleItem.mjs";
116
117
  export * from "./OrganizationScheduleListResponse.mjs";
117
118
  export * from "./OtpType.mjs";
@@ -112,6 +112,7 @@ export * from "./NonEmptyCreditCardCredential.mjs";
112
112
  export * from "./NonEmptyPasswordCredential.mjs";
113
113
  export * from "./OnePasswordCredentialParameter.mjs";
114
114
  export * from "./OnePasswordCredentialParameterYaml.mjs";
115
+ export * from "./OneTimeDispatchStatus.mjs";
115
116
  export * from "./OrganizationScheduleItem.mjs";
116
117
  export * from "./OrganizationScheduleListResponse.mjs";
117
118
  export * from "./OtpType.mjs";
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.0.47";
1
+ export declare const SDK_VERSION = "1.0.55";
@@ -1 +1 @@
1
- export const SDK_VERSION = "1.0.47";
1
+ export const SDK_VERSION = "1.0.55";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyvern/client",
3
- "version": "1.0.55",
3
+ "version": "1.0.57",
4
4
  "private": false,
5
5
  "repository": {
6
6
  "type": "git",
@@ -52,7 +52,8 @@
52
52
  "devDependencies": {
53
53
  "webpack": "^5.97.1",
54
54
  "ts-loader": "^9.5.1",
55
- "vitest": "^4.1.11",
55
+ "vitest": "^4.1.12",
56
+ "vite": "^7.3.7",
56
57
  "msw": "2.11.2",
57
58
  "@types/node": "^18.19.70",
58
59
  "typescript": "~5.7.2",
@@ -76,11 +77,13 @@
76
77
  },
77
78
  "pnpm": {
78
79
  "overrides": {
79
- "vitest": "^4.1.11",
80
- "vite": "^7.3.5",
80
+ "vitest": "^4.1.12",
81
+ "vite": "^7.3.7",
81
82
  "rollup": "^4.59.0",
82
- "serialize-javascript": "^7.0.3",
83
- "fast-uri": "^3.1.2"
83
+ "serialize-javascript": "^7.1.3",
84
+ "fast-uri": "^3.1.9",
85
+ "source-map-js": "^1.2.2",
86
+ "ajv": "^8.18.0"
84
87
  }
85
88
  }
86
89
  }
package/reference.md CHANGED
@@ -309,6 +309,20 @@ await client.schedules.list("workflow_permanent_id");
309
309
  <dl>
310
310
  <dd>
311
311
 
312
+ #### 📝 Description
313
+
314
+ <dl>
315
+ <dd>
316
+
317
+ <dl>
318
+ <dd>
319
+
320
+ Create a cron, fixed-interval or one-time schedule that runs the given agent automatically with a fixed set of parameters. An interval schedule first runs at first_fire_at, or one interval after creation. A one-time schedule runs once at run_at. Returns the stored schedule and its next upcoming run times.
321
+ </dd>
322
+ </dl>
323
+ </dd>
324
+ </dl>
325
+
312
326
  #### 🔌 Usage
313
327
 
314
328
  <dl>
@@ -319,7 +333,6 @@ await client.schedules.list("workflow_permanent_id");
319
333
 
320
334
  ```typescript
321
335
  await client.schedules.create("workflow_permanent_id", {
322
- cron_expression: "cron_expression",
323
336
  timezone: "timezone"
324
337
  });
325
338
 
@@ -369,6 +382,20 @@ await client.schedules.create("workflow_permanent_id", {
369
382
  <dl>
370
383
  <dd>
371
384
 
385
+ #### 📝 Description
386
+
387
+ <dl>
388
+ <dd>
389
+
390
+ <dl>
391
+ <dd>
392
+
393
+ Fetch one schedule belonging to an agent. Returns the schedule's cron expression or interval, timezone, parameters, enabled state, and next upcoming run times.
394
+ </dd>
395
+ </dl>
396
+ </dd>
397
+ </dl>
398
+
372
399
  #### 🔌 Usage
373
400
 
374
401
  <dl>
@@ -426,6 +453,20 @@ await client.schedules.get("workflow_permanent_id", "workflow_schedule_id");
426
453
  <dl>
427
454
  <dd>
428
455
 
456
+ #### 📝 Description
457
+
458
+ <dl>
459
+ <dd>
460
+
461
+ <dl>
462
+ <dd>
463
+
464
+ Replace a schedule's cron expression, interval or one-time run_at, timezone, run parameters, and enabled state. A one-time schedule stays one-time and can change only until it fires; afterwards this returns 409. Returns the updated schedule and its next upcoming run times.
465
+ </dd>
466
+ </dl>
467
+ </dd>
468
+ </dl>
469
+
429
470
  #### 🔌 Usage
430
471
 
431
472
  <dl>
@@ -436,7 +477,6 @@ await client.schedules.get("workflow_permanent_id", "workflow_schedule_id");
436
477
 
437
478
  ```typescript
438
479
  await client.schedules.update("workflow_permanent_id", "workflow_schedule_id", {
439
- cron_expression: "cron_expression",
440
480
  timezone: "timezone"
441
481
  });
442
482
 
@@ -657,6 +697,77 @@ await client.schedules.disable("workflow_permanent_id", "workflow_schedule_id");
657
697
  </dl>
658
698
 
659
699
 
700
+ </dd>
701
+ </dl>
702
+ </details>
703
+
704
+ <details><summary><code>client.schedules.<a href="/src/api/resources/schedules/client/Client.ts">cancel</a>(workflowPermanentId, workflowScheduleId) -> Skyvern.WorkflowScheduleResponse</code></summary>
705
+ <dl>
706
+ <dd>
707
+
708
+ #### 📝 Description
709
+
710
+ <dl>
711
+ <dd>
712
+
713
+ <dl>
714
+ <dd>
715
+
716
+ Cancel a one-time schedule that has not fired yet. The schedule stays readable with dispatch_status canceled. Returns 409 once it has fired or was already canceled, and 422 for a recurring schedule.
717
+ </dd>
718
+ </dl>
719
+ </dd>
720
+ </dl>
721
+
722
+ #### 🔌 Usage
723
+
724
+ <dl>
725
+ <dd>
726
+
727
+ <dl>
728
+ <dd>
729
+
730
+ ```typescript
731
+ await client.schedules.cancel("workflow_permanent_id", "workflow_schedule_id");
732
+
733
+ ```
734
+ </dd>
735
+ </dl>
736
+ </dd>
737
+ </dl>
738
+
739
+ #### ⚙️ Parameters
740
+
741
+ <dl>
742
+ <dd>
743
+
744
+ <dl>
745
+ <dd>
746
+
747
+ **workflowPermanentId:** `string`
748
+
749
+ </dd>
750
+ </dl>
751
+
752
+ <dl>
753
+ <dd>
754
+
755
+ **workflowScheduleId:** `string`
756
+
757
+ </dd>
758
+ </dl>
759
+
760
+ <dl>
761
+ <dd>
762
+
763
+ **requestOptions:** `Schedules.RequestOptions`
764
+
765
+ </dd>
766
+ </dl>
767
+ </dd>
768
+ </dl>
769
+
770
+
660
771
  </dd>
661
772
  </dl>
662
773
  </details>