npm - mavenagi - Versions diffs - 1.2.6 → 1.2.8 - Mend

mavenagi 1.2.6 → 1.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (291) hide show

package/core/file/types.d.ts ADDED Viewed

@@ -0,0 +1,66 @@
+/**
+ * A file that can be uploaded. Can be a file-like object (stream, buffer, blob, etc.),
+ * a path to a file, or an object with a file-like object and metadata.
+ */
+export type Uploadable = Uploadable.FileLike | Uploadable.FromPath | Uploadable.WithMetadata;
+export declare namespace Uploadable {
+    /**
+     * Various file-like objects that can be used to upload a file.
+     */
+    type FileLike = ArrayBuffer | ArrayBufferLike | ArrayBufferView | Uint8Array | import("buffer").Buffer | import("buffer").Blob | import("buffer").File | import("stream").Readable | import("stream/web").ReadableStream | globalThis.Blob | globalThis.File | ReadableStream;
+    /**
+     * A file path with optional metadata, used for uploading a file from the file system.
+     */
+    type FromPath = {
+        /** The path to the file to upload */
+        path: string;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * If not provided, the file size will be determined from the file system.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         */
+        contentLength?: number;
+    };
+    /**
+     * A file-like object with metadata, used for uploading files.
+     */
+    type WithMetadata = {
+        /** The file data */
+        data: FileLike;
+        /**
+         * Optional override for the file name (defaults to basename of path).
+         * This is used to set the `Content-Disposition` header in upload requests.
+         */
+        filename?: string;
+        /**
+         * Optional MIME type of the file (e.g., 'image/jpeg', 'text/plain').
+         * This is used to set the `Content-Type` header in upload requests.
+         *
+         * If not provided, the content type may be determined from the data itself.
+         * * If the data is a `File`, `Blob`, or similar, the content type will be determined from the file itself, if the type is set.
+         * * Any other data type will not have a content type set, and the upload request will use `Content-Type: application/octet-stream` instead.
+         */
+        contentType?: string;
+        /**
+         * Optional file size in bytes.
+         * The content length is used to set the `Content-Length` header in upload requests.
+         * If the content length is not provided and cannot be determined, the upload request will not include the `Content-Length` header, but will use `Transfer-Encoding: chunked` instead.
+         *
+         * If not provided, the file size will be determined depending on the data type.
+         * * If the data is of type `fs.ReadStream` (`createReadStream`), the size will be determined from the file system.
+         * * If the data is a `Buffer`, `ArrayBuffer`, `Uint8Array`, `Blob`, `File`, or similar, the size will be determined from the data itself.
+         * * If the data is a `Readable` or `ReadableStream`, the size will not be determined.
+         */
+        contentLength?: number;
+    };
+}

package/core/form-data-utils/FormDataWrapper.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+interface FormDataRequest<Body> {
+    body: Body;
+    headers: Record<string, string>;
+    duplex?: "half";
+}
+export declare function newFormData(): Promise<FormDataWrapper>;
+export declare class FormDataWrapper {
+    private fd;
+    setup(): Promise<void>;
+    append(key: string, value: unknown): void;
+    private getFileName;
+    private convertToBlob;
+    appendFile(key: string, value: unknown, fileName?: string): Promise<void>;
+    getRequest(): FormDataRequest<FormData>;
+}
+export {};

package/core/form-data-utils/FormDataWrapper.js ADDED Viewed

