mavenagi 1.0.10 → 1.0.12

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

@@ -83,7 +83,15 @@ export declare class Knowledge {
      *
      * @example
      *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
-     *         type: "FULL"
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven",
+     *             organizationId: "acme",
+     *             agentId: "support"
+     *         },
+     *         type: "FULL",
+     *         status: "IN_PROGRESS"
      *     })
      */
     createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
@@ -91,6 +99,7 @@ export declare class Knowledge {
      * Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
      *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.FinalizeKnowledgeBaseVersionRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -98,12 +107,24 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center")
+     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
+     *         status: "SUCCEEDED"
+     *     })
      */
-    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.FinalizeKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
     /**
      * Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
      *
+     * <Tip>
+     * This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
+     * have changed, a new document version will not be created. The existing version will be reused.
+     * </Tip>
+     *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
@@ -117,9 +138,17 @@ export declare class Knowledge {
      *         knowledgeDocumentId: {
      *             referenceId: "getting-started"
      *         },
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
      *         contentType: "MARKDOWN",
      *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started"
+     *         title: "Getting started",
+     *         metadata: {
+     *             "category": "getting-started"
+     *         }
      *     })
      */
     createKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
@@ -139,9 +168,17 @@ export declare class Knowledge {
      *         knowledgeDocumentId: {
      *             referenceId: "getting-started"
      *         },
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
      *         contentType: "MARKDOWN",
      *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started"
+     *         title: "Getting started",
+     *         metadata: {
+     *             "category": "getting-started"
+     *         }
      *     })
      */
     updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;

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

@@ -83,7 +83,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/knowledge"),
                 method: "PUT",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.KnowledgeBaseRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -163,7 +163,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -238,7 +238,15 @@ class Knowledge {
      *
      * @example
      *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
-     *         type: "FULL"
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven",
+     *             organizationId: "acme",
+     *             agentId: "support"
+     *         },
+     *         type: "FULL",
+     *         status: "IN_PROGRESS"
      *     })
      */
     createKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
