/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments.js"; import * as core from "../../../../core/index.js"; import * as Zep from "../../../index.js"; export declare namespace User { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; apiKey?: core.Supplier; /** Additional headers to include in requests. */ headers?: Record | undefined>; fetcher?: core.FetchFunction; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Additional headers to include in the request. */ headers?: Record | undefined>; } } export declare class User { protected readonly _options: User.Options; constructor(_options?: User.Options); /** * Lists all user summary instructions for a project, user. * * @param {Zep.UserListUserSummaryInstructionsRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.listUserSummaryInstructions({ * userId: "user_id" * }) */ listUserSummaryInstructions(request?: Zep.UserListUserSummaryInstructionsRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __listUserSummaryInstructions; /** * Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions. * * @param {Zep.AddUserInstructionsRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.addUserSummaryInstructions({ * instructions: [{ * name: "name", * text: "text" * }] * }) */ addUserSummaryInstructions(request: Zep.AddUserInstructionsRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __addUserSummaryInstructions; /** * Deletes user summary/instructions for users or project wide defaults. * * @param {Zep.DeleteUserInstructionsRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.deleteUserSummaryInstructions() */ deleteUserSummaryInstructions(request?: Zep.DeleteUserInstructionsRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __deleteUserSummaryInstructions; /** * Adds a user. * * @param {Zep.CreateUserRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.add({ * userId: "user_id" * }) */ add(request: Zep.CreateUserRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __add; /** * Returns all users. * * @param {Zep.UserListOrderedRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.listOrdered({ * pageNumber: 1, * pageSize: 1, * search: "search", * orderBy: "order_by", * asc: true * }) */ listOrdered(request?: Zep.UserListOrderedRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __listOrdered; /** * Returns a user. * * @param {string} userId - The user_id of the user to get. * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.get("userId") */ get(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __get; /** * Deletes a user. * * @param {string} userId - User ID * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.delete("userId") */ delete(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __delete; /** * Updates a user. * * @param {string} userId - User ID * @param {Zep.UpdateUserRequest} request * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.update("userId") */ update(userId: string, request?: Zep.UpdateUserRequest, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __update; /** * Returns a user's node. * * @param {string} userId - The user_id of the user to get the node for. * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.getNode("userId") */ getNode(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __getNode; /** * Returns all threads for a user. * * @param {string} userId - User ID * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.InternalServerError} * * @example * await client.user.getThreads("userId") */ getThreads(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __getThreads; /** * Hints Zep to warm a user's graph for low-latency search * * @param {string} userId - User ID * @param {User.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.user.warm("userId") */ warm(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise; private __warm; protected _getCustomAuthorizationHeaders(): Promise<{ Authorization: string; }>; }