/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as environments from "../../../../environments";
import * as core from "../../../../core";
import * as Vectara from "../../../index";
export declare namespace Users {
    interface Options {
        environment?: core.Supplier<environments.VectaraEnvironment | environments.VectaraEnvironmentUrls>;
        token?: core.Supplier<core.BearerToken | undefined>;
        /** Override the x-api-key header */
        apiKey?: core.Supplier<string | 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;
        /** Override the x-api-key header */
        apiKey?: string | undefined;
        /** Additional headers to include in the request. */
        headers?: Record<string, string>;
    }
}
/**
 * Create, manage, and authenticate users within the platform for user administration
 */
export declare class Users {
    protected readonly _options: Users.Options;
    constructor(_options?: Users.Options);
    /**
     * Lists all users in the account.
     *
     * @param {Vectara.UsersListRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.ForbiddenError}
     *
     * @example
     *     await client.users.list()
     */
    list(request?: Vectara.UsersListRequest, requestOptions?: Users.RequestOptions): Promise<core.Page<Vectara.User>>;
    /**
     * Create a user for the current customer account.
     *
     * @param {Vectara.CreateUserRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.BadRequestError}
     * @throws {@link Vectara.ForbiddenError}
     *
     * @example
     *     await client.users.create({
     *         email: "email"
     *     })
     */
    create(request: Vectara.CreateUserRequest, requestOptions?: Users.RequestOptions): Promise<Vectara.User>;
    /**
     * Get a user and view details like the email, username, and associated roles.
     *
     * @param {string} username - Specifies the user ID that to retrieve.
     *                            Note that the username must be percent encoded.
     * @param {Vectara.UsersGetRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.ForbiddenError}
     * @throws {@link Vectara.NotFoundError}
     *
     * @example
     *     await client.users.get("username")
     */
    get(username: string, request?: Vectara.UsersGetRequest, requestOptions?: Users.RequestOptions): Promise<Vectara.User>;
    /**
     * Delete a user from the account.
     *
     * @param {string} username - Specifies the user ID to delete.
     *                            Note that the username must be percent encoded.
     * @param {Vectara.UsersDeleteRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.ForbiddenError}
     * @throws {@link Vectara.NotFoundError}
     *
     * @example
     *     await client.users.delete("username")
     */
    delete(username: string, request?: Vectara.UsersDeleteRequest, requestOptions?: Users.RequestOptions): Promise<void>;
    /**
     * Update details about a user such as role names.
     *
     * @param {string} username - Specifies the user ID to update.
     *                            Note that the username must be percent encoded.
     * @param {Vectara.UpdateUserRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.ForbiddenError}
     * @throws {@link Vectara.NotFoundError}
     *
     * @example
     *     await client.users.update("username")
     */
    update(username: string, request?: Vectara.UpdateUserRequest, requestOptions?: Users.RequestOptions): Promise<Vectara.User>;
    /**
     * Reset the password for a user.
     *
     * @param {string} username - Specifies the user ID to update.
     *                            Note that the username must be percent encoded and URI safe.
     * @param {Vectara.UsersResetPasswordRequest} request
     * @param {Users.RequestOptions} requestOptions - Request-specific configuration.
     *
     * @throws {@link Vectara.ForbiddenError}
     * @throws {@link Vectara.NotFoundError}
     *
     * @example
     *     await client.users.resetPassword("username")
     */
    resetPassword(username: string, request?: Vectara.UsersResetPasswordRequest, requestOptions?: Users.RequestOptions): Promise<void>;
    protected _getAuthorizationHeader(): Promise<string | undefined>;
}