mavenagi 0.0.0-alpha.8 → 1.0.0

package/Client.d.ts

@@ -4,8 +4,10 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Actions } from "./api/resources/actions/client/Client";
+import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/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";
 export declare namespace MavenAGIClient {
@@ -13,14 +15,23 @@ export declare namespace MavenAGIClient {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class MavenAGIClient {
@@ -28,10 +39,14 @@ export declare class MavenAGIClient {
     constructor(_options: MavenAGIClient.Options);
     protected _actions: Actions | undefined;
     get actions(): Actions;
+    protected _appSettings: AppSettings | undefined;
+    get appSettings(): AppSettings;
     protected _conversation: Conversation | undefined;
     get conversation(): Conversation;
     protected _knowledge: Knowledge | undefined;
     get knowledge(): Knowledge;
+    protected _translations: Translations | undefined;
+    get translations(): Translations;
     protected _triggers: Triggers | undefined;
     get triggers(): Triggers;
     protected _users: Users | undefined;

package/Client.js

@@ -2,8 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import { Actions } from "./api/resources/actions/client/Client";
+import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
 import { Knowledge } from "./api/resources/knowledge/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";
 export class MavenAGIClient {
@@ -14,6 +16,10 @@ export class MavenAGIClient {
         var _a;
         return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Actions(this._options)));
     }
+    get appSettings() {
+        var _a;
+        return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new AppSettings(this._options)));
+    }
     get conversation() {
         var _a;
         return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Conversation(this._options)));
@@ -22,6 +28,10 @@ export class MavenAGIClient {
         var _a;
         return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Knowledge(this._options)));
     }
+    get translations() {
+        var _a;
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Translations(this._options)));
+    }
     get triggers() {
         var _a;
         return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Triggers(this._options)));

package/README.md

@@ -1,6 +1,6 @@
 # Mavenagi TypeScript Library
 
-[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fmavenagi%2Fmavenagi-node)
 [![npm shield](https://img.shields.io/npm/v/mavenagi)](https://www.npmjs.com/package/mavenagi)
 
 The Mavenagi TypeScript library provides convenient access to the Mavenagi API from TypeScript.
@@ -16,8 +16,7 @@ npm i -s mavenagi
 Instantiate and use the client with the following:
 
 ```typescript
-import * as environments from "../src/environments";
-import { MavenAGIClient, MavenAGI } from "mavenagi";
+import { MavenAGIClient } from "mavenagi";
 
 const client = new MavenAGIClient({
     appId: "YOUR_APP_ID",
@@ -26,34 +25,37 @@ const client = new MavenAGIClient({
     agentId: "YOUR_AGENT_ID",
 });
 await client.conversation.initialize({
+    conversationId: {
+        referenceId: "string",
+    },
     messages: [{}],
-    context: {},
-    id: "string",
     responseConfig: {
-        capabilities: [MavenAGI.Capability.Markdown],
+        capabilities: ["MARKDOWN"],
         isCopilot: true,
-        responseLength: MavenAGI.ResponseLength.Short,
+        responseLength: "SHORT",
+    },
+    subject: "string",
+    url: "string",
+    createdAt: new Date("2024-01-15T09:30:00.000Z"),
+    updatedAt: new Date("2024-01-15T09:30:00.000Z"),
+    tags: new Set(["string"]),
+    metadata: {
+        string: "string",
     },
 });
 ```
 
-## Exception Handling
+## Request And Response Types
 
-When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
-will be thrown.
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
 
 ```typescript
-import { MavenAGIError } from "mavenagi";
+import { MavenAGI } from "mavenagi";
 
-try {
-    await client.initialize(...);
-} catch (err) {
-    if (err instanceof MavenAGIError) {
-        console.log(err.statusCode);
-        console.log(err.message);
-        console.log(err.body);
-    }
-}
+const request: MavenAGI.ConversationGetRequest = {
+    ...
+};
 ```
 
 ## Aborting Requests
@@ -94,6 +96,25 @@ const client = new MavenAGIClient({
 });
 ```
 
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { MavenAGIError } from "mavenagi";
+
+try {
+    await client.conversation.initialize(...);
+} catch (err) {
+    if (err instanceof MavenAGIError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
+}
+```
+
 ## Advanced
 
 ### Retries
@@ -111,7 +132,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.initialize(..., {
+const response = await client.conversation.initialize(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -121,11 +142,49 @@ const response = await client.initialize(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.initialize(..., {
+const response = await client.conversation.initialize(..., {
     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.conversation.initialize(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
+
+### Runtime Compatibility
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
+
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
+
+### Customizing Fetch Client
+
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { MavenAGIClient } from "mavenagi";
+
+const client = new MavenAGIClient({
+    ...
+    fetcher: // provide your implementation here
+});
+```
+
 ## Contributing
 
 While we value open-source contributions to this SDK, this library is generated programmatically.

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

@@ -9,14 +9,23 @@ export declare namespace Actions {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
         organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
         timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
         maxRetries?: number;
+        /** A hook to abort the request. */
         abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
     }
 }
 export declare class Actions {
@@ -40,10 +49,18 @@ export declare class Actions {
      *         name: "Get the user's balance",
      *         description: "This action calls an API to get the user's current balance.",
      *         userInteractionRequired: false,
-     *         preconditions: {
-     *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
-     *         },
-     *         userFormParameters: []
+     *         userFormParameters: [],
+     *         precondition: {
+     *             preconditionType: "group",
+     *             operator: "AND",
+     *             preconditions: [{
+     *                     preconditionType: "user",
+     *                     key: "userKey"
+     *                 }, {
+     *                     preconditionType: "user",
+     *                     key: "userKey2"
+     *                 }]
+     *         }
      *     })
      */
     createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;

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

@@ -38,10 +38,18 @@ export class Actions {
      *         name: "Get the user's balance",
      *         description: "This action calls an API to get the user's current balance.",
      *         userInteractionRequired: false,
-     *         preconditions: {
-     *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
-     *         },
-     *         userFormParameters: []
+     *         userFormParameters: [],
+     *         precondition: {
+     *             preconditionType: "group",
+     *             operator: "AND",
+     *             preconditions: [{
+     *                     preconditionType: "user",
+     *                     key: "userKey"
+     *                 }, {
+     *                     preconditionType: "user",
+     *                     key: "userKey2"
+     *                 }]
+     *         }
      *     })
      */
     createOrUpdate(request, requestOptions) {
@@ -56,18 +64,20 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
+                    "X-Fern-SDK-Version": "1.0.0",
+                    "User-Agent": "mavenagi/1.0.0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                requestType: "json",
+                body: 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.ActionResponse.parseOrThrow(_response.body, {
+                return serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -77,21 +87,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -144,17 +154,19 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
+                    "X-Fern-SDK-Version": "1.0.0",
+                    "User-Agent": "mavenagi/1.0.0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
+                requestType: "json",
                 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.ActionResponse.parseOrThrow(_response.body, {
+                return serializers.ActionResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -164,21 +176,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
@@ -231,11 +243,13 @@ export class Actions {
                     "X-Agent-Id": yield core.Supplier.get(this._options.agentId),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "mavenagi",
-                    "X-Fern-SDK-Version": "0.0.0-alpha.8",
+                    "X-Fern-SDK-Version": "1.0.0",
+                    "User-Agent": "mavenagi/1.0.0",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
+                requestType: "json",
                 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,
@@ -246,21 +260,21 @@ export class Actions {
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {
                     case 404:
-                        throw new MavenAGI.NotFoundError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 400:
-                        throw new MavenAGI.BadRequestError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,
                             breadcrumbsPrefix: ["response"],
                         }));
                     case 500:
-                        throw new MavenAGI.ServerError(yield serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
                             unrecognizedObjectKeys: "passthrough",
                             allowUnrecognizedUnionMembers: true,
                             allowUnrecognizedEnumValues: true,

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

@@ -5,14 +5,14 @@ import * as MavenAGI from "../../../index";
 export interface ActionBase {
     /** 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. This helps Maven decide if the action is relevant to a conversation and is not displayed directly to the end user. */
+    /** 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 */
     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. */
-    preconditions: MavenAGI.Preconditions;
+    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[];
 }

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

@@ -11,10 +11,18 @@ import * as MavenAGI from "../../../index";
  *         name: "Get the user's balance",
  *         description: "This action calls an API to get the user's current balance.",
  *         userInteractionRequired: false,
- *         preconditions: {
- *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
- *         },
- *         userFormParameters: []
+ *         userFormParameters: [],
+ *         precondition: {
+ *             preconditionType: "group",
+ *             operator: MavenAGI.PreconditionGroupOperator.And,
+ *             preconditions: [{
+ *                     preconditionType: "user",
+ *                     key: "userKey"
+ *                 }, {
+ *                     preconditionType: "user",
+ *                     key: "userKey2"
+ *                 }]
+ *         }
  *     }
  */
 export interface ActionRequest extends MavenAGI.ActionBase {

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

@@ -15,10 +15,18 @@ import * as MavenAGI from "../../../index";
  *         name: "Get the user's balance",
  *         description: "This action calls an API to get the user's current balance.",
  *         userInteractionRequired: false,
- *         preconditions: {
- *             requiredUserContextFieldNames: new Set(["my-billing-system.userId"])
- *         },
- *         userFormParameters: []
+ *         userFormParameters: [],
+ *         precondition: {
+ *             preconditionType: "group",
+ *             operator: MavenAGI.PreconditionGroupOperator.And,
+ *             preconditions: [{
+ *                     preconditionType: "user",
+ *                     key: "userKey"
+ *                 }, {
+ *                     preconditionType: "user",
+ *                     key: "userKey2"
+ *                 }]
+ *         }
  *     }
  */
 export interface ActionResponse extends MavenAGI.ActionBase {

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ConversationExecutedActionPrecondition extends MavenAGI.PreconditionBase {
+    /** ID of an action that must have executed in this conversation for the precondition to be met */
+    actionId: string;
+    /** App ID that the given actionId belongs to. If not provided, the calling appId will be used. */
+    appId?: string;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export declare type ConversationPrecondition = MavenAGI.ConversationPrecondition.Tags | MavenAGI.ConversationPrecondition.Metadata | MavenAGI.ConversationPrecondition.ActionExecuted;
+export declare namespace ConversationPrecondition {
+    interface Tags extends MavenAGI.TagsPrecondition {
+        conversationPreconditionType: "tags";
+    }
+    interface Metadata extends MavenAGI.MetadataPrecondition {
+        conversationPreconditionType: "metadata";
+    }
+    interface ActionExecuted extends MavenAGI.ConversationExecutedActionPrecondition {
+        conversationPreconditionType: "actionExecuted";
+    }
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface MetadataPrecondition extends MavenAGI.PreconditionBase {
+    /** The key that must be present in the metadata for a precondition to be met */
+    key: string;
+    /** If set, the value must match the metadata value for the given key */
+    value?: string;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+/**
+ * @example
+ *     {
+ *         preconditionType: "group",
+ *         operator: MavenAGI.PreconditionGroupOperator.And,
+ *         preconditions: [{
+ *                 preconditionType: "user",
+ *                 key: "userKey"
+ *             }, {
+ *                 preconditionType: "user",
+ *                 key: "userKey2"
+ *             }]
+ *     }
+ */
+export declare type Precondition = MavenAGI.Precondition.User | MavenAGI.Precondition.Conversation | MavenAGI.Precondition.Group;
+export declare namespace Precondition {
+    interface User extends MavenAGI.MetadataPrecondition {
+        preconditionType: "user";
+    }
+    interface Conversation {
+        preconditionType: "conversation";
+        value: MavenAGI.ConversationPrecondition;
+    }
+    interface Group extends MavenAGI.PreconditionGroup {
+        preconditionType: "group";
+    }
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface PreconditionBase {
+    /** Operator to apply to this precondition */
+    operator?: MavenAGI.PreconditionOperator;
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface PreconditionGroup {
+    operator: MavenAGI.PreconditionGroupOperator;
+    preconditions: MavenAGI.Precondition[];
+}

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type PreconditionGroupOperator = "AND" | "OR";
+export declare const PreconditionGroupOperator: {
+    readonly And: "AND";
+    readonly Or: "OR";
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PreconditionGroupOperator = {
+    And: "AND",
+    Or: "OR",
+};

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type PreconditionOperator = "NOT";
+export declare const PreconditionOperator: {
+    readonly Not: "NOT";
+};

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const PreconditionOperator = {
+    Not: "NOT",
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface TagsPrecondition extends MavenAGI.PreconditionBase {
+    /** The tags that must be present in the conversation context for the precondition to be met */
+    tags: Set<string>;
+}