mavenagi 1.0.10 → 1.0.12

package/Client.d.ts

@@ -4,11 +4,14 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Actions } from "./api/resources/actions/client/Client";
+import { Agents } from "./api/resources/agents/client/Client";
 import { Analytics } from "./api/resources/analytics/client/Client";
 import { AppSettings } from "./api/resources/appSettings/client/Client";
 import { Conversation } from "./api/resources/conversation/client/Client";
+import { Events } from "./api/resources/events/client/Client";
 import { Inbox } from "./api/resources/inbox/client/Client";
 import { Knowledge } from "./api/resources/knowledge/client/Client";
+import { Organizations } from "./api/resources/organizations/client/Client";
 import { Realtime } from "./api/resources/realtime/client/Client";
 import { Translations } from "./api/resources/translations/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
@@ -44,22 +47,28 @@ export declare namespace MavenAGIClient {
 export declare class MavenAGIClient {
     protected readonly _options: MavenAGIClient.Options;
     protected _actions: Actions | undefined;
+    protected _agents: Agents | undefined;
     protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
     protected _conversation: Conversation | undefined;
+    protected _events: Events | undefined;
     protected _inbox: Inbox | undefined;
     protected _knowledge: Knowledge | undefined;
+    protected _organizations: Organizations | undefined;
     protected _realtime: Realtime | undefined;
     protected _translations: Translations | undefined;
     protected _triggers: Triggers | undefined;
     protected _users: Users | undefined;
     constructor(_options: MavenAGIClient.Options);
     get actions(): Actions;
+    get agents(): Agents;
     get analytics(): Analytics;
     get appSettings(): AppSettings;
     get conversation(): Conversation;
+    get events(): Events;
     get inbox(): Inbox;
     get knowledge(): Knowledge;
+    get organizations(): Organizations;
     get realtime(): Realtime;
     get translations(): Translations;
     get triggers(): Triggers;

package/Client.js

@@ -5,15 +5,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MavenAGIClient = void 0;
 const Client_1 = require("./api/resources/actions/client/Client");
-const Client_2 = require("./api/resources/analytics/client/Client");
-const Client_3 = require("./api/resources/appSettings/client/Client");
-const Client_4 = require("./api/resources/conversation/client/Client");
-const Client_5 = require("./api/resources/inbox/client/Client");
-const Client_6 = require("./api/resources/knowledge/client/Client");
-const Client_7 = require("./api/resources/realtime/client/Client");
-const Client_8 = require("./api/resources/translations/client/Client");
-const Client_9 = require("./api/resources/triggers/client/Client");
-const Client_10 = require("./api/resources/users/client/Client");
+const Client_2 = require("./api/resources/agents/client/Client");
+const Client_3 = require("./api/resources/analytics/client/Client");
+const Client_4 = require("./api/resources/appSettings/client/Client");
+const Client_5 = require("./api/resources/conversation/client/Client");
+const Client_6 = require("./api/resources/events/client/Client");
+const Client_7 = require("./api/resources/inbox/client/Client");
+const Client_8 = require("./api/resources/knowledge/client/Client");
+const Client_9 = require("./api/resources/organizations/client/Client");
+const Client_10 = require("./api/resources/realtime/client/Client");
+const Client_11 = require("./api/resources/translations/client/Client");
+const Client_12 = require("./api/resources/triggers/client/Client");
+const Client_13 = require("./api/resources/users/client/Client");
 class MavenAGIClient {
     constructor(_options) {
         this._options = _options;
@@ -22,41 +25,53 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Client_1.Actions(this._options)));
     }
+    get agents() {
+        var _a;
+        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_2.Agents(this._options)));
+    }
     get analytics() {
         var _a;
-        return ((_a = this._analytics) !== null && _a !== void 0 ? _a : (this._analytics = new Client_2.Analytics(this._options)));
+        return ((_a = this._analytics) !== null && _a !== void 0 ? _a : (this._analytics = new Client_3.Analytics(this._options)));
     }
     get appSettings() {
         var _a;
-        return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new Client_3.AppSettings(this._options)));
+        return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new Client_4.AppSettings(this._options)));
     }
     get conversation() {
         var _a;
-        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_4.Conversation(this._options)));
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_5.Conversation(this._options)));
+    }
+    get events() {
+        var _a;
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_6.Events(this._options)));
     }
     get inbox() {
         var _a;
-        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_5.Inbox(this._options)));
+        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_7.Inbox(this._options)));
     }
     get knowledge() {
         var _a;
-        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_6.Knowledge(this._options)));
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_8.Knowledge(this._options)));
+    }
+    get organizations() {
+        var _a;
+        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_9.Organizations(this._options)));
     }
     get realtime() {
         var _a;
-        return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_7.Realtime(this._options)));
+        return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_10.Realtime(this._options)));
     }
     get translations() {
         var _a;
-        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_8.Translations(this._options)));
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_11.Translations(this._options)));
     }
     get triggers() {
         var _a;
-        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_9.Triggers(this._options)));
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_12.Triggers(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_10.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_13.Users(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

package/README.md

@@ -20,7 +20,7 @@ A full reference for this library is available [here](./reference.md).
 Instantiate and use the client with the following:
 
 ```typescript
-import { MavenAGIClient } from "mavenagi";
+import { MavenAGIClient, MavenAGI } from "mavenagi";
 
 const client = new MavenAGIClient({
     appId: "YOUR_APP_ID",
@@ -28,40 +28,7 @@ const client = new MavenAGIClient({
     organizationId: "YOUR_ORGANIZATION_ID",
     agentId: "YOUR_AGENT_ID",
 });
-await client.analytics.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,
-            },
-        },
-    ],
-});
+await client.agents.search({});
 ```
 
 ## Aborting Requests
@@ -110,7 +77,7 @@ following namespace:
 ```typescript
 import { MavenAGI } from "mavenagi";
 
-const request: MavenAGI.ConversationGetRequest = {
+const request: MavenAGI.SearchAppSettingsRequest = {
     ...
 };
 ```
@@ -124,7 +91,7 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.analytics.getConversationTable(...);
+    await client.agents.search(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
@@ -141,7 +108,7 @@ try {
 If you would like to send additional headers as part of the request, use the `headers` request option.
 
 ```typescript
-const response = await client.analytics.getConversationTable(..., {
+const response = await client.agents.search(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -163,7 +130,7 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 Use the `maxRetries` request option to configure this behavior.
 
 ```typescript
-const response = await client.analytics.getConversationTable(..., {
+const response = await client.agents.search(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -173,7 +140,7 @@ const response = await client.analytics.getConversationTable(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.analytics.getConversationTable(..., {
+const response = await client.agents.search(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -184,7 +151,7 @@ The SDK allows users to abort requests at any point by passing in an abort signa
 
 ```typescript
 const controller = new AbortController();
-const response = await client.analytics.getConversationTable(..., {
+const response = await client.agents.search(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request

package/api/resources/actions/client/Client.js

@@ -98,7 +98,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, "/v1/actions"),
                 method: "PUT",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.ActionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -178,7 +178,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -257,7 +257,7 @@ class Actions {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.MavenAGIEnvironment.Production, `/v1/actions/${encodeURIComponent(actionReferenceId)}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.10", "User-Agent": "mavenagi/1.0.10", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Organization-Id": yield core.Supplier.get(this._options.organizationId), "X-Agent-Id": yield core.Supplier.get(this._options.agentId), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "mavenagi", "X-Fern-SDK-Version": "1.0.12", "User-Agent": "mavenagi/1.0.12", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

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

@@ -0,0 +1,86 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as MavenAGI from "../../../index";
+export declare namespace Agents {
+    interface Options {
+        environment?: core.Supplier<environments.MavenAGIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        appId?: core.Supplier<string | undefined>;
+        appSecret?: core.Supplier<string | undefined>;
+        /** Override the X-Organization-Id header */
+        organizationId: core.Supplier<string>;
+        /** Override the X-Agent-Id header */
+        agentId: core.Supplier<string>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the X-Organization-Id header */
+        organizationId?: string;
+        /** Override the X-Agent-Id header */
+        agentId?: string;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class Agents {
+    protected readonly _options: Agents.Options;
+    constructor(_options: Agents.Options);
+    /**
+     * Search for agents across all organizations.
+     *
+     * <Tip>
+     * This endpoint requires additional permissions. Contact support to request access.
+     * </Tip>
+     *
+     * @param {MavenAGI.AgentsSearchRequest} request
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.agents.search({})
+     */
+    search(request: MavenAGI.AgentsSearchRequest, requestOptions?: Agents.RequestOptions): Promise<MavenAGI.AgentsSearchResponse>;
+    /**
+     * Lists all agents for an organization
+     *
+     * @param {string} organizationReferenceId - The ID of the organization.
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.agents.list("organizationReferenceId")
+     */
+    list(organizationReferenceId: string, requestOptions?: Agents.RequestOptions): Promise<MavenAGI.Agent[]>;
+    /**
+     * Get an agent
+     *
+     * @param {string} organizationReferenceId - The ID of the organization.
+     * @param {string} agentReferenceId - The ID of the agent.
+     * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.agents.get("organizationReferenceId", "agentReferenceId")
+     */
+    get(organizationReferenceId: string, agentReferenceId: string, requestOptions?: Agents.RequestOptions): Promise<MavenAGI.Agent>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}