mavenagi 1.0.5 → 1.0.7

package/Client.d.ts

@@ -4,6 +4,7 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Actions } from "./api/resources/actions/client/Client";
+import { Analytics } from "./api/resources/analytics/client/Client";
 import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
@@ -39,6 +40,7 @@ export declare namespace MavenAGIClient {
 export declare class MavenAGIClient {
     protected readonly _options: MavenAGIClient.Options;
     protected _actions: Actions | undefined;
+    protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
     protected _conversation: Conversation | undefined;
     protected _knowledge: Knowledge | undefined;
@@ -47,6 +49,7 @@ export declare class MavenAGIClient {
     protected _users: Users | undefined;
     constructor(_options: MavenAGIClient.Options);
     get actions(): Actions;
+    get analytics(): Analytics;
     get appSettings(): AppSettings;
     get conversation(): Conversation;
     get knowledge(): Knowledge;

package/Client.js

@@ -5,12 +5,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MavenAGIClient = void 0;
 const Client_1 = require("./api/resources/actions/client/Client");
-const Client_2 = require("./api/resources/appSettings/client/Client");
-const Client_3 = require("./api/resources/conversation/client/Client");
-const Client_4 = require("./api/resources/knowledge/client/Client");
-const Client_5 = require("./api/resources/translations/client/Client");
-const Client_6 = require("./api/resources/triggers/client/Client");
-const Client_7 = require("./api/resources/users/client/Client");
+const Client_2 = require("./api/resources/analytics/client/Client");
+const Client_3 = require("./api/resources/appSettings/client/Client");
+const Client_4 = require("./api/resources/conversation/client/Client");
+const Client_5 = require("./api/resources/knowledge/client/Client");
+const Client_6 = require("./api/resources/translations/client/Client");
+const Client_7 = require("./api/resources/triggers/client/Client");
+const Client_8 = require("./api/resources/users/client/Client");
 class MavenAGIClient {
     constructor(_options) {
         this._options = _options;
@@ -19,29 +20,33 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Client_1.Actions(this._options)));
     }
+    get analytics() {
+        var _a;
+        return ((_a = this._analytics) !== null && _a !== void 0 ? _a : (this._analytics = new Client_2.Analytics(this._options)));
+    }
     get appSettings() {
         var _a;
-        return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new Client_2.AppSettings(this._options)));
+        return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new Client_3.AppSettings(this._options)));
     }
     get conversation() {
         var _a;
-        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_3.Conversation(this._options)));
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_4.Conversation(this._options)));
     }
     get knowledge() {
         var _a;
-        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_4.Knowledge(this._options)));
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_5.Knowledge(this._options)));
     }
     get translations() {
         var _a;
-        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_5.Translations(this._options)));
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_6.Translations(this._options)));
     }
     get triggers() {
         var _a;
-        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_6.Triggers(this._options)));
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_7.Triggers(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_7.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_8.Users(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

package/README.md

@@ -28,19 +28,36 @@ const client = new MavenAGIClient({
     organizationId: "YOUR_ORGANIZATION_ID",
     agentId: "YOUR_AGENT_ID",
 });
-await client.conversation.initialize({
-    conversationId: {
-        referenceId: "referenceId",
+await client.analytics.getConversationTable({
+    conversationFilter: {
+        languages: ["en", "es"],
     },
-    messages: [
+    timeGrouping: "DAY",
+    fieldGroupings: [
         {
-            conversationMessageId: {
-                referenceId: "referenceId",
+            field: "Category",
+        },
+    ],
+    columnDefinitions: [
+        {
+            header: "count",
+            metric: {
+                type: "count",
+            },
+        },
+        {
+            header: "avg_first_response_time",
+            metric: {
+                type: "average",
+                targetField: "FirstResponseTime",
             },
         },
         {
-            conversationMessageId: {
-                referenceId: "referenceId",
+            header: "percentile_handle_time",
+            metric: {
+                type: "percentile",
+                targetField: "HandleTime",
+                percentile: 25,
             },
         },
     ],
@@ -107,7 +124,7 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.conversation.initialize(...);
+    await client.analytics.getConversationTable(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -124,7 +141,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.conversation.initialize(..., {
+const response = await client.analytics.getConversationTable(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -146,7 +163,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.conversation.initialize(..., {
+const response = await client.analytics.getConversationTable(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -156,7 +173,7 @@ const response = await client.conversation.initialize(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.conversation.initialize(..., {
+const response = await client.analytics.getConversationTable(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -167,7 +184,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.conversation.initialize(..., {
+const response = await client.analytics.getConversationTable(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

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

@@ -87,7 +87,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/actions"),
                 method: "PUT",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.5", "User-Agent": "mavenagi/1.0.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.7", "User-Agent": "mavenagi/1.0.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -167,7 +167,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.5", "User-Agent": "mavenagi/1.0.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.7", "User-Agent": "mavenagi/1.0.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -246,7 +246,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.5", "User-Agent": "mavenagi/1.0.5", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.7", "User-Agent": "mavenagi/1.0.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -0,0 +1,162 @@
+/**
+ * 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 Analytics {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | 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 Analytics {
+    protected readonly _options: Analytics.Options;
+    constructor(_options: Analytics.Options);
+    /**
+     * Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
+     *
+     * @param {MavenAGI.ConversationTableRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.analytics.getConversationTable({
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         timeGrouping: "DAY",
+     *         fieldGroupings: [{
+     *                 field: "Category"
+     *             }],
+     *         columnDefinitions: [{
+     *                 header: "count",
+     *                 metric: {
+     *                     type: "count"
+     *                 }
+     *             }, {
+     *                 header: "avg_first_response_time",
+     *                 metric: {
+     *                     type: "average",
+     *                     targetField: "FirstResponseTime"
+     *                 }
+     *             }, {
+     *                 header: "percentile_handle_time",
+     *                 metric: {
+     *                     type: "percentile",
+     *                     targetField: "HandleTime",
+     *                     percentile: 25
+     *                 }
+     *             }]
+     *     })
+     */
+    getConversationTable(request: MavenAGI.ConversationTableRequest, requestOptions?: Analytics.RequestOptions): Promise<MavenAGI.ConversationTableResponse>;
+    /**
+     * Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
+     *
+     * @param {MavenAGI.ConversationChartRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.analytics.getConversationChart({
+     *         type: "pieChart",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         groupBy: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.analytics.getConversationChart({
+     *         type: "dateHistogram",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         timeInterval: "DAY",
+     *         groupBy: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.analytics.getConversationChart({
+     *         type: "barChart",
+     *         conversationFilter: {
+     *             languages: ["en", "es"]
+     *         },
+     *         barDefinition: {
+     *             field: "Category"
+     *         },
+     *         metric: {
+     *             type: "count"
+     *         },
+     *         verticalGrouping: {
+     *             field: "ResolutionStatus"
+     *         }
+     *     })
+     */
+    getConversationChart(request: MavenAGI.ConversationChartRequest, requestOptions?: Analytics.RequestOptions): Promise<MavenAGI.ChartResponse>;
+    /**
+     * Retrieves structured feedback data formatted as a table, allowing users to group, filter,  and define specific metrics to display as columns.
+     *
+     * @param {MavenAGI.FeedbackTableRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.analytics.getFeedbackTable({
+     *         feedbackFilter: {
+     *             types: ["THUMBS_UP", "INSERT"]
+     *         },
+     *         fieldGroupings: [{
+     *                 field: "CreatedBy"
+     *             }],
+     *         columnDefinitions: [{
+     *                 header: "feedback_count",
+     *                 metric: {
+     *                     type: "count"
+     *                 }
+     *             }]
+     *     })
+     */
+    getFeedbackTable(request: MavenAGI.FeedbackTableRequest, requestOptions?: Analytics.RequestOptions): Promise<MavenAGI.FeedbackTableResponse>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}