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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/api/resources/commons/types/AppUser.js

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

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

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

package/dist/api/resources/commons/types/AppUserIdentification.js

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

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

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

package/dist/api/resources/commons/types/AppUserIdentifyingProperty.js

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

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

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

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

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

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

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

package/dist/api/resources/commons/types/EntityId.js

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

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

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

package/dist/api/resources/commons/types/EntityIdBase.js

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

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

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

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

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

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

@@ -12,5 +12,5 @@ export interface Feedback {
     /** The type of feedback */
     type: MavenAGI.FeedbackType;
     /** The feedback text */
-    text: string;
+    text?: string;
 }

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

@@ -1,4 +1,11 @@
 export * from "./ErrorMessage";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
 export * from "./User";
 export * from "./FeedbackType";
 export * from "./Feedback";
+export * from "./AppUserIdentification";
+export * from "./AppUserIdentifyingProperty";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";

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

@@ -1,4 +1,11 @@
 export * from "./ErrorMessage";
+export * from "./EntityType";
+export * from "./EntityIdBase";
+export * from "./EntityId";
 export * from "./User";
 export * from "./FeedbackType";
 export * from "./Feedback";
+export * from "./AppUserIdentification";
+export * from "./AppUserIdentifyingProperty";
+export * from "./AppUserIdentifyingPropertyType";
+export * from "./AppUser";

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

@@ -9,8 +9,8 @@ export declare namespace Conversation {
         environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
         appId?: core.Supplier<string | undefined>;
         appSecret?: core.Supplier<string | undefined>;
-        organizationId: core.Supplier<string>;
-        agentId: core.Supplier<string>;
+        xOrganizationId: core.Supplier<string>;
+        xAgentId: core.Supplier<string>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -35,8 +35,13 @@ export declare class Conversation {
      * @example
      *     await client.conversation.initialize({
      *         messages: [{}],
+     *         context: {},
      *         id: "string",
-     *         context: {}
+     *         responseConfig: {
+     *             capabilities: [MavenAGI.Capability.Markdown],
+     *             isCopilot: true,
+     *             responseLength: MavenAGI.ResponseLength.Short
+     *         }
      *     })
      */
     initialize(request: MavenAGI.ConversationRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -89,7 +94,8 @@ export declare class Conversation {
      *     await client.conversation.ask("string", {
      *         id: "string",
      *         text: "string",
-     *         context: {}
+     *         context: {},
+     *         responseConfig: {}
      *     })
      */
     ask(conversationId: string, request: MavenAGI.AskRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
@@ -166,5 +172,22 @@ export declare class Conversation {
      *     })
      */
     submitActionForm(conversationId: string, request: MavenAGI.ActionExecutionRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ActionExecutionResponse>;
+    /**
+     * Add metadata to an existing conversation's Context. 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
+     * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.addConversationMetadata("string", {
+     *         "string": "string"
+     *     })
+     */
+    addConversationMetadata(conversationId: string, request: Record<string, string>, requestOptions?: Conversation.RequestOptions): Promise<Record<string, string>>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }