Class MemberService

Index

Constructors

Methods

deleteMemberById getFilterMember getItemMember getItemMemberAncestors getItemMemberSearch getMemberAreReferenced getMemberById getMemberByIdReferencedBy getMemberByIdReferencedDescendants getMemberConfiguration postMember postMemberValidate putMemberById putMemberByIdValidate

Constructors

constructor

new MemberService(): MemberService
Returns MemberService

Methods

`Static`deleteMemberById

deleteMemberById<ThrowOnError extends boolean = true>(
    options: Options<DeleteMemberByIdData, ThrowOnError>,
): RequestResult<
    DeleteMemberByIdResponses,
    DeleteMemberByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes a member.

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

`Static`getFilterMember

getFilterMember<ThrowOnError extends boolean = true>(
    options?: Options<GetFilterMemberData, ThrowOnError>,
): RequestResult<
    GetFilterMemberResponses,
    GetFilterMemberErrors,
    ThrowOnError,
    "fields",
>
Gets a filtered collection of members.

Filters members based on the provided criteria with support for pagination.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetFilterMemberData, ThrowOnError>
Returns RequestResult<
    GetFilterMemberResponses,
    GetFilterMemberErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5111

`Static`getItemMember

getItemMember<ThrowOnError extends boolean = true>(
    options?: Options<GetItemMemberData, ThrowOnError>,
): RequestResult<
    GetItemMemberResponses,
    GetItemMemberErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of member items.

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

`Static`getItemMemberAncestors

getItemMemberAncestors<ThrowOnError extends boolean = true>(
    options?: Options<GetItemMemberAncestorsData, ThrowOnError>,
): RequestResult<
    GetItemMemberAncestorsResponses,
    GetItemMemberAncestorsErrors,
    ThrowOnError,
    "fields",
>
Gets ancestors for a collection of member items.

Gets the ancestor chains for member items identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemMemberAncestorsData, ThrowOnError>
Returns RequestResult<
    GetItemMemberAncestorsResponses,
    GetItemMemberAncestorsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5147

`Static`getItemMemberSearch

getItemMemberSearch<ThrowOnError extends boolean = true>(
    options?: Options<GetItemMemberSearchData, ThrowOnError>,
): RequestResult<
    GetItemMemberSearchResponses,
    GetItemMemberSearchErrors,
    ThrowOnError,
    "fields",
>
Searches member items.

Searches member items by the provided query with pagination support.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetItemMemberSearchData, ThrowOnError>
Returns RequestResult<
    GetItemMemberSearchResponses,
    GetItemMemberSearchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5165

`Static`getMemberAreReferenced

getMemberAreReferenced<ThrowOnError extends boolean = true>(
    options?: Options<GetMemberAreReferencedData, ThrowOnError>,
): RequestResult<
    GetMemberAreReferencedResponses,
    GetMemberAreReferencedErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of items that reference members.

Gets a paginated collection of items that reference the members identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMemberAreReferencedData, ThrowOnError>
Returns RequestResult<
    GetMemberAreReferencedResponses,
    GetMemberAreReferencedErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5321

`Static`getMemberById

getMemberById<ThrowOnError extends boolean = true>(
    options: Options<GetMemberByIdData, ThrowOnError>,
): RequestResult<
    GetMemberByIdResponses,
    GetMemberByIdErrors,
    ThrowOnError,
    "fields",
>
Gets a member.

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

`Static`getMemberByIdReferencedBy

getMemberByIdReferencedBy<ThrowOnError extends boolean = true>(
    options: Options<GetMemberByIdReferencedByData, ThrowOnError>,
): RequestResult<
    GetMemberByIdReferencedByResponses,
    GetMemberByIdReferencedByErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of items that reference members.

Gets a paginated collection of items that reference the members identified by the provided Ids.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetMemberByIdReferencedByData, ThrowOnError>
Returns RequestResult<
    GetMemberByIdReferencedByResponses,
    GetMemberByIdReferencedByErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5263

