fineract_sdk
Version:
Wrapper around fineract api.
242 lines (241 loc) • 14.6 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 { DeleteAccountNumberFormatsResponse } from '../models';
import { GetAccountNumberFormatsIdResponse } from '../models';
import { GetAccountNumberFormatsResponseTemplate } from '../models';
import { PostAccountNumberFormatsRequest } from '../models';
import { PostAccountNumberFormatsResponse } from '../models';
import { PutAccountNumberFormatsRequest } from '../models';
import { PutAccountNumberFormatsResponse } from '../models';
/**
* AccountNumberFormatApi - axios parameter creator
* @export
*/
export declare const AccountNumberFormatApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Note: Account numbers created while this format was active would remain unchanged.
* @summary Delete an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
_delete: (accountNumberFormatId: number, options?: any) => Promise<RequestArgs>;
/**
* Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
* @summary Create an Account number format
* @param {PostAccountNumberFormatsRequest} [postAccountNumberFormatsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create: (postAccountNumberFormatsRequest?: PostAccountNumberFormatsRequest, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
* @summary List Account number formats
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll3: (options?: any) => Promise<RequestArgs>;
/**
* Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
* @summary Retrieve an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne: (accountNumberFormatId: 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: accountnumberformats/template
* @summary Retrieve Account number format Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate2: (options?: any) => Promise<RequestArgs>;
/**
*
* @summary Update an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {PutAccountNumberFormatsRequest} putAccountNumberFormatsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update1: (accountNumberFormatId: number, putAccountNumberFormatsRequest: PutAccountNumberFormatsRequest, options?: any) => Promise<RequestArgs>;
};
/**
* AccountNumberFormatApi - functional programming interface
* @export
*/
export declare const AccountNumberFormatApiFp: (configuration?: Configuration) => {
/**
* Note: Account numbers created while this format was active would remain unchanged.
* @summary Delete an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
_delete(accountNumberFormatId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteAccountNumberFormatsResponse>>;
/**
* Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
* @summary Create an Account number format
* @param {PostAccountNumberFormatsRequest} [postAccountNumberFormatsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create(postAccountNumberFormatsRequest?: PostAccountNumberFormatsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostAccountNumberFormatsResponse>>;
/**
* Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
* @summary List Account number formats
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll3(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetAccountNumberFormatsIdResponse>>>;
/**
* Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
* @summary Retrieve an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne(accountNumberFormatId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountNumberFormatsIdResponse>>;
/**
* 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: accountnumberformats/template
* @summary Retrieve Account number format Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate2(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountNumberFormatsResponseTemplate>>;
/**
*
* @summary Update an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {PutAccountNumberFormatsRequest} putAccountNumberFormatsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update1(accountNumberFormatId: number, putAccountNumberFormatsRequest: PutAccountNumberFormatsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutAccountNumberFormatsResponse>>;
};
/**
* AccountNumberFormatApi - factory interface
* @export
*/
export declare const AccountNumberFormatApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Note: Account numbers created while this format was active would remain unchanged.
* @summary Delete an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
_delete(accountNumberFormatId: number, options?: any): AxiosPromise<DeleteAccountNumberFormatsResponse>;
/**
* Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
* @summary Create an Account number format
* @param {PostAccountNumberFormatsRequest} [postAccountNumberFormatsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create(postAccountNumberFormatsRequest?: PostAccountNumberFormatsRequest, options?: any): AxiosPromise<PostAccountNumberFormatsResponse>;
/**
* Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
* @summary List Account number formats
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll3(options?: any): AxiosPromise<Array<GetAccountNumberFormatsIdResponse>>;
/**
* Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
* @summary Retrieve an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne(accountNumberFormatId: number, options?: any): AxiosPromise<GetAccountNumberFormatsIdResponse>;
/**
* 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: accountnumberformats/template
* @summary Retrieve Account number format Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate2(options?: any): AxiosPromise<GetAccountNumberFormatsResponseTemplate>;
/**
*
* @summary Update an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {PutAccountNumberFormatsRequest} putAccountNumberFormatsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update1(accountNumberFormatId: number, putAccountNumberFormatsRequest: PutAccountNumberFormatsRequest, options?: any): AxiosPromise<PutAccountNumberFormatsResponse>;
};
/**
* AccountNumberFormatApi - object-oriented interface
* @export
* @class AccountNumberFormatApi
* @extends {BaseAPI}
*/
export declare class AccountNumberFormatApi extends BaseAPI {
/**
* Note: Account numbers created while this format was active would remain unchanged.
* @summary Delete an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
_delete(accountNumberFormatId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteAccountNumberFormatsResponse>>;
/**
* Note: You may associate a single Account number format for a given account type Mandatory Fields for Account number formats accountType
* @summary Create an Account number format
* @param {PostAccountNumberFormatsRequest} [postAccountNumberFormatsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
create(postAccountNumberFormatsRequest?: PostAccountNumberFormatsRequest, options?: any): Promise<import("axios").AxiosResponse<PostAccountNumberFormatsResponse>>;
/**
* Example Requests: accountnumberformats accountnumberformats?fields=accountType,prefixType
* @summary List Account number formats
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
retrieveAll3(options?: any): Promise<import("axios").AxiosResponse<GetAccountNumberFormatsIdResponse[]>>;
/**
* Example Requests: accountnumberformats/1 accountnumberformats/1?template=true accountnumberformats/1?fields=accountType,prefixType
* @summary Retrieve an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
retrieveOne(accountNumberFormatId: number, options?: any): Promise<import("axios").AxiosResponse<GetAccountNumberFormatsIdResponse>>;
/**
* 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: accountnumberformats/template
* @summary Retrieve Account number format Template
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
retrieveTemplate2(options?: any): Promise<import("axios").AxiosResponse<GetAccountNumberFormatsResponseTemplate>>;
/**
*
* @summary Update an Account number format
* @param {number} accountNumberFormatId accountNumberFormatId
* @param {PutAccountNumberFormatsRequest} putAccountNumberFormatsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof AccountNumberFormatApi
*/
update1(accountNumberFormatId: number, putAccountNumberFormatsRequest: PutAccountNumberFormatsRequest, options?: any): Promise<import("axios").AxiosResponse<PutAccountNumberFormatsResponse>>;
}