vellum-ai 0.6.4 → 0.6.7

package/dist/api/resources/sandboxes/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace Sandboxes {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,11 +12,21 @@ export declare namespace Sandboxes {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class Sandboxes {
     protected readonly _options: Sandboxes.Options;
     constructor(_options: Sandboxes.Options);
+    /**
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {string} promptId - An ID identifying the Prompt you'd like to deploy.
+     * @param {Vellum.DeploySandboxPromptRequest} request
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.sandboxes.deployPrompt("id", "prompt_id")
+     */
     deployPrompt(id: string, promptId: string, request?: Vellum.DeploySandboxPromptRequest, requestOptions?: Sandboxes.RequestOptions): Promise<Vellum.DeploymentRead>;
     /**
      * Upserts a new scenario for a sandbox, keying off of the optionally provided scenario id.
@@ -27,6 +37,10 @@ export declare class Sandboxes {
      * Note that a full replacement of the scenario is performed, so any fields not provided will be removed
      * or overwritten with default values.
      *
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {Vellum.UpsertSandboxScenarioRequestRequest} request
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 1",
@@ -43,6 +57,10 @@ export declare class Sandboxes {
     /**
      * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
      *
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {string} scenarioId - An id identifying the scenario that you'd like to delete
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.sandboxes.deleteSandboxScenario("id", "scenario_id")
      */

package/dist/api/resources/sandboxes/client/Client.js

@@ -41,27 +41,37 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sandboxes = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const serializers = __importStar(require("../../../../serialization"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class Sandboxes {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {string} promptId - An ID identifying the Prompt you'd like to deploy.
+     * @param {Vellum.DeploySandboxPromptRequest} request
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.sandboxes.deployPrompt("id", "prompt_id")
+     */
     deployPrompt(id, promptId, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/sandboxes/${id}/prompts/${promptId}/deploy`),
+                    .default, `v1/sandboxes/${encodeURIComponent(id)}/prompts/${encodeURIComponent(promptId)}/deploy`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.DeploySandboxPromptRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.DeploymentRead.parseOrThrow(_response.body, {
@@ -101,6 +111,10 @@ class Sandboxes {
      * Note that a full replacement of the scenario is performed, so any fields not provided will be removed
      * or overwritten with default values.
      *
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {Vellum.UpsertSandboxScenarioRequestRequest} request
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 1",
@@ -118,15 +132,16 @@ class Sandboxes {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/sandboxes/${id}/scenarios`),
+                    .default, `v1/sandboxes/${encodeURIComponent(id)}/scenarios`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.UpsertSandboxScenarioRequestRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.SandboxScenario.parseOrThrow(_response.body, {
@@ -160,6 +175,10 @@ class Sandboxes {
     /**
      * Deletes an existing scenario from a sandbox, keying off of the provided scenario id.
      *
+     * @param {string} id - A UUID string identifying this sandbox.
+     * @param {string} scenarioId - An id identifying the scenario that you'd like to delete
+     * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.sandboxes.deleteSandboxScenario("id", "scenario_id")
      */
@@ -168,12 +187,13 @@ class Sandboxes {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/sandboxes/${id}/scenarios/${scenarioId}`),
+                    .default, `v1/sandboxes/${encodeURIComponent(id)}/scenarios/${encodeURIComponent(scenarioId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;

package/dist/api/resources/sandboxes/client/requests/UpsertSandboxScenarioRequestRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {

package/dist/api/resources/sandboxes/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { DeploySandboxPromptRequest } from "./DeploySandboxPromptRequest";
-export { UpsertSandboxScenarioRequestRequest } from "./UpsertSandboxScenarioRequestRequest";
+export { type DeploySandboxPromptRequest } from "./DeploySandboxPromptRequest";
+export { type UpsertSandboxScenarioRequestRequest } from "./UpsertSandboxScenarioRequestRequest";

package/dist/api/resources/testSuiteRuns/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace TestSuiteRuns {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,6 +12,7 @@ export declare namespace TestSuiteRuns {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class TestSuiteRuns {
@@ -19,15 +20,42 @@ export declare class TestSuiteRuns {
     constructor(_options: TestSuiteRuns.Options);
     /**
      * Trigger a Test Suite and create a new Test Suite Run
+     *
+     * @param {Vellum.TestSuiteRunCreateRequest} request
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.testSuiteRuns.create({
+     *         testSuiteId: "string",
+     *         execConfig: {
+     *             type: "DEPLOYMENT_RELEASE_TAG",
+     *             data: {
+     *                 deploymentId: "string",
+     *                 tag: "string"
+     *             },
+     *             testCaseIds: ["string"]
+     *         }
+     *     })
      */
     create(request: Vellum.TestSuiteRunCreateRequest, requestOptions?: TestSuiteRuns.RequestOptions): Promise<Vellum.TestSuiteRunRead>;
     /**
      * Retrieve a specific Test Suite Run by ID
      *
+     * @param {string} id - A UUID string identifying this test suite run.
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuiteRuns.retrieve("id")
      */
     retrieve(id: string, requestOptions?: TestSuiteRuns.RequestOptions): Promise<Vellum.TestSuiteRunRead>;
+    /**
+     * @param {string} id - A UUID string identifying this test suite run.
+     * @param {Vellum.TestSuiteRunsListExecutionsRequest} request
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.testSuiteRuns.listExecutions("id")
+     */
     listExecutions(id: string, request?: Vellum.TestSuiteRunsListExecutionsRequest, requestOptions?: TestSuiteRuns.RequestOptions): Promise<Vellum.PaginatedTestSuiteRunExecutionList>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         X_API_KEY: string;

package/dist/api/resources/testSuiteRuns/client/Client.js

@@ -41,15 +41,31 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestSuiteRuns = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
-const serializers = __importStar(require("../../../../serialization"));
+const serializers = __importStar(require("../../../../serialization/index"));
 const url_join_1 = __importDefault(require("url-join"));
-const errors = __importStar(require("../../../../errors"));
+const errors = __importStar(require("../../../../errors/index"));
 class TestSuiteRuns {
     constructor(_options) {
         this._options = _options;
     }
     /**
      * Trigger a Test Suite and create a new Test Suite Run
+     *
+     * @param {Vellum.TestSuiteRunCreateRequest} request
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.testSuiteRuns.create({
+     *         testSuiteId: "string",
+     *         execConfig: {
+     *             type: "DEPLOYMENT_RELEASE_TAG",
+     *             data: {
+     *                 deploymentId: "string",
+     *                 tag: "string"
+     *             },
+     *             testCaseIds: ["string"]
+     *         }
+     *     })
      */
     create(request, requestOptions) {
         var _a;
@@ -58,11 +74,12 @@ class TestSuiteRuns {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/test-suite-runs"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.TestSuiteRunCreateRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.TestSuiteRunRead.parseOrThrow(_response.body, {
@@ -96,6 +113,9 @@ class TestSuiteRuns {
     /**
      * Retrieve a specific Test Suite Run by ID
      *
+     * @param {string} id - A UUID string identifying this test suite run.
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuiteRuns.retrieve("id")
      */
@@ -104,12 +124,13 @@ class TestSuiteRuns {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suite-runs/${id}`),
+                    .default, `v1/test-suite-runs/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.TestSuiteRunRead.parseOrThrow(_response.body, {
@@ -140,6 +161,14 @@ class TestSuiteRuns {
             }
         });
     }
+    /**
+     * @param {string} id - A UUID string identifying this test suite run.
+     * @param {Vellum.TestSuiteRunsListExecutionsRequest} request
+     * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.testSuiteRuns.listExecutions("id")
+     */
     listExecutions(id, request = {}, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
@@ -161,13 +190,14 @@ class TestSuiteRuns {
             }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suite-runs/${id}/executions`),
+                    .default, `v1/test-suite-runs/${encodeURIComponent(id)}/executions`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.PaginatedTestSuiteRunExecutionList.parseOrThrow(_response.body, {

package/dist/api/resources/testSuiteRuns/client/requests/TestSuiteRunCreateRequest.d.ts

@@ -1,7 +1,21 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
+/**
+ * @example
+ *     {
+ *         testSuiteId: "string",
+ *         execConfig: {
+ *             type: "DEPLOYMENT_RELEASE_TAG",
+ *             data: {
+ *                 deploymentId: "string",
+ *                 tag: "string"
+ *             },
+ *             testCaseIds: ["string"]
+ *         }
+ *     }
+ */
 export interface TestSuiteRunCreateRequest {
     /** The ID of the Test Suite to run */
     testSuiteId: string;

package/dist/api/resources/testSuiteRuns/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { TestSuiteRunCreateRequest } from "./TestSuiteRunCreateRequest";
-export { TestSuiteRunsListExecutionsRequest } from "./TestSuiteRunsListExecutionsRequest";
+export { type TestSuiteRunCreateRequest } from "./TestSuiteRunCreateRequest";
+export { type TestSuiteRunsListExecutionsRequest } from "./TestSuiteRunsListExecutionsRequest";

package/dist/api/resources/testSuites/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace TestSuites {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,6 +12,7 @@ export declare namespace TestSuites {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class TestSuites {
@@ -20,6 +21,10 @@ export declare class TestSuites {
     /**
      * List the Test Cases associated with a Test Suite
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {Vellum.ListTestSuiteTestCasesRequest} request
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.listTestSuiteTestCases("id")
      */
@@ -33,6 +38,10 @@ export declare class TestSuites {
      * Note that a full replacement of the test case is performed, so any fields not provided will be removed
      * or overwritten with default values.
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {Vellum.UpsertTestSuiteTestCaseRequest} request
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.upsertTestSuiteTestCase("id", {
      *         inputValues: [],
@@ -47,6 +56,10 @@ export declare class TestSuites {
     /**
      * Deletes an existing test case for a test suite, keying off of the test case id.
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {string} testCaseId - An id identifying the test case that you'd like to delete
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
      */

package/dist/api/resources/testSuites/client/Client.js

@@ -42,8 +42,8 @@ exports.TestSuites = void 0;
 const environments = __importStar(require("../../../../environments"));
 const core = __importStar(require("../../../../core"));
 const url_join_1 = __importDefault(require("url-join"));
-const serializers = __importStar(require("../../../../serialization"));
-const errors = __importStar(require("../../../../errors"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const errors = __importStar(require("../../../../errors/index"));
 class TestSuites {
     constructor(_options) {
         this._options = _options;
@@ -51,6 +51,10 @@ class TestSuites {
     /**
      * List the Test Cases associated with a Test Suite
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {Vellum.ListTestSuiteTestCasesRequest} request
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.listTestSuiteTestCases("id")
      */
@@ -67,13 +71,14 @@ class TestSuites {
             }
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suites/${id}/test-cases`),
+                    .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.PaginatedTestSuiteTestCaseList.parseOrThrow(_response.body, {
@@ -113,6 +118,10 @@ class TestSuites {
      * Note that a full replacement of the test case is performed, so any fields not provided will be removed
      * or overwritten with default values.
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {Vellum.UpsertTestSuiteTestCaseRequest} request
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.upsertTestSuiteTestCase("id", {
      *         inputValues: [],
@@ -124,15 +133,16 @@ class TestSuites {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suites/${id}/test-cases`),
+                    .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.UpsertTestSuiteTestCaseRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return yield serializers.TestSuiteTestCase.parseOrThrow(_response.body, {
@@ -171,9 +181,9 @@ class TestSuites {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suites/${id}/test-cases-bulk`),
+                    .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases-bulk`),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 body: yield serializers.testSuites.testSuiteTestCasesBulk.Request.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
@@ -181,11 +191,11 @@ class TestSuites {
                 responseType: "streaming",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return new core.Stream({
                     stream: _response.body,
-                    terminator: "\n",
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
                         return yield serializers.testSuites.testSuiteTestCasesBulk.StreamData.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
@@ -194,6 +204,11 @@ class TestSuites {
                             breadcrumbsPrefix: ["response"],
                         });
                     }),
+                    signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                    eventShape: {
+                        type: "json",
+                        messageTerminator: "\n",
+                    },
                 });
             }
             if (_response.error.reason === "status-code") {
@@ -220,6 +235,10 @@ class TestSuites {
     /**
      * Deletes an existing test case for a test suite, keying off of the test case id.
      *
+     * @param {string} id - A UUID string identifying this test suite.
+     * @param {string} testCaseId - An id identifying the test case that you'd like to delete
+     * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
      */
@@ -228,12 +247,13 @@ class TestSuites {
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield core.fetcher({
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
-                    .default, `v1/test-suites/${id}/test-cases/${testCaseId}`),
+                    .default, `v1/test-suites/${encodeURIComponent(id)}/test-cases/${encodeURIComponent(testCaseId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
                 return;

package/dist/api/resources/testSuites/client/requests/UpsertTestSuiteTestCaseRequest.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import * as Vellum from "../../../..";
+import * as Vellum from "../../../../index";
 /**
  * @example
  *     {
@@ -10,8 +10,11 @@ import * as Vellum from "../../../..";
  *     }
  */
 export interface UpsertTestSuiteTestCaseRequest {
-    /** The ID of the Test Case to upsert. If specified and a match is found, the existing Test Case will be updated. If specified and no match is found, a Test Case will be created with the provided ID. If not provided, a new Test Case will be created with an auto-generated ID. */
+    /** The Vellum-generated ID of an existing Test Case whose data you'd like to replace. If specified and no Test Case exists with this ID, a 404 will be returned. */
     upsertTestSuiteTestCaseRequestId?: string;
+    /** An ID external to Vellum that uniquely identifies the Test Case that you'd like to create/update. If there's a match on a Test Case that was previously created with the same external_id, it will be updated. Otherwise, a new Test Case will be created with this value as its external_id. If no external_id is specified, then a new Test Case will always be created. */
+    externalId?: string;
+    /** A human-readable label used to convey the intention of this Test Case */
     label?: string;
     /** Values for each of the Test Case's input variables */
     inputValues: Vellum.NamedTestCaseVariableValueRequest[];

package/dist/api/resources/testSuites/client/requests/index.d.ts

@@ -1,2 +1,2 @@
-export { ListTestSuiteTestCasesRequest } from "./ListTestSuiteTestCasesRequest";
-export { UpsertTestSuiteTestCaseRequest } from "./UpsertTestSuiteTestCaseRequest";
+export { type ListTestSuiteTestCasesRequest } from "./ListTestSuiteTestCasesRequest";
+export { type UpsertTestSuiteTestCaseRequest } from "./UpsertTestSuiteTestCaseRequest";

package/dist/api/resources/workflowDeployments/client/Client.d.ts

@@ -3,7 +3,7 @@
  */
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
-import * as Vellum from "../../..";
+import * as Vellum from "../../../index";
 export declare namespace WorkflowDeployments {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
@@ -12,15 +12,26 @@ export declare namespace WorkflowDeployments {
     interface RequestOptions {
         timeoutInSeconds?: number;
         maxRetries?: number;
+        abortSignal?: AbortSignal;
     }
 }
 export declare class WorkflowDeployments {
     protected readonly _options: WorkflowDeployments.Options;
     constructor(_options: WorkflowDeployments.Options);
+    /**
+     * @param {Vellum.WorkflowDeploymentsListRequest} request
+     * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await vellum.workflowDeployments.list()
+     */
     list(request?: Vellum.WorkflowDeploymentsListRequest, requestOptions?: WorkflowDeployments.RequestOptions): Promise<Vellum.PaginatedSlimWorkflowDeploymentList>;
     /**
      * Used to retrieve a workflow deployment given its ID or name.
      *
+     * @param {string} id - Either the Workflow Deployment's ID or its unique name
+     * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.workflowDeployments.retrieve("id")
      */
@@ -28,6 +39,10 @@ export declare class WorkflowDeployments {
     /**
      * Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.
      *
+     * @param {string} id - A UUID string identifying this workflow deployment.
+     * @param {string} name - The name of the Release Tag associated with this Workflow Deployment that you'd like to retrieve.
+     * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.workflowDeployments.retrieveWorkflowReleaseTag("id", "name")
      */
@@ -35,6 +50,11 @@ export declare class WorkflowDeployments {
     /**
      * Updates an existing Release Tag associated with the specified Workflow Deployment.
      *
+     * @param {string} id - A UUID string identifying this workflow deployment.
+     * @param {string} name - The name of the Release Tag associated with this Workflow Deployment that you'd like to update.
+     * @param {Vellum.PatchedWorkflowReleaseTagUpdateRequest} request
+     * @param {WorkflowDeployments.RequestOptions} requestOptions - Request-specific configuration.
+     *
      * @example
      *     await vellum.workflowDeployments.updateWorkflowReleaseTag("id", "name")
      */