Class AccountService

Account service

Hierarchy (View Summary)

BaseService
- AccountService

Index

Constructors

Properties

apiClient axiosInstance

Methods

confirmPasswordRecovery getInfo getPreferences refreshToken requestPasswordRecovery resendVerificationEmail signIn update updatePassword updatePreferences verifyEmail

Constructors

constructor

new AccountService(apiClient: Client): AccountService
Constructor
Parameters
- apiClient: Client
  API client
Returns AccountService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

confirmPasswordRecovery

confirmPasswordRecovery(
requestUuid: string,
request: UserPasswordReset,
): Promise<UserSignedIn>
Reset the new user's password
Parameters
- requestUuid: string
  Password recovery request UUID
- request: UserPasswordReset
  Password reset request
Returns Promise<UserSignedIn>
Signed-in user
- Defined in services/AccountService.ts:78

getInfo

getInfo(): Promise<UserInfo>
Retrieve information about the logged-in user

Returns Promise<UserInfo>
User information
- Defined in services/AccountService.ts:47

getPreferences

getPreferences(): Promise<UserPreferences>
Retrieve preferences of the logged-in user

Returns Promise<UserPreferences>
User preferences
- Defined in services/AccountService.ts:102

refreshToken

refreshToken(): Promise<UserSignedIn>
Refresh the user token

Returns Promise<UserSignedIn>
Signed in user
- Defined in services/AccountService.ts:156

requestPasswordRecovery

requestPasswordRecovery(recovery: UserAccountRecovery): Promise<void>
Request user account recovery
Parameters
- recovery: UserAccountRecovery
  Account recovery request
Returns Promise<void>
- Defined in services/AccountService.ts:94

resendVerificationEmail

resendVerificationEmail(request: EmailVerificationResendRequest): Promise<void>
Resends the verification email
Parameters
- request: EmailVerificationResendRequest
  Verification e-mail resend request
Returns Promise<void>
- Defined in services/AccountService.ts:137

signIn

signIn(credentials: UserCredentials): Promise<UserSignedIn>
Sign in the user
Parameters
- credentials: UserCredentials
  User credentials
Returns Promise<UserSignedIn>
Signed in user
- Defined in services/AccountService.ts:146

update

update(user: UserEdit): Promise<EmailSentResponse>
Update the user
Parameters
- user: UserEdit
  User to edit
Returns Promise<EmailSentResponse>
Email sent response
- Defined in services/AccountService.ts:58

updatePassword

updatePassword(change: UserPasswordChange): Promise<void>
Update the user's password
Parameters
- change: UserPasswordChange
  Password change request
Returns Promise<void>
- Defined in services/AccountService.ts:68

updatePreferences

updatePreferences(preferences: UserPreferences): Promise<void>
Update the preferences of the logged-in user
Parameters
- preferences: UserPreferences
  User preferences
Returns Promise<void>
- Defined in services/AccountService.ts:112

verifyEmail

verifyEmail(uuid: string): Promise<UserSignedIn>
Verify the e-mail address
Parameters
- uuid: string
  E-mail verification UUID
Returns Promise<UserSignedIn>
Signed-in user
- Defined in services/AccountService.ts:121