@@ -0,0 +1,208 @@
+"use strict";
+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;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormDataWrapper = void 0;
+exports.newFormData = newFormData;
+const json_1 = require("../../core/json");
+const index_1 = require("../runtime/index");
+function isNamedValue(value) {
+    return typeof value === "object" && value != null && "name" in value;
+}
+function isPathedValue(value) {
+    return typeof value === "object" && value != null && "path" in value;
+}
+function isStreamLike(value) {
+    return typeof value === "object" && value != null && ("read" in value || "pipe" in value);
+}
+function isReadableStream(value) {
+    return typeof value === "object" && value != null && "getReader" in value;
+}
+function isBuffer(value) {
+    return typeof Buffer !== "undefined" && Buffer.isBuffer && Buffer.isBuffer(value);
+}
+function isArrayBufferView(value) {
+    return ArrayBuffer.isView(value);
+}
+function getLastPathSegment(pathStr) {
+    const lastForwardSlash = pathStr.lastIndexOf("/");
+    const lastBackSlash = pathStr.lastIndexOf("\\");
+    const lastSlashIndex = Math.max(lastForwardSlash, lastBackSlash);
+    return lastSlashIndex >= 0 ? pathStr.substring(lastSlashIndex + 1) : pathStr;
+}
+function streamToBuffer(stream) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, stream_1, stream_1_1;
+        var _b, e_1, _c, _d;
+        if (index_1.RUNTIME.type === "node") {
+            const { Readable } = yield Promise.resolve().then(() => __importStar(require("stream")));
+            if (stream instanceof Readable) {
+                const chunks = [];
+                try {
+                    for (_a = true, stream_1 = __asyncValues(stream); stream_1_1 = yield stream_1.next(), _b = stream_1_1.done, !_b; _a = true) {
+                        _d = stream_1_1.value;
+                        _a = false;
+                        const chunk = _d;
+                        chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_a && !_b && (_c = stream_1.return)) yield _c.call(stream_1);
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return Buffer.concat(chunks);
+            }
+        }
+        if (isReadableStream(stream)) {
+            const reader = stream.getReader();
+            const chunks = [];
+            try {
+                while (true) {
+                    const { done, value } = yield reader.read();
+                    if (done)
+                        break;
+                    chunks.push(value);
+                }
+            }
+            finally {
+                reader.releaseLock();
+            }
+            const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+            const result = new Uint8Array(totalLength);
+            let offset = 0;
+            for (const chunk of chunks) {
+                result.set(chunk, offset);
+                offset += chunk.length;
+            }
+            return Buffer.from(result);
+        }
+        throw new Error("Unsupported stream type: " + typeof stream + ". Expected Node.js Readable stream or Web ReadableStream.");
+    });
+}
+function newFormData() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return new FormDataWrapper();
+    });
+}
+class FormDataWrapper {
+    constructor() {
+        this.fd = new FormData();
+    }
+    setup() {
+        return __awaiter(this, void 0, void 0, function* () {
+            // noop
+        });
+    }
+    append(key, value) {
+        this.fd.append(key, String(value));
+    }
+    getFileName(value, filename) {
+        if (filename != null) {
+            return filename;
+        }
+        if (isNamedValue(value)) {
+            return value.name;
+        }
+        if (isPathedValue(value) && value.path) {
+            return getLastPathSegment(value.path.toString());
+        }
+        return undefined;
+    }
+    convertToBlob(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (isStreamLike(value) || isReadableStream(value)) {
+                const buffer = yield streamToBuffer(value);
+                return new Blob([buffer]);
+            }
+            if (value instanceof Blob) {
+                return value;
+            }
+            if (isBuffer(value)) {
+                return new Blob([value]);
+            }
+            if (value instanceof ArrayBuffer) {
+                return new Blob([value]);
+            }
+            if (isArrayBufferView(value)) {
+                return new Blob([value]);
+            }
+            if (typeof value === "string") {
+                return new Blob([value]);
+            }
+            if (typeof value === "object" && value !== null) {
+                return new Blob([(0, json_1.toJson)(value)], { type: "application/json" });
+            }
+            return new Blob([String(value)]);
+        });
+    }
+    appendFile(key, value, fileName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            fileName = this.getFileName(value, fileName);
+            const blob = yield this.convertToBlob(value);
+            if (fileName) {
+                this.fd.append(key, blob, fileName);
+            }
+            else {
+                this.fd.append(key, blob);
+            }
+        });
+    }
+    getRequest() {
+        return {
+            body: this.fd,
+            headers: {},
+            duplex: "half",
+        };
+    }
+}
+exports.FormDataWrapper = FormDataWrapper;

package/core/form-data-utils/encodeAsFormParameter.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function encodeAsFormParameter(value: unknown): Record<string, string>;

package/core/form-data-utils/encodeAsFormParameter.js ADDED Viewed

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encodeAsFormParameter = encodeAsFormParameter;
+const qs_1 = require("../url/qs");
+function encodeAsFormParameter(value) {
+    const stringified = (0, qs_1.toQueryString)(value, { encode: false });
+    const keyValuePairs = stringified.split("&").map((pair) => {
+        const [key, value] = pair.split("=");
+        return [key, value];
+    });
+    return Object.fromEntries(keyValuePairs);
+}

package/core/form-data-utils/index.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export { encodeAsFormParameter } from "./encodeAsFormParameter";
2	+ export * from "./FormDataWrapper";

package/core/form-data-utils/index.js ADDED Viewed

@@ -0,0 +1,20 @@
+"use strict";
+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 __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 });
+exports.encodeAsFormParameter = void 0;
+var encodeAsFormParameter_1 = require("./encodeAsFormParameter");
+Object.defineProperty(exports, "encodeAsFormParameter", { enumerable: true, get: function () { return encodeAsFormParameter_1.encodeAsFormParameter; } });
+__exportStar(require("./FormDataWrapper"), exports);

