fineract_sdk
Version:
Wrapper around fineract api.
261 lines (260 loc) • 15.1 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 { DeleteInterestRateChartsChartIdChartSlabsResponse } from '../models';
import { GetInterestRateChartsChartIdChartSlabsResponse } from '../models';
import { PostInterestRateChartsChartIdChartSlabsRequest } from '../models';
import { PostInterestRateChartsChartIdChartSlabsResponse } from '../models';
import { PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest } from '../models';
import { PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse } from '../models';
/**
* InterestRateSlabAKAInterestBandsApi - axios parameter creator
* @export
*/
export declare const InterestRateSlabAKAInterestBandsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new interest rate slab for an interest rate chart. Mandatory Fields periodType, fromPeriod, annualInterestRate Optional Fields toPeriod and description Example Requests: interestratecharts/1/chartslabs
* @summary Create a Slab
* @param {number} chartId chartId
* @param {PostInterestRateChartsChartIdChartSlabsRequest} postInterestRateChartsChartIdChartSlabsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create9: (chartId: number, postInterestRateChartsChartIdChartSlabsRequest: PostInterestRateChartsChartIdChartSlabsRequest, options?: any) => Promise<RequestArgs>;
/**
* Delete a Slab from a chart
* @summary Delete a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete12: (chartId: number, chartSlabId: number, options?: any) => Promise<RequestArgs>;
/**
* Retrieve list of slabs associated with a chart Example Requests: interestratecharts/1/chartslabs
* @summary Retrieve all Slabs
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll25: (chartId: number, options?: any) => Promise<RequestArgs>;
/**
* Retrieve a slab associated with an Interest rate chart Example Requests: interestratecharts/1/chartslabs/1
* @summary Retrieve a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne15: (chartId: number, chartSlabId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template8: (chartId: number, options?: any) => Promise<RequestArgs>;
/**
* It updates the Slab from chart
* @summary Update a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest} putInterestRateChartsChartIdChartSlabsChartSlabIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update13: (chartId: number, chartSlabId: number, putInterestRateChartsChartIdChartSlabsChartSlabIdRequest: PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* InterestRateSlabAKAInterestBandsApi - functional programming interface
* @export
*/
export declare const InterestRateSlabAKAInterestBandsApiFp: (configuration?: Configuration) => {
/**
* Creates a new interest rate slab for an interest rate chart. Mandatory Fields periodType, fromPeriod, annualInterestRate Optional Fields toPeriod and description Example Requests: interestratecharts/1/chartslabs
* @summary Create a Slab
* @param {number} chartId chartId
* @param {PostInterestRateChartsChartIdChartSlabsRequest} postInterestRateChartsChartIdChartSlabsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create9(chartId: number, postInterestRateChartsChartIdChartSlabsRequest: PostInterestRateChartsChartIdChartSlabsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostInterestRateChartsChartIdChartSlabsResponse>>;
/**
* Delete a Slab from a chart
* @summary Delete a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete12(chartId: number, chartSlabId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteInterestRateChartsChartIdChartSlabsResponse>>;
/**
* Retrieve list of slabs associated with a chart Example Requests: interestratecharts/1/chartslabs
* @summary Retrieve all Slabs
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll25(chartId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetInterestRateChartsChartIdChartSlabsResponse>>>;
/**
* Retrieve a slab associated with an Interest rate chart Example Requests: interestratecharts/1/chartslabs/1
* @summary Retrieve a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne15(chartId: number, chartSlabId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInterestRateChartsChartIdChartSlabsResponse>>;
/**
*
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template8(chartId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* It updates the Slab from chart
* @summary Update a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest} putInterestRateChartsChartIdChartSlabsChartSlabIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update13(chartId: number, chartSlabId: number, putInterestRateChartsChartIdChartSlabsChartSlabIdRequest: PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse>>;
};
/**
* InterestRateSlabAKAInterestBandsApi - factory interface
* @export
*/
export declare const InterestRateSlabAKAInterestBandsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new interest rate slab for an interest rate chart. Mandatory Fields periodType, fromPeriod, annualInterestRate Optional Fields toPeriod and description Example Requests: interestratecharts/1/chartslabs
* @summary Create a Slab
* @param {number} chartId chartId
* @param {PostInterestRateChartsChartIdChartSlabsRequest} postInterestRateChartsChartIdChartSlabsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create9(chartId: number, postInterestRateChartsChartIdChartSlabsRequest: PostInterestRateChartsChartIdChartSlabsRequest, options?: any): AxiosPromise<PostInterestRateChartsChartIdChartSlabsResponse>;
/**
* Delete a Slab from a chart
* @summary Delete a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete12(chartId: number, chartSlabId: number, options?: any): AxiosPromise<DeleteInterestRateChartsChartIdChartSlabsResponse>;
/**
* Retrieve list of slabs associated with a chart Example Requests: interestratecharts/1/chartslabs
* @summary Retrieve all Slabs
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll25(chartId: number, options?: any): AxiosPromise<Array<GetInterestRateChartsChartIdChartSlabsResponse>>;
/**
* Retrieve a slab associated with an Interest rate chart Example Requests: interestratecharts/1/chartslabs/1
* @summary Retrieve a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne15(chartId: number, chartSlabId: number, options?: any): AxiosPromise<GetInterestRateChartsChartIdChartSlabsResponse>;
/**
*
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template8(chartId: number, options?: any): AxiosPromise<string>;
/**
* It updates the Slab from chart
* @summary Update a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest} putInterestRateChartsChartIdChartSlabsChartSlabIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update13(chartId: number, chartSlabId: number, putInterestRateChartsChartIdChartSlabsChartSlabIdRequest: PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest, options?: any): AxiosPromise<PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse>;
};
/**
* InterestRateSlabAKAInterestBandsApi - object-oriented interface
* @export
* @class InterestRateSlabAKAInterestBandsApi
* @extends {BaseAPI}
*/
export declare class InterestRateSlabAKAInterestBandsApi extends BaseAPI {
/**
* Creates a new interest rate slab for an interest rate chart. Mandatory Fields periodType, fromPeriod, annualInterestRate Optional Fields toPeriod and description Example Requests: interestratecharts/1/chartslabs
* @summary Create a Slab
* @param {number} chartId chartId
* @param {PostInterestRateChartsChartIdChartSlabsRequest} postInterestRateChartsChartIdChartSlabsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
create9(chartId: number, postInterestRateChartsChartIdChartSlabsRequest: PostInterestRateChartsChartIdChartSlabsRequest, options?: any): Promise<import("axios").AxiosResponse<PostInterestRateChartsChartIdChartSlabsResponse>>;
/**
* Delete a Slab from a chart
* @summary Delete a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
delete12(chartId: number, chartSlabId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteInterestRateChartsChartIdChartSlabsResponse>>;
/**
* Retrieve list of slabs associated with a chart Example Requests: interestratecharts/1/chartslabs
* @summary Retrieve all Slabs
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
retrieveAll25(chartId: number, options?: any): Promise<import("axios").AxiosResponse<GetInterestRateChartsChartIdChartSlabsResponse[]>>;
/**
* Retrieve a slab associated with an Interest rate chart Example Requests: interestratecharts/1/chartslabs/1
* @summary Retrieve a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
retrieveOne15(chartId: number, chartSlabId: number, options?: any): Promise<import("axios").AxiosResponse<GetInterestRateChartsChartIdChartSlabsResponse>>;
/**
*
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
template8(chartId: number, options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* It updates the Slab from chart
* @summary Update a Slab
* @param {number} chartId chartId
* @param {number} chartSlabId chartSlabId
* @param {PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest} putInterestRateChartsChartIdChartSlabsChartSlabIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateSlabAKAInterestBandsApi
*/
update13(chartId: number, chartSlabId: number, putInterestRateChartsChartIdChartSlabsChartSlabIdRequest: PutInterestRateChartsChartIdChartSlabsChartSlabIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutInterestRateChartsChartIdChartSlabsChartSlabIdResponse>>;
}