lfk-client-js/dist/services/UserGroupService.js

99 lines
3.3 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserGroupService = void 0;
const request_1 = require("../core/request");
class UserGroupService {
/**
* Get all
* Lists all groups. <br> The information provided might change while the project continues to evolve.
* @returns ResponseUserGroup
* @throws ApiError
*/
static async userGroupControllerGetAll() {
const result = await (0, request_1.request)({
method: 'GET',
path: `/api/usergroups`,
});
return result.body;
}
/**
* Post
* Create a new group. <br> If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group.
* @param requestBody CreateUserGroup
* @returns any
* @throws ApiError
*/
static async userGroupControllerPost(requestBody) {
const result = await (0, request_1.request)({
method: 'POST',
path: `/api/usergroups`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the group whose id got provided. <br> The information provided might change while the project continues to evolve.
* @param id
* @returns ResponseUserGroup
* @throws ApiError
*/
static async userGroupControllerGetOne(id) {
const result = await (0, request_1.request)({
method: 'GET',
path: `/api/usergroups/${id}`,
});
return result.body;
}
/**
* Put
* Update the group whose id you provided. <br> To change the permissions granted to the group please use /api/permissions instead. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateUserGroup
* @returns UserGroup
* @throws ApiError
*/
static async userGroupControllerPut(id, requestBody) {
const result = await (0, request_1.request)({
method: 'PUT',
path: `/api/usergroups/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* Delete the group whose id you provided. <br> If there are any permissions directly granted to the group they will get deleted as well. <br> Users associated with this group won't get deleted - just deassociated. <br> If no group with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseUserGroup
* @returns ResponseEmpty
* @throws ApiError
*/
static async userGroupControllerRemove(id, force) {
const result = await (0, request_1.request)({
method: 'DELETE',
path: `/api/usergroups/${id}`,
query: {
'force': force,
},
});
return result.body;
}
/**
* Get permissions
* Lists all permissions granted to the group as permission response objects.
* @param id
* @returns ResponseUserGroupPermissions
* @throws ApiError
*/
static async userGroupControllerGetPermissions(id) {
const result = await (0, request_1.request)({
method: 'GET',
path: `/api/usergroups/${id}/permissions`,
});
return result.body;
}
}
exports.UserGroupService = UserGroupService;