UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

179 lines (178 loc) 9.97 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'; import { GetFloatingRatesFloatingRateIdResponse } from '../models'; import { GetFloatingRatesResponse } from '../models'; import { PostFloatingRatesRequest } from '../models'; import { PostFloatingRatesResponse } from '../models'; import { PutFloatingRatesFloatingRateIdRequest } from '../models'; import { PutFloatingRatesFloatingRateIdResponse } from '../models'; /** * FloatingRatesApi - axios parameter creator * @export */ export declare const FloatingRatesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Creates a new Floating Rate Mandatory Fields: name Optional Fields: isBaseLendingRate, isActive, ratePeriods * @summary Create a new Floating Rate * @param {PostFloatingRatesRequest} postFloatingRatesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFloatingRate: (postFloatingRatesRequest: PostFloatingRatesRequest, options?: any) => Promise<RequestArgs>; /** * Lists Floating Rates * @summary List Floating Rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll22: (options?: any) => Promise<RequestArgs>; /** * Retrieves Floating Rate * @summary Retrieve Floating Rate * @param {number} floatingRateId floatingRateId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne12: (floatingRateId: number, options?: any) => Promise<RequestArgs>; /** * Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent. * @summary Update Floating Rate * @param {number} floatingRateId floatingRateId * @param {PutFloatingRatesFloatingRateIdRequest} putFloatingRatesFloatingRateIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFloatingRate: (floatingRateId: number, putFloatingRatesFloatingRateIdRequest: PutFloatingRatesFloatingRateIdRequest, options?: any) => Promise<RequestArgs>; }; /** * FloatingRatesApi - functional programming interface * @export */ export declare const FloatingRatesApiFp: (configuration?: Configuration) => { /** * Creates a new Floating Rate Mandatory Fields: name Optional Fields: isBaseLendingRate, isActive, ratePeriods * @summary Create a new Floating Rate * @param {PostFloatingRatesRequest} postFloatingRatesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFloatingRate(postFloatingRatesRequest: PostFloatingRatesRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFloatingRatesResponse>>; /** * Lists Floating Rates * @summary List Floating Rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll22(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetFloatingRatesResponse>>>; /** * Retrieves Floating Rate * @summary Retrieve Floating Rate * @param {number} floatingRateId floatingRateId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne12(floatingRateId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFloatingRatesFloatingRateIdResponse>>; /** * Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent. * @summary Update Floating Rate * @param {number} floatingRateId floatingRateId * @param {PutFloatingRatesFloatingRateIdRequest} putFloatingRatesFloatingRateIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFloatingRate(floatingRateId: number, putFloatingRatesFloatingRateIdRequest: PutFloatingRatesFloatingRateIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutFloatingRatesFloatingRateIdResponse>>; }; /** * FloatingRatesApi - factory interface * @export */ export declare const FloatingRatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Creates a new Floating Rate Mandatory Fields: name Optional Fields: isBaseLendingRate, isActive, ratePeriods * @summary Create a new Floating Rate * @param {PostFloatingRatesRequest} postFloatingRatesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFloatingRate(postFloatingRatesRequest: PostFloatingRatesRequest, options?: any): AxiosPromise<PostFloatingRatesResponse>; /** * Lists Floating Rates * @summary List Floating Rates * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAll22(options?: any): AxiosPromise<Array<GetFloatingRatesResponse>>; /** * Retrieves Floating Rate * @summary Retrieve Floating Rate * @param {number} floatingRateId floatingRateId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveOne12(floatingRateId: number, options?: any): AxiosPromise<GetFloatingRatesFloatingRateIdResponse>; /** * Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent. * @summary Update Floating Rate * @param {number} floatingRateId floatingRateId * @param {PutFloatingRatesFloatingRateIdRequest} putFloatingRatesFloatingRateIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFloatingRate(floatingRateId: number, putFloatingRatesFloatingRateIdRequest: PutFloatingRatesFloatingRateIdRequest, options?: any): AxiosPromise<PutFloatingRatesFloatingRateIdResponse>; }; /** * FloatingRatesApi - object-oriented interface * @export * @class FloatingRatesApi * @extends {BaseAPI} */ export declare class FloatingRatesApi extends BaseAPI { /** * Creates a new Floating Rate Mandatory Fields: name Optional Fields: isBaseLendingRate, isActive, ratePeriods * @summary Create a new Floating Rate * @param {PostFloatingRatesRequest} postFloatingRatesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FloatingRatesApi */ createFloatingRate(postFloatingRatesRequest: PostFloatingRatesRequest, options?: any): Promise<import("axios").AxiosResponse<PostFloatingRatesResponse>>; /** * Lists Floating Rates * @summary List Floating Rates * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FloatingRatesApi */ retrieveAll22(options?: any): Promise<import("axios").AxiosResponse<GetFloatingRatesResponse[]>>; /** * Retrieves Floating Rate * @summary Retrieve Floating Rate * @param {number} floatingRateId floatingRateId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FloatingRatesApi */ retrieveOne12(floatingRateId: number, options?: any): Promise<import("axios").AxiosResponse<GetFloatingRatesFloatingRateIdResponse>>; /** * Updates new Floating Rate. Rate Periods in the past cannot be modified. All the future rateperiods would be replaced with the new ratePeriods data sent. * @summary Update Floating Rate * @param {number} floatingRateId floatingRateId * @param {PutFloatingRatesFloatingRateIdRequest} putFloatingRatesFloatingRateIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FloatingRatesApi */ updateFloatingRate(floatingRateId: number, putFloatingRatesFloatingRateIdRequest: PutFloatingRatesFloatingRateIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutFloatingRatesFloatingRateIdResponse>>; }