mavenagi 1.2.4 → 1.2.5

package/api/resources/analytics/types/ConversationPieChartRequest.d.ts

@@ -1,6 +1,18 @@
 import * as MavenAGI from "../../../index";
 export interface ConversationPieChartRequest extends MavenAGI.ConversationAnalyticsRequest {
-    /** Field used to group data into slices for the pie chart. */
+    /**
+     * Field used to group data into slices for the pie chart.
+     *
+     * **Series Name Formats by Field:**
+     * - `Sources`: Document title (e.g., "Product Documentation")
+     * - `Actions`: "Action Name - App Name" (e.g., "Create Ticket - Freshdesk")
+     * - `IncompleteActions`: "Action Name - App Name" (e.g., "Search Documents - Zendesk")
+     * - `Users`: User identifier value (e.g., "user@example.com")
+     * - `InboxItems`: Inbox item title
+     * - `HumanAgents`: Human agent display name
+     * - `HumanAgentsWithInserts`: Human agent display name (for agents who made inserts)
+     * - Other fields: Field value as stored (e.g., "GOOD", "NEEDS_IMPROVEMENT" for Quality)
+     */
     groupBy: MavenAGI.ConversationGroupBy;
     /** Metric defining the value for each pie slice, stored in the y-axis value. */
     metric: MavenAGI.ConversationMetric;

package/api/resources/commons/types/ActionResponse.d.ts

@@ -26,6 +26,13 @@ import * as MavenAGI from "../../../index";
  *                     key: "userKey2"
  *                 }]
  *         },
+ *         segmentId: {
+ *             referenceId: "premium-users",
+ *             appId: "my-billing-system",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Segment
+ *         },
  *         language: "en",
  *         deleted: false
  *     }

package/api/resources/commons/types/SimulationContext.d.ts

