mavenagi 1.1.0 → 1.2.3

package/api/resources/analytics/client/Client.d.ts

@@ -165,5 +165,30 @@ export declare class Analytics {
      */
     getFeedbackTable(request: MavenAGI.FeedbackTableRequest, requestOptions?: Analytics.RequestOptions): core.HttpResponsePromise<MavenAGI.FeedbackTableResponse>;
     private __getFeedbackTable;
+    /**
+     * Retrieves structured agent user data formatted as a table, allowing users to group, filter,  and define specific metrics to display as columns.
+     *
+     * @param {MavenAGI.AgentUserTableRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.analytics.getAgentUserTable({
+     *         agentUserFilter: {
+     *             search: "john"
+     *         },
+     *         columnDefinitions: [{
+     *                 header: "user_count",
+     *                 metric: {
+     *                     type: "count"
+     *                 }
+     *             }]
+     *     })
+     */
+    getAgentUserTable(request: MavenAGI.AgentUserTableRequest, requestOptions?: Analytics.RequestOptions): core.HttpResponsePromise<MavenAGI.AgentUserTableResponse>;
+    private __getAgentUserTable;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/api/resources/analytics/client/Client.js

@@ -418,6 +418,109 @@ class Analytics {
             }
         });
     }
+    /**
+     * Retrieves structured agent user data formatted as a table, allowing users to group, filter,  and define specific metrics to display as columns.
+     *
+     * @param {MavenAGI.AgentUserTableRequest} request
+     * @param {Analytics.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.analytics.getAgentUserTable({
+     *         agentUserFilter: {
+     *             search: "john"
+     *         },
+     *         columnDefinitions: [{
+     *                 header: "user_count",
+     *                 metric: {
+     *                     type: "count"
+     *                 }
+     *             }]
+     *     })
+     */
+    getAgentUserTable(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getAgentUserTable(request, requestOptions));
+    }
+    __getAgentUserTable(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/tables/agent-users"),
+                method: "POST",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.AgentUserTableRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.AgentUserTableResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/tables/agent-users.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getAuthorizationHeader() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AgentUserAnalyticsRequest {
+    /** Optional filter applied to refine the agent user data before processing. */
+    agentUserFilter?: MavenAGI.AgentUserFilter;
+    /**
+     * IANA timezone identifier (e.g., "America/Los_Angeles").
+     * When provided, time-based groupings (e.g., DAY) and date filters are evaluated in this timezone;
+     * otherwise UTC is used.
+     */
+    timezone?: string;
+}

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

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * 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 AgentUserMetric = MavenAGI.AgentUserMetric.Count;
+export declare namespace AgentUserMetric {
+    interface Count extends MavenAGI.AgentUserCount {
+        type: "count";
+    }
+}

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

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

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

@@ -0,0 +1,30 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         agentUserFilter: {
+ *             search: "john"
+ *         },
+ *         columnDefinitions: [{
+ *                 header: "user_count",
+ *                 metric: {
+ *                     type: "count"
+ *                 }
+ *             }]
+ *     }
+ */
+export interface AgentUserTableRequest extends MavenAGI.AgentUserAnalyticsRequest {
+    /**
+     * 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 metrics to be displayed as columns.
+     * Only the `count` metric is supported for agent user tables, so each table will have a single column definition using `count`.
+     */
+    columnDefinitions: MavenAGI.AgentUserColumnDefinition[];
+}

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

@@ -0,0 +1,28 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         headers: ["user_count"],
+ *         rows: [{
+ *                 identifier: {
+ *                     [MavenAGI.AgentUserField.CreatedAt]: {
+ *                         type: "dateTime",
+ *                         value: new Date("2023-10-01T00:00:00.000Z")
+ *                     }
+ *                 },
+ *                 data: {
+ *                     "user_count": {
+ *                         type: "double",
+ *                         value: 5
+ *                     }
+ *                 }
+ *             }]
+ *     }
+ */
+export interface AgentUserTableResponse extends MavenAGI.TableResponseBase {
+    /** Each row contains the user count for the given search query and corresponding time grouping. */
+    rows: MavenAGI.AgentUserRow[];
+}

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

@@ -5,4 +5,10 @@ import * as MavenAGI from "../../../index";
 export interface ConversationAnalyticsRequest {
     /** Optional filter applied to refine the conversation data before processing. */
     conversationFilter?: MavenAGI.ConversationFilter;
+    /**
+     * IANA timezone identifier (e.g., "America/Los_Angeles").
+     * When provided, time-based groupings (e.g., DAY) and date filters are evaluated in this timezone;
+     * otherwise UTC is used.
+     */
+    timezone?: string;
 }

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

