import { chakram } from "../../citra";

/**
 * Logs a user in using the configured authentication method and optionally synchronizes the session.
 *
 * The `sessionSyncEndpoint` request is made **after** a successful login.
 * This should be a secure endpoint in the Be Informed application.
 *
 * @async
 * @param {string} userName The user's login name.
 * @param {string} password The user's password.
 * @param {string} [sessionSyncSecureEndpoint=null] An optional URL to request with a GET
 * after a successful login (e.g., to synchronize the session state with a backend service).
 * @returns {Promise<Object>} A promise that resolves with the result of the authentication.
 * @throws {Error} Throws an error if the login or the subsequent GET request fails.
 */
export function login(userName: string, password: string): Promise<any>;
/**
 * Logs out the user by clearing the local session or by requesting the server logoff endpoint.
 *
 * Uses `formLogout()` for `FORM` mode, otherwise only clears the local session.
 *
 * @returns {Promise<Object|void>} A promise that resolves with the server logoff response for FORM mode,
 * or resolves immediately for other modes after clearing the session.
 */
export function logout(): Promise<chakram.ChakramResponse>;
//# sourceMappingURL=login.d.ts.map