mavenagi 1.2.10 → 1.2.11

package/Client.d.ts

@@ -3,6 +3,7 @@ import { Agents } from "./api/resources/agents/client/Client";
 import { Analytics } from "./api/resources/analytics/client/Client";
 import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Assets } from "./api/resources/assets/client/Client";
+import { Auth } from "./api/resources/auth/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Customers } from "./api/resources/customers/client/Client";
 import { Events } from "./api/resources/events/client/Client";
@@ -13,6 +14,7 @@ import { Segments } from "./api/resources/segments/client/Client";
 import { Translations } from "./api/resources/translations/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
 import { Users } from "./api/resources/users/client/Client";
+import { Websockets } from "./api/resources/websockets/client/Client";
 import type { BaseClientOptions, BaseRequestOptions } from "./BaseClient";
 export declare namespace MavenAGIClient {
     interface Options extends BaseClientOptions {
@@ -27,6 +29,7 @@ export declare class MavenAGIClient {
     protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
     protected _assets: Assets | undefined;
+    protected _auth: Auth | undefined;
     protected _conversation: Conversation | undefined;
     protected _customers: Customers | undefined;
     protected _events: Events | undefined;
@@ -37,12 +40,14 @@ export declare class MavenAGIClient {
     protected _translations: Translations | undefined;
     protected _triggers: Triggers | undefined;
     protected _users: Users | undefined;
+    protected _websockets: Websockets | undefined;
     constructor(_options: MavenAGIClient.Options);
     get actions(): Actions;
     get agents(): Agents;
     get analytics(): Analytics;
     get appSettings(): AppSettings;
     get assets(): Assets;
+    get auth(): Auth;
     get conversation(): Conversation;
     get customers(): Customers;
     get events(): Events;
@@ -53,4 +58,5 @@ export declare class MavenAGIClient {
     get translations(): Translations;
     get triggers(): Triggers;
     get users(): Users;
+    get websockets(): Websockets;
 }

package/Client.js

@@ -40,16 +40,18 @@ const Client_2 = require("./api/resources/agents/client/Client");
 const Client_3 = require("./api/resources/analytics/client/Client");
 const Client_4 = require("./api/resources/appSettings/client/Client");
 const Client_5 = require("./api/resources/assets/client/Client");
-const Client_6 = require("./api/resources/conversation/client/Client");
-const Client_7 = require("./api/resources/customers/client/Client");
-const Client_8 = require("./api/resources/events/client/Client");
-const Client_9 = require("./api/resources/inbox/client/Client");
-const Client_10 = require("./api/resources/knowledge/client/Client");
-const Client_11 = require("./api/resources/organizations/client/Client");
-const Client_12 = require("./api/resources/segments/client/Client");
-const Client_13 = require("./api/resources/translations/client/Client");
-const Client_14 = require("./api/resources/triggers/client/Client");
-const Client_15 = require("./api/resources/users/client/Client");
+const Client_6 = require("./api/resources/auth/client/Client");
+const Client_7 = require("./api/resources/conversation/client/Client");
+const Client_8 = require("./api/resources/customers/client/Client");
+const Client_9 = require("./api/resources/events/client/Client");
+const Client_10 = require("./api/resources/inbox/client/Client");
+const Client_11 = require("./api/resources/knowledge/client/Client");
+const Client_12 = require("./api/resources/organizations/client/Client");
+const Client_13 = require("./api/resources/segments/client/Client");
+const Client_14 = require("./api/resources/translations/client/Client");
+const Client_15 = require("./api/resources/triggers/client/Client");
+const Client_16 = require("./api/resources/users/client/Client");
+const Client_17 = require("./api/resources/websockets/client/Client");
 const core = __importStar(require("./core"));
 const headers_1 = require("./core/headers");
 class MavenAGIClient {
@@ -59,8 +61,8 @@ class MavenAGIClient {
                 "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "mavenagi",
-                "X-Fern-SDK-Version": "1.2.10",
-                "User-Agent": "mavenagi/1.2.10",
+                "X-Fern-SDK-Version": "1.2.11",
+                "User-Agent": "mavenagi/1.2.11",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -85,45 +87,53 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._assets) !== null && _a !== void 0 ? _a : (this._assets = new Client_5.Assets(this._options)));
     }
+    get auth() {
+        var _a;
+        return ((_a = this._auth) !== null && _a !== void 0 ? _a : (this._auth = new Client_6.Auth(this._options)));
+    }
     get conversation() {
         var _a;
-        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_6.Conversation(this._options)));
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_7.Conversation(this._options)));
     }
     get customers() {
         var _a;
-        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_7.Customers(this._options)));
+        return ((_a = this._customers) !== null && _a !== void 0 ? _a : (this._customers = new Client_8.Customers(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_8.Events(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_9.Events(this._options)));
     }
     get inbox() {
         var _a;
-        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_9.Inbox(this._options)));
+        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_10.Inbox(this._options)));
     }
     get knowledge() {
         var _a;
-        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_10.Knowledge(this._options)));
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_11.Knowledge(this._options)));
     }
     get organizations() {
         var _a;
-        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_11.Organizations(this._options)));
+        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_12.Organizations(this._options)));
     }
     get segments() {
         var _a;
-        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_12.Segments(this._options)));
+        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_13.Segments(this._options)));
     }
     get translations() {
         var _a;
-        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_13.Translations(this._options)));
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_14.Translations(this._options)));
     }
     get triggers() {
         var _a;
-        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_14.Triggers(this._options)));
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_15.Triggers(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_15.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_16.Users(this._options)));
+    }
+    get websockets() {
+        var _a;
+        return ((_a = this._websockets) !== null && _a !== void 0 ? _a : (this._websockets = new Client_17.Websockets(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

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

@@ -0,0 +1,33 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Auth {
+    interface Options extends BaseClientOptions {
+    }
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class Auth {
+    protected readonly _options: Auth.Options;
+    constructor(_options: Auth.Options);
+    /**
+     * Creates a short-lived session token that can be used to authenticate
+     * WebSocket connections. Session tokens are useful for client-side applications where
+     * you don’t want to expose your API key.
+     *
+     * @param {MavenAGI.SessionTokenRequest} request
+     * @param {Auth.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.auth.sessionToken({
+     *         ttlSeconds: 3600
+     *     })
+     */
+    sessionToken(request: MavenAGI.SessionTokenRequest, requestOptions?: Auth.RequestOptions): core.HttpResponsePromise<MavenAGI.SessionTokenResponse>;
+    private __sessionToken;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}

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

@@ -0,0 +1,171 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auth = void 0;
+const core = __importStar(require("../../../../core"));
+const headers_1 = require("../../../../core/headers");
+const environments = __importStar(require("../../../../environments"));
+const errors = __importStar(require("../../../../errors/index"));
+const serializers = __importStar(require("../../../../serialization/index"));
+const MavenAGI = __importStar(require("../../../index"));
+class Auth {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Creates a short-lived session token that can be used to authenticate
+     * WebSocket connections. Session tokens are useful for client-side applications where
+     * you don’t want to expose your API key.
+     *
+     * @param {MavenAGI.SessionTokenRequest} request
+     * @param {Auth.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.auth.sessionToken({
+     *         ttlSeconds: 3600
+     *     })
+     */
+    sessionToken(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__sessionToken(request, requestOptions));
+    }
+    __sessionToken(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+            const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
+                "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
+                url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, "/v1/auth/session-token"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.SessionTokenRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
+                maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.SessionTokenResponse.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/auth/session-token.");
+                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;
+            const appId = (_a = (yield core.Supplier.get(this._options.appId))) !== null && _a !== void 0 ? _a : process === null || process === void 0 ? void 0 : process.env.MAVENAGI_APP_ID;
+            const appSecret = (_b = (yield core.Supplier.get(this._options.appSecret))) !== null && _b !== void 0 ? _b : process === null || process === void 0 ? void 0 : process.env.MAVENAGI_APP_SECRET;
+            if (appId != null && appSecret != null) {
+                return core.BasicAuth.toAuthorizationHeader({
+                    username: appId,
+                    password: appSecret,
+                });
+            }
+            return undefined;
+        });
+    }
+}
+exports.Auth = Auth;

package/api/resources/auth/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/api/resources/auth/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/api/resources/auth/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./client"), exports);
+__exportStar(require("./types"), exports);

package/api/resources/auth/types/SessionTokenRequest.d.ts

@@ -0,0 +1,3 @@
+export interface SessionTokenRequest {
+    ttlSeconds: number;
+}

package/api/resources/auth/types/SessionTokenRequest.js

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

package/api/resources/auth/types/SessionTokenResponse.d.ts

@@ -0,0 +1,6 @@
+export interface SessionTokenResponse {
+    /** The session token to use for authentication. */
+    sessionToken: string;
+    /** When the session token expires. */
+    expiresAt: Date;
+}

package/api/resources/auth/types/SessionTokenResponse.js

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

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

@@ -0,0 +1,2 @@
+export * from "./SessionTokenRequest";
+export * from "./SessionTokenResponse";

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

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./SessionTokenRequest"), exports);
+__exportStar(require("./SessionTokenResponse"), exports);

package/api/resources/commons/types/ActionBase.d.ts

@@ -1,17 +1,7 @@
 import type * as MavenAGI from "../../../index";
-export interface ActionBase {
+export interface ActionBase extends MavenAGI.ActionProperties {
     /** The name of the action. This is displayed to the end user as part of forms when user interaction is required. It is also used to help Maven decide if the action is relevant to a conversation. */
     name: string;
     /** The description of the action. Must be less than 1024 characters. This helps Maven decide if the action is relevant to a conversation and is not displayed directly to the end user. Descriptions are used by the LLM. */
     description: string;
-    /** Whether the action requires user interaction to execute. If false, and all of the required action parameters are known, the LLM may call the action automatically. If true, an conversations ask call will return a BotActionFormResponse which must be submitted by an API caller. API callers must display a button with the buttonName label to confirm the user's intent. */
-    userInteractionRequired: boolean;
-    /** When user interaction is required, the name of the button that is shown to the end user to confirm execution of the action. Defaults to "Submit" if not supplied. */
-    buttonName?: string;
-    /** The preconditions that must be met for an action to be relevant to a conversation. Can be used to restrict actions to certain types of users. */
-    precondition?: MavenAGI.Precondition;
-    /** The parameters that the action uses as input. An action will only be executed when all of the required parameters are provided. During execution, actions all have access to the full Conversation and User objects. Parameter values may be inferred from the user's conversation by the LLM. */
-    userFormParameters: MavenAGI.ActionParameter[];
-    /** The ISO 639-1 code for the language used in all fields of this action. Will be derived using the description's text if not specified. */
-    language?: string;
 }

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

@@ -23,6 +23,9 @@ export declare const ActionParameterType: {
     /**
      * Email parameter type; must be a valid email address */
     readonly Email: "EMAIL";
+    /**
+     * Phone number parameter type; must be a valid phone number (E.164 or regional format) */
+    readonly Phone: "PHONE";
     /**
      * 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. */
     readonly Schema: "SCHEMA";

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

@@ -27,6 +27,9 @@ exports.ActionParameterType = {
     /**
      * Email parameter type; must be a valid email address */
     Email: "EMAIL",
+    /**
+     * Phone number parameter type; must be a valid phone number (E.164 or regional format) */
+    Phone: "PHONE",
     /**
      * 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",

package/api/resources/commons/types/ActionProperties.d.ts

@@ -0,0 +1,13 @@
+import type * as MavenAGI from "../../../index";
+export interface ActionProperties {
+    /** Whether the action requires user interaction to execute. If false, and all of the required action parameters are known, the LLM may call the action automatically. If true, an conversations ask call will return a BotActionFormResponse which must be submitted by an API caller. API callers must display a button with the buttonName label to confirm the user's intent. */
+    userInteractionRequired: boolean;
+    /** When user interaction is required, the name of the button that is shown to the end user to confirm execution of the action. Defaults to "Submit" if not supplied. */
+    buttonName?: string;
+    /** The preconditions that must be met for an action to be relevant to a conversation. Can be used to restrict actions to certain types of users. */
+    precondition?: MavenAGI.Precondition;
+    /** The parameters that the action uses as input. An action will only be executed when all of the required parameters are provided. During execution, actions all have access to the full Conversation and User objects. Parameter values may be inferred from the user's conversation by the LLM. */
+    userFormParameters: MavenAGI.ActionParameter[];
+    /** The ISO 639-1 code for the language used in all fields of this action. Will be derived using the description's text if not specified. */
+    language?: string;
+}

package/api/resources/commons/types/ActionProperties.js

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

package/api/resources/commons/types/ActionUser.d.ts

@@ -0,0 +1,46 @@
+import type * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         userId: {
+ *             referenceId: "user0"
+ *         },
+ *         agentUserId: "aus_1234567890",
+ *         userIdentifiers: [{
+ *                 value: "joe@joe.com",
+ *                 type: MavenAGI.AppUserIdentifyingPropertyType.Email
+ *             }],
+ *         allUserData: {
+ *             "myapp": {
+ *                 "name": "Joe"
+ *             }
+ *         },
+ *         defaultUserData: {
+ *             "name": "Joe"
+ *         },
+ *         agentUserData: {
+ *             "name": [{
+ *                     value: "Joe",
+ *                     visibility: MavenAGI.VisibilityType.Visible,
+ *                     userId: {
+ *                         appId: "myapp",
+ *                         referenceId: "user0"
+ *                     }
+ *                 }]
+ *         }
+ *     }
+ */
+export interface ActionUser {
+    /** A user ID that can be used to store user information. Will only be undefined on legacy surfaces. */
+    userId?: MavenAGI.EntityIdBase;
+    /** The ID of the agent user that the userId is associated with */
+    agentUserId?: string;
+    /** All known identifiers for the user who is executing the action. */
+    userIdentifiers: MavenAGI.AppUserIdentifier[];
+    /** Data from all apps */
+    allUserData: Record<string, Record<string, string>>;
+    /** Default data for this user */
+    defaultUserData: Record<string, string>;
+    /** All user data for this user, including reverse indexable user data */
+    agentUserData: Record<string, MavenAGI.UserDataWithReference[]>;
+}

package/api/resources/commons/types/ActionUser.js

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

package/api/resources/commons/types/EntityType.d.ts

@@ -15,5 +15,6 @@ export declare const EntityType: {
     readonly InboxItemFix: "INBOX_ITEM_FIX";
     readonly Segment: "SEGMENT";
     readonly Customer: "CUSTOMER";
+    readonly IntelligentField: "INTELLIGENT_FIELD";
 };
 export type EntityType = (typeof EntityType)[keyof typeof EntityType];

package/api/resources/commons/types/EntityType.js

@@ -19,4 +19,5 @@ exports.EntityType = {
     InboxItemFix: "INBOX_ITEM_FIX",
     Segment: "SEGMENT",
     Customer: "CUSTOMER",
+    IntelligentField: "INTELLIGENT_FIELD",
 };

package/api/resources/commons/types/EventField.d.ts

@@ -15,5 +15,6 @@ export declare const EventField: {
     readonly SourceGeoCountry: "SOURCE_GEO_COUNTRY";
     readonly UserReferenceId: "USER_REFERENCE_ID";
     readonly AgentUserId: "AGENT_USER_ID";
+    readonly Timestamp: "TIMESTAMP";
 };
 export type EventField = (typeof EventField)[keyof typeof EventField];

package/api/resources/commons/types/EventField.js

@@ -19,4 +19,5 @@ exports.EventField = {
     SourceGeoCountry: "SOURCE_GEO_COUNTRY",
     UserReferenceId: "USER_REFERENCE_ID",
     AgentUserId: "AGENT_USER_ID",
+    Timestamp: "TIMESTAMP",
 };

package/api/resources/commons/types/UserEvent.d.ts

@@ -2,6 +2,8 @@ import type * as MavenAGI from "../../../index";
 export interface UserEvent extends MavenAGI.EventBaseNoId {
     /** The unique ID of the event */
     id: MavenAGI.EntityId;
+    /** The date and time the event was created */
+    createdAt?: Date;
     /** The name of the event */
     eventName: MavenAGI.UserEventName;
     /** Information about the user who triggered the event */

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

@@ -5,7 +5,9 @@ export * from "./ActionFormField";
 export * from "./ActionOAuthConfiguration";
 export * from "./ActionParameter";
 export * from "./ActionParameterType";
+export * from "./ActionProperties";
 export * from "./ActionResponse";
+export * from "./ActionUser";
 export * from "./AppPrecondition";
 export * from "./AppUser";
 export * from "./AppUserIdentifier";
@@ -70,6 +72,7 @@ export * from "./EventRequest";
 export * from "./EventResponse";
 export * from "./EventsSearchRequest";
 export * from "./EventsSearchResponse";
+export * from "./EventTriggerType";
 export * from "./EventType";
 export * from "./EventUserInfo";
 export * from "./EventUserInfoBase";

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

@@ -21,7 +21,9 @@ __exportStar(require("./ActionFormField"), exports);
 __exportStar(require("./ActionOAuthConfiguration"), exports);
 __exportStar(require("./ActionParameter"), exports);
 __exportStar(require("./ActionParameterType"), exports);
+__exportStar(require("./ActionProperties"), exports);
 __exportStar(require("./ActionResponse"), exports);
+__exportStar(require("./ActionUser"), exports);
 __exportStar(require("./AppPrecondition"), exports);
 __exportStar(require("./AppUser"), exports);
 __exportStar(require("./AppUserIdentifier"), exports);
@@ -86,6 +88,7 @@ __exportStar(require("./EventRequest"), exports);
 __exportStar(require("./EventResponse"), exports);
 __exportStar(require("./EventsSearchRequest"), exports);
 __exportStar(require("./EventsSearchResponse"), exports);
+__exportStar(require("./EventTriggerType"), exports);
 __exportStar(require("./EventType"), exports);
 __exportStar(require("./EventUserInfo"), exports);
 __exportStar(require("./EventUserInfoBase"), exports);