Class UserDataService

Index

Constructors

Methods

deleteUserDataById getUserData getUserDataById postUserData putUserData

Constructors

constructor

new UserDataService(): UserDataService
Returns UserDataService

Methods

`Static`deleteUserDataById

deleteUserDataById<ThrowOnError extends boolean = true>(
    options: Options<DeleteUserDataByIdData, ThrowOnError>,
): RequestResult<
    DeleteUserDataByIdResponses,
    DeleteUserDataByIdErrors,
    ThrowOnError,
    "fields",
>
Deletes user data.

Deletes user data identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteUserDataByIdData, ThrowOnError>
Returns RequestResult<
    DeleteUserDataByIdResponses,
    DeleteUserDataByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7046

`Static`getUserData

getUserData<ThrowOnError extends boolean = true>(
    options?: Options<GetUserDataData, ThrowOnError, unknown>,
): RequestResult<
    GetUserDataResponses,
    GetUserDataErrors,
    ThrowOnError,
    "fields",
>
Gets user data.

Gets user-specific data stored for the current authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetUserDataData, ThrowOnError, unknown>
Returns RequestResult<GetUserDataResponses, GetUserDataErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:6999

`Static`getUserDataById

getUserDataById<ThrowOnError extends boolean = true>(
    options: Options<GetUserDataByIdData, ThrowOnError>,
): RequestResult<
    GetUserDataByIdResponses,
    GetUserDataByIdErrors,
    ThrowOnError,
    "fields",
>
Gets user data.

Gets user data identified by the provided Id.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetUserDataByIdData, ThrowOnError>
Returns RequestResult<
    GetUserDataByIdResponses,
    GetUserDataByIdErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:7059

`Static`postUserData

postUserData<ThrowOnError extends boolean = true>(
    options: Options<PostUserDataData, ThrowOnError>,
): RequestResult<
    PostUserDataResponses,
    PostUserDataErrors,
    ThrowOnError,
    "fields",
>
Creates user data.

Creates user-specific data for the current authenticated user with the provided key and value.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PostUserDataData, ThrowOnError>
Returns RequestResult<PostUserDataResponses, PostUserDataErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7012

`Static`putUserData

putUserData<ThrowOnError extends boolean = true>(
    options: Options<PutUserDataData, ThrowOnError>,
): RequestResult<
    PutUserDataResponses,
    PutUserDataErrors,
    ThrowOnError,
    "fields",
>
Updates user data.

Updates user-specific data for the current authenticated user.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<PutUserDataData, ThrowOnError>
Returns RequestResult<PutUserDataResponses, PutUserDataErrors, ThrowOnError, "fields">
- Defined in src/packages/core/backend-api/sdk.gen.ts:7029