npm - mavenagi - Versions diffs - 0.0.0-alpha.2 → 0.0.0-alpha.3 - Mend

mavenagi 0.0.0-alpha.2 → 0.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (274) hide show

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

@@ -28,14 +28,12 @@ export declare class Conversation {
      * @param {MavenAGI.ConversationRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.ConversationAlreadyExistsError}
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.EmptyConversationError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.initialize({
+     *     await client.conversation.initialize({
      *         messages: [{}],
      *         id: "string",
      *         context: {}
@@ -45,14 +43,15 @@ export declare class Conversation {
     /**
      * Get a conversation
      *
-     * @param {string} conversationId - The ID of a conversation to get
+     * @param {string} conversationId - The ID of the conversation to get
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.get("string")
+     *     await client.conversation.get("string")
      */
     get(conversationId: string, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ConversationResponse>;
     /**
@@ -62,12 +61,12 @@ export declare class Conversation {
      * @param {MavenAGI.ConversationMessageRequest[]} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.appendNewMessages("string", [{
+     *     await client.conversation.appendNewMessages("string", [{
      *             text: "string",
      *             userMessageType: MavenAGI.UserConversationMessageType.User,
      *             id: "string",
@@ -82,11 +81,12 @@ export declare class Conversation {
      * @param {MavenAGI.AskRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.ask("string", {
+     *     await client.conversation.ask("string", {
      *         id: "string",
      *         text: "string",
      *         context: {}
@@ -104,14 +104,12 @@ export declare class Conversation {
      * @param {MavenAGI.GenerateMavenSuggestionsRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidConversationIdError}
-     * @throws {@link MavenAGI.ConversationNotFoundError}
-     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
-     * @throws {@link MavenAGI.InvalidConversationMessageIdError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.generateMavenSuggestions("string", {
+     *     await client.conversation.generateMavenSuggestions("string", {
      *         messageIds: ["string"]
      *     })
      */
@@ -122,17 +120,51 @@ export declare class Conversation {
      * @param {MavenAGI.FeedbackRequest} request
      * @param {Conversation.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link MavenAGI.InvalidFeedbackTypeError}
-     * @throws {@link MavenAGI.ConversationMessageNotFoundError}
-     * @throws {@link MavenAGI.AgentNotFoundError}
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await mavenAgi.conversation.createFeedback({
+     *     await client.conversation.createFeedback({
+     *         id: "string",
+     *         conversationId: "string",
      *         conversationMessageId: "string",
-     *         text: "string",
-     *         type: MavenAGI.FeedbackType.ThumbsUp
+     *         type: MavenAGI.FeedbackType.ThumbsUp,
+     *         text: "string"
      *     })
      */
     createFeedback(request: MavenAGI.FeedbackRequest, requestOptions?: Conversation.RequestOptions): Promise<void>;
+    /**
+     * 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 {Conversation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.conversation.submitActionForm("string", {
+     *         actionFormId: "string",
+     *         userContext: {
+     *             name: "string",
+     *             id: {
+     *                 "string": "string"
+     *             },
+     *             email: "string",
+     *             context: {
+     *                 "string": "string"
+     *             }
+     *         },
+     *         parameters: {
+     *             "string": {
+     *                 "key": "value"
+     *             }
+     *         }
+     *     })
+     */
+    submitActionForm(conversationId: string, request: MavenAGI.ActionExecutionRequest, requestOptions?: Conversation.RequestOptions): Promise<MavenAGI.ActionExecutionResponse>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }