fineract_sdk
Version:
Wrapper around fineract api.
351 lines (350 loc) • 14.3 kB
TypeScript
/**
* 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 { FormDataContentDisposition } from '../models';
/**
* GuarantorsApi - axios parameter creator
* @export
*/
export declare const GuarantorsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @param {number} loanId
* @param {number} [clientId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
accountsTemplate: (loanId: number, clientId?: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGuarantor: (loanId: number, body?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {number} [guarantorFundingId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGuarantor: (loanId: number, guarantorId: number, guarantorFundingId?: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGuarantorTemplate: (loanId: number, officeId?: number, dateFormat?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newGuarantorTemplate: (loanId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGuarantorTemplate: (loanId: number, file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails: (loanId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails1: (loanId: number, guarantorId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGuarantor: (loanId: number, guarantorId: number, body?: string, options?: any) => Promise<RequestArgs>;
};
/**
* GuarantorsApi - functional programming interface
* @export
*/
export declare const GuarantorsApiFp: (configuration?: Configuration) => {
/**
*
* @param {number} loanId
* @param {number} [clientId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
accountsTemplate(loanId: number, clientId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGuarantor(loanId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {number} [guarantorFundingId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGuarantor(loanId: number, guarantorId: number, guarantorFundingId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGuarantorTemplate(loanId: number, officeId?: number, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newGuarantorTemplate(loanId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGuarantorTemplate(loanId: number, file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails(loanId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails1(loanId: number, guarantorId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGuarantor(loanId: number, guarantorId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
* GuarantorsApi - factory interface
* @export
*/
export declare const GuarantorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @param {number} loanId
* @param {number} [clientId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
accountsTemplate(loanId: number, clientId?: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGuarantor(loanId: number, body?: string, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {number} [guarantorFundingId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGuarantor(loanId: number, guarantorId: number, guarantorFundingId?: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getGuarantorTemplate(loanId: number, officeId?: number, dateFormat?: string, options?: any): AxiosPromise<void>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newGuarantorTemplate(loanId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postGuarantorTemplate(loanId: number, file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails(loanId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGuarantorDetails1(loanId: number, guarantorId: number, options?: any): AxiosPromise<string>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGuarantor(loanId: number, guarantorId: number, body?: string, options?: any): AxiosPromise<string>;
};
/**
* GuarantorsApi - object-oriented interface
* @export
* @class GuarantorsApi
* @extends {BaseAPI}
*/
export declare class GuarantorsApi extends BaseAPI {
/**
*
* @param {number} loanId
* @param {number} [clientId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
accountsTemplate(loanId: number, clientId?: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
createGuarantor(loanId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {number} [guarantorFundingId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
deleteGuarantor(loanId: number, guarantorId: number, guarantorFundingId?: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
getGuarantorTemplate(loanId: number, officeId?: number, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
newGuarantorTemplate(loanId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
postGuarantorTemplate(loanId: number, file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
retrieveGuarantorDetails(loanId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
retrieveGuarantorDetails1(loanId: number, guarantorId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
*
* @param {number} loanId
* @param {number} guarantorId
* @param {string} [body]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GuarantorsApi
*/
updateGuarantor(loanId: number, guarantorId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
}