fineract_sdk
Version:
Wrapper around fineract api.
236 lines (235 loc) • 12.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 { DeleteFinancialActivityAccountsResponse } from '../models';
import { GetFinancialActivityAccountsResponse } from '../models';
import { PostFinancialActivityAccountsRequest } from '../models';
import { PostFinancialActivityAccountsResponse } from '../models';
import { PutFinancialActivityAccountsResponse } from '../models';
/**
* MappingFinancialActivitiesToAccountsApi - axios parameter creator
* @export
*/
export declare const MappingFinancialActivitiesToAccountsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Mandatory Fields financialActivityId, glAccountId
* @summary Create a new Financial Activity to Accounts Mapping
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLAccount: (postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Delete a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGLAccount: (mappingId: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: financialactivityaccounts/1
* @summary Retrieve a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreive: (mappingId: number, options?: any) => Promise<RequestArgs>;
/**
* Example Requests: financialactivityaccounts
* @summary List Financial Activities to Accounts Mappings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll: (options?: any) => Promise<RequestArgs>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate: (options?: any) => Promise<RequestArgs>;
/**
* the API updates the Ledger account linked to a Financial Activity
* @summary Update a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGLAccount: (mappingId: number, postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any) => Promise<RequestArgs>;
};
/**
* MappingFinancialActivitiesToAccountsApi - functional programming interface
* @export
*/
export declare const MappingFinancialActivitiesToAccountsApiFp: (configuration?: Configuration) => {
/**
* Mandatory Fields financialActivityId, glAccountId
* @summary Create a new Financial Activity to Accounts Mapping
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLAccount(postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFinancialActivityAccountsResponse>>;
/**
*
* @summary Delete a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGLAccount(mappingId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFinancialActivityAccountsResponse>>;
/**
* Example Requests: financialactivityaccounts/1
* @summary Retrieve a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreive(mappingId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFinancialActivityAccountsResponse>>;
/**
* Example Requests: financialactivityaccounts
* @summary List Financial Activities to Accounts Mappings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetFinancialActivityAccountsResponse>>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* the API updates the Ledger account linked to a Financial Activity
* @summary Update a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGLAccount(mappingId: number, postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutFinancialActivityAccountsResponse>>;
};
/**
* MappingFinancialActivitiesToAccountsApi - factory interface
* @export
*/
export declare const MappingFinancialActivitiesToAccountsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Mandatory Fields financialActivityId, glAccountId
* @summary Create a new Financial Activity to Accounts Mapping
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLAccount(postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): AxiosPromise<PostFinancialActivityAccountsResponse>;
/**
*
* @summary Delete a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteGLAccount(mappingId: number, options?: any): AxiosPromise<DeleteFinancialActivityAccountsResponse>;
/**
* Example Requests: financialactivityaccounts/1
* @summary Retrieve a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreive(mappingId: number, options?: any): AxiosPromise<GetFinancialActivityAccountsResponse>;
/**
* Example Requests: financialactivityaccounts
* @summary List Financial Activities to Accounts Mappings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll(options?: any): AxiosPromise<Array<GetFinancialActivityAccountsResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate(options?: any): AxiosPromise<string>;
/**
* the API updates the Ledger account linked to a Financial Activity
* @summary Update a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateGLAccount(mappingId: number, postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): AxiosPromise<PutFinancialActivityAccountsResponse>;
};
/**
* MappingFinancialActivitiesToAccountsApi - object-oriented interface
* @export
* @class MappingFinancialActivitiesToAccountsApi
* @extends {BaseAPI}
*/
export declare class MappingFinancialActivitiesToAccountsApi extends BaseAPI {
/**
* Mandatory Fields financialActivityId, glAccountId
* @summary Create a new Financial Activity to Accounts Mapping
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
createGLAccount(postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): Promise<import("axios").AxiosResponse<PostFinancialActivityAccountsResponse>>;
/**
*
* @summary Delete a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
deleteGLAccount(mappingId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteFinancialActivityAccountsResponse>>;
/**
* Example Requests: financialactivityaccounts/1
* @summary Retrieve a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
retreive(mappingId: number, options?: any): Promise<import("axios").AxiosResponse<GetFinancialActivityAccountsResponse>>;
/**
* Example Requests: financialactivityaccounts
* @summary List Financial Activities to Accounts Mappings
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
retrieveAll(options?: any): Promise<import("axios").AxiosResponse<GetFinancialActivityAccountsResponse[]>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
retrieveTemplate(options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* the API updates the Ledger account linked to a Financial Activity
* @summary Update a Financial Activity to Account Mapping
* @param {number} mappingId mappingId
* @param {PostFinancialActivityAccountsRequest} [postFinancialActivityAccountsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof MappingFinancialActivitiesToAccountsApi
*/
updateGLAccount(mappingId: number, postFinancialActivityAccountsRequest?: PostFinancialActivityAccountsRequest, options?: any): Promise<import("axios").AxiosResponse<PutFinancialActivityAccountsResponse>>;
}