Class MemberService

Index

Constructors

Methods

deleteMemberById getFilterMember getItemMember 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<unknown, unknown, ThrowOnError>
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteMemberByIdData, ThrowOnError>
Returns RequestResult<unknown, unknown, ThrowOnError>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3294

`Static`getFilterMember

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

`Static`getItemMember

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

`Static`getItemMemberSearch

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

`Static`getMemberAreReferenced

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

`Static`getMemberById

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

`Static`postMember

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

`Static`postMemberValidate

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

`Static`putMemberById

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

`Static`putMemberByIdValidate

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

Class MemberService

Index

Constructors

Methods

Constructors

constructor

Returns MemberService

Methods

StaticdeleteMemberById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticgetFilterMember

Type Parameters

Parameters

Returns RequestResult<PagedMemberResponseModel, unknown, ThrowOnError>

StaticgetItemMember

Type Parameters

Parameters

Returns RequestResult<MemberItemResponseModel[], unknown, ThrowOnError>

StaticgetItemMemberSearch

Type Parameters

Parameters

Returns RequestResult<PagedModelMemberItemResponseModel, unknown, ThrowOnError>

StaticgetMemberAreReferenced

Type Parameters

Parameters

Returns RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>

StaticgetMemberById

Type Parameters

Parameters

Returns RequestResult<MemberResponseModel, unknown, ThrowOnError>

StaticgetMemberByIdReferencedBy

Type Parameters

Parameters

Returns RequestResult<PagedIReferenceResponseModel, unknown, ThrowOnError>

StaticgetMemberByIdReferencedDescendants

Type Parameters

Parameters

Returns RequestResult<PagedReferenceByIdModel, unknown, ThrowOnError>

StaticgetMemberConfiguration

Type Parameters

Parameters

Returns RequestResult<MemberConfigurationResponseModel, unknown, ThrowOnError>

StaticpostMember

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticpostMemberValidate

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputMemberById

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

StaticputMemberByIdValidate

Type Parameters

Parameters

Returns RequestResult<unknown, unknown, ThrowOnError>

Settings

On This Page

`Static`deleteMemberById

`Static`getFilterMember

`Static`getItemMember

`Static`getItemMemberSearch

`Static`getMemberAreReferenced

`Static`getMemberById

`Static`getMemberByIdReferencedBy

`Static`getMemberByIdReferencedDescendants

`Static`getMemberConfiguration

`Static`postMember

`Static`postMemberValidate

`Static`putMemberById

`Static`putMemberByIdValidate