This repository has been archived on 2023-11-06. You can view files and clone it, but cannot push or open issues or pull requests.
lfk-client-node/dist/services/UserService.d.ts

50 lines
1.5 KiB
TypeScript

import type { CreateUser } from '../models/CreateUser';
import type { ResponseEmpty } from '../models/ResponseEmpty';
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.
* @returns User
* @throws ApiError
*/
static userControllerGetAll(): Promise<Array<User>>;
/**
* Post
* Create a new user object (id will be generated automagicly).
* @param requestBody CreateUser
* @returns any
* @throws ApiError
*/
static userControllerPost(requestBody?: CreateUser): Promise<(User | UserGroupNotFoundError)>;
/**
* Get one
* Returns a user of a specified id (if it exists)
* @param id
* @returns User
* @throws ApiError
*/
static userControllerGetOne(id: number): Promise<User>;
/**
* Put
* Update a user object (id can't be changed).
* @param id
* @param requestBody UpdateUser
* @returns User
* @throws ApiError
*/
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<User>;
/**
* Remove
* Delete a user runner (if it exists).
* @param id
* @param force
* @returns User
* @returns ResponseEmpty
* @throws ApiError
*/
static userControllerRemove(id: number, force?: boolean): Promise<User | ResponseEmpty>;
}