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<
    DeleteUserGroupResponses,
    DeleteUserGroupErrors,
    ThrowOnError,
    "fields",
>
Deletes multiple user groups. Deletes multiple user groups identified by the provided Ids. This operation cannot be undone.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<DeleteUserGroupData, ThrowOnError>
Returns RequestResult<
    DeleteUserGroupResponses,
    DeleteUserGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7155

`Static`deleteUserGroupById

deleteUserGroupById<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserGroupByIdData, ThrowOnError>,
): RequestResult<
    DeleteUserGroupByIdResponses,
    DeleteUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a user group. Deletes a user group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserGroupByIdData, ThrowOnError>
Returns RequestResult<
    DeleteUserGroupByIdResponses,
    DeleteUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7214

`Static`deleteUserGroupByIdUsers

deleteUserGroupByIdUsers<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserGroupByIdUsersData, ThrowOnError>,
): RequestResult<
    DeleteUserGroupByIdUsersResponses,
    DeleteUserGroupByIdUsersErrors,
    ThrowOnError,
    "fields",
>
Removes users from a user group. Removes the specified users from the user group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserGroupByIdUsersData, ThrowOnError>
Returns RequestResult<
    DeleteUserGroupByIdUsersResponses,
    DeleteUserGroupByIdUsersErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7269

`Static`getFilterUserGroup

getFilterUserGroup<ThrowOnError extends boolean = true>(
    options?: Options<GetFilterUserGroupData, ThrowOnError>,
): RequestResult<
    GetFilterUserGroupResponses,
    GetFilterUserGroupErrors,
    ThrowOnError,
    "fields",
>
Gets a filtered collection of user groups. Filters user groups based on the provided criteria with support for pagination.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetFilterUserGroupData, ThrowOnError>
Returns RequestResult<
    GetFilterUserGroupResponses,
    GetFilterUserGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7121

`Static`getItemUserGroup

getItemUserGroup<ThrowOnError extends boolean = true>(
    options?: Options<GetItemUserGroupData, ThrowOnError>,
): RequestResult<
    GetItemUserGroupResponses,
    GetItemUserGroupErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of user group items. Gets a collection of user group items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemUserGroupData, ThrowOnError>
Returns RequestResult<
    GetItemUserGroupResponses,
    GetItemUserGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7138

`Static`getUserGroup

getUserGroup<ThrowOnError extends boolean = true>(
    options?: Options<GetUserGroupData, ThrowOnError>,
): RequestResult<
    GetUserGroupResponses,
    GetUserGroupErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of user groups. Gets a paginated collection of all user groups.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserGroupData, ThrowOnError>
Returns RequestResult<GetUserGroupResponses, GetUserGroupErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7176

`Static`getUserGroupById

getUserGroupById<ThrowOnError extends boolean = true>(
    options: Options<GetUserGroupByIdData, ThrowOnError>,
): RequestResult<
    GetUserGroupByIdResponses,
    GetUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a user group. Gets a user group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserGroupByIdData, ThrowOnError>
Returns RequestResult<
    GetUserGroupByIdResponses,
    GetUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7231

`Static`postUserGroup

postUserGroup<ThrowOnError extends boolean = true>(
    options?: Options<PostUserGroupData, ThrowOnError>,
): RequestResult<
    PostUserGroupResponses,
    PostUserGroupErrors,
    ThrowOnError,
    "fields",
>
Creates a new user group. Creates a new user group with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostUserGroupData, ThrowOnError>
Returns RequestResult<
    PostUserGroupResponses,
    PostUserGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7193

`Static`postUserGroupByIdUsers

postUserGroupByIdUsers<ThrowOnError extends boolean = true>(
    options: Options<PostUserGroupByIdUsersData, ThrowOnError>,
): RequestResult<
    PostUserGroupByIdUsersResponses,
    PostUserGroupByIdUsersErrors,
    ThrowOnError,
    "fields",
>
Adds users to a user group. Adds the specified users to the user group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserGroupByIdUsersData, ThrowOnError>
Returns RequestResult<
    PostUserGroupByIdUsersResponses,
    PostUserGroupByIdUsersErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7290

