mavenagi 1.0.7 → 1.0.9

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 declare type ConversationField = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt";
+export type ConversationField = "Category" | "FirstResponseTime" | "HandleTime" | "HumanAgents" | "App" | "Sentiment" | "QualityReason" | "ResolutionStatus" | "Quality" | "Users" | "ResponseLength" | "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "Tags" | "UserMessageCount" | "Languages" | "Actions" | "IncompleteActions" | "Sources" | "CreatedAt";
 export declare const ConversationField: {
     readonly Category: "Category";
     readonly FirstResponseTime: "FirstResponseTime";
@@ -16,6 +16,7 @@ export declare const ConversationField: {
     readonly ResponseLength: "ResponseLength";
     readonly ThumbsUpCount: "ThumbsUpCount";
     readonly ThumbsDownCount: "ThumbsDownCount";
+    readonly InsertCount: "InsertCount";
     readonly Tags: "Tags";
     readonly UserMessageCount: "UserMessageCount";
     readonly Languages: "Languages";

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

@@ -18,6 +18,7 @@ exports.ConversationField = {
     ResponseLength: "ResponseLength",
     ThumbsUpCount: "ThumbsUpCount",
     ThumbsDownCount: "ThumbsDownCount",
+    InsertCount: "InsertCount",
     Tags: "Tags",
     UserMessageCount: "UserMessageCount",
     Languages: "Languages",

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

@@ -18,4 +18,6 @@ export interface ConversationFilter {
     responseLength?: MavenAGI.ResponseLength[];
     sentiment?: MavenAGI.Sentiment[];
     tags?: string[];
+    resolutionStatus?: MavenAGI.ResolutionStatus[];
+    resolvedByMaven?: boolean;
 }

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

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         metadata: {
+ *             "myapp": {
+ *                 "key": "newValue"
+ *             },
+ *             "conversation-owning-app": {
+ *                 "existingKey": "existingValue"
+ *             }
+ *         }
+ *     }
+ */
+export interface ConversationMetadata {
+    /** All metadata for the conversation. Keyed by appId. */
+    metadata: Record<string, Record<string, string>>;
+}

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

@@ -2,9 +2,23 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface ConversationRequest extends MavenAGI.ConversationBase {
+export interface ConversationRequest {
     /** An externally supplied ID to uniquely identify this conversation */
     conversationId: MavenAGI.EntityIdBase;
+    /** Optional configurations for responses to this conversation */
+    responseConfig?: MavenAGI.ResponseConfig;
+    /** The subject of the conversation */
+    subject?: string;
+    /** The url of the conversation */
+    url?: string;
+    /** The date and time the conversation was created */
+    createdAt?: Date;
+    /** The date and time the conversation was last updated */
+    updatedAt?: Date;
+    /** The tags of the conversation. Used for filtering in Agent Designer. */
+    tags?: Set<string>;
+    /** The metadata of the conversation supplied by the app which created the conversation. */
+    metadata?: Record<string, string>;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];
 }

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationsResponse extends MavenAGI.Page {
+    /** The conversations that match the search criteria */
+    conversations: MavenAGI.ConversationPreview[];
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationsSearchRequest extends MavenAGI.BasePaginatedRequest {
+    sort?: MavenAGI.ConversationField;
+    filter?: MavenAGI.ConversationFilter;
+}

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type FeedbackField = "Type" | "CreatedBy" | "CreatedAt";
+export type FeedbackField = "Type" | "CreatedBy" | "CreatedAt";
 export declare const FeedbackField: {
     readonly Type: "Type";
     readonly CreatedBy: "CreatedBy";

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

@@ -1,10 +1,11 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type NumericConversationField = "ThumbsUpCount" | "ThumbsDownCount" | "UserMessageCount" | "HandleTime" | "FirstResponseTime";
+export type NumericConversationField = "ThumbsUpCount" | "ThumbsDownCount" | "InsertCount" | "UserMessageCount" | "HandleTime" | "FirstResponseTime";
 export declare const NumericConversationField: {
     readonly ThumbsUpCount: "ThumbsUpCount";
     readonly ThumbsDownCount: "ThumbsDownCount";
+    readonly InsertCount: "InsertCount";
     readonly UserMessageCount: "UserMessageCount";
     readonly HandleTime: "HandleTime";
     readonly FirstResponseTime: "FirstResponseTime";

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

@@ -7,6 +7,7 @@ exports.NumericConversationField = void 0;
 exports.NumericConversationField = {
     ThumbsUpCount: "ThumbsUpCount",
     ThumbsDownCount: "ThumbsDownCount",
+    InsertCount: "InsertCount",
     UserMessageCount: "UserMessageCount",
     HandleTime: "HandleTime",
     FirstResponseTime: "FirstResponseTime",

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type Quality = "GOOD" | "NEEDS_IMPROVEMENT" | "UNKNOWN";
+export type Quality = "GOOD" | "NEEDS_IMPROVEMENT" | "UNKNOWN";
 export declare const Quality: {
     readonly Good: "GOOD";
     readonly NeedsImprovement: "NEEDS_IMPROVEMENT";

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

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type QualityReason = "MISSING_KNOWLEDGE" | "MISSING_USER_INFORMATION" | "MISSING_ACTION" | "NEEDS_USER_CLARIFICATION" | "UNSUPPORTED_FORMAT" | "GREAT_ANSWER" | "INTERRUPTED" | "UNSUPPORTED_USER_BEHAVIOR" | "UNKNOWN";
+export type QualityReason = "MISSING_KNOWLEDGE" | "MISSING_USER_INFORMATION" | "MISSING_ACTION" | "NEEDS_USER_CLARIFICATION" | "UNSUPPORTED_FORMAT" | "GREAT_ANSWER" | "INTERRUPTED" | "UNSUPPORTED_USER_BEHAVIOR" | "UNKNOWN";
 export declare const QualityReason: {
     readonly MissingKnowledge: "MISSING_KNOWLEDGE";
     readonly MissingUserInformation: "MISSING_USER_INFORMATION";

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ResolutionStatus = "RESOLVED" | "ESCALATED" | "IN_PROGRESS";
+export declare const ResolutionStatus: {
+    readonly Resolved: "RESOLVED";
+    readonly Escalated: "ESCALATED";
+    readonly InProgress: "IN_PROGRESS";
+};

package/{api/resources/knowledge/types/KnowledgeBaseType.js → dist/api/resources/conversation/types/ResolutionStatus.js}

@@ -3,9 +3,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KnowledgeBaseType = void 0;
-exports.KnowledgeBaseType = {
-    Api: "API",
-    Url: "URL",
-    Rss: "RSS",
+exports.ResolutionStatus = void 0;
+exports.ResolutionStatus = {
+    Resolved: "RESOLVED",
+    Escalated: "ESCALATED",
+    InProgress: "IN_PROGRESS",
 };

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

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type StreamResponse = MavenAGI.StreamResponse.Text | MavenAGI.StreamResponse.Action | MavenAGI.StreamResponse.Chart | MavenAGI.StreamResponse.Metadata | MavenAGI.StreamResponse.Start | MavenAGI.StreamResponse.End;
+export type StreamResponse = MavenAGI.StreamResponse.Text | MavenAGI.StreamResponse.Action | MavenAGI.StreamResponse.Chart | MavenAGI.StreamResponse.Metadata | MavenAGI.StreamResponse.Start | MavenAGI.StreamResponse.End;
 export declare namespace StreamResponse {
     interface Text extends MavenAGI.AskStreamTextEvent {
         eventType: "text";

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         appId: "conversation-owning-app",
+ *         values: {
+ *             "key": "newValue"
+ *         }
+ *     }
+ */
+export interface UpdateMetadataRequest {
+    /** The App ID of the conversation to modify metadata for. If not provided the ID of the calling app will be used. */
+    appId?: string;
+    /** The metadata values to add to the conversation. */
+    values: Record<string, string>;
+}

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

@@ -15,8 +15,13 @@ export * from "./AskStreamEndEvent";
 export * from "./CategorizationResponse";
 export * from "./ConversationField";
 export * from "./NumericConversationField";
+export * from "./ResolutionStatus";
 export * from "./Quality";
 export * from "./QualityReason";
+export * from "./ConversationsSearchRequest";
+export * from "./ConversationsResponse";
 export * from "./ConversationFilter";
 export * from "./FeedbackField";
 export * from "./FeedbackFilter";
+export * from "./ConversationMetadata";
+export * from "./UpdateMetadataRequest";

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

@@ -31,8 +31,13 @@ __exportStar(require("./AskStreamEndEvent"), exports);
 __exportStar(require("./CategorizationResponse"), exports);
 __exportStar(require("./ConversationField"), exports);
 __exportStar(require("./NumericConversationField"), exports);
+__exportStar(require("./ResolutionStatus"), exports);
 __exportStar(require("./Quality"), exports);
 __exportStar(require("./QualityReason"), exports);
+__exportStar(require("./ConversationsSearchRequest"), exports);
+__exportStar(require("./ConversationsResponse"), exports);
 __exportStar(require("./ConversationFilter"), exports);
 __exportStar(require("./FeedbackField"), exports);
 __exportStar(require("./FeedbackFilter"), exports);
+__exportStar(require("./ConversationMetadata"), exports);
+__exportStar(require("./UpdateMetadataRequest"), exports);

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

@@ -0,0 +1,121 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Inbox {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
+        organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Inbox {
+    protected readonly _options: Inbox.Options;
+    constructor(_options: Inbox.Options);
+    /**
+     * Retrieve a paginated list of inbox items for an agent.
+     *
+     * @param {MavenAGI.InboxSearchRequest} request
+     * @param {Inbox.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.inbox.search({})
+     */
+    search(request: MavenAGI.InboxSearchRequest, requestOptions?: Inbox.RequestOptions): Promise<MavenAGI.InboxSearchResponse>;
+    /**
+     * Retrieve details of a specific inbox item by its ID.
+     *
+     * @param {string} inboxItemId - The ID of the inbox item to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.InboxItemRequest} request
+     * @param {Inbox.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.inbox.get("inboxItemId", {
+     *         appId: "appId"
+     *     })
+     */
+    get(inboxItemId: string, request: MavenAGI.InboxItemRequest, requestOptions?: Inbox.RequestOptions): Promise<MavenAGI.InboxItem>;
+    /**
+     * Retrieve a suggested fix. Includes document information if the fix is a Missing Knowledge suggestion.
+     *
+     * @param {string} inboxItemFixId - Unique identifier for the inbox fix.
+     * @param {MavenAGI.InboxItemFixRequest} request
+     * @param {Inbox.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.inbox.getFix("inboxItemFixId", {
+     *         appId: "appId"
+     *     })
+     */
+    getFix(inboxItemFixId: string, request: MavenAGI.InboxItemFixRequest, requestOptions?: Inbox.RequestOptions): Promise<MavenAGI.InboxItemFix>;
+    /**
+     * Apply a fix to an inbox item with a specific document.
+     *
+     * @param {string} inboxItemFixId - Unique identifier for the inbox fix.
+     * @param {MavenAGI.ApplyInboxItemFixRequest} request
+     * @param {Inbox.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.inbox.applyFix("inboxItemFixId", {
+     *         appId: "appId"
+     *     })
+     */
+    applyFix(inboxItemFixId: string, request: MavenAGI.ApplyInboxItemFixRequest, requestOptions?: Inbox.RequestOptions): Promise<void>;
+    /**
+     * Ignore a specific inbox item by its ID.
+     *
+     * @param {string} inboxItemId - Unique identifier for the inbox item.
+     * @param {MavenAGI.InboxItemIgnoreRequest} request
+     * @param {Inbox.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.inbox.ignore("inboxItemId", {
+     *         appId: "appId"
+     *     })
+     */
+    ignore(inboxItemId: string, request: MavenAGI.InboxItemIgnoreRequest, requestOptions?: Inbox.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}