mavenagi 1.0.6 → 1.0.7

package/reference.md

@@ -272,7 +272,7 @@ await client.analytics.getConversationTable({
             metric: {
                 type: "percentile",
                 targetField: "HandleTime",
-                percentiles: [25, 75],
+                percentile: 25,
             },
         },
     ],
@@ -311,6 +311,160 @@ await client.analytics.getConversationTable({
 </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>
@@ -404,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",
             },
@@ -629,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",
         },
@@ -2169,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/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/{analyticsCommons → analytics}/types/CellData.d.ts

@@ -6,7 +6,7 @@ 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 | CellData.PercentileMap;
+    type Raw = CellData.Double | CellData.Long | CellData.Millisecond | CellData.String;
     interface Double {
         type: "double";
         value: number;
@@ -23,8 +23,4 @@ export declare namespace CellData {
         type: "string";
         value: string;
     }
-    interface PercentileMap {
-        type: "percentileMap";
-        value: Record<string, number>;
-    }
 }

package/{dist/serialization/resources/analyticsCommons → serialization/resources/analytics}/types/CellData.js

@@ -42,9 +42,6 @@ exports.CellData = core.serialization
     string: core.serialization.object({
         value: core.serialization.string(),
     }),
-    percentileMap: core.serialization.object({
-        value: core.serialization.record(core.serialization.string(), core.serialization.number()),
-    }),
 })
     .transform({
     transform: (value) => value,

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

@@ -0,0 +1,22 @@
+/**
+ * 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 { PieChartResponse } from "./PieChartResponse";
+import { DateHistogramResponse } from "./DateHistogramResponse";
+import { BarChartResponse } from "./BarChartResponse";
+export declare const ChartResponse: core.serialization.Schema<serializers.ChartResponse.Raw, MavenAGI.ChartResponse>;
+export declare namespace ChartResponse {
+    type Raw = ChartResponse.PieChart | ChartResponse.DateHistogram | ChartResponse.BarChart;
+    interface PieChart extends PieChartResponse.Raw {
+        type: "pieChart";
+    }
+    interface DateHistogram extends DateHistogramResponse.Raw {
+        type: "dateHistogram";
+    }
+    interface BarChart extends BarChartResponse.Raw {
+        type: "barChart";
+    }
+}

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

@@ -0,0 +1,43 @@
+"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.ChartResponse = void 0;
+const core = __importStar(require("../../../../core"));
+const PieChartResponse_1 = require("./PieChartResponse");
+const DateHistogramResponse_1 = require("./DateHistogramResponse");
+const BarChartResponse_1 = require("./BarChartResponse");
+exports.ChartResponse = core.serialization
+    .union("type", {
+    pieChart: PieChartResponse_1.PieChartResponse,
+    dateHistogram: DateHistogramResponse_1.DateHistogramResponse,
+    barChart: BarChartResponse_1.BarChartResponse,
+})
+    .transform({
+    transform: (value) => value,
+    untransform: (value) => value,
+});

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

@@ -0,0 +1,12 @@
+/**
+ * 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 ColumnDefinitionBase: core.serialization.ObjectSchema<serializers.ColumnDefinitionBase.Raw, MavenAGI.ColumnDefinitionBase>;
+export declare namespace ColumnDefinitionBase {
+    interface Raw {
+        header: string;
+    }
+}

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

@@ -0,0 +1,33 @@
+"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.ColumnDefinitionBase = void 0;
+const core = __importStar(require("../../../../core"));
+exports.ColumnDefinitionBase = core.serialization.object({
+    header: core.serialization.string(),
+});

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

@@ -0,0 +1,12 @@
+/**
+ * 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 { ConversationNumericMetric } from "./ConversationNumericMetric";
+export declare const ConversationAverage: core.serialization.ObjectSchema<serializers.ConversationAverage.Raw, MavenAGI.ConversationAverage>;
+export declare namespace ConversationAverage {
+    interface Raw extends ConversationNumericMetric.Raw {
+    }
+}

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

@@ -0,0 +1,32 @@
+"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.ConversationAverage = void 0;
+const core = __importStar(require("../../../../core"));
+const ConversationNumericMetric_1 = require("./ConversationNumericMetric");
+exports.ConversationAverage = core.serialization.object({}).extend(ConversationNumericMetric_1.ConversationNumericMetric);

package/serialization/resources/analytics/types/{BasicMetric.d.ts → ConversationBasicMetric.d.ts}

@@ -5,8 +5,8 @@ import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
 import { ConversationField } from "../../conversation/types/ConversationField";
-export declare const BasicMetric: core.serialization.ObjectSchema<serializers.BasicMetric.Raw, MavenAGI.BasicMetric>;
-export declare namespace BasicMetric {
+export declare const ConversationBasicMetric: core.serialization.ObjectSchema<serializers.ConversationBasicMetric.Raw, MavenAGI.ConversationBasicMetric>;
+export declare namespace ConversationBasicMetric {
     interface Raw {
         targetField: ConversationField.Raw;
     }

package/serialization/resources/analytics/types/{BasicMetric.js → ConversationBasicMetric.js}

@@ -26,9 +26,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasicMetric = void 0;
+exports.ConversationBasicMetric = void 0;
 const core = __importStar(require("../../../../core"));
 const ConversationField_1 = require("../../conversation/types/ConversationField");
-exports.BasicMetric = core.serialization.object({
+exports.ConversationBasicMetric = core.serialization.object({
     targetField: ConversationField_1.ConversationField,
 });

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

@@ -0,0 +1,22 @@
+/**
+ * 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 { PieChartRequest } from "./PieChartRequest";
+import { DateHistogramRequest } from "./DateHistogramRequest";
+import { BarChartRequest } from "./BarChartRequest";
+export declare const ConversationChartRequest: core.serialization.Schema<serializers.ConversationChartRequest.Raw, MavenAGI.ConversationChartRequest>;
+export declare namespace ConversationChartRequest {
+    type Raw = ConversationChartRequest.PieChart | ConversationChartRequest.DateHistogram | ConversationChartRequest.BarChart;
+    interface PieChart extends PieChartRequest.Raw {
+        type: "pieChart";
+    }
+    interface DateHistogram extends DateHistogramRequest.Raw {
+        type: "dateHistogram";
+    }
+    interface BarChart extends BarChartRequest.Raw {
+        type: "barChart";
+    }
+}

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

@@ -0,0 +1,43 @@
+"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.ConversationChartRequest = void 0;
+const core = __importStar(require("../../../../core"));
+const PieChartRequest_1 = require("./PieChartRequest");
+const DateHistogramRequest_1 = require("./DateHistogramRequest");
+const BarChartRequest_1 = require("./BarChartRequest");
+exports.ConversationChartRequest = core.serialization
+    .union("type", {
+    pieChart: PieChartRequest_1.PieChartRequest,
+    dateHistogram: DateHistogramRequest_1.DateHistogramRequest,
+    barChart: BarChartRequest_1.BarChartRequest,
+})
+    .transform({
+    transform: (value) => value,
+    untransform: (value) => value,
+});