UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

389 lines (388 loc) 15.9 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'; /** * CreditBureauConfigurationApi - axios parameter creator * @export */ export declare const CreditBureauConfigurationApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrganisationCreditBureau: (organisationCreditBureauId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} creditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauConfiguration: (creditBureauId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauLoanProductMapping: (organisationCreditBureauId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchLoanProducts: (options?: any) => Promise<RequestArgs>; /** * * @param {number} loanProductId * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchMappingByLoanProductId: (loanProductId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} organisationCreditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfiguration: (organisationCreditBureauId: number, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureau: (options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureauLoanProductMapping: (options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganisationCreditBureau: (options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureau: (body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {number} configurationId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauConfiguration: (configurationId: number, body?: string, options?: any) => Promise<RequestArgs>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauLoanProductMapping: (body?: string, options?: any) => Promise<RequestArgs>; }; /** * CreditBureauConfigurationApi - functional programming interface * @export */ export declare const CreditBureauConfigurationApiFp: (configuration?: Configuration) => { /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrganisationCreditBureau(organisationCreditBureauId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} creditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauConfiguration(creditBureauId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauLoanProductMapping(organisationCreditBureauId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchLoanProducts(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} loanProductId * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchMappingByLoanProductId(loanProductId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} organisationCreditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfiguration(organisationCreditBureauId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureau(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureauLoanProductMapping(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganisationCreditBureau(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureau(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {number} configurationId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauConfiguration(configurationId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauLoanProductMapping(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; }; /** * CreditBureauConfigurationApi - factory interface * @export */ export declare const CreditBureauConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addOrganisationCreditBureau(organisationCreditBureauId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} creditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauConfiguration(creditBureauId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCreditBureauLoanProductMapping(organisationCreditBureauId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchLoanProducts(options?: any): AxiosPromise<string>; /** * * @param {number} loanProductId * @param {*} [options] Override http request option. * @throws {RequiredError} */ fetchMappingByLoanProductId(loanProductId: number, options?: any): AxiosPromise<string>; /** * * @param {number} organisationCreditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getConfiguration(organisationCreditBureauId: number, options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureau(options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCreditBureauLoanProductMapping(options?: any): AxiosPromise<string>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ getOrganisationCreditBureau(options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureau(body?: string, options?: any): AxiosPromise<string>; /** * * @param {number} configurationId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauConfiguration(configurationId: number, body?: string, options?: any): AxiosPromise<string>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCreditBureauLoanProductMapping(body?: string, options?: any): AxiosPromise<string>; }; /** * CreditBureauConfigurationApi - object-oriented interface * @export * @class CreditBureauConfigurationApi * @extends {BaseAPI} */ export declare class CreditBureauConfigurationApi extends BaseAPI { /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ addOrganisationCreditBureau(organisationCreditBureauId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} creditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ createCreditBureauConfiguration(creditBureauId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} organisationCreditBureauId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ createCreditBureauLoanProductMapping(organisationCreditBureauId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ fetchLoanProducts(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} loanProductId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ fetchMappingByLoanProductId(loanProductId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} organisationCreditBureauId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ getConfiguration(organisationCreditBureauId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ getCreditBureau(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ getCreditBureauLoanProductMapping(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ getOrganisationCreditBureau(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ updateCreditBureau(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {number} configurationId * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ updateCreditBureauConfiguration(configurationId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CreditBureauConfigurationApi */ updateCreditBureauLoanProductMapping(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; }