fineract_sdk
Version:
Wrapper around fineract api.
829 lines (828 loc) • 47.6 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.RolesApi = exports.RolesApiFactory = exports.RolesApiFp = exports.RolesApiAxiosParamCreator = 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");
/**
* RolesApi - axios parameter creator
* @export
*/
exports.RolesApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
* @summary Enable Role | Disable Role
* @param {number} roleId roleId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
actionsOnRoles: function (roleId, 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 'roleId' is not null or undefined
common_1.assertParamExists('actionsOnRoles', 'roleId', roleId);
localVarPath = "/roles/{roleId}"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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;
}
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,
}];
}
});
});
},
/**
* Mandatory Fields name, description
* @summary Create a New Role
* @param {PostRolesRequest} postRolesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRole: function (postRolesRequest, 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 'postRolesRequest' is not null or undefined
common_1.assertParamExists('createRole', 'postRolesRequest', postRolesRequest);
localVarPath = "/roles";
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(postRolesRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Description : Delete the role in case role is not associated with any users.
* @summary Delete a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteRole: function (roleId, 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 'roleId' is not null or undefined
common_1.assertParamExists('deleteRole', 'roleId', roleId);
localVarPath = "/roles/{roleId}"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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: roles roles?fields=name
* @summary List Roles
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllRoles: function (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 = "/roles";
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: roles/1 roles/1?fields=name
* @summary Retrieve a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRole: function (roleId, 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 'roleId' is not null or undefined
common_1.assertParamExists('retrieveRole', 'roleId', roleId);
localVarPath = "/roles/{roleId}"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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: roles/1/permissions
* @summary Retrieve a Role\'s Permissions
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRolePermissions: function (roleId, 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 'roleId' is not null or undefined
common_1.assertParamExists('retrieveRolePermissions', 'roleId', roleId);
localVarPath = "/roles/{roleId}/permissions"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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,
}];
}
});
});
},
/**
*
* @summary Update a Role
* @param {number} roleId roleId
* @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRole: function (roleId, putRolesRoleIdRequest, 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 'roleId' is not null or undefined
common_1.assertParamExists('updateRole', 'roleId', roleId);
// verify required parameter 'putRolesRoleIdRequest' is not null or undefined
common_1.assertParamExists('updateRole', 'putRolesRoleIdRequest', putRolesRoleIdRequest);
localVarPath = "/roles/{roleId}"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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(putRolesRoleIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
*
* @summary Update a Role\'s Permissions
* @param {number} roleId roleId
* @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRolePermissions: function (roleId, putRolesRoleIdPermissionsRequest, 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 'roleId' is not null or undefined
common_1.assertParamExists('updateRolePermissions', 'roleId', roleId);
// verify required parameter 'putRolesRoleIdPermissionsRequest' is not null or undefined
common_1.assertParamExists('updateRolePermissions', 'putRolesRoleIdPermissionsRequest', putRolesRoleIdPermissionsRequest);
localVarPath = "/roles/{roleId}/permissions"
.replace("{" + "roleId" + "}", encodeURIComponent(String(roleId)));
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(putRolesRoleIdPermissionsRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
};
};
/**
* RolesApi - functional programming interface
* @export
*/
exports.RolesApiFp = function (configuration) {
var localVarAxiosParamCreator = exports.RolesApiAxiosParamCreator(configuration);
return {
/**
* Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
* @summary Enable Role | Disable Role
* @param {number} roleId roleId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
actionsOnRoles: function (roleId, 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.actionsOnRoles(roleId, command, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Mandatory Fields name, description
* @summary Create a New Role
* @param {PostRolesRequest} postRolesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRole: function (postRolesRequest, 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.createRole(postRolesRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Description : Delete the role in case role is not associated with any users.
* @summary Delete a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteRole: function (roleId, 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.deleteRole(roleId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Example Requests: roles roles?fields=name
* @summary List Roles
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllRoles: function (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.retrieveAllRoles(options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Example Requests: roles/1 roles/1?fields=name
* @summary Retrieve a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRole: function (roleId, 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.retrieveRole(roleId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Example Requests: roles/1/permissions
* @summary Retrieve a Role\'s Permissions
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRolePermissions: function (roleId, 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.retrieveRolePermissions(roleId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @summary Update a Role
* @param {number} roleId roleId
* @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRole: function (roleId, putRolesRoleIdRequest, 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.updateRole(roleId, putRolesRoleIdRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @summary Update a Role\'s Permissions
* @param {number} roleId roleId
* @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRolePermissions: function (roleId, putRolesRoleIdPermissionsRequest, 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.updateRolePermissions(roleId, putRolesRoleIdPermissionsRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
};
};
/**
* RolesApi - factory interface
* @export
*/
exports.RolesApiFactory = function (configuration, basePath, axios) {
var localVarFp = exports.RolesApiFp(configuration);
return {
/**
* Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
* @summary Enable Role | Disable Role
* @param {number} roleId roleId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
actionsOnRoles: function (roleId, command, options) {
return localVarFp.actionsOnRoles(roleId, command, options).then(function (request) { return request(axios, basePath); });
},
/**
* Mandatory Fields name, description
* @summary Create a New Role
* @param {PostRolesRequest} postRolesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createRole: function (postRolesRequest, options) {
return localVarFp.createRole(postRolesRequest, options).then(function (request) { return request(axios, basePath); });
},
/**
* Description : Delete the role in case role is not associated with any users.
* @summary Delete a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteRole: function (roleId, options) {
return localVarFp.deleteRole(roleId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Example Requests: roles roles?fields=name
* @summary List Roles
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAllRoles: function (options) {
return localVarFp.retrieveAllRoles(options).then(function (request) { return request(axios, basePath); });
},
/**
* Example Requests: roles/1 roles/1?fields=name
* @summary Retrieve a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRole: function (roleId, options) {
return localVarFp.retrieveRole(roleId, options).then(function (request) { return request(axios, basePath); });
},
/**
* Example Requests: roles/1/permissions
* @summary Retrieve a Role\'s Permissions
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveRolePermissions: function (roleId, options) {
return localVarFp.retrieveRolePermissions(roleId, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Update a Role
* @param {number} roleId roleId
* @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRole: function (roleId, putRolesRoleIdRequest, options) {
return localVarFp.updateRole(roleId, putRolesRoleIdRequest, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @summary Update a Role\'s Permissions
* @param {number} roleId roleId
* @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateRolePermissions: function (roleId, putRolesRoleIdPermissionsRequest, options) {
return localVarFp.updateRolePermissions(roleId, putRolesRoleIdPermissionsRequest, options).then(function (request) { return request(axios, basePath); });
},
};
};
/**
* RolesApi - object-oriented interface
* @export
* @class RolesApi
* @extends {BaseAPI}
*/
var RolesApi = /** @class */ (function (_super) {
__extends(RolesApi, _super);
function RolesApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Description : Enable role in case role is disabled. | Disable the role in case role is not associated with any users. Example Request: https://DomainName/api/v1/roles/{roleId}?command=enable https://DomainName/api/v1/roles/{roleId}?command=disable
* @summary Enable Role | Disable Role
* @param {number} roleId roleId
* @param {string} [command] command
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.actionsOnRoles = function (roleId, command, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).actionsOnRoles(roleId, command, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Mandatory Fields name, description
* @summary Create a New Role
* @param {PostRolesRequest} postRolesRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.createRole = function (postRolesRequest, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).createRole(postRolesRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Description : Delete the role in case role is not associated with any users.
* @summary Delete a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.deleteRole = function (roleId, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).deleteRole(roleId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Example Requests: roles roles?fields=name
* @summary List Roles
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.retrieveAllRoles = function (options) {
var _this = this;
return exports.RolesApiFp(this.configuration).retrieveAllRoles(options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Example Requests: roles/1 roles/1?fields=name
* @summary Retrieve a Role
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.retrieveRole = function (roleId, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).retrieveRole(roleId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Example Requests: roles/1/permissions
* @summary Retrieve a Role\'s Permissions
* @param {number} roleId roleId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.retrieveRolePermissions = function (roleId, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).retrieveRolePermissions(roleId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Update a Role
* @param {number} roleId roleId
* @param {PutRolesRoleIdRequest} putRolesRoleIdRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.updateRole = function (roleId, putRolesRoleIdRequest, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).updateRole(roleId, putRolesRoleIdRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @summary Update a Role\'s Permissions
* @param {number} roleId roleId
* @param {PutRolesRoleIdPermissionsRequest} putRolesRoleIdPermissionsRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof RolesApi
*/
RolesApi.prototype.updateRolePermissions = function (roleId, putRolesRoleIdPermissionsRequest, options) {
var _this = this;
return exports.RolesApiFp(this.configuration).updateRolePermissions(roleId, putRolesRoleIdPermissionsRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
return RolesApi;
}(base_1.BaseAPI));
exports.RolesApi = RolesApi;