Class RunUser

SDB

confirmOTP

• confirmOTP(tagoIORunURL, pinCode, typeOTP): Promise<string>

• Confirm OTP enabling process for a given OTP Type

  Parameters

  • tagoIORunURL: string
  • pinCode: string
  • typeOTP: OTPType

    authenticator, sms or email

  Returns Promise<string>

delete

• delete(tagoIORunURL): Promise<string>

• Delete Run user info

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http

  Returns Promise<string>

disableOTP

• disableOTP(tagoIORunURL, credentials, typeOTP): Promise<string>

• Enable OTP for a given OTP Type

  Parameters

  • tagoIORunURL: string
  • credentials: RunUserCredentials

    Credentials
  • typeOTP: OTPType

    authenticator, sms or email

  Returns Promise<string>

edit

• edit(tagoIORunURL, userChangesObj): Promise<string>

• Edit Run user info

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • userChangesObj: Partial<RunUserInfo>

    Data to change in user

  Returns Promise<string>

enableOTP

• enableOTP(tagoIORunURL, credentials, typeOTP): Promise<string>

• Enable OTP for a given OTP Type. You will be requested to confirm the operation with a pin code.

  Parameters

  • tagoIORunURL: string
  • credentials: RunUserCredentials

    Credentials
  • typeOTP: OTPType

    authenticator, sms or email

  Returns Promise<string>

info

• info(tagoIORunURL): Promise<RunUserInfo>

• Get Run user info

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http

  Returns Promise<RunUserInfo>

notificationButton

• notificationButton(tagoIORunURL, notificationID, buttonID): Promise<any>

• Trigger notification button

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • notificationID: string

    TagoIO Run notification id
  • buttonID: string

    Notification button id

  Returns Promise<any>

notificationDelete

• notificationDelete(tagoIORunURL, notificationID): Promise<string>

• Delete notification

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • notificationID: string

    TagoIO Run notification id

  Returns Promise<string>

notificationList

• notificationList(tagoIORunURL, queryObj?): Promise<NotificationInfo[]>

• List notifications.

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • Optional queryObj: NotificationQuery

  Returns Promise<NotificationInfo[]>

notificationMarkAllRead

• notificationMarkAllRead(tagoIORunURL): Promise<string>

• Mark all notifications as read

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http

  Returns Promise<string>

notificationMarkRead

• notificationMarkRead(tagoIORunURL, notificationIDs): Promise<string>

• Mark notification as read

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • notificationIDs: string | string[]

    array of notification ids or a single id

  Returns Promise<string>

notificationMarkUnread

• notificationMarkUnread(tagoIORunURL, notificationIDs): Promise<string>

• Mark notification as unread

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • notificationIDs: string | string[]

    array of notification ids or a single id

  Returns Promise<string>

passwordChange

• passwordChange(tagoIORunURL, password): Promise<string>

• Change password using token of the password recover.

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • password: string

    New password

  Returns Promise<string>

Static confirmUser

• confirmUser(tagoIORunURL, token, region?): Promise<string>

• Confirm User on TagoIO Run (Anonymous)

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • token: string

    TagoIO Run user token
  • Optional region: RegionsObj | Regions

    TagoIO Region Server [default usa-1]

  Returns Promise<string>

Static create

• create(tagoIORunURL, newUserObj, region?): Promise<RunUserCreate>

• Create new TagoIO Run User (Anonymous)

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • newUserObj: RunUserCreateInfo

    New user data
  • Optional region: RegionsObj | Regions

    TagoIO Region Server [default usa-1]

  Returns Promise<RunUserCreate>

Static login

• login(tagoIORunURL, credentialsObj, region?): Promise<RunUserLoginResponse>

• Login at TagoIO Run as user (Anonymous)

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • credentialsObj: RunUserLogin

    Run user credentials
  • Optional region: RegionsObj | Regions

    TagoIO Region Server [default usa-1]

  Returns Promise<RunUserLoginResponse>

Static passwordRecover

• passwordRecover(tagoIORunURL, email, region?): Promise<string>

• Sends a password recover e-mail

  Parameters

  • tagoIORunURL: string

    TagoIO Run url without http
  • email: string

    Run user email to recover the password
  • Optional region: RegionsObj | Regions

    TagoIO Region Server [default usa-1]

  Returns Promise<string>

Static requestLoginPINCode

• requestLoginPINCode(tagoIORunURL, credentials, typeOTP, region?): Promise<string>

• Request the PIN Code for a given OTP Type.

  Parameters

  • tagoIORunURL: string
  • credentials: RunUserCredentials

    Credentials
  • typeOTP: OTPType

    authenticator, sms or email
  • Optional region: RegionsObj | Regions

  Returns Promise<string>