62 lines
2.8 KiB
TypeScript
62 lines
2.8 KiB
TypeScript
import type { CreateUserGroup } from '../models/CreateUserGroup';
|
|
import type { ResponseEmpty } from '../models/ResponseEmpty';
|
|
import type { ResponseUserGroup } from '../models/ResponseUserGroup';
|
|
import type { ResponseUserGroupPermissions } from '../models/ResponseUserGroupPermissions';
|
|
import type { UpdateUserGroup } from '../models/UpdateUserGroup';
|
|
import type { UserGroup } from '../models/UserGroup';
|
|
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
|
|
export declare class UserGroupService {
|
|
/**
|
|
* Get all
|
|
* Lists all groups. <br> The information provided might change while the project continues to evolve.
|
|
* @param page
|
|
* @param pageSize
|
|
* @result ResponseUserGroup
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerGetAll(page?: number, pageSize?: number): Promise<Array<ResponseUserGroup>>;
|
|
/**
|
|
* 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
|
|
* @result any
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerPost(requestBody?: CreateUserGroup): Promise<(UserGroup | UserGroupNotFoundError)>;
|
|
/**
|
|
* 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
|
|
* @result ResponseUserGroup
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerGetOne(id: number): Promise<ResponseUserGroup>;
|
|
/**
|
|
* 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
|
|
* @result UserGroup
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerPut(id: number, requestBody?: UpdateUserGroup): Promise<UserGroup>;
|
|
/**
|
|
* 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
|
|
* @result ResponseUserGroup
|
|
* @result ResponseEmpty
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerRemove(id: number, force?: boolean): Promise<ResponseUserGroup | ResponseEmpty>;
|
|
/**
|
|
* Get permissions
|
|
* Lists all permissions granted to the group as permission response objects.
|
|
* @param id
|
|
* @result ResponseUserGroupPermissions
|
|
* @throws ApiError
|
|
*/
|
|
static userGroupControllerGetPermissions(id: number): Promise<ResponseUserGroupPermissions>;
|
|
}
|