@usecortex_ai/node 0.1.1 → 0.2.0

package/dist/api/resources/userMemory/client/Client.js

@@ -25,6 +25,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserMemory = void 0;
 const environments = __importStar(require("../../../../environments.js"));
@@ -33,19 +44,32 @@ const CortexAI = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class UserMemory {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
+     * Retrieve all stored user memories for your tenant.
+     *
+     * This endpoint returns a comprehensive list of all user memories that have been stored,
+     * whether they were added manually or generated through AI. User memories help personalize
+     * your experience by storing context, preferences, and important information.
+     *
+     * You can optionally specify a sub-tenant to filter memories within that specific scope.
+     *
      * @param {CortexAI.UserMemoryListUserMemoriesRequest} request
      * @param {UserMemory.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
      *     await client.userMemory.listUserMemories({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_id"
      *     })
      */
     listUserMemories(request, requestOptions) {
@@ -56,7 +80,9 @@ class UserMemory {
         const { tenant_id: tenantId, sub_tenant_id: subTenantId } = request;
         const _queryParams = {};
         _queryParams["tenant_id"] = tenantId;
-        _queryParams["sub_tenant_id"] = subTenantId;
+        if (subTenantId != null) {
+            _queryParams["sub_tenant_id"] = subTenantId;
+        }
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
             url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "user_memory/list_user_memories"),
@@ -72,8 +98,20 @@ class UserMemory {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortexAIError({
                         statusCode: _response.error.statusCode,
@@ -99,16 +137,29 @@ class UserMemory {
         }
     }
     /**
+     * Permanently remove a specific user memory from storage.
+     *
+     * This endpoint allows you to delete a user memory by its unique identifier.
+     * Once deleted, the memory cannot be recovered, so use this operation carefully.
+     *
+     * The memory will be removed from your tenant's storage and will no longer
+     * appear in search results or memory listings.
+     *
      * @param {CortexAI.UserMemoryDeleteUserMemoryRequest} request
      * @param {UserMemory.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
      *     await client.userMemory.deleteUserMemory({
      *         tenant_id: "tenant_id",
-     *         memory_id: "memory_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         memory_id: "memory_id"
      *     })
      */
     deleteUserMemory(request, requestOptions) {
@@ -120,7 +171,9 @@ class UserMemory {
         const _queryParams = {};
         _queryParams["tenant_id"] = tenantId;
         _queryParams["memory_id"] = memoryId;
-        _queryParams["sub_tenant_id"] = subTenantId;
+        if (subTenantId != null) {
+            _queryParams["sub_tenant_id"] = subTenantId;
+        }
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
             url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "user_memory/delete_user_memory"),
@@ -136,8 +189,20 @@ class UserMemory {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortexAIError({
                         statusCode: _response.error.statusCode,
@@ -163,16 +228,30 @@ class UserMemory {
         }
     }
     /**
-     * @param {CortexAI.UserMemoryRetrieveUserMemoryRequest} request
+     * Find relevant user memories using semantic search.
+     *
+     * This endpoint performs a semantic search across all your stored user memories
+     * to find the most relevant ones based on your query. The results are ranked by
+     * similarity score, with the most relevant memories returned first.
+     *
+     * Use this to recall past preferences, context, or information that might be
+     * relevant to your current task or query.
+     *
+     * @param {CortexAI.RetrieveUserMemoryRequest} request
      * @param {UserMemory.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
      *     await client.userMemory.retrieveUserMemory({
      *         tenant_id: "tenant_id",
-     *         query: "query",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         query: "query"
      *     })
      */
     retrieveUserMemory(request, requestOptions) {
@@ -180,20 +259,24 @@ class UserMemory {
     }
     async __retrieveUserMemory(request, requestOptions) {
         var _a, _b, _c;
-        const { tenant_id: tenantId, query, sub_tenant_id: subTenantId, max_count: maxCount } = request;
+        const { tenant_id: tenantId, sub_tenant_id: subTenantId, max_count: maxCount } = request, _body = __rest(request, ["tenant_id", "sub_tenant_id", "max_count"]);
         const _queryParams = {};
         _queryParams["tenant_id"] = tenantId;
-        _queryParams["query"] = query;
-        _queryParams["sub_tenant_id"] = subTenantId;
+        if (subTenantId != null) {
+            _queryParams["sub_tenant_id"] = subTenantId;
+        }
         if (maxCount != null) {
             _queryParams["max_count"] = maxCount.toString();
         }
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
             url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "user_memory/retrieve_user_memory"),
-            method: "GET",
+            method: "POST",
             headers: _headers,
+            contentType: "application/json",
             queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+            requestType: "json",
+            body: _body,
             timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -203,8 +286,20 @@ class UserMemory {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortexAIError({
                         statusCode: _response.error.statusCode,
@@ -221,7 +316,7 @@ class UserMemory {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /user_memory/retrieve_user_memory.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /user_memory/retrieve_user_memory.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,
@@ -230,17 +325,31 @@ class UserMemory {
         }
     }
     /**
-     * @param {CortexAI.UserMemoryGenerateUserMemoryRequest} request
+     * Generate AI-powered user memories from your query and context.
+     *
+     * This endpoint uses artificial intelligence to create personalized memories
+     * based on your query and user context. The AI analyzes your input and generates
+     * relevant, contextual memories that can help improve future interactions.
+     *
+     * Generated memories are automatically stored and can be retrieved through
+     * the standard memory search endpoints.
+     *
+     * @param {CortexAI.GenerateUserMemoryRequest} request
      * @param {UserMemory.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
      *     await client.userMemory.generateUserMemory({
      *         tenant_id: "tenant_id",
      *         user_query: "user_query",
-     *         user_name: "user_name",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         user_name: "user_name"
      *     })
      */
     generateUserMemory(request, requestOptions) {
@@ -248,18 +357,21 @@ class UserMemory {
     }
     async __generateUserMemory(request, requestOptions) {
         var _a, _b, _c;
-        const { tenant_id: tenantId, user_query: userQuery, user_name: userName, sub_tenant_id: subTenantId } = request;
+        const { tenant_id: tenantId, sub_tenant_id: subTenantId } = request, _body = __rest(request, ["tenant_id", "sub_tenant_id"]);
         const _queryParams = {};
         _queryParams["tenant_id"] = tenantId;
-        _queryParams["user_query"] = userQuery;
-        _queryParams["user_name"] = userName;
-        _queryParams["sub_tenant_id"] = subTenantId;
+        if (subTenantId != null) {
+            _queryParams["sub_tenant_id"] = subTenantId;
+        }
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
             url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "user_memory/generate_user_memory"),
             method: "POST",
             headers: _headers,
+            contentType: "application/json",
             queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+            requestType: "json",
+            body: _body,
             timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -269,8 +381,20 @@ class UserMemory {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortexAIError({
                         statusCode: _response.error.statusCode,
@@ -296,16 +420,30 @@ class UserMemory {
         }
     }
     /**
-     * @param {CortexAI.UserMemoryAddUserMemoryRequest} request
+     * Store a new user memory for future reference.
+     *
+     * This endpoint allows you to manually add a memory that will be stored and
+     * can be retrieved later through memory search. Use this to save important
+     * preferences, context, or information that you want the system to remember.
+     *
+     * The stored memory will be indexed and available for semantic search, making
+     * it accessible when relevant to future queries or interactions.
+     *
+     * @param {CortexAI.AddUserMemoryRequest} request
      * @param {UserMemory.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
      *     await client.userMemory.addUserMemory({
      *         tenant_id: "tenant_id",
-     *         user_memory: "user_memory",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         user_memory: "user_memory"
      *     })
      */
     addUserMemory(request, requestOptions) {
@@ -313,17 +451,21 @@ class UserMemory {
     }
     async __addUserMemory(request, requestOptions) {
         var _a, _b, _c;
-        const { tenant_id: tenantId, user_memory: userMemory, sub_tenant_id: subTenantId } = request;
+        const { tenant_id: tenantId, sub_tenant_id: subTenantId } = request, _body = __rest(request, ["tenant_id", "sub_tenant_id"]);
         const _queryParams = {};
         _queryParams["tenant_id"] = tenantId;
-        _queryParams["user_memory"] = userMemory;
-        _queryParams["sub_tenant_id"] = subTenantId;
+        if (subTenantId != null) {
+            _queryParams["sub_tenant_id"] = subTenantId;
+        }
         let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
         const _response = await core.fetcher({
             url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "user_memory/add_user_memory"),
             method: "POST",
             headers: _headers,
+            contentType: "application/json",
             queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+            requestType: "json",
+            body: _body,
             timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
             maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
             abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -333,8 +475,20 @@ class UserMemory {
         }
         if (_response.error.reason === "status-code") {
             switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
                 default:
                     throw new errors.CortexAIError({
                         statusCode: _response.error.statusCode,
@@ -360,11 +514,7 @@ class UserMemory {
         }
     }
     async _getAuthorizationHeader() {
-        const bearer = await core.Supplier.get(this._options.token);
-        if (bearer != null) {
-            return `Bearer ${bearer}`;
-        }
-        return undefined;
+        return `Bearer ${await core.Supplier.get(this._options.token)}`;
     }
 }
 exports.UserMemory = UserMemory;

package/dist/api/resources/userMemory/client/requests/AddUserMemoryRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         user_memory: "user_memory"
+ *     }
+ */
+export interface AddUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
+    /** The memory content to store for future reference */
+    user_memory: string;
+}

package/dist/api/resources/userMemory/client/requests/AddUserMemoryRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/userMemory/client/requests/GenerateUserMemoryRequest.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         user_query: "user_query",
+ *         user_name: "user_name"
+ *     }
+ */
+export interface GenerateUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
+    /** Your query or context for AI memory generation */
+    user_query: string;
+    /** Your name to personalize the generated memories */
+    user_name: string;
+}

package/dist/api/resources/userMemory/client/requests/GenerateUserMemoryRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         query: "query"
+ *     }
+ */
+export interface RetrieveUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
+    tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
+    /** Maximum number of memories to return (default: 5) */
+    max_count?: number;
+    /** Search query to find relevant user memories */
+    query: string;
+}

package/dist/api/resources/userMemory/client/requests/RetrieveUserMemoryRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/userMemory/client/requests/UserMemoryDeleteUserMemoryRequest.d.ts

@@ -5,12 +5,14 @@
  * @example
  *     {
  *         tenant_id: "tenant_id",
- *         memory_id: "memory_id",
- *         sub_tenant_id: "sub_tenant_id"
+ *         memory_id: "memory_id"
  *     }
  */
 export interface UserMemoryDeleteUserMemoryRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** Unique identifier of the memory to delete */
     memory_id: string;
-    sub_tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
 }

package/dist/api/resources/userMemory/client/requests/UserMemoryListUserMemoriesRequest.d.ts

@@ -4,11 +4,12 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         sub_tenant_id: "sub_tenant_id"
+ *         tenant_id: "tenant_id"
  *     }
  */
 export interface UserMemoryListUserMemoriesRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
-    sub_tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
+    sub_tenant_id?: string;
 }

package/dist/api/resources/userMemory/client/requests/index.d.ts

@@ -1,5 +1,5 @@
 export { type UserMemoryListUserMemoriesRequest } from "./UserMemoryListUserMemoriesRequest.js";
 export { type UserMemoryDeleteUserMemoryRequest } from "./UserMemoryDeleteUserMemoryRequest.js";
-export { type UserMemoryRetrieveUserMemoryRequest } from "./UserMemoryRetrieveUserMemoryRequest.js";
-export { type UserMemoryGenerateUserMemoryRequest } from "./UserMemoryGenerateUserMemoryRequest.js";
-export { type UserMemoryAddUserMemoryRequest } from "./UserMemoryAddUserMemoryRequest.js";
+export { type RetrieveUserMemoryRequest } from "./RetrieveUserMemoryRequest.js";
+export { type GenerateUserMemoryRequest } from "./GenerateUserMemoryRequest.js";
+export { type AddUserMemoryRequest } from "./AddUserMemoryRequest.js";

package/dist/api/types/AddUserMemoryResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Response model for adding a new user memory.
+ */
+export interface AddUserMemoryResponse {
+    /** Indicates whether the memory addition operation was successful */
+    success: boolean;
+    /** Confirms whether the memory was successfully stored in the system */
+    user_memory_added: boolean;
+    /** Unique identifier assigned to the newly created memory */
+    memory_id?: string;
+}

package/dist/api/types/AddUserMemoryResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/types/AppSourcesUploadData.d.ts

@@ -3,7 +3,9 @@
  */
 import * as CortexAI from "../index.js";
 export interface AppSourcesUploadData {
-    success?: boolean;
-    message?: string;
+    /** List of successfully uploaded app source for indexing */
     uploaded: CortexAI.FileUploadResult[];
+    /** Status message indicating app sources upload scheduled */
+    message: string;
+    success?: boolean;
 }

package/dist/api/types/AttachmentModel.d.ts

@@ -3,11 +3,18 @@
  */
 import * as CortexAI from "../index.js";
 export interface AttachmentModel {
+    /** Unique identifier for the attachment. */
     id?: string;
+    /** Public or internal URL referencing the attachment resource. */
     url?: string;
+    /** Human-readable title or filename of the attachment. */
     title?: string;
+    /** MIME type of the attachment (e.g., application/pdf). */
     content_type?: string;
+    /** Direct URL for content retrieval when different from the reference URL. */
     content_url?: string;
+    /** Additional attachment attributes defined by the tenant (free-form). */
     misc?: Record<string, unknown>;
+    /** Structured content payload for the attachment when available. */
     content?: CortexAI.ContentModel;
 }

package/dist/api/types/BatchUploadData.d.ts

@@ -3,7 +3,9 @@
  */
 import * as CortexAI from "../index.js";
 export interface BatchUploadData {
-    success?: boolean;
-    message?: string;
+    /** List of successfully uploaded files for processing */
     uploaded: CortexAI.FileUploadResult[];
+    /** Status message indicating batch document parsing scheduled */
+    message: string;
+    success?: boolean;
 }

package/dist/api/types/BodyScrapeWebpageUploadScrapeWebpagePost.d.ts

@@ -2,5 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BodyScrapeWebpageUploadScrapeWebpagePost {
-    relations?: string;
 }

package/dist/api/types/BodyUpdateScrapeJobUploadUpdateWebpagePatch.d.ts

@@ -2,5 +2,4 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface BodyUpdateScrapeJobUploadUpdateWebpagePatch {
-    relations?: string;
 }

package/dist/api/types/ContentModel.d.ts

@@ -2,10 +2,16 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ContentModel {
+    /** Plain text content extracted or provided for indexing. */
     text?: string;
+    /** Base64-encoded HTML content preserving structure and formatting. */
     html_base64?: string;
+    /** Base64-encoded CSV data for tabular content ingestion. */
     csv_base64?: string;
+    /** Raw Markdown content to be indexed as rich text. */
     markdown?: string;
+    /** List of file descriptors associated with the source (e.g., filenames, sizes). */
     files?: Record<string, unknown>[];
+    /** Optional layout metadata such as sections or blocks to guide chunking. */
     layout?: Record<string, unknown>[];
 }

package/dist/api/types/DeleteMemoryRequest.d.ts

@@ -2,7 +2,10 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface DeleteMemoryRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** List of source IDs to delete */
     source_ids: string[];
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
     sub_tenant_id?: string;
 }