mavenagi 0.0.0-alpha.9 → 1.0.0

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

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

@@ -0,0 +1,125 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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());
+    });
+};
+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 * as errors from "../../../../errors/index";
+export class AppSettings {
+    constructor(_options) {
+        this._options = _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) {
+        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/app-settings"),
+                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-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "mavenagi",
+                    "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 serializers.appSettings.get.Response.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            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"],
+                        }));
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError();
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    _getAuthorizationHeader() {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            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;
+        });
+    }
+}

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

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

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

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

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

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

package/api/resources/appSettings/index.js

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

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

@@ -3,8 +3,7 @@
  */
 import * as MavenAGI from "../../../index";
 export interface AppUser {
-    /** Externally supplied unique ID of the user */
-    id: string;
-    userIdentifiers?: MavenAGI.AppUserIdentification;
-    metadata?: Record<string, string>;
+    /** Used to determine whether two users from different apps are the same */
+    identifiers: MavenAGI.AppUserIdentifier[];
+    data: Record<string, MavenAGI.UserData>;
 }

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

@@ -5,5 +5,5 @@ import * as MavenAGI from "../../../index";
 export interface AppUserIdentifier {
     /** The identifying property text */
     value: string;
-    userIdentifyingPropertyType: MavenAGI.AppUserIdentifyingPropertyType;
+    type: MavenAGI.AppUserIdentifyingPropertyType;
 }

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

@@ -2,4 +2,25 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type AppUserRequest = MavenAGI.AppUser;
+/**
+ * @example
+ *     {
+ *         userId: {
+ *             referenceId: "user-0"
+ *         },
+ *         identifiers: new Set([{
+ *                 value: "joe@myapp.com",
+ *                 type: MavenAGI.AppUserIdentifyingPropertyType.Email
+ *             }]),
+ *         data: {
+ *             "name": {
+ *                 value: "Joe",
+ *                 visibility: MavenAGI.VisibilityType.Visible
+ *             }
+ *         }
+ *     }
+ */
+export interface AppUserRequest extends MavenAGI.AppUser {
+    /** ID that uniquely identifies this app user */
+    userId: MavenAGI.EntityIdBase;
+}

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

@@ -2,4 +2,41 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export declare type AppUserResponse = MavenAGI.AppUser;
+/**
+ * @example
+ *     {
+ *         userId: {
+ *             referenceId: "user-0",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.UserProfile
+ *         },
+ *         identifiers: new Set([{
+ *                 value: "joe@myapp.com",
+ *                 type: MavenAGI.AppUserIdentifyingPropertyType.Email
+ *             }]),
+ *         data: {
+ *             "name": {
+ *                 value: "Joe",
+ *                 visibility: MavenAGI.VisibilityType.Visible
+ *             }
+ *         },
+ *         allUserData: {
+ *             "myapp": {
+ *                 "name": "Joe"
+ *             }
+ *         },
+ *         defaultUserData: {
+ *             "name": "Joe"
+ *         }
+ *     }
+ */
+export interface AppUserResponse extends MavenAGI.AppUser {
+    /** ID that uniquely identifies this user */
+    userId: MavenAGI.EntityId;
+    /** Data from all apps */
+    allUserData: Record<string, Record<string, string>>;
+    /** Default data for this user */
+    defaultUserData: Record<string, string>;
+}

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

@@ -1,7 +1,7 @@
 /**
  * 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 type EntityType = "CONVERSATION" | "CONVERSATION_MESSAGE" | "KNOWLEDGE_BASE" | "KNOWLEDGE_DOCUMENT" | "ACTION" | "USER" | "USER_EVENT" | "EVENT_TRIGGER" | "USER_PROFILE" | "FEEDBACK";
 export declare const EntityType: {
     readonly Conversation: "CONVERSATION";
     readonly ConversationMessage: "CONVERSATION_MESSAGE";
@@ -11,4 +11,6 @@ export declare const EntityType: {
     readonly User: "USER";
     readonly UserEvent: "USER_EVENT";
     readonly EventTrigger: "EVENT_TRIGGER";
+    readonly UserProfile: "USER_PROFILE";
+    readonly Feedback: "FEEDBACK";
 };

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

@@ -10,4 +10,6 @@ export const EntityType = {
     User: "USER",
     UserEvent: "USER_EVENT",
     EventTrigger: "EVENT_TRIGGER",
+    UserProfile: "USER_PROFILE",
+    Feedback: "FEEDBACK",
 };

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

@@ -2,15 +2,39 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface Feedback {
+/**
+ * @example
+ *     {
+ *         feedbackId: {
+ *             referenceId: "feedback-0",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Feedback
+ *         },
+ *         conversationId: {
+ *             referenceId: "conversation-0",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.Conversation
+ *         },
+ *         conversationMessageId: {
+ *             referenceId: "message-1",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.ConversationMessage
+ *         },
+ *         type: MavenAGI.FeedbackType.ThumbsUp,
+ *         text: "Great answer!"
+ *     }
+ */
+export interface Feedback extends MavenAGI.FeedbackBase {
     /** The ID of the piece of feedback */
-    id: string;
+    feedbackId: MavenAGI.EntityId;
     /** The ID of the conversation the feedback is about */
-    conversationId: string;
+    conversationId: MavenAGI.EntityId;
     /** The ID of the conversation message the feedback is about */
-    conversationMessageId: string;
-    /** The type of feedback */
-    type: MavenAGI.FeedbackType;
-    /** The feedback text */
-    text?: string;
+    conversationMessageId: MavenAGI.EntityId;
 }

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface FeedbackBase {
+    /** The type of feedback */
+    type: MavenAGI.FeedbackType;
+    /** The feedback text */
+    text?: string;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface UserData {
+    /** The value of the user metadata */
+    value: string;
+    /** The visibility of the user metadata */
+    visibility: MavenAGI.VisibilityType;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type VisibilityType = "VISIBLE" | "PARTIALLY_VISIBLE" | "HIDDEN";
+export declare const VisibilityType: {
+    readonly Visible: "VISIBLE";
+    readonly PartiallyVisible: "PARTIALLY_VISIBLE";
+    readonly Hidden: "HIDDEN";
+};

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const VisibilityType = {
+    Visible: "VISIBLE",
+    PartiallyVisible: "PARTIALLY_VISIBLE",
+    Hidden: "HIDDEN",
+};

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

@@ -2,12 +2,16 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
 export * from "./Feedback";
-export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -2,12 +2,16 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
+export * from "./FeedbackBase";
 export * from "./FeedbackType";
 export * from "./Feedback";
-export * from "./AppUserIdentification";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
+export * from "./UserData";
+export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";