RestClient

Implements

• TransportInterface

Index

Constructors

• constructor

Properties

• client

Methods

• addEmail
• authFetch
• authenticateWithService
• changePassword
• createUser
• fetch
• getTwoFactorSecret
• getUser
• impersonate
• loginWithService
• logout
• refreshTokens
• requestMagicLinkEmail
• resetPassword
• sendResetPasswordEmail
• sendVerificationEmail
• twoFactorSet
• twoFactorUnset
• verifyEmail

Constructors

constructor

• new RestClient(options: OptionsType): RestClient

• Parameters

  • options: OptionsType

  Returns RestClient

Properties

publicclient

client: AccountsClient

Implementation of TransportInterface.client

Methods

publicaddEmail

• addEmail(newEmail: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.addEmail

  Parameters

  • newEmail: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publicauthFetch

• authFetch(route: string, args: object, customHeaders?: object): Promise<any>

• Parameters

  • route: string

  • args: object

  • customHeaders: object = {}

  Returns Promise<any>

publicauthenticateWithService

• authenticateWithService(provider: string, data: any, customHeaders?: object): Promise<boolean>

• Implementation of TransportInterface.authenticateWithService

  Parameters

  • provider: string

  • data: any

  • optionalcustomHeaders: object

  Returns Promise<boolean>

publicchangePassword

• changePassword(oldPassword: string, newPassword: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.changePassword

  Parameters

  • oldPassword: string

  • newPassword: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publiccreateUser

• createUser(user: CreateUser, customHeaders?: object): Promise<CreateUserResult>

• Implementation of TransportInterface.createUser

  Parameters

  • user: CreateUser

  • optionalcustomHeaders: object

  Returns Promise<CreateUserResult>

publicfetch

• fetch(route: string, args: object, customHeaders?: object): Promise<any>

• Parameters

  • route: string

  • args: object

  • customHeaders: object = {}

  Returns Promise<any>

publicgetTwoFactorSecret

• getTwoFactorSecret(customHeaders?: object): Promise<any>

• Parameters

  • optionalcustomHeaders: object

  Returns Promise<any>

publicgetUser

• getUser(customHeaders?: object): Promise<User>

• Implementation of TransportInterface.getUser

  Parameters

  • optionalcustomHeaders: object

  Returns Promise<User>

publicimpersonate

• impersonate(accessToken: string, impersonated: ImpersonationUserIdentity, customHeaders?: object): Promise<ImpersonationResult>

• Implementation of TransportInterface.impersonate

  Parameters

  • accessToken: string

  • impersonated: ImpersonationUserIdentity

  • optionalcustomHeaders: object

  Returns Promise<ImpersonationResult>

publicloginWithService

• loginWithService(provider: string, data: any, customHeaders?: object): Promise<LoginResult>

• Implementation of TransportInterface.loginWithService

  Parameters

  • provider: string

  • data: any

  • optionalcustomHeaders: object

  Returns Promise<LoginResult>

publiclogout

• logout(customHeaders?: object): Promise<void>

• Implementation of TransportInterface.logout

  Parameters

  • optionalcustomHeaders: object

  Returns Promise<void>

publicrefreshTokens

• refreshTokens(accessToken: string, refreshToken: string, customHeaders?: object): Promise<LoginResult>

• Implementation of TransportInterface.refreshTokens

  Parameters

  • accessToken: string

  • refreshToken: string

  • optionalcustomHeaders: object

  Returns Promise<LoginResult>

publicrequestMagicLinkEmail

• requestMagicLinkEmail(email: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.requestMagicLinkEmail

  Parameters

  • email: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publicresetPassword

• resetPassword(token: string, newPassword: string, customHeaders?: object): Promise<null | LoginResult>

• Implementation of TransportInterface.resetPassword

  Parameters

  • token: string

  • newPassword: string

  • optionalcustomHeaders: object

  Returns Promise<null | LoginResult>

publicsendResetPasswordEmail

• sendResetPasswordEmail(email: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.sendResetPasswordEmail

  Parameters

  • email: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publicsendVerificationEmail

• sendVerificationEmail(email: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.sendVerificationEmail

  Parameters

  • email: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publictwoFactorSet

• twoFactorSet(secret: any, code: string, customHeaders?: object): Promise<void>

• Parameters

  • secret: any

  • code: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publictwoFactorUnset

• twoFactorUnset(code: string, customHeaders?: object): Promise<void>

• Parameters

  • code: string

  • optionalcustomHeaders: object

  Returns Promise<void>

publicverifyEmail

• verifyEmail(token: string, customHeaders?: object): Promise<void>

• Implementation of TransportInterface.verifyEmail

  Parameters

  • token: string

  • optionalcustomHeaders: object

  Returns Promise<void>