fineract_sdk
Version:
Wrapper around fineract api.
203 lines (202 loc) • 11 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 { GetTaxesComponentsResponse } from '../models';
import { PostTaxesComponentsRequest } from '../models';
import { PostTaxesComponentsResponse } from '../models';
import { PutTaxesComponentsTaxComponentIdRequest } from '../models';
import { PutTaxesComponentsTaxComponentIdResponse } from '../models';
/**
* TaxComponentsApi - axios parameter creator
* @export
*/
export declare const TaxComponentsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
* @summary Create a new Tax Component
* @param {PostTaxesComponentsRequest} postTaxesComponentsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTaxCompoent: (postTaxesComponentsRequest: PostTaxesComponentsRequest, options?: any) => Promise<RequestArgs>;
/**
* List Tax Components
* @summary List Tax Components
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllTaxComponents: (options?: any) => Promise<RequestArgs>;
/**
* Retrieve Tax Component
* @summary Retrieve Tax Component
* @param {number} taxComponentId taxComponentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTaxComponent: (taxComponentId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate20: (options?: any) => Promise<RequestArgs>;
/**
* Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.
* @summary Update Tax Component
* @param {number} taxComponentId taxComponentId
* @param {PutTaxesComponentsTaxComponentIdRequest} putTaxesComponentsTaxComponentIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateTaxCompoent: (taxComponentId: number, putTaxesComponentsTaxComponentIdRequest: PutTaxesComponentsTaxComponentIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* TaxComponentsApi - functional programming interface
* @export
*/
export declare const TaxComponentsApiFp: (configuration?: Configuration) => {
/**
* Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
* @summary Create a new Tax Component
* @param {PostTaxesComponentsRequest} postTaxesComponentsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTaxCompoent(postTaxesComponentsRequest: PostTaxesComponentsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTaxesComponentsResponse>>;
/**
* List Tax Components
* @summary List Tax Components
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllTaxComponents(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetTaxesComponentsResponse>>>;
/**
* Retrieve Tax Component
* @summary Retrieve Tax Component
* @param {number} taxComponentId taxComponentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTaxComponent(taxComponentId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaxesComponentsResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate20(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.
* @summary Update Tax Component
* @param {number} taxComponentId taxComponentId
* @param {PutTaxesComponentsTaxComponentIdRequest} putTaxesComponentsTaxComponentIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateTaxCompoent(taxComponentId: number, putTaxesComponentsTaxComponentIdRequest: PutTaxesComponentsTaxComponentIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTaxesComponentsTaxComponentIdResponse>>;
};
/**
* TaxComponentsApi - factory interface
* @export
*/
export declare const TaxComponentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
* @summary Create a new Tax Component
* @param {PostTaxesComponentsRequest} postTaxesComponentsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createTaxCompoent(postTaxesComponentsRequest: PostTaxesComponentsRequest, options?: any): AxiosPromise<PostTaxesComponentsResponse>;
/**
* List Tax Components
* @summary List Tax Components
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllTaxComponents(options?: any): AxiosPromise<Array<GetTaxesComponentsResponse>>;
/**
* Retrieve Tax Component
* @summary Retrieve Tax Component
* @param {number} taxComponentId taxComponentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTaxComponent(taxComponentId: number, options?: any): AxiosPromise<GetTaxesComponentsResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate20(options?: any): AxiosPromise<string>;
/**
* Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.
* @summary Update Tax Component
* @param {number} taxComponentId taxComponentId
* @param {PutTaxesComponentsTaxComponentIdRequest} putTaxesComponentsTaxComponentIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateTaxCompoent(taxComponentId: number, putTaxesComponentsTaxComponentIdRequest: PutTaxesComponentsTaxComponentIdRequest, options?: any): AxiosPromise<PutTaxesComponentsTaxComponentIdResponse>;
};
/**
* TaxComponentsApi - object-oriented interface
* @export
* @class TaxComponentsApi
* @extends {BaseAPI}
*/
export declare class TaxComponentsApi extends BaseAPI {
/**
* Creates a new Tax Component Mandatory Fields: name, percentage Optional Fields: debitAccountType, debitAcountId, creditAccountType, creditAcountId, startDate
* @summary Create a new Tax Component
* @param {PostTaxesComponentsRequest} postTaxesComponentsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TaxComponentsApi
*/
createTaxCompoent(postTaxesComponentsRequest: PostTaxesComponentsRequest, options?: any): Promise<import("axios").AxiosResponse<PostTaxesComponentsResponse>>;
/**
* List Tax Components
* @summary List Tax Components
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TaxComponentsApi
*/
retrieveAllTaxComponents(options?: any): Promise<import("axios").AxiosResponse<GetTaxesComponentsResponse[]>>;
/**
* Retrieve Tax Component
* @summary Retrieve Tax Component
* @param {number} taxComponentId taxComponentId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TaxComponentsApi
*/
retrieveTaxComponent(taxComponentId: number, options?: any): Promise<import("axios").AxiosResponse<GetTaxesComponentsResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TaxComponentsApi
*/
retrieveTemplate20(options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* Updates Tax component. Debit and credit account details cannot be modified. All the future tax components would be replaced with the new percentage.
* @summary Update Tax Component
* @param {number} taxComponentId taxComponentId
* @param {PutTaxesComponentsTaxComponentIdRequest} putTaxesComponentsTaxComponentIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof TaxComponentsApi
*/
updateTaxCompoent(taxComponentId: number, putTaxesComponentsTaxComponentIdRequest: PutTaxesComponentsTaxComponentIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutTaxesComponentsTaxComponentIdResponse>>;
}