mavenagi 1.1.0 → 1.2.3

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

@@ -82,6 +82,27 @@ export declare class Conversation {
      */
     initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
     private __initialize;
+    /**
+     * Update mutable conversation fields.
+     *
+     * The `appId` field can be provided to update a conversation owned by a different app.
+     * All other fields will overwrite the existing value on the conversation only if provided.
+     *
+     * @param {string} conversationId - The ID of the conversation to patch
+     * @param {MavenAGI.ConversationPatchRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.patch("conversation-0", {
+     *         llmEnabled: true
+     *     })
+     */
+    patch(conversationId: string, request: MavenAGI.ConversationPatchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
+    private __patch;
     /**
      * Get a conversation
      *
@@ -236,6 +257,23 @@ export declare class Conversation {
      */
     generateMavenSuggestions(conversationId: string, request: MavenAGI.GenerateMavenSuggestionsRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationResponse>;
     private __generateMavenSuggestions;
+    /**
+     * Generate a structured object response based on a provided schema and user prompt with a streaming response.
+     * The response will be sent as a stream of events containing text, start, and end events.
+     * The text portions of stream responses should be concatenated to form the full response text.
+     *
+     * If the user question and object response already exist, they will be reused and not updated.
+     *
+     * Concurrency Behavior:
+     * - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
+     * - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
+     *
+     * Known Limitations:
+     * - Schema enforcement is best-effort and may not guarantee exact conformity.
+     * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
+     */
+    askObjectStream(conversationId: string, request: MavenAGI.AskObjectRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<core.Stream<MavenAGI.ObjectStreamResponse>>;
+    private __askObjectStream;
     /**
      * Uses an LLM flow to categorize the conversation. Experimental.
      *
@@ -366,5 +404,42 @@ export declare class Conversation {
      */
     search(request: MavenAGI.ConversationsSearchRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.ConversationsResponse>;
     private __search;
+    /**
+     * Deliver a message to a user or conversation.
+     *
+     * <Warning>
+     * Currently, messages can only be successfully delivered to conversations with the `ASYNC` capability that are `open`.
+     * User message delivery is not yet supported.
+     * </Warning>
+     *
+     * @param {MavenAGI.DeliverMessageRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.deliverMessage({
+     *         type: "user",
+     *         userId: {
+     *             type: "AGENT",
+     *             appId: "appId",
+     *             referenceId: "referenceId"
+     *         },
+     *         message: {
+     *             conversationMessageId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             userId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             text: "text",
+     *             userMessageType: "USER"
+     *         }
+     *     })
+     */
+    deliverMessage(request: MavenAGI.DeliverMessageRequest, requestOptions?: Conversation.RequestOptions): core.HttpResponsePromise<MavenAGI.DeliverMessageResponse>;
+    private __deliverMessage;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -179,6 +179,105 @@ class Conversation {
             }
         });
     }
+    /**
+     * Update mutable conversation fields.
+     *
+     * The `appId` field can be provided to update a conversation owned by a different app.
+     * All other fields will overwrite the existing value on the conversation only if provided.
+     *
+     * @param {string} conversationId - The ID of the conversation to patch
+     * @param {MavenAGI.ConversationPatchRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.patch("conversation-0", {
+     *         llmEnabled: true
+     *     })
+     */
+    patch(conversationId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__patch(conversationId, request, requestOptions));
+    }
+    __patch(conversationId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_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/conversations/${encodeURIComponent(conversationId)}`),
+                method: "PATCH",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.ConversationPatchRequest.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: serializers.ConversationResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    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 PATCH /v1/conversations/{conversationId}.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Get a conversation
      *
@@ -199,11 +298,14 @@ class Conversation {
     __get(conversationId_1) {
         return __awaiter(this, arguments, void 0, function* (conversationId, request = {}, requestOptions) {
             var _a, _b, _c, _d;
-            const { appId } = request;
+            const { appId, translationLanguage } = request;
             const _queryParams = {};
             if (appId != null) {
                 _queryParams["appId"] = appId;
             }
+            if (translationLanguage != null) {
+                _queryParams["translationLanguage"] = translationLanguage;
+            }
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: core.url.join((_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/conversations/${encodeURIComponent(conversationId)}`),
                 method: "GET",
@@ -813,6 +915,112 @@ class Conversation {
             }
         });
     }
+    /**
+     * Generate a structured object response based on a provided schema and user prompt with a streaming response.
+     * The response will be sent as a stream of events containing text, start, and end events.
+     * The text portions of stream responses should be concatenated to form the full response text.
+     *
+     * If the user question and object response already exist, they will be reused and not updated.
+     *
+     * Concurrency Behavior:
+     * - If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
+     * - The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
+     *
+     * Known Limitations:
+     * - Schema enforcement is best-effort and may not guarantee exact conformity.
+     * - The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
+     */
+    askObjectStream(conversationId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__askObjectStream(conversationId, request, requestOptions));
+    }
+    __askObjectStream(conversationId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_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/conversations/${encodeURIComponent(conversationId)}/ask_object_stream`),
+                method: "POST",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.AskObjectRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "sse",
+                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: new core.Stream({
+                        stream: _response.body,
+                        parse: (data) => __awaiter(this, void 0, void 0, function* () {
+                            return serializers.ObjectStreamResponse.parseOrThrow(data, {
+                                unrecognizedObjectKeys: "passthrough",
+                                allowUnrecognizedUnionMembers: true,
+                                allowUnrecognizedEnumValues: true,
+                                breadcrumbsPrefix: ["response"],
+                            });
+                        }),
+                        signal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                        eventShape: {
+                            type: "sse",
+                            streamTerminator: "[DONE]",
+                        },
+                    }),
+                    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/{conversationId}/ask_object_stream.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Uses an LLM flow to categorize the conversation. Experimental.
      *
@@ -1410,6 +1618,121 @@ class Conversation {
             }
         });
     }
+    /**
+     * Deliver a message to a user or conversation.
+     *
+     * <Warning>
+     * Currently, messages can only be successfully delivered to conversations with the `ASYNC` capability that are `open`.
+     * User message delivery is not yet supported.
+     * </Warning>
+     *
+     * @param {MavenAGI.DeliverMessageRequest} request
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.deliverMessage({
+     *         type: "user",
+     *         userId: {
+     *             type: "AGENT",
+     *             appId: "appId",
+     *             referenceId: "referenceId"
+     *         },
+     *         message: {
+     *             conversationMessageId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             userId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             text: "text",
+     *             userMessageType: "USER"
+     *         }
+     *     })
+     */
+    deliverMessage(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__deliverMessage(request, requestOptions));
+    }
+    __deliverMessage(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_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/conversations/deliver-message"),
+                method: "POST",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.DeliverMessageRequest.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: serializers.DeliverMessageResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    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/deliver-message.");
+                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/dist/api/resources/conversation/client/requests/ConversationGetRequest.d.ts

@@ -10,4 +10,8 @@ export interface ConversationGetRequest {
      * The App ID of the conversation to get. If not provided the ID of the calling app will be used.
      */
     appId?: string;
+    /**
+     * The language to translate the conversation analysis into
+     */
+    translationLanguage?: string;
 }

package/dist/api/resources/conversation/types/ActionFormAttachment.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ActionFormAttachment {
+    /** The asset ID of the attachment. */
+    assetId: MavenAGI.EntityIdBase;
+}

package/dist/api/resources/conversation/types/ActionFormAttachment.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/dist/api/resources/conversation/types/ActionFormRequestParamValue.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export type ActionFormRequestParamValue = unknown | MavenAGI.ActionFormAttachment;

package/dist/api/resources/conversation/types/ActionFormRequestParamValue.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/dist/api/resources/conversation/types/AskObjectRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AskObjectRequest extends MavenAGI.AskRequest {
+    /** JSON schema string defining the expected object shape. */
+    schema: string;
+}

package/dist/api/resources/conversation/types/AskObjectRequest.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/dist/api/resources/conversation/types/AskRequest.d.ts

@@ -30,8 +30,11 @@ export interface AskRequest {
     userId: MavenAGI.EntityIdBase;
     /** The text of the message */
     text: string;
-    /** The attachments to the message. */
-    attachments?: MavenAGI.Attachment[];
+    /**
+     * The attachments to the message. Image attachments will be sent to the LLM as additional data.
+     * Non-image attachments can be stored and downloaded from the API but will not be sent to the LLM.
+     */
+    attachments?: MavenAGI.AttachmentRequest[];
     /** Transient data which the Maven platform will not persist. This data will only be forwarded to actions taken by this ask request. For example, one may put in user tokens as transient data. */
     transientData?: Record<string, string>;
     /** IANA timezone identifier (e.g. "America/New_York", "Europe/London") to be used for time-based operations in the conversation. */

package/dist/api/resources/conversation/types/AskStreamOAuthButtonEvent.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AskStreamOAuthButtonEvent extends MavenAGI.BotOAuthButtonResponse {
+}

package/dist/api/resources/conversation/types/AskStreamOAuthButtonEvent.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/dist/api/resources/conversation/types/ConversationField.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type ConversationField = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "HumanAgentsWithInserts" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt";
+export type ConversationField = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "HumanAgentsWithInserts" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "ResolvedByMaven" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt" | "PredictedNPS" | "OrganizationId" | "AgentId";
 export declare const ConversationField: {
     readonly Category: "Category";
     readonly FirstResponseTime: "FirstResponseTime";
@@ -12,6 +12,7 @@ export declare const ConversationField: {
     readonly Sentiment: "Sentiment";
     readonly QualityReason: "QualityReason";
     readonly ResolutionStatus: "ResolutionStatus";
+    readonly ResolvedByMaven: "ResolvedByMaven";
     readonly Quality: "Quality";
     readonly Users: "Users";
     readonly ResponseLength: "ResponseLength";
@@ -25,4 +26,7 @@ export declare const ConversationField: {
     readonly IncompleteActions: "IncompleteActions";
     readonly Sources: "Sources";
     readonly CreatedAt: "CreatedAt";
+    readonly PredictedNps: "PredictedNPS";
+    readonly OrganizationId: "OrganizationId";
+    readonly AgentId: "AgentId";
 };

package/dist/api/resources/conversation/types/ConversationField.js

@@ -14,6 +14,7 @@ exports.ConversationField = {
     Sentiment: "Sentiment",
     QualityReason: "QualityReason",
     ResolutionStatus: "ResolutionStatus",
+    ResolvedByMaven: "ResolvedByMaven",
     Quality: "Quality",
     Users: "Users",
     ResponseLength: "ResponseLength",
@@ -27,4 +28,7 @@ exports.ConversationField = {
     IncompleteActions: "IncompleteActions",
     Sources: "Sources",
     CreatedAt: "CreatedAt",
+    PredictedNps: "PredictedNPS",
+    OrganizationId: "OrganizationId",
+    AgentId: "AgentId",
 };

package/dist/api/resources/conversation/types/ConversationFilter.d.ts

@@ -3,7 +3,27 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationFilter {
-    /** Full-text search query for matching conversations by content. When you search with this parameter, you're performing a full-text search across all textual content in the conversations, including both the user's messages and the AI's responses. */
+    /**
+     * Full-text search query for matching conversations by content.
+     * When you search with this parameter, you're performing a full-text search across all textual content
+     * in the conversations, including both the user's messages and the AI's responses.
+     *
+     * This field also supports a syntax for advanced filtering the `metadata` and `tags` fields.
+     *
+     * Metadata examples:
+     * - `metadata:myvalue` - matches conversations with any metadata field set to `myvalue`
+     * - `metadata.mykey:myvalue` - matches conversations with a metadata field `mykey` set to `myvalue`
+     * - `metadata.mykey:myvalue OR anothervalue` - matches conversations with a metadata field `mykey` set to `myvalue` or `anothervalue`
+     * - `metadata.mykey:*` - matches conversations with a metadata field `mykey`
+     * - `-metadata:myvalue` - matches conversations that do not have any metadata field set to `myvalue`
+     * - `_exists_:metadata` - matches conversations that have any metadata field set
+     *
+     * Tags examples:
+     * - `tags:myvalue` - matches conversations with a tag of `myvalue`
+     * - `tags:myvalue OR anothervalue` - matches conversations with a tag of `myvalue` or `anothervalue`
+     * - `-tags:myvalue` - matches conversations that do not have the tag `myvalue`
+     * - `_exists_:tags` - matches conversations that have any tags field set
+     */
     search?: string;
     /** Filter conversations created on or after this timestamp */
     createdAfter?: Date;
@@ -35,10 +55,16 @@ export interface ConversationFilter {
     sentiment?: MavenAGI.Sentiment[];
     /** Filter by tags applied to the conversation */
     tags?: string[];
+    /** Filter by agent user IDs associated with the conversation */
+    agentUserIds?: string[];
     /** Filter by conversation resolution status which is determined by AI based on the conversation content. */
     resolutionStatus?: MavenAGI.ResolutionStatus[];
     /** Filter conversations based on whether they were resolved by Maven AI */
     resolvedByMaven?: boolean;
     /** Filter by the number of messages sent by the user in the conversation */
     userMessageCount?: MavenAGI.NumberRange;
+    /** Filter by whether any message in the conversation has an attachment */
+    hasAttachment?: boolean;
+    /** Filter by the segments that any message on a conversation matched. */
+    matchedSegmentIds?: MavenAGI.EntityIdFilter[];
 }

package/dist/api/resources/conversation/types/ConversationMessageRequest.d.ts

@@ -6,5 +6,5 @@ export interface ConversationMessageRequest extends MavenAGI.UserMessageBase {
     /** The ID that uniquely identifies this message within the conversation */
     conversationMessageId: MavenAGI.EntityIdBase;
     /** The attachments to the message. */
-    attachments?: MavenAGI.Attachment[];
+    attachments?: MavenAGI.AttachmentRequest[];
 }

package/dist/api/resources/conversation/types/ConversationPatchRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         llmEnabled: true
+ *     }
+ */
+export interface ConversationPatchRequest {
+    /** The App ID of the conversation to patch. If not provided the ID of the calling app will be used. */
+    appId?: string;
+    /** Whether the conversation is able to receive asynchronous messages. Only valid for conversations with the `ASYNC` capability. */
+    open?: boolean;
+    /** Whether the LLM is enabled for this conversation. */
+    llmEnabled?: boolean;
+    /** A list of attachments to add to the conversation. Attachments can only be appended. Removal is not allowed. */
+    attachments?: MavenAGI.AttachmentRequest[];
+}