UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

75 lines (74 loc) 4.5 kB
/** * 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 { PostSelfAuthenticationResponse } from '../models'; /** * SelfAuthenticationApi - axios parameter creator * @export */ export declare const SelfAuthenticationApiAxiosParamCreator: (configuration?: Configuration) => { /** * Authenticates the credentials provided and returns the set roles and permissions allowed. Please visit this link for more info - https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#selfbasicauth * @summary Verify authentication * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate1: (body?: string, options?: any) => Promise<RequestArgs>; }; /** * SelfAuthenticationApi - functional programming interface * @export */ export declare const SelfAuthenticationApiFp: (configuration?: Configuration) => { /** * Authenticates the credentials provided and returns the set roles and permissions allowed. Please visit this link for more info - https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#selfbasicauth * @summary Verify authentication * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate1(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostSelfAuthenticationResponse>>; }; /** * SelfAuthenticationApi - factory interface * @export */ export declare const SelfAuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Authenticates the credentials provided and returns the set roles and permissions allowed. Please visit this link for more info - https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#selfbasicauth * @summary Verify authentication * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticate1(body?: string, options?: any): AxiosPromise<PostSelfAuthenticationResponse>; }; /** * SelfAuthenticationApi - object-oriented interface * @export * @class SelfAuthenticationApi * @extends {BaseAPI} */ export declare class SelfAuthenticationApi extends BaseAPI { /** * Authenticates the credentials provided and returns the set roles and permissions allowed. Please visit this link for more info - https://demo.fineract.dev/fineract-provider/api-docs/apiLive.htm#selfbasicauth * @summary Verify authentication * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfAuthenticationApi */ authenticate1(body?: string, options?: any): Promise<import("axios").AxiosResponse<PostSelfAuthenticationResponse>>; }