mavenagi 1.0.5 → 1.0.7

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

@@ -0,0 +1,63 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         type: "pieChart",
+ *         conversationFilter: {
+ *             languages: ["en", "es"]
+ *         },
+ *         groupBy: {
+ *             field: MavenAGI.ConversationField.Category
+ *         },
+ *         metric: {
+ *             type: "count"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "dateHistogram",
+ *         conversationFilter: {
+ *             languages: ["en", "es"]
+ *         },
+ *         timeInterval: MavenAGI.TimeInterval.Day,
+ *         groupBy: {
+ *             field: MavenAGI.ConversationField.Category
+ *         },
+ *         metric: {
+ *             type: "count"
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "barChart",
+ *         conversationFilter: {
+ *             languages: ["en", "es"]
+ *         },
+ *         barDefinition: {
+ *             field: MavenAGI.ConversationField.Category
+ *         },
+ *         metric: {
+ *             type: "count"
+ *         },
+ *         verticalGrouping: {
+ *             field: MavenAGI.ConversationField.ResolutionStatus
+ *         }
+ *     }
+ */
+export declare type ConversationChartRequest = MavenAGI.ConversationChartRequest.PieChart | MavenAGI.ConversationChartRequest.DateHistogram | MavenAGI.ConversationChartRequest.BarChart;
+export declare namespace ConversationChartRequest {
+    interface PieChart extends MavenAGI.PieChartRequest {
+        type: "pieChart";
+    }
+    interface DateHistogram extends MavenAGI.DateHistogramRequest {
+        type: "dateHistogram";
+    }
+    interface BarChart extends MavenAGI.BarChartRequest {
+        type: "barChart";
+    }
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationColumnDefinition extends MavenAGI.ColumnDefinitionBase {
+    /** The metric calculated for this column, stored in the row data under the specified header. */
+    metric: MavenAGI.ConversationMetric;
+}

package/api/resources/analytics/types/ConversationColumnDefinition.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/ConversationCount.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 ConversationCount {
+}

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

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

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationGroupBy extends MavenAGI.GroupByBase {
+    /** Field used for data grouping. */
+    field: MavenAGI.ConversationField;
+    /** Numeric ranges for grouping data into predefined buckets. Applies only to numeric fields. */
+    ranges?: MavenAGI.Range[];
+}

package/api/resources/analytics/types/ConversationGroupBy.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/ConversationMax.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 ConversationMax extends MavenAGI.ConversationNumericMetric {
+}

package/api/resources/analytics/types/ConversationMax.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/ConversationMedian.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 ConversationMedian extends MavenAGI.ConversationNumericMetric {
+}

package/api/resources/analytics/types/ConversationMedian.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/ConversationMetric.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 ConversationCount and ConversationDistinctCount, which can be applied to any field.
+ */
+export declare type ConversationMetric = MavenAGI.ConversationMetric.Count | MavenAGI.ConversationMetric.Sum | MavenAGI.ConversationMetric.Average | MavenAGI.ConversationMetric.Min | MavenAGI.ConversationMetric.Max | MavenAGI.ConversationMetric.Percentile | MavenAGI.ConversationMetric.Median | MavenAGI.ConversationMetric.DistinctCount;
+export declare namespace ConversationMetric {
+    interface Count extends MavenAGI.ConversationCount {
+        type: "count";
+    }
+    interface Sum extends MavenAGI.ConversationSum {
+        type: "sum";
+    }
+    interface Average extends MavenAGI.ConversationAverage {
+        type: "average";
+    }
+    interface Min extends MavenAGI.ConversationMin {
+        type: "min";
+    }
+    interface Max extends MavenAGI.ConversationMax {
+        type: "max";
+    }
+    interface Percentile extends MavenAGI.ConversationPercentile {
+        type: "percentile";
+    }
+    interface Median extends MavenAGI.ConversationMedian {
+        type: "median";
+    }
+    interface DistinctCount extends MavenAGI.ConversationDistinctCount {
+        type: "distinctCount";
+    }
+}

package/api/resources/analytics/types/ConversationMetric.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/ConversationMin.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 ConversationMin extends MavenAGI.ConversationNumericMetric {
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationNumericMetric {
+    /** Numeric field to apply the metric to. */
+    targetField: MavenAGI.NumericConversationField;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Calculates specified percentile for a numeric field.
+ */
+export interface ConversationPercentile extends MavenAGI.ConversationNumericMetric {
+    /** The percentile to calculate. Example: 25 computes the 25th percentile. */
+    percentile: number;
+}

package/api/resources/analytics/types/ConversationPercentile.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,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationRow extends MavenAGI.RowBase {
+    /**
+     * 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>;
+}

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/ConversationSum.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 ConversationSum extends MavenAGI.ConversationNumericMetric {
+}

package/api/resources/analytics/types/ConversationSum.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,47 @@
+/**
+ * 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.NumericConversationField.FirstResponseTime
+ *                 }
+ *             }, {
+ *                 header: "percentile_handle_time",
+ *                 metric: {
+ *                     type: "percentile",
+ *                     targetField: MavenAGI.NumericConversationField.HandleTime,
+ *                     percentile: 25
+ *                 }
+ *             }]
+ *     }
+ */
+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.ConversationGroupBy[];
+    /** 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.ConversationColumnDefinition[];
+}

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 });

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

@@ -0,0 +1,115 @@
+/**
+ * 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: "millisecond",
+ *                         value: 110
+ *                     }
+ *                 }
+ *             }, {
+ *                 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: "millisecond",
+ *                         value: 250
+ *                     }
+ *                 }
+ *             }, {
+ *                 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: "millisecond",
+ *                         value: 180
+ *                     }
+ *                 }
+ *             }, {
+ *                 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: "millisecond",
+ *                         value: 220
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface ConversationTableResponse extends MavenAGI.TableResponseBase {
+    /**
+     * 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/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/api/resources/analytics/types/DateHistogramRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface DateHistogramRequest extends MavenAGI.ConversationAnalyticsRequest {
+    /** Time-based grouping interval (e.g., HOUR, DAY, WEEK) for the date histogram. */
+    timeInterval: MavenAGI.TimeInterval;
+    /** Groups data before applying calculations, forming a separate time series for each group. */
+    groupBy?: MavenAGI.ConversationGroupBy;
+    /** Defines the y-axis values for the date histogram. */
+    metric: MavenAGI.ConversationMetric;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface DateHistogramResponse {
+    /**
+     * The dataset for the date histogram.
+     * Each series represents a separate plottable time series.
+     * Series names reflect the grouping field values.
+     */
+    timeSeries: MavenAGI.TimeSeries[];
+}

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackColumnDefinition extends MavenAGI.ColumnDefinitionBase {
+    /** The metric calculated for this column, stored in the row data under the specified header. */
+    metric: MavenAGI.FeedbackMetric;
+}

package/api/resources/analytics/types/FeedbackColumnDefinition.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/FeedbackCount.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 FeedbackCount {
+}

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * Calculates the number of unique values in the specified field.
+ * Supports fields with list values as well.
+ */
+export interface FeedbackDistinctCount {
+    /** All the distinct values of this field will be counted. */
+    targetField: MavenAGI.FeedbackField;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackGroupBy extends MavenAGI.GroupByBase {
+    /** Field used for data grouping. */
+    field: MavenAGI.FeedbackField;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+export declare type FeedbackMetric = MavenAGI.FeedbackMetric.Count | MavenAGI.FeedbackMetric.DistinctCount;
+export declare namespace FeedbackMetric {
+    interface Count extends MavenAGI.FeedbackCount {
+        type: "count";
+    }
+    interface DistinctCount extends MavenAGI.FeedbackDistinctCount {
+        type: "distinctCount";
+    }
+}

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

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