fineract_sdk/dist/api/authentication-httpbasic-api.d.ts

Wrapper around fineract api.

/**
 * Apache Fineract
 * Apache Fineract is a secure, multi-tenanted microfinance platform  The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation  - The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top) - You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact) - The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts) - Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers) - For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview) - Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)  Please refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries
 *
 * The version of the OpenAPI document: 1.5.0-66-gffae7d4-dirty
 * Contact: dev@fineract.apache.org
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { InlineObject7 } from '../models';
import { PostAuthenticationResponse } from '../models';
/**
 * AuthenticationHTTPBasicApi - axios parameter creator
 * @export
 */
export declare const AuthenticationHTTPBasicApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Authenticates the credentials provided and returns the set roles and permissions allowed.
     * @summary Verify authentication
     * @param {boolean} [returnClientList]
     * @param {InlineObject7} [inlineObject7]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authenticate: (returnClientList?: boolean, inlineObject7?: InlineObject7, options?: any) => Promise<RequestArgs>;
};
/**
 * AuthenticationHTTPBasicApi - functional programming interface
 * @export
 */
export declare const AuthenticationHTTPBasicApiFp: (configuration?: Configuration) => {
    /**
     * Authenticates the credentials provided and returns the set roles and permissions allowed.
     * @summary Verify authentication
     * @param {boolean} [returnClientList]
     * @param {InlineObject7} [inlineObject7]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authenticate(returnClientList?: boolean, inlineObject7?: InlineObject7, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostAuthenticationResponse>>;
};
/**
 * AuthenticationHTTPBasicApi - factory interface
 * @export
 */
export declare const AuthenticationHTTPBasicApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Authenticates the credentials provided and returns the set roles and permissions allowed.
     * @summary Verify authentication
     * @param {boolean} [returnClientList]
     * @param {InlineObject7} [inlineObject7]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authenticate(returnClientList?: boolean, inlineObject7?: InlineObject7, options?: any): AxiosPromise<PostAuthenticationResponse>;
};
/**
 * AuthenticationHTTPBasicApi - object-oriented interface
 * @export
 * @class AuthenticationHTTPBasicApi
 * @extends {BaseAPI}
 */
export declare class AuthenticationHTTPBasicApi extends BaseAPI {
    /**
     * Authenticates the credentials provided and returns the set roles and permissions allowed.
     * @summary Verify authentication
     * @param {boolean} [returnClientList]
     * @param {InlineObject7} [inlineObject7]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthenticationHTTPBasicApi
     */
    authenticate(returnClientList?: boolean, inlineObject7?: InlineObject7, options?: any): Promise<import("axios").AxiosResponse<PostAuthenticationResponse>>;
}