@getzep/zep-cloud 2.4.0 → 2.6.0

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

@@ -60,7 +60,7 @@ class Group {
         this._options = _options;
     }
     /**
-     * Create a new user group
+     * Creates a new group.
      *
      * @param {Zep.CreateGroupRequest} request
      * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
@@ -79,7 +79,7 @@ class Group {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, "groups"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.4.0", "User-Agent": "zep-cloud/2.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CreateGroupRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -137,7 +137,7 @@ class Group {
         });
     }
     /**
-     * List all groups with pagination.
+     * Returns all groups.
      *
      * @param {Zep.GetGroupsOrderedRequest} request
      * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
@@ -146,9 +146,9 @@ class Group {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await client.group.listAllGroups()
+     *     await client.group.getAllGroups()
      */
-    listAllGroups() {
+    getAllGroups() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b;
             const { pageNumber, pageSize } = request;
@@ -162,7 +162,7 @@ class Group {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, "groups-ordered"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.4.0", "User-Agent": "zep-cloud/2.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",
@@ -220,7 +220,7 @@ class Group {
         });
     }
     /**
-     * Get a group.
+     * Returns a group.
      *
      * @param {string} groupId - The group_id of the group to get.
      * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
@@ -229,15 +229,15 @@ class Group {
      * @throws {@link Zep.InternalServerError}
      *
      * @example
-     *     await client.group.getAGroup("groupId")
+     *     await client.group.getGroup("groupId")
      */
