mavenagi 1.0.6 → 1.0.7

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 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/{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/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,27 @@ 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.
      */
-    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/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/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 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/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,40 @@
+/**
+ * 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.
+     */
+    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[];
+}

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

@@ -0,0 +1,45 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         headers: ["feedback_count", "unique_users"],
+ *         rows: [{
+ *                 identifier: {
+ *                     [MavenAGI.FeedbackField.CreatedBy]: {
+ *                         type: "string",
+ *                         value: "John Doe"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "feedback_count": {
+ *                         type: "double",
+ *                         value: 5
+ *                     }
+ *                 }
+ *             }, {
+ *                 identifier: {
+ *                     [MavenAGI.FeedbackField.CreatedBy]: {
+ *                         type: "string",
+ *                         value: "Jane Smith"
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "feedback_count": {
+ *                         type: "double",
+ *                         value: 3
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface FeedbackTableResponse 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.FeedbackRow[];
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GroupByBase {
+    /** Limits the number of groups returned (defaults to 100 if omitted). */
+    limit?: number;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface LabeledPoint {
+    /** Label for the data point corresponding to the y-value. */
+    label: string;
+    /** Value of the data point. */
+    y: number;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface PieChartRequest 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/PieChartRequest.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/PieChartResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface PieChartResponse {
+    /**
+     * The dataset for the pie chart.
+     * Each slice in the pie chart is represented as a data point with a name and a corresponding y-value.
+     */
+    series: MavenAGI.Series;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface RowBase {
+    /** 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/RowBase.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/Series.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface Series {
+    /**
+     * The name of the series, derived from the grouping field.
+     * If the metric is a percentile, the name represents the percentile value.
+     */
+    name: string;
+    /** List of labeled data points for the series. */
+    data: MavenAGI.LabeledPoint[];
+}

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TableResponseBase {
+    /** Column headers in the table, aligning with the column definitions specified in the request. */
+    headers: string[];
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TimeDataPoint {
+    /** X-axis value representing time in epoch milliseconds. */
+    x: number;
+    /** Y-axis value representing the measured data. */
+    y: number;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface TimeSeries {
+    /** Name of the series, derived from the grouping field or percentile metric. */
+    name: string;
+    /** List of time-based data points for the series. */
+    data: MavenAGI.TimeDataPoint[];
+}

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

@@ -1,16 +1,46 @@
+export * from "./TableResponseBase";
 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 "./FeedbackAnalyticsRequest";
+export * from "./FeedbackTableRequest";
+export * from "./FeedbackTableResponse";
+export * from "./ColumnDefinitionBase";
+export * from "./ConversationColumnDefinition";
+export * from "./FeedbackColumnDefinition";
+export * from "./ConversationChartRequest";
+export * from "./PieChartRequest";
+export * from "./DateHistogramRequest";
+export * from "./BarChartRequest";
+export * from "./ConversationMetric";
+export * from "./ConversationCount";
+export * from "./ConversationNumericMetric";
+export * from "./ConversationBasicMetric";
+export * from "./ConversationSum";
+export * from "./ConversationAverage";
+export * from "./ConversationMin";
+export * from "./ConversationMax";
+export * from "./ConversationMedian";
+export * from "./ConversationDistinctCount";
+export * from "./ConversationPercentile";
+export * from "./FeedbackMetric";
+export * from "./FeedbackCount";
+export * from "./FeedbackDistinctCount";
+export * from "./GroupByBase";
+export * from "./ConversationGroupBy";
+export * from "./FeedbackGroupBy";
+export * from "./RowBase";
 export * from "./ConversationRow";
+export * from "./FeedbackRow";
+export * from "./FieldValue";
+export * from "./Series";
+export * from "./LabeledPoint";
+export * from "./TimeSeries";
+export * from "./TimeDataPoint";
+export * from "./ChartResponse";
+export * from "./PieChartResponse";
+export * from "./DateHistogramResponse";
+export * from "./BarChartResponse";
+export * from "./TimeInterval";
+export * from "./Range";
+export * from "./CellData";