mavenagi 1.1.0 → 1.2.3

package/api/resources/inbox/types/InboxSearchRequest.d.ts

@@ -2,17 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 import * as MavenAGI from "../../../index";
-export interface InboxSearchRequest extends MavenAGI.BaseInboxSearchRequest {
-    /** List of inbox item statuses to filter by. */
-    statuses?: MavenAGI.InboxItemStatus[];
-    /** List of inbox item types to filter by. */
-    type?: MavenAGI.InboxItemType[];
-    /** Filter for items created after this timestamp. */
-    createdAfter?: Date;
-    /** Filter for items created before this timestamp. */
-    createdBefore?: Date;
-    /** The field to sort by, defaults to created timestamp. */
-    sortId?: string;
-    /** Whether to sort descending, defaults to true. */
-    sortDesc?: boolean;
+export interface InboxSearchRequest extends MavenAGI.BasePaginatedRequest {
+    filter?: MavenAGI.InboxFilter;
 }

package/api/resources/inbox/types/InboxSearchResponse.d.ts

@@ -4,5 +4,5 @@
 import * as MavenAGI from "../../../index";
 export interface InboxSearchResponse extends MavenAGI.Page {
     /** The list of inbox items returned in the search response. */
-    content: MavenAGI.InboxItem[];
+    items: MavenAGI.InboxItem[];
 }

package/api/resources/inbox/types/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./BaseInboxSearchRequest";
+export * from "./InboxFilter";
 export * from "./InboxSearchRequest";
 export * from "./InboxSearchResponse";
-export * from "./ApplyInboxItemFixRequest";
 export * from "./AddDocumentFixRequest";
+export * from "./ApplyFixesRequest";

package/api/resources/inbox/types/index.js

@@ -14,8 +14,8 @@ 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("./BaseInboxSearchRequest"), exports);
+__exportStar(require("./InboxFilter"), exports);
 __exportStar(require("./InboxSearchRequest"), exports);
 __exportStar(require("./InboxSearchResponse"), exports);
-__exportStar(require("./ApplyInboxItemFixRequest"), exports);
 __exportStar(require("./AddDocumentFixRequest"), exports);
+__exportStar(require("./ApplyFixesRequest"), exports);

package/api/resources/index.d.ts

@@ -1,30 +1,40 @@
 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";
 export * from "./analytics/types";
 export * as appSettings from "./appSettings";
 export * from "./appSettings/types";
+export * as assets from "./assets";
+export * from "./assets/types";
 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";
 export * from "./translations/types";
 export * as triggers from "./triggers";
 export * from "./triggers/types";
-export * from "./commons/errors";
-export * as organizations from "./organizations";
 export * as users from "./users";
+export * from "./users/types";
+export * from "./commons/errors";
+export * as events from "./events";
+export * from "./actions/client/requests";
 export * from "./appSettings/client/requests";
 export * from "./conversation/client/requests";
 export * from "./inbox/client/requests";
+export * from "./knowledge/client/requests";
+export * from "./segments/client/requests";
 export * from "./triggers/client/requests";
 export * from "./users/client/requests";

package/api/resources/index.js

@@ -36,34 +36,44 @@ 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.knowledge = exports.inbox = exports.events = exports.conversation = exports.commons = 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"));
 __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"));
 __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"));
 __exportStar(require("./translations/types"), exports);
 exports.triggers = __importStar(require("./triggers"));
 __exportStar(require("./triggers/types"), exports);
-__exportStar(require("./commons/errors"), exports);
-exports.organizations = __importStar(require("./organizations"));
 exports.users = __importStar(require("./users"));
+__exportStar(require("./users/types"), exports);
+__exportStar(require("./commons/errors"), exports);
+exports.events = __importStar(require("./events"));
+__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

@@ -37,6 +37,21 @@ export declare namespace Knowledge {
 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.
      *
@@ -61,6 +76,7 @@ export declare class Knowledge {
      * 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}
@@ -70,15 +86,34 @@ export declare class Knowledge {
      * @example
      *     await client.knowledge.getKnowledgeBase("help-center")
      */
-    getKnowledgeBase(knowledgeBaseReferenceId: string, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<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.
      *
      * 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}
@@ -87,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.
@@ -124,10 +151,42 @@ export declare class Knowledge {
     finalizeKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.FinalizeKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<MavenAGI.KnowledgeBaseVersion>;
     private __finalizeKnowledgeBaseVersion;
     /**
-     * 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.
+     * 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
+     *
+     * @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 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>
      *
@@ -160,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}
@@ -171,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}
@@ -202,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>;
 }