fineract_sdk
Version:
Wrapper around fineract api.
238 lines (237 loc) • 16.7 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 { DeleteRecurringDepositProductsProductIdResponse } from '../models';
import { GetRecurringDepositProductsProductIdResponse } from '../models';
import { GetRecurringDepositProductsResponse } from '../models';
import { PostRecurringDepositProductsRequest } from '../models';
import { PostRecurringDepositProductsResponse } from '../models';
import { PutRecurringDepositProductsRequest } from '../models';
import { PutRecurringDepositProductsResponse } from '../models';
/**
* RecurringDepositProductApi - axios parameter creator
* @export
*/
export declare const RecurringDepositProductApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
* @summary Create a Recurring Deposit Product
* @param {PostRecurringDepositProductsRequest} postRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create12: (postRecurringDepositProductsRequest: PostRecurringDepositProductsRequest, options?: any) => Promise<RequestArgs>;
/**
* Deletes a Recurring Deposit Product
* @summary Delete a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete17: (productId: number, options?: any) => Promise<RequestArgs>;
/**
* Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
* @summary List Recuring Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll32: (options?: any) => Promise<RequestArgs>;
/**
* Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
* @summary Retrieve a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne22: (productId: number, options?: any) => Promise<RequestArgs>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate16: (options?: any) => Promise<RequestArgs>;
/**
* Updates a Recurring Deposit Product
* @summary Update a Recurring Deposit Product
* @param {number} productId productId
* @param {PutRecurringDepositProductsRequest} putRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update18: (productId: number, putRecurringDepositProductsRequest: PutRecurringDepositProductsRequest, options?: any) => Promise<RequestArgs>;
};
/**
* RecurringDepositProductApi - functional programming interface
* @export
*/
export declare const RecurringDepositProductApiFp: (configuration?: Configuration) => {
/**
* Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
* @summary Create a Recurring Deposit Product
* @param {PostRecurringDepositProductsRequest} postRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create12(postRecurringDepositProductsRequest: PostRecurringDepositProductsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostRecurringDepositProductsResponse>>;
/**
* Deletes a Recurring Deposit Product
* @summary Delete a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete17(productId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteRecurringDepositProductsProductIdResponse>>;
/**
* Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
* @summary List Recuring Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll32(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetRecurringDepositProductsResponse>>>;
/**
* Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
* @summary Retrieve a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne22(productId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRecurringDepositProductsProductIdResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate16(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
/**
* Updates a Recurring Deposit Product
* @summary Update a Recurring Deposit Product
* @param {number} productId productId
* @param {PutRecurringDepositProductsRequest} putRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update18(productId: number, putRecurringDepositProductsRequest: PutRecurringDepositProductsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutRecurringDepositProductsResponse>>;
};
/**
* RecurringDepositProductApi - factory interface
* @export
*/
export declare const RecurringDepositProductApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
* @summary Create a Recurring Deposit Product
* @param {PostRecurringDepositProductsRequest} postRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create12(postRecurringDepositProductsRequest: PostRecurringDepositProductsRequest, options?: any): AxiosPromise<PostRecurringDepositProductsResponse>;
/**
* Deletes a Recurring Deposit Product
* @summary Delete a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete17(productId: number, options?: any): AxiosPromise<DeleteRecurringDepositProductsProductIdResponse>;
/**
* Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
* @summary List Recuring Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll32(options?: any): AxiosPromise<Array<GetRecurringDepositProductsResponse>>;
/**
* Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
* @summary Retrieve a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne22(productId: number, options?: any): AxiosPromise<GetRecurringDepositProductsProductIdResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate16(options?: any): AxiosPromise<string>;
/**
* Updates a Recurring Deposit Product
* @summary Update a Recurring Deposit Product
* @param {number} productId productId
* @param {PutRecurringDepositProductsRequest} putRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update18(productId: number, putRecurringDepositProductsRequest: PutRecurringDepositProductsRequest, options?: any): AxiosPromise<PutRecurringDepositProductsResponse>;
};
/**
* RecurringDepositProductApi - object-oriented interface
* @export
* @class RecurringDepositProductApi
* @extends {BaseAPI}
*/
export declare class RecurringDepositProductApi extends BaseAPI {
/**
* Creates a Recurring Deposit Product Mandatory Fields: name, shortName, description, currencyCode, digitsAfterDecimal,inMultiplesOf, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minDepositTerm, minDepositTermTypeId, recurringDepositFrequency, recurringDepositFrequencyTypeId, accountingRule, depositAmount Mandatory Fields for Cash based accounting (accountingRule = 2): savingsReferenceAccountId, savingsControlAccountId, interestOnSavingsAccountId, incomeFromFeeAccountId, transfersInSuspenseAccountId, incomeFromPenaltyAccountId Optional Fields: lockinPeriodFrequency, lockinPeriodFrequencyType, maxDepositTerm, maxDepositTermTypeId, inMultiplesOfDepositTerm, inMultiplesOfDepositTermTypeId, preClosurePenalApplicable, preClosurePenalInterest, preClosurePenalInterestOnTypeId, feeToIncomeAccountMappings, penaltyToIncomeAccountMappings, charges, charts, minDepositAmount, maxDepositAmount, withHoldTax, taxGroupId
* @summary Create a Recurring Deposit Product
* @param {PostRecurringDepositProductsRequest} postRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
create12(postRecurringDepositProductsRequest: PostRecurringDepositProductsRequest, options?: any): Promise<import("axios").AxiosResponse<PostRecurringDepositProductsResponse>>;
/**
* Deletes a Recurring Deposit Product
* @summary Delete a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
delete17(productId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteRecurringDepositProductsProductIdResponse>>;
/**
* Lists Recuring Deposit Products Example Requests: recurringdepositproducts recurringdepositproducts?fields=name
* @summary List Recuring Deposit Products
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
retrieveAll32(options?: any): Promise<import("axios").AxiosResponse<GetRecurringDepositProductsResponse[]>>;
/**
* Retrieves a Recurring Deposit Product Example Requests: recurringdepositproducts/1 recurringdepositproducts/1?template=true recurringdepositproducts/1?fields=name,description
* @summary Retrieve a Recurring Deposit Product
* @param {number} productId productId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
retrieveOne22(productId: number, options?: any): Promise<import("axios").AxiosResponse<GetRecurringDepositProductsProductIdResponse>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
retrieveTemplate16(options?: any): Promise<import("axios").AxiosResponse<string>>;
/**
* Updates a Recurring Deposit Product
* @summary Update a Recurring Deposit Product
* @param {number} productId productId
* @param {PutRecurringDepositProductsRequest} putRecurringDepositProductsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RecurringDepositProductApi
*/
update18(productId: number, putRecurringDepositProductsRequest: PutRecurringDepositProductsRequest, options?: any): Promise<import("axios").AxiosResponse<PutRecurringDepositProductsResponse>>;
}