mavenagi 1.0.15 → 1.2.0

package/Client.d.ts

@@ -7,12 +7,13 @@ 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 { Assets } from "./api/resources/assets/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 { Segments } from "./api/resources/segments/client/Client";
 import { Translations } from "./api/resources/translations/client/Client";
 import { Triggers } from "./api/resources/triggers/client/Client";
 import { Users } from "./api/resources/users/client/Client";
@@ -27,6 +28,8 @@ export declare namespace MavenAGIClient {
         organizationId: core.Supplier<string>;
         /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -41,7 +44,7 @@ export declare namespace MavenAGIClient {
         /** Override the X-Agent-Id header */
         agentId?: string;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class MavenAGIClient {
@@ -50,12 +53,13 @@ export declare class MavenAGIClient {
     protected _agents: Agents | undefined;
     protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
+    protected _assets: Assets | 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 _segments: Segments | undefined;
     protected _translations: Translations | undefined;
     protected _triggers: Triggers | undefined;
     protected _users: Users | undefined;
@@ -64,12 +68,13 @@ export declare class MavenAGIClient {
     get agents(): Agents;
     get analytics(): Analytics;
     get appSettings(): AppSettings;
+    get assets(): Assets;
     get conversation(): Conversation;
     get events(): Events;
     get inbox(): Inbox;
     get knowledge(): Knowledge;
     get organizations(): Organizations;
-    get realtime(): Realtime;
+    get segments(): Segments;
     get translations(): Translations;
     get triggers(): Triggers;
     get users(): Users;

package/Client.js

@@ -2,24 +2,69 @@
 /**
  * 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.MavenAGIClient = void 0;
+const core = __importStar(require("./core"));
+const headers_1 = require("./core/headers");
 const Client_1 = require("./api/resources/actions/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");
+const Client_5 = require("./api/resources/assets/client/Client");
+const Client_6 = require("./api/resources/conversation/client/Client");
+const Client_7 = require("./api/resources/events/client/Client");
+const Client_8 = require("./api/resources/inbox/client/Client");
+const Client_9 = require("./api/resources/knowledge/client/Client");
+const Client_10 = require("./api/resources/organizations/client/Client");
+const Client_11 = require("./api/resources/segments/client/Client");
+const Client_12 = require("./api/resources/translations/client/Client");
+const Client_13 = require("./api/resources/triggers/client/Client");
+const Client_14 = require("./api/resources/users/client/Client");
 class MavenAGIClient {
     constructor(_options) {
-        this._options = _options;
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_1.mergeHeaders)({
+                "X-Organization-Id": _options === null || _options === void 0 ? void 0 : _options.organizationId,
+                "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "mavenagi",
+                "X-Fern-SDK-Version": "1.2.0",
+                "User-Agent": "mavenagi/1.2.0",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
     }
     get actions() {
         var _a;
@@ -37,41 +82,45 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._appSettings) !== null && _a !== void 0 ? _a : (this._appSettings = new Client_4.AppSettings(this._options)));
     }
+    get assets() {
+        var _a;
+        return ((_a = this._assets) !== null && _a !== void 0 ? _a : (this._assets = new Client_5.Assets(this._options)));
+    }
     get conversation() {
         var _a;
-        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_5.Conversation(this._options)));
+        return ((_a = this._conversation) !== null && _a !== void 0 ? _a : (this._conversation = new Client_6.Conversation(this._options)));
     }
     get events() {
         var _a;
-        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_6.Events(this._options)));
+        return ((_a = this._events) !== null && _a !== void 0 ? _a : (this._events = new Client_7.Events(this._options)));
     }
     get inbox() {
         var _a;
-        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_7.Inbox(this._options)));
+        return ((_a = this._inbox) !== null && _a !== void 0 ? _a : (this._inbox = new Client_8.Inbox(this._options)));
     }
     get knowledge() {
         var _a;
-        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_8.Knowledge(this._options)));
+        return ((_a = this._knowledge) !== null && _a !== void 0 ? _a : (this._knowledge = new Client_9.Knowledge(this._options)));
     }
     get organizations() {
         var _a;
-        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_9.Organizations(this._options)));
+        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_10.Organizations(this._options)));
     }
-    get realtime() {
+    get segments() {
         var _a;
-        return ((_a = this._realtime) !== null && _a !== void 0 ? _a : (this._realtime = new Client_10.Realtime(this._options)));
+        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_11.Segments(this._options)));
     }
     get translations() {
         var _a;
-        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_11.Translations(this._options)));
+        return ((_a = this._translations) !== null && _a !== void 0 ? _a : (this._translations = new Client_12.Translations(this._options)));
     }
     get triggers() {
         var _a;
-        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_12.Triggers(this._options)));
+        return ((_a = this._triggers) !== null && _a !== void 0 ? _a : (this._triggers = new Client_13.Triggers(this._options)));
     }
     get users() {
         var _a;
-        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_13.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_14.Users(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

package/README.md

@@ -28,7 +28,7 @@ const client = new MavenAGIClient({
     organizationId: "YOUR_ORGANIZATION_ID",
     agentId: "YOUR_AGENT_ID",
 });
-await client.agents.search({});
+await client.actions.search({});
 ```
 
 ## Aborting Requests
@@ -77,7 +77,7 @@ following namespace:
 ```typescript
 import { MavenAGI } from "mavenagi";
 
-const request: MavenAGI.SearchAppSettingsRequest = {
+const request: MavenAGI.ActionGetRequest = {
     ...
 };
 ```
@@ -91,12 +91,13 @@ will be thrown.
 import { MavenAGIError } from "mavenagi";
 
 try {
-    await client.agents.search(...);
+    await client.actions.search(...);
 } catch (err) {
     if (err instanceof MavenAGIError) {
         console.log(err.statusCode);
         console.log(err.message);
         console.log(err.body);
+        console.log(err.rawResponse);
     }
 }
 ```
@@ -108,7 +109,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.agents.search(..., {
+const response = await client.actions.search(..., {
     headers: {
         'X-Custom-Header': 'custom value'
     }
@@ -130,7 +131,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.agents.search(..., {
+const response = await client.actions.search(..., {
     maxRetries: 0 // override maxRetries at the request level
 });
 ```
@@ -140,7 +141,7 @@ const response = await client.agents.search(..., {
 The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
 ```typescript
-const response = await client.agents.search(..., {
+const response = await client.actions.search(..., {
     timeoutInSeconds: 30 // override timeout to 30s
 });
 ```
@@ -151,12 +152,24 @@ 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.agents.search(..., {
+const response = await client.actions.search(..., {
     abortSignal: controller.signal
 });
 controller.abort(); // aborts the request
 ```
 
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.withRawResponse()` method.
+The `.withRawResponse()` method returns a promise that results to an object with a `data` and a `rawResponse` property.
+
+```typescript
+const { data, rawResponse } = await client.actions.search(...).withRawResponse();
+
+console.log(data);
+console.log(rawResponse.headers['X-My-Header']);
+```
+
 ### Runtime Compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
@@ -171,7 +184,7 @@ runtimes:
 
 ### Customizing Fetch Client
 
-The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
 unsupported environment, this provides a way for you to break glass and ensure the SDK works.
 
 ```typescript

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

@@ -15,6 +15,8 @@ export declare namespace Actions {
         organizationId: core.Supplier<string>;
         /** Override the X-Agent-Id header */
         agentId: core.Supplier<string>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
         fetcher?: core.FetchFunction;
     }
     interface RequestOptions {
@@ -29,12 +31,25 @@ export declare namespace Actions {
         /** Override the X-Agent-Id header */
         agentId?: string;
         /** Additional headers to include in the request. */
-        headers?: Record<string, string>;
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
 }
 export declare class Actions {
     protected readonly _options: Actions.Options;
     constructor(_options: Actions.Options);
+    /**
+     * @param {MavenAGI.ActionsSearchRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.actions.search({})
+     */
+    search(request: MavenAGI.ActionsSearchRequest, requestOptions?: Actions.RequestOptions): core.HttpResponsePromise<MavenAGI.ActionsResponse>;
+    private __search;
     /**
      * Update an action or create it if it doesn't exist
      *
@@ -68,11 +83,13 @@ export declare class Actions {
      *         language: "en"
      *     })
      */
-    createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
+    createOrUpdate(request: MavenAGI.ActionRequest, requestOptions?: Actions.RequestOptions): core.HttpResponsePromise<MavenAGI.ActionResponse>;
+    private __createOrUpdate;
     /**
      * Get an action by its supplied ID
      *
      * @param {string} actionReferenceId - The reference ID of the action to get. All other entity ID fields are inferred from the request.
+     * @param {MavenAGI.ActionGetRequest} request
      * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link MavenAGI.NotFoundError}
@@ -82,7 +99,27 @@ export declare class Actions {
      * @example
      *     await client.actions.get("get-balance")
      */
-    get(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<MavenAGI.ActionResponse>;
+    get(actionReferenceId: string, request?: MavenAGI.ActionGetRequest, requestOptions?: Actions.RequestOptions): core.HttpResponsePromise<MavenAGI.ActionResponse>;
+    private __get;
+    /**
+     * Update mutable action fields
+     *
+     * The `appId` field can be provided to update an action owned by a different app.
+     * All other fields will overwrite the existing value on the action only if provided.
+     *
+     * @param {string} actionReferenceId - The reference ID of the action to patch.
+     * @param {MavenAGI.ActionPatchRequest} request
+     * @param {Actions.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link MavenAGI.NotFoundError}
+     * @throws {@link MavenAGI.BadRequestError}
+     * @throws {@link MavenAGI.ServerError}
+     *
+     * @example
+     *     await client.actions.patch("actionReferenceId", {})
+     */
+    patch(actionReferenceId: string, request: MavenAGI.ActionPatchRequest, requestOptions?: Actions.RequestOptions): core.HttpResponsePromise<MavenAGI.ActionResponse>;
+    private __patch;
     /**
      * Delete an action
      *
@@ -96,6 +133,7 @@ export declare class Actions {
      * @example
      *     await client.actions.delete("get-balance")
      */
-    delete(actionReferenceId: string, requestOptions?: Actions.RequestOptions): Promise<void>;
+    delete(actionReferenceId: string, requestOptions?: Actions.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }