UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

203 lines (202 loc) 10.2 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 { GetTaxesGroupResponse } from '../models'; import { PostTaxesGroupRequest } from '../models'; import { PostTaxesGroupResponse } from '../models'; import { PutTaxesGroupTaxGroupIdRequest } from '../models'; import { PutTaxesGroupTaxGroupIdResponse } from '../models'; /** * TaxGroupApi - axios parameter creator * @export */ export declare const TaxGroupApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate * @summary Create a new Tax Group * @param {PostTaxesGroupRequest} postTaxesGroupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTaxGroup: (postTaxesGroupRequest: PostTaxesGroupRequest, options?: any) => Promise<RequestArgs>; /** * List Tax Group * @summary List Tax Group * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllTaxGroups: (options?: any) => Promise<RequestArgs>; /** * Retrieve Tax Group * @summary Retrieve Tax Group * @param {number} taxGroupId taxGroupId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTaxGroup: (taxGroupId: number, options?: any) => Promise<RequestArgs>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate21: (options?: any) => Promise<RequestArgs>; /** * Updates Tax Group. Only end date can be up-datable and can insert new tax components. * @summary Update Tax Group * @param {number} taxGroupId taxGroupId * @param {PutTaxesGroupTaxGroupIdRequest} putTaxesGroupTaxGroupIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTaxGroup: (taxGroupId: number, putTaxesGroupTaxGroupIdRequest: PutTaxesGroupTaxGroupIdRequest, options?: any) => Promise<RequestArgs>; }; /** * TaxGroupApi - functional programming interface * @export */ export declare const TaxGroupApiFp: (configuration?: Configuration) => { /** * Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate * @summary Create a new Tax Group * @param {PostTaxesGroupRequest} postTaxesGroupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTaxGroup(postTaxesGroupRequest: PostTaxesGroupRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTaxesGroupResponse>>; /** * List Tax Group * @summary List Tax Group * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllTaxGroups(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetTaxesGroupResponse>>>; /** * Retrieve Tax Group * @summary Retrieve Tax Group * @param {number} taxGroupId taxGroupId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTaxGroup(taxGroupId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTaxesGroupResponse>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate21(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Updates Tax Group. Only end date can be up-datable and can insert new tax components. * @summary Update Tax Group * @param {number} taxGroupId taxGroupId * @param {PutTaxesGroupTaxGroupIdRequest} putTaxesGroupTaxGroupIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTaxGroup(taxGroupId: number, putTaxesGroupTaxGroupIdRequest: PutTaxesGroupTaxGroupIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTaxesGroupTaxGroupIdResponse>>; }; /** * TaxGroupApi - factory interface * @export */ export declare const TaxGroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate * @summary Create a new Tax Group * @param {PostTaxesGroupRequest} postTaxesGroupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTaxGroup(postTaxesGroupRequest: PostTaxesGroupRequest, options?: any): AxiosPromise<PostTaxesGroupResponse>; /** * List Tax Group * @summary List Tax Group * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllTaxGroups(options?: any): AxiosPromise<Array<GetTaxesGroupResponse>>; /** * Retrieve Tax Group * @summary Retrieve Tax Group * @param {number} taxGroupId taxGroupId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTaxGroup(taxGroupId: number, options?: any): AxiosPromise<GetTaxesGroupResponse>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveTemplate21(options?: any): AxiosPromise<string>; /** * Updates Tax Group. Only end date can be up-datable and can insert new tax components. * @summary Update Tax Group * @param {number} taxGroupId taxGroupId * @param {PutTaxesGroupTaxGroupIdRequest} putTaxesGroupTaxGroupIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTaxGroup(taxGroupId: number, putTaxesGroupTaxGroupIdRequest: PutTaxesGroupTaxGroupIdRequest, options?: any): AxiosPromise<PutTaxesGroupTaxGroupIdResponse>; }; /** * TaxGroupApi - object-oriented interface * @export * @class TaxGroupApi * @extends {BaseAPI} */ export declare class TaxGroupApi extends BaseAPI { /** * Create a new Tax Group Mandatory Fields: name and taxComponents Mandatory Fields in taxComponents: taxComponentId Optional Fields in taxComponents: id, startDate and endDate * @summary Create a new Tax Group * @param {PostTaxesGroupRequest} postTaxesGroupRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TaxGroupApi */ createTaxGroup(postTaxesGroupRequest: PostTaxesGroupRequest, options?: any): Promise<import("axios").AxiosResponse<PostTaxesGroupResponse>>; /** * List Tax Group * @summary List Tax Group * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TaxGroupApi */ retrieveAllTaxGroups(options?: any): Promise<import("axios").AxiosResponse<GetTaxesGroupResponse[]>>; /** * Retrieve Tax Group * @summary Retrieve Tax Group * @param {number} taxGroupId taxGroupId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TaxGroupApi */ retrieveTaxGroup(taxGroupId: number, options?: any): Promise<import("axios").AxiosResponse<GetTaxesGroupResponse>>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TaxGroupApi */ retrieveTemplate21(options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Updates Tax Group. Only end date can be up-datable and can insert new tax components. * @summary Update Tax Group * @param {number} taxGroupId taxGroupId * @param {PutTaxesGroupTaxGroupIdRequest} putTaxesGroupTaxGroupIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TaxGroupApi */ updateTaxGroup(taxGroupId: number, putTaxesGroupTaxGroupIdRequest: PutTaxesGroupTaxGroupIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutTaxesGroupTaxGroupIdResponse>>; }