Class Account

Hierarchy

HeyApiClient
- Account

Index

Methods

changePassword login logout me register usernameAvailability

Methods

changePassword

changePassword<ThrowOnError extends boolean = true>(
    parameters: { current_password: string; new_password: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    ChangePasswordResponses,
    ChangePasswordErrors,
    ThrowOnError,
    "data",
>
Change the current password
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { current_password: string; new_password: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    ChangePasswordResponses,
    ChangePasswordErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:315

login<ThrowOnError extends boolean = true>(
parameters: { identifier: string; password: string },
options?: Options<never, ThrowOnError, unknown>,
): RequestResult<LoginResponses, LoginErrors, ThrowOnError, "data">
Create a user session
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { identifier: string; password: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<LoginResponses, LoginErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:219

logout

logout<ThrowOnError extends boolean = true>(
options?: Options<never, ThrowOnError, unknown>,
): RequestResult<LogoutResponses, LogoutErrors, ThrowOnError, "data">
Revoke the current session
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<LogoutResponses, LogoutErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:258

me

me<ThrowOnError extends boolean = true>(
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    GetCurrentUserResponses,
    GetCurrentUserErrors,
    ThrowOnError,
    "data",
>
Get the current user
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    GetCurrentUserResponses,
    GetCurrentUserErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:284

register

register<ThrowOnError extends boolean = true>(
    parameters: { email: string; name: string; password: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    RegisterUserResponses,
    RegisterUserErrors,
    ThrowOnError,
    "data",
>
Register a local user

A 409 has code username_taken when an account or an organization already holds the username, and code email_taken when an account already uses the email address.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { email: string; name: string; password: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "data">
- Defined in src/generated/sdk.gen.ts:142

usernameAvailability

usernameAvailability<ThrowOnError extends boolean = true>(
    parameters: { name: string },
    options?: Options<never, ThrowOnError, unknown>,
): RequestResult<
    GetUsernameAvailabilityResponses,
    GetUsernameAvailabilityErrors,
    ThrowOnError,
    "data",
>
Check whether a username is available
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- parameters: { name: string }
- Optionaloptions: Options<never, ThrowOnError, unknown>
Returns RequestResult<
    GetUsernameAvailabilityResponses,
    GetUsernameAvailabilityErrors,
    ThrowOnError,
    "data",
>
- Defined in src/generated/sdk.gen.ts:188

Class Account

Hierarchy

Index

Methods

Methods

changePassword

Type Parameters

Parameters

Returns RequestResult<
    ChangePasswordResponses,
    ChangePasswordErrors,
    ThrowOnError,
    "data",
>

Type Parameters

Parameters

Returns RequestResult<LoginResponses, LoginErrors, ThrowOnError, "data">

logout

Type Parameters

Parameters

Returns RequestResult<LogoutResponses, LogoutErrors, ThrowOnError, "data">

me

Type Parameters

Parameters

Returns RequestResult<
    GetCurrentUserResponses,
    GetCurrentUserErrors,
    ThrowOnError,
    "data",
>

register

Type Parameters

Parameters

Returns RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "data">

usernameAvailability

Type Parameters

Parameters

Returns RequestResult<
    GetUsernameAvailabilityResponses,
    GetUsernameAvailabilityErrors,
    ThrowOnError,
    "data",
>

Settings

On This Page

Class Account

Hierarchy

Index

Methods

Methods

changePassword

Type Parameters

Parameters

Returns RequestResult< ChangePasswordResponses, ChangePasswordErrors, ThrowOnError, "data",>

login

Type Parameters

Parameters

Returns RequestResult<LoginResponses, LoginErrors, ThrowOnError, "data">

logout

Type Parameters

Parameters

Returns RequestResult<LogoutResponses, LogoutErrors, ThrowOnError, "data">

me

Type Parameters

Parameters

Returns RequestResult< GetCurrentUserResponses, GetCurrentUserErrors, ThrowOnError, "data",>

register

Type Parameters

Parameters

Returns RequestResult<RegisterUserResponses, RegisterUserErrors, ThrowOnError, "data">

usernameAvailability

Type Parameters

Parameters

Returns RequestResult< GetUsernameAvailabilityResponses, GetUsernameAvailabilityErrors, ThrowOnError, "data",>

Settings

On This Page

Returns RequestResult<
ChangePasswordResponses,
ChangePasswordErrors,
ThrowOnError,
"data",
>

Returns RequestResult<
GetCurrentUserResponses,
GetCurrentUserErrors,
ThrowOnError,
"data",
>

Returns RequestResult<
GetUsernameAvailabilityResponses,
GetUsernameAvailabilityErrors,
ThrowOnError,
"data",
>