mavenagi 1.0.6 → 1.0.8

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

@@ -0,0 +1,23 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export type CellData = MavenAGI.CellData.Double | MavenAGI.CellData.Long | MavenAGI.CellData.Millisecond | MavenAGI.CellData.String;
+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;
+    }
+}

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

@@ -0,0 +1,80 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         type: "pieChart",
+ *         series: {
+ *             name: "Series",
+ *             data: [{
+ *                     label: "Sales",
+ *                     y: 5
+ *                 }, {
+ *                     label: "Support",
+ *                     y: 10
+ *                 }]
+ *         }
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "dateHistogram",
+ *         timeSeries: [{
+ *                 name: "Sales",
+ *                 data: [{
+ *                         x: 1633046400000,
+ *                         y: 5
+ *                     }, {
+ *                         x: 1633132800000,
+ *                         y: 7
+ *                     }]
+ *             }, {
+ *                 name: "Support",
+ *                 data: [{
+ *                         x: 1633046400000,
+ *                         y: 10
+ *                     }, {
+ *                         x: 1633132800000,
+ *                         y: 8
+ *                     }]
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         type: "barChart",
+ *         series: [{
+ *                 name: "Resolved",
+ *                 data: [{
+ *                         label: "Sales",
+ *                         y: 5
+ *                     }, {
+ *                         label: "Support",
+ *                         y: 10
+ *                     }]
+ *             }, {
+ *                 name: "Escalated",
+ *                 data: [{
+ *                         label: "Sales",
+ *                         y: 7
+ *                     }, {
+ *                         label: "Support",
+ *                         y: 8
+ *                     }]
+ *             }]
+ *     }
+ */
+export type ChartResponse = MavenAGI.ChartResponse.PieChart | MavenAGI.ChartResponse.DateHistogram | MavenAGI.ChartResponse.BarChart;
+export declare namespace ChartResponse {
+    interface PieChart extends MavenAGI.PieChartResponse {
+        type: "pieChart";
+    }
+    interface DateHistogram extends MavenAGI.DateHistogramResponse {
+        type: "dateHistogram";
+    }
+    interface BarChart extends MavenAGI.BarChartResponse {
+        type: "barChart";
+    }
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ColumnDefinitionBase {
+    /** Unique column header, serving as the key for corresponding metric values. */
+    header: string;
+}

package/api/resources/analytics/types/{Average.d.ts → ConversationAverage.d.ts}

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 /**
  * Calculates the average value of the specified field.
  */
-export interface Average extends MavenAGI.BasicMetric {
+export interface ConversationAverage extends MavenAGI.ConversationNumericMetric {
 }

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationBarChartRequest extends MavenAGI.ConversationAnalyticsRequest {
+    /**
+     * Determines how data is grouped along the x-axis. Each unique value forms a separate bar.
+     * The name of the bar is derived from the grouping field's value or range.
+     */
+    barDefinition: MavenAGI.ConversationGroupBy;
+    /** Metric defining the y-axis values for the bar chart. */
+    metric: MavenAGI.ConversationMetric;
+    /**
+     * Optionally defines vertical grouping within each bar, producing multiple series.
+     * If omitted, a single series is generated.
+     */
+    verticalGrouping?: MavenAGI.ConversationGroupBy;
+}

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

@@ -2,7 +2,7 @@
  * 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. */
+export interface ConversationBasicMetric {
+    /** Field to apply the metric to. */
     targetField: MavenAGI.ConversationField;
 }

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 type ConversationChartRequest = MavenAGI.ConversationChartRequest.PieChart | MavenAGI.ConversationChartRequest.DateHistogram | MavenAGI.ConversationChartRequest.BarChart;
+export declare namespace ConversationChartRequest {
+    interface PieChart extends MavenAGI.ConversationPieChartRequest {
+        type: "pieChart";
+    }
+    interface DateHistogram extends MavenAGI.ConversationDateHistogramRequest {
+        type: "dateHistogram";
+    }
+    interface BarChart extends MavenAGI.ConversationBarChartRequest {
+        type: "barChart";
+    }
+}

package/{dist/api/resources/analytics/types/ColumnDefinition.d.ts → api/resources/analytics/types/ConversationColumnDefinition.d.ts}

@@ -2,9 +2,7 @@
  * 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;
+export interface ConversationColumnDefinition extends MavenAGI.ColumnDefinitionBase {
     /** The metric calculated for this column, stored in the row data under the specified header. */
-    metric: MavenAGI.Metric;
+    metric: MavenAGI.ConversationMetric;
 }

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/ConversationDateHistogramRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationDateHistogramRequest 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/{dist/api/resources/analytics/types/DistinctCount.d.ts → api/resources/analytics/types/ConversationDistinctCount.d.ts}

@@ -3,8 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 /**
- * Estimates the number of unique values in the specified field.
+ * Calculates the number of unique values in the specified field.
  * Supports fields with list values as well.
  */
-export interface DistinctCount extends MavenAGI.BasicMetric {
+export interface ConversationDistinctCount extends MavenAGI.ConversationBasicMetric {
 }

package/api/resources/analytics/types/{GroupBy.d.ts → ConversationGroupBy.d.ts}

@@ -2,11 +2,9 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface GroupBy {
+export interface ConversationGroupBy extends MavenAGI.GroupByBase {
     /** 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/Max.d.ts → api/resources/analytics/types/ConversationMax.d.ts}

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 /**
  * Retrieves the maximum value of the specified field.
  */
-export interface Max extends MavenAGI.BasicMetric {
+export interface ConversationMax extends MavenAGI.ConversationNumericMetric {
 }

package/{dist/api/resources/analytics/types/Median.d.ts → api/resources/analytics/types/ConversationMedian.d.ts}

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 /**
  * Computes the median value of the specified field.
  */
-export interface Median extends MavenAGI.BasicMetric {
+export interface ConversationMedian extends MavenAGI.ConversationNumericMetric {
 }

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 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/{dist/api/resources/analytics/types/Min.d.ts → api/resources/analytics/types/ConversationMin.d.ts}

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 /**
  * Retrieves the minimum value of the specified field.
  */
-export interface Min extends MavenAGI.BasicMetric {
+export interface ConversationMin extends MavenAGI.ConversationNumericMetric {
 }

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/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/ConversationPieChartRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationPieChartRequest extends MavenAGI.ConversationAnalyticsRequest {
+    /** Field used to group data into slices for the pie chart. */
+    groupBy: MavenAGI.ConversationGroupBy;
+    /** Metric defining the value for each pie slice, stored in the y-axis value. */
+    metric: MavenAGI.ConversationMetric;
+}

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

@@ -2,12 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface ConversationRow {
+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>;
-    /** 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/{Sum.d.ts → ConversationSum.d.ts}

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 /**
  * Computes the sum of all values in the specified field.
  */
-export interface Sum extends MavenAGI.BasicMetric {
+export interface ConversationSum extends MavenAGI.ConversationNumericMetric {
 }

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

@@ -21,30 +21,28 @@ import * as MavenAGI from "../../../index";
  *                 header: "avg_first_response_time",
  *                 metric: {
  *                     type: "average",
- *                     targetField: MavenAGI.ConversationField.FirstResponseTime
+ *                     targetField: MavenAGI.NumericConversationField.FirstResponseTime
  *                 }
  *             }, {
  *                 header: "percentile_handle_time",
  *                 metric: {
  *                     type: "percentile",
- *                     targetField: MavenAGI.ConversationField.HandleTime,
- *                     percentiles: [25, 75]
+ *                     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.
-     */
+    /** 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.
+     * If empty, all data is aggregated into a single row. |
+     * Note: The field `CreatedAt` should not be used here, all time-based grouping should be done using the `timeGrouping` field.
      */
-    fieldGroupings: MavenAGI.GroupBy[];
+    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.ColumnDefinition[];
+    columnDefinitions: MavenAGI.ConversationColumnDefinition[];
 }

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

@@ -27,11 +27,8 @@ import * as MavenAGI from "../../../index";
  *                         value: 150
  *                     },
  *                     "percentile_handle_time": {
- *                         type: "percentileMap",
- *                         value: {
- *                             "25": 100,
- *                             "75": 250
- *                         }
+ *                         type: "millisecond",
+ *                         value: 110
  *                     }
  *                 }
  *             }, {
@@ -55,11 +52,8 @@ import * as MavenAGI from "../../../index";
  *                         value: 300
  *                     },
  *                     "percentile_handle_time": {
- *                         type: "percentileMap",
- *                         value: {
- *                             "25": 200,
- *                             "75": 400
- *                         }
+ *                         type: "millisecond",
+ *                         value: 250
  *                     }
  *                 }
  *             }, {
@@ -79,11 +73,8 @@ import * as MavenAGI from "../../../index";
  *                         value: 180
  *                     },
  *                     "percentile_handle_time": {
- *                         type: "percentileMap",
- *                         value: {
- *                             "25": 130,
- *                             "75": 280
- *                         }
+ *                         type: "millisecond",
+ *                         value: 180
  *                     }
  *                 }
  *             }, {
@@ -107,19 +98,14 @@ import * as MavenAGI from "../../../index";
  *                         value: 320
  *                     },
  *                     "percentile_handle_time": {
- *                         type: "percentileMap",
- *                         value: {
- *                             "25": 220,
- *                             "75": 420
- *                         }
+ *                         type: "millisecond",
+ *                         value: 220
  *                     }
  *                 }
  *             }]
  *     }
  */