@@ -1,5 +1,11 @@
 import * as MavenAGI from "../../../index";
 export interface SimulationContext {
+    /**
+     * If provided, overrides the agent's default additional prompt text during the simulation.
+     * Note that this field is provided for backwards compatibility and will be removed in a future release.
+     * Instead please use the `availableKnowledgeBases` field to include a knowledge base with a document `llmInclusionStatus` set to `ALWAYS`.
+     */
+    additionalPromptText?: string;
     /** The persona to use during the simulation. If not provided, the agent's default persona will be used. */
     persona?: MavenAGI.LlmPersona;
     /** If provided, knowledge search will be restricted to the provided list of knowledge bases. Otherwise, all active knowledge bases will be used. An empty list means no knowledge bases will be used. */

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

@@ -300,7 +300,11 @@ export declare class Conversation {
     createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.Feedback>;
     private __createFeedback;
     /**
-     * Submit a filled out action form
+     * Submit a filled out action form.
+     * Action forms can not be submitted more than once, attempting to do so will result in an error.
+     *
+     * Additionally, form submission is only allowed when the form is the last message in the conversation.
+     * Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
      *
      * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
      * @param {MavenAGI.SubmitActionFormRequest} request
@@ -384,6 +388,19 @@ export declare class Conversation {
      */
     search(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationsResponse>;
     private __search;
+    /**
+     * Export conversations to a CSV file.
+     *
+     * This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
+     *
+     * For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
+     * The CSV format may change over time and should not be relied upon by code consumers.
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    export(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __export;
     /**
      * Deliver a message to a user or conversation.
      *

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

@@ -1139,7 +1139,11 @@ class Conversation {
         });
     }
     /**
-     * Submit a filled out action form
+     * Submit a filled out action form.
+     * Action forms can not be submitted more than once, attempting to do so will result in an error.
+     *
+     * Additionally, form submission is only allowed when the form is the last message in the conversation.
+     * Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
      *
      * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
      * @param {MavenAGI.SubmitActionFormRequest} request
@@ -1545,6 +1549,92 @@ class Conversation {
             }
         });
     }
+    /**
+     * Export conversations to a CSV file.
+     *
+     * This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
+     *
+     * For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
+     * The CSV format may change over time and should not be relied upon by code consumers.
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    export(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__export(request, requestOptions));
+    }
+    __export(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            let _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
+                "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, "/v1/conversations/export"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.ConversationsSearchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "binary-response",
+                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 { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/conversations/export.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Deliver a message to a user or conversation.
      *

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

@@ -95,5 +95,15 @@ export declare class Events {
      */
     get(eventId: string, request: MavenAGI.EventGetRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<MavenAGI.EventResponse>;
     private __get;
+    /**
+     * Export events to a CSV file.
+     *
+     * This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    export(request: MavenAGI.EventsSearchRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<core.BinaryResponse>;
+    private __export;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -353,6 +353,89 @@ class Events {
             }
         });
     }
+    /**
+     * Export events to a CSV file.
+     *
+     * This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     */
+    export(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__export(request, requestOptions));
+    }
+    __export(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            let _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
+                "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, "/v1/events/export"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.EventsSearchRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "binary-response",
+                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 { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/events/export.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;

package/api/resources/index.d.ts

@@ -31,6 +31,7 @@ export * from "./users/types";
 export * from "./commons/errors";
 export * as events from "./events";
 export * from "./actions/client/requests";
+export * from "./agents/client/requests";
 export * from "./appSettings/client/requests";
 export * from "./conversation/client/requests";
 export * from "./events/client/requests";

package/api/resources/index.js

@@ -70,6 +70,7 @@ __exportStar(require("./users/types"), exports);
 __exportStar(require("./commons/errors"), exports);
 exports.events = __importStar(require("./events"));
 __exportStar(require("./actions/client/requests"), exports);
+__exportStar(require("./agents/client/requests"), exports);
 __exportStar(require("./appSettings/client/requests"), exports);
 __exportStar(require("./conversation/client/requests"), exports);
 __exportStar(require("./events/client/requests"), exports);

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

@@ -87,6 +87,27 @@ export declare class Knowledge {
      */
     getKnowledgeBase(knowledgeBaseReferenceId: string, request?: MavenAGI.KnowledgeBaseGetRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
     private __getKnowledgeBase;
+    /**
+     * Request that a knowledge base refresh itself.
+     *
+     * Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
+     * They can also be refreshed on demand by calling this endpoint.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeBaseRefreshRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.refreshKnowledgeBase("help-center", {
+     *         appId: "readme"
+     *     })
+     */
+    refreshKnowledgeBase(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseRefreshRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
+    private __refreshKnowledgeBase;
     /**
      * Update mutable knowledge base fields
      *
@@ -102,7 +123,17 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId")
+     *     await client.knowledge.patchKnowledgeBase("help-center", {
+     *         name: "Updated Help Center",
+     *         tags: new Set(["tag1", "tag2", "tag3"]),
+     *         segmentId: {
+     *             referenceId: "premium-users",
+     *             appId: "readme",
+     *             organizationId: "acme",
+     *             agentId: "support",
+     *             type: "SEGMENT"
+     *         }
+     *     })
      */
     patchKnowledgeBase(knowledgeBaseReferenceId: string, request?: MavenAGI.KnowledgeBasePatchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
     private __patchKnowledgeBase;

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

@@ -347,6 +347,99 @@ class Knowledge {
             }
         });
     }
+    /**
+     * Request that a knowledge base refresh itself.
+     *
+     * Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
+     * They can also be refreshed on demand by calling this endpoint.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeBaseRefreshRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.refreshKnowledgeBase("help-center", {
+     *         appId: "readme"
+     *     })
+     */
+    refreshKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__refreshKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions));
+    }
+    __refreshKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            let _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
+                "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${encodeURIComponent(knowledgeBaseReferenceId)}/refresh`),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.KnowledgeBaseRefreshRequest.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 { data: undefined, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/knowledge/{knowledgeBaseReferenceId}/refresh.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Update mutable knowledge base fields
      *
@@ -362,7 +455,17 @@ class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId")
+     *     await client.knowledge.patchKnowledgeBase("help-center", {
+     *         name: "Updated Help Center",
+     *         tags: new Set(["tag1", "tag2", "tag3"]),
+     *         segmentId: {
+     *             referenceId: "premium-users",
+     *             appId: "readme",
+     *             organizationId: "acme",
+     *             agentId: "support",
+     *             type: "SEGMENT"
+     *         }
+     *     })
      */
     patchKnowledgeBase(knowledgeBaseReferenceId, request = {}, requestOptions) {
         return core.HttpResponsePromise.fromPromise(this.__patchKnowledgeBase(knowledgeBaseReferenceId, request, requestOptions));

package/api/resources/knowledge/client/requests/KnowledgeBasePatchRequest.d.ts

@@ -1,7 +1,17 @@
 import * as MavenAGI from "../../../../index";
 /**
  * @example
- *     {}
+ *     {
+ *         name: "Updated Help Center",
+ *         tags: new Set(["tag1", "tag2", "tag3"]),
+ *         segmentId: {
+ *             referenceId: "premium-users",
+ *             appId: "readme",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: "SEGMENT"
+ *         }
+ *     }
  */
 export interface KnowledgeBasePatchRequest {
     /** The App ID of the knowledge base to patch. If not provided the ID of the calling app will be used. */

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

@@ -1,6 +1,4 @@
 export interface BaseKnowledgeDocument {
-    /** The title of the document. Will be shown as part of answers. */
-    title: string;
     /** The URL of the document. Should be visible to end users. Will be shown as part of answers. Not used for crawling. */
     url?: string;
     /** The document language. Must be a valid ISO 639-1 language code. */

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

@@ -1,5 +1,6 @@
 export declare const KnowledgeBaseField: {
     readonly Title: "Title";
+    readonly CreatedAt: "CreatedAt";
     readonly UpdatedAt: "UpdatedAt";
 };
 export type KnowledgeBaseField = (typeof KnowledgeBaseField)[keyof typeof KnowledgeBaseField];

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

@@ -4,5 +4,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.KnowledgeBaseField = void 0;
 exports.KnowledgeBaseField = {
     Title: "Title",
+    CreatedAt: "CreatedAt",
     UpdatedAt: "UpdatedAt",
 };

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

@@ -1,3 +1,4 @@
+import * as MavenAGI from "../../../index";
 export interface KnowledgeBaseFilter {
     /**
      * Full-text search query for matching knowledge bases by content.
@@ -22,4 +23,8 @@ export interface KnowledgeBaseFilter {
     createdBefore?: Date;
     /** Filter by app IDs */
     appIds?: string[];
+    /** Filter knowledge bases by the most recent version status */
+    mostRecentVersionStatus?: MavenAGI.KnowledgeBaseVersionStatus[];
+    /** Filter knowledge bases by the LLM inclusion status */
+    llmInclusionStatus?: MavenAGI.LlmInclusionStatus;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         appId: "readme"
+ *     }
+ */
+export interface KnowledgeBaseRefreshRequest {
+    /** The App ID of the knowledge base to refresh. If not provided the ID of the calling app will be used. */
+    appId?: string;
+}

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

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

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

@@ -2,6 +2,8 @@ import * as MavenAGI from "../../../index";
 /**
  * @example
  *     {
+ *         createdAt: new Date("2025-01-01T00:00:00.000Z"),
+ *         updatedAt: new Date("2025-02-02T00:00:00.000Z"),
  *         knowledgeBaseId: {
  *             referenceId: "help-center",
  *             appId: "readme",
@@ -9,20 +11,46 @@ import * as MavenAGI from "../../../index";
  *             agentId: "support",
  *             type: MavenAGI.EntityType.KnowledgeBase
  *         },
+ *         activeVersionId: {
+ *             referenceId: "version-1",
+ *             appId: "readme",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.KnowledgeBaseVersion
+ *         },
+ *         mostRecentVersionStatus: MavenAGI.KnowledgeBaseVersionStatus.Succeeded,
+ *         llmInclusionStatus: MavenAGI.LlmInclusionStatus.WhenRelevant,
  *         name: "Help center",
  *         type: MavenAGI.KnowledgeBaseType.Api,
  *         metadata: {
  *             "key": "value"
  *         },
  *         tags: new Set(["tag1", "tag2"]),
- *         refreshFrequency: MavenAGI.KnowledgeBaseRefreshFrequency.Daily
+ *         refreshFrequency: MavenAGI.KnowledgeBaseRefreshFrequency.Daily,
+ *         segmentId: {
+ *             referenceId: "premium-users",
+ *             appId: "readme",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Segment
+ *         }
  *     }
  */
 export interface KnowledgeBaseResponse extends MavenAGI.KnowledgeBaseProperties {
+    /** The date and time when the knowledge base was created. */
+    createdAt: Date;
+    /** The date and time when the knowledge base was last updated. */
+    updatedAt: Date;
     /** ID that uniquely identifies this knowledge base */
     knowledgeBaseId: MavenAGI.EntityId;
     /** ID of the knowledge base version that is currently active. Documents can be fetched using this version ID. */
     activeVersionId?: MavenAGI.EntityId;
+    /**
+     * The status of the most recent version of the knowledge base.
+     * The `activeVersionId` will only be populated if this status is `SUCCEEDED`.
+     * Use the `listKnowledgeBaseVersions` endpoint to get the full list of versions.
+     */
+    mostRecentVersionStatus: MavenAGI.KnowledgeBaseVersionStatus;
     /** The type of the knowledge base. Can not be changed once created. */
     type: MavenAGI.KnowledgeBaseType;
     /** Metadata for the knowledge base. */

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

@@ -1,5 +1,12 @@
-/** API knowledge bases are managed by a Maven App. */
+/**
+ * API knowledge bases are managed by a Maven App.
+ * All other knowledge base types are deprecated and can not be created.
+ */
 export declare const KnowledgeBaseType: {
     readonly Api: "API";
+    readonly Url: "URL";
+    readonly Manual: "MANUAL";
+    readonly Rss: "RSS";
+    readonly Legacy: "LEGACY";
 };
 export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];

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

@@ -2,7 +2,14 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KnowledgeBaseType = void 0;
-/** API knowledge bases are managed by a Maven App. */
+/**
+ * API knowledge bases are managed by a Maven App.
+ * All other knowledge base types are deprecated and can not be created.
+ */
 exports.KnowledgeBaseType = {
     Api: "API",
+    Url: "URL",
+    Manual: "MANUAL",
+    Rss: "RSS",
+    Legacy: "LEGACY",
 };