Skip to main content

AccountsGraphQLClient

Implements

unknown

Constructors

constructor

new AccountsGraphQLClient(options: OptionsType): default

Parameters
- options: OptionsType
Returns default

Properties

publicclient

client: AccountsClient

Methods

publicaddEmail

addEmail(newEmail: string): Promise<void>

@inheritDoc
Parameters
- newEmail: string
Returns Promise<void>

publicauthenticateWithService

authenticateWithService(service: string, authenticateParams: {}): Promise<boolean>

@inheritDoc
Parameters
- service: string
- authenticateParams: {}
Returns Promise<boolean>

publicchangePassword

changePassword(oldPassword: string, newPassword: string): Promise<void>

@inheritDoc
Parameters
- oldPassword: string
- newPassword: string
Returns Promise<void>

publiccreateUser

createUser(user: CreateUser): Promise<CreateUserResult>

Create a user with basic user info
@memberof
GraphQLClient
Parameters
- user: CreateUser
  user object
Returns Promise<CreateUserResult>
contains user's ID and LoginResult object if autologin is enabled

publicgetTwoFactorSecret

getTwoFactorSecret(): Promise<any>

@inheritDoc
Returns Promise<any>

publicgetUser

getUser(): Promise<User>

@inheritDoc
Returns Promise<User>

publicimpersonate

impersonate(token: string, impersonated: { email?: string; userId?: string; username?: string }): Promise<ImpersonationResult>

@inheritDoc
Parameters
- token: string
- impersonated: { email?: string; userId?: string; username?: string }
Returns Promise<ImpersonationResult>

publicloginWithService

loginWithService(service: string, authenticateParams: AuthenticateParams): Promise<LoginResult>

@inheritDoc
Parameters
- service: string
- authenticateParams: AuthenticateParams
Returns Promise<LoginResult>

publiclogout

logout(): Promise<void>

@inheritDoc
Returns Promise<void>

publicrefreshTokens

refreshTokens(accessToken: string, refreshToken: string): Promise<LoginResult>

@inheritDoc
Parameters
- accessToken: string
- refreshToken: string
Returns Promise<LoginResult>

publicrequestMagicLinkEmail

requestMagicLinkEmail(email: string): Promise<void>

@inheritDoc
Parameters
- email: string
Returns Promise<void>

publicresetPassword

resetPassword(token: string, newPassword: string): Promise<any>

@inheritDoc
Parameters
- token: string
- newPassword: string
Returns Promise<any>

publicsendResetPasswordEmail

sendResetPasswordEmail(email: string): Promise<void>

@inheritDoc
Parameters
- email: string
Returns Promise<void>

publicsendVerificationEmail

sendVerificationEmail(email: string): Promise<void>

@inheritDoc
Parameters
- email: string
Returns Promise<void>

publictwoFactorSet

twoFactorSet(secret: any, code: string): Promise<void>

@inheritDoc
Parameters
- secret: any
- code: string
Returns Promise<void>

publictwoFactorUnset

twoFactorUnset(code: string): Promise<void>

@inheritDoc
Parameters
- code: string
Returns Promise<void>

publicverifyEmail

verifyEmail(token: string): Promise<void>

@inheritDoc
Parameters
- token: string
Returns Promise<void>

constructor
client
addEmail
authenticateWithService
changePassword
createUser
getTwoFactorSecret
getUser
impersonate
loginWithService
logout
refreshTokens
requestMagicLinkEmail
resetPassword
sendResetPasswordEmail
sendVerificationEmail
twoFactorSet
twoFactorUnset
verifyEmail