mavenagi 1.2.0 → 1.2.3

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

@@ -19,12 +19,15 @@ __exportStar(require("./GenerateMavenSuggestionsRequest"), exports);
 __exportStar(require("./ConversationRequest"), exports);
 __exportStar(require("./ConversationMessageRequest"), exports);
 __exportStar(require("./SubmitActionFormRequest"), exports);
+__exportStar(require("./ActionFormRequestParamValue"), exports);
+__exportStar(require("./ActionFormAttachment"), exports);
 __exportStar(require("./FeedbackRequest"), exports);
 __exportStar(require("./AskObjectRequest"), exports);
 __exportStar(require("./StreamResponse"), exports);
 __exportStar(require("./ObjectStreamResponse"), exports);
 __exportStar(require("./AskStreamTextEvent"), exports);
 __exportStar(require("./AskStreamActionEvent"), exports);
+__exportStar(require("./AskStreamOAuthButtonEvent"), exports);
 __exportStar(require("./AskStreamChartEvent"), exports);
 __exportStar(require("./AskStreamMetadataEvent"), exports);
 __exportStar(require("./AskStreamStartEvent"), exports);

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

@@ -37,6 +37,32 @@ export declare namespace Events {
 export declare class Events {
     protected readonly _options: Events.Options;
     constructor(_options: Events.Options);
+    /**
+     * Create a new event
+     *
+     * @param {MavenAGI.EventRequest} request
+     * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.events.create({
+     *         eventType: "userEvent",
+     *         id: {
+     *             referenceId: "referenceId"
+     *         },
+     *         eventName: "BUTTON_CLICKED",
+     *         userInfo: {
+     *             id: {
+     *                 referenceId: "referenceId"
+     *             }
+     *         }
+     *     })
+     */
+    create(request: MavenAGI.EventRequest, requestOptions?: Events.RequestOptions): core.HttpResponsePromise<MavenAGI.EventResponse>;
+    private __create;
     /**
      * Search events
      *

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

@@ -56,6 +56,110 @@ class Events {
     constructor(_options) {
         this._options = _options;
     }
+    /**
+     * Create a new event
+     *
+     * @param {MavenAGI.EventRequest} request
+     * @param {Events.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.events.create({
+     *         eventType: "userEvent",
+     *         id: {
+     *             referenceId: "referenceId"
+     *         },
+     *         eventName: "BUTTON_CLICKED",
+     *         userInfo: {
+     *             id: {
+     *                 referenceId: "referenceId"
+     *             }
+     *         }
+     *     })
+     */
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    __create(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/events"),
+                method: "POST",
+                headers: (0, headers_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Organization-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId,
+                    "X-Agent-Id": requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId,
+                }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.EventRequest.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 {
+                    data: serializers.EventResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            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"],
+                        }), _response.rawResponse);
+                    case 400:
+                        throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.MavenAGIError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.MavenAGIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/events.");
+                case "unknown":
+                    throw new errors.MavenAGIError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * Search events
      *

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

@@ -1,2 +1 @@
-export * from "./types";
 export * from "./client";

package/dist/api/resources/events/index.js

@@ -14,5 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./types"), exports);
 __exportStar(require("./client"), exports);

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

@@ -1,5 +1,7 @@
 export * as actions from "./actions";
 export * from "./actions/types";
+export * as agentCapabilities from "./agentCapabilities";
+export * from "./agentCapabilities/types";
 export * as agents from "./agents";
 export * from "./agents/types";
 export * as analytics from "./analytics";
@@ -12,12 +14,12 @@ export * as commons from "./commons";
 export * from "./commons/types";
 export * as conversation from "./conversation";
 export * from "./conversation/types";
-export * as events from "./events";
-export * from "./events/types";
 export * as inbox from "./inbox";
 export * from "./inbox/types";
 export * as knowledge from "./knowledge";
 export * from "./knowledge/types";
+export * as organizations from "./organizations";
+export * from "./organizations/types";
 export * as segments from "./segments";
 export * from "./segments/types";
 export * as translations from "./translations";
@@ -27,7 +29,7 @@ export * from "./triggers/types";
 export * as users from "./users";
 export * from "./users/types";
 export * from "./commons/errors";
-export * as organizations from "./organizations";
+export * as events from "./events";
 export * from "./actions/client/requests";
 export * from "./appSettings/client/requests";
 export * from "./conversation/client/requests";

package/dist/api/resources/index.js

@@ -36,9 +36,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.organizations = exports.users = exports.triggers = exports.translations = exports.segments = exports.knowledge = exports.inbox = exports.events = exports.conversation = exports.commons = exports.assets = exports.appSettings = exports.analytics = exports.agents = exports.actions = void 0;
+exports.events = exports.users = exports.triggers = exports.translations = exports.segments = exports.organizations = exports.knowledge = exports.inbox = exports.conversation = exports.commons = exports.assets = exports.appSettings = exports.analytics = exports.agents = exports.agentCapabilities = exports.actions = void 0;
 exports.actions = __importStar(require("./actions"));
 __exportStar(require("./actions/types"), exports);
+exports.agentCapabilities = __importStar(require("./agentCapabilities"));
+__exportStar(require("./agentCapabilities/types"), exports);
 exports.agents = __importStar(require("./agents"));
 __exportStar(require("./agents/types"), exports);
 exports.analytics = __importStar(require("./analytics"));
@@ -51,12 +53,12 @@ exports.commons = __importStar(require("./commons"));
 __exportStar(require("./commons/types"), exports);
 exports.conversation = __importStar(require("./conversation"));
 __exportStar(require("./conversation/types"), exports);
-exports.events = __importStar(require("./events"));
-__exportStar(require("./events/types"), exports);
 exports.inbox = __importStar(require("./inbox"));
 __exportStar(require("./inbox/types"), exports);
 exports.knowledge = __importStar(require("./knowledge"));
 __exportStar(require("./knowledge/types"), exports);
+exports.organizations = __importStar(require("./organizations"));
+__exportStar(require("./organizations/types"), exports);
 exports.segments = __importStar(require("./segments"));
 __exportStar(require("./segments/types"), exports);
 exports.translations = __importStar(require("./translations"));
@@ -66,7 +68,7 @@ __exportStar(require("./triggers/types"), exports);
 exports.users = __importStar(require("./users"));
 __exportStar(require("./users/types"), exports);
 __exportStar(require("./commons/errors"), exports);
-exports.organizations = __importStar(require("./organizations"));
+exports.events = __importStar(require("./events"));
 __exportStar(require("./actions/client/requests"), exports);
 __exportStar(require("./appSettings/client/requests"), exports);
 __exportStar(require("./conversation/client/requests"), exports);

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

@@ -103,9 +103,9 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {})
+     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId")
      */
