@skyvern/client 1.0.22 → 1.0.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/dist/cjs/Client.d.ts +96 -13
  2. package/dist/cjs/Client.js +413 -61
  3. package/dist/cjs/api/client/requests/CreateBrowserSessionRequest.d.ts +9 -0
  4. package/dist/cjs/api/client/requests/DeleteFolderRequest.d.ts +10 -0
  5. package/dist/cjs/api/client/requests/FolderCreate.d.ts +12 -0
  6. package/dist/cjs/api/client/requests/FolderCreate.js +3 -0
  7. package/dist/cjs/api/client/requests/FolderUpdate.d.ts +10 -0
  8. package/dist/cjs/api/client/requests/FolderUpdate.js +3 -0
  9. package/dist/cjs/api/client/requests/GetFoldersRequest.d.ts +16 -0
  10. package/dist/cjs/api/client/requests/GetFoldersRequest.js +3 -0
  11. package/dist/cjs/api/client/requests/UpdateWorkflowFolderRequest.d.ts +8 -0
  12. package/dist/cjs/api/client/requests/UpdateWorkflowFolderRequest.js +3 -0
  13. package/dist/cjs/api/client/requests/index.d.ts +5 -0
  14. package/dist/cjs/api/types/BlockType.d.ts +1 -0
  15. package/dist/cjs/api/types/BlockType.js +1 -0
  16. package/dist/cjs/api/types/BrowserSessionResponse.d.ts +2 -0
  17. package/dist/cjs/api/types/Folder.d.ts +15 -0
  18. package/dist/cjs/api/types/Folder.js +3 -0
  19. package/dist/cjs/api/types/ForLoopBlockLoopBlocksItem.d.ts +4 -1
  20. package/dist/cjs/api/types/ForLoopBlockYamlLoopBlocksItem.d.ts +4 -1
  21. package/dist/cjs/api/types/ProxyLocation.d.ts +1 -0
  22. package/dist/cjs/api/types/ProxyLocation.js +1 -0
  23. package/dist/cjs/api/types/TaskRunRequest.d.ts +14 -0
  24. package/dist/cjs/api/types/Workflow.d.ts +2 -0
  25. package/dist/cjs/api/types/WorkflowCreateYamlRequest.d.ts +2 -0
  26. package/dist/cjs/api/types/WorkflowDefinitionBlocksItem.d.ts +4 -1
  27. package/dist/cjs/api/types/WorkflowDefinitionYamlBlocksItem.d.ts +4 -1
  28. package/dist/cjs/api/types/WorkflowRun.d.ts +0 -3
  29. package/dist/cjs/api/types/WorkflowRunRequest.d.ts +15 -1
  30. package/dist/cjs/api/types/WorkflowRunResponse.d.ts +1 -1
  31. package/dist/cjs/api/types/WorkflowTriggerBlock.d.ts +18 -0
  32. package/dist/cjs/api/types/WorkflowTriggerBlock.js +3 -0
  33. package/dist/cjs/api/types/WorkflowTriggerBlockParametersItem.d.ts +37 -0
  34. package/dist/cjs/api/types/WorkflowTriggerBlockParametersItem.js +3 -0
  35. package/dist/cjs/api/types/WorkflowTriggerBlockYaml.d.ts +15 -0
  36. package/dist/cjs/api/types/WorkflowTriggerBlockYaml.js +3 -0
  37. package/dist/cjs/api/types/index.d.ts +4 -1
  38. package/dist/cjs/api/types/index.js +4 -1
  39. package/dist/cjs/version.d.ts +1 -1
  40. package/dist/cjs/version.js +1 -1
  41. package/dist/esm/Client.d.mts +96 -13
  42. package/dist/esm/Client.mjs +413 -61
  43. package/dist/esm/api/client/requests/CreateBrowserSessionRequest.d.mts +9 -0
  44. package/dist/esm/api/client/requests/DeleteFolderRequest.d.mts +10 -0
  45. package/dist/esm/api/client/requests/FolderCreate.d.mts +12 -0
  46. package/dist/esm/api/client/requests/FolderCreate.mjs +2 -0
  47. package/dist/esm/api/client/requests/FolderUpdate.d.mts +10 -0
  48. package/dist/esm/api/client/requests/FolderUpdate.mjs +2 -0
  49. package/dist/esm/api/client/requests/GetFoldersRequest.d.mts +16 -0
  50. package/dist/esm/api/client/requests/GetFoldersRequest.mjs +2 -0
  51. package/dist/esm/api/client/requests/UpdateWorkflowFolderRequest.d.mts +8 -0
  52. package/dist/esm/api/client/requests/UpdateWorkflowFolderRequest.mjs +2 -0
  53. package/dist/esm/api/client/requests/index.d.mts +5 -0
  54. package/dist/esm/api/types/BlockType.d.mts +1 -0
  55. package/dist/esm/api/types/BlockType.mjs +1 -0
  56. package/dist/esm/api/types/BrowserSessionResponse.d.mts +2 -0
  57. package/dist/esm/api/types/Folder.d.mts +15 -0
  58. package/dist/esm/api/types/Folder.mjs +2 -0
  59. package/dist/esm/api/types/ForLoopBlockLoopBlocksItem.d.mts +4 -1
  60. package/dist/esm/api/types/ForLoopBlockYamlLoopBlocksItem.d.mts +4 -1
  61. package/dist/esm/api/types/ProxyLocation.d.mts +1 -0
  62. package/dist/esm/api/types/ProxyLocation.mjs +1 -0
  63. package/dist/esm/api/types/TaskRunRequest.d.mts +14 -0
  64. package/dist/esm/api/types/Workflow.d.mts +2 -0
  65. package/dist/esm/api/types/WorkflowCreateYamlRequest.d.mts +2 -0
  66. package/dist/esm/api/types/WorkflowDefinitionBlocksItem.d.mts +4 -1
  67. package/dist/esm/api/types/WorkflowDefinitionYamlBlocksItem.d.mts +4 -1
  68. package/dist/esm/api/types/WorkflowRun.d.mts +0 -3
  69. package/dist/esm/api/types/WorkflowRunRequest.d.mts +15 -1
  70. package/dist/esm/api/types/WorkflowRunResponse.d.mts +1 -1
  71. package/dist/esm/api/types/WorkflowTriggerBlock.d.mts +18 -0
  72. package/dist/esm/api/types/WorkflowTriggerBlock.mjs +2 -0
  73. package/dist/esm/api/types/WorkflowTriggerBlockParametersItem.d.mts +37 -0
  74. package/dist/esm/api/types/WorkflowTriggerBlockParametersItem.mjs +2 -0
  75. package/dist/esm/api/types/WorkflowTriggerBlockYaml.d.mts +15 -0
  76. package/dist/esm/api/types/WorkflowTriggerBlockYaml.mjs +2 -0
  77. package/dist/esm/api/types/index.d.mts +4 -1
  78. package/dist/esm/api/types/index.mjs +4 -1
  79. package/dist/esm/version.d.mts +1 -1
  80. package/dist/esm/version.mjs +1 -1
  81. package/package.json +1 -1
  82. package/reference.md +12 -9
  83. package/dist/cjs/api/types/ClearCacheResponse.d.ts +0 -9
  84. package/dist/esm/api/types/ClearCacheResponse.d.mts +0 -9
  85. /package/dist/cjs/api/{types/ClearCacheResponse.js → client/requests/DeleteFolderRequest.js} +0 -0
  86. /package/dist/esm/api/{types/ClearCacheResponse.mjs → client/requests/DeleteFolderRequest.mjs} +0 -0
@@ -380,6 +380,7 @@ export declare class SkyvernClient {
380
380
  * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
381
381
  *
382
382
  * @throws {@link Skyvern.ForbiddenError}
383
+ * @throws {@link Skyvern.NotFoundError}
383
384
  * @throws {@link Skyvern.UnprocessableEntityError}
384
385
  *
385
386
  * @example
@@ -607,19 +608,6 @@ export declare class SkyvernClient {
607
608
  */
608
609
  deployScript(scriptId: string, request: Skyvern.DeployScriptRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.CreateScriptResponse>;
609
610
  private __deployScript;
610
- /**
611
- * Clear all cached scripts for a specific workflow. This will trigger script regeneration on subsequent runs.
612
- *
613
- * @param {string} workflowPermanentId - The workflow permanent ID to clear cache for
614
- * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
615
- *
616
- * @throws {@link Skyvern.UnprocessableEntityError}
617
- *
618
- * @example
619
- * await client.clearWorkflowCache("wpid_abc123")
620
- */
621
- clearWorkflowCache(workflowPermanentId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.ClearCacheResponse>;
622
- private __clearWorkflowCache;
623
611
  /**
624
612
  * Execute a single SDK action with the specified parameters
625
613
  *
@@ -706,4 +694,99 @@ export declare class SkyvernClient {
706
694
  */
707
695
  changeTierApiV1BillingChangeTierPost(request: Skyvern.ChangeTierRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.ChangeTierResponse>;
708
696
  private __changeTierApiV1BillingChangeTierPost;
697
+ /**
698
+ * Get all folders for the organization
699
+ *
700
+ * @param {Skyvern.GetFoldersRequest} request
701
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
702
+ *
703
+ * @throws {@link Skyvern.UnprocessableEntityError}
704
+ *
705
+ * @example
706
+ * await client.getFolders({
707
+ * page: 1,
708
+ * page_size: 1,
709
+ * search: "search"
710
+ * })
711
+ */
712
+ getFolders(request?: Skyvern.GetFoldersRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder[]>;
713
+ private __getFolders;
714
+ /**
715
+ * Create a new folder to organize workflows
716
+ *
717
+ * @param {Skyvern.FolderCreate} request
718
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
719
+ *
720
+ * @throws {@link Skyvern.BadRequestError}
721
+ * @throws {@link Skyvern.UnprocessableEntityError}
722
+ *
723
+ * @example
724
+ * await client.createFolder({
725
+ * title: "title"
726
+ * })
727
+ */
728
+ createFolder(request: Skyvern.FolderCreate, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
729
+ private __createFolder;
730
+ /**
731
+ * Get a specific folder by ID
732
+ *
733
+ * @param {string} folderId - Folder ID
734
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
735
+ *
736
+ * @throws {@link Skyvern.NotFoundError}
737
+ * @throws {@link Skyvern.UnprocessableEntityError}
738
+ *
739
+ * @example
740
+ * await client.getFolder("fld_123")
741
+ */
742
+ getFolder(folderId: string, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
743
+ private __getFolder;
744
+ /**
745
+ * Update a folder's title or description
746
+ *
747
+ * @param {string} folderId - Folder ID
748
+ * @param {Skyvern.FolderUpdate} request
749
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
750
+ *
751
+ * @throws {@link Skyvern.NotFoundError}
752
+ * @throws {@link Skyvern.UnprocessableEntityError}
753
+ *
754
+ * @example
755
+ * await client.updateFolder("fld_123")
756
+ */
757
+ updateFolder(folderId: string, request?: Skyvern.FolderUpdate, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Folder>;
758
+ private __updateFolder;
759
+ /**
760
+ * Delete a folder. Optionally delete all workflows in the folder.
761
+ *
762
+ * @param {string} folderId - Folder ID
763
+ * @param {Skyvern.DeleteFolderRequest} request
764
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
765
+ *
766
+ * @throws {@link Skyvern.NotFoundError}
767
+ * @throws {@link Skyvern.UnprocessableEntityError}
768
+ *
769
+ * @example
770
+ * await client.deleteFolder("fld_123", {
771
+ * delete_workflows: true
772
+ * })
773
+ */
774
+ deleteFolder(folderId: string, request?: Skyvern.DeleteFolderRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
775
+ private __deleteFolder;
776
+ /**
777
+ * Update a workflow's folder assignment for the latest version
778
+ *
779
+ * @param {string} workflowPermanentId - Workflow permanent ID
780
+ * @param {Skyvern.UpdateWorkflowFolderRequest} request
781
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
782
+ *
783
+ * @throws {@link Skyvern.BadRequestError}
784
+ * @throws {@link Skyvern.NotFoundError}
785
+ * @throws {@link Skyvern.UnprocessableEntityError}
786
+ *
787
+ * @example
788
+ * await client.updateWorkflowFolder("wpid_123")
789
+ */
790
+ updateWorkflowFolder(workflowPermanentId: string, request?: Skyvern.UpdateWorkflowFolderRequest, requestOptions?: SkyvernClient.RequestOptions): core.HttpResponsePromise<Skyvern.Workflow>;
791
+ private __updateWorkflowFolder;
709
792
  }
@@ -56,8 +56,8 @@ class SkyvernClient {
56
56
  "x-api-key": _options === null || _options === void 0 ? void 0 : _options.apiKey,
57
57
  "X-Fern-Language": "JavaScript",
58
58
  "X-Fern-SDK-Name": "@skyvern/client",
59
- "X-Fern-SDK-Version": "1.0.22",
60
- "User-Agent": "@skyvern/client/1.0.22",
59
+ "X-Fern-SDK-Version": "1.0.24",
60
+ "User-Agent": "@skyvern/client/1.0.24",
61
61
  "X-Fern-Runtime": core.RUNTIME.type,
62
62
  "X-Fern-Runtime-Version": core.RUNTIME.version,
63
63
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -1550,6 +1550,7 @@ class SkyvernClient {
1550
1550
  * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
1551
1551
  *
1552
1552
  * @throws {@link Skyvern.ForbiddenError}
1553
+ * @throws {@link Skyvern.NotFoundError}
1553
1554
  * @throws {@link Skyvern.UnprocessableEntityError}
1554
1555
  *
1555
1556
  * @example
@@ -1581,6 +1582,8 @@ class SkyvernClient {
1581
1582
  switch (_response.error.statusCode) {
1582
1583
  case 403:
1583
1584
  throw new Skyvern.ForbiddenError(_response.error.body, _response.rawResponse);
1585
+ case 404:
1586
+ throw new Skyvern.NotFoundError(_response.error.body, _response.rawResponse);
1584
1587
  case 422:
1585
1588
  throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
1586
1589
  default:
@@ -2515,65 +2518,6 @@ class SkyvernClient {
2515
2518
  }
2516
2519
  });
2517
2520
  }
2518
- /**
2519
- * Clear all cached scripts for a specific workflow. This will trigger script regeneration on subsequent runs.
2520
- *
2521
- * @param {string} workflowPermanentId - The workflow permanent ID to clear cache for
2522
- * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
2523
- *
2524
- * @throws {@link Skyvern.UnprocessableEntityError}
2525
- *
2526
- * @example
2527
- * await client.clearWorkflowCache("wpid_abc123")
2528
- */
2529
- clearWorkflowCache(workflowPermanentId, requestOptions) {
2530
- return core.HttpResponsePromise.fromPromise(this.__clearWorkflowCache(workflowPermanentId, requestOptions));
2531
- }
2532
- __clearWorkflowCache(workflowPermanentId, requestOptions) {
2533
- return __awaiter(this, void 0, void 0, function* () {
2534
- var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2535
- const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
2536
- const _response = yield core.fetcher({
2537
- url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/scripts/${core.url.encodePathParam(workflowPermanentId)}/cache`),
2538
- method: "DELETE",
2539
- headers: _headers,
2540
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
2541
- timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
2542
- maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
2543
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
2544
- });
2545
- if (_response.ok) {
2546
- return { data: _response.body, rawResponse: _response.rawResponse };
2547
- }
2548
- if (_response.error.reason === "status-code") {
2549
- switch (_response.error.statusCode) {
2550
- case 422:
2551
- throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
2552
- default:
2553
- throw new errors.SkyvernError({
2554
- statusCode: _response.error.statusCode,
2555
- body: _response.error.body,
2556
- rawResponse: _response.rawResponse,
2557
- });
2558
- }
2559
- }
2560
- switch (_response.error.reason) {
2561
- case "non-json":
2562
- throw new errors.SkyvernError({
2563
- statusCode: _response.error.statusCode,
2564
- body: _response.error.rawBody,
2565
- rawResponse: _response.rawResponse,
2566
- });
2567
- case "timeout":
2568
- throw new errors.SkyvernTimeoutError("Timeout exceeded when calling DELETE /v1/scripts/{workflow_permanent_id}/cache.");
2569
- case "unknown":
2570
- throw new errors.SkyvernError({
2571
- message: _response.error.errorMessage,
2572
- rawResponse: _response.rawResponse,
2573
- });
2574
- }
2575
- });
2576
- }
2577
2521
  /**
2578
2522
  * Execute a single SDK action with the specified parameters
2579
2523
  *
@@ -2902,5 +2846,413 @@ class SkyvernClient {
2902
2846
  }
2903
2847
  });
2904
2848
  }
2849
+ /**
2850
+ * Get all folders for the organization
2851
+ *
2852
+ * @param {Skyvern.GetFoldersRequest} request
2853
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
2854
+ *
2855
+ * @throws {@link Skyvern.UnprocessableEntityError}
2856
+ *
2857
+ * @example
2858
+ * await client.getFolders({
2859
+ * page: 1,
2860
+ * page_size: 1,
2861
+ * search: "search"
2862
+ * })
2863
+ */
2864
+ getFolders(request = {}, requestOptions) {
2865
+ return core.HttpResponsePromise.fromPromise(this.__getFolders(request, requestOptions));
2866
+ }
2867
+ __getFolders() {
2868
+ return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
2869
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2870
+ const { page, page_size: pageSize, search } = request;
2871
+ const _queryParams = {};
2872
+ if (page != null) {
2873
+ _queryParams.page = page.toString();
2874
+ }
2875
+ if (pageSize != null) {
2876
+ _queryParams.page_size = pageSize.toString();
2877
+ }
2878
+ if (search != null) {
2879
+ _queryParams.search = search;
2880
+ }
2881
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
2882
+ const _response = yield core.fetcher({
2883
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, "v1/folders"),
2884
+ method: "GET",
2885
+ headers: _headers,
2886
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
2887
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
2888
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
2889
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
2890
+ });
2891
+ if (_response.ok) {
2892
+ return { data: _response.body, rawResponse: _response.rawResponse };
2893
+ }
2894
+ if (_response.error.reason === "status-code") {
2895
+ switch (_response.error.statusCode) {
2896
+ case 422:
2897
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
2898
+ default:
2899
+ throw new errors.SkyvernError({
2900
+ statusCode: _response.error.statusCode,
2901
+ body: _response.error.body,
2902
+ rawResponse: _response.rawResponse,
2903
+ });
2904
+ }
2905
+ }
2906
+ switch (_response.error.reason) {
2907
+ case "non-json":
2908
+ throw new errors.SkyvernError({
2909
+ statusCode: _response.error.statusCode,
2910
+ body: _response.error.rawBody,
2911
+ rawResponse: _response.rawResponse,
2912
+ });
2913
+ case "timeout":
2914
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling GET /v1/folders.");
2915
+ case "unknown":
2916
+ throw new errors.SkyvernError({
2917
+ message: _response.error.errorMessage,
2918
+ rawResponse: _response.rawResponse,
2919
+ });
2920
+ }
2921
+ });
2922
+ }
2923
+ /**
2924
+ * Create a new folder to organize workflows
2925
+ *
2926
+ * @param {Skyvern.FolderCreate} request
2927
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
2928
+ *
2929
+ * @throws {@link Skyvern.BadRequestError}
2930
+ * @throws {@link Skyvern.UnprocessableEntityError}
2931
+ *
2932
+ * @example
2933
+ * await client.createFolder({
2934
+ * title: "title"
2935
+ * })
2936
+ */
2937
+ createFolder(request, requestOptions) {
2938
+ return core.HttpResponsePromise.fromPromise(this.__createFolder(request, requestOptions));
2939
+ }
2940
+ __createFolder(request, requestOptions) {
2941
+ return __awaiter(this, void 0, void 0, function* () {
2942
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
2943
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
2944
+ const _response = yield core.fetcher({
2945
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, "v1/folders"),
2946
+ method: "POST",
2947
+ headers: _headers,
2948
+ contentType: "application/json",
2949
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
2950
+ requestType: "json",
2951
+ body: request,
2952
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
2953
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
2954
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
2955
+ });
2956
+ if (_response.ok) {
2957
+ return { data: _response.body, rawResponse: _response.rawResponse };
2958
+ }
2959
+ if (_response.error.reason === "status-code") {
2960
+ switch (_response.error.statusCode) {
2961
+ case 400:
2962
+ throw new Skyvern.BadRequestError(_response.error.body, _response.rawResponse);
2963
+ case 422:
2964
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
2965
+ default:
2966
+ throw new errors.SkyvernError({
2967
+ statusCode: _response.error.statusCode,
2968
+ body: _response.error.body,
2969
+ rawResponse: _response.rawResponse,
2970
+ });
2971
+ }
2972
+ }
2973
+ switch (_response.error.reason) {
2974
+ case "non-json":
2975
+ throw new errors.SkyvernError({
2976
+ statusCode: _response.error.statusCode,
2977
+ body: _response.error.rawBody,
2978
+ rawResponse: _response.rawResponse,
2979
+ });
2980
+ case "timeout":
2981
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling POST /v1/folders.");
2982
+ case "unknown":
2983
+ throw new errors.SkyvernError({
2984
+ message: _response.error.errorMessage,
2985
+ rawResponse: _response.rawResponse,
2986
+ });
2987
+ }
2988
+ });
2989
+ }
2990
+ /**
2991
+ * Get a specific folder by ID
2992
+ *
2993
+ * @param {string} folderId - Folder ID
2994
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
2995
+ *
2996
+ * @throws {@link Skyvern.NotFoundError}
2997
+ * @throws {@link Skyvern.UnprocessableEntityError}
2998
+ *
2999
+ * @example
3000
+ * await client.getFolder("fld_123")
3001
+ */
3002
+ getFolder(folderId, requestOptions) {
3003
+ return core.HttpResponsePromise.fromPromise(this.__getFolder(folderId, requestOptions));
3004
+ }
3005
+ __getFolder(folderId, requestOptions) {
3006
+ return __awaiter(this, void 0, void 0, function* () {
3007
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
3008
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3009
+ const _response = yield core.fetcher({
3010
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/folders/${core.url.encodePathParam(folderId)}`),
3011
+ method: "GET",
3012
+ headers: _headers,
3013
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
3014
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
3015
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
3016
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3017
+ });
3018
+ if (_response.ok) {
3019
+ return { data: _response.body, rawResponse: _response.rawResponse };
3020
+ }
3021
+ if (_response.error.reason === "status-code") {
3022
+ switch (_response.error.statusCode) {
3023
+ case 404:
3024
+ throw new Skyvern.NotFoundError(_response.error.body, _response.rawResponse);
3025
+ case 422:
3026
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
3027
+ default:
3028
+ throw new errors.SkyvernError({
3029
+ statusCode: _response.error.statusCode,
3030
+ body: _response.error.body,
3031
+ rawResponse: _response.rawResponse,
3032
+ });
3033
+ }
3034
+ }
3035
+ switch (_response.error.reason) {
3036
+ case "non-json":
3037
+ throw new errors.SkyvernError({
3038
+ statusCode: _response.error.statusCode,
3039
+ body: _response.error.rawBody,
3040
+ rawResponse: _response.rawResponse,
3041
+ });
3042
+ case "timeout":
3043
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling GET /v1/folders/{folder_id}.");
3044
+ case "unknown":
3045
+ throw new errors.SkyvernError({
3046
+ message: _response.error.errorMessage,
3047
+ rawResponse: _response.rawResponse,
3048
+ });
3049
+ }
3050
+ });
3051
+ }
3052
+ /**
3053
+ * Update a folder's title or description
3054
+ *
3055
+ * @param {string} folderId - Folder ID
3056
+ * @param {Skyvern.FolderUpdate} request
3057
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
3058
+ *
3059
+ * @throws {@link Skyvern.NotFoundError}
3060
+ * @throws {@link Skyvern.UnprocessableEntityError}
3061
+ *
3062
+ * @example
3063
+ * await client.updateFolder("fld_123")
3064
+ */
3065
+ updateFolder(folderId, request = {}, requestOptions) {
3066
+ return core.HttpResponsePromise.fromPromise(this.__updateFolder(folderId, request, requestOptions));
3067
+ }
3068
+ __updateFolder(folderId_1) {
3069
+ return __awaiter(this, arguments, void 0, function* (folderId, request = {}, requestOptions) {
3070
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
3071
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3072
+ const _response = yield core.fetcher({
3073
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/folders/${core.url.encodePathParam(folderId)}`),
3074
+ method: "PUT",
3075
+ headers: _headers,
3076
+ contentType: "application/json",
3077
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
3078
+ requestType: "json",
3079
+ body: request,
3080
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
3081
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
3082
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3083
+ });
3084
+ if (_response.ok) {
3085
+ return { data: _response.body, rawResponse: _response.rawResponse };
3086
+ }
3087
+ if (_response.error.reason === "status-code") {
3088
+ switch (_response.error.statusCode) {
3089
+ case 404:
3090
+ throw new Skyvern.NotFoundError(_response.error.body, _response.rawResponse);
3091
+ case 422:
3092
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
3093
+ default:
3094
+ throw new errors.SkyvernError({
3095
+ statusCode: _response.error.statusCode,
3096
+ body: _response.error.body,
3097
+ rawResponse: _response.rawResponse,
3098
+ });
3099
+ }
3100
+ }
3101
+ switch (_response.error.reason) {
3102
+ case "non-json":
3103
+ throw new errors.SkyvernError({
3104
+ statusCode: _response.error.statusCode,
3105
+ body: _response.error.rawBody,
3106
+ rawResponse: _response.rawResponse,
3107
+ });
3108
+ case "timeout":
3109
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling PUT /v1/folders/{folder_id}.");
3110
+ case "unknown":
3111
+ throw new errors.SkyvernError({
3112
+ message: _response.error.errorMessage,
3113
+ rawResponse: _response.rawResponse,
3114
+ });
3115
+ }
3116
+ });
3117
+ }
3118
+ /**
3119
+ * Delete a folder. Optionally delete all workflows in the folder.
3120
+ *
3121
+ * @param {string} folderId - Folder ID
3122
+ * @param {Skyvern.DeleteFolderRequest} request
3123
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
3124
+ *
3125
+ * @throws {@link Skyvern.NotFoundError}
3126
+ * @throws {@link Skyvern.UnprocessableEntityError}
3127
+ *
3128
+ * @example
3129
+ * await client.deleteFolder("fld_123", {
3130
+ * delete_workflows: true
3131
+ * })
3132
+ */
3133
+ deleteFolder(folderId, request = {}, requestOptions) {
3134
+ return core.HttpResponsePromise.fromPromise(this.__deleteFolder(folderId, request, requestOptions));
3135
+ }
3136
+ __deleteFolder(folderId_1) {
3137
+ return __awaiter(this, arguments, void 0, function* (folderId, request = {}, requestOptions) {
3138
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
3139
+ const { delete_workflows: deleteWorkflows } = request;
3140
+ const _queryParams = {};
3141
+ if (deleteWorkflows != null) {
3142
+ _queryParams.delete_workflows = deleteWorkflows.toString();
3143
+ }
3144
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3145
+ const _response = yield core.fetcher({
3146
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/folders/${core.url.encodePathParam(folderId)}`),
3147
+ method: "DELETE",
3148
+ headers: _headers,
3149
+ queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
3150
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
3151
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
3152
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3153
+ });
3154
+ if (_response.ok) {
3155
+ return { data: _response.body, rawResponse: _response.rawResponse };
3156
+ }
3157
+ if (_response.error.reason === "status-code") {
3158
+ switch (_response.error.statusCode) {
3159
+ case 404:
3160
+ throw new Skyvern.NotFoundError(_response.error.body, _response.rawResponse);
3161
+ case 422:
3162
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
3163
+ default:
3164
+ throw new errors.SkyvernError({
3165
+ statusCode: _response.error.statusCode,
3166
+ body: _response.error.body,
3167
+ rawResponse: _response.rawResponse,
3168
+ });
3169
+ }
3170
+ }
3171
+ switch (_response.error.reason) {
3172
+ case "non-json":
3173
+ throw new errors.SkyvernError({
3174
+ statusCode: _response.error.statusCode,
3175
+ body: _response.error.rawBody,
3176
+ rawResponse: _response.rawResponse,
3177
+ });
3178
+ case "timeout":
3179
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling DELETE /v1/folders/{folder_id}.");
3180
+ case "unknown":
3181
+ throw new errors.SkyvernError({
3182
+ message: _response.error.errorMessage,
3183
+ rawResponse: _response.rawResponse,
3184
+ });
3185
+ }
3186
+ });
3187
+ }
3188
+ /**
3189
+ * Update a workflow's folder assignment for the latest version
3190
+ *
3191
+ * @param {string} workflowPermanentId - Workflow permanent ID
3192
+ * @param {Skyvern.UpdateWorkflowFolderRequest} request
3193
+ * @param {SkyvernClient.RequestOptions} requestOptions - Request-specific configuration.
3194
+ *
3195
+ * @throws {@link Skyvern.BadRequestError}
3196
+ * @throws {@link Skyvern.NotFoundError}
3197
+ * @throws {@link Skyvern.UnprocessableEntityError}
3198
+ *
3199
+ * @example
3200
+ * await client.updateWorkflowFolder("wpid_123")
3201
+ */
3202
+ updateWorkflowFolder(workflowPermanentId, request = {}, requestOptions) {
3203
+ return core.HttpResponsePromise.fromPromise(this.__updateWorkflowFolder(workflowPermanentId, request, requestOptions));
3204
+ }
3205
+ __updateWorkflowFolder(workflowPermanentId_1) {
3206
+ return __awaiter(this, arguments, void 0, function* (workflowPermanentId, request = {}, requestOptions) {
3207
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
3208
+ const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ "x-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
3209
+ const _response = yield core.fetcher({
3210
+ url: core.url.join((_e = (_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.SkyvernEnvironment.Cloud, `v1/workflows/${core.url.encodePathParam(workflowPermanentId)}/folder`),
3211
+ method: "PUT",
3212
+ headers: _headers,
3213
+ contentType: "application/json",
3214
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
3215
+ requestType: "json",
3216
+ body: request,
3217
+ timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
3218
+ maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
3219
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
3220
+ });
3221
+ if (_response.ok) {
3222
+ return { data: _response.body, rawResponse: _response.rawResponse };
3223
+ }
3224
+ if (_response.error.reason === "status-code") {
3225
+ switch (_response.error.statusCode) {
3226
+ case 400:
3227
+ throw new Skyvern.BadRequestError(_response.error.body, _response.rawResponse);
3228
+ case 404:
3229
+ throw new Skyvern.NotFoundError(_response.error.body, _response.rawResponse);
3230
+ case 422:
3231
+ throw new Skyvern.UnprocessableEntityError(_response.error.body, _response.rawResponse);
3232
+ default:
3233
+ throw new errors.SkyvernError({
3234
+ statusCode: _response.error.statusCode,
3235
+ body: _response.error.body,
3236
+ rawResponse: _response.rawResponse,
3237
+ });
3238
+ }
3239
+ }
3240
+ switch (_response.error.reason) {
3241
+ case "non-json":
3242
+ throw new errors.SkyvernError({
3243
+ statusCode: _response.error.statusCode,
3244
+ body: _response.error.rawBody,
3245
+ rawResponse: _response.rawResponse,
3246
+ });
3247
+ case "timeout":
3248
+ throw new errors.SkyvernTimeoutError("Timeout exceeded when calling PUT /v1/workflows/{workflow_permanent_id}/folder.");
3249
+ case "unknown":
3250
+ throw new errors.SkyvernError({
3251
+ message: _response.error.errorMessage,
3252
+ rawResponse: _response.rawResponse,
3253
+ });
3254
+ }
3255
+ });
3256
+ }
2905
3257
  }
2906
3258
  exports.SkyvernClient = SkyvernClient;
@@ -20,9 +20,16 @@ export interface CreateBrowserSessionRequest {
20
20
  * - RESIDENTIAL_DE: Germany
21
21
  * - RESIDENTIAL_NZ: New Zealand
22
22
  * - RESIDENTIAL_PH: Philippines
23
+ * - RESIDENTIAL_KR: South Korea
23
24
  * - RESIDENTIAL_ZA: South Africa
24
25
  * - RESIDENTIAL_AR: Argentina
25
26
  * - RESIDENTIAL_AU: Australia
27
+ * - RESIDENTIAL_BR: Brazil
28
+ * - RESIDENTIAL_TR: Turkey
29
+ * - RESIDENTIAL_CA: Canada
30
+ * - RESIDENTIAL_MX: Mexico
31
+ * - RESIDENTIAL_IT: Italy
32
+ * - RESIDENTIAL_NL: Netherlands
26
33
  * - RESIDENTIAL_ISP: ISP proxy
27
34
  * - US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
28
35
  * - US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
@@ -36,4 +43,6 @@ export interface CreateBrowserSessionRequest {
36
43
  extensions?: Skyvern.Extensions[];
37
44
  /** The type of browser to use for the session. */
38
45
  browser_type?: Skyvern.PersistentBrowserType;
46
+ /** ID of a browser profile to load into this session (restores cookies, localStorage, etc.). browser_profile_id starts with `bp_`. */
47
+ browser_profile_id?: string;
39
48
  }