@@ -5,4 +5,10 @@ import * as MavenAGI from "../../../index";
 export interface FeedbackAnalyticsRequest {
     /** Optional filter applied to refine the feedback data before processing. */
     feedbackFilter?: MavenAGI.FeedbackFilter;
+    /**
+     * IANA timezone identifier (e.g., "America/Los_Angeles").
+     * When provided, time-based groupings (e.g., DAY) and date filters are evaluated in this timezone;
+     * otherwise UTC is used.
+     */
+    timezone?: string;
 }

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

@@ -27,7 +27,7 @@ export declare namespace FieldValue {
         type: "boolean";
         value: boolean;
     }
-    interface EntityId extends MavenAGI.EntityIdFilter {
+    interface EntityId extends MavenAGI.EntityResult {
         type: "entityId";
     }
 }

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

@@ -5,6 +5,9 @@ export * from "./ConversationTableResponse";
 export * from "./FeedbackAnalyticsRequest";
 export * from "./FeedbackTableRequest";
 export * from "./FeedbackTableResponse";
+export * from "./AgentUserAnalyticsRequest";
+export * from "./AgentUserTableRequest";
+export * from "./AgentUserTableResponse";
 export * from "./ColumnDefinitionBase";
 export * from "./ConversationColumnDefinition";
 export * from "./FeedbackColumnDefinition";
@@ -26,6 +29,10 @@ export * from "./ConversationPercentile";
 export * from "./FeedbackMetric";
 export * from "./FeedbackCount";
 export * from "./FeedbackDistinctCount";
+export * from "./AgentUserColumnDefinition";
+export * from "./AgentUserRow";
+export * from "./AgentUserMetric";
+export * from "./AgentUserCount";
 export * from "./GroupByBase";
 export * from "./ConversationGroupBy";
 export * from "./FeedbackGroupBy";

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

@@ -21,6 +21,9 @@ __exportStar(require("./ConversationTableResponse"), exports);
 __exportStar(require("./FeedbackAnalyticsRequest"), exports);
 __exportStar(require("./FeedbackTableRequest"), exports);
 __exportStar(require("./FeedbackTableResponse"), exports);
+__exportStar(require("./AgentUserAnalyticsRequest"), exports);
+__exportStar(require("./AgentUserTableRequest"), exports);
+__exportStar(require("./AgentUserTableResponse"), exports);
 __exportStar(require("./ColumnDefinitionBase"), exports);
 __exportStar(require("./ConversationColumnDefinition"), exports);
 __exportStar(require("./FeedbackColumnDefinition"), exports);
@@ -42,6 +45,10 @@ __exportStar(require("./ConversationPercentile"), exports);
 __exportStar(require("./FeedbackMetric"), exports);
 __exportStar(require("./FeedbackCount"), exports);
 __exportStar(require("./FeedbackDistinctCount"), exports);
+__exportStar(require("./AgentUserColumnDefinition"), exports);
+__exportStar(require("./AgentUserRow"), exports);
+__exportStar(require("./AgentUserMetric"), exports);
+__exportStar(require("./AgentUserCount"), exports);
 __exportStar(require("./GroupByBase"), exports);
 __exportStar(require("./ConversationGroupBy"), exports);
 __exportStar(require("./FeedbackGroupBy"), exports);

package/api/resources/assets/client/Client.d.ts

@@ -0,0 +1,76 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Assets {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
+        organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
+        agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Assets {
+    protected readonly _options: Assets.Options;
+    constructor(_options: Assets.Options);
+    /**
+     * Initiate an upload.
+     * Returns a pre-signed URL for direct file upload and an asset ID for subsequent operations.
+     *
+     * @param {MavenAGI.InitiateAssetUploadRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.assets.initiateUpload({
+     *         type: "type"
+     *     })
+     */
+    initiateUpload(request: MavenAGI.InitiateAssetUploadRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<MavenAGI.InitiateAssetUploadResponse>;
+    private __initiateUpload;
+    /**
+     * Commit an upload after successful file transfer.
+     * Updates the asset status and makes it available for use.
+     *
+     * @param {string} assetReferenceId - The reference ID of the asset to commit (provided by the initiate call). All other entity ID fields are inferred from the API request.
+     * @param {MavenAGI.CommitAssetUploadRequest} request
+     * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.assets.commitUpload("assetReferenceId", {})
+     */
+    commitUpload(assetReferenceId: string, request: MavenAGI.CommitAssetUploadRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
+    private __commitUpload;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}