mavenagi 1.2.3 → 1.2.5

package/reference.md

@@ -238,7 +238,17 @@ 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("get-balance", {
+    instructions: "Use this action when the user asks about their account balance or remaining credits.",
+    llmInclusionStatus: "WHEN_RELEVANT",
+    segmentId: {
+        referenceId: "premium-users",
+        appId: "my-billing-system",
+        organizationId: "acme",
+        agentId: "support",
+        type: "SEGMENT",
+    },
+});
 ```
 
 </dd>
@@ -529,6 +539,85 @@ await client.agentCapabilities.patch("integrationId", "capabilityId", {});
 </dl>
 </details>
 
+<details><summary><code>client.agentCapabilities.<a href="/src/api/resources/agentCapabilities/client/Client.ts">execute</a>(integrationId, capabilityId, { ...params }) -> MavenAGI.ExecuteCapabilityResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Execute an action capability.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.agentCapabilities.execute("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.ExecuteCapabilityRequest`
+
+</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>
@@ -848,7 +937,7 @@ This endpoint requires additional permissions. Contact support to request access
 <dd>
 
 ```typescript
-await client.agents.patch("organizationReferenceId", "agentReferenceId", {});
+await client.agents.patch("organizationReferenceId", "agentReferenceId");
 ```
 
 </dd>
@@ -1900,6 +1989,9 @@ Wipes a conversation of all user data.
 The conversation ID will still exist and non-user specific data will still be retained.
 Attempts to modify or add messages to the conversation will throw an error.
 
+Simulation conversations will no longer be visible in search results nor metrics.
+Non-simulation conversations will remain visible - they can not be fully removed from the system.
+
 <Warning>This is a destructive operation and cannot be undone. <br/><br/>
 The exact fields cleared include: the conversation subject, userRequest, agentResponse.
 As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
