Class: Users

Users()

Class to get list users Check user availability in the account Get, update, create, delete a user

Constructor

new Users()

Source:

functions/users.js, line 19

Methods

(async) checkUserEmail(email) → {Promise.<CheckEmail>}

Parameters:

Name	Type	Description
`email`	string

Source:

functions/users.js, line 112

Returns:

- returns an object with boolean or throws an error

Type: Promise.<CheckEmail>

(async) createUser(params) → {Promise.<User>}

Parameters:

Name	Type	Description
`params`	CreateUserParams

Source:

functions/users.js, line 49

Returns:

- returns a user or throws an error

Type: Promise.<User>

(async) deleteUser(params) → {Promise.<string>}

Parameters:

Name	Type	Description
`params`	DeleteUserParams

Source:

functions/users.js, line 145

Returns:

- returns an success message or throws an error

Type: Promise.<string>

(async) getListUsers(params) → {Promise.<GetUsersListResponse>}

Parameters:

Name	Type	Description
`params`	GetUsersListParams

Source:

functions/users.js, line 28

Returns:

- returns a list of users or throws an error

Type: Promise.<GetUsersListResponse>

(async) getUser(userId, loginType) → {Promise.<User>}

Parameters:

Name	Type	Description
`userId`	string
`loginType`	LoginTypes

Source:

functions/users.js, line 83

Returns:

- returs a user object or throws an error

Type: Promise.<User>