Class Account

Hierarchy

TagoIOModule<GenericModuleParams>
- Account

Index

Constructors

Methods

confirmOTP delete disableOTP edit enableOTP info passwordChange acceptTeamInvitation confirmAccount create declineTeamInvitation login passwordRecover requestLoginPINCode resendConfirmation tokenCreate

Constructors

constructor

new Account(params): Account
Parameters
- params: GenericModuleParams
Returns Account
Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in common/TagoIOModule.ts:79

Methods

confirmOTP

confirmOTP(pinCode, typeOTP): Promise<string>
Confirm OTP enabling process for a given OTP Type
Parameters
- pinCode: string
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/Resources/Account.ts:225

delete

delete(): Promise<string>
Delete account

Returns Promise<string>
- Defined in modules/Resources/Account.ts:41

disableOTP

disableOTP(credentials, typeOTP): Promise<string>
Enable OTP for a given OTP Type
Parameters
- credentials: {
  email: string;
  password: string;
  }
  
  Credentials
  - email: string
  - password: string
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/Resources/Account.ts:210

edit

edit(accountObj): Promise<string>
Edit account
Parameters
- accountObj: Partial<AccountInfo>
  
  Account data to edit
Returns Promise<string>
- Defined in modules/Resources/Account.ts:28

enableOTP

enableOTP(credentials, typeOTP): Promise<string>
Enable OTP for a given OTP Type. You will be requested to confirm the operation with a pin code.
Parameters
- credentials: {
  email: string;
  password: string;
  }
  
  Credentials
  - email: string
  - password: string
- typeOTP: OTPType
  
  authenticator, sms or email
Returns Promise<string>
- Defined in modules/Resources/Account.ts:195

info

info(): Promise<AccountInfo>
Gets all account information

Returns Promise<AccountInfo>
- Defined in modules/Resources/Account.ts:11

passwordChange

passwordChange(password): Promise<string>
Change account password
Parameters
- password: string
  
  New Password
Returns Promise<string>
- Defined in modules/Resources/Account.ts:107

`Static` acceptTeamInvitation

acceptTeamInvitation(token): Promise<string>
Accept a team member invitation to become a profile's team member.
Parameters
- token: string
Returns Promise<string>
Success message.
- Defined in modules/Resources/Account.ts:242

`Static` confirmAccount

confirmAccount(token, region?): Promise<string>
Confirm account creation
Parameters
- token: string
  
  Confirmation token
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/Resources/Account.ts:157

`Static` create

create(createParams, region?): Promise<string>
Create new TagoIO account
Parameters
- createParams: AccountCreateInfo
  
  New account details
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/Resources/Account.ts:124

`Static` declineTeamInvitation

declineTeamInvitation(token): Promise<string>
Decline a team member invitation to become a profile's team member.
Parameters
- token: string
Returns Promise<string>
Success message.
- Defined in modules/Resources/Account.ts:256

`Static` login

login(credentials, region?): Promise<LoginResponse>
Retrieve list of profiles for login and do Login
Parameters
- credentials: {
  email: string;
  password: string;
  }
  
  Credentials
  - email: string
  - password: string
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<LoginResponse>
- Defined in modules/Resources/Account.ts:72

`Static` passwordRecover

passwordRecover(email, region?): Promise<string>
Send password recover email
Parameters
- email: string
  
  E-mail to recovery
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/Resources/Account.ts:92

`Static` requestLoginPINCode

requestLoginPINCode(credentials, typeOTP, region?): Promise<string>
Request the PIN Code for a given OTP Type.
Parameters
- credentials: {
  email: string;
  password: string;
  }
  
  Credentials
  - email: string
  - password: string
- typeOTP: OTPType
  
  authenticator, sms or email
- Optional region: Regions
Returns Promise<string>
- Defined in modules/Resources/Account.ts:173

`Static` resendConfirmation

resendConfirmation(email, region?): Promise<string>
Re-send confirmation account email
Parameters
- email: string
  
  E-mail address
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<string>
- Defined in modules/Resources/Account.ts:141

`Static` tokenCreate

tokenCreate(tokenParams, region?): Promise<{
token: string;
}>
Generates and retrieves a new token for the account
Parameters
- tokenParams: TokenCreateInfo
  
  Token data
- Optional region: Regions
  
  TagoIO Region Server [default usa-1]
Returns Promise<{
token: string;
}>
- Defined in modules/Resources/Account.ts:55