fineract_sdk
Version:
Wrapper around fineract api.
266 lines (265 loc) • 15.4 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 { DeleteLoansLoanIdCollateralsCollateralIdResponse } from '../models';
import { GetLoansLoanIdCollateralsResponse } from '../models';
import { GetLoansLoanIdCollateralsTemplateResponse } from '../models';
import { PostLoansLoanIdCollateralsRequest } from '../models';
import { PostLoansLoanIdCollateralsResponse } from '../models';
import { PutLoansLoanIdCollateralsCollateralIdResponse } from '../models';
import { PutLoansLoandIdCollateralsCollateralIdRequest } from '../models';
/**
* LoanCollateralApi - axios parameter creator
* @export
*/
export declare const LoanCollateralApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Note: Currently, Collaterals may be added only before a Loan is approved
* @summary Create a Collateral
* @param {number} loanId loanId
* @param {PostLoansLoanIdCollateralsRequest} postLoansLoanIdCollateralsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollateral: (loanId: number, postLoansLoanIdCollateralsRequest: PostLoansLoanIdCollateralsRequest, options?: any) => Promise<RequestArgs>;
/**
* Note: A collateral can only be removed from Loans that are not yet approved.
* @summary Remove a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCollateral: (loanId: number, collateralId: number, options?: any) => Promise<RequestArgs>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
* @summary Retrieve Collateral Details Template
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newCollateralTemplate: (loanId: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
* @summary List Loan Collaterals
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails: (loanId: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
* @summary Retrieve a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails1: (loanId: number, collateralId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Update a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {PutLoansLoandIdCollateralsCollateralIdRequest} putLoansLoandIdCollateralsCollateralIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCollateral: (loanId: number, collateralId: number, putLoansLoandIdCollateralsCollateralIdRequest: PutLoansLoandIdCollateralsCollateralIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* LoanCollateralApi - functional programming interface
* @export
*/
export declare const LoanCollateralApiFp: (configuration?: Configuration) => {
/**
* Note: Currently, Collaterals may be added only before a Loan is approved
* @summary Create a Collateral
* @param {number} loanId loanId
* @param {PostLoansLoanIdCollateralsRequest} postLoansLoanIdCollateralsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollateral(loanId: number, postLoansLoanIdCollateralsRequest: PostLoansLoanIdCollateralsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostLoansLoanIdCollateralsResponse>>;
/**
* Note: A collateral can only be removed from Loans that are not yet approved.
* @summary Remove a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCollateral(loanId: number, collateralId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteLoansLoanIdCollateralsCollateralIdResponse>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
* @summary Retrieve Collateral Details Template
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newCollateralTemplate(loanId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoansLoanIdCollateralsTemplateResponse>>;
/**
* Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
* @summary List Loan Collaterals
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails(loanId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetLoansLoanIdCollateralsResponse>>>;
/**
* Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
* @summary Retrieve a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails1(loanId: number, collateralId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoansLoanIdCollateralsResponse>>;
/**
*
* @summary Update a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {PutLoansLoandIdCollateralsCollateralIdRequest} putLoansLoandIdCollateralsCollateralIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCollateral(loanId: number, collateralId: number, putLoansLoandIdCollateralsCollateralIdRequest: PutLoansLoandIdCollateralsCollateralIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutLoansLoanIdCollateralsCollateralIdResponse>>;
};
/**
* LoanCollateralApi - factory interface
* @export
*/
export declare const LoanCollateralApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Note: Currently, Collaterals may be added only before a Loan is approved
* @summary Create a Collateral
* @param {number} loanId loanId
* @param {PostLoansLoanIdCollateralsRequest} postLoansLoanIdCollateralsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollateral(loanId: number, postLoansLoanIdCollateralsRequest: PostLoansLoanIdCollateralsRequest, options?: any): AxiosPromise<PostLoansLoanIdCollateralsResponse>;
/**
* Note: A collateral can only be removed from Loans that are not yet approved.
* @summary Remove a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCollateral(loanId: number, collateralId: number, options?: any): AxiosPromise<DeleteLoansLoanIdCollateralsCollateralIdResponse>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
* @summary Retrieve Collateral Details Template
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
newCollateralTemplate(loanId: number, options?: any): AxiosPromise<GetLoansLoanIdCollateralsTemplateResponse>;
/**
* Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
* @summary List Loan Collaterals
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails(loanId: number, options?: any): AxiosPromise<Array<GetLoansLoanIdCollateralsResponse>>;
/**
* Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
* @summary Retrieve a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveCollateralDetails1(loanId: number, collateralId: number, options?: any): AxiosPromise<GetLoansLoanIdCollateralsResponse>;
/**
*
* @summary Update a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {PutLoansLoandIdCollateralsCollateralIdRequest} putLoansLoandIdCollateralsCollateralIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCollateral(loanId: number, collateralId: number, putLoansLoandIdCollateralsCollateralIdRequest: PutLoansLoandIdCollateralsCollateralIdRequest, options?: any): AxiosPromise<PutLoansLoanIdCollateralsCollateralIdResponse>;
};
/**
* LoanCollateralApi - object-oriented interface
* @export
* @class LoanCollateralApi
* @extends {BaseAPI}
*/
export declare class LoanCollateralApi extends BaseAPI {
/**
* Note: Currently, Collaterals may be added only before a Loan is approved
* @summary Create a Collateral
* @param {number} loanId loanId
* @param {PostLoansLoanIdCollateralsRequest} postLoansLoanIdCollateralsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
createCollateral(loanId: number, postLoansLoanIdCollateralsRequest: PostLoansLoanIdCollateralsRequest, options?: any): Promise<import("axios").AxiosResponse<PostLoansLoanIdCollateralsResponse>>;
/**
* Note: A collateral can only be removed from Loans that are not yet approved.
* @summary Remove a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
deleteCollateral(loanId: number, collateralId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteLoansLoanIdCollateralsCollateralIdResponse>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: loans/1/collaterals/template
* @summary Retrieve Collateral Details Template
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
newCollateralTemplate(loanId: number, options?: any): Promise<import("axios").AxiosResponse<GetLoansLoanIdCollateralsTemplateResponse>>;
/**
* Example Requests: loans/1/collaterals loans/1/collaterals?fields=value,description
* @summary List Loan Collaterals
* @param {number} loanId loanId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
retrieveCollateralDetails(loanId: number, options?: any): Promise<import("axios").AxiosResponse<GetLoansLoanIdCollateralsResponse[]>>;
/**
* Example Requests: /loans/1/collaterals/1 /loans/1/collaterals/1?fields=description,description
* @summary Retrieve a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
retrieveCollateralDetails1(loanId: number, collateralId: number, options?: any): Promise<import("axios").AxiosResponse<GetLoansLoanIdCollateralsResponse>>;
/**
*
* @summary Update a Collateral
* @param {number} loanId loanId
* @param {number} collateralId collateralId
* @param {PutLoansLoandIdCollateralsCollateralIdRequest} putLoansLoandIdCollateralsCollateralIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof LoanCollateralApi
*/
updateCollateral(loanId: number, collateralId: number, putLoansLoandIdCollateralsCollateralIdRequest: PutLoansLoandIdCollateralsCollateralIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutLoansLoanIdCollateralsCollateralIdResponse>>;
}