🚀New lib version v0.13.1 [CI SKIP]
All checks were successful
continuous-integration/drone Build is passing
All checks were successful
continuous-integration/drone Build is passing
This commit is contained in:
14
dist/services/UserService.js
vendored
14
dist/services/UserService.js
vendored
@@ -6,7 +6,7 @@ class UserService {
|
||||
/**
|
||||
* Get all
|
||||
* Lists all users. <br> This includes their groups and permissions granted to them.
|
||||
* @returns ResponseUser
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerGetAll() {
|
||||
@@ -20,7 +20,7 @@ class UserService {
|
||||
* Post
|
||||
* Create a new user. <br> If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user.
|
||||
* @param requestBody CreateUser
|
||||
* @returns ResponseUser
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerPost(requestBody) {
|
||||
@@ -35,7 +35,7 @@ class UserService {
|
||||
* Get one
|
||||
* Lists all information about the user whose id got provided. <br> Please remember that all permissions granted to the user will show up here.
|
||||
* @param id
|
||||
* @returns ResponseUser
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerGetOne(id) {
|
||||
@@ -50,7 +50,7 @@ class UserService {
|
||||
* Update the user whose id you provided. <br> To change the permissions directly granted to the user please use /api/permissions instead. <br> Please remember that ids can't be changed.
|
||||
* @param id
|
||||
* @param requestBody UpdateUser
|
||||
* @returns ResponseUser
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerPut(id, requestBody) {
|
||||
@@ -66,8 +66,8 @@ class UserService {
|
||||
* Delete the user whose id you provided. <br> You have to confirm your decision by providing the ?force=true query param. <br> If there are any permissions directly granted to the user they will get deleted as well. <br> If no user with this id exists it will just return 204(no content).
|
||||
* @param id
|
||||
* @param force
|
||||
* @returns ResponseUser
|
||||
* @returns ResponseEmpty
|
||||
* @result ResponseUser
|
||||
* @result ResponseEmpty
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerRemove(id, force) {
|
||||
@@ -84,7 +84,7 @@ class UserService {
|
||||
* Get permissions
|
||||
* Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects.
|
||||
* @param id
|
||||
* @returns ResponseUser
|
||||
* @result ResponseUser
|
||||
* @throws ApiError
|
||||
*/
|
||||
static async userControllerGetPermissions(id) {
|
||||
|
||||
Reference in New Issue
Block a user