-export interface ConversationTableResponse {
-    /** Column headers in the table, aligning with the column definitions specified in the request. */
-    headers: string[];
+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.

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/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/{ColumnDefinition.d.ts → FeedbackColumnDefinition.d.ts}

@@ -2,9 +2,7 @@
  * 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;
+export interface FeedbackColumnDefinition extends MavenAGI.ColumnDefinitionBase {
     /** The metric calculated for this column, stored in the row data under the specified header. */
-    metric: MavenAGI.Metric;
+    metric: MavenAGI.FeedbackMetric;
 }

package/api/resources/analytics/types/{Count.d.ts → FeedbackCount.d.ts}

@@ -4,5 +4,5 @@
 /**
  * Returns the total count of records in a group.
  */
-export interface Count {
+export interface FeedbackCount {
 }

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/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/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 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/FeedbackRow.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackRow 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.FeedbackField, MavenAGI.FieldValue | undefined>;
+}

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

@@ -0,0 +1,41 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         feedbackFilter: {
+ *             types: [MavenAGI.FeedbackType.ThumbsUp, MavenAGI.FeedbackType.Insert]
+ *         },
+ *         fieldGroupings: [{
+ *                 field: MavenAGI.FeedbackField.CreatedBy
+ *             }],
+ *         columnDefinitions: [{
+ *                 header: "feedback_count",
+ *                 metric: {
+ *                     type: "count"
+ *                 }
+ *             }]
+ *     }
+ */
+export interface FeedbackTableRequest extends MavenAGI.FeedbackAnalyticsRequest {
+    /**
+     * 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.
+     * Note: The field CreatedAt should not be used here, all the time-based grouping should be done using the timeGrouping field.
+     */
+    fieldGroupings: MavenAGI.FeedbackGroupBy[];
+    /**
+     * 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.FeedbackColumnDefinition[];
+}