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

package/dist/api/resources/conversation/client/Client.js

@@ -33,8 +33,13 @@ export 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, requestOptions) {
@@ -45,11 +50,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -133,11 +138,11 @@ export class Conversation {
                 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,
                 },
@@ -226,11 +231,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -310,7 +315,8 @@ export class Conversation {
      *     await client.conversation.ask("string", {
      *         id: "string",
      *         text: "string",
-     *         context: {}
+     *         context: {},
+     *         responseConfig: {}
      *     })
      */
     ask(conversationId, request, requestOptions) {
@@ -321,11 +327,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -399,11 +405,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -501,11 +507,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -597,11 +603,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -698,11 +704,11 @@ export class Conversation {
                 method: "POST",
                 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,
                 },
@@ -765,6 +771,99 @@ export class Conversation {
             }
         });
     }
+    /**
+     * 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, 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/conversations/${encodeURIComponent(conversationId)}/metadata`),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "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.5",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.conversation.addConversationMetadata.Request.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.conversation.addConversationMetadata.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(yield 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, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 500:
+                        throw new MavenAGI.ServerError(yield 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* () {

package/dist/api/resources/conversation/types/AskRequest.d.ts

@@ -9,4 +9,6 @@ export interface AskRequest {
     text: string;
     /** The context of the message */
     context?: MavenAGI.ConversationMessageContext;
+    /** Optional configuration for responses to this conversation. Only applies to new conversations. */
+    responseConfig?: MavenAGI.ResponseConfig;
 }

package/dist/api/resources/conversation/types/Capability.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type Capability = "MARKDOWN" | "FORMS";
+export declare const Capability: {
+    readonly Markdown: "MARKDOWN";
+    readonly Forms: "FORMS";
+};

package/dist/api/resources/conversation/types/Capability.js

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const Capability = {
+    Markdown: "MARKDOWN",
+    Forms: "FORMS",
+};

package/dist/api/resources/conversation/types/ConversationBase.d.ts

@@ -5,6 +5,6 @@ import * as MavenAGI from "../../../index";
 export interface ConversationBase {
     /** Externally supplied ID to uniquely identify this conversation */
     id: string;
-    /** The context of the conversation */
-    context?: MavenAGI.ConversationContext;
+    /** Optional configurations for responses to this conversation */
+    responseConfig?: MavenAGI.ResponseConfig;
 }

package/dist/api/resources/conversation/types/ConversationRequest.d.ts

@@ -5,4 +5,6 @@ import * as MavenAGI from "../../../index";
 export interface ConversationRequest extends MavenAGI.ConversationBase {
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];
+    /** The context of the conversation */
+    context?: MavenAGI.ConversationContext;
 }

package/dist/api/resources/conversation/types/ConversationResponse.d.ts

@@ -5,4 +5,6 @@ import * as MavenAGI from "../../../index";
 export interface ConversationResponse extends MavenAGI.ConversationBase {
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageResponse[];
+    /** The context of the conversation */
+    context: MavenAGI.ConversationContext;
 }

package/dist/api/resources/conversation/types/ResponseConfig.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface ResponseConfig {
+    /** List of capabilities supported by the caller. Defaults to all */
+    capabilities?: MavenAGI.Capability[];
+    /** Whether the response is for an human agent (true) or an end user (false). Defaults to false. */
+    isCopilot?: boolean;
+    /** The desired response length. Defaults to ResponseLength.MEDIUM. */
+    responseLength?: MavenAGI.ResponseLength;
+}

package/dist/api/resources/conversation/types/ResponseConfig.js

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

package/dist/api/resources/conversation/types/ResponseLength.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ResponseLength = "SHORT" | "MEDIUM" | "LONG";
+export declare const ResponseLength: {
+    readonly Short: "SHORT";
+    readonly Medium: "MEDIUM";
+    readonly Long: "LONG";
+};

package/dist/api/resources/conversation/types/ResponseLength.js

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const ResponseLength = {
+    Short: "SHORT",
+    Medium: "MEDIUM",
+    Long: "LONG",
+};

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

@@ -1,4 +1,7 @@
 export * from "./AskRequest";
+export * from "./ResponseConfig";
+export * from "./Capability";
+export * from "./ResponseLength";
 export * from "./GenerateMavenSuggestionsRequest";
 export * from "./ConversationBase";
 export * from "./ConversationResponse";

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

@@ -1,4 +1,7 @@
 export * from "./AskRequest";
+export * from "./ResponseConfig";
+export * from "./Capability";
+export * from "./ResponseLength";
 export * from "./GenerateMavenSuggestionsRequest";
 export * from "./ConversationBase";
 export * from "./ConversationResponse";

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

@@ -1,11 +1,12 @@
-export * as actionSet from "./actionSet";
-export * from "./actionSet/types";
-export * as action from "./action";
-export * from "./action/types";
+export * as actions from "./actions";
+export * from "./actions/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
 export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
+export * as triggers from "./triggers";
+export * from "./triggers/types";
 export * from "./commons/errors";
+export * as users from "./users";

package/dist/api/resources/index.js

@@ -1,11 +1,12 @@
-export * as actionSet from "./actionSet";
-export * from "./actionSet/types";
-export * as action from "./action";
-export * from "./action/types";
+export * as actions from "./actions";
+export * from "./actions/types";
 export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
 export * from "./conversation/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
+export * as triggers from "./triggers";
+export * from "./triggers/types";
 export * from "./commons/errors";
+export * as users from "./users";

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

@@ -9,8 +9,8 @@ export declare namespace Knowledge {
         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 {
@@ -41,6 +41,20 @@ export declare class Knowledge {
      *     })
      */
     createKnowledgeBase(request: MavenAGI.KnowledgeBase, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    /**
+     * Get an existing knowledge base.
+     *
+     * @param {string} knowledgeBaseId - The ID of the knowledge base to get
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.getKnowledgeBase("string")
+     */
+    getKnowledgeBase(knowledgeBaseId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
     /**
      * Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
      *
@@ -77,7 +91,7 @@ export declare class Knowledge {
     /**
      * Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
      *
-     * @param {MavenAGI.KnowledgeDocument} request
+     * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -86,8 +100,9 @@ export declare class Knowledge {
      *
      * @example
      *     await client.knowledge.createKnowledgeDocument({
-     *         title: "string",
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
      *         content: "string",
+     *         title: "string",
      *         url: "string",
      *         language: "string",
      *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
@@ -97,11 +112,11 @@ export declare class Knowledge {
      *         documentId: "string"
      *     })
      */
-    createKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    createKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
      * Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
      *
-     * @param {MavenAGI.KnowledgeDocument} request
+     * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -110,8 +125,9 @@ export declare class Knowledge {
      *
      * @example
      *     await client.knowledge.updateKnowledgeDocument({
-     *         title: "string",
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
      *         content: "string",
+     *         title: "string",
      *         url: "string",
      *         language: "string",
      *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
@@ -121,7 +137,7 @@ export declare class Knowledge {
      *         documentId: "string"
      *     })
      */
-    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocument, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocument>;
+    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
     /**
      * Delete knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
      *