`Static`getMemberByIdReferencedDescendants

getMemberByIdReferencedDescendants<ThrowOnError extends boolean = true>(
    options: Options<GetMemberByIdReferencedDescendantsData, ThrowOnError>,
): RequestResult<
    GetMemberByIdReferencedDescendantsResponses,
    GetMemberByIdReferencedDescendantsErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of referenced descendant members.

Gets a paginated collection of descendant members that are referenced in relations for the member identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetMemberByIdReferencedDescendantsData, ThrowOnError>
Returns RequestResult<
    GetMemberByIdReferencedDescendantsResponses,
    GetMemberByIdReferencedDescendantsErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5281

`Static`getMemberConfiguration

getMemberConfiguration<ThrowOnError extends boolean = true>(
    options?: Options<GetMemberConfigurationData, ThrowOnError>,
): RequestResult<
    GetMemberConfigurationResponses,
    GetMemberConfigurationErrors,
    ThrowOnError,
    "fields",
>
Gets the member configuration.

Gets the configuration settings for members.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetMemberConfigurationData, ThrowOnError>
Returns RequestResult<
    GetMemberConfigurationResponses,
    GetMemberConfigurationErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5339

`Static`postMember

postMember<ThrowOnError extends boolean = true>(
    options?: Options<PostMemberData, ThrowOnError>,
): RequestResult<
    PostMemberResponses,
    PostMemberErrors,
    ThrowOnError,
    "fields",
>
Creates a new member.

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

`Static`postMemberValidate

postMemberValidate<ThrowOnError extends boolean = true>(
    options?: Options<PostMemberValidateData, ThrowOnError>,
): RequestResult<
    PostMemberValidateResponses,
    PostMemberValidateErrors,
    ThrowOnError,
    "fields",
>
Validates creating a member.

Validates the request model for creating a new member without actually creating it.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostMemberValidateData, ThrowOnError>
Returns RequestResult<
    PostMemberValidateResponses,
    PostMemberValidateErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5357

`Static`putMemberById

putMemberById<ThrowOnError extends boolean = true>(
    options: Options<PutMemberByIdData, ThrowOnError>,
): RequestResult<
    PutMemberByIdResponses,
    PutMemberByIdErrors,
    ThrowOnError,
    "fields",
>
Updates a member.

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

`Static`putMemberByIdValidate

putMemberByIdValidate<ThrowOnError extends boolean = true>(
    options: Options<PutMemberByIdValidateData, ThrowOnError>,
): RequestResult<
    PutMemberByIdValidateResponses,
    PutMemberByIdValidateErrors,
    ThrowOnError,
    "fields",
>
Validates updating a member.

Validates the request model for updating a member without actually updating it.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutMemberByIdValidateData, ThrowOnError>
Returns RequestResult<
    PutMemberByIdValidateResponses,
    PutMemberByIdValidateErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:5299

Class MemberService

Index

Constructors

Methods

Constructors

constructor

Returns MemberService

Methods

StaticdeleteMemberById

Type Parameters

Parameters

Returns RequestResult< DeleteMemberByIdResponses, DeleteMemberByIdErrors, ThrowOnError, "fields",>

StaticgetFilterMember

Type Parameters

Parameters

Returns RequestResult< GetFilterMemberResponses, GetFilterMemberErrors, ThrowOnError, "fields",>

StaticgetItemMember

Type Parameters

Parameters

Returns RequestResult< GetItemMemberResponses, GetItemMemberErrors, ThrowOnError, "fields",>

StaticgetItemMemberAncestors

Type Parameters

Parameters

Returns RequestResult< GetItemMemberAncestorsResponses, GetItemMemberAncestorsErrors, ThrowOnError, "fields",>

StaticgetItemMemberSearch

Type Parameters

Parameters

Returns RequestResult< GetItemMemberSearchResponses, GetItemMemberSearchErrors, ThrowOnError, "fields",>

StaticgetMemberAreReferenced