package/core/index.d.ts CHANGED Viewed

@@ -4,4 +4,6 @@ export * as url from "./url";
 export * from "./auth";
 export * from "./base64";
 export * from "./stream";
+export * as file from "./file";
+export * from "./form-data-utils";
 export * as serialization from "./schemas";

package/core/index.js CHANGED Viewed

@@ -36,11 +36,13 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serialization = exports.url = void 0;
+exports.serialization = exports.file = exports.url = void 0;
 __exportStar(require("./fetcher"), exports);
 __exportStar(require("./runtime"), exports);
 exports.url = __importStar(require("./url"));
 __exportStar(require("./auth"), exports);
 __exportStar(require("./base64"), exports);
 __exportStar(require("./stream"), exports);
+exports.file = __importStar(require("./file"));
+__exportStar(require("./form-data-utils"), exports);
 exports.serialization = __importStar(require("./schemas"));

package/dist/Client.d.ts CHANGED Viewed

@@ -1,7 +1,6 @@
 import * as environments from "./environments";
 import * as core from "./core";
 import { Actions } from "./api/resources/actions/client/Client";
-import { AgentCapabilities } from "./api/resources/agentCapabilities/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";
@@ -50,7 +49,6 @@ export declare namespace MavenAGIClient {
 export declare class MavenAGIClient {
     protected readonly _options: MavenAGIClient.Options;
     protected _actions: Actions | undefined;
-    protected _agentCapabilities: AgentCapabilities | undefined;
     protected _agents: Agents | undefined;
     protected _analytics: Analytics | undefined;
     protected _appSettings: AppSettings | undefined;
@@ -66,7 +64,6 @@ export declare class MavenAGIClient {
     protected _users: Users | undefined;
     constructor(_options: MavenAGIClient.Options);
     get actions(): Actions;
-    get agentCapabilities(): AgentCapabilities;
     get agents(): Agents;
     get analytics(): Analytics;
     get appSettings(): AppSettings;

package/dist/Client.js CHANGED Viewed

@@ -38,20 +38,19 @@ 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/agentCapabilities/client/Client");
-const Client_3 = require("./api/resources/agents/client/Client");
-const Client_4 = require("./api/resources/analytics/client/Client");
-const Client_5 = require("./api/resources/appSettings/client/Client");
-const Client_6 = require("./api/resources/assets/client/Client");
-const Client_7 = require("./api/resources/conversation/client/Client");
-const Client_8 = require("./api/resources/events/client/Client");
-const Client_9 = require("./api/resources/inbox/client/Client");
-const Client_10 = require("./api/resources/knowledge/client/Client");
-const Client_11 = require("./api/resources/organizations/client/Client");
-const Client_12 = require("./api/resources/segments/client/Client");
-const Client_13 = require("./api/resources/translations/client/Client");
-const Client_14 = require("./api/resources/triggers/client/Client");
-const Client_15 = 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/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 = Object.assign(Object.assign({}, _options), { headers: (0, headers_1.mergeHeaders)({
@@ -59,8 +58,8 @@ class MavenAGIClient {
                 "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.6",
-                "User-Agent": "mavenagi/1.2.6",
+                "X-Fern-SDK-Version": "1.2.8",
+                "User-Agent": "mavenagi/1.2.8",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -69,61 +68,57 @@ class MavenAGIClient {
         var _a;
         return ((_a = this._actions) !== null && _a !== void 0 ? _a : (this._actions = new Client_1.Actions(this._options)));
     }
-    get agentCapabilities() {
-        var _a;
-        return ((_a = this._agentCapabilities) !== null && _a !== void 0 ? _a : (this._agentCapabilities = new Client_2.AgentCapabilities(this._options)));
-    }
     get agents() {
         var _a;
-        return ((_a = this._agents) !== null && _a !== void 0 ? _a : (this._agents = new Client_3.Agents(this._options)));
+        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_4.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_5.AppSettings(this._options)));
+        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_6.Assets(this._options)));
+        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_7.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_8.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_9.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_10.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_11.Organizations(this._options)));
+        return ((_a = this._organizations) !== null && _a !== void 0 ? _a : (this._organizations = new Client_10.Organizations(this._options)));
     }
     get segments() {
         var _a;
-        return ((_a = this._segments) !== null && _a !== void 0 ? _a : (this._segments = new Client_12.Segments(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_13.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_14.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_15.Users(this._options)));
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_14.Users(this._options)));
     }
 }
 exports.MavenAGIClient = MavenAGIClient;

package/dist/api/resources/commons/types/ConversationResponse.d.ts CHANGED Viewed

