mavenagi 1.2.0 → 1.2.4

package/dist/api/resources/commons/types/QualityReason.d.ts

@@ -1,7 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type QualityReason = "MISSING_KNOWLEDGE" | "MISSING_USER_INFORMATION" | "MISSING_ACTION" | "NEEDS_USER_CLARIFICATION" | "UNSUPPORTED_FORMAT" | "INTERRUPTED" | "UNSUPPORTED_USER_BEHAVIOR" | "UNKNOWN";
 export declare const QualityReason: {
     readonly MissingKnowledge: "MISSING_KNOWLEDGE";
     readonly MissingUserInformation: "MISSING_USER_INFORMATION";
@@ -11,4 +7,6 @@ export declare const QualityReason: {
     readonly Interrupted: "INTERRUPTED";
     readonly UnsupportedUserBehavior: "UNSUPPORTED_USER_BEHAVIOR";
     readonly Unknown: "UNKNOWN";
+    readonly NoBotReplies: "NO_BOT_REPLIES";
 };
+export type QualityReason = (typeof QualityReason)[keyof typeof QualityReason];

package/dist/api/resources/commons/types/QualityReason.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QualityReason = void 0;
 exports.QualityReason = {
@@ -13,4 +11,5 @@ exports.QualityReason = {
     Interrupted: "INTERRUPTED",
     UnsupportedUserBehavior: "UNSUPPORTED_USER_BEHAVIOR",
     Unknown: "UNKNOWN",
+    NoBotReplies: "NO_BOT_REPLIES",
 };

package/dist/api/resources/commons/types/ResponseConfig.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface ResponseConfig {
     /**
@@ -11,6 +8,7 @@ export interface ResponseConfig {
      * - `IMAGES`: Whether the response should include images. Not yet supported.
      * - `CHARTS_HIGHCHARTS_TS`: Whether the response should include a Highcharts typescript chart if applicable.
      * - `ASYNC`: Whether the app that created this conversation supports asynchronous message delivery. If provided, messages may be sent to the app via the `handleMessage` function.
+     * - `OAUTH_BUTTONS`: Whether the response should include OAuth buttons. If provided, the caller needs to render OAuth buttons when returned from the ask API and allow the user to click the buttons to initiate the OAuth flow. If not provided, then actions which require OAuth authorization will not be considered by the LLM. This capability is not recommended for surfaces which can not display links (e.g. voice).
      */
     capabilities: MavenAGI.Capability[];
     /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */

package/dist/api/resources/commons/types/ResponseConfig.js

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

package/dist/api/resources/commons/types/ResponseConfigPrecondition.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface ResponseConfigPrecondition extends MavenAGI.PreconditionBase {
     useMarkdown?: boolean;

package/dist/api/resources/commons/types/ResponseConfigPrecondition.js

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

package/dist/api/resources/commons/types/ResponseLength.d.ts

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ResponseLength = "SHORT" | "MEDIUM" | "LONG";
 export declare const ResponseLength: {
     readonly Short: "SHORT";
     readonly Medium: "MEDIUM";
     readonly Long: "LONG";
 };
+export type ResponseLength = (typeof ResponseLength)[keyof typeof ResponseLength];

package/dist/api/resources/commons/types/ResponseLength.js

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

package/dist/api/resources/commons/types/ScopedEntity.d.ts

@@ -0,0 +1,5 @@
+import * as MavenAGI from "../../../index";
+export interface ScopedEntity {
+    entityId: MavenAGI.EntityId;
+    scopeEntityId?: MavenAGI.EntityId;
+}

package/dist/api/resources/commons/types/ScopedEntity.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/dist/api/resources/commons/types/Sentiment.d.ts

@@ -1,10 +1,4 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The sentiment of the conversation
- */
-export type Sentiment = "POSITIVE" | "NEGATIVE" | "NEUTRAL" | "MIXED" | "UNKNOWN";
+/** The sentiment of the conversation */
 export declare const Sentiment: {
     readonly Positive: "POSITIVE";
     readonly Negative: "NEGATIVE";
@@ -12,3 +6,4 @@ export declare const Sentiment: {
     readonly Mixed: "MIXED";
     readonly Unknown: "UNKNOWN";
 };
+export type Sentiment = (typeof Sentiment)[keyof typeof Sentiment];

package/dist/api/resources/commons/types/Sentiment.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Sentiment = void 0;
+/** The sentiment of the conversation */
 exports.Sentiment = {
     Positive: "POSITIVE",
     Negative: "NEGATIVE",

package/dist/api/resources/commons/types/SessionInfo.d.ts

@@ -0,0 +1,6 @@
+export interface SessionInfo {
+    id: string;
+    start?: Date;
+    end?: Date;
+    duration?: number;
+}

package/dist/api/resources/commons/types/SessionInfo.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/dist/api/resources/commons/types/SimulationContext.d.ts

@@ -0,0 +1,7 @@
+import * as MavenAGI from "../../../index";
+export interface SimulationContext {
+    /** 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. */
+    availableKnowledgeBases?: MavenAGI.EntityId[];
+}

package/dist/api/resources/commons/types/SimulationContext.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/dist/api/resources/commons/types/Source.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 export interface Source {
     title: string;
     url: string;

package/dist/api/resources/commons/types/Source.js

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

package/dist/api/resources/commons/types/SourceInfo.d.ts

@@ -0,0 +1,9 @@
+import * as MavenAGI from "../../../index";
+export interface SourceInfo {
+    type: MavenAGI.SourceType;
+    deviceInfo?: MavenAGI.DeviceInfo;
+    browserInfo?: MavenAGI.BrowserInfo;
+    geoInfo?: MavenAGI.GeoInfo;
+    ipInfo?: MavenAGI.IpInfo;
+    languageInfo?: MavenAGI.LanguageInfo;
+}

package/dist/api/resources/commons/types/SourceInfo.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/dist/api/resources/commons/types/SourceType.d.ts

@@ -0,0 +1,6 @@
+export declare const SourceType: {
+    readonly Web: "WEB";
+    readonly Api: "API";
+    readonly System: "SYSTEM";
+};
+export type SourceType = (typeof SourceType)[keyof typeof SourceType];

package/dist/api/resources/commons/types/SourceType.js

@@ -0,0 +1,9 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceType = void 0;
+exports.SourceType = {
+    Web: "WEB",
+    Api: "API",
+    System: "SYSTEM",
+};

package/dist/api/resources/commons/types/SurveyInfo.d.ts

@@ -0,0 +1,4 @@
+export interface SurveyInfo {
+    surveyQuestion?: string;
+    surveyAnswer?: string;
+}

package/dist/api/resources/commons/types/SurveyInfo.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/dist/api/resources/commons/types/SystemEvent.d.ts

@@ -0,0 +1,5 @@
+import * as MavenAGI from "../../../index";
+export interface SystemEvent extends MavenAGI.NovelSystemEventNoId {
+    /** The unique ID of the event */
+    id: MavenAGI.EntityId;
+}

package/dist/api/resources/commons/types/SystemEvent.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/dist/api/resources/commons/types/SystemEventName.d.ts

@@ -0,0 +1,12 @@
+export declare const SystemEventName: {
+    /**
+     * An app was installed */
+    readonly AppInstalled: "APP_INSTALLED";
+    /**
+     * An app was uninstalled */
+    readonly AppUninstalled: "APP_UNINSTALLED";
+    /**
+     * An app was updated */
+    readonly AppUpdated: "APP_UPDATED";
+};
+export type SystemEventName = (typeof SystemEventName)[keyof typeof SystemEventName];

package/dist/api/resources/commons/types/SystemEventName.js

@@ -0,0 +1,15 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemEventName = void 0;
+exports.SystemEventName = {
+    /**
+     * An app was installed */
+    AppInstalled: "APP_INSTALLED",
+    /**
+     * An app was uninstalled */
+    AppUninstalled: "APP_UNINSTALLED",
+    /**
+     * An app was updated */
+    AppUpdated: "APP_UPDATED",
+};

package/dist/api/resources/commons/types/TagsPrecondition.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface TagsPrecondition extends MavenAGI.PreconditionBase {
     /** The tags that must be present in the conversation context for the precondition to be met */

package/dist/api/resources/commons/types/TagsPrecondition.js

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

package/dist/api/resources/commons/types/UserConversationMessageType.d.ts

@@ -1,12 +1,7 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * The type of user message
- */
-export type UserConversationMessageType = "USER" | "HUMAN_AGENT" | "EXTERNAL_SYSTEM";
+/** The type of user message */
 export declare const UserConversationMessageType: {
     readonly User: "USER";
     readonly HumanAgent: "HUMAN_AGENT";
     readonly ExternalSystem: "EXTERNAL_SYSTEM";
 };
+export type UserConversationMessageType = (typeof UserConversationMessageType)[keyof typeof UserConversationMessageType];

package/dist/api/resources/commons/types/UserConversationMessageType.js

@@ -1,9 +1,8 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserConversationMessageType = void 0;
+/** The type of user message */
 exports.UserConversationMessageType = {
     User: "USER",
     HumanAgent: "HUMAN_AGENT",

package/dist/api/resources/commons/types/UserData.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface UserData {
     /** The value of the user metadata */

package/dist/api/resources/commons/types/UserData.js

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

package/dist/api/resources/commons/types/UserEvent.d.ts

@@ -0,0 +1,13 @@
+import * as MavenAGI from "../../../index";
+export interface UserEvent extends MavenAGI.EventBaseNoId {
+    /** The unique ID of the event */
+    id: MavenAGI.EntityId;
+    /** The name of the event */
+    eventName: MavenAGI.UserEventName;
+    /** Information about the user who triggered the event */
+    userInfo: MavenAGI.EventUserInfo;
+    /** Information about any feedback associated with the event */
+    feedbackInfo?: MavenAGI.FeedbackInfo[];
+    /** Information about the page on which the event occurred */
+    pageInfo?: MavenAGI.PageInfo;
+}

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

@@ -0,0 +1,18 @@
+export declare const UserEventName: {
+    /**
+     * A button click occurred */
+    readonly ButtonClicked: "BUTTON_CLICKED";
+    /**
+     * A link was clicked */
+    readonly LinkClicked: "LINK_CLICKED";
+    /**
+     * The chat window was opened */
+    readonly ChatOpened: "CHAT_OPENED";
+    /**
+     * The chat window was closed */
+    readonly ChatClosed: "CHAT_CLOSED";
+    /**
+     * A text was inserted into a field */
+    readonly TextInserted: "TEXT_INSERTED";
+};
+export type UserEventName = (typeof UserEventName)[keyof typeof UserEventName];

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

@@ -0,0 +1,21 @@
+"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 = {
+    /**
+     * A button click occurred */
+    ButtonClicked: "BUTTON_CLICKED",
+    /**
+     * A link was clicked */
+    LinkClicked: "LINK_CLICKED",
+    /**
+     * The chat window was opened */
+    ChatOpened: "CHAT_OPENED",
+    /**
+     * The chat window was closed */
+    ChatClosed: "CHAT_CLOSED",
+    /**
+     * A text was inserted into a field */
+    TextInserted: "TEXT_INSERTED",
+};

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

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface UserMessage extends MavenAGI.UserMessageBase {
     /** The ID that uniquely identifies this message within the conversation */

package/dist/api/resources/commons/types/UserMessage.js

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

package/dist/api/resources/commons/types/UserMessageBase.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as MavenAGI from "../../../index";
 export interface UserMessageBase extends MavenAGI.ConversationMessageBase {
     /** ID that uniquely identifies the user that created this message */

package/dist/api/resources/commons/types/UserMessageBase.js

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

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

@@ -1,9 +1,6 @@
-/**
- * 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";
 };
+export type UserMessageResponseState = (typeof UserMessageResponseState)[keyof typeof UserMessageResponseState];

package/dist/api/resources/commons/types/UserMessageResponseState.js

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

package/dist/api/resources/commons/types/VisibilityType.d.ts

@@ -1,9 +1,6 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type VisibilityType = "VISIBLE" | "PARTIALLY_VISIBLE" | "HIDDEN";
 export declare const VisibilityType: {
     readonly Visible: "VISIBLE";
     readonly PartiallyVisible: "PARTIALLY_VISIBLE";
     readonly Hidden: "HIDDEN";
 };
+export type VisibilityType = (typeof VisibilityType)[keyof typeof VisibilityType];

package/dist/api/resources/commons/types/VisibilityType.js

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

package/dist/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";
@@ -15,6 +50,7 @@ export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
 export * from "./Page";
+export * from "./BaseSearchRequest";
 export * from "./BasePaginatedRequest";
 export * from "./ActionParameterType";
 export * from "./ActionEnumOption";
@@ -30,6 +66,7 @@ export * from "./ResponseConfig";
 export * from "./ConversationResponse";
 export * from "./ConversationPreview";
 export * from "./BaseConversationResponse";
+export * from "./SimulationContext";
 export * from "./ConversationMessageResponse";
 export * from "./ConversationMessageBase";
 export * from "./UserConversationMessageType";
@@ -49,6 +86,7 @@ export * from "./BotResponse";
 export * from "./BotObjectResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
+export * from "./BotOAuthButtonResponse";
 export * from "./ActionFormField";
 export * from "./BotChartResponse";
 export * from "./ChartSpecSchema";
@@ -59,12 +97,14 @@ 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";
@@ -91,3 +131,4 @@ export * from "./InboxItemFixBase";
 export * from "./InboxItemFixAddDocument";
 export * from "./InboxItemFixDeactivateDocument";
 export * from "./NumberRange";
+export * from "./LlmPersona";