fineract_sdk
Version:
Wrapper around fineract api.
681 lines • 57.8 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SavingsChargesApi = exports.SavingsChargesApiFactory = exports.SavingsChargesApiFp = exports.SavingsChargesApiAxiosParamCreator = void 0;
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var common_1 = require("../common");
// @ts-ignore
var base_1 = require("../base");
/**
* SavingsChargesApi - axios parameter creator
* @export
*/
exports.SavingsChargesApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale
* @summary Create a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {PostSavingsAccountsSavingsAccountIdChargesRequest} postSavingsAccountsSavingsAccountIdChargesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addSavingsAccountCharge: function (savingsAccountId, postSavingsAccountsSavingsAccountIdChargesRequest, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('addSavingsAccountCharge', 'savingsAccountId', savingsAccountId);
// verify required parameter 'postSavingsAccountsSavingsAccountIdChargesRequest' is not null or undefined
common_1.assertParamExists('addSavingsAccountCharge', 'postSavingsAccountsSavingsAccountIdChargesRequest', postSavingsAccountsSavingsAccountIdChargesRequest);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(postSavingsAccountsSavingsAccountIdChargesRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.
* @summary Delete a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('deleteSavingsAccountCharge', 'savingsAccountId', savingsAccountId);
// verify required parameter 'savingsAccountChargeId' is not null or undefined
common_1.assertParamExists('deleteSavingsAccountCharge', 'savingsAccountChargeId', savingsAccountChargeId);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)))
.replace("{" + "savingsAccountChargeId" + "}", encodeURIComponent(String(savingsAccountChargeId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for \'Pay a Savings account Charge\'
* @summary Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
payOrWaiveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, command, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('payOrWaiveSavingsAccountCharge', 'savingsAccountId', savingsAccountId);
// verify required parameter 'savingsAccountChargeId' is not null or undefined
common_1.assertParamExists('payOrWaiveSavingsAccountCharge', 'savingsAccountChargeId', savingsAccountChargeId);
// verify required parameter 'postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest' is not null or undefined
common_1.assertParamExists('payOrWaiveSavingsAccountCharge', 'postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest', postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)))
.replace("{" + "savingsAccountChargeId" + "}", encodeURIComponent(String(savingsAccountChargeId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (command !== undefined) {
localVarQueryParameter['command'] = command;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Lists Savings Charges Example Requests: savingsaccounts/1/charges savingsaccounts/1/charges?chargeStatus=all savingsaccounts/1/charges?chargeStatus=inactive savingsaccounts/1/charges?chargeStatus=active savingsaccounts/1/charges?fields=name,amountOrPercentage
* @summary List Savings Charges
* @param {number} savingsAccountId savingsAccountId
* @param {string} [chargeStatus] chargeStatus
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllSavingsAccountCharges: function (savingsAccountId, chargeStatus, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('retrieveAllSavingsAccountCharges', 'savingsAccountId', savingsAccountId);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (chargeStatus !== undefined) {
localVarQueryParameter['chargeStatus'] = chargeStatus;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Retrieves a Savings account Charge Example Requests: /savingsaccounts/1/charges/5 /savingsaccounts/1/charges/5?fields=name,amountOrPercentage
* @summary Retrieve a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('retrieveSavingsAccountCharge', 'savingsAccountId', savingsAccountId);
// verify required parameter 'savingsAccountChargeId' is not null or undefined
common_1.assertParamExists('retrieveSavingsAccountCharge', 'savingsAccountChargeId', savingsAccountChargeId);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)))
.replace("{" + "savingsAccountChargeId" + "}", encodeURIComponent(String(savingsAccountChargeId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template
* @summary Retrieve Savings Charges Template
* @param {number} savingsAccountId savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate17: function (savingsAccountId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('retrieveTemplate17', 'savingsAccountId', savingsAccountId);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges/template"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Currently Savings account Charges may be updated only if the Savings account is not yet approved.
* @summary Update a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'savingsAccountId' is not null or undefined
common_1.assertParamExists('updateSavingsAccountCharge', 'savingsAccountId', savingsAccountId);
// verify required parameter 'savingsAccountChargeId' is not null or undefined
common_1.assertParamExists('updateSavingsAccountCharge', 'savingsAccountChargeId', savingsAccountChargeId);
// verify required parameter 'putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest' is not null or undefined
common_1.assertParamExists('updateSavingsAccountCharge', 'putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest', putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest);
localVarPath = "/savingsaccounts/{savingsAccountId}/charges/{savingsAccountChargeId}"
.replace("{" + "savingsAccountId" + "}", encodeURIComponent(String(savingsAccountId)))
.replace("{" + "savingsAccountChargeId" + "}", encodeURIComponent(String(savingsAccountChargeId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'PUT' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
};
};
/**
* SavingsChargesApi - functional programming interface
* @export
*/
exports.SavingsChargesApiFp = function (configuration) {
var localVarAxiosParamCreator = exports.SavingsChargesApiAxiosParamCreator(configuration);
return {
/**
* Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale
* @summary Create a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {PostSavingsAccountsSavingsAccountIdChargesRequest} postSavingsAccountsSavingsAccountIdChargesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addSavingsAccountCharge: function (savingsAccountId, postSavingsAccountsSavingsAccountIdChargesRequest, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.addSavingsAccountCharge(savingsAccountId, postSavingsAccountsSavingsAccountIdChargesRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.
* @summary Delete a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for \'Pay a Savings account Charge\'
* @summary Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
payOrWaiveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, command, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.payOrWaiveSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, command, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Lists Savings Charges Example Requests: savingsaccounts/1/charges savingsaccounts/1/charges?chargeStatus=all savingsaccounts/1/charges?chargeStatus=inactive savingsaccounts/1/charges?chargeStatus=active savingsaccounts/1/charges?fields=name,amountOrPercentage
* @summary List Savings Charges
* @param {number} savingsAccountId savingsAccountId
* @param {string} [chargeStatus] chargeStatus
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllSavingsAccountCharges: function (savingsAccountId, chargeStatus, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveAllSavingsAccountCharges(savingsAccountId, chargeStatus, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Retrieves a Savings account Charge Example Requests: /savingsaccounts/1/charges/5 /savingsaccounts/1/charges/5?fields=name,amountOrPercentage
* @summary Retrieve a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template
* @summary Retrieve Savings Charges Template
* @param {number} savingsAccountId savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate17: function (savingsAccountId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveTemplate17(savingsAccountId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Currently Savings account Charges may be updated only if the Savings account is not yet approved.
* @summary Update a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.updateSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
};
};
/**
* SavingsChargesApi - factory interface
* @export
*/
exports.SavingsChargesApiFactory = function (configuration, basePath, axios) {
var localVarFp = exports.SavingsChargesApiFp(configuration);
return {
/**
* Creates a Savings account Charge Mandatory Fields for Savings account Charges: chargeId, amount chargeId, amount, dueDate, dateFormat, locale chargeId, amount, feeOnMonthDay, monthDayFormat, locale
* @summary Create a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {PostSavingsAccountsSavingsAccountIdChargesRequest} postSavingsAccountsSavingsAccountIdChargesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
addSavingsAccountCharge: function (savingsAccountId, postSavingsAccountsSavingsAccountIdChargesRequest, options) {
return localVarFp.addSavingsAccountCharge(savingsAccountId, postSavingsAccountsSavingsAccountIdChargesRequest, options).then(function (request) { return request(axios, basePath); });
},
/**
* Note: Currently, A Savings account Charge may only be removed from Savings that are not yet approved.
* @summary Delete a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
return localVarFp.deleteSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Pay a Savings account Charge: An active charge will be paid when savings account is active and having sufficient balance. Waive off a Savings account Charge: Outstanding charge amount will be waived off. Inactivate a Savings account Charge: A charge will be allowed to inactivate when savings account is active and not having any dues as of today. If charge is overpaid, corresponding charge payment transactions will be reversed. Showing request/response for \'Pay a Savings account Charge\'
* @summary Pay a Savings account Charge | Waive off a Savings account Charge | Inactivate a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PostSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
payOrWaiveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, command, options) {
return localVarFp.payOrWaiveSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, postSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, command, options).then(function (request) { return request(axios, basePath); });
},
/**
* Lists Savings Charges Example Requests: savingsaccounts/1/charges savingsaccounts/1/charges?chargeStatus=all savingsaccounts/1/charges?chargeStatus=inactive savingsaccounts/1/charges?chargeStatus=active savingsaccounts/1/charges?fields=name,amountOrPercentage
* @summary List Savings Charges
* @param {number} savingsAccountId savingsAccountId
* @param {string} [chargeStatus] chargeStatus
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllSavingsAccountCharges: function (savingsAccountId, chargeStatus, options) {
return localVarFp.retrieveAllSavingsAccountCharges(savingsAccountId, chargeStatus, options).then(function (request) { return request(axios, basePath); });
},
/**
* Retrieves a Savings account Charge Example Requests: /savingsaccounts/1/charges/5 /savingsaccounts/1/charges/5?fields=name,amountOrPercentage
* @summary Retrieve a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, options) {
return localVarFp.retrieveSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, options).then(function (request) { return request(axios, basePath); });
},
/**
* This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of: Field Defaults Allowed description Lists Example Request: savingsaccounts/1/charges/template
* @summary Retrieve Savings Charges Template
* @param {number} savingsAccountId savingsAccountId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate17: function (savingsAccountId, options) {
return localVarFp.retrieveTemplate17(savingsAccountId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Currently Savings account Charges may be updated only if the Savings account is not yet approved.
* @summary Update a Savings account Charge
* @param {number} savingsAccountId savingsAccountId
* @param {number} savingsAccountChargeId savingsAccountChargeId
* @param {PutSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest} putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateSavingsAccountCharge: function (savingsAccountId, savingsAccountChargeId, putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeIdRequest, options) {
return localVarFp.updateSavingsAccountCharge(savingsAccountId, savingsAccountChargeId, putSavingsAccountsSavingsAccountIdChargesSavingsAccountChargeI