Class: User

Constructor

new User(userID, config)

The constructor function is a special function that is called when an object is created from a class

Parameters:

Name	Type	Description
`userID`	string	The user ID of the user you want to get the profile of.
`config`	Config	Config - This is the configuration object that is passed to the constructor of the base class.

Source: modules/user/index.js, line 11

Extends

SetConfig

Methods

createAPIKey(payload) → {Output-CreateAPIKey}

It creates an api key for the user.

Parameters:

Name	Type	Description
`payload`	Input-CreateAPIKeyForUser	Input-CreateAPIKeyForUser

Source: modules/user/index.js, line 70

Returns:

The response from the API.

Type:: Output-CreateAPIKey

createApplication(payload) → {Output-CreateApplication}

It creates an application for the user.

Parameters:

Name	Type	Description
`payload`	Input-CreateApplication	Input-CreateApplication

Source: modules/user/index.js, line 29

Returns:

The response from the API.

Type:: Output-CreateApplication

createGateway(payload) → {Output-CreateGateway}

It creates a gateway for the user.

Parameters:

Name	Type	Description
`payload`	Input-CreateGateway	CreateGateway

Source: modules/user/index.js, line 155

Returns:

The response from the API. ----> CreateGateway

Type:: Output-CreateGateway

getAPIKeyInfo(payload) → {Output-GetAPIKeyInfo}

It returns the information of the api key that has been created by the user.

Parameters:

Name	Type	Description
`payload`	Input-GetAPIKeyInfo	Input-GetAPIKeyInfo

Source: modules/user/index.js, line 109

Returns:

The response from the API.

Type:: Output-GetAPIKeyInfo

getAPIKeyList(payloadopt) → {Output-GetAPIKeyList}

It returns the list of api keys that have been created by the user.

Parameters:

Name	Type	Attributes	Description
`payload`	Input-GetAPIKeyList	<optional>	Input-GetAPIKeyList

Source: modules/user/index.js, line 89

Returns:

The response from the API.

Type:: Output-GetAPIKeyList

getApplicationList(payloadopt) → {Output-GetApplicationList}

It returns the list of applications that have been created by the user.

Parameters:

Name	Type	Attributes	Description
`payload`	Input-GetApplicationList	<optional>	Input-GetApplicationList

Source: modules/user/index.js, line 50

Returns:

The response from the API.

Type:: Output-GetApplicationList

getGatewayList(payloadopt) → {Output-GetGatewayList}

It returns the list of gateways that have been created by the user.

Parameters:

Name	Type	Attributes	Description
`payload`	Input-GetGatewayList	<optional>	Input-GetGatewayList

Source: modules/user/index.js, line 169

Returns:

The response from the API. ----> GetGatewayList

Type:: Output-GetGatewayList

updateAPIKey(payload) → {Output-UpdateAPIKey}

It returns the information of the api key that has been created by the user.

Parameters:

Name	Type	Description
`payload`	Input-UpdateAPIKeyOfUser	Input-UpdateAPIKeyOfUser

Source: modules/user/index.js, line 123

Returns:

The response from the API.

Type:: Output-UpdateAPIKey