UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

113 lines (112 loc) 6.19 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 { GetAccountTransferTemplateResponse } from '../models'; import { PostNewTransferResponse } from '../models'; /** * SelfAccountTransferApi - axios parameter creator * @export */ export declare const SelfAccountTransferApiAxiosParamCreator: (configuration?: Configuration) => { /** * Ability to create new transfer of monetary funds from one account to another. Example Requests: self/accounttransfers/ * @summary Create new Transfer * @param {string} [type] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create14: (type?: string, body?: string, options?: any) => Promise<RequestArgs>; /** * Returns list of loan/savings accounts that can be used for account transfer Example Requests: self/accounttransfers/template * @summary Retrieve Account Transfer Template * @param {string} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ template15: (type?: string, options?: any) => Promise<RequestArgs>; }; /** * SelfAccountTransferApi - functional programming interface * @export */ export declare const SelfAccountTransferApiFp: (configuration?: Configuration) => { /** * Ability to create new transfer of monetary funds from one account to another. Example Requests: self/accounttransfers/ * @summary Create new Transfer * @param {string} [type] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create14(type?: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PostNewTransferResponse>>>; /** * Returns list of loan/savings accounts that can be used for account transfer Example Requests: self/accounttransfers/template * @summary Retrieve Account Transfer Template * @param {string} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ template15(type?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetAccountTransferTemplateResponse>>>; }; /** * SelfAccountTransferApi - factory interface * @export */ export declare const SelfAccountTransferApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Ability to create new transfer of monetary funds from one account to another. Example Requests: self/accounttransfers/ * @summary Create new Transfer * @param {string} [type] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} */ create14(type?: string, body?: string, options?: any): AxiosPromise<Array<PostNewTransferResponse>>; /** * Returns list of loan/savings accounts that can be used for account transfer Example Requests: self/accounttransfers/template * @summary Retrieve Account Transfer Template * @param {string} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} */ template15(type?: string, options?: any): AxiosPromise<Array<GetAccountTransferTemplateResponse>>; }; /** * SelfAccountTransferApi - object-oriented interface * @export * @class SelfAccountTransferApi * @extends {BaseAPI} */ export declare class SelfAccountTransferApi extends BaseAPI { /** * Ability to create new transfer of monetary funds from one account to another. Example Requests: self/accounttransfers/ * @summary Create new Transfer * @param {string} [type] * @param {string} [body] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfAccountTransferApi */ create14(type?: string, body?: string, options?: any): Promise<import("axios").AxiosResponse<PostNewTransferResponse[]>>; /** * Returns list of loan/savings accounts that can be used for account transfer Example Requests: self/accounttransfers/template * @summary Retrieve Account Transfer Template * @param {string} [type] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SelfAccountTransferApi */ template15(type?: string, options?: any): Promise<import("axios").AxiosResponse<GetAccountTransferTemplateResponse[]>>; }