@@ -247,7 +255,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/version`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.KnowledgeBaseVersion.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -312,6 +320,7 @@ class Knowledge {
      * Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
      *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.FinalizeKnowledgeBaseVersionRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -319,23 +328,38 @@ class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center")
+     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
+     *         status: "SUCCEEDED"
+     *     })
      */
-    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId, requestOptions) {
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/version/finalize`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
+                body: serializers.FinalizeKnowledgeBaseVersionRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
             });
             if (_response.ok) {
-                return;
+                return serializers.KnowledgeBaseVersion.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
@@ -385,6 +409,11 @@ class Knowledge {
     /**
      * Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
      *
+     * <Tip>
+     * This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
+     * have changed, a new document version will not be created. The existing version will be reused.
+     * </Tip>
+     *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
@@ -398,9 +427,17 @@ class Knowledge {
      *         knowledgeDocumentId: {
      *             referenceId: "getting-started"
      *         },
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
      *         contentType: "MARKDOWN",
      *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started"
+     *         title: "Getting started",
+     *         metadata: {
+     *             "category": "getting-started"
+     *         }
      *     })
      */
     createKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
@@ -409,7 +446,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/document`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.KnowledgeDocumentRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -486,9 +523,17 @@ class Knowledge {
      *         knowledgeDocumentId: {
      *             referenceId: "getting-started"
      *         },
+     *         versionId: {
+     *             type: "KNOWLEDGE_BASE_VERSION",
+     *             referenceId: "versionId",
+     *             appId: "maven"
+     *         },
      *         contentType: "MARKDOWN",
      *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started"
+     *         title: "Getting started",
+     *         metadata: {
+     *             "category": "getting-started"
+     *         }
      *     })
      */
     updateKnowledgeDocument(knowledgeBaseReferenceId, request, requestOptions) {
@@ -497,7 +542,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/document`),
                 method: "PUT",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.KnowledgeDocumentRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -578,7 +623,7 @@ class Knowledge {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/${encodeURIComponent(knowledgeDocumentReferenceId)}/document`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/api/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.d.ts

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         versionId: {
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion,
+ *             referenceId: "versionId",
+ *             appId: "maven"
+ *         },
+ *         status: MavenAGI.KnowledgeBaseVersionFinalizeStatus.Succeeded
+ *     }
+ */
+export interface FinalizeKnowledgeBaseVersionRequest {
+    /** ID that uniquely identifies which knowledge base version to finalize. If not provided will use the most recent version of the knowledge base. */
+    versionId?: MavenAGI.EntityIdWithoutAgent;
+    /** Whether the knowledge base version processing was successful or not. */
+    status?: MavenAGI.KnowledgeBaseVersionFinalizeStatus;
+    /** A user-facing error message that provides more details about a version failure. */
+    errorMessage?: string;
+}

package/api/resources/knowledge/types/FinalizeKnowledgeBaseVersionRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/knowledge/types/KnowledgeBaseRequest.d.ts

@@ -14,4 +14,6 @@ import * as MavenAGI from "../../../index";
 export interface KnowledgeBaseRequest extends MavenAGI.KnowledgeBaseProperties {
     /** ID that uniquely identifies this knowledge base */
     knowledgeBaseId: MavenAGI.EntityIdBase;
+    /** Metadata for the knowledge base. */
+    metadata?: Record<string, string>;
 }

package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts

@@ -13,7 +13,10 @@ import * as MavenAGI from "../../../index";
  *             type: MavenAGI.EntityType.KnowledgeBase
  *         },
  *         name: "Help center",
- *         type: MavenAGI.KnowledgeBaseType.Api
+ *         type: MavenAGI.KnowledgeBaseType.Api,
+ *         metadata: {
+ *             "key": "value"
+ *         }
  *     }
  */
 export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties {
@@ -21,4 +24,6 @@ export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties
     knowledgeBaseId: MavenAGI.EntityId;
     /** The type of the knowledge base. Can not be changed once created. */
     type: MavenAGI.KnowledgeBaseType;
+    /** Metadata for the knowledge base. */
+    metadata: Record<string, string>;
 }

package/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts

@@ -5,10 +5,24 @@ import * as MavenAGI from "../../../index";
 /**
  * @example
  *     {
- *         type: MavenAGI.KnowledgeBaseVersionType.Full
+ *         versionId: {
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion,
+ *             referenceId: "versionId",
+ *             appId: "maven",
+ *             organizationId: "acme",
+ *             agentId: "support"
+ *         },
+ *         type: MavenAGI.KnowledgeBaseVersionType.Full,
+ *         status: MavenAGI.KnowledgeBaseVersionStatus.InProgress
  *     }
  */
 export interface KnowledgeBaseVersion {
+    /** The unique ID of the knowledge base version. */
+    versionId: MavenAGI.EntityId;
     /** Indicates whether the completed version constitutes a full or partial refresh of the knowledge base. Deleting and updating documents is only supported for partial refreshes. */
     type: MavenAGI.KnowledgeBaseVersionType;
+    /** The status of the knowledge base version */
+    status: MavenAGI.KnowledgeBaseVersionStatus;
+    /** A user-facing error message that provides more details about a version failure. */
+    errorMessage?: string;
 }

package/api/resources/knowledge/types/KnowledgeBaseVersionFinalizeStatus.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Whether the knowledge base version processing was successful or not.
+ */
+export type KnowledgeBaseVersionFinalizeStatus = "SUCCEEDED" | "FAILED";
+export declare const KnowledgeBaseVersionFinalizeStatus: {
+    readonly Succeeded: "SUCCEEDED";
+    readonly Failed: "FAILED";
+};

package/api/resources/knowledge/types/KnowledgeBaseVersionFinalizeStatus.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseVersionFinalizeStatus = void 0;
+exports.KnowledgeBaseVersionFinalizeStatus = {
+    Succeeded: "SUCCEEDED",
+    Failed: "FAILED",
+};

package/api/resources/knowledge/types/KnowledgeBaseVersionStatus.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the knowledge base version
+ */
+export type KnowledgeBaseVersionStatus = "SUCCEEDED" | "FAILED" | "IN_PROGRESS";
+export declare const KnowledgeBaseVersionStatus: {
+    readonly Succeeded: "SUCCEEDED";
+    readonly Failed: "FAILED";
+    readonly InProgress: "IN_PROGRESS";
+};

package/api/resources/knowledge/types/KnowledgeBaseVersionStatus.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KnowledgeBaseVersionStatus = void 0;
+exports.KnowledgeBaseVersionStatus = {
+    Succeeded: "SUCCEEDED",
+    Failed: "FAILED",
+    InProgress: "IN_PROGRESS",
+};

package/api/resources/knowledge/types/KnowledgeDocumentRequest.d.ts

@@ -8,15 +8,27 @@ import * as MavenAGI from "../../../index";
  *         knowledgeDocumentId: {
  *             referenceId: "getting-started"
  *         },
+ *         versionId: {
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion,
+ *             referenceId: "versionId",
+ *             appId: "maven"
+ *         },
  *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
  *         content: "## Getting started\\nThis is a getting started guide for the help center.",
- *         title: "Getting started"
+ *         title: "Getting started",
+ *         metadata: {
+ *             "category": "getting-started"
+ *         }
  *     }
  */
 export interface KnowledgeDocumentRequest extends MavenAGI.BaseKnowledgeDocument {
     /** ID that uniquely identifies this knowledge document within its knowledge base */
     knowledgeDocumentId: MavenAGI.EntityIdBase;
+    /** ID that uniquely identifies which knowledge base version to create the document in. If not provided will use the most recent version of the knowledge base. */
+    versionId?: MavenAGI.EntityIdWithoutAgent;
     contentType: MavenAGI.KnowledgeDocumentContentType;
     /** The content of the document. Not shown directly to users. May be provided in HTML or markdown. HTML will be converted to markdown automatically. Images are not currently supported and will be ignored. */
     content: string;
+    /** Metadata for the knowledge document. */
+    metadata?: Record<string, string>;
 }

package/api/resources/knowledge/types/KnowledgeDocumentResponse.d.ts

@@ -13,7 +13,10 @@ import * as MavenAGI from "../../../index";
  *             type: MavenAGI.EntityType.KnowledgeDocument
  *         },
  *         content: "## Getting started This is a getting started guide for the help center.",
- *         title: "Getting started"
+ *         title: "Getting started",
+ *         metadata: {
+ *             "category": "getting-started"
+ *         }
  *     }
  */
 export interface KnowledgeDocumentResponse extends MavenAGI.BaseKnowledgeDocument {
@@ -21,4 +24,6 @@ export interface KnowledgeDocumentResponse extends MavenAGI.BaseKnowledgeDocumen
     knowledgeDocumentId: MavenAGI.EntityId;
     /** The content of the document in markdown format. Not shown directly to users. */
     content: string;
+    /** Metadata for the knowledge document. */
+    metadata: Record<string, string>;
 }

package/api/resources/knowledge/types/index.d.ts

@@ -4,6 +4,9 @@ export * from "./KnowledgeBaseResponse";
 export * from "./KnowledgeBaseType";
 export * from "./KnowledgeBaseVersion";
 export * from "./KnowledgeBaseVersionType";
+export * from "./KnowledgeBaseVersionStatus";
+export * from "./KnowledgeBaseVersionFinalizeStatus";
+export * from "./FinalizeKnowledgeBaseVersionRequest";
 export * from "./BaseKnowledgeDocument";
 export * from "./KnowledgeDocumentContentType";
 export * from "./KnowledgeDocumentRequest";

package/api/resources/knowledge/types/index.js

@@ -20,6 +20,9 @@ __exportStar(require("./KnowledgeBaseResponse"), exports);
 __exportStar(require("./KnowledgeBaseType"), exports);
 __exportStar(require("./KnowledgeBaseVersion"), exports);
 __exportStar(require("./KnowledgeBaseVersionType"), exports);
+__exportStar(require("./KnowledgeBaseVersionStatus"), exports);
+__exportStar(require("./KnowledgeBaseVersionFinalizeStatus"), exports);
+__exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
 __exportStar(require("./BaseKnowledgeDocument"), exports);
 __exportStar(require("./KnowledgeDocumentContentType"), exports);
 __exportStar(require("./KnowledgeDocumentRequest"), exports);

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

@@ -0,0 +1,147 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Organizations {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
+        organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    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;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Organizations {
+    protected readonly _options: Organizations.Options;
+    constructor(_options: Organizations.Options);
+    /**
+     * Retrieves structured conversation data across all organizations, formatted as a table,
+     * allowing users to group, filter, and define specific metrics to display as columns.
+     *
+     * <Tip>
+     * This endpoint requires additional permissions. Contact support to request access.
+     * </Tip>
+     *
+     * @param {MavenAGI.ConversationTableRequest} request
+     * @param {Organizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.organizations.getConversationTable({
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         timeGrouping: "DAY",
+     *         fieldGroupings: [{
+     *                 field: "Category"
+     *             }],
+     *         columnDefinitions: [{
+     *                 header: "count",
+     *                 metric: {
+     *                     type: "count"
+     *                 }
+     *             }, {
+     *                 header: "avg_first_response_time",
+     *                 metric: {
+     *                     type: "average",
+     *                     targetField: "FirstResponseTime"
+     *                 }
+     *             }, {
+     *                 header: "percentile_handle_time",
+     *                 metric: {
+     *                     type: "percentile",
+     *                     targetField: "HandleTime",
+     *                     percentile: 25
+     *                 }
+     *             }]
+     *     })
+     */
+    getConversationTable(request: MavenAGI.ConversationTableRequest, requestOptions?: Organizations.RequestOptions): Promise<MavenAGI.ConversationTableResponse>;
+    /**
+     * Fetches conversation data across all organizations, visualized in a chart format.
+     * Supported chart types include pie chart, date histogram, and stacked bar charts.
+     *
+     * <Tip>
+     * This endpoint requires additional permissions. Contact support to request access.
+     * </Tip>
+     *
+     * @param {MavenAGI.ConversationChartRequest} request
+     * @param {Organizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.organizations.getConversationChart({
+     *         type: "pieChart",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         groupBy: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.organizations.getConversationChart({
+     *         type: "dateHistogram",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         timeInterval: "DAY",
+     *         groupBy: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.organizations.getConversationChart({
+     *         type: "barChart",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         barDefinition: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         },
+     *         verticalGrouping: {
+     *             field: "ResolutionStatus"
+     *         }
+     *     })
+     */
+    getConversationChart(request: MavenAGI.ConversationChartRequest, requestOptions?: Organizations.RequestOptions): Promise<MavenAGI.ChartResponse>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}