-    getAGroup(groupId, requestOptions) {
+    getGroup(groupId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, `groups/${encodeURIComponent(groupId)}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.4.0", "User-Agent": "zep-cloud/2.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), 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,
@@ -294,7 +294,7 @@ class Group {
         });
     }
     /**
-     * Delete group
+     * Deletes a group.
      *
      * @param {string} groupId - Group ID
      * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
@@ -312,7 +312,7 @@ class Group {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, `groups/${encodeURIComponent(groupId)}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.4.0", "User-Agent": "zep-cloud/2.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), 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,
@@ -377,7 +377,92 @@ class Group {
         });
     }
     /**
-     * Get group facts.
+     * Updates information about a group.
+     *
+     * @param {string} groupId - Group ID
+     * @param {Zep.UpdateGroupRequest} request
+     * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.group.update("groupId")
+     */
+    update(groupId_1) {
+        return __awaiter(this, arguments, void 0, function* (groupId, request = {}, requestOptions) {
+            var _a, _b;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, `groups/${encodeURIComponent(groupId)}`),
+                method: "PATCH",
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                contentType: "application/json",
+                requestType: "json",
+                body: serializers.UpdateGroupRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                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,
+            });
+            if (_response.ok) {
+                return serializers.Group.parseOrThrow(_response.body, {
+                    unrecognizedObjectKeys: "passthrough",
+                    allowUnrecognizedUnionMembers: true,
+                    allowUnrecognizedEnumValues: true,
+                    skipValidation: true,
+                    breadcrumbsPrefix: ["response"],
+                });
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Zep.BadRequestError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 404:
+                        throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    case 500:
+                        throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }));
+                    default:
+                        throw new errors.ZepError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ZepError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.ZepTimeoutError("Timeout exceeded when calling PATCH /groups/{groupId}.");
+                case "unknown":
+                    throw new errors.ZepError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
+    /**
+     * Deprecated: Use Get Group Edges instead.
      *
      * @param {string} groupId - The group_id of the group to get.
      * @param {Group.RequestOptions} requestOptions - Request-specific configuration.
@@ -394,7 +479,7 @@ class Group {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.ZepEnvironment.Default, `groups/${encodeURIComponent(groupId)}/facts`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.4.0", "User-Agent": "zep-cloud/2.4.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "zep-cloud", "X-Fern-SDK-Version": "2.6.0", "User-Agent": "zep-cloud/2.6.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), 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/dist/api/resources/group/client/requests/CreateGroupRequest.d.ts

@@ -10,7 +10,6 @@ import * as Zep from "../../../../index";
  */
 export interface CreateGroupRequest {
     description?: string;
-    /** UserIDs     []string `json:"user_ids"` */
     factRatingInstruction?: Zep.FactRatingInstruction;
     groupId: string;
     name?: string;

package/dist/api/resources/group/client/requests/GetGroupsOrderedRequest.d.ts

@@ -7,11 +7,11 @@
  */
 export interface GetGroupsOrderedRequest {
     /**
-     * Page number for pagination, starting from 1
+     * Page number for pagination, starting from 1.
      */
     pageNumber?: number;
     /**
-     * Number of groups to retrieve per page
+     * Number of groups to retrieve per page.
      */
     pageSize?: number;
 }

package/dist/api/resources/group/client/requests/UpdateGroupRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface UpdateGroupRequest {
+    description?: string;
+    factRatingInstruction?: Zep.FactRatingInstruction;
+    name?: string;
+}

package/dist/api/resources/group/client/requests/UpdateGroupRequest.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/group/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export { type CreateGroupRequest } from "./CreateGroupRequest";
 export { type GetGroupsOrderedRequest } from "./GetGroupsOrderedRequest";
+export { type UpdateGroupRequest } from "./UpdateGroupRequest";

package/dist/api/resources/memory/client/Client.d.ts

@@ -25,7 +25,7 @@ export declare class Memory {
     protected readonly _options: Memory.Options;
     constructor(_options?: Memory.Options);
     /**
-     * get fact by uuid
+     * Deprecated API: get fact by uuid
      *
      * @param {string} factUuid - Fact UUID
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,7 +38,7 @@ export declare class Memory {
      */
     getFact(factUuid: string, requestOptions?: Memory.RequestOptions): Promise<Zep.FactResponse>;
     /**
-     * delete a fact
+     * Deprecated API: delete a fact
      *
      * @param {string} factUuid - Fact UUID
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -51,7 +51,7 @@ export declare class Memory {
      */
     deleteFact(factUuid: string, requestOptions?: Memory.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
-     * Create New Session
+     * Creates a new session.
      *
      * @param {Zep.CreateSessionRequest} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -67,7 +67,7 @@ export declare class Memory {
      */
     addSession(request: Zep.CreateSessionRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.Session>;
     /**
-     * Get all sessions with optional page number, page size, order by field and order direction for pagination.
+     * Returns all sessions.
      *
      * @param {Zep.MemoryListSessionsRequest} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -80,7 +80,7 @@ export declare class Memory {
      */
     listSessions(request?: Zep.MemoryListSessionsRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.SessionListResponse>;
     /**
-     * End multiple sessions by their IDs.
+     * Deprecated API: End multiple sessions by their IDs.
      *
      * @param {Zep.EndSessionsRequest} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,7 +96,7 @@ export declare class Memory {
      */
     endSessions(request: Zep.EndSessionsRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.EndSessionsResponse>;
     /**
-     * Search sessions for the specified query.
+     * Deprecated API: Search sessions for the specified query.
      *
      * @param {Zep.SessionSearchQuery} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -110,9 +110,9 @@ export declare class Memory {
      */
     searchSessions(request: Zep.SessionSearchQuery, requestOptions?: Memory.RequestOptions): Promise<Zep.SessionSearchResponse>;
     /**
-     * get session by id
+     * Returns a session.
      *
-     * @param {string} sessionId - Session ID
+     * @param {string} sessionId - The unique identifier of the session.
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Zep.NotFoundError}
@@ -125,7 +125,7 @@ export declare class Memory {
     /**
      * Update Session Metadata
      *
-     * @param {string} sessionId - Session ID
+     * @param {string} sessionId - The unique identifier of the session.
      * @param {Zep.UpdateSessionRequest} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -143,7 +143,7 @@ export declare class Memory {
      */
     updateSession(sessionId: string, request: Zep.UpdateSessionRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.Session>;
     /**
-     * classify a session by session id.
+     * Classifies a session.
      *
      * @param {string} sessionId - Session ID
      * @param {Zep.ClassifySessionRequest} request
@@ -160,7 +160,7 @@ export declare class Memory {
      */
     classifySession(sessionId: string, request: Zep.ClassifySessionRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.SessionClassification>;
     /**
-     * End a session by ID.
+     * Deprecated API: End a session by ID.
      *
      * @param {string} sessionId - Session ID
      * @param {Zep.EndSessionRequest} request
@@ -193,7 +193,7 @@ export declare class Memory {
      */
     extractData(sessionId: string, request: Zep.ExtractDataRequest, requestOptions?: Memory.RequestOptions): Promise<Record<string, string>>;
     /**
-     * get facts for a session
+     * Deprecated API: get facts for a session
      *
      * @param {string} sessionId - Session ID
      * @param {Zep.MemoryGetSessionFactsRequest} request
@@ -207,7 +207,7 @@ export declare class Memory {
      */
     getSessionFacts(sessionId: string, request?: Zep.MemoryGetSessionFactsRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.FactsResponse>;
     /**
-     * Adds facts to a session
+     * Deprecated API: Adds facts to a session
      *
      * @param {string} sessionId - Session ID
      * @param {Zep.AddFactsRequest} request
@@ -221,7 +221,7 @@ export declare class Memory {
      */
     addSessionFacts(sessionId: string, request?: Zep.AddFactsRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
-     * Returns a memory (latest summary, list of messages and facts) for a given session
+     * Returns a memory for a given session.
      *
      * @param {string} sessionId - The ID of the session for which to retrieve memory.
      * @param {Zep.MemoryGetRequest} request
@@ -253,7 +253,7 @@ export declare class Memory {
      */
     add(sessionId: string, request: Zep.AddMemoryRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.AddMemoryResponse>;
     /**
-     * delete memory messages by session id
+     * Deletes a session.
      *
      * @param {string} sessionId - The ID of the session for which memory should be deleted.
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -266,7 +266,7 @@ export declare class Memory {
      */
     delete(sessionId: string, requestOptions?: Memory.RequestOptions): Promise<Zep.SuccessResponse>;
     /**
-     * Lists messages for a session, specified by limit and cursor.
+     * Returns messages for a session.
      *
      * @param {string} sessionId - Session ID
      * @param {Zep.MemoryGetSessionMessagesRequest} request
@@ -280,9 +280,9 @@ export declare class Memory {
      */
     getSessionMessages(sessionId: string, request?: Zep.MemoryGetSessionMessagesRequest, requestOptions?: Memory.RequestOptions): Promise<Zep.MessageListResponse>;
     /**
-     * Gets a specific message from a session
+     * Returns a specific message from a session.
      *
-     * @param {string} sessionId - The ID of the session.
+     * @param {string} sessionId - Soon to be deprecated as this is not needed.
      * @param {string} messageUuid - The UUID of the message.
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -313,8 +313,6 @@ export declare class Memory {
      */
     updateMessageMetadata(sessionId: string, messageUuid: string, request: Zep.ModelsMessageMetadataUpdate, requestOptions?: Memory.RequestOptions): Promise<Zep.Message>;
     /**
-     * Search memory for the specified session. Deprecated, please use search_sessions method instead
-     *
      * @param {string} sessionId - The ID of the session for which memory should be searched.
      * @param {Zep.MemorySearchPayload} request
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -327,7 +325,7 @@ export declare class Memory {
      */
     search(sessionId: string, request?: Zep.MemorySearchPayload, requestOptions?: Memory.RequestOptions): Promise<Zep.MemorySearchResult[]>;
     /**
-     * Get session summaries by ID
+     * Deprecated API: Get session summaries by ID
      *
      * @param {string} sessionId - Session ID
      * @param {Memory.RequestOptions} requestOptions - Request-specific configuration.
@@ -340,7 +338,7 @@ export declare class Memory {
      */
     getSummaries(sessionId: string, requestOptions?: Memory.RequestOptions): Promise<Zep.SummaryListResponse>;
     /**
-     * Synthesize a question from the last N messages in the chat history.
+     * Deprecated API: Synthesize a question from the last N messages in the chat history.
      *
      * @param {string} sessionId - The ID of the session.
      * @param {Zep.MemorySynthesizeQuestionRequest} request