`Static`putUserGroupById

putUserGroupById<ThrowOnError extends boolean = true>(
    options: Options<PutUserGroupByIdData, ThrowOnError>,
): RequestResult<
    PutUserGroupByIdResponses,
    PutUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a user group. Updates a user group identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutUserGroupByIdData, ThrowOnError>
Returns RequestResult<
    PutUserGroupByIdResponses,
    PutUserGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7248

Class UserGroupService

Index

Constructors

Methods

Constructors

constructor

Returns UserGroupService

Methods

StaticdeleteUserGroup

Type Parameters

Parameters

Returns RequestResult< DeleteUserGroupResponses, DeleteUserGroupErrors, ThrowOnError, "fields",>

StaticdeleteUserGroupById

Type Parameters

Parameters

Returns RequestResult< DeleteUserGroupByIdResponses, DeleteUserGroupByIdErrors, ThrowOnError, "fields",>

StaticdeleteUserGroupByIdUsers

Type Parameters

Parameters

Returns RequestResult< DeleteUserGroupByIdUsersResponses, DeleteUserGroupByIdUsersErrors, ThrowOnError, "fields",>

StaticgetFilterUserGroup

Type Parameters

Parameters

Returns RequestResult< GetFilterUserGroupResponses, GetFilterUserGroupErrors, ThrowOnError, "fields",>

StaticgetItemUserGroup

Type Parameters

Parameters

Returns RequestResult< GetItemUserGroupResponses, GetItemUserGroupErrors, ThrowOnError, "fields",>

StaticgetUserGroup

Type Parameters

Parameters

Returns RequestResult<GetUserGroupResponses, GetUserGroupErrors, ThrowOnError, "fields">

StaticgetUserGroupById

Type Parameters

Parameters

Returns RequestResult< GetUserGroupByIdResponses, GetUserGroupByIdErrors, ThrowOnError, "fields",>

StaticpostUserGroup

Type Parameters

Parameters

Returns RequestResult< PostUserGroupResponses, PostUserGroupErrors, ThrowOnError, "fields",>

StaticpostUserGroupByIdUsers

Type Parameters

Parameters

Returns RequestResult< PostUserGroupByIdUsersResponses, PostUserGroupByIdUsersErrors, ThrowOnError, "fields",>

StaticputUserGroupById

Type Parameters

Parameters

Returns RequestResult< PutUserGroupByIdResponses, PutUserGroupByIdErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteUserGroup

Returns RequestResult<
DeleteUserGroupResponses,
DeleteUserGroupErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserGroupById

Returns RequestResult<
DeleteUserGroupByIdResponses,
DeleteUserGroupByIdErrors,
ThrowOnError,
"fields",
>

`Static`deleteUserGroupByIdUsers

Returns RequestResult<
DeleteUserGroupByIdUsersResponses,
DeleteUserGroupByIdUsersErrors,
ThrowOnError,
"fields",
>

`Static`getFilterUserGroup

Returns RequestResult<
GetFilterUserGroupResponses,
GetFilterUserGroupErrors,
ThrowOnError,
"fields",
>

`Static`getItemUserGroup

Returns RequestResult<
GetItemUserGroupResponses,
GetItemUserGroupErrors,
ThrowOnError,
"fields",
>

`Static`getUserGroup

`Static`getUserGroupById

Returns RequestResult<
GetUserGroupByIdResponses,
GetUserGroupByIdErrors,
ThrowOnError,
"fields",
>

`Static`postUserGroup

Returns RequestResult<
PostUserGroupResponses,
PostUserGroupErrors,
ThrowOnError,
"fields",
>

`Static`postUserGroupByIdUsers

Returns RequestResult<
PostUserGroupByIdUsersResponses,
PostUserGroupByIdUsersErrors,
ThrowOnError,
"fields",
>

`Static`putUserGroupById

Returns RequestResult<
PutUserGroupByIdResponses,
PutUserGroupByIdErrors,
ThrowOnError,
"fields",
>