@@ -2260,86 +2352,6 @@ for await (const item of response) {
 </dl>
 </details>
 
-<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">generateMavenSuggestions</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.conversation.generateMavenSuggestions("conversationId", {
-    conversationMessageIds: [
-        {
-            referenceId: "referenceId",
-        },
-        {
-            referenceId: "referenceId",
-        },
-    ],
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**conversationId:** `string` — The ID of a conversation the messages belong to
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `MavenAGI.GenerateMavenSuggestionsRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Conversation.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askObjectStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.ObjectStreamResponse></code></summary>
 <dl>
 <dd>
@@ -2589,7 +2601,11 @@ await client.conversation.createFeedback({
 <dl>
 <dd>
 
-Submit a filled out action form
+Submit a filled out action form.
+Action forms can not be submitted more than once, attempting to do so will result in an error.
+
+Additionally, form submission is only allowed when the form is the last message in the conversation.
+Forms should be disabled in surface UI if a conversation continues and they remain unsubmitted.
 
 </dd>
 </dl>
@@ -2875,6 +2891,74 @@ await client.conversation.search({});
 </dl>
 </details>
 
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Export conversations to a CSV file.
+
+This will output a summary of each conversation that matches the supplied filter. A maximum of 10,000 conversations can be exported at a time.
+
+For most use cases it is recommended to use the `search` API instead and convert the JSON response to your desired format.
+The CSV format may change over time and should not be relied upon by code consumers.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.conversation.export({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationsSearchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Conversation.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">deliverMessage</a>({ ...params }) -> MavenAGI.DeliverMessageResponse</code></summary>
 <dl>
 <dd>
@@ -3098,6 +3182,144 @@ await client.events.search({});
 </dl>
 </details>
 
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">get</a>(eventId, { ...params }) -> MavenAGI.EventResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve details of a specific Event item by its ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.get("eventId", {
+    appId: "appId",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**eventId:** `string` — The ID of the Event to get.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.EventGetRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Events.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">export</a>({ ...params }) -> core.BinaryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Export events to a CSV file.
+
+This will output a summary of each event that matches the supplied filter. A maximum of 10,000 events can be exported at a time. For most use cases it is recommended to use the search API instead and convert the JSON response to your desired format. The CSV format may change over time and should not be relied upon by code consumers.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.events.export({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**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>
@@ -3660,6 +3882,82 @@ await client.knowledge.getKnowledgeBase("help-center");
 </dl>
 </details>
 
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">refreshKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> void</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Request that a knowledge base refresh itself.
+
+Knowledge bases refresh on a schedule determined by the `refreshFrequency` field.
+They can also be refreshed on demand by calling this endpoint.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.knowledge.refreshKnowledgeBase("help-center", {
+    appId: "readme",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to refresh. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.KnowledgeBaseRefreshRequest`
+
+</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">patchKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
 <dl>
 <dd>
@@ -3691,7 +3989,17 @@ 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("help-center", {
+    name: "Updated Help Center",
+    tags: new Set(["tag1", "tag2", "tag3"]),
+    segmentId: {
+        referenceId: "premium-users",
+        appId: "readme",
+        organizationId: "acme",
+        agentId: "support",
+        type: "SEGMENT",
+    },
+});
 ```
 
 </dd>
@@ -5470,7 +5778,7 @@ await client.users.search({});
 </dl>
 </details>
 
-<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAgentUser</a>(userId) -> MavenAGI.AgentUser</code></summary>
+<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAgentUser</a>(agentUserId) -> MavenAGI.AgentUser</code></summary>
 <dl>
 <dd>
 
@@ -5500,7 +5808,7 @@ Agent users are a merged view of the users created by individual apps.
 <dd>
 
 ```typescript
-await client.users.getAgentUser("userId");
+await client.users.getAgentUser("aus_1234567890");
 ```
 
 </dd>
@@ -5516,7 +5824,7 @@ await client.users.getAgentUser("userId");
 <dl>
 <dd>
 
-**userId:** `string` — The ID of the agent user to get.
+**agentUserId:** `string` — The ID of the agent user to get.
 
 </dd>
 </dl>

package/serialization/resources/actions/client/requests/ActionPatchRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../../index";
 import * as MavenAGI from "../../../../../api/index";
 import * as core from "../../../../../core";
@@ -12,6 +9,6 @@ export declare namespace ActionPatchRequest {
         appId?: string | null;
         instructions?: string | null;
         llmInclusionStatus?: LlmInclusionStatus.Raw | null;
-        segmentId?: (EntityId.Raw | null) | null;
+        segmentId?: (EntityId.Raw | null | undefined) | null;
     }
 }

package/serialization/resources/actions/client/requests/ActionPatchRequest.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/serialization/resources/actions/types/ActionField.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";

package/serialization/resources/actions/types/ActionField.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/serialization/resources/actions/types/ActionFilter.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";
@@ -9,6 +6,7 @@ export declare const ActionFilter: core.serialization.ObjectSchema<serializers.A
 export declare namespace ActionFilter {
     interface Raw {
         instructions?: string | null;
+        name?: string | null;
         llmInclusionStatuses?: LlmInclusionStatus.Raw[] | null;
         appIds?: string[] | null;
         userInteractionRequired?: boolean | null;

package/serialization/resources/actions/types/ActionFilter.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -41,6 +39,7 @@ const core = __importStar(require("../../../../core"));
 const LlmInclusionStatus_1 = require("../../commons/types/LlmInclusionStatus");
 exports.ActionFilter = core.serialization.object({
     instructions: core.serialization.string().optional(),
+    name: core.serialization.string().optional(),
     llmInclusionStatuses: core.serialization.list(LlmInclusionStatus_1.LlmInclusionStatus).optional(),
     appIds: core.serialization.list(core.serialization.string()).optional(),
     userInteractionRequired: core.serialization.boolean().optional(),

package/serialization/resources/actions/types/ActionRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";

package/serialization/resources/actions/types/ActionRequest.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/serialization/resources/actions/types/ActionsResponse.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";

package/serialization/resources/actions/types/ActionsResponse.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/serialization/resources/actions/types/ActionsSearchRequest.d.ts

@@ -1,6 +1,3 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
 import * as serializers from "../../../index";
 import * as MavenAGI from "../../../../api/index";
 import * as core from "../../../../core";

package/serialization/resources/actions/types/ActionsSearchRequest.js

@@ -1,7 +1,5 @@
 "use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
+// This file was auto-generated by Fern from our API Definition.
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);