mavenagi 1.0.5 → 1.0.7

package/reference.md

@@ -213,6 +213,258 @@ await client.actions.delete("get-balance");
 </dl>
 </details>
 
+## Analytics
+
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+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,
+            },
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationTableRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Analytics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.analytics.getConversationChart({
+    type: "pieChart",
+    conversationFilter: {
+        languages: ["en", "es"],
+    },
+    groupBy: {
+        field: "Category",
+    },
+    metric: {
+        type: "count",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationChartRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Analytics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getFeedbackTable</a>({ ...params }) -> MavenAGI.FeedbackTableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves structured feedback data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.analytics.getFeedbackTable({
+    feedbackFilter: {
+        types: ["THUMBS_UP", "INSERT"],
+    },
+    fieldGroupings: [
+        {
+            field: "CreatedBy",
+        },
+    ],
+    columnDefinitions: [
+        {
+            header: "feedback_count",
+            metric: {
+                type: "count",
+            },
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.FeedbackTableRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Analytics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## AppSettings
 
 <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
@@ -306,11 +558,21 @@ await client.conversation.initialize({
     },
     messages: [
         {
+            userId: {
+                referenceId: "referenceId",
+            },
+            text: "text",
+            userMessageType: "USER",
             conversationMessageId: {
                 referenceId: "referenceId",
             },
         },
         {
+            userId: {
+                referenceId: "referenceId",
+            },
+            text: "text",
+            userMessageType: "USER",
             conversationMessageId: {
                 referenceId: "referenceId",
             },
@@ -422,6 +684,85 @@ await client.conversation.get("conversationId");
 </dl>
 </details>
 
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">delete</a>(conversationId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Wipes a conversation of all user data.
+The conversation ID will still exist and non-user specific data will still be retained.
+Attempts to modify or add messages to the conversation will throw an error.
+
+<Warning>This is a destructive operation and cannot be undone. <br/><br/>
+The exact fields cleared include: the conversation subject, userRequest, agentResponse.
+As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.delete("conversation-0", {
+    reason: "GDPR deletion request 1234.",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**conversationId:** `string` — The ID of the conversation to delete
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationDeleteRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversation.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">appendNewMessages</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
 <dl>
 <dd>
@@ -434,7 +775,7 @@ await client.conversation.get("conversationId");
 <dl>
 <dd>
 
-Append messages to an existing conversation. The conversation must be initialized first. If a message with the same id already exists, it will be ignored.
+Append messages to an existing conversation. The conversation must be initialized first. If a message with the same ID already exists, it will be ignored. Messages do not allow modification.
 
 </dd>
 </dl>
@@ -452,11 +793,21 @@ Append messages to an existing conversation. The conversation must be initialize
 ```typescript
 await client.conversation.appendNewMessages("conversationId", [
     {
+        userId: {
+            referenceId: "referenceId",
+        },
+        text: "text",
+        userMessageType: "USER",
         conversationMessageId: {
             referenceId: "referenceId",
         },
     },
     {
+        userId: {
+            referenceId: "referenceId",
+        },
+        text: "text",
+        userMessageType: "USER",
         conversationMessageId: {
             referenceId: "referenceId",
         },
@@ -516,8 +867,17 @@ await client.conversation.appendNewMessages("conversationId", [
 <dl>
 <dd>
 
-Ask a question
+Get an answer from Maven for a given user question. If the user question or its answer already exists,
+they will be reused and will not be updated. Messages do not allow modification once generated.
+
+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 Limitation:
+
+-   The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
 </dd>
 </dl>
 </dd>
@@ -605,8 +965,21 @@ await client.conversation.ask("conversation-0", {
 <dl>
 <dd>
 
-Ask a question with a streaming response. The response will be sent as a stream of events. The text portions of stream responses should be concatenated to form the full response text. Action and metadata events should overwrite past data and do not need concatenation.
+Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
+The text portions of stream responses should be concatenated to form the full response text.
+Action and metadata events should overwrite past data and do not need concatenation.
+
+If the user question or its answer already exists, they will be reused and will not be updated.
+Messages do not allow modification once generated.
 
+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 Limitation:
+
+-   The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
 </dd>
 </dl>
 </dd>
@@ -697,7 +1070,7 @@ for await (const item of response) {
 <dl>
 <dd>
 
-Generate a response suggestion for each requested message id in a conversation
+This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
 
 </dd>
 </dl>
@@ -1970,3 +2343,79 @@ await client.users.get("user-0");
 </dd>
 </dl>
 </details>
+
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">delete</a>(userId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes all identifiers and user data saved by the specified app.
+Does not modify data or identifiers saved by other apps.
+
+If this user is linked to a user from another app, it will not be unlinked. Unlinking of users is not yet supported.
+
+<Warning>This is a destructive operation and cannot be undone.</Warning>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.users.delete("user-0");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**userId:** `string` — The reference ID of the user to delete. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.UserDeleteRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Users.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>

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

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

package/serialization/resources/analytics/index.js

@@ -0,0 +1,17 @@
+"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);

package/serialization/resources/analytics/types/BarChartRequest.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { ConversationGroupBy } from "./ConversationGroupBy";
+import { ConversationMetric } from "./ConversationMetric";
+import { ConversationAnalyticsRequest } from "./ConversationAnalyticsRequest";
+export declare const BarChartRequest: core.serialization.ObjectSchema<serializers.BarChartRequest.Raw, MavenAGI.BarChartRequest>;
+export declare namespace BarChartRequest {
+    interface Raw extends ConversationAnalyticsRequest.Raw {
+        barDefinition: ConversationGroupBy.Raw;
+        metric: ConversationMetric.Raw;
+        verticalGrouping?: ConversationGroupBy.Raw | null;
+    }
+}

package/serialization/resources/analytics/types/BarChartRequest.js

@@ -0,0 +1,40 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarChartRequest = void 0;
+const core = __importStar(require("../../../../core"));
+const ConversationGroupBy_1 = require("./ConversationGroupBy");
+const ConversationMetric_1 = require("./ConversationMetric");
+const ConversationAnalyticsRequest_1 = require("./ConversationAnalyticsRequest");
+exports.BarChartRequest = core.serialization
+    .object({
+    barDefinition: ConversationGroupBy_1.ConversationGroupBy,
+    metric: ConversationMetric_1.ConversationMetric,
+    verticalGrouping: ConversationGroupBy_1.ConversationGroupBy.optional(),
+})
+    .extend(ConversationAnalyticsRequest_1.ConversationAnalyticsRequest);

package/serialization/resources/analytics/types/BarChartResponse.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+import { Series } from "./Series";
+export declare const BarChartResponse: core.serialization.ObjectSchema<serializers.BarChartResponse.Raw, MavenAGI.BarChartResponse>;
+export declare namespace BarChartResponse {
+    interface Raw {
+        series: Series.Raw[];
+    }
+}

package/serialization/resources/analytics/types/BarChartResponse.js

@@ -0,0 +1,34 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BarChartResponse = void 0;
+const core = __importStar(require("../../../../core"));
+const Series_1 = require("./Series");
+exports.BarChartResponse = core.serialization.object({
+    series: core.serialization.list(Series_1.Series),
+});

package/serialization/resources/analytics/types/CellData.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as MavenAGI from "../../../../api/index";
+import * as core from "../../../../core";
+export declare const CellData: core.serialization.Schema<serializers.CellData.Raw, MavenAGI.CellData>;
+export declare namespace CellData {
+    type Raw = CellData.Double | CellData.Long | CellData.Millisecond | CellData.String;
+    interface Double {
+        type: "double";
+        value: number;
+    }
+    interface Long {
+        type: "long";
+        value: number;
+    }
+    interface Millisecond {
+        type: "millisecond";
+        value: number;
+    }
+    interface String {
+        type: "string";
+        value: string;
+    }
+}