Class AccountClient

Hierarchy

AccountClient

Index

Constructors

constructor

Methods

Constructors

constructor

new AccountClient(_request: IRequest): AccountClient

- Defined in src/client/index.ts:58
Parameters
- _request: IRequest
Returns AccountClient

Methods

disableTwoFactor

disableTwoFactor(password: string): Promise<boolean>

- Defined in src/client/index.ts:76
Disables 2FA from user's account.

Parameters
- password: string
  
  User Account's password
Returns Promise<boolean>

enableTwoFactor

enableTwoFactor(otpCode: string): Promise<string[]>

- Defined in src/client/index.ts:83
Enables 2FA to user's account.

Parameters
- otpCode: string
  
  OTP Code from 2FA QR
Returns Promise<string[]>

getDetails

getDetails(): Promise<IAccountDetails>

- Defined in src/client/index.ts:69
Retrieves a detail of user's account

Returns Promise<IAccountDetails>

twoFactor

twoFactor(): Promise<string>

- Defined in src/client/index.ts:64
Generates a QR Code url for 2FA

Returns Promise<string>

updateEmail

updateEmail(newMail: string, password: string): Promise<true>

- Defined in src/client/index.ts:91
Updates user's email

Parameters
- newMail: string
  
  New Email
- password: string
  
  Your current password account
Returns Promise<true>

updatePassword

updatePassword(currentPassword: string, newPassword: string): Promise<boolean>

- Defined in src/client/index.ts:98
Updates user's password

Parameters
- currentPassword: string
  
  Your current account password
- newPassword: string
  
  New password you want
Returns Promise<boolean>

Generated using TypeDoc