mavenagi 1.0.6 → 1.0.7

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

package/dist/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/dist/api/resources/analytics/types/FeedbackRow.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/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/dist/api/resources/analytics/types/FeedbackTableRequest.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/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/dist/api/resources/analytics/types/FeedbackTableResponse.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/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/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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/dist/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";

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

@@ -14,19 +14,49 @@ 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("./TableResponseBase"), exports);
 __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("./FeedbackAnalyticsRequest"), exports);
+__exportStar(require("./FeedbackTableRequest"), exports);
+__exportStar(require("./FeedbackTableResponse"), exports);
+__exportStar(require("./ColumnDefinitionBase"), exports);
+__exportStar(require("./ConversationColumnDefinition"), exports);
+__exportStar(require("./FeedbackColumnDefinition"), exports);
+__exportStar(require("./ConversationChartRequest"), exports);
+__exportStar(require("./PieChartRequest"), exports);
+__exportStar(require("./DateHistogramRequest"), exports);
+__exportStar(require("./BarChartRequest"), exports);
+__exportStar(require("./ConversationMetric"), exports);
+__exportStar(require("./ConversationCount"), exports);
+__exportStar(require("./ConversationNumericMetric"), exports);
+__exportStar(require("./ConversationBasicMetric"), exports);
+__exportStar(require("./ConversationSum"), exports);
+__exportStar(require("./ConversationAverage"), exports);
+__exportStar(require("./ConversationMin"), exports);
+__exportStar(require("./ConversationMax"), exports);
+__exportStar(require("./ConversationMedian"), exports);
+__exportStar(require("./ConversationDistinctCount"), exports);
+__exportStar(require("./ConversationPercentile"), exports);
+__exportStar(require("./FeedbackMetric"), exports);
+__exportStar(require("./FeedbackCount"), exports);
+__exportStar(require("./FeedbackDistinctCount"), exports);
+__exportStar(require("./GroupByBase"), exports);
+__exportStar(require("./ConversationGroupBy"), exports);
+__exportStar(require("./FeedbackGroupBy"), exports);
+__exportStar(require("./RowBase"), exports);
 __exportStar(require("./ConversationRow"), exports);
+__exportStar(require("./FeedbackRow"), exports);
+__exportStar(require("./FieldValue"), exports);
+__exportStar(require("./Series"), exports);
+__exportStar(require("./LabeledPoint"), exports);
+__exportStar(require("./TimeSeries"), exports);
+__exportStar(require("./TimeDataPoint"), exports);
+__exportStar(require("./ChartResponse"), exports);
+__exportStar(require("./PieChartResponse"), exports);
+__exportStar(require("./DateHistogramResponse"), exports);
+__exportStar(require("./BarChartResponse"), exports);
+__exportStar(require("./TimeInterval"), exports);
+__exportStar(require("./Range"), exports);
+__exportStar(require("./CellData"), exports);

package/dist/api/resources/appSettings/client/Client.js

@@ -67,7 +67,7 @@ class AppSettings {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "v1/app-settings"),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.6", "User-Agent": "mavenagi/1.0.6", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.7", "User-Agent": "mavenagi/1.0.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/commons/types/EventTriggerBase.d.ts

@@ -5,6 +5,13 @@ import * as MavenAGI from "../../../index";
 export interface EventTriggerBase {
     /** The description of what the event trigger does, shown in the Maven Dashboard */
     description: string;
-    /** The type of event trigger this app wishes to handle */
+    /**
+     * The type of event trigger this app wishes to handle.
+     *
+     * Conversation triggers fire when a conversation is created, after each additional message, and upon deletion events.
+     * There is a small delay before trigger execution to allow time for conversation analysis to complete.
+     *
+     * Feedback can not be modified, so the feedback trigger fires immediately after feedback is created.
+     */
     type: MavenAGI.EventTriggerType;
 }

package/dist/api/resources/conversation/client/Client.d.ts

@@ -49,10 +49,20 @@ export declare class Conversation {
      *             referenceId: "referenceId"
      *         },
      *         messages: [{
+     *                 userId: {
+     *                     referenceId: "referenceId"
+     *                 },
+     *                 text: "text",
+     *                 userMessageType: "USER",
      *                 conversationMessageId: {
      *                     referenceId: "referenceId"
      *                 }
      *             }, {
+     *                 userId: {
+     *                     referenceId: "referenceId"
+     *                 },
+     *                 text: "text",
+     *                 userMessageType: "USER",
      *                 conversationMessageId: {
      *                     referenceId: "referenceId"
      *                 }
@@ -111,10 +121,20 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.appendNewMessages("conversationId", [{
+     *             userId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             text: "text",
+     *             userMessageType: "USER",
      *             conversationMessageId: {
      *                 referenceId: "referenceId"
      *             }
      *         }, {
+     *             userId: {
+     *                 referenceId: "referenceId"
+     *             },
+     *             text: "text",
+     *             userMessageType: "USER",
      *             conversationMessageId: {
      *                 referenceId: "referenceId"
      *             }