mavenagi 1.0.15 → 1.2.0

package/api/resources/index.js

@@ -36,7 +36,7 @@ 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.users = exports.organizations = exports.triggers = exports.translations = exports.realtime = exports.knowledge = exports.inbox = exports.events = exports.conversation = exports.commons = exports.appSettings = exports.analytics = exports.agents = exports.actions = void 0;
+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.actions = __importStar(require("./actions"));
 __exportStar(require("./actions/types"), exports);
 exports.agents = __importStar(require("./agents"));
@@ -45,6 +45,8 @@ exports.analytics = __importStar(require("./analytics"));
 __exportStar(require("./analytics/types"), exports);
 exports.appSettings = __importStar(require("./appSettings"));
 __exportStar(require("./appSettings/types"), exports);
+exports.assets = __importStar(require("./assets"));
+__exportStar(require("./assets/types"), exports);
 exports.commons = __importStar(require("./commons"));
 __exportStar(require("./commons/types"), exports);
 exports.conversation = __importStar(require("./conversation"));
@@ -55,17 +57,21 @@ exports.inbox = __importStar(require("./inbox"));
 __exportStar(require("./inbox/types"), exports);
 exports.knowledge = __importStar(require("./knowledge"));
 __exportStar(require("./knowledge/types"), exports);
-exports.realtime = __importStar(require("./realtime"));
-__exportStar(require("./realtime/types"), exports);
+exports.segments = __importStar(require("./segments"));
+__exportStar(require("./segments/types"), exports);
 exports.translations = __importStar(require("./translations"));
 __exportStar(require("./translations/types"), exports);
 exports.triggers = __importStar(require("./triggers"));
 __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.users = __importStar(require("./users"));
+__exportStar(require("./actions/client/requests"), exports);
 __exportStar(require("./appSettings/client/requests"), exports);
 __exportStar(require("./conversation/client/requests"), exports);
 __exportStar(require("./inbox/client/requests"), exports);
+__exportStar(require("./knowledge/client/requests"), exports);
+__exportStar(require("./segments/client/requests"), exports);
 __exportStar(require("./triggers/client/requests"), exports);
 __exportStar(require("./users/client/requests"), exports);

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

@@ -15,6 +15,8 @@ export declare namespace Knowledge {
         organizationId: core.Supplier<string>;
         /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -29,12 +31,27 @@ export declare namespace Knowledge {
         /** Override the X-Agent-Id header */
         agentId?: string;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class Knowledge {
     protected readonly _options: Knowledge.Options;
     constructor(_options: Knowledge.Options);
+    /**
+     * Search knowledge bases
+     *
+     * @param {MavenAGI.KnowledgeBaseSearchRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.searchKnowledgeBases({})
+     */
+    searchKnowledgeBases(request: MavenAGI.KnowledgeBaseSearchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBasesResponse>;
+    private __searchKnowledgeBases;
     /**
      * Update a knowledge base or create it if it doesn't exist.
      *
@@ -53,11 +70,13 @@ export declare class Knowledge {
      *         name: "Help center"
      *     })
      */
-    createOrUpdateKnowledgeBase(request: MavenAGI.KnowledgeBaseRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
+    createOrUpdateKnowledgeBase(request: MavenAGI.KnowledgeBaseRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
+    private __createOrUpdateKnowledgeBase;
     /**
      * Get an existing knowledge base by its supplied ID
      *
      * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.KnowledgeBaseGetRequest} request
      * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -67,7 +86,27 @@ export declare class Knowledge {
      * @example
      *     await client.knowledge.getKnowledgeBase("help-center")
      */
-    getKnowledgeBase(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseResponse>;
+    getKnowledgeBase(knowledgeBaseReferenceId: string, request?: MavenAGI.KnowledgeBaseGetRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
+    private __getKnowledgeBase;
+    /**
+     * Update mutable knowledge base fields
+     *
+     * The `appId` field can be provided to update a knowledge base owned by a different app.
+     * All other fields will overwrite the existing value on the knowledge base only if provided.
+     *
+     * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to patch.
+     * @param {MavenAGI.KnowledgeBasePatchRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {})
+     */
+    patchKnowledgeBase(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBasePatchRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseResponse>;
+    private __patchKnowledgeBase;
     /**
      * Create a new knowledge base version.
      *
@@ -94,7 +133,8 @@ export declare class Knowledge {
      *         status: "IN_PROGRESS"
      *     })
      */
-    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
+    createKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseVersion, 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.
      *
@@ -116,7 +156,23 @@ export declare class Knowledge {
      *         status: "SUCCEEDED"
      *     })
      */
-    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.FinalizeKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeBaseVersion>;
+    finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.FinalizeKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersion>;
+    private __finalizeKnowledgeBaseVersion;
+    /**
+     * Search knowledge documents
+     *
+     * @param {MavenAGI.KnowledgeDocumentSearchRequest} request
+     * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.knowledge.searchKnowledgeDocuments({})
+     */
+    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.
      *
@@ -151,7 +207,8 @@ export declare class Knowledge {
      *         }
      *     })
      */
-    createKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    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.
      *
@@ -181,7 +238,8 @@ export declare class Knowledge {
      *         }
      *     })
      */
-    updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): Promise<MavenAGI.KnowledgeDocumentResponse>;
+    updateKnowledgeDocument(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeDocumentRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeDocumentResponse>;
+    private __updateKnowledgeDocument;
     /**
      * 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.
      *
@@ -196,6 +254,7 @@ export declare class Knowledge {
      * @example
      *     await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
      */
-    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, requestOptions?: Knowledge.RequestOptions): Promise<void>;
+    deleteKnowledgeDocument(knowledgeBaseReferenceId: string, knowledgeDocumentReferenceId: string, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteKnowledgeDocument;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }