mavenagi 1.1.0 → 1.2.3

package/api/resources/commons/types/UserEvent.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/commons/types/UserEventName.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UserEventName = 
+/**
+ * A button click occurred */
+"BUTTON_CLICKED"
+/**
+ * A link was clicked */
+ | "LINK_CLICKED"
+/**
+ * The chat window was opened */
+ | "CHAT_OPENED"
+/**
+ * The chat window was closed */
+ | "CHAT_CLOSED"
+/**
+ * A text was inserted into a field */
+ | "TEXT_INSERTED";
+export declare const UserEventName: {
+    readonly ButtonClicked: "BUTTON_CLICKED";
+    readonly LinkClicked: "LINK_CLICKED";
+    readonly ChatOpened: "CHAT_OPENED";
+    readonly ChatClosed: "CHAT_CLOSED";
+    readonly TextInserted: "TEXT_INSERTED";
+};

package/api/resources/commons/types/UserEventName.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserEventName = void 0;
+exports.UserEventName = {
+    ButtonClicked: "BUTTON_CLICKED",
+    LinkClicked: "LINK_CLICKED",
+    ChatOpened: "CHAT_OPENED",
+    ChatClosed: "CHAT_CLOSED",
+    TextInserted: "TEXT_INSERTED",
+};

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

@@ -8,7 +8,27 @@ export interface UserMessage extends MavenAGI.UserMessageBase {
     /** The language of the message in ISO 639-1 code format */
     language?: string;
     /** The attachments associated with the message */
-    attachments: MavenAGI.UserMessageAttachment[];
+    attachments: MavenAGI.AttachmentResponse[];
+    /** The ID of the agent user that created this message. More detail can be fetched via the agent user APIs. Will be empty only for legacy conversations. */
+    agentUserId?: string;
     /** The display name of the user who created this message. Only available for users who have saved name information. */
     userDisplayName?: string;
+    /**
+     * The delivery status of the message. Only applicable to messages sent via the deliverMessage API.
+     * All other messages have an `UNKNOWN` status.
+     *
+     * * `SENT`: The message has been sent to the user.
+     * * `FAILED`: The message sending encountered an error.
+     * * `UNKNOWN`: The message status is unknown.
+     */
+    status: MavenAGI.MessageStatus;
+    /**
+     * Only present on newer messaged where `userMessageType` is `USER`.
+     * Indicates the state of the answer to the user message.
+     *
+     * - `NOT_ASKED`: An answer was not requested for this user message.
+     * - `LLM_ENABLED`: An answer was requested for this user message and the LLM was enabled.
+     * - `LLM_DISABLED`: An answer was requested for this user message and the LLM was disabled.
+     */
+    responseState?: MavenAGI.UserMessageResponseState;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type UserMessageResponseState = "NOT_ASKED" | "LLM_ENABLED" | "LLM_DISABLED";
+export declare const UserMessageResponseState: {
+    readonly NotAsked: "NOT_ASKED";
+    readonly LlmEnabled: "LLM_ENABLED";
+    readonly LlmDisabled: "LLM_DISABLED";
+};

package/api/resources/commons/types/UserMessageResponseState.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.UserMessageResponseState = void 0;
+exports.UserMessageResponseState = {
+    NotAsked: "NOT_ASKED",
+    LlmEnabled: "LLM_ENABLED",
+    LlmDisabled: "LLM_DISABLED",
+};

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

@@ -4,9 +4,44 @@ export * from "./EntityIdBase";
 export * from "./EntityIdWithoutAgent";
 export * from "./EntityId";
 export * from "./EntityIdFilter";
+export * from "./EntityResult";
 export * from "./FeedbackType";
 export * from "./FeedbackBase";
 export * from "./Feedback";
+export * from "./EventBaseNoId";
+export * from "./NovelUserEvent";
+export * from "./NovelSystemEventNoId";
+export * from "./NovelSystemEvent";
+export * from "./EventRequest";
+export * from "./UserEvent";
+export * from "./SystemEvent";
+export * from "./EventResponse";
+export * from "./EventsSearchRequest";
+export * from "./EventsSearchResponse";
+export * from "./EventType";
+export * from "./EventField";
+export * from "./EventFilter";
+export * from "./ScopedEntity";
+export * from "./UserEventName";
+export * from "./SystemEventName";
+export * from "./SourceType";
+export * from "./DeviceType";
+export * from "./OsType";
+export * from "./BrowserType";
+export * from "./EventUserInfoBase";
+export * from "./EventUserInfo";
+export * from "./FeedbackInfo";
+export * from "./SurveyInfo";
+export * from "./PageInfo";
+export * from "./ContextInfo";
+export * from "./SourceInfo";
+export * from "./DeviceInfo";
+export * from "./OsInfo";
+export * from "./BrowserInfo";
+export * from "./GeoInfo";
+export * from "./IpInfo";
+export * from "./LanguageInfo";
+export * from "./SessionInfo";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
@@ -34,10 +69,14 @@ export * from "./ConversationMessageResponse";
 export * from "./ConversationMessageBase";
 export * from "./UserConversationMessageType";
 export * from "./UserMessageBase";
-export * from "./UserMessageAttachment";
+export * from "./AttachmentStatus";
+export * from "./BaseAttachment";
+export * from "./AttachmentRequest";
+export * from "./AttachmentResponse";
 export * from "./UserMessage";
+export * from "./UserMessageResponseState";
 export * from "./BotConversationMessageType";
-export * from "./BotMessageStatus";
+export * from "./MessageStatus";
 export * from "./BotMessage";
 export * from "./Source";
 export * from "./BotResponseMetadata";
@@ -45,11 +84,26 @@ export * from "./BotResponse";
 export * from "./BotObjectResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
+export * from "./BotOAuthButtonResponse";
 export * from "./ActionFormField";
 export * from "./BotChartResponse";
 export * from "./ChartSpecSchema";
+export * from "./BotLogic";
+export * from "./BotLogicItem";
+export * from "./BotLogicSegmentsItem";
+export * from "./BotLogicUserItem";
+export * from "./BotLogicActionItem";
+export * from "./BotLogicActionReviewedDetail";
+export * from "./BotLogicActionExecutedDetail";
+export * from "./ActionExecutionParamValue";
+export * from "./BotLogicFormSubmissionItem";
+export * from "./BotLogicKnowledgeItem";
+export * from "./BotLogicKnowledgeDetail";
+export * from "./BotLogicSafetyItem";
 export * from "./ActionBase";
 export * from "./ActionParameter";
+export * from "./ActionOAuthConfiguration";
+export * from "./LlmInclusionStatus";
 export * from "./ActionResponse";
 export * from "./Precondition";
 export * from "./PreconditionOperator";
@@ -62,20 +116,16 @@ export * from "./PreconditionGroupOperator";
 export * from "./PreconditionGroup";
 export * from "./TagsPrecondition";
 export * from "./ConversationExecutedActionPrecondition";
-export * from "./KnowledgeBaseInformation";
 export * from "./DocumentInformation";
 export * from "./InboxItemStatus";
 export * from "./InboxItemType";
-export * from "./InboxItemFixType";
+export * from "./InboxItemSeverity";
 export * from "./InboxItem";
 export * from "./InboxItemBase";
-export * from "./InboxItemKnowledgeBaseAlert";
-export * from "./InboxItemDuplicateKnowledgeBase";
 export * from "./InboxItemDuplicateDocuments";
 export * from "./InboxItemMissingKnowledge";
 export * from "./InboxItemFix";
 export * from "./InboxItemFixBase";
 export * from "./InboxItemFixAddDocument";
 export * from "./InboxItemFixDeactivateDocument";
-export * from "./InboxItemFixDeactivateKnowledgeBase";
 export * from "./NumberRange";

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

@@ -20,9 +20,44 @@ __exportStar(require("./EntityIdBase"), exports);
 __exportStar(require("./EntityIdWithoutAgent"), exports);
 __exportStar(require("./EntityId"), exports);
 __exportStar(require("./EntityIdFilter"), exports);
+__exportStar(require("./EntityResult"), exports);
 __exportStar(require("./FeedbackType"), exports);
 __exportStar(require("./FeedbackBase"), exports);
 __exportStar(require("./Feedback"), exports);
+__exportStar(require("./EventBaseNoId"), exports);
+__exportStar(require("./NovelUserEvent"), exports);
+__exportStar(require("./NovelSystemEventNoId"), exports);
+__exportStar(require("./NovelSystemEvent"), exports);
+__exportStar(require("./EventRequest"), exports);
+__exportStar(require("./UserEvent"), exports);
+__exportStar(require("./SystemEvent"), exports);
+__exportStar(require("./EventResponse"), exports);
+__exportStar(require("./EventsSearchRequest"), exports);
+__exportStar(require("./EventsSearchResponse"), exports);
+__exportStar(require("./EventType"), exports);
+__exportStar(require("./EventField"), exports);
+__exportStar(require("./EventFilter"), exports);
+__exportStar(require("./ScopedEntity"), exports);
+__exportStar(require("./UserEventName"), exports);
+__exportStar(require("./SystemEventName"), exports);
+__exportStar(require("./SourceType"), exports);
+__exportStar(require("./DeviceType"), exports);
+__exportStar(require("./OsType"), exports);
+__exportStar(require("./BrowserType"), exports);
+__exportStar(require("./EventUserInfoBase"), exports);
+__exportStar(require("./EventUserInfo"), exports);
+__exportStar(require("./FeedbackInfo"), exports);
+__exportStar(require("./SurveyInfo"), exports);
+__exportStar(require("./PageInfo"), exports);
+__exportStar(require("./ContextInfo"), exports);
+__exportStar(require("./SourceInfo"), exports);
+__exportStar(require("./DeviceInfo"), exports);
+__exportStar(require("./OsInfo"), exports);
+__exportStar(require("./BrowserInfo"), exports);
+__exportStar(require("./GeoInfo"), exports);
+__exportStar(require("./IpInfo"), exports);
+__exportStar(require("./LanguageInfo"), exports);
+__exportStar(require("./SessionInfo"), exports);
 __exportStar(require("./AppUserIdentifier"), exports);
 __exportStar(require("./AppUserIdentifyingPropertyType"), exports);
 __exportStar(require("./AppUser"), exports);
@@ -50,10 +85,14 @@ __exportStar(require("./ConversationMessageResponse"), exports);
 __exportStar(require("./ConversationMessageBase"), exports);
 __exportStar(require("./UserConversationMessageType"), exports);
 __exportStar(require("./UserMessageBase"), exports);
-__exportStar(require("./UserMessageAttachment"), exports);
+__exportStar(require("./AttachmentStatus"), exports);
+__exportStar(require("./BaseAttachment"), exports);
+__exportStar(require("./AttachmentRequest"), exports);
+__exportStar(require("./AttachmentResponse"), exports);
 __exportStar(require("./UserMessage"), exports);
+__exportStar(require("./UserMessageResponseState"), exports);
 __exportStar(require("./BotConversationMessageType"), exports);
-__exportStar(require("./BotMessageStatus"), exports);
+__exportStar(require("./MessageStatus"), exports);
 __exportStar(require("./BotMessage"), exports);
 __exportStar(require("./Source"), exports);
 __exportStar(require("./BotResponseMetadata"), exports);
@@ -61,11 +100,26 @@ __exportStar(require("./BotResponse"), exports);
 __exportStar(require("./BotObjectResponse"), exports);
 __exportStar(require("./BotTextResponse"), exports);
 __exportStar(require("./BotActionFormResponse"), exports);
+__exportStar(require("./BotOAuthButtonResponse"), exports);
 __exportStar(require("./ActionFormField"), exports);
 __exportStar(require("./BotChartResponse"), exports);
 __exportStar(require("./ChartSpecSchema"), exports);
+__exportStar(require("./BotLogic"), exports);
+__exportStar(require("./BotLogicItem"), exports);
+__exportStar(require("./BotLogicSegmentsItem"), exports);
+__exportStar(require("./BotLogicUserItem"), exports);
+__exportStar(require("./BotLogicActionItem"), exports);
+__exportStar(require("./BotLogicActionReviewedDetail"), exports);
+__exportStar(require("./BotLogicActionExecutedDetail"), exports);
+__exportStar(require("./ActionExecutionParamValue"), exports);
+__exportStar(require("./BotLogicFormSubmissionItem"), exports);
+__exportStar(require("./BotLogicKnowledgeItem"), exports);
+__exportStar(require("./BotLogicKnowledgeDetail"), exports);
+__exportStar(require("./BotLogicSafetyItem"), exports);
 __exportStar(require("./ActionBase"), exports);
 __exportStar(require("./ActionParameter"), exports);
+__exportStar(require("./ActionOAuthConfiguration"), exports);
+__exportStar(require("./LlmInclusionStatus"), exports);
 __exportStar(require("./ActionResponse"), exports);
 __exportStar(require("./Precondition"), exports);
 __exportStar(require("./PreconditionOperator"), exports);
@@ -78,20 +132,16 @@ __exportStar(require("./PreconditionGroupOperator"), exports);
 __exportStar(require("./PreconditionGroup"), exports);
 __exportStar(require("./TagsPrecondition"), exports);
 __exportStar(require("./ConversationExecutedActionPrecondition"), exports);
-__exportStar(require("./KnowledgeBaseInformation"), exports);
 __exportStar(require("./DocumentInformation"), exports);
 __exportStar(require("./InboxItemStatus"), exports);
 __exportStar(require("./InboxItemType"), exports);
-__exportStar(require("./InboxItemFixType"), exports);
+__exportStar(require("./InboxItemSeverity"), exports);
 __exportStar(require("./InboxItem"), exports);
 __exportStar(require("./InboxItemBase"), exports);
-__exportStar(require("./InboxItemKnowledgeBaseAlert"), exports);
-__exportStar(require("./InboxItemDuplicateKnowledgeBase"), exports);
 __exportStar(require("./InboxItemDuplicateDocuments"), exports);
 __exportStar(require("./InboxItemMissingKnowledge"), exports);
 __exportStar(require("./InboxItemFix"), exports);
 __exportStar(require("./InboxItemFixBase"), exports);
 __exportStar(require("./InboxItemFixAddDocument"), exports);
 __exportStar(require("./InboxItemFixDeactivateDocument"), exports);
-__exportStar(require("./InboxItemFixDeactivateKnowledgeBase"), exports);
 __exportStar(require("./NumberRange"), exports);

package/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>;
 }