mavenagi 1.2.0 → 1.2.3

package/dist/api/resources/agents/types/AgentPatchRequest.d.ts

@@ -7,6 +7,8 @@ export interface AgentPatchRequest {
     name?: string;
     /** The environment of the agent. */
     environment?: MavenAGI.AgentEnvironment;
+    /** The agent's default timezone. This is used when a timezone is not set on a conversation. */
+    defaultTimezone?: string;
     /** The PII categories that are enabled for the agent. */
     enabledPiiCategories?: Set<MavenAGI.PiiCategory>;
 }

package/dist/api/resources/agents/types/PiiCategory.d.ts

@@ -1,7 +1,7 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type PiiCategory = "Name" | "Email" | "PhoneNumber" | "StreetAddress" | "CreditCardNumber" | "UsBankAccountNumber" | "UsSocialSecurityNumber" | "UsUkPassportNumber" | "UsDriversLicenseNumber" | "Date" | "IpAddress" | "Url" | "AbaRoutingNumber" | "Age" | "SwiftCode" | "AuBankAccountNumber" | "AuBusinessNumber" | "AuCompanyNumber" | "AuDriversLicenseNumber" | "AuMedicalAccountNumber" | "AuPassportNumber" | "AuTaxFileNumber" | "CaBankAccountNumber" | "CaDriversLicenseNumber" | "CaHealthServiceNumber" | "CaPassportNumber" | "CaPersonalHealthIdentification" | "CaSocialInsuranceNumber" | "EsDni" | "EsSocialSecurityNumber" | "EsTaxIdentificationNumber" | "EuDebitCardNumber" | "EuDriversLicenseNumber" | "EuGpsCoordinates" | "EuNationalIdentificationNumber" | "EuPassportNumber" | "EuSocialSecurityNumber" | "EuTaxIdentificationNumber" | "FrDriversLicenseNumber" | "FrHealthInsuranceNumber" | "FrNationalId" | "FrPassportNumber" | "FrSocialSecurityNumber" | "FrTaxIdentificationNumber" | "FrValueAddedTaxNumber" | "InternationalBankingAccountNumber" | "NzBankAccountNumber" | "NzDriversLicenseNumber" | "NzInlandRevenueNumber" | "NzMinistryOfHealthNumber" | "NzSocialWelfareNumber" | "UkDriversLicenseNumber" | "UkElectoralRollNumber" | "UkNationalHealthNumber" | "UkNationalInsuranceNumber" | "UkUniqueTaxpayerNumber" | "UsIndividualTaxpayerIdentification";
+export type PiiCategory = "Name" | "Email" | "PhoneNumber" | "StreetAddress" | "CreditCardNumber" | "UsBankAccountNumber" | "UsSocialSecurityNumber" | "UsUkPassportNumber" | "UsDriversLicenseNumber" | "UsIndividualTaxpayerIdentification" | "Date" | "IpAddress" | "Url" | "AbaRoutingNumber" | "Age" | "SwiftCode" | "AuBankAccountNumber" | "AuBusinessNumber" | "AuCompanyNumber" | "AuDriversLicenseNumber" | "AuMedicalAccountNumber" | "AuPassportNumber" | "AuTaxFileNumber" | "CaBankAccountNumber" | "CaDriversLicenseNumber" | "CaHealthServiceNumber" | "CaPassportNumber" | "CaPersonalHealthIdentification" | "CaSocialInsuranceNumber" | "EsDni" | "EsSocialSecurityNumber" | "EsTaxIdentificationNumber" | "EuDebitCardNumber" | "EuDriversLicenseNumber" | "EuGpsCoordinates" | "EuNationalIdentificationNumber" | "EuPassportNumber" | "EuSocialSecurityNumber" | "EuTaxIdentificationNumber" | "FrDriversLicenseNumber" | "FrHealthInsuranceNumber" | "FrNationalId" | "FrPassportNumber" | "FrSocialSecurityNumber" | "FrTaxIdentificationNumber" | "FrValueAddedTaxNumber" | "InternationalBankingAccountNumber" | "NzBankAccountNumber" | "NzDriversLicenseNumber" | "NzInlandRevenueNumber" | "NzMinistryOfHealthNumber" | "NzSocialWelfareNumber" | "UkDriversLicenseNumber" | "UkElectoralRollNumber" | "UkNationalHealthNumber" | "UkNationalInsuranceNumber" | "UkUniqueTaxpayerNumber";
 export declare const PiiCategory: {
     readonly Name: "Name";
     readonly Email: "Email";
@@ -12,6 +12,7 @@ export declare const PiiCategory: {
     readonly UsSocialSecurityNumber: "UsSocialSecurityNumber";
     readonly UsUkPassportNumber: "UsUkPassportNumber";
     readonly UsDriversLicenseNumber: "UsDriversLicenseNumber";
+    readonly UsIndividualTaxpayerIdentification: "UsIndividualTaxpayerIdentification";
     readonly Date: "Date";
     readonly IpAddress: "IpAddress";
     readonly Url: "Url";
@@ -59,5 +60,4 @@ export declare const PiiCategory: {
     readonly UkNationalHealthNumber: "UkNationalHealthNumber";
     readonly UkNationalInsuranceNumber: "UkNationalInsuranceNumber";
     readonly UkUniqueTaxpayerNumber: "UkUniqueTaxpayerNumber";
-    readonly UsIndividualTaxpayerIdentification: "UsIndividualTaxpayerIdentification";
 };

package/dist/api/resources/agents/types/PiiCategory.js

@@ -14,6 +14,7 @@ exports.PiiCategory = {
     UsSocialSecurityNumber: "UsSocialSecurityNumber",
     UsUkPassportNumber: "UsUkPassportNumber",
     UsDriversLicenseNumber: "UsDriversLicenseNumber",
+    UsIndividualTaxpayerIdentification: "UsIndividualTaxpayerIdentification",
     Date: "Date",
     IpAddress: "IpAddress",
     Url: "Url",
@@ -61,5 +62,4 @@ exports.PiiCategory = {
     UkNationalHealthNumber: "UkNationalHealthNumber",
     UkNationalInsuranceNumber: "UkNationalInsuranceNumber",
     UkUniqueTaxpayerNumber: "UkUniqueTaxpayerNumber",
-    UsIndividualTaxpayerIdentification: "UsIndividualTaxpayerIdentification",
 };

package/dist/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/dist/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/dist/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/dist/api/resources/analytics/types/AgentUserAnalyticsRequest.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/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/dist/api/resources/analytics/types/AgentUserColumnDefinition.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/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/dist/api/resources/analytics/types/AgentUserCount.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/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/dist/api/resources/analytics/types/AgentUserMetric.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/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/dist/api/resources/analytics/types/AgentUserRow.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/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/dist/api/resources/analytics/types/AgentUserTableRequest.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/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/dist/api/resources/analytics/types/AgentUserTableResponse.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/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/dist/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/dist/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/dist/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/dist/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/dist/api/resources/commons/types/ActionExecutionParamValue.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export type ActionExecutionParamValue = MavenAGI.ActionExecutionParamValue.Primitive | MavenAGI.ActionExecutionParamValue.Attachment;
+export declare namespace ActionExecutionParamValue {
+    interface Primitive {
+        valueType: "primitive";
+        value?: unknown;
+    }
+    interface Attachment extends MavenAGI.AttachmentResponse {
+        valueType: "attachment";
+    }
+}

package/dist/api/resources/commons/types/ActionExecutionParamValue.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/commons/types/ActionOAuthConfiguration.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ActionOAuthConfiguration {
+    authorizationUrl: string;
+    tokenUrl: string;
+    clientId: string;
+    clientSecret: string;
+    scopes: string[];
+    extraAuthParams?: Record<string, string>;
+    extraTokenParams?: Record<string, string>;
+}

package/dist/api/resources/commons/types/ActionOAuthConfiguration.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/commons/types/ActionParameter.d.ts

@@ -11,10 +11,29 @@ export interface ActionParameter {
     description: string;
     /** Whether the field is required for action execution. */
     required: boolean;
+    /** When user interaction is required, whether this parameter should be excluded from forms. Hidden parameters are not displayed to users but their values are still populated by the LLM and sent to actions. Defaults to false. */
+    hidden?: boolean;
     /** The parameter type. Values provided to `executeAction` will conform to this type. Defaults to `STRING`. */
     type?: MavenAGI.ActionParameterType;
     /** Restricts the action parameter to only the options in this list. Valid for type `STRING`, `BOOLEAN`, and `NUMBER`. Should not be used when type is `SCHEMA`. */
     enumOptions?: MavenAGI.ActionEnumOption[];
-    /** JSON schema for validating the parameter value. Only valid when type is `SCHEMA`. */
+    /**
+     * JSON schema for validating the parameter value. Only valid when type is `SCHEMA`.
+     *
+     * **Schema Requirements:**
+     * - Root type must be "object" - The top-level schema must define an object type
+     * - Supported types: string, number, boolean, integer, object, array, enum, anyOf
+     * - Unsupported features: oneOf, allOf, const, not, if/then/else, pattern, maxLength, minLength
+     * - Required fields: All fields must be required (no optional properties)
+     * - Additional properties: Must be set to false
+     *
+     * **Limits:**
+     * - Maximum nesting depth: 5 levels
+     * - Maximum total properties: 100
+     * - Maximum total string length: 15,000 characters
+     * - Maximum total enum values: 500
+     */
     schema?: string;
+    /** OAuth configuration required to start an OAuth authorization flow when this parameter's type is `OAUTH`. */
+    oauthConfiguration?: MavenAGI.ActionOAuthConfiguration;
 }

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

@@ -13,10 +13,18 @@ export type ActionParameterType =
  | "NUMBER"
 /**
  * Schema parameter type for complex structured data that adheres to a JSON schema definition. When this type is used this should be the only action parameter (all other parameters should be omitted), the `schema` field must be set and `enumOptions` should not be used. */
- | "SCHEMA";
+ | "SCHEMA"
+/**
+ * File parameter type for file uploads. */
+ | "FILE"
+/**
+ * OAuth authorization parameter type used to pass an access token at execution time. When this type is used it should be the only action parameter. This parameter is not sent to the LLM or shown on forms. */
+ | "OAUTH";
 export declare const ActionParameterType: {
     readonly String: "STRING";
     readonly Boolean: "BOOLEAN";
     readonly Number: "NUMBER";
     readonly Schema: "SCHEMA";
+    readonly File: "FILE";
+    readonly Oauth: "OAUTH";
 };

package/dist/api/resources/commons/types/ActionParameterType.js

@@ -9,4 +9,6 @@ exports.ActionParameterType = {
     Boolean: "BOOLEAN",
     Number: "NUMBER",
     Schema: "SCHEMA",
+    File: "FILE",
+    Oauth: "OAUTH",
 };

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

@@ -3,7 +3,7 @@
  */
 import * as MavenAGI from "../../../index";
 export interface BotLogicActionExecutedDetail extends MavenAGI.BotLogicActionReviewedDetail {
-    actionParameters: Record<string, unknown>;
+    actionParameters: Record<string, MavenAGI.ActionExecutionParamValue>;
     executionResult?: string;
     executionError?: string;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * This response should be rendered as a single button that starts an OAuth authorization flow.
+ */
+export interface BotOAuthButtonResponse {
+    /** Text that should be displayed to the user on the button. */
+    buttonName: string;
+    /** The OAuth authorization URL to open when the button is clicked. */
+    url: string;
+}

package/dist/api/resources/commons/types/BotOAuthButtonResponse.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/commons/types/BotResponse.d.ts

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export type BotResponse = MavenAGI.BotResponse.Text | MavenAGI.BotResponse.ActionForm | MavenAGI.BotResponse.Chart | MavenAGI.BotResponse.Object_;
+export type BotResponse = MavenAGI.BotResponse.Text | MavenAGI.BotResponse.ActionForm | MavenAGI.BotResponse.OauthButton | MavenAGI.BotResponse.Chart | MavenAGI.BotResponse.Object_;
 export declare namespace BotResponse {
     interface Text extends MavenAGI.BotTextResponse {
         type: "text";
@@ -10,6 +10,9 @@ export declare namespace BotResponse {
     interface ActionForm extends MavenAGI.BotActionFormResponse {
         type: "actionForm";
     }
+    interface OauthButton extends MavenAGI.BotOAuthButtonResponse {
+        type: "oauthButton";
+    }
     interface Chart extends MavenAGI.BotChartResponse {
         type: "chart";
     }

package/dist/api/resources/commons/types/BrowserInfo.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/commons/types/Capability.d.ts

@@ -1,11 +1,12 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export type Capability = "MARKDOWN" | "FORMS" | "IMAGES" | "CHARTS_HIGHCHARTS_TS" | "ASYNC";
+export type Capability = "MARKDOWN" | "FORMS" | "IMAGES" | "CHARTS_HIGHCHARTS_TS" | "ASYNC" | "OAUTH_BUTTONS";
 export declare const Capability: {
     readonly Markdown: "MARKDOWN";
     readonly Forms: "FORMS";
     readonly Images: "IMAGES";
     readonly ChartsHighchartsTs: "CHARTS_HIGHCHARTS_TS";
     readonly Async: "ASYNC";
+    readonly OauthButtons: "OAUTH_BUTTONS";
 };

package/dist/api/resources/commons/types/Capability.js

@@ -10,4 +10,5 @@ exports.Capability = {
     Images: "IMAGES",
     ChartsHighchartsTs: "CHARTS_HIGHCHARTS_TS",
     Async: "ASYNC",
+    OauthButtons: "OAUTH_BUTTONS",
 };

package/dist/api/resources/commons/types/ContextInfo.js

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