mavenagi 1.2.0 → 1.2.3

package/reference.md

@@ -238,7 +238,7 @@ All other fields will overwrite the existing value on the action only if provide
 <dd>
 
 ```typescript
-await client.actions.patch("actionReferenceId", {});
+await client.actions.patch("actionReferenceId");
 ```
 
 </dd>
@@ -344,6 +344,191 @@ await client.actions.delete("get-balance");
 </dl>
 </details>
 
+## AgentCapabilities
+
+<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">list</a>({ ...params }) -> MavenAGI.ListAgentCapabilitiesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all capabilities for an agent.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentCapabilities.list({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.AgentCapabilityListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentCapabilities.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">get</a>(integrationId, capabilityId) -> MavenAGI.AgentCapability</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentCapabilities.get("integrationId", "capabilityId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**integrationId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**capabilityId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentCapabilities.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">patch</a>(integrationId, capabilityId, { ...params }) -> MavenAGI.AgentCapability</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentCapabilities.patch("integrationId", "capabilityId", {});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**integrationId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**capabilityId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.PatchAgentCapabilityRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AgentCapabilities.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Agents
 
 <details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
@@ -1040,6 +1225,81 @@ await client.analytics.getFeedbackTable({
 </dl>
 </details>
 
+<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getAgentUserTable</a>({ ...params }) -> MavenAGI.AgentUserTableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves structured agent user data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.analytics.getAgentUserTable({
+    agentUserFilter: {
+        search: "john",
+    },
+    columnDefinitions: [
+        {
+            header: "user_count",
+            metric: {
+                type: "count",
+            },
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.AgentUserTableRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Analytics.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## AppSettings
 
 <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
@@ -2701,7 +2961,7 @@ await client.conversation.deliverMessage({
 
 ## Events
 
-<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">create</a>({ ...params }) -> MavenAGI.EventResponse</code></summary>
 <dl>
 <dd>
 
@@ -2713,7 +2973,7 @@ await client.conversation.deliverMessage({
 <dl>
 <dd>
 
-Search events
+Create a new event
 
 </dd>
 </dl>
@@ -2729,7 +2989,18 @@ Search events
 <dd>
 
 ```typescript
-await client.events.search({});
+await client.events.create({
+    eventType: "userEvent",
+    id: {
+        referenceId: "referenceId",
+    },
+    eventName: "BUTTON_CLICKED",
+    userInfo: {
+        id: {
+            referenceId: "referenceId",
+        },
+    },
+});
 ```
 
 </dd>
@@ -2745,7 +3016,7 @@ await client.events.search({});
 <dl>
 <dd>
 
-**request:** `MavenAGI.EventsSearchRequest`
+**request:** `MavenAGI.EventRequest`
 
 </dd>
 </dl>
@@ -2764,9 +3035,7 @@ await client.events.search({});
 </dl>
 </details>
 
-## Inbox
-
-<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
 <dl>
 <dd>
 
@@ -2778,7 +3047,7 @@ await client.events.search({});
 <dl>
 <dd>
 
-Retrieve a paginated list of inbox items for an agent.
+Search events
 
 </dd>
 </dl>
@@ -2794,7 +3063,7 @@ Retrieve a paginated list of inbox items for an agent.
 <dd>
 
 ```typescript
-await client.inbox.search({});
+await client.events.search({});
 ```
 
 </dd>
@@ -2810,7 +3079,72 @@ await client.inbox.search({});
 <dl>
 <dd>
 
-**request:** `MavenAGI.InboxSearchRequest`
+**request:** `MavenAGI.EventsSearchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Events.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## Inbox
+
+<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a paginated list of inbox items for an agent.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.inbox.search({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.InboxSearchRequest`
 
 </dd>
 </dl>
@@ -3357,7 +3691,7 @@ All other fields will overwrite the existing value on the knowledge base only if
 <dd>
 
 ```typescript
-await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {});
+await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId");
 ```
 
 </dd>
@@ -3431,15 +3765,7 @@ If an existing version is in progress, then that version will be finalized in an
 
 ```typescript
 await client.knowledge.createKnowledgeBaseVersion("help-center", {
-    versionId: {
-        type: "KNOWLEDGE_BASE_VERSION",
-        referenceId: "versionId",
-        appId: "maven",
-        organizationId: "acme",
-        agentId: "support",
-    },
     type: "FULL",
-    status: "IN_PROGRESS",
 });
 ```
 
@@ -3464,7 +3790,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
 <dl>
 <dd>
 
-**request:** `MavenAGI.KnowledgeBaseVersion`
+**request:** `MavenAGI.KnowledgeBaseVersionRequest`
 
 </dd>
 </dl>
@@ -3561,6 +3887,77 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
 </dl>
 </details>
 
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">listKnowledgeBaseVersions</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersionsListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all active versions for a knowledge base. Returns the most recent versions first.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.knowledge.listKnowledgeBaseVersions("knowledgeBaseReferenceId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to list versions for. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeBaseVersionsListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Knowledge.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeDocuments</a>({ ...params }) -> MavenAGI.KnowledgeDocumentsResponse</code></summary>
 <dl>
 <dd>
@@ -3636,10 +4033,11 @@ await client.knowledge.searchKnowledgeDocuments({});
 <dl>
 <dd>
 
-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>
 </dd>
@@ -3714,7 +4112,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
 </dl>
 </details>
 
-<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">updateKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">deleteKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId, { ...params }) -> void</code></summary>
 <dl>
 <dd>
 
@@ -3726,7 +4124,8 @@ await client.knowledge.createKnowledgeDocument("help-center", {
 <dl>
 <dd>
 
-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.
 
 </dd>
 </dl>
@@ -3742,20 +4141,11 @@ Not yet implemented. Update knowledge document. Requires an existing knowledge b
 <dd>
 
 ```typescript
-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",
+        referenceId: "versionId",
     },
 });
 ```
@@ -3773,7 +4163,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
 <dl>
 <dd>
 
-**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
+**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
 
 </dd>
 </dl>
@@ -3781,7 +4171,15 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
 <dl>
 <dd>
 
-**request:** `MavenAGI.KnowledgeDocumentRequest`
+**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeDeleteRequest`
 
 </dd>
 </dl>
@@ -3800,7 +4198,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
 </dl>
 </details>
 
-<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">deleteKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId) -> void</code></summary>
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">getKnowledgeDocument</a>(knowledgeBaseVersionReferenceId, knowledgeDocumentReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
 <dl>
 <dd>
 
@@ -3812,7 +4210,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
 <dl>
 <dd>
 
-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.
 
 </dd>
 </dl>
@@ -3828,7 +4226,9 @@ Not yet implemented. Delete knowledge document. Requires an existing knowledge b
 <dd>
 
 ```typescript
-await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started");
+await client.knowledge.getKnowledgeDocument("knowledgeBaseVersionReferenceId", "knowledgeDocumentReferenceId", {
+    knowledgeBaseVersionAppId: "knowledgeBaseVersionAppId",
+});
 ```
 
 </dd>
@@ -3844,7 +4244,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
 <dl>
 <dd>
 
-**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
+**knowledgeBaseVersionReferenceId:** `string` — The reference ID of the knowledge base version that contains the document. All other entity ID fields are inferred from the request.
 
 </dd>
 </dl>
@@ -3852,7 +4252,15 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
 <dl>
 <dd>
 
-**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
+**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to get. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeDocumentGetRequest`
 
 </dd>
 </dl>
@@ -3873,6 +4281,287 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
 
 ## Organizations
 
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">create</a>(organizationReferenceId, { ...params }) -> MavenAGI.Organization</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a new organization.
+
+<Tip>
+This endpoint requires additional permissions. Contact support to request access.
+</Tip>
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.create("organizationReferenceId", {
+    name: "name",
+    defaultLanguage: "defaultLanguage",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organizationReferenceId:** `string` — The reference ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.CreateOrganizationRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Organizations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">get</a>(organizationReferenceId) -> MavenAGI.Organization</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Get an organization by ID
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.get("organizationReferenceId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organizationReferenceId:** `string` — The reference ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Organizations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">patch</a>(organizationReferenceId, { ...params }) -> MavenAGI.Organization</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update mutable organization fields.
+All fields will overwrite the existing value on the organization only if provided.
+
+<Tip>
+This endpoint requires additional permissions. Contact support to request access.
+</Tip>
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.patch("organizationReferenceId", {});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organizationReferenceId:** `string` — The reference ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.OrganizationPatchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Organizations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">delete</a>(organizationReferenceId) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Delete an organization.
+
+<Tip>
+This endpoint requires additional permissions. Contact support to request access.
+</Tip>
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizations.delete("organizationReferenceId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**organizationReferenceId:** `string` — The reference ID of the organization.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Organizations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
 <dl>
 <dd>