-    patchKnowledgeBase(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBasePatchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
+    patchKnowledgeBase(knowledgeBaseReferenceId: string, request?: MavenAGI.KnowledgeBasePatchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
     private __patchKnowledgeBase;
     /**
      * Create a new knowledge base version.
@@ -113,7 +113,7 @@ export declare class Knowledge {
      * If an existing version is in progress, then that version will be finalized in an error state.
      *
      * @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 {MavenAGI.KnowledgeBaseVersionRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -122,18 +122,10 @@ export declare class Knowledge {
      *
      * @example
      *     await client.knowledge.createKnowledgeBaseVersion("help-center", {
-     *         versionId: {
-     *             type: "KNOWLEDGE_BASE_VERSION",
-     *             referenceId: "versionId",
-     *             appId: "maven",
-     *             organizationId: "acme",
-     *             agentId: "support"
-     *         },
-     *         type: "FULL",
-     *         status: "IN_PROGRESS"
+     *         type: "FULL"
      *     })
      */
-    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersion>;
+    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersion>;
     private __createKnowledgeBaseVersion;
     /**
      * 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.
@@ -158,6 +150,22 @@ export declare class Knowledge {
      */
     finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.FinalizeKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersion>;
     private __finalizeKnowledgeBaseVersion;
+    /**
+     * List all active versions for a knowledge base. Returns the most recent versions first.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to list versions for. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeBaseVersionsListRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId")
+     */
+    listKnowledgeBaseVersions(knowledgeBaseReferenceId: string, request?: MavenAGI.KnowledgeBaseVersionsListRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersionsListResponse>;
+    private __listKnowledgeBaseVersions;
     /**
      * Search knowledge documents
      *
@@ -174,10 +182,11 @@ export declare class Knowledge {
     searchKnowledgeDocuments(request: MavenAGI.KnowledgeDocumentSearchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentsResponse>;
     private __searchKnowledgeDocuments;
     /**
-     * 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.
+     * Create or update a knowledge document. Requires an existing knowledge base with an in progress version.
+     * Will throw an exception if the latest version is not in progress.
      *
      * <Tip>
-     * This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
+     * This API maintains document version history. If for the same reference ID none of the `title`, `text`, `sourceUrl`, `metadata` fields
      * have changed, a new document version will not be created. The existing version will be reused.
      * </Tip>
      *
@@ -210,10 +219,12 @@ export declare class Knowledge {
     createKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
     private __createKnowledgeDocument;
     /**
-     * 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.
+     * Delete knowledge document from a specific version.
+     * Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the 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 {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 {MavenAGI.KnowledgeDeleteRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -221,30 +232,22 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.updateKnowledgeDocument("help-center", {
-     *         knowledgeDocumentId: {
-     *             referenceId: "getting-started"
-     *         },
+     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started", {
      *         versionId: {
      *             type: "KNOWLEDGE_BASE_VERSION",
-     *             referenceId: "versionId",
-     *             appId: "maven"
-     *         },
-     *         contentType: "MARKDOWN",
-     *         content: "## Getting started\\nThis is a getting started guide for the help center.",
-     *         title: "Getting started",
-     *         metadata: {
-     *             "category": "getting-started"
+     *             appId: "maven",
+     *             referenceId: "versionId"
      *         }
      *     })
      */
-    updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
-    private __updateKnowledgeDocument;
+    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, request: MavenAGI.KnowledgeDeleteRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteKnowledgeDocument;
     /**
-     * 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.
+     * Get a knowledge document by its supplied version and document IDs. Response includes document content in markdown format.
      *
-     * @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 {string} knowledgeBaseVersionReferenceId - The reference ID of the knowledge base version that contains the document. All other entity ID fields are inferred from the request.
+     * @param {string} knowledgeDocumentReferenceId - The reference ID of the knowledge document to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeDocumentGetRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -252,9 +255,11 @@ export declare class Knowledge {
      * @throws {@link MavenAGI.ServerError}
      *
      * @example
-     *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
+     *     await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "knowledgeDocumentReferenceId", {
+     *         knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId"
+     *     })
      */
-    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
-    private __deleteKnowledgeDocument;
+    getKnowledgeDocument(knowledgeBaseVersionReferenceId: string, knowledgeDocumentReferenceId: string, request: MavenAGI.KnowledgeDocumentGetRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
+    private __getKnowledgeDocument;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }