fineract_sdk
Version:
Wrapper around fineract api.
759 lines • 72.3 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.CentersApi = exports.CentersApiFactory = exports.CentersApiFp = exports.CentersApiAxiosParamCreator = 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");
/**
* CentersApi - axios parameter creator
* @export
*/
exports.CentersApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don\'t have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center
* @summary Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups
* @param {number} centerId centerId
* @param {PostCentersCenterIdRequest} postCentersCenterIdRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
activate2: function (centerId, postCentersCenterIdRequest, 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 'centerId' is not null or undefined
common_1.assertParamExists('activate2', 'centerId', centerId);
// verify required parameter 'postCentersCenterIdRequest' is not null or undefined
common_1.assertParamExists('activate2', 'postCentersCenterIdRequest', postCentersCenterIdRequest);
localVarPath = "/centers/{centerId}"
.replace("{" + "centerId" + "}", encodeURIComponent(String(centerId)));
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(postCentersCenterIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers
* @summary Create a Center
* @param {PostCentersRequest} postCentersRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create7: function (postCentersRequest, 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 'postCentersRequest' is not null or undefined
common_1.assertParamExists('create7', 'postCentersRequest', postCentersRequest);
localVarPath = "/centers";
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(postCentersRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* A Center can be deleted if it is in pending state and has no association - groups, loans or savings
* @summary Delete a Center
* @param {number} centerId centerId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete10: function (centerId, 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 'centerId' is not null or undefined
common_1.assertParamExists('delete10', 'centerId', centerId);
localVarPath = "/centers/{centerId}"
.replace("{" + "centerId" + "}", encodeURIComponent(String(centerId)));
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,
}];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {number} [staffId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCentersTemplate: function (officeId, staffId, dateFormat, 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 = "/centers/downloadtemplate";
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;
}
if (staffId !== undefined) {
localVarQueryParameter['staffId'] = staffId;
}
if (dateFormat !== undefined) {
localVarQueryParameter['dateFormat'] = dateFormat;
}
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,
}];
}
});
});
},
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postCentersTemplate: function (file, locale, dateFormat, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, localVarFormParams, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/centers/uploadtemplate";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
// 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 (file !== undefined) {
localVarFormParams.append('file', new Blob([JSON.stringify(file)], { type: "application/json", }));
}
if (locale !== undefined) {
localVarFormParams.append('locale', locale);
}
if (dateFormat !== undefined) {
localVarFormParams.append('dateFormat', dateFormat);
}
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = localVarFormParams;
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC
* @summary List Centers
* @param {number} [officeId] officeId
* @param {number} [staffId] staffId
* @param {string} [externalId] externalId
* @param {string} [name] name
* @param {string} [underHierarchy] underHierarchy
* @param {boolean} [paged] paged
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {object} [meetingDate] meetingDate
* @param {string} [dateFormat] dateFormat
* @param {string} [locale] locale
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll23: function (officeId, staffId, externalId, name, underHierarchy, paged, offset, limit, orderBy, sortOrder, meetingDate, dateFormat, locale, 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 = "/centers";
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;
}
if (staffId !== undefined) {
localVarQueryParameter['staffId'] = staffId;
}
if (externalId !== undefined) {
localVarQueryParameter['externalId'] = externalId;
}
if (name !== undefined) {
localVarQueryParameter['name'] = name;
}
if (underHierarchy !== undefined) {
localVarQueryParameter['underHierarchy'] = underHierarchy;
}
if (paged !== undefined) {
localVarQueryParameter['paged'] = paged;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (orderBy !== undefined) {
localVarQueryParameter['orderBy'] = orderBy;
}
if (sortOrder !== undefined) {
localVarQueryParameter['sortOrder'] = sortOrder;
}
if (meetingDate !== undefined) {
localVarQueryParameter['meetingDate'] = meetingDate;
}
if (dateFormat !== undefined) {
localVarQueryParameter['dateFormat'] = dateFormat;
}
if (locale !== undefined) {
localVarQueryParameter['locale'] = locale;
}
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,
}];
}
});
});
},
/**
* An example of how a savings summary for a Center can be provided. This is requested in a specific use case of the reference application. It is quite reasonable to add resources like this to simplify User Interface development. Example Requests: centers/9/accounts
* @summary Retrieve Center accounts overview
* @param {number} centerId centerId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveGroupAccount: function (centerId, 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 'centerId' is not null or undefined
common_1.assertParamExists('retrieveGroupAccount', 'centerId', centerId);
localVarPath = "/centers/{centerId}/accounts"
.replace("{" + "centerId" + "}", encodeURIComponent(String(centerId)));
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,
}];
}
});
});
},
/**
* Retrieves a Center Example Requests: centers/1 centers/1?associations=groupMembers
* @summary Retrieve a Center
* @param {number} centerId centerId
* @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOne13: function (centerId, staffInSelectedOfficeOnly, 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 'centerId' is not null or undefined
common_1.assertParamExists('retrieveOne13', 'centerId', centerId);
localVarPath = "/centers/{centerId}"
.replace("{" + "centerId" + "}", encodeURIComponent(String(centerId)));
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 (staffInSelectedOfficeOnly !== undefined) {
localVarQueryParameter['staffInSelectedOfficeOnly'] = staffInSelectedOfficeOnly;
}
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 Center Template Example Requests: centers/template centers/template?officeId=2
* @summary Retrieve a Center Template
* @param {string} [command] command
* @param {number} [officeId] officeId
* @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveTemplate6: function (command, officeId, staffInSelectedOfficeOnly, 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 = "/centers/template";
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 (command !== undefined) {
localVarQueryParameter['command'] = command;
}
if (officeId !== undefined) {
localVarQueryParameter['officeId'] = officeId;
}
if (staffInSelectedOfficeOnly !== undefined) {
localVarQueryParameter['staffInSelectedOfficeOnly'] = staffInSelectedOfficeOnly;
}
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,
}];
}
});
});
},
/**
* Updates a Center
* @summary Update a Center
* @param {number} centerId centerId
* @param {PutCentersCenterIdRequest} putCentersCenterIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
update11: function (centerId, putCentersCenterIdRequest, 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 'centerId' is not null or undefined
common_1.assertParamExists('update11', 'centerId', centerId);
// verify required parameter 'putCentersCenterIdRequest' is not null or undefined
common_1.assertParamExists('update11', 'putCentersCenterIdRequest', putCentersCenterIdRequest);
localVarPath = "/centers/{centerId}"
.replace("{" + "centerId" + "}", encodeURIComponent(String(centerId)));
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(putCentersCenterIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
};
};
/**
* CentersApi - functional programming interface
* @export
*/
exports.CentersApiFp = function (configuration) {
var localVarAxiosParamCreator = exports.CentersApiAxiosParamCreator(configuration);
return {
/**
* Activate a Center: Centers can be created in a Pending state. This API exists to enable center activation. If the center happens to be already active, this API will result in an error. Close a Center: Centers can be closed if they don\'t have any non-closed groups or saving accounts. If the Center has any active groups or savings accounts, this API will result in an error. Associate Groups: This API allows associating existing groups to a center. The groups are listed from the office to which the center is associated. If group(s) is already associated with a center, this API will result in an error. Disassociate Groups: This API allows to disassociate groups from a center. Generate Collection Sheet: This Api retrieves repayment details of all jlg loans under a center as on a specified meeting date. Save Collection Sheet: This Api allows the loan officer to perform bulk repayments of JLG loans for a center on a given meeting date. Showing Request/Response for Close a Center
* @summary Activate a Center | Generate Collection Sheet | Save Collection Sheet | Close a Center | Associate Groups | Disassociate Groups
* @param {number} centerId centerId
* @param {PostCentersCenterIdRequest} postCentersCenterIdRequest
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
activate2: function (centerId, postCentersCenterIdRequest, 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.activate2(centerId, postCentersCenterIdRequest, command, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Creates a Center Mandatory Fields: name, officeId, active, activationDate (if active=true) Optional Fields: externalId, staffId, groupMembers
* @summary Create a Center
* @param {PostCentersRequest} postCentersRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
create7: function (postCentersRequest, 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.create7(postCentersRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* A Center can be deleted if it is in pending state and has no association - groups, loans or savings
* @summary Delete a Center
* @param {number} centerId centerId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
delete10: function (centerId, 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.delete10(centerId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {number} [staffId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCentersTemplate: function (officeId, staffId, dateFormat, 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.getCentersTemplate(officeId, staffId, dateFormat, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postCentersTemplate: function (file, locale, dateFormat, 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.postCentersTemplate(file, locale, dateFormat, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* The default implementation supports pagination and sorting with the default pagination size set to 200 records. The parameter limit with description -1 will return all entries. Example Requests: centers centers?fields=name,officeName,joinedDate centers?offset=10&limit=50 centers?orderBy=name&sortOrder=DESC
* @summary List Centers
* @param {number} [officeId] officeId
* @param {number} [staffId] staffId
* @param {string} [externalId] externalId
* @param {string} [name] name
* @param {string} [underHierarchy] underHierarchy
* @param {boolean} [paged] paged
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {object} [meetingDate] meetingDate
* @param {string} [dateFormat] dateFormat
* @param {string} [locale] locale
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll23: function (officeId, staffId, externalId, name, underHierarchy, paged, offset, limit, orderBy, sortOrder, meetingDate, dateFormat, locale, 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.retrieveAll23(officeId, staffId, externalId, name, underHierarchy, paged, offset, l