Class UserGroupService

Index

Constructors

Methods

deleteUserGroup deleteUserGroupById deleteUserGroupByIdUsers getFilterUserGroup getItemUserGroup getUserGroup getUserGroupById postUserGroup postUserGroupByIdUsers putUserGroupById

Constructors

constructor

new UserGroupService(): UserGroupService
Returns UserGroupService

Methods

`Static`deleteUserGroup

deleteUserGroup<ThrowOnError extends boolean = true>(
options?: Options<DeleteUserGroupData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteUserGroupData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5047

`Static`deleteUserGroupById

deleteUserGroupById<ThrowOnError extends boolean = true>(
options: Options<DeleteUserGroupByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserGroupByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5094

`Static`deleteUserGroupByIdUsers

deleteUserGroupByIdUsers<ThrowOnError extends boolean = true>(
options: Options<DeleteUserGroupByIdUsersData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserGroupByIdUsersData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5137

`Static`getFilterUserGroup

getFilterUserGroup<ThrowOnError extends boolean = true>(
options?: Options<GetFilterUserGroupData, ThrowOnError>,
): RequestResult<PagedUserGroupResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetFilterUserGroupData, ThrowOnError>
Returns RequestResult<PagedUserGroupResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5021

`Static`getItemUserGroup

getItemUserGroup<ThrowOnError extends boolean = true>(
options?: Options<GetItemUserGroupData, ThrowOnError>,
): RequestResult<UserGroupItemResponseModel[], unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemUserGroupData, ThrowOnError>
Returns RequestResult<UserGroupItemResponseModel[], unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5034

`Static`getUserGroup

getUserGroup<ThrowOnError extends boolean = true>(
options?: Options<GetUserGroupData, ThrowOnError>,
): RequestResult<PagedUserGroupResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserGroupData, ThrowOnError>
Returns RequestResult<PagedUserGroupResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5064

`Static`getUserGroupById

getUserGroupById<ThrowOnError extends boolean = true>(
options: Options<GetUserGroupByIdData, ThrowOnError>,
): RequestResult<UserGroupResponseModel, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserGroupByIdData, ThrowOnError>
Returns RequestResult<UserGroupResponseModel, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5107

`Static`postUserGroup

postUserGroup<ThrowOnError extends boolean = true>(
options?: Options<PostUserGroupData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserGroupData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5077

`Static`postUserGroupByIdUsers

postUserGroupByIdUsers<ThrowOnError extends boolean = true>(
options: Options<PostUserGroupByIdUsersData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserGroupByIdUsersData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5154

`Static`putUserGroupById

putUserGroupById<ThrowOnError extends boolean = true>(
options: Options<PutUserGroupByIdData, ThrowOnError>,
): RequestResult<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutUserGroupByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5120