vellum-ai 0.6.8 → 0.6.12

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

@@ -10,8 +10,11 @@ export declare namespace DocumentIndexes {
         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 DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.list()
+     *     await client.documentIndexes.list()
      */
     list(request?: Vellum.DocumentIndexesListRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.PaginatedDocumentIndexReadList>;
     /**
@@ -35,7 +38,7 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.create({
+     *     await client.documentIndexes.create({
      *         label: "string",
      *         name: "string",
      *         status: Vellum.EntityStatus.Active,
@@ -59,7 +62,7 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.retrieve("string")
+     *     await client.documentIndexes.retrieve("string")
      */
     retrieve(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
     /**
@@ -70,7 +73,7 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.update("string", {
+     *     await client.documentIndexes.update("string", {
      *         label: "string",
      *         status: Vellum.EntityStatus.Active,
      *         environment: Vellum.EnvironmentEnum.Development
@@ -84,7 +87,7 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.destroy("id")
+     *     await client.documentIndexes.destroy("id")
      */
     destroy(id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     /**
@@ -95,13 +98,24 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.partialUpdate("string", {
+     *     await client.documentIndexes.partialUpdate("string", {
      *         label: "string",
      *         status: Vellum.EntityStatus.Active,
      *         environment: Vellum.EnvironmentEnum.Development
      *     })
      */
     partialUpdate(id: string, request?: Vellum.PatchedDocumentIndexUpdateRequest, requestOptions?: DocumentIndexes.RequestOptions): Promise<Vellum.DocumentIndexRead>;
+    /**
+     * Adds a previously uploaded Document to the specified Document Index.
+     *
+     * @param {string} documentId - Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
+     * @param {string} id - Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentIndexes.addDocument("document_id", "id")
+     */
+    addDocument(documentId: string, id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     /**
      * Removes a Document from a Document Index without deleting the Document itself.
      *
@@ -110,7 +124,7 @@ export declare class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.removeDocument("document_id", "id")
+     *     await client.documentIndexes.removeDocument("document_id", "id")
      */
     removeDocument(documentId: string, id: string, requestOptions?: DocumentIndexes.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{

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

@@ -55,7 +55,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.list()
+     *     await client.documentIndexes.list()
      */
     list(request = {}, requestOptions) {
         var _a;
@@ -81,15 +81,16 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "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.PaginatedDocumentIndexReadList.parseOrThrow(_response.body, {
+                return serializers.PaginatedDocumentIndexReadList.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -124,7 +125,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.create({
+     *     await client.documentIndexes.create({
      *         label: "string",
      *         name: "string",
      *         status: Vellum.EntityStatus.Active,
@@ -147,17 +148,16 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, "v1/document-indexes"),
                 method: "POST",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.DocumentIndexCreateRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.DocumentIndexCreateRequest.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.DocumentIndexRead.parseOrThrow(_response.body, {
+                return serializers.DocumentIndexRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -192,7 +192,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.retrieve("string")
+     *     await client.documentIndexes.retrieve("string")
      */
     retrieve(id, requestOptions) {
         var _a;
@@ -201,14 +201,15 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "GET",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "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.DocumentIndexRead.parseOrThrow(_response.body, {
+                return serializers.DocumentIndexRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -244,7 +245,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.update("string", {
+     *     await client.documentIndexes.update("string", {
      *         label: "string",
      *         status: Vellum.EntityStatus.Active,
      *         environment: Vellum.EnvironmentEnum.Development
@@ -257,17 +258,16 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PUT",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.DocumentIndexUpdateRequest.jsonOrThrow(request, {
-                    unrecognizedObjectKeys: "strip",
-                }),
+                requestType: "json",
+                body: serializers.DocumentIndexUpdateRequest.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.DocumentIndexRead.parseOrThrow(_response.body, {
+                return serializers.DocumentIndexRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -302,7 +302,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.destroy("id")
+     *     await client.documentIndexes.destroy("id")
      */
     destroy(id, requestOptions) {
         var _a;
@@ -311,8 +311,9 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "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,
@@ -349,7 +350,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.partialUpdate("string", {
+     *     await client.documentIndexes.partialUpdate("string", {
      *         label: "string",
      *         status: Vellum.EntityStatus.Active,
      *         environment: Vellum.EnvironmentEnum.Development
@@ -362,9 +363,10 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}`),
                 method: "PATCH",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())),
                 contentType: "application/json",
-                body: yield serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
+                requestType: "json",
+                body: serializers.PatchedDocumentIndexUpdateRequest.jsonOrThrow(request, {
                     unrecognizedObjectKeys: "strip",
                 }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : undefined,
@@ -372,7 +374,7 @@ class DocumentIndexes {
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return yield serializers.DocumentIndexRead.parseOrThrow(_response.body, {
+                return serializers.DocumentIndexRead.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -400,6 +402,54 @@ class DocumentIndexes {
             }
         });
     }
+    /**
+     * Adds a previously uploaded Document to the specified Document Index.
+     *
+     * @param {string} documentId - Either the Vellum-generated ID or the originally supplied external_id that uniquely identifies the Document you'd like to add.
+     * @param {string} id - Either the Vellum-generated ID or the originally specified name that uniquely identifies the Document Index to which you'd like to add the Document.
+     * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.documentIndexes.addDocument("document_id", "id")
+     */
+    addDocument(documentId, id, 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/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
+                method: "POST",
+                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.12", "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;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.VellumError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.VellumError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.VellumTimeoutError();
+                case "unknown":
+                    throw new errors.VellumError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     /**
      * Removes a Document from a Document Index without deleting the Document itself.
      *
@@ -408,7 +458,7 @@ class DocumentIndexes {
      * @param {DocumentIndexes.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documentIndexes.removeDocument("document_id", "id")
+     *     await client.documentIndexes.removeDocument("document_id", "id")
      */
     removeDocument(documentId, id, requestOptions) {
         var _a;
@@ -417,8 +467,9 @@ class DocumentIndexes {
                 url: (0, url_join_1.default)(((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.VellumEnvironment.Production)
                     .default, `v1/document-indexes/${encodeURIComponent(id)}/documents/${encodeURIComponent(documentId)}`),
                 method: "DELETE",
-                headers: Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "vellum-ai", "X-Fern-SDK-Version": "0.6.8", "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.12", "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/documents/client/Client.d.ts

@@ -6,14 +6,18 @@ import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as Vellum from "../../../index";
 import * as fs from "fs";
+import { Blob } from "buffer";
 export declare namespace Documents {
     interface Options {
         environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
         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;
     }
 }
@@ -27,7 +31,7 @@ export declare class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.list()
+     *     await client.documents.list()
      */
     list(request?: Vellum.DocumentsListRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.PaginatedSlimDocumentList>;
     /**
@@ -37,7 +41,7 @@ export declare class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.retrieve("id")
+     *     await client.documents.retrieve("id")
      */
     retrieve(id: string, requestOptions?: Documents.RequestOptions): Promise<Vellum.DocumentRead>;
     /**
@@ -47,7 +51,7 @@ export declare class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.destroy("id")
+     *     await client.documents.destroy("id")
      */
     destroy(id: string, requestOptions?: Documents.RequestOptions): Promise<void>;
     /**
@@ -58,7 +62,7 @@ export declare class Documents {
      * @param {Documents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await vellum.documents.partialUpdate("id")
+     *     await client.documents.partialUpdate("id")
      */
     partialUpdate(id: string, request?: Vellum.PatchedDocumentUpdateRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.DocumentRead>;
     /**
@@ -74,7 +78,7 @@ export declare 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.
      *
@@ -83,11 +87,11 @@ export declare 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: File | fs.ReadStream, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.UploadDocumentResponse>;
+    upload(contents: File | fs.ReadStream | Blob, request: Vellum.UploadDocumentBodyRequest, requestOptions?: Documents.RequestOptions): Promise<Vellum.UploadDocumentResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         X_API_KEY: string;
     }>;

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.8", "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.12", "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.8", "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.12", "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.8", "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.12", "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.8", "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.12", "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.8", "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.12", "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.8", "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.12", "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,