Type Parameters

Parameters

Returns RequestResult< GetMemberAreReferencedResponses, GetMemberAreReferencedErrors, ThrowOnError, "fields",>

StaticgetMemberById

Type Parameters

Parameters

Returns RequestResult< GetMemberByIdResponses, GetMemberByIdErrors, ThrowOnError, "fields",>

StaticgetMemberByIdReferencedBy

Type Parameters

Parameters

Returns RequestResult< GetMemberByIdReferencedByResponses, GetMemberByIdReferencedByErrors, ThrowOnError, "fields",>

StaticgetMemberByIdReferencedDescendants

Type Parameters

Parameters

Returns RequestResult< GetMemberByIdReferencedDescendantsResponses, GetMemberByIdReferencedDescendantsErrors, ThrowOnError, "fields",>

StaticgetMemberConfiguration

Type Parameters

Parameters

Returns RequestResult< GetMemberConfigurationResponses, GetMemberConfigurationErrors, ThrowOnError, "fields",>

StaticpostMember

Type Parameters

Parameters

Returns RequestResult<PostMemberResponses, PostMemberErrors, ThrowOnError, "fields">

StaticpostMemberValidate

Type Parameters

Parameters

Returns RequestResult< PostMemberValidateResponses, PostMemberValidateErrors, ThrowOnError, "fields",>

StaticputMemberById

Type Parameters

Parameters

Returns RequestResult< PutMemberByIdResponses, PutMemberByIdErrors, ThrowOnError, "fields",>

StaticputMemberByIdValidate

Type Parameters

Parameters

Returns RequestResult< PutMemberByIdValidateResponses, PutMemberByIdValidateErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteMemberById

Returns RequestResult<
DeleteMemberByIdResponses,
DeleteMemberByIdErrors,
ThrowOnError,
"fields",
>

`Static`getFilterMember

Returns RequestResult<
GetFilterMemberResponses,
GetFilterMemberErrors,
ThrowOnError,
"fields",
>

`Static`getItemMember

Returns RequestResult<
GetItemMemberResponses,
GetItemMemberErrors,
ThrowOnError,
"fields",
>

`Static`getItemMemberAncestors

Returns RequestResult<
GetItemMemberAncestorsResponses,
GetItemMemberAncestorsErrors,
ThrowOnError,
"fields",
>

`Static`getItemMemberSearch

Returns RequestResult<
GetItemMemberSearchResponses,
GetItemMemberSearchErrors,
ThrowOnError,
"fields",
>

`Static`getMemberAreReferenced

Returns RequestResult<
GetMemberAreReferencedResponses,
GetMemberAreReferencedErrors,
ThrowOnError,
"fields",
>

`Static`getMemberById

Returns RequestResult<
GetMemberByIdResponses,
GetMemberByIdErrors,
ThrowOnError,
"fields",
>

`Static`getMemberByIdReferencedBy

Returns RequestResult<
GetMemberByIdReferencedByResponses,
GetMemberByIdReferencedByErrors,
ThrowOnError,
"fields",
>

`Static`getMemberByIdReferencedDescendants

Returns RequestResult<
GetMemberByIdReferencedDescendantsResponses,
GetMemberByIdReferencedDescendantsErrors,
ThrowOnError,
"fields",
>

`Static`getMemberConfiguration

Returns RequestResult<
GetMemberConfigurationResponses,
GetMemberConfigurationErrors,
ThrowOnError,
"fields",
>

`Static`postMember

`Static`postMemberValidate

Returns RequestResult<
PostMemberValidateResponses,
PostMemberValidateErrors,
ThrowOnError,
"fields",
>

`Static`putMemberById

Returns RequestResult<
PutMemberByIdResponses,
PutMemberByIdErrors,
ThrowOnError,
"fields",
>

`Static`putMemberByIdValidate

Returns RequestResult<
PutMemberByIdValidateResponses,
PutMemberByIdValidateErrors,
ThrowOnError,
"fields",
>