fineract_sdk
Version:
Wrapper around fineract api.
246 lines (245 loc) • 13.5 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 { DeleteInterestRateChartsChartIdResponse } from '../models';
import { GetInterestRateChartsResponse } from '../models';
import { GetInterestRateChartsTemplateResponse } from '../models';
import { PostInterestRateChartsRequest } from '../models';
import { PostInterestRateChartsResponse } from '../models';
import { PutInterestRateChartsChartIdRequest } from '../models';
import { PutInterestRateChartsChartIdResponse } from '../models';
/**
* InterestRateChartApi - axios parameter creator
* @export
*/
export declare const InterestRateChartApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new chart which can be attached to a term deposit products (FD or RD).
* @summary Create a Chart
* @param {PostInterestRateChartsRequest} postInterestRateChartsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create10: (postInterestRateChartsRequest: PostInterestRateChartsRequest, options?: any) => Promise<RequestArgs>;
/**
* It deletes the chart
* @summary Delete a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete13: (chartId: number, options?: any) => Promise<RequestArgs>;
/**
* Retrieve list of charts associated with a term deposit product(FD or RD). Example Requests: interestratecharts?productId=1
* @summary Retrieve all Charts
* @param {number} [productId] productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll26: (productId?: number, options?: any) => Promise<RequestArgs>;
/**
* It retrieves the Interest Rate Chart Example Requests: interestratecharts/1
* @summary Retrieve a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne16: (chartId: number, options?: any) => Promise<RequestArgs>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: interestratecharts/template
* @summary Retrieve Chart Details Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template9: (options?: any) => Promise<RequestArgs>;
/**
* It updates the chart
* @summary Update a Chart
* @param {number} chartId chartId
* @param {PutInterestRateChartsChartIdRequest} putInterestRateChartsChartIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update14: (chartId: number, putInterestRateChartsChartIdRequest: PutInterestRateChartsChartIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* InterestRateChartApi - functional programming interface
* @export
*/
export declare const InterestRateChartApiFp: (configuration?: Configuration) => {
/**
* Creates a new chart which can be attached to a term deposit products (FD or RD).
* @summary Create a Chart
* @param {PostInterestRateChartsRequest} postInterestRateChartsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create10(postInterestRateChartsRequest: PostInterestRateChartsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostInterestRateChartsResponse>>;
/**
* It deletes the chart
* @summary Delete a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete13(chartId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteInterestRateChartsChartIdResponse>>;
/**
* Retrieve list of charts associated with a term deposit product(FD or RD). Example Requests: interestratecharts?productId=1
* @summary Retrieve all Charts
* @param {number} [productId] productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll26(productId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetInterestRateChartsResponse>>>;
/**
* It retrieves the Interest Rate Chart Example Requests: interestratecharts/1
* @summary Retrieve a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne16(chartId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInterestRateChartsResponse>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: interestratecharts/template
* @summary Retrieve Chart Details Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template9(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetInterestRateChartsTemplateResponse>>;
/**
* It updates the chart
* @summary Update a Chart
* @param {number} chartId chartId
* @param {PutInterestRateChartsChartIdRequest} putInterestRateChartsChartIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update14(chartId: number, putInterestRateChartsChartIdRequest: PutInterestRateChartsChartIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutInterestRateChartsChartIdResponse>>;
};
/**
* InterestRateChartApi - factory interface
* @export
*/
export declare const InterestRateChartApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new chart which can be attached to a term deposit products (FD or RD).
* @summary Create a Chart
* @param {PostInterestRateChartsRequest} postInterestRateChartsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create10(postInterestRateChartsRequest: PostInterestRateChartsRequest, options?: any): AxiosPromise<PostInterestRateChartsResponse>;
/**
* It deletes the chart
* @summary Delete a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete13(chartId: number, options?: any): AxiosPromise<DeleteInterestRateChartsChartIdResponse>;
/**
* Retrieve list of charts associated with a term deposit product(FD or RD). Example Requests: interestratecharts?productId=1
* @summary Retrieve all Charts
* @param {number} [productId] productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll26(productId?: number, options?: any): AxiosPromise<Array<GetInterestRateChartsResponse>>;
/**
* It retrieves the Interest Rate Chart Example Requests: interestratecharts/1
* @summary Retrieve a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne16(chartId: number, options?: any): AxiosPromise<GetInterestRateChartsResponse>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: interestratecharts/template
* @summary Retrieve Chart Details Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
template9(options?: any): AxiosPromise<GetInterestRateChartsTemplateResponse>;
/**
* It updates the chart
* @summary Update a Chart
* @param {number} chartId chartId
* @param {PutInterestRateChartsChartIdRequest} putInterestRateChartsChartIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update14(chartId: number, putInterestRateChartsChartIdRequest: PutInterestRateChartsChartIdRequest, options?: any): AxiosPromise<PutInterestRateChartsChartIdResponse>;
};
/**
* InterestRateChartApi - object-oriented interface
* @export
* @class InterestRateChartApi
* @extends {BaseAPI}
*/
export declare class InterestRateChartApi extends BaseAPI {
/**
* Creates a new chart which can be attached to a term deposit products (FD or RD).
* @summary Create a Chart
* @param {PostInterestRateChartsRequest} postInterestRateChartsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
create10(postInterestRateChartsRequest: PostInterestRateChartsRequest, options?: any): Promise<import("axios").AxiosResponse<PostInterestRateChartsResponse>>;
/**
* It deletes the chart
* @summary Delete a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
delete13(chartId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteInterestRateChartsChartIdResponse>>;
/**
* Retrieve list of charts associated with a term deposit product(FD or RD). Example Requests: interestratecharts?productId=1
* @summary Retrieve all Charts
* @param {number} [productId] productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
retrieveAll26(productId?: number, options?: any): Promise<import("axios").AxiosResponse<GetInterestRateChartsResponse[]>>;
/**
* It retrieves the Interest Rate Chart Example Requests: interestratecharts/1
* @summary Retrieve a Chart
* @param {number} chartId chartId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
retrieveOne16(chartId: number, options?: any): Promise<import("axios").AxiosResponse<GetInterestRateChartsResponse>>;
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for creating a chart. The template data returned consists of any or all of: Field Defaults Allowed Value Lists Example Request: interestratecharts/template
* @summary Retrieve Chart Details Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
template9(options?: any): Promise<import("axios").AxiosResponse<GetInterestRateChartsTemplateResponse>>;
/**
* It updates the chart
* @summary Update a Chart
* @param {number} chartId chartId
* @param {PutInterestRateChartsChartIdRequest} putInterestRateChartsChartIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof InterestRateChartApi
*/
update14(chartId: number, putInterestRateChartsChartIdRequest: PutInterestRateChartsChartIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutInterestRateChartsChartIdResponse>>;
}