mavenagi 1.0.5 → 1.0.6

package/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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 });

package/dist/api/resources/analytics/types/ConversationTableResponse.d.ts

@@ -0,0 +1,129 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         headers: ["count", "avg_first_response_time", "percentile_first_response_time"],
+ *         rows: [{
+ *                 identifier: {
+ *                     [MavenAGI.ConversationField.Category]: {
+ *                         type: "string",
+ *                         value: "Sales"
+ *                     },
+ *                     [MavenAGI.ConversationField.CreatedAt]: {
+ *                         type: "dateTime",
+ *                         value: "2023-10-01T00:00:00Z"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "count": {
+ *                         type: "double",
+ *                         value: 5
+ *                     },
+ *                     "avg_first_response_time": {
+ *                         type: "millisecond",
+ *                         value: 150
+ *                     },
+ *                     "percentile_handle_time": {
+ *                         type: "percentileMap",
+ *                         value: {
+ *                             "25": 100,
+ *                             "75": 250
+ *                         }
+ *                     }
+ *                 }
+ *             }, {
+ *                 identifier: {
+ *                     [MavenAGI.ConversationField.Category]: {
+ *                         type: "string",
+ *                         value: "Support"
+ *                     },
+ *                     [MavenAGI.ConversationField.CreatedAt]: {
+ *                         type: "dateTime",
+ *                         value: "2023-10-01T00:00:00Z"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "count": {
+ *                         type: "double",
+ *                         value: 10
+ *                     },
+ *                     "avg_first_response_time": {
+ *                         type: "millisecond",
+ *                         value: 300
+ *                     },
+ *                     "percentile_handle_time": {
+ *                         type: "percentileMap",
+ *                         value: {
+ *                             "25": 200,
+ *                             "75": 400
+ *                         }
+ *                     }
+ *                 }
+ *             }, {
+ *                 identifier: {
+ *                     [MavenAGI.ConversationField.Category]: {
+ *                         type: "string",
+ *                         value: "Sales"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "count": {
+ *                         type: "double",
+ *                         value: 7
+ *                     },
+ *                     "avg_first_response_time": {
+ *                         type: "millisecond",
+ *                         value: 180
+ *                     },
+ *                     "percentile_handle_time": {
+ *                         type: "percentileMap",
+ *                         value: {
+ *                             "25": 130,
+ *                             "75": 280
+ *                         }
+ *                     }
+ *                 }
+ *             }, {
+ *                 identifier: {
+ *                     [MavenAGI.ConversationField.Category]: {
+ *                         type: "string",
+ *                         value: "Support"
+ *                     },
+ *                     [MavenAGI.ConversationField.CreatedAt]: {
+ *                         type: "dateTime",
+ *                         value: "2023-10-02T00:00:00Z"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "count": {
+ *                         type: "double",
+ *                         value: 8
+ *                     },
+ *                     "avg_first_response_time": {
+ *                         type: "millisecond",
+ *                         value: 320
+ *                     },
+ *                     "percentile_handle_time": {
+ *                         type: "percentileMap",
+ *                         value: {
+ *                             "25": 220,
+ *                             "75": 420
+ *                         }
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface ConversationTableResponse {
+    /** Column headers in the table, aligning with the column definitions specified in the request. */
+    headers: string[];
+    /**
+     * The dataset rows, where each row represents a unique combination of grouping field values.
+     * The identifier map contains grouping field names mapped to their respective values.
+     * The data map contains column headers mapped to their respective metric values.
+     */
+    rows: MavenAGI.ConversationRow[];
+}

package/dist/api/resources/analytics/types/ConversationTableResponse.js

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

package/dist/api/resources/analytics/types/Count.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Returns the total count of records in a group.
+ */
+export interface Count {
+}

package/dist/api/resources/analytics/types/Count.js

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

package/dist/api/resources/analytics/types/DistinctCount.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Estimates the number of unique values in the specified field.
+ * Supports fields with list values as well.
+ */
+export interface DistinctCount extends MavenAGI.BasicMetric {
+}

package/dist/api/resources/analytics/types/DistinctCount.js

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

package/dist/api/resources/analytics/types/GroupBy.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface GroupBy {
+    /** Field used for data grouping. */
+    field: MavenAGI.ConversationField;
+    /** Limits the number of groups returned (defaults to 100 if omitted). */
+    limit?: number;
+    /** Numeric ranges for grouping data into predefined buckets. Applies only to numeric fields. */
+    ranges?: MavenAGI.Range[];
+}

package/dist/api/resources/analytics/types/GroupBy.js

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

package/dist/api/resources/analytics/types/Max.d.ts

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

package/dist/api/resources/analytics/types/Max.js

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

package/dist/api/resources/analytics/types/Median.d.ts

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

package/dist/api/resources/analytics/types/Median.js

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

package/dist/api/resources/analytics/types/Metric.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Defines the metric to be calculated for a column or chart.
+ * Only numeric fields are supported, except for Count and DistinctCount, which can be applied to any field.
+ */
+export declare type Metric = MavenAGI.Metric.Count | MavenAGI.Metric.Sum | MavenAGI.Metric.Average | MavenAGI.Metric.Min | MavenAGI.Metric.Max | MavenAGI.Metric.Percentile | MavenAGI.Metric.Median | MavenAGI.Metric.DistinctCount;
+export declare namespace Metric {
+    interface Count extends MavenAGI.Count {
+        type: "count";
+    }
+    interface Sum extends MavenAGI.Sum {
+        type: "sum";
+    }
+    interface Average extends MavenAGI.Average {
+        type: "average";
+    }
+    interface Min extends MavenAGI.Min {
+        type: "min";
+    }
+    interface Max extends MavenAGI.Max {
+        type: "max";
+    }
+    interface Percentile extends MavenAGI.Percentile {
+        type: "percentile";
+    }
+    interface Median extends MavenAGI.Median {
+        type: "median";
+    }
+    interface DistinctCount extends MavenAGI.DistinctCount {
+        type: "distinctCount";
+    }
+}

package/dist/api/resources/analytics/types/Metric.js

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

package/dist/api/resources/analytics/types/Min.d.ts

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

package/dist/api/resources/analytics/types/Min.js

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

package/dist/api/resources/analytics/types/Percentile.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Calculates specified percentiles for a numeric field.
+ */
+export interface Percentile extends MavenAGI.BasicMetric {
+    /** List of percentiles to calculate. Example: [25, 50, 75] computes the 25th, 50th, and 75th percentiles. */
+    percentiles: number[];
+}

package/dist/api/resources/analytics/types/Percentile.js

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

package/dist/api/resources/analytics/types/Sum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Computes the sum of all values in the specified field.
+ */
+export interface Sum extends MavenAGI.BasicMetric {
+}

package/dist/api/resources/analytics/types/Sum.js

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

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

@@ -0,0 +1,16 @@
+export * from "./ConversationAnalyticsRequest";
+export * from "./ConversationTableRequest";
+export * from "./ConversationTableResponse";
+export * from "./ColumnDefinition";
+export * from "./Metric";
+export * from "./Count";
+export * from "./BasicMetric";
+export * from "./Sum";
+export * from "./Average";
+export * from "./Min";
+export * from "./Max";
+export * from "./Median";
+export * from "./DistinctCount";
+export * from "./Percentile";
+export * from "./GroupBy";
+export * from "./ConversationRow";

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

@@ -0,0 +1,32 @@
+"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("./ConversationAnalyticsRequest"), exports);
+__exportStar(require("./ConversationTableRequest"), exports);
+__exportStar(require("./ConversationTableResponse"), exports);
+__exportStar(require("./ColumnDefinition"), exports);
+__exportStar(require("./Metric"), exports);
+__exportStar(require("./Count"), exports);
+__exportStar(require("./BasicMetric"), exports);
+__exportStar(require("./Sum"), exports);
+__exportStar(require("./Average"), exports);
+__exportStar(require("./Min"), exports);
+__exportStar(require("./Max"), exports);
+__exportStar(require("./Median"), exports);
+__exportStar(require("./DistinctCount"), exports);
+__exportStar(require("./Percentile"), exports);
+__exportStar(require("./GroupBy"), exports);
+__exportStar(require("./ConversationRow"), exports);

package/dist/api/resources/analyticsCommons/index.d.ts

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

package/dist/api/resources/analyticsCommons/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/dist/api/resources/analyticsCommons/types/CellData.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export declare type CellData = MavenAGI.CellData.Double | MavenAGI.CellData.Long | MavenAGI.CellData.Millisecond | MavenAGI.CellData.String
+/**
+ * A map containing percentile values computed based on the percentile metric request.
+ * Keys represent percentile levels, and values are their corresponding computed results.
+ *  */
+ | MavenAGI.CellData.PercentileMap;
+export declare namespace CellData {
+    interface Double {
+        type: "double";
+        value: number;
+    }
+    interface Long {
+        type: "long";
+        value: number;
+    }
+    interface Millisecond {
+        type: "millisecond";
+        value: number;
+    }
+    interface String {
+        type: "string";
+        value: string;
+    }
+    interface PercentileMap {
+        type: "percentileMap";
+        value: Record<string, number>;
+    }
+}

package/dist/api/resources/analyticsCommons/types/CellData.js

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

package/dist/api/resources/analyticsCommons/types/FieldValue.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export declare type FieldValue = MavenAGI.FieldValue.DateTime | MavenAGI.FieldValue.String | MavenAGI.FieldValue.Double | MavenAGI.FieldValue.Long | MavenAGI.FieldValue.Range | MavenAGI.FieldValue.Boolean | MavenAGI.FieldValue.EntityId;
+export declare namespace FieldValue {
+    interface DateTime {
+        type: "dateTime";
+        value: Date;
+    }
+    interface String {
+        type: "string";
+        value: string;
+    }
+    interface Double {
+        type: "double";
+        value: number;
+    }
+    interface Long {
+        type: "long";
+        value: number;
+    }
+    interface Range extends MavenAGI.Range {
+        type: "range";
+    }
+    interface Boolean {
+        type: "boolean";
+        value: boolean;
+    }
+    interface EntityId extends MavenAGI.EntityIdFilter {
+        type: "entityId";
+    }
+}

package/dist/api/resources/analyticsCommons/types/FieldValue.js

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

package/dist/api/resources/analyticsCommons/types/Range.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Range {
+    /** Lower bound of the range (inclusive). */
+    from?: number;
+    /** Upper bound of the range (exclusive). */
+    to?: number;
+}

package/dist/api/resources/analyticsCommons/types/Range.js

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

package/dist/api/resources/analyticsCommons/types/TimeInterval.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type TimeInterval = "HOUR" | "DAY" | "WEEK" | "MONTH" | "YEAR";
+export declare const TimeInterval: {
+    readonly Hour: "HOUR";
+    readonly Day: "DAY";
+    readonly Week: "WEEK";
+    readonly Month: "MONTH";
+    readonly Year: "YEAR";
+};

package/dist/api/resources/analyticsCommons/types/TimeInterval.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimeInterval = void 0;
+exports.TimeInterval = {
+    Hour: "HOUR",
+    Day: "DAY",
+    Week: "WEEK",
+    Month: "MONTH",
+    Year: "YEAR",
+};

package/dist/api/resources/analyticsCommons/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./FieldValue";
+export * from "./TimeInterval";
+export * from "./Range";
+export * from "./CellData";