mavenagi 0.0.0-alpha.3 → 0.0.0-alpha.5

package/Client.d.ts

@@ -3,17 +3,18 @@
  */
 import * as environments from "./environments";
 import * as core from "./core";
-import { ActionSet } from "./api/resources/actionSet/client/Client";
-import { Action } from "./api/resources/action/client/Client";
+import { Actions } from "./api/resources/actions/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
+import { Triggers } from "./api/resources/triggers/client/Client";
+import { Users } from "./api/resources/users/client/Client";
 export declare namespace MavenAGIClient {
     interface Options {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
-        organizationId: core.Supplier<string>;
-        agentId: core.Supplier<string>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -25,12 +26,14 @@ export declare namespace MavenAGIClient {
 export declare class MavenAGIClient {
     protected readonly _options: MavenAGIClient.Options;
     constructor(_options: MavenAGIClient.Options);
-    protected _actionSet: ActionSet | undefined;
-    get actionSet(): ActionSet;
-    protected _action: Action | undefined;
-    get action(): Action;
+    protected _actions: Actions | undefined;
+    get actions(): Actions;
     protected _conversation: Conversation | undefined;
     get conversation(): Conversation;
     protected _knowledge: Knowledge | undefined;
     get knowledge(): Knowledge;
+    protected _triggers: Triggers | undefined;
+    get triggers(): Triggers;
+    protected _users: Users | undefined;
+    get users(): Users;
 }

package/Client.js

@@ -1,21 +1,18 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-import { ActionSet } from "./api/resources/actionSet/client/Client";
-import { Action } from "./api/resources/action/client/Client";
+import { Actions } from "./api/resources/actions/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
+import { Triggers } from "./api/resources/triggers/client/Client";
+import { Users } from "./api/resources/users/client/Client";
 export class MavenAGIClient {
     constructor(_options) {
         this._options = _options;
     }
-    get actionSet() {
+    get actions() {
         var _a;
-        return ((_a = this._actionSet) !== null && _a !== void 0 ? _a : (this._actionSet = new ActionSet(this._options)));
-    }
-    get action() {
-        var _a;
-        return ((_a = this._action) !== null && _a !== void 0 ? _a : (this._action = new Action(this._options)));
+        return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Actions(this._options)));
     }
     get conversation() {
         var _a;
@@ -25,4 +22,12 @@ export class MavenAGIClient {
         var _a;
         return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Knowledge(this._options)));
     }
+    get triggers() {
+        var _a;
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Triggers(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Users(this._options)));
+    }
 }

package/README.md

@@ -17,17 +17,23 @@ Instantiate and use the client with the following:
 
 ```typescript
 import * as environments from "../src/environments";
-import { MavenAGIClient } from "mavenagi";
+import { MavenAGIClient, MavenAGI } from "mavenagi";
 
 const client = new MavenAGIClient({
     appId: "YOUR_APP_ID",
     appSecret: "YOUR_APP_SECRET",
-    organizationId: "YOUR_ORGANIZATION_ID",
-    agentId: "YOUR_AGENT_ID",
+    xOrganizationId: "YOUR_X_ORGANIZATION_ID",
+    xAgentId: "YOUR_X_AGENT_ID",
 });
-await client.actionSet.create({
+await client.conversation.initialize({
+    messages: [{}],
+    context: {},
     id: "string",
-    name: "string",
+    responseConfig: {
+        capabilities: [MavenAGI.Capability.Markdown],
+        isCopilot: true,
+        responseLength: MavenAGI.ResponseLength.Short,
+    },
 });
 ```
 
@@ -40,7 +46,7 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.create(...);
+    await client.initialize(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -50,43 +56,13 @@ try {
 }
 ```
 
-## Retries
-
-The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
-retry limit (default: 2).
-
-A request is deemed retriable when any of the following HTTP status codes is returned:
-
--   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
--   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
--   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
-
-Use the `maxRetries` request option to configure this behavior.
-
-```typescript
-const response = await client.create(..., {
-    maxRetries: 0 // override maxRetries at the request level
-});
-```
-
-## Timeouts
-
-The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
-
-```typescript
-const response = await client.create(..., {
-    timeoutInSeconds: 30 // override timeout to 30s
-});
-```
-
 ## Aborting Requests
 
 The SDK allows users to abort requests at any point by passing in an abort signal.
 
 ```typescript
 const controller = new AbortController();
-const response = await client.create(..., {
+const response = await client.initialize(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
@@ -118,6 +94,38 @@ const client = new MavenAGIClient({
 });
 ```
 
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.initialize(..., {
+    maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
+
+```typescript
+const response = await client.initialize(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

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

@@ -0,0 +1,77 @@
+/**
+ * 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 Actions {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Actions {
+    protected readonly _options: Actions.Options;
+    constructor(_options: Actions.Options);
+    /**
+     * Update an action or create it if it doesn't exist
+     *
+     * @param {MavenAGI.ActionRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.actions.createOrUpdateAction({
+     *         entityId: {
+     *             referenceId: "get-balance"
+     *         },
+     *         name: "Get the user's balance",
+     *         description: "This action calls an API to get the user's current balance.",
+     *         userInteractionRequired: false,
+     *         requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
+     *         userFormParameters: []
+     *     })
+     */
+    createOrUpdateAction(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
+    /**
+     * Get an action by its supplied ID
+     *
+     * @param {string} referenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.actions.getAction("get-balance")
+     */
+    getAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
+    /**
+     * Delete an action
+     *
+     * @param {string} referenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.actions.deleteAction("get-balance")
+     */
+    deleteAction(referenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}

package/api/resources/{action → actions}/client/Client.js

@@ -13,49 +13,59 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import * as environments from "../../../../environments";
 import * as core from "../../../../core";
 import * as MavenAGI from "../../../index";
-import urlJoin from "url-join";
 import * as serializers from "../../../../serialization/index";
+import urlJoin from "url-join";
 import * as errors from "../../../../errors/index";
-export class Action {
+export class Actions {
     constructor(_options) {
         this._options = _options;
     }
     /**
-     * Get an action by its supplied ID
+     * Update an action or create it if it doesn't exist
      *
-     * @param {string} actionId - The ID of the action to get
-     * @param {Action.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {MavenAGI.ActionRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.action.get("string")
+     *     await client.actions.createOrUpdateAction({
+     *         entityId: {
+     *             referenceId: "get-balance"
+     *         },
+     *         name: "Get the user's balance",
+     *         description: "This action calls an API to get the user's current balance.",
+     *         userInteractionRequired: false,
+     *         requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
+     *         userFormParameters: []
+     *     })
      */
-    get(actionId, requestOptions) {
+    createOrUpdateAction(request, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionId)}`),
-                method: "GET",
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/actions"),
+                method: "PUT",
                 headers: {
                     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-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
+                    "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.3",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
+                body: yield serializers.ActionRequest.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 yield serializers.Action.parseOrThrow(_response.body, {
+                return yield serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -108,52 +118,41 @@ export class Action {
         });
     }
     /**
-     * Update an action or create it if it doesn't exist
+     * Get an action by its supplied ID
      *
-     * @param {MavenAGI.Action} request
-     * @param {Action.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} referenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.action.register({
-     *         id: "string",
-     *         actionSetId: "string",
-     *         appId: "string",
-     *         name: "string",
-     *         description: "string",
-     *         userInteractionRequired: true,
-     *         buttonName: "string",
-     *         requiredUserContextFieldNames: new Set(["string"]),
-     *         userFormParameters: [{}]
-     *     })
+     *     await client.actions.getAction("get-balance")
      */
-    register(request, requestOptions) {
+    getAction(referenceId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, "/v1/actions"),
-                method: "PUT",
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(referenceId)}`),
+                method: "GET",
                 headers: {
                     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-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
+                    "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.3",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.Action.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 yield serializers.Action.parseOrThrow(_response.body, {
+                return yield serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -208,29 +207,29 @@ export class Action {
     /**
      * Delete an action
      *
-     * @param {string} actionId - The ID of the action to delete
-     * @param {Action.RequestOptions} requestOptions - Request-specific configuration.
+     * @param {string} referenceId - The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
      * @throws {@link MavenAGI.BadRequestError}
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.action.delete("string")
+     *     await client.actions.deleteAction("get-balance")
      */
-    delete(actionId, requestOptions) {
+    deleteAction(referenceId, requestOptions) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionId)}`),
+                url: urlJoin((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(referenceId)}`),
                 method: "DELETE",
                 headers: {
                     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-Organization-Id": yield core.Supplier.get(this._options.xOrganizationId),
+                    "X-Agent-Id": yield core.Supplier.get(this._options.xAgentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.3",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/{action/types/Action.d.ts → actions/types/ActionBase.d.ts}

@@ -2,20 +2,14 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface Action {
-    /** Externally supplied ID to uniquely identify this action */
-    id: string;
-    /** The ID of the action set this action belongs to. Must be an existing action set ID. */
-    actionSetId: string;
-    /** The maven app id of the app that runs this action */
-    appId: string;
+export interface ActionBase {
     /** The name of the action */
     name: string;
-    /** The description of the action. This helps Maven decide when to trigger the action and is not displayed directly to the user. */
+    /** The description of the action. This helps Maven decide when to trigger the action and is not displayed directly to the end user. */
     description: string;
     /** Whether the action requires user interaction to execute */
     userInteractionRequired: boolean;
-    /** The name of the button that submits the action */
+    /** When user interaction is required, the name of the button that is shown to the end user to execute the action */
     buttonName?: string;
     /** The names of the user context fields required by the action */
     requiredUserContextFieldNames: Set<string>;

package/api/resources/{action → actions}/types/ActionParameter.d.ts

@@ -3,6 +3,7 @@
  */
 export interface ActionParameter {
     id: string;
+    label: string;
     description: string;
     required: boolean;
 }

package/api/resources/actions/types/ActionRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         entityId: {
+ *             referenceId: "get-balance"
+ *         },
+ *         name: "Get the user's balance",
+ *         description: "This action calls an API to get the user's current balance.",
+ *         userInteractionRequired: false,
+ *         requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
+ *         userFormParameters: []
+ *     }
+ */
+export interface ActionRequest extends MavenAGI.ActionBase {
+    /** ID that uniquely identifies this action */
+    entityId: MavenAGI.EntityIdBase;
+}

package/api/resources/actions/types/ActionResponse.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         entityId: {
+ *             referenceId: "get-balance",
+ *             appId: "my-billing-system",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Action
+ *         },
+ *         name: "Get the user's balance",
+ *         description: "This action calls an API to get the user's current balance.",
+ *         userInteractionRequired: false,
+ *         requiredUserContextFieldNames: new Set(["my-billing-system.userId"]),
+ *         userFormParameters: []
+ *     }
+ */
+export interface ActionResponse extends MavenAGI.ActionBase {
+    /** ID that uniquely identifies this action */
+    entityId: MavenAGI.EntityId;
+}

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

@@ -0,0 +1,4 @@
+export * from "./ActionBase";
+export * from "./ActionParameter";
+export * from "./ActionRequest";
+export * from "./ActionResponse";

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

@@ -0,0 +1,4 @@
+export * from "./ActionBase";
+export * from "./ActionParameter";
+export * from "./ActionRequest";
+export * from "./ActionResponse";

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUser {
+    /** Externally supplied unique ID of the user */
+    id: string;
+    userIdentifiers?: MavenAGI.AppUserIdentification;
+    metadata?: Record<string, string>;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserIdentification {
+    /** At least one identifying property must be provided. etc */
+    identifiers: MavenAGI.AppUserIdentifyingProperty[];
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface AppUserIdentifyingProperty {
+    /** The identifying property text */
+    value: string;
+    userIdentifyingPropertyType: MavenAGI.AppUserIdentifyingPropertyType;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppUserIdentifyingPropertyType = "EMAIL" | "PHONE_NUMBER";
+export declare const AppUserIdentifyingPropertyType: {
+    readonly Email: "EMAIL";
+    readonly PhoneNumber: "PHONE_NUMBER";
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const AppUserIdentifyingPropertyType = {
+    Email: "EMAIL",
+    PhoneNumber: "PHONE_NUMBER",
+};

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface EntityId extends MavenAGI.EntityIdBase {
+    /** The object type */
+    type: MavenAGI.EntityType;
+    /** The ID of the application that created this object */
+    appId: string;
+    /** The ID of the organization that this object belongs too */
+    organizationId: string;
+    /** The ID of the agent that this object belongs too */
+    agentId: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * All other entityId fields are inferred from the API request.
+ */
+export interface EntityIdBase {
+    /** Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId) */
+    referenceId: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER";
+export declare const EntityType: {
+    readonly Conversation: "CONVERSATION";
+    readonly ConversationMessage: "CONVERSATION_MESSAGE";
+    readonly KnowledgeBase: "KNOWLEDGE_BASE";
+    readonly KnowledgeDocument: "KNOWLEDGE_DOCUMENT";
+    readonly Action: "ACTION";
+    readonly User: "USER";
+    readonly UserEvent: "USER_EVENT";
+    readonly EventTrigger: "EVENT_TRIGGER";
+};