UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

561 lines (560 loc) 32.6 kB
"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.AccountingClosureApi = exports.AccountingClosureApiFactory = exports.AccountingClosureApiFp = exports.AccountingClosureApiAxiosParamCreator = 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"); /** * AccountingClosureApi - axios parameter creator * @export */ exports.AccountingClosureApiAxiosParamCreator = function (configuration) { var _this = this; return { /** * Mandatory Fields officeId,closingDate * @summary Create an Accounting Closure * @param {PostGlClosuresRequest} postGlClosuresRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGLClosure: function (postGlClosuresRequest, 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 'postGlClosuresRequest' is not null or undefined common_1.assertParamExists('createGLClosure', 'postGlClosuresRequest', postGlClosuresRequest); localVarPath = "/glclosures"; 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(postGlClosuresRequest, localVarRequestOptions, configuration); return [2 /*return*/, { url: common_1.toPathString(localVarUrlObj), options: localVarRequestOptions, }]; } }); }); }, /** * Note: Only the latest accounting closure associated with a branch may be deleted. * @summary Delete an accounting closure * @param {number} glClosureId glclosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGLClosure: function (glClosureId, 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 'glClosureId' is not null or undefined common_1.assertParamExists('deleteGLClosure', 'glClosureId', glClosureId); localVarPath = "/glclosures/{glClosureId}" .replace("{" + "glClosureId" + "}", encodeURIComponent(String(glClosureId))); 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, }]; } }); }); }, /** * Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate * @summary Retrieve an Accounting Closure * @param {number} glClosureId glClosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retreiveClosure: function (glClosureId, 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 'glClosureId' is not null or undefined common_1.assertParamExists('retreiveClosure', 'glClosureId', glClosureId); localVarPath = "/glclosures/{glClosureId}" .replace("{" + "glClosureId" + "}", encodeURIComponent(String(glClosureId))); 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, }]; } }); }); }, /** * Example Requests: glclosures * @summary List Accounting closures * @param {number} [officeId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClosures: function (officeId, 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: localVarPath = "/glclosures"; 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 (officeId !== undefined) { localVarQueryParameter['officeId'] = officeId; } 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, }]; } }); }); }, /** * Once an accounting closure is created, only the comments associated with it may be edited * @summary Update an Accounting closure * @param {number} glClosureId glClosureId * @param {PutGlClosuresRequest} [putGlClosuresRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGLClosure: function (glClosureId, putGlClosuresRequest, 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 'glClosureId' is not null or undefined common_1.assertParamExists('updateGLClosure', 'glClosureId', glClosureId); localVarPath = "/glclosures/{glClosureId}" .replace("{" + "glClosureId" + "}", encodeURIComponent(String(glClosureId))); 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(putGlClosuresRequest, localVarRequestOptions, configuration); return [2 /*return*/, { url: common_1.toPathString(localVarUrlObj), options: localVarRequestOptions, }]; } }); }); }, }; }; /** * AccountingClosureApi - functional programming interface * @export */ exports.AccountingClosureApiFp = function (configuration) { var localVarAxiosParamCreator = exports.AccountingClosureApiAxiosParamCreator(configuration); return { /** * Mandatory Fields officeId,closingDate * @summary Create an Accounting Closure * @param {PostGlClosuresRequest} postGlClosuresRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGLClosure: function (postGlClosuresRequest, 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.createGLClosure(postGlClosuresRequest, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)]; } }); }); }, /** * Note: Only the latest accounting closure associated with a branch may be deleted. * @summary Delete an accounting closure * @param {number} glClosureId glclosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGLClosure: function (glClosureId, 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.deleteGLClosure(glClosureId, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)]; } }); }); }, /** * Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate * @summary Retrieve an Accounting Closure * @param {number} glClosureId glClosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retreiveClosure: function (glClosureId, 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.retreiveClosure(glClosureId, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)]; } }); }); }, /** * Example Requests: glclosures * @summary List Accounting closures * @param {number} [officeId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClosures: function (officeId, 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.retrieveAllClosures(officeId, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)]; } }); }); }, /** * Once an accounting closure is created, only the comments associated with it may be edited * @summary Update an Accounting closure * @param {number} glClosureId glClosureId * @param {PutGlClosuresRequest} [putGlClosuresRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGLClosure: function (glClosureId, putGlClosuresRequest, 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.updateGLClosure(glClosureId, putGlClosuresRequest, options)]; case 1: localVarAxiosArgs = _a.sent(); return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)]; } }); }); }, }; }; /** * AccountingClosureApi - factory interface * @export */ exports.AccountingClosureApiFactory = function (configuration, basePath, axios) { var localVarFp = exports.AccountingClosureApiFp(configuration); return { /** * Mandatory Fields officeId,closingDate * @summary Create an Accounting Closure * @param {PostGlClosuresRequest} postGlClosuresRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createGLClosure: function (postGlClosuresRequest, options) { return localVarFp.createGLClosure(postGlClosuresRequest, options).then(function (request) { return request(axios, basePath); }); }, /** * Note: Only the latest accounting closure associated with a branch may be deleted. * @summary Delete an accounting closure * @param {number} glClosureId glclosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteGLClosure: function (glClosureId, options) { return localVarFp.deleteGLClosure(glClosureId, options).then(function (request) { return request(axios, basePath); }); }, /** * Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate * @summary Retrieve an Accounting Closure * @param {number} glClosureId glClosureId * @param {*} [options] Override http request option. * @throws {RequiredError} */ retreiveClosure: function (glClosureId, options) { return localVarFp.retreiveClosure(glClosureId, options).then(function (request) { return request(axios, basePath); }); }, /** * Example Requests: glclosures * @summary List Accounting closures * @param {number} [officeId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ retrieveAllClosures: function (officeId, options) { return localVarFp.retrieveAllClosures(officeId, options).then(function (request) { return request(axios, basePath); }); }, /** * Once an accounting closure is created, only the comments associated with it may be edited * @summary Update an Accounting closure * @param {number} glClosureId glClosureId * @param {PutGlClosuresRequest} [putGlClosuresRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateGLClosure: function (glClosureId, putGlClosuresRequest, options) { return localVarFp.updateGLClosure(glClosureId, putGlClosuresRequest, options).then(function (request) { return request(axios, basePath); }); }, }; }; /** * AccountingClosureApi - object-oriented interface * @export * @class AccountingClosureApi * @extends {BaseAPI} */ var AccountingClosureApi = /** @class */ (function (_super) { __extends(AccountingClosureApi, _super); function AccountingClosureApi() { return _super !== null && _super.apply(this, arguments) || this; } /** * Mandatory Fields officeId,closingDate * @summary Create an Accounting Closure * @param {PostGlClosuresRequest} postGlClosuresRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountingClosureApi */ AccountingClosureApi.prototype.createGLClosure = function (postGlClosuresRequest, options) { var _this = this; return exports.AccountingClosureApiFp(this.configuration).createGLClosure(postGlClosuresRequest, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; /** * Note: Only the latest accounting closure associated with a branch may be deleted. * @summary Delete an accounting closure * @param {number} glClosureId glclosureId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountingClosureApi */ AccountingClosureApi.prototype.deleteGLClosure = function (glClosureId, options) { var _this = this; return exports.AccountingClosureApiFp(this.configuration).deleteGLClosure(glClosureId, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; /** * Example Requests: glclosures/1 /glclosures/1?fields=officeName,closingDate * @summary Retrieve an Accounting Closure * @param {number} glClosureId glClosureId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountingClosureApi */ AccountingClosureApi.prototype.retreiveClosure = function (glClosureId, options) { var _this = this; return exports.AccountingClosureApiFp(this.configuration).retreiveClosure(glClosureId, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; /** * Example Requests: glclosures * @summary List Accounting closures * @param {number} [officeId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountingClosureApi */ AccountingClosureApi.prototype.retrieveAllClosures = function (officeId, options) { var _this = this; return exports.AccountingClosureApiFp(this.configuration).retrieveAllClosures(officeId, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; /** * Once an accounting closure is created, only the comments associated with it may be edited * @summary Update an Accounting closure * @param {number} glClosureId glClosureId * @param {PutGlClosuresRequest} [putGlClosuresRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountingClosureApi */ AccountingClosureApi.prototype.updateGLClosure = function (glClosureId, putGlClosuresRequest, options) { var _this = this; return exports.AccountingClosureApiFp(this.configuration).updateGLClosure(glClosureId, putGlClosuresRequest, options).then(function (request) { return request(_this.axios, _this.basePath); }); }; return AccountingClosureApi; }(base_1.BaseAPI)); exports.AccountingClosureApi = AccountingClosureApi;