This commit is contained in:
parent
b9e573311c
commit
7efff57b5d
20
dist/services/UserService.d.ts
vendored
20
dist/services/UserService.d.ts
vendored
@ -1,16 +1,16 @@
|
|||||||
import type { CreateUser } from '../models/CreateUser';
|
import type { CreateUser } from '../models/CreateUser';
|
||||||
import type { ResponseEmpty } from '../models/ResponseEmpty';
|
import type { ResponseEmpty } from '../models/ResponseEmpty';
|
||||||
|
import type { ResponseUser } from '../models/ResponseUser';
|
||||||
import type { UpdateUser } from '../models/UpdateUser';
|
import type { UpdateUser } from '../models/UpdateUser';
|
||||||
import type { User } from '../models/User';
|
|
||||||
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
|
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
|
||||||
export declare class UserService {
|
export declare class UserService {
|
||||||
/**
|
/**
|
||||||
* Get all
|
* Get all
|
||||||
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
|
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static userControllerGetAll(): Promise<Array<User>>;
|
static userControllerGetAll(): Promise<Array<ResponseUser>>;
|
||||||
/**
|
/**
|
||||||
* Post
|
* 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.
|
* 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.
|
||||||
@ -18,32 +18,32 @@ export declare class UserService {
|
|||||||
* @returns any
|
* @returns any
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static userControllerPost(requestBody?: CreateUser): Promise<(User | UserGroupNotFoundError)>;
|
static userControllerPost(requestBody?: CreateUser): Promise<(ResponseUser | UserGroupNotFoundError)>;
|
||||||
/**
|
/**
|
||||||
* Get one
|
* Get one
|
||||||
* Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
|
* Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
|
||||||
* @param id
|
* @param id
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static userControllerGetOne(id: number): Promise<User>;
|
static userControllerGetOne(id: number): Promise<ResponseUser>;
|
||||||
/**
|
/**
|
||||||
* Put
|
* Put
|
||||||
* 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.
|
* 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 id
|
||||||
* @param requestBody UpdateUser
|
* @param requestBody UpdateUser
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<User>;
|
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<ResponseUser>;
|
||||||
/**
|
/**
|
||||||
* Remove
|
* Remove
|
||||||
* Delete the user whose id you provided. <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).
|
* Delete the user whose id you provided. <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 id
|
||||||
* @param force
|
* @param force
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @returns ResponseEmpty
|
* @returns ResponseEmpty
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static userControllerRemove(id: number, force?: boolean): Promise<User | ResponseEmpty>;
|
static userControllerRemove(id: number, force?: boolean): Promise<ResponseUser | ResponseEmpty>;
|
||||||
}
|
}
|
||||||
|
8
dist/services/UserService.js
vendored
8
dist/services/UserService.js
vendored
@ -6,7 +6,7 @@ class UserService {
|
|||||||
/**
|
/**
|
||||||
* Get all
|
* Get all
|
||||||
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
|
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static async userControllerGetAll() {
|
static async userControllerGetAll() {
|
||||||
@ -35,7 +35,7 @@ class UserService {
|
|||||||
* Get one
|
* Get one
|
||||||
* Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
|
* Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
|
||||||
* @param id
|
* @param id
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static async userControllerGetOne(id) {
|
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.
|
* 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 id
|
||||||
* @param requestBody UpdateUser
|
* @param requestBody UpdateUser
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
static async userControllerPut(id, requestBody) {
|
static async userControllerPut(id, requestBody) {
|
||||||
@ -66,7 +66,7 @@ class UserService {
|
|||||||
* Delete the user whose id you provided. <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).
|
* Delete the user whose id you provided. <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 id
|
||||||
* @param force
|
* @param force
|
||||||
* @returns User
|
* @returns ResponseUser
|
||||||
* @returns ResponseEmpty
|
* @returns ResponseEmpty
|
||||||
* @throws ApiError
|
* @throws ApiError
|
||||||
*/
|
*/
|
||||||
|
File diff suppressed because one or more lines are too long
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "@odit/lfk-client-js",
|
"name": "@odit/lfk-client-js",
|
||||||
"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for native JS applications.",
|
"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for native JS applications.",
|
||||||
"version": "0.0.9",
|
"version": "0.0.10",
|
||||||
"license": "CC-BY-NC-SA-4.0",
|
"license": "CC-BY-NC-SA-4.0",
|
||||||
"main": "./dist/index.js",
|
"main": "./dist/index.js",
|
||||||
"types": "./dist/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
|
Loading…
x
Reference in New Issue
Block a user