new lib version [CI SKIP]
All checks were successful
continuous-integration/drone Build is passing

This commit is contained in:
Nicolai Ort 2021-01-08 20:18:27 +00:00
parent b9e573311c
commit 7efff57b5d
4 changed files with 16 additions and 16 deletions

View File

@ -1,16 +1,16 @@
import type { CreateUser } from '../models/CreateUser';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseUser } from '../models/ResponseUser';
import type { UpdateUser } from '../models/UpdateUser';
import type { User } from '../models/User';
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
export declare class UserService {
/**
* Get all
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
* @returns User
* @returns ResponseUser
* @throws ApiError
*/
static userControllerGetAll(): Promise<Array<User>>;
static userControllerGetAll(): Promise<Array<ResponseUser>>;
/**
* 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.
@ -18,32 +18,32 @@ export declare class UserService {
* @returns any
* @throws ApiError
*/
static userControllerPost(requestBody?: CreateUser): Promise<(User | UserGroupNotFoundError)>;
static userControllerPost(requestBody?: CreateUser): Promise<(ResponseUser | UserGroupNotFoundError)>;
/**
* 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.
* @param id
* @returns User
* @returns ResponseUser
* @throws ApiError
*/
static userControllerGetOne(id: number): Promise<User>;
static userControllerGetOne(id: number): Promise<ResponseUser>;
/**
* 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.
* @param id
* @param requestBody UpdateUser
* @returns User
* @returns ResponseUser
* @throws ApiError
*/
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<User>;
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<ResponseUser>;
/**
* 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).
* @param id
* @param force
* @returns User
* @returns ResponseUser
* @returns ResponseEmpty
* @throws ApiError
*/
static userControllerRemove(id: number, force?: boolean): Promise<User | ResponseEmpty>;
static userControllerRemove(id: number, force?: boolean): Promise<ResponseUser | ResponseEmpty>;
}

View File

@ -6,7 +6,7 @@ class UserService {
/**
* Get all
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
* @returns User
* @returns ResponseUser
* @throws ApiError
*/
static async userControllerGetAll() {
@ -35,7 +35,7 @@ class UserService {
* 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.
* @param id
* @returns User
* @returns 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 User
* @returns ResponseUser
* @throws ApiError
*/
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).
* @param id
* @param force
* @returns User
* @returns ResponseUser
* @returns ResponseEmpty
* @throws ApiError
*/

File diff suppressed because one or more lines are too long

View File

@ -1,7 +1,7 @@
{
"name": "@odit/lfk-client-js",
"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",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",