Class MemberGroupService

Index

Constructors

Methods

deleteMemberGroupById getItemMemberGroup getMemberGroup getMemberGroupById getTreeMemberGroupRoot postMemberGroup putMemberGroupById

Constructors

constructor

new MemberGroupService(): MemberGroupService
Returns MemberGroupService

Methods

`Static`deleteMemberGroupById

deleteMemberGroupById<ThrowOnError extends boolean = true>(
    options: Options<DeleteMemberGroupByIdData, ThrowOnError>,
): RequestResult<
    DeleteMemberGroupByIdResponses,
    DeleteMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a member group.

Deletes a member group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteMemberGroupByIdData, ThrowOnError>
Returns RequestResult<
    DeleteMemberGroupByIdResponses,
    DeleteMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4532

`Static`getItemMemberGroup

getItemMemberGroup<ThrowOnError extends boolean = true>(
    options?: Options<GetItemMemberGroupData, ThrowOnError>,
): RequestResult<
    GetItemMemberGroupResponses,
    GetItemMemberGroupErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of member group items.

Gets a collection of member group items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemMemberGroupData, ThrowOnError>
Returns RequestResult<
    GetItemMemberGroupResponses,
    GetItemMemberGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4474

`Static`getMemberGroup

getMemberGroup<ThrowOnError extends boolean = true>(
    options?: Options<GetMemberGroupData, ThrowOnError>,
): RequestResult<
    GetMemberGroupResponses,
    GetMemberGroupErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of member groups.

Gets a paginated collection of all member groups.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMemberGroupData, ThrowOnError>
Returns RequestResult<
    GetMemberGroupResponses,
    GetMemberGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4492

`Static`getMemberGroupById

getMemberGroupById<ThrowOnError extends boolean = true>(
    options: Options<GetMemberGroupByIdData, ThrowOnError>,
): RequestResult<
    GetMemberGroupByIdResponses,
    GetMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a member group.

Gets a member group identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetMemberGroupByIdData, ThrowOnError>
Returns RequestResult<
    GetMemberGroupByIdResponses,
    GetMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4550

`Static`getTreeMemberGroupRoot

getTreeMemberGroupRoot<ThrowOnError extends boolean = true>(
    options?: Options<GetTreeMemberGroupRootData, ThrowOnError>,
): RequestResult<
    GetTreeMemberGroupRootResponses,
    GetTreeMemberGroupRootErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of member group items from the root of the tree.

Gets a paginated collection of member group items from the root of the tree with optional filtering.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetTreeMemberGroupRootData, ThrowOnError>
Returns RequestResult<
    GetTreeMemberGroupRootResponses,
    GetTreeMemberGroupRootErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4590

`Static`postMemberGroup

postMemberGroup<ThrowOnError extends boolean = true>(
    options?: Options<PostMemberGroupData, ThrowOnError>,
): RequestResult<
    PostMemberGroupResponses,
    PostMemberGroupErrors,
    ThrowOnError,
    "fields",
>
Creates a new member group.

Creates a new member group with the configuration specified in the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostMemberGroupData, ThrowOnError>
Returns RequestResult<
    PostMemberGroupResponses,
    PostMemberGroupErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4510

`Static`putMemberGroupById

putMemberGroupById<ThrowOnError extends boolean = true>(
    options: Options<PutMemberGroupByIdData, ThrowOnError>,
): RequestResult<
    PutMemberGroupByIdResponses,
    PutMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a member group.

Updates a member group identified by the provided Id with the details from the request model.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMemberGroupByIdData, ThrowOnError>
Returns RequestResult<
    PutMemberGroupByIdResponses,
    PutMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:4568

Class MemberGroupService

Index

Constructors

Methods

Constructors

constructor

Returns MemberGroupService

Methods

`Static`deleteMemberGroupById

Type Parameters

Parameters

Returns RequestResult<
    DeleteMemberGroupByIdResponses,
    DeleteMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>

