fineract_sdk
Version:
Wrapper around fineract api.
238 lines (237 loc) • 16 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 { DeleteFixedDepositProductsProductIdResponse } from '../models';
import { GetFixedDepositProductsProductIdResponse } from '../models';
import { GetFixedDepositProductsResponse } from '../models';
import { PostFixedDepositProductsRequest } from '../models';
import { PostFixedDepositProductsResponse } from '../models';
import { PutFixedDepositProductsProductIdRequest } from '../models';
import { PutFixedDepositProductsProductIdResponse } from '../models';
/**
* FixedDepositProductApi - axios parameter creator
* @export
*/
export declare const FixedDepositProductApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
* @summary Create a Fixed Deposit Product
* @param {PostFixedDepositProductsRequest} postFixedDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create11: (postFixedDepositProductsRequest: PostFixedDepositProductsRequest, options?: any) => Promise<RequestArgs>;
/**
* Deletes a Fixed Deposit Product
* @summary Delete a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete15: (productId: number, options?: any) => Promise<RequestArgs>;
/**
* Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
* @summary List Fixed Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll30: (options?: any) => Promise<RequestArgs>;
/**
* Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
* @summary Retrieve a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne19: (productId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate14: (options?: any) => Promise<RequestArgs>;
/**
* Updates a Fixed Deposit Product
* @summary Update a Fixed Deposit Product
* @param {number} productId productId
* @param {PutFixedDepositProductsProductIdRequest} putFixedDepositProductsProductIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update16: (productId: number, putFixedDepositProductsProductIdRequest: PutFixedDepositProductsProductIdRequest, options?: any) => Promise<RequestArgs>;
};
/**
* FixedDepositProductApi - functional programming interface
* @export
*/
export declare const FixedDepositProductApiFp: (configuration?: Configuration) => {
/**
* Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
* @summary Create a Fixed Deposit Product
* @param {PostFixedDepositProductsRequest} postFixedDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create11(postFixedDepositProductsRequest: PostFixedDepositProductsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostFixedDepositProductsResponse>>;
/**
* Deletes a Fixed Deposit Product
* @summary Delete a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete15(productId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteFixedDepositProductsProductIdResponse>>;
/**
* Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
* @summary List Fixed Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll30(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetFixedDepositProductsResponse>>>;
/**
* Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
* @summary Retrieve a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne19(productId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFixedDepositProductsProductIdResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate14(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* Updates a Fixed Deposit Product
* @summary Update a Fixed Deposit Product
* @param {number} productId productId
* @param {PutFixedDepositProductsProductIdRequest} putFixedDepositProductsProductIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update16(productId: number, putFixedDepositProductsProductIdRequest: PutFixedDepositProductsProductIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutFixedDepositProductsProductIdResponse>>;
};
/**
* FixedDepositProductApi - factory interface
* @export
*/
export declare const FixedDepositProductApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
* @summary Create a Fixed Deposit Product
* @param {PostFixedDepositProductsRequest} postFixedDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create11(postFixedDepositProductsRequest: PostFixedDepositProductsRequest, options?: any): AxiosPromise<PostFixedDepositProductsResponse>;
/**
* Deletes a Fixed Deposit Product
* @summary Delete a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete15(productId: number, options?: any): AxiosPromise<DeleteFixedDepositProductsProductIdResponse>;
/**
* Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
* @summary List Fixed Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll30(options?: any): AxiosPromise<Array<GetFixedDepositProductsResponse>>;
/**
* Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
* @summary Retrieve a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne19(productId: number, options?: any): AxiosPromise<GetFixedDepositProductsProductIdResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate14(options?: any): AxiosPromise<string>;
/**
* Updates a Fixed Deposit Product
* @summary Update a Fixed Deposit Product
* @param {number} productId productId
* @param {PutFixedDepositProductsProductIdRequest} putFixedDepositProductsProductIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update16(productId: number, putFixedDepositProductsProductIdRequest: PutFixedDepositProductsProductIdRequest, options?: any): AxiosPromise<PutFixedDepositProductsProductIdResponse>;
};
/**
* FixedDepositProductApi - object-oriented interface
* @export
* @class FixedDepositProductApi
* @extends {BaseAPI}
*/
export declare class FixedDepositProductApi extends BaseAPI {
/**
* Creates a Fixed Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, accountingRule Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, , withHoldTax, taxGroupId Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId
* @summary Create a Fixed Deposit Product
* @param {PostFixedDepositProductsRequest} postFixedDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
create11(postFixedDepositProductsRequest: PostFixedDepositProductsRequest, options?: any): Promise<import("axios").AxiosResponse<PostFixedDepositProductsResponse>>;
/**
* Deletes a Fixed Deposit Product
* @summary Delete a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
delete15(productId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteFixedDepositProductsProductIdResponse>>;
/**
* Lists Fixed Deposit Products Example Requests: fixeddepositproducts fixeddepositproducts?fields=name
* @summary List Fixed Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
retrieveAll30(options?: any): Promise<import("axios").AxiosResponse<GetFixedDepositProductsResponse[]>>;
/**
* Retrieves a Fixed Deposit Product Example Requests: fixeddepositproducts/1 fixeddepositproducts/1?template=true fixeddepositproducts/1?fields=name,description
* @summary Retrieve a Fixed Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
retrieveOne19(productId: number, options?: any): Promise<import("axios").AxiosResponse<GetFixedDepositProductsProductIdResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
retrieveTemplate14(options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* Updates a Fixed Deposit Product
* @summary Update a Fixed Deposit Product
* @param {number} productId productId
* @param {PutFixedDepositProductsProductIdRequest} putFixedDepositProductsProductIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FixedDepositProductApi
*/
update16(productId: number, putFixedDepositProductsProductIdRequest: PutFixedDepositProductsProductIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutFixedDepositProductsProductIdResponse>>;
}