vellum-ai 0.6.7 → 0.6.11

package/api/resources/documents/client/Client.js

@@ -56,7 +56,7 @@ class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.list()
+     *     await client.documents.list()
      */
     list(request = {}, requestOptions) {
         var _a;
@@ -79,15 +79,16 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/documents"),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "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.PaginatedSlimDocumentList.parseOrThrow(_response.body, {
+                return serializers.PaginatedSlimDocumentList.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -122,7 +123,7 @@ class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.retrieve("id")
+     *     await client.documents.retrieve("id")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -131,14 +132,15 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
+                requestType: "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.DocumentRead.parseOrThrow(_response.body, {
+                return serializers.DocumentRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -173,7 +175,7 @@ class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.destroy("id")
+     *     await client.documents.destroy("id")
      */
     destroy(id, requestOptions) {
         var _a;
@@ -182,8 +184,9 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
+                requestType: "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,
@@ -220,7 +223,7 @@ class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.partialUpdate("id")
+     *     await client.documents.partialUpdate("id")
      */
     partialUpdate(id, request = {}, requestOptions) {
         var _a;
@@ -229,17 +232,16 @@ class Documents {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/documents/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.PatchedDocumentUpdateRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.PatchedDocumentUpdateRequest.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.DocumentRead.parseOrThrow(_response.body, {
+                return serializers.DocumentRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -280,7 +282,7 @@ class Documents {
      * - `keywords: list[str] | None` - Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
      * - `metadata: dict[str, Any]` - A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
      *
-     * @param {File | fs.ReadStream} contents
+     * @param {File | fs.ReadStream | Blob} contents
      * @param {Vellum.UploadDocumentBodyRequest} request
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -289,14 +291,14 @@ class Documents {
      * @throws {@link Vellum.InternalServerError}
      *
      * @example
-     *     await vellum.documents.upload(fs.createReadStream("/path/to/your/file"), {
+     *     await client.documents.upload(fs.createReadStream("/path/to/your/file"), {
      *         label: "label"
      *     })
      */
     upload(contents, request, requestOptions) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const _request = new core.FormDataWrapper();
+            const _request = yield core.newFormData();
             if (request.addToIndexNames != null) {
                 for (const _item of request.addToIndexNames) {
                     yield _request.append("add_to_index_names", _item);
@@ -306,7 +308,7 @@ class Documents {
                 yield _request.append("external_id", request.externalId);
             }
             yield _request.append("label", request.label);
-            yield _request.append("contents", contents);
+            yield _request.appendFile("contents", contents);
             if (request.keywords != null) {
                 for (const _item of request.keywords) {
                     yield _request.append("keywords", _item);
@@ -315,19 +317,20 @@ class Documents {
             if (request.metadata != null) {
                 yield _request.append("metadata", request.metadata);
             }
-            const _maybeEncodedRequest = _request.getRequest();
+            const _maybeEncodedRequest = yield _request.getRequest();
             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)
                     .documents, "v1/upload-document"),
                 method: "POST",
-                headers: Object.assign(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())), (yield _maybeEncodedRequest.getHeaders())),
-                body: yield _maybeEncodedRequest.getBody(),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), (yield _maybeEncodedRequest.headers)),
+                requestType: "file",
+                body: yield _maybeEncodedRequest.body,
                 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.UploadDocumentResponse.parseOrThrow(_response.body, {
+                return serializers.UploadDocumentResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,

package/api/resources/folderEntities/client/Client.d.ts

@@ -10,8 +10,11 @@ export declare namespace FolderEntities {
         apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -28,7 +31,7 @@ export declare class FolderEntities {
      * @param {FolderEntities.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.folderEntities.addEntityToFolder("folder_id", {
+     *     await client.folderEntities.addEntityToFolder("folder_id", {
      *         entityId: "entity_id"
      *     })
      */

package/api/resources/folderEntities/client/Client.js

@@ -58,7 +58,7 @@ class FolderEntities {
      * @param {FolderEntities.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.folderEntities.addEntityToFolder("folder_id", {
+     *     await client.folderEntities.addEntityToFolder("folder_id", {
      *         entityId: "entity_id"
      *     })
      */
@@ -69,9 +69,10 @@ class FolderEntities {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/folders/${encodeURIComponent(folderId)}/add-entity`),
                 method: "POST",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.AddEntityToFolderRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: serializers.AddEntityToFolderRequest.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,

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

@@ -10,8 +10,11 @@ export declare namespace Sandboxes {
         apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -25,7 +28,7 @@ export declare class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.deployPrompt("id", "prompt_id")
+     *     await client.sandboxes.deployPrompt("id", "prompt_id")
      */
     deployPrompt(id: string, promptId: string, request?: Vellum.DeploySandboxPromptRequest, requestOptions?: Sandboxes.RequestOptions): Promise<Vellum.DeploymentRead>;
     /**
@@ -42,13 +45,13 @@ export declare class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.upsertSandboxScenario("id", {
+     *     await client.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 1",
      *         inputs: []
      *     })
      *
      * @example
-     *     await vellum.sandboxes.upsertSandboxScenario("id", {
+     *     await client.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 2",
      *         inputs: []
      *     })
@@ -62,7 +65,7 @@ export declare class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.deleteSandboxScenario("id", "scenario_id")
+     *     await client.sandboxes.deleteSandboxScenario("id", "scenario_id")
      */
     deleteSandboxScenario(id: string, scenarioId: string, requestOptions?: Sandboxes.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -55,7 +55,7 @@ class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.deployPrompt("id", "prompt_id")
+     *     await client.sandboxes.deployPrompt("id", "prompt_id")
      */
     deployPrompt(id, promptId, request = {}, requestOptions) {
         var _a;
@@ -64,17 +64,16 @@ class Sandboxes {
                 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/${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.7", "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.11", "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",
-                }),
+                requestType: "json",
+                body: 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, {
+                return serializers.DeploymentRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -116,13 +115,13 @@ class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.upsertSandboxScenario("id", {
+     *     await client.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 1",
      *         inputs: []
      *     })
      *
      * @example
-     *     await vellum.sandboxes.upsertSandboxScenario("id", {
+     *     await client.sandboxes.upsertSandboxScenario("id", {
      *         label: "Scenario 2",
      *         inputs: []
      *     })
@@ -134,9 +133,10 @@ class Sandboxes {
                 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/${encodeURIComponent(id)}/scenarios`),
                 method: "POST",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "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, {
+                requestType: "json",
+                body: serializers.UpsertSandboxScenarioRequestRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -144,7 +144,7 @@ class Sandboxes {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.SandboxScenario.parseOrThrow(_response.body, {
+                return serializers.SandboxScenario.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -180,7 +180,7 @@ class Sandboxes {
      * @param {Sandboxes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.sandboxes.deleteSandboxScenario("id", "scenario_id")
+     *     await client.sandboxes.deleteSandboxScenario("id", "scenario_id")
      */
     deleteSandboxScenario(id, scenarioId, requestOptions) {
         var _a;
@@ -189,8 +189,9 @@ class Sandboxes {
                 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/${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.7", "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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
+                requestType: "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,

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

@@ -10,8 +10,11 @@ export declare namespace TestSuiteRuns {
         apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -25,7 +28,7 @@ export declare class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.create({
+     *     await client.testSuiteRuns.create({
      *         testSuiteId: "string",
      *         execConfig: {
      *             type: "DEPLOYMENT_RELEASE_TAG",
@@ -45,7 +48,7 @@ export declare class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.retrieve("id")
+     *     await client.testSuiteRuns.retrieve("id")
      */
     retrieve(id: string, requestOptions?: TestSuiteRuns.RequestOptions): Promise<Vellum.TestSuiteRunRead>;
     /**
@@ -54,7 +57,7 @@ export declare class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.listExecutions("id")
+     *     await client.testSuiteRuns.listExecutions("id")
      */
     listExecutions(id: string, request?: Vellum.TestSuiteRunsListExecutionsRequest, requestOptions?: TestSuiteRuns.RequestOptions): Promise<Vellum.PaginatedTestSuiteRunExecutionList>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -55,7 +55,7 @@ class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.create({
+     *     await client.testSuiteRuns.create({
      *         testSuiteId: "string",
      *         execConfig: {
      *             type: "DEPLOYMENT_RELEASE_TAG",
@@ -74,15 +74,16 @@ 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.7", "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.11", "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" }),
+                requestType: "json",
+                body: 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, {
+                return serializers.TestSuiteRunRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -117,7 +118,7 @@ class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.retrieve("id")
+     *     await client.testSuiteRuns.retrieve("id")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -126,14 +127,15 @@ 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/${encodeURIComponent(id)}`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
+                requestType: "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, {
+                return serializers.TestSuiteRunRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -167,7 +169,7 @@ class TestSuiteRuns {
      * @param {TestSuiteRuns.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuiteRuns.listExecutions("id")
+     *     await client.testSuiteRuns.listExecutions("id")
      */
     listExecutions(id, request = {}, requestOptions) {
         var _a;
@@ -192,15 +194,16 @@ 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/${encodeURIComponent(id)}/executions`),
                 method: "GET",
-                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())),
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "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.PaginatedTestSuiteRunExecutionList.parseOrThrow(_response.body, {
+                return serializers.PaginatedTestSuiteRunExecutionList.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,

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

@@ -10,8 +10,11 @@ export declare namespace TestSuites {
         apiKey: core.Supplier<string>;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
     }
 }
@@ -26,7 +29,7 @@ export declare class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.listTestSuiteTestCases("id")
+     *     await client.testSuites.listTestSuiteTestCases("id")
      */
     listTestSuiteTestCases(id: string, request?: Vellum.ListTestSuiteTestCasesRequest, requestOptions?: TestSuites.RequestOptions): Promise<Vellum.PaginatedTestSuiteTestCaseList>;
     /**
@@ -43,7 +46,7 @@ export declare class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.upsertTestSuiteTestCase("id", {
+     *     await client.testSuites.upsertTestSuiteTestCase("id", {
      *         inputValues: [],
      *         evaluationValues: []
      *     })
@@ -61,7 +64,7 @@ export declare class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
+     *     await client.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
      */
     deleteTestSuiteTestCase(id: string, testCaseId: string, requestOptions?: TestSuites.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -56,7 +56,7 @@ class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.listTestSuiteTestCases("id")
+     *     await client.testSuites.listTestSuiteTestCases("id")
      */
     listTestSuiteTestCases(id, request = {}, requestOptions) {
         var _a;
@@ -73,15 +73,16 @@ class TestSuites {
                 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/${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.7", "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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
                 queryParameters: _queryParams,
+                requestType: "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.PaginatedTestSuiteTestCaseList.parseOrThrow(_response.body, {
+                return serializers.PaginatedTestSuiteTestCaseList.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -123,7 +124,7 @@ class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.upsertTestSuiteTestCase("id", {
+     *     await client.testSuites.upsertTestSuiteTestCase("id", {
      *         inputValues: [],
      *         evaluationValues: []
      *     })
@@ -135,17 +136,16 @@ class TestSuites {
                 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/${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.7", "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.11", "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",
-                }),
+                requestType: "json",
+                body: 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, {
+                return serializers.TestSuiteTestCase.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -183,9 +183,10 @@ class TestSuites {
                 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/${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.7", "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.11", "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, {
+                requestType: "json",
+                body: serializers.testSuites.testSuiteTestCasesBulk.Request.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 responseType: "streaming",
@@ -197,7 +198,7 @@ class TestSuites {
                 return new core.Stream({
                     stream: _response.body,
                     parse: (data) => __awaiter(this, void 0, void 0, function* () {
-                        return yield serializers.testSuites.testSuiteTestCasesBulk.StreamData.parseOrThrow(data, {
+                        return serializers.testSuites.testSuiteTestCasesBulk.StreamData.parseOrThrow(data, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -240,7 +241,7 @@ class TestSuites {
      * @param {TestSuites.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
+     *     await client.testSuites.deleteTestSuiteTestCase("id", "test_case_id")
      */
     deleteTestSuiteTestCase(id, testCaseId, requestOptions) {
         var _a;
@@ -249,8 +250,9 @@ class TestSuites {
                 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/${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.7", "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.11", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
+                requestType: "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,