Skip to main content

TransportInterface

Index

Properties

client

Methods

addEmail

  • addEmail(newEmail: string): Promise<void>
  • Parameters

    • newEmail: string

    Returns Promise<void>

authenticateWithService

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

    • service: string
    • authenticateParams: {}

    Returns Promise<boolean>

changePassword

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

    • oldPassword: string
    • newPassword: string

    Returns Promise<void>

createUser

  • createUser(user: CreateUser): Promise<CreateUserResult>
  • Parameters

    • user: CreateUser

    Returns Promise<CreateUserResult>

getUser

  • getUser(): Promise<User>
  • Returns Promise<User>

impersonate

  • impersonate(token: string, impersonated: ImpersonationUserIdentity): Promise<ImpersonationResult>
  • Parameters

    • token: string
    • impersonated: ImpersonationUserIdentity

    Returns Promise<ImpersonationResult>

loginWithService

  • loginWithService(service: string, authenticateParams: {}): Promise<LoginResult>
  • Parameters

    • service: string
    • authenticateParams: {}

    Returns Promise<LoginResult>

logout

  • logout(): Promise<void>
  • Returns Promise<void>

refreshTokens

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

    • accessToken: string
    • refreshToken: string

    Returns Promise<LoginResult>

requestMagicLinkEmail

  • requestMagicLinkEmail(email: string): Promise<void>
  • Parameters

    • email: string

    Returns Promise<void>

resetPassword

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

    • token: string
    • newPassword: string

    Returns Promise<any>

sendResetPasswordEmail

  • sendResetPasswordEmail(email: string): Promise<void>
  • Parameters

    • email: string

    Returns Promise<void>

sendVerificationEmail

  • sendVerificationEmail(email: string): Promise<void>
  • Parameters

    • email: string

    Returns Promise<void>

verifyEmail

  • verifyEmail(token: string): Promise<void>
  • Parameters

    • token: string

    Returns Promise<void>