`Static`getItemMemberGroup

Type Parameters

Parameters

Returns RequestResult<
    GetItemMemberGroupResponses,
    GetItemMemberGroupErrors,
    ThrowOnError,
    "fields",
>

`Static`getMemberGroup

Type Parameters

Parameters

Returns RequestResult<
    GetMemberGroupResponses,
    GetMemberGroupErrors,
    ThrowOnError,
    "fields",
>

`Static`getMemberGroupById

Type Parameters

Parameters

Returns RequestResult<
    GetMemberGroupByIdResponses,
    GetMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>

`Static`getTreeMemberGroupRoot

Type Parameters

Parameters

Returns RequestResult<
    GetTreeMemberGroupRootResponses,
    GetTreeMemberGroupRootErrors,
    ThrowOnError,
    "fields",
>

`Static`postMemberGroup

Type Parameters

Parameters

Returns RequestResult<
    PostMemberGroupResponses,
    PostMemberGroupErrors,
    ThrowOnError,
    "fields",
>

`Static`putMemberGroupById

Type Parameters

Parameters

Returns RequestResult<
    PutMemberGroupByIdResponses,
    PutMemberGroupByIdErrors,
    ThrowOnError,
    "fields",
>

Settings

On This Page

Class MemberGroupService

Index

Constructors

Methods

Constructors

constructor

Returns MemberGroupService

Methods

StaticdeleteMemberGroupById

Type Parameters

Parameters

Returns RequestResult< DeleteMemberGroupByIdResponses, DeleteMemberGroupByIdErrors, ThrowOnError, "fields",>

StaticgetItemMemberGroup

Type Parameters

Parameters

Returns RequestResult< GetItemMemberGroupResponses, GetItemMemberGroupErrors, ThrowOnError, "fields",>

StaticgetMemberGroup

Type Parameters

Parameters

Returns RequestResult< GetMemberGroupResponses, GetMemberGroupErrors, ThrowOnError, "fields",>

StaticgetMemberGroupById

Type Parameters

Parameters

Returns RequestResult< GetMemberGroupByIdResponses, GetMemberGroupByIdErrors, ThrowOnError, "fields",>

StaticgetTreeMemberGroupRoot

Type Parameters

Parameters

Returns RequestResult< GetTreeMemberGroupRootResponses, GetTreeMemberGroupRootErrors, ThrowOnError, "fields",>

StaticpostMemberGroup

Type Parameters

Parameters

Returns RequestResult< PostMemberGroupResponses, PostMemberGroupErrors, ThrowOnError, "fields",>

StaticputMemberGroupById

Type Parameters

Parameters

Returns RequestResult< PutMemberGroupByIdResponses, PutMemberGroupByIdErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteMemberGroupById

Returns RequestResult<
DeleteMemberGroupByIdResponses,
DeleteMemberGroupByIdErrors,
ThrowOnError,
"fields",
>

`Static`getItemMemberGroup

Returns RequestResult<
GetItemMemberGroupResponses,
GetItemMemberGroupErrors,
ThrowOnError,
"fields",
>

`Static`getMemberGroup

Returns RequestResult<
GetMemberGroupResponses,
GetMemberGroupErrors,
ThrowOnError,
"fields",
>

`Static`getMemberGroupById

Returns RequestResult<
GetMemberGroupByIdResponses,
GetMemberGroupByIdErrors,
ThrowOnError,
"fields",
>

`Static`getTreeMemberGroupRoot

Returns RequestResult<
GetTreeMemberGroupRootResponses,
GetTreeMemberGroupRootErrors,
ThrowOnError,
"fields",
>

`Static`postMemberGroup

Returns RequestResult<
PostMemberGroupResponses,
PostMemberGroupErrors,
ThrowOnError,
"fields",
>

`Static`putMemberGroupById

Returns RequestResult<
PutMemberGroupByIdResponses,
PutMemberGroupByIdErrors,
ThrowOnError,
"fields",
>