@@ -27,7 +27,8 @@ import * as MavenAGI from "../../../index";
  *             userMessageCount: 1,
  *             humanAgents: [],
  *             humanAgentsWithInserts: [],
- *             users: []
+ *             users: [],
+ *             userIdentifiers: []
  *         },
  *         metadata: {},
  *         allMetadata: {},

package/dist/api/resources/commons/types/ConversationSummary.d.ts CHANGED Viewed

@@ -33,6 +33,8 @@ export interface ConversationSummary {
     humanAgentsWithInserts: string[];
     /** The names of all users that have a message of type `USER` on the conversation. */
     users: string[];
+    /** The user identifiers (typically email addresses or phone numbers) of all users that have a message of type `USER` on the conversation. */
+    userIdentifiers: string[];
     /** The text of the last user message in the conversation. */
     lastUserMessage?: string;
     /** The text of the last bot message in the conversation. */

package/dist/api/resources/commons/types/EntityIdBase.d.ts CHANGED Viewed

@@ -2,6 +2,17 @@
  * All other entityId fields are inferred from the API request.
  */
 export interface EntityIdBase {
-    /** Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId) */
+    /**
+     * Externally supplied ID to uniquely identify this object. Is globally unique when combined with all other entityId fields (type, appId, organizationId, agentId).
+     *
+     * Must be less than 192 characters and contain only:
+     * - alphanumeric characters (`a-z`, `A-Z`, `0-9`)
+     * - hyphens (`-`)
+     * - underscores (`_`)
+     * - plus signs (`+`)
+     * - periods (`.`)
+     * - at symbol (`@`)
+     * - pipe symbol (`|`)
+     */
     referenceId: string;
 }

package/dist/api/resources/commons/types/InboxItem.d.ts CHANGED Viewed

@@ -1,5 +1,25 @@
 import * as MavenAGI from "../../../index";
-export type InboxItem = MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.MissingKnowledge;
+/**
+ * @example
+ *     {
+ *         type: "custom",
+ *         id: {
+ *             referenceId: "todo-item-1",
+ *             appId: "myapp",
+ *             organizationId: "acme",
+ *             agentId: "support",
+ *             type: MavenAGI.EntityType.InboxItem
+ *         },
+ *         status: MavenAGI.InboxItemStatus.Open,
+ *         severity: MavenAGI.InboxItemSeverity.High,
+ *         createdAt: new Date("2025-01-01T00:00:00.000Z"),
+ *         updatedAt: new Date("2025-02-01T00:00:00.000Z"),
+ *         metadata: {
+ *             "key": "value"
+ *         }
+ *     }
+ */
+export type InboxItem = MavenAGI.InboxItem.DuplicateDocuments | MavenAGI.InboxItem.MissingKnowledge | MavenAGI.InboxItem.Custom;
 export declare namespace InboxItem {
     interface DuplicateDocuments extends MavenAGI.InboxItemDuplicateDocuments {
         type: "duplicateDocuments";
@@ -7,4 +27,7 @@ export declare namespace InboxItem {
     interface MissingKnowledge extends MavenAGI.InboxItemMissingKnowledge {
         type: "missingKnowledge";
     }
+    interface Custom extends MavenAGI.InboxItemCustom {
+        type: "custom";
+    }
 }

package/dist/api/resources/commons/types/InboxItemCustom.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+import * as MavenAGI from "../../../index";
+export interface InboxItemCustom extends MavenAGI.InboxItemBase {
+    /** Additional metadata associated with the inbox item. */
+    metadata: Record<string, string>;
+}

package/dist/api/resources/commons/types/index.d.ts CHANGED Viewed

@@ -125,6 +125,7 @@ export * from "./InboxItemType";
 export * from "./InboxItemSeverity";
 export * from "./InboxItem";
 export * from "./InboxItemBase";
+export * from "./InboxItemCustom";
 export * from "./InboxItemDuplicateDocuments";
 export * from "./InboxItemMissingKnowledge";
 export * from "./InboxItemFix";

package/dist/api/resources/commons/types/index.js CHANGED Viewed

@@ -141,6 +141,7 @@ __exportStar(require("./InboxItemType"), exports);
 __exportStar(require("./InboxItemSeverity"), exports);
 __exportStar(require("./InboxItem"), exports);
 __exportStar(require("./InboxItemBase"), exports);
+__exportStar(require("./InboxItemCustom"), exports);
 __exportStar(require("./InboxItemDuplicateDocuments"), exports);
 __exportStar(require("./InboxItemMissingKnowledge"), exports);
 __exportStar(require("./InboxItemFix"), exports);