mavenagi 1.0.5 → 1.0.6

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",
+                percentiles: [25, 75],
             },
         },
     ],
@@ -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.6", "User-Agent": "mavenagi/1.0.6", "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.6", "User-Agent": "mavenagi/1.0.6", "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.6", "User-Agent": "mavenagi/1.0.6", "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,78 @@
+/**
+ * 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",
+     *                     percentiles: [25, 75]
+     *                 }
+     *             }]
+     *     })
+     */
+    getConversationTable(request: MavenAGI.ConversationTableRequest, requestOptions?: Analytics.RequestOptions): Promise<MavenAGI.ConversationTableResponse>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}

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

@@ -0,0 +1,174 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const environments = __importStar(require("../../../../environments"));
+const core = __importStar(require("../../../../core"));
+const MavenAGI = __importStar(require("../../../index"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const url_join_1 = __importDefault(require("url-join"));
+const errors = __importStar(require("../../../../errors/index"));
+class Analytics {
+    constructor(_options) {
+        this._options = _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",
+     *                     percentiles: [25, 75]
+     *                 }
+     *             }]
+     *     })
+     */
+    getConversationTable(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            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/tables/conversations"),
+                method: "POST",
+                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.6", "User-Agent": "mavenagi/1.0.6", "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.ConversationTableRequest.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 serializers.ConversationTableResponse.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            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"],
+                        }));
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/tables/conversations.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const appId = (_a = (yield core.Supplier.get(this._options.appId))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env["MAVENAGI_APP_ID"];
+            const appSecret = (_b = (yield core.Supplier.get(this._options.appSecret))) !== null && _b !== void 0 ? _b : process === null || process === void 0 ? void 0 : process.env["MAVENAGI_APP_SECRET"];
+            if (appId != null && appSecret != null) {
+                return core.BasicAuth.toAuthorizationHeader({
+                    username: appId,
+                    password: appSecret,
+                });
+            }
+            return undefined;
+        });
+    }
+}
+exports.Analytics = Analytics;

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

@@ -0,0 +1 @@
+export {};

package/api/resources/analytics/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/analytics/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./client";

package/api/resources/analytics/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types"), exports);
+__exportStar(require("./client"), exports);

package/api/resources/analytics/types/Average.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Calculates the average value of the specified field.
+ */
+export interface Average extends MavenAGI.BasicMetric {
+}

package/api/resources/analytics/types/Average.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/analytics/types/BasicMetric.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface BasicMetric {
+    /** Field to apply the metric to. The field should be numeric for all metrics except for Count (no field) and DistinctCount. */
+    targetField: MavenAGI.ConversationField;
+}

package/api/resources/analytics/types/BasicMetric.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/analytics/types/ColumnDefinition.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ColumnDefinition {
+    /** Unique column header, serving as the key for corresponding metric values. */
+    header: string;
+    /** The metric calculated for this column, stored in the row data under the specified header. */
+    metric: MavenAGI.Metric;
+}

package/api/resources/analytics/types/ColumnDefinition.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/analytics/types/ConversationAnalyticsRequest.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationAnalyticsRequest {
+    /** Optional filter applied to refine the conversation data before processing. */
+    conversationFilter?: MavenAGI.ConversationFilter;
+}

package/api/resources/analytics/types/ConversationAnalyticsRequest.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/analytics/types/ConversationRow.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationRow {
+    /**
+     * A unique identifier for each row, consisting of field names mapped to their respective values.
+     * This includes time groupings and any specified field groupings.
+     */
+    identifier: Record<MavenAGI.ConversationField, MavenAGI.FieldValue | undefined>;
+    /** The actual row data, where keys represent column headers and values contain the respective metric results. */
+    data: Record<string, MavenAGI.CellData>;
+}

package/api/resources/analytics/types/ConversationRow.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/analytics/types/ConversationTableRequest.d.ts

@@ -0,0 +1,50 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         conversationFilter: {
+ *             languages: ["en", "es"]
+ *         },
+ *         timeGrouping: MavenAGI.TimeInterval.Day,
+ *         fieldGroupings: [{
+ *                 field: MavenAGI.ConversationField.Category
+ *             }],
+ *         columnDefinitions: [{
+ *                 header: "count",
+ *                 metric: {
+ *                     type: "count"
+ *                 }
+ *             }, {
+ *                 header: "avg_first_response_time",
+ *                 metric: {
+ *                     type: "average",
+ *                     targetField: MavenAGI.ConversationField.FirstResponseTime
+ *                 }
+ *             }, {
+ *                 header: "percentile_handle_time",
+ *                 metric: {
+ *                     type: "percentile",
+ *                     targetField: MavenAGI.ConversationField.HandleTime,
+ *                     percentiles: [25, 75]
+ *                 }
+ *             }]
+ *     }
+ */
+export interface ConversationTableRequest extends MavenAGI.ConversationAnalyticsRequest {
+    /**
+     * Defines the time interval for grouping data. If specified, data is grouped accordingly based on the time they were created.
+     * Example: If set to "DAY," data will be aggregated by day.
+     */
+    timeGrouping?: MavenAGI.TimeInterval;
+    /**
+     * Specifies the fields by which data should be grouped. Each unique combination forms a row.
+     * If multiple fields are provided, the result is grouped by their unique value combinations.
+     * If empty, all data is aggregated into a single row.
+     */
+    fieldGroupings: MavenAGI.GroupBy[];
+    /** Specifies the metrics to be displayed as columns. Column headers act as keys, with computed metric values as their mapped values. There needs to be at least one column definition in the table request. */
+    columnDefinitions: MavenAGI.ColumnDefinition[];
+}

package/api/resources/analytics/types/ConversationTableRequest.js

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