mavenagi 1.0.9 → 1.0.11

package/reference.md

@@ -468,6 +468,75 @@ await client.analytics.getFeedbackTable({
 
 ## AppSettings
 
+<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Search for app settings which have the `$index` key set to the provided value.
+
+You can set the `$index` key using the Update app settings API.
+
+<Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.appSettings.search({
+    index: "index",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.SearchAppSettingsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AppSettings.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
 <dl>
 <dd>
@@ -523,9 +592,7 @@ await client.appSettings.get();
 </dl>
 </details>
 
-## Conversation
-
-<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
+<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">update</a>({ ...params }) -> Record<string, unknown></code></summary>
 <dl>
 <dd>
 
@@ -537,13 +604,95 @@ await client.appSettings.get();
 <dl>
 <dd>
 
-Initialize a new conversation. Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
+Update app settings. Performs a merge of the provided settings with the existing app settings.
+
+- If a new key is provided, it will be added to the app settings.
+- If an existing key is provided, it will be updated.
+- No keys will be removed.
+
+Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.appSettings.update({
+    string: {
+        key: "value",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Record<string, unknown>`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `AppSettings.RequestOptions`
 
 </dd>
 </dl>
 </dd>
 </dl>
 
+</dd>
+</dl>
+</details>
+
+## Conversation
+
+<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Initialize a new conversation.
+Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
+
+Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
+
+After initialization,
+
+- metadata can be changed using the `updateConversationMetadata` API.
+- messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
+  </dd>
+  </dl>
+  </dd>
+  </dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -911,6 +1060,7 @@ await client.conversation.ask("conversation-0", {
         userToken: "abcdef123",
         queryApiKey: "foobar456",
     },
+    timezone: "America/New_York",
 });
 ```
 
@@ -1013,6 +1163,7 @@ const response = await client.conversation.askStream("conversation-0", {
         userToken: "abcdef123",
         queryApiKey: "foobar456",
     },
+    timezone: "America/New_York",
 });
 for await (const item of response) {
     console.log(item);
@@ -2080,7 +2231,9 @@ await client.knowledge.getKnowledgeBase("help-center");
 <dl>
 <dd>
 
-Create a new knowledge base version. Only supported on API knowledge bases. Will throw an exception if there is an existing version in progress.
+Create a new knowledge base version.
+
+If an existing version is in progress, then that version will be finalized in an error state.
 
 </dd>
 </dl>
@@ -2097,7 +2250,15 @@ Create a new knowledge base version. Only supported on API knowledge bases. Will
 
 ```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",
 });
 ```
 
@@ -2141,7 +2302,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
 </dl>
 </details>
 
-<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">finalizeKnowledgeBaseVersion</a>(knowledgeBaseReferenceId) -> void</code></summary>
+<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">finalizeKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
 <dl>
 <dd>
 
@@ -2169,7 +2330,14 @@ Finalize the latest knowledge base version. Required to indicate the version is
 <dd>
 
 ```typescript
-await client.knowledge.finalizeKnowledgeBaseVersion("help-center");
+await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
+    versionId: {
+        type: "KNOWLEDGE_BASE_VERSION",
+        referenceId: "versionId",
+        appId: "maven",
+    },
+    status: "SUCCEEDED",
+});
 ```
 
 </dd>
@@ -2193,6 +2361,14 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center");
 <dl>
 <dd>
 
+**request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **requestOptions:** `Knowledge.RequestOptions`
 
 </dd>
@@ -2218,6 +2394,10 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center");
 
 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.
 
+<Tip>
+This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields 
+have changed, a new document version will not be created. The existing version will be reused.
+</Tip>
 </dd>
 </dl>
 </dd>
@@ -2236,9 +2416,17 @@ await client.knowledge.createKnowledgeDocument("help-center", {
     knowledgeDocumentId: {
         referenceId: "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",
+    },
 });
 ```
 
@@ -2314,9 +2502,17 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
     knowledgeDocumentId: {
         referenceId: "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",
+    },
 });
 ```
 
@@ -2431,6 +2627,186 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
 </dl>
 </details>
 
+## Organizations
+
+<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves structured conversation data across all organizations, formatted as a table,
+allowing users to group, filter, and define specific metrics to display as columns.
+
+<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.getConversationTable({
+    conversationFilter: {
+        languages: ["en", "es"],
+    },
+    timeGrouping: "DAY",
+    fieldGroupings: [
+        {
+            field: "Category",
+        },
+    ],
+    columnDefinitions: [
+        {
+            header: "count",
+            metric: {
+                type: "count",
+            },
+        },
+        {
+            header: "avg_first_response_time",
+            metric: {
+                type: "average",
+                targetField: "FirstResponseTime",
+            },
+        },
+        {
+            header: "percentile_handle_time",
+            metric: {
+                type: "percentile",
+                targetField: "HandleTime",
+                percentile: 25,
+            },
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationTableRequest`
+
+</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">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Fetches conversation data across all organizations, visualized in a chart format.
+Supported chart types include pie chart, date histogram, and stacked bar charts.
+
+<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.getConversationChart({
+    type: "pieChart",
+    conversationFilter: {
+        languages: ["en", "es"],
+    },
+    groupBy: {
+        field: "Category",
+    },
+    metric: {
+        type: "count",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.ConversationChartRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Organizations.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Translations
 
 <details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
@@ -2501,6 +2877,54 @@ await client.translations.translate({
 
 ## Triggers
 
+<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.triggers.search({});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.EventTriggersSearchRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Triggers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
 <dl>
 <dd>
@@ -2696,6 +3120,79 @@ await client.triggers.delete("store-in-snowflake");
 </dl>
 </details>
 
+<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">partialUpdate</a>(triggerReferenceId, { ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an event trigger. Only the enabled field is editable.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.triggers.partialUpdate("triggerReferenceId", {
+    body: {},
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**triggerReferenceId:** `string` — The reference ID of the event trigger to update. All other entity ID fields are inferred from the request.
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `MavenAGI.PartialUpdateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Triggers.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Users
 
 <details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>

package/serialization/resources/appSettings/client/index.d.ts

@@ -1 +1,2 @@
 export * as get from "./get";
+export * as update from "./update";

package/serialization/resources/appSettings/client/index.js

@@ -33,5 +33,6 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.get = void 0;
+exports.update = exports.get = void 0;
 exports.get = __importStar(require("./get"));
+exports.update = __importStar(require("./update"));

package/serialization/resources/appSettings/client/update.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../index";
+import * as core from "../../../../core";
+export declare const Request: core.serialization.Schema<serializers.appSettings.update.Request.Raw, Record<string, unknown>>;
+export declare namespace Request {
+    type Raw = Record<string, unknown>;
+}
+export declare const Response: core.serialization.Schema<serializers.appSettings.update.Response.Raw, Record<string, unknown>>;
+export declare namespace Response {
+    type Raw = Record<string, unknown>;
+}

package/serialization/resources/appSettings/client/update.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * 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);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Response = exports.Request = void 0;
+const core = __importStar(require("../../../../core"));
+exports.Request = core.serialization.record(core.serialization.string(), core.serialization.unknown());
+exports.Response = core.serialization.record(core.serialization.string(), core.serialization.unknown());

package/serialization/resources/appSettings/index.d.ts

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

package/serialization/resources/appSettings/index.js

@@ -14,4 +14,5 @@ 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);