mavenagi 0.0.0-alpha.12 → 0.0.0-alpha.15

package/Client.d.ts

@@ -4,6 +4,7 @@
 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 { Triggers } from "./api/resources/triggers/client/Client";
@@ -37,6 +38,8 @@ 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;

package/Client.js

@@ -2,6 +2,7 @@
  * 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 { Triggers } from "./api/resources/triggers/client/Client";
@@ -14,6 +15,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)));

package/README.md

@@ -29,12 +29,19 @@ await client.conversation.initialize({
         referenceId: "string",
     },
     messages: [{}],
-    context: {},
     responseConfig: {
         capabilities: [MavenAGI.Capability.Markdown],
         isCopilot: true,
         responseLength: MavenAGI.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",
+    },
 });
 ```
 

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

@@ -56,7 +56,7 @@ 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.12",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.15",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -145,7 +145,7 @@ 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.12",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.15",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -233,7 +233,7 @@ 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.12",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.15",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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,124 @@
+/**
+ * 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": "0.0.0-alpha.15",
+                    "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,6 +3,7 @@
  */
 import * as MavenAGI from "../../../index";
 export interface AppUser {
-    userIdentifiers?: MavenAGI.AppUserIdentification;
-    metadata?: Record<string, MavenAGI.UserData>;
+    /** 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,7 +2,25 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @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 */
-    appUserId: MavenAGI.EntityIdBase;
+    userId: MavenAGI.EntityIdBase;
 }

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

@@ -2,7 +2,39 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
+/**
+ * @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 app user */
-    appUserId: MavenAGI.EntityId;
+    /** ID that uniquely identifies this user */
+    userId: MavenAGI.EntityId;
+    /** Data from all apps */
+    allUserData: Record<string, Record<string, string>>;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface Feedback extends MavenAGI.FeedbackBase {
+    /** The ID of the piece of feedback */
+    feedbackId: MavenAGI.EntityId;
+    /** The ID of the conversation the feedback is about */
+    conversationId: MavenAGI.EntityId;
+    /** The ID of the conversation message the feedback is about */
+    conversationMessageId: MavenAGI.EntityId;
+}

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

@@ -6,5 +6,5 @@ export interface UserData {
     /** The value of the user metadata */
     value: string;
     /** The visibility of the user metadata */
-    visibility?: MavenAGI.VisibilityType;
+    visibility: MavenAGI.VisibilityType;
 }

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

@@ -2,10 +2,9 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
 export * from "./FeedbackBase";
 export * from "./FeedbackType";
-export * from "./AppUserIdentification";
+export * from "./Feedback";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
@@ -13,3 +12,6 @@ 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,10 +2,9 @@ export * from "./ErrorMessage";
 export * from "./EntityType";
 export * from "./EntityIdBase";
 export * from "./EntityId";
-export * from "./User";
 export * from "./FeedbackBase";
 export * from "./FeedbackType";
-export * from "./AppUserIdentification";
+export * from "./Feedback";
 export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
@@ -13,3 +12,6 @@ export * from "./UserData";
 export * from "./VisibilityType";
 export * from "./AppUserRequest";
 export * from "./AppUserResponse";
+export * from "./EventTriggerBase";
+export * from "./EventTriggerResponse";
+export * from "./EventTriggerType";

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

@@ -32,7 +32,7 @@ export declare class Conversation {
     protected readonly _options: Conversation.Options;
     constructor(_options: Conversation.Options);
     /**
-     * Pre-populate a new conversation with messages
+     * Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
      *
      * @param {MavenAGI.ConversationRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
@@ -47,11 +47,18 @@ export declare class Conversation {
      *             referenceId: "string"
      *         },
      *         messages: [{}],
-     *         context: {},
      *         responseConfig: {
      *             capabilities: [MavenAGI.Capability.Markdown],
      *             isCopilot: true,
      *             responseLength: MavenAGI.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"
      *         }
      *     })
      */
@@ -86,14 +93,18 @@ export declare class Conversation {
      *             conversationMessageId: {
      *                 referenceId: "string"
      *             },
+     *             userId: {
+     *                 referenceId: "string"
+     *             },
      *             text: "string",
      *             userMessageType: MavenAGI.UserConversationMessageType.User,
-     *             context: {}
+     *             createdAt: new Date("2024-01-15T09:30:00.000Z"),
+     *             updatedAt: new Date("2024-01-15T09:30:00.000Z")
      *         }])
      */
     appendNewMessages(conversationId: string, request: MavenAGI.ConversationMessageRequest[], requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Ask a question in a conversation
+     * Ask a question
      *
      * @param {string} conversationId - The ID of a new or existing conversation to use as context for the question
      * @param {MavenAGI.AskRequest} request
@@ -108,9 +119,10 @@ export declare class Conversation {
      *         conversationMessageId: {
      *             referenceId: "string"
      *         },
-     *         text: "string",
-     *         context: {},
-     *         responseConfig: {}
+     *         userId: {
+     *             referenceId: "string"
+     *         },
+     *         text: "string"
      *     })
      */
     ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -162,7 +174,7 @@ export declare class Conversation {
      *         text: "string"
      *     })
      */
-    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.Feedback>;
     /**
      * Submit a filled out action form
      *
@@ -177,16 +189,6 @@ export declare class Conversation {
      * @example
      *     await client.conversation.submitActionForm("string", {
      *         actionFormId: "string",
-     *         userContext: {
-     *             name: "string",
-     *             id: {
-     *                 "string": "string"
-     *             },
-     *             email: "string",
-     *             context: {
-     *                 "string": "string"
-     *             }
-     *         },
      *         parameters: {
      *             "string": {
      *                 "key": "value"
@@ -196,7 +198,7 @@ export declare class Conversation {
      */
     submitActionForm(conversationId: string, request: MavenAGI.SubmitActionFormRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
-     * Add metadata to an existing conversation's Context. If a metadata field already exists, it will be overwritten.
+     * Add metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
      *
      * @param {string} conversationId - The ID of a conversation the metadata being added belongs to
      * @param {Record<string, string>} request