mavenagi 0.0.0-alpha.7 → 0.0.0-alpha.9

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

@@ -6,6 +6,8 @@ export * from "./User";
 export * from "./FeedbackType";
 export * from "./Feedback";
 export * from "./AppUserIdentification";
-export * from "./AppUserIdentifyingProperty";
+export * from "./AppUserIdentifier";
 export * from "./AppUserIdentifyingPropertyType";
 export * from "./AppUser";
+export * from "./AppUserRequest";
+export * from "./AppUserResponse";

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

@@ -34,6 +34,9 @@ export declare class Conversation {
      *
      * @example
      *     await client.conversation.initialize({
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
      *         messages: [{}],
      *         context: {},
      *         id: "string",
@@ -144,7 +147,7 @@ export declare class Conversation {
      * Submit a filled out action form
      *
      * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
-     * @param {MavenAGI.ActionExecutionRequest} request
+     * @param {MavenAGI.SubmitActionFormRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -171,7 +174,7 @@ export declare class Conversation {
      *         }
      *     })
      */
-    submitActionForm(conversationId: string, request: MavenAGI.ActionExecutionRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ActionExecutionResponse>;
+    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.
      *

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

@@ -32,6 +32,9 @@ export class Conversation {
      *
      * @example
      *     await client.conversation.initialize({
+     *         conversationId: {
+     *             referenceId: "string"
+     *         },
      *         messages: [{}],
      *         context: {},
      *         id: "string",
@@ -54,7 +57,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -142,7 +145,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -235,7 +238,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -331,7 +334,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -409,7 +412,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -511,7 +514,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -607,7 +610,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -669,7 +672,7 @@ export class Conversation {
      * Submit a filled out action form
      *
      * @param {string} conversationId - The ID of a conversation the form being submitted belongs to
-     * @param {MavenAGI.ActionExecutionRequest} request
+     * @param {MavenAGI.SubmitActionFormRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -708,18 +711,18 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
                 contentType: "application/json",
-                body: yield serializers.ActionExecutionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                body: yield serializers.SubmitActionFormRequest.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.ActionExecutionResponse.parseOrThrow(_response.body, {
+                return yield serializers.ConversationResponse.parseOrThrow(_response.body, {
                     unrecognizedObjectKeys: "passthrough",
                     allowUnrecognizedUnionMembers: true,
                     allowUnrecognizedEnumValues: true,
@@ -799,7 +802,7 @@ export class Conversation {
                     "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.7",
+                    "X-Fern-SDK-Version": "0.0.0-alpha.9",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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

@@ -3,6 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationRequest extends MavenAGI.ConversationBase {
+    /** An externally supplied ID to uniquely identify this conversation */
+    conversationId: MavenAGI.EntityIdBase;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageRequest[];
     /** The context of the conversation */

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

@@ -3,6 +3,8 @@
  */
 import * as MavenAGI from "../../../index";
 export interface ConversationResponse extends MavenAGI.ConversationBase {
+    /** The ID that uniquely identifies this conversation */
+    conversationId: MavenAGI.EntityId;
     /** The messages in the conversation */
     messages: MavenAGI.ConversationMessageResponse[];
     /** The context of the conversation */

package/dist/api/resources/conversation/types/{ActionExecutionRequest.d.ts → SubmitActionFormRequest.d.ts}

@@ -2,7 +2,7 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface ActionExecutionRequest {
+export interface SubmitActionFormRequest {
     actionFormId: string;
     userContext: MavenAGI.User;
     /** Map of parameter names to values */

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

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

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

@@ -16,8 +16,7 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
-export * from "./ActionExecutionRequest";
-export * from "./ActionExecutionResponse";
+export * from "./SubmitActionFormRequest";
 export * from "./ConversationContext";
 export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";

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

@@ -16,8 +16,7 @@ export * from "./BotResponse";
 export * from "./BotTextResponse";
 export * from "./BotActionFormResponse";
 export * from "./ActionFormField";
-export * from "./ActionExecutionRequest";
-export * from "./ActionExecutionResponse";
+export * from "./SubmitActionFormRequest";
 export * from "./ConversationContext";
 export * from "./ConversationMessageContext";
 export * from "./UserConversationMessageType";

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

@@ -23,9 +23,9 @@ export declare class Knowledge {
     protected readonly _options: Knowledge.Options;
     constructor(_options: Knowledge.Options);
     /**
-     * Create a new knowledge base.
+     * Update a knowledge base or create it if it doesn't exist.
      *
-     * @param {MavenAGI.KnowledgeBase} request
+     * @param {MavenAGI.KnowledgeBaseRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -33,18 +33,19 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBase({
-     *         displayName: "string",
-     *         type: MavenAGI.KnowledgeBaseType.Api,
-     *         url: "string",
-     *         knowledgeBaseId: "string"
+     *     await client.knowledge.createOrUpdateKnowledgeBase({
+     *         knowledgeBaseId: {
+     *             referenceId: "help-center"
+     *         },
+     *         name: "Help center",
+     *         type: MavenAGI.KnowledgeBaseType.Api
      *     })
      */
-    createKnowledgeBase(request: MavenAGI.KnowledgeBase, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    createOrUpdateKnowledgeBase(request: MavenAGI.KnowledgeBaseRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
     /**
-     * Get an existing knowledge base.
+     * Get an existing knowledge base by its supplied ID
      *
-     * @param {string} knowledgeBaseId - The ID of the knowledge base to get
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -52,12 +53,13 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.getKnowledgeBase("string")
+     *     await client.knowledge.getKnowledgeBase("help-center")
      */
-    getKnowledgeBase(knowledgeBaseId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBase>;
+    getKnowledgeBase(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
     /**
      * Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
      *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeBaseVersion} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -66,16 +68,15 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string",
+     *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
      *         type: MavenAGI.KnowledgeBaseVersionType.Full
      *     })
      */
-    createKnowledgeBaseVersion(request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
+    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
     /**
      * Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
      *
-     * @param {MavenAGI.KnowledgeBaseId} request
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -83,14 +84,13 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.finalizeKnowledgeBaseVersion({
-     *         knowledgeBaseId: "string"
-     *     })
+     *     await client.knowledge.finalizeKnowledgeBaseVersion("help-center")
      */
-    finalizeKnowledgeBaseVersion(request: MavenAGI.KnowledgeBaseId, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
     /**
      * 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 {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -99,23 +99,20 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.createKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.createKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    createKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    createKnowledgeDocument(knowledgeBaseReferenceId: string, 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.
+     * Not yet implemented. 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 {string} knowledgeBaseReferenceId - The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
      * @param {MavenAGI.KnowledgeDocumentRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -124,24 +121,21 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.updateKnowledgeDocument({
-     *         contentType: MavenAGI.KnowledgeDocumentContentType.Html,
-     *         content: "string",
-     *         title: "string",
-     *         url: "string",
-     *         language: "string",
-     *         createdAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         updatedAt: new Date("2024-01-15T09:30:00.000Z"),
-     *         author: "string",
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
+     *     await client.knowledge.updateKnowledgeDocument("help-center", {
+     *         knowledgeDocumentId: {
+     *             referenceId: "getting-started"
+     *         },
+     *         contentType: MavenAGI.KnowledgeDocumentContentType.Markdown,
+     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
+     *         title: "Getting started"
      *     })
      */
-    updateKnowledgeDocument(request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    updateKnowledgeDocument(knowledgeBaseReferenceId: string, 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.
+     * Not yet implemented. 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.
      *
-     * @param {MavenAGI.KnowledgeDocumentId} request
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -149,11 +143,8 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.deleteKnowledgeDocument({
-     *         knowledgeBaseId: "string",
-     *         documentId: "string"
-     *     })
+     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
      */
-    deleteKnowledgeDocument(request: MavenAGI.KnowledgeDocumentId, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }