mavenagi 0.0.0-alpha.9 → 1.0.0

package/dist/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/dist/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.9",
+                    "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.9",
+                    "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.9",
+                    "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/dist/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/dist/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/dist/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/dist/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/dist/api/resources/actions/types/ConversationExecutedActionPrecondition.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/api/resources/actions/types/ConversationPrecondition.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/api/resources/actions/types/MetadataPrecondition.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/api/resources/actions/types/Precondition.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/api/resources/actions/types/PreconditionBase.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/api/resources/actions/types/PreconditionGroup.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/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/dist/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/dist/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/dist/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/dist/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>;
+}

package/dist/api/resources/actions/types/TagsPrecondition.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -1,5 +1,13 @@
-export * from "./Preconditions";
 export * from "./ActionBase";
 export * from "./ActionParameter";
 export * from "./ActionRequest";
 export * from "./ActionResponse";
+export * from "./Precondition";
+export * from "./PreconditionOperator";
+export * from "./PreconditionBase";
+export * from "./MetadataPrecondition";
+export * from "./ConversationPrecondition";
+export * from "./PreconditionGroupOperator";
+export * from "./PreconditionGroup";
+export * from "./TagsPrecondition";
+export * from "./ConversationExecutedActionPrecondition";

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

@@ -1,5 +1,13 @@
-export * from "./Preconditions";
 export * from "./ActionBase";
 export * from "./ActionParameter";
 export * from "./ActionRequest";
 export * from "./ActionResponse";
+export * from "./Precondition";
+export * from "./PreconditionOperator";
+export * from "./PreconditionBase";
+export * from "./MetadataPrecondition";
+export * from "./ConversationPrecondition";
+export * from "./PreconditionGroupOperator";
+export * from "./PreconditionGroup";
+export * from "./TagsPrecondition";
+export * from "./ConversationExecutedActionPrecondition";

package/dist/api/resources/appSettings/client/Client.d.ts

@@ -0,0 +1,47 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+export declare namespace AppSettings {
+    interface Options {
+        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 AppSettings {
+    protected readonly _options: AppSettings.Options;
+    constructor(_options: AppSettings.Options);
+    /**
+     * Get app settings set during installation
+     *
+     * @param {AppSettings.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.appSettings.get()
+     */
+    get(requestOptions?: AppSettings.RequestOptions): Promise<Record<string, unknown>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}