Constructor
new Gateway(gatewayID, config)
The constructor function is a special function that is called when an object is created from a class
| Name | Type | Description |
|---|---|---|
gatewayID | string | The ID of the gateway you want to get the list of users from. |
config | Config | This is the configuration object that is passed to the constructor of the base class. |
- Source
Extends
- SetConfig
Methods
createAPIKey(payload) → {Output-CreateAPIKey}
It creates an API key for the gateway.
| Name | Type | Description |
|---|---|---|
payload | Input-CreateAPIKeyForUser | Input-CreateAPIKeyForUser |
- Source
The response from the API.
- Type:
- Output-CreateAPIKey
deleteGateway() → {Output-EmptyPayload}
It deletes the gateway.
- Source
The response from the API.
- Type:
- Output-EmptyPayload
getAPIKeyInfo(payload) → {Output-GetAPIKeyInfo}
It returns the API key information for the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetAPIKeyInfo | Input-GetAPIKeyInfo |
- Source
The response from the API.
- Type:
- Output-GetAPIKeyInfo
getAPIKeyList(payloadopt) → {Output-GetAPIKeyList}
It returns the list of API keys for the gateway.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetAPIKeyList | <optional> | Input-GetAPIKeyList |
- Source
The response from the API.
- Type:
- Output-GetAPIKeyList
getCollaboratorInfoOfOrg(payload) → {Output-GetCollaboratorInfoOfOrg}
It returns rights of the collaborator (member) of the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetCollaboratorInfoOfOrg | Input-GetCollaboratorInfoOfOrg |
- Source
The response from the API.
getCollaboratorInfoOfUser(payload) → {Output-GetCollaboratorInfoOfUser}
It returns rights of the collaborator (member) of the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetCollaboratorInfoOfUser | Input-GetCollaboratorInfoOfUser |
- Source
The response from the API.
getCollaboratorList(payloadopt) → {Output-GetCollabortorList}
It returns the list of collaborators (members) of the application.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetCollabortorList | <optional> | Input-GetCollabortorList |
- Source
The response from the API.
getGatewayInfo() → {Output-GetGatewayInfo}
It returns the gateway information.
- Source
The response from the API. ----> CreateGateway
- Type:
- Output-GetGatewayInfo
getGatewayList(payloadopt) → {Output-GetGatewayList}
It returns the list of gateways.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetGatewayList | <optional> | Input-GetGatewayList |
- Source
The response from the API. ----> GetGatewayList
- Type:
- Output-GetGatewayList
getGatewayRight() → {Output-GetGatewayRight}
It returns the gateway rights.
- Source
The response from the API.
- Type:
- Output-GetGatewayRight
purgeGateway() → {Output-EmptyPayload}
It purges the gateway.
- Source
The response from the API.
- Type:
- Output-EmptyPayload
restoreGateway() → {Output-EmptyPayload}
It restores the gateway.
- Source
The response from the API.
- Type:
- Output-EmptyPayload
searchGateway() → {Output-SearchGateway}
It searches the gateway.
- Source
The response from the API.
- Type:
- Output-SearchGateway
setCollaboratorOfOrg(payload) → {Output-EmptyPayload}
It sets the rights of a collaborator (member) on the application.
| Name | Type | Description |
|---|---|---|
payload | Input-SetCollaboratorOfOrg | Input-SetCollaboratorOfOrg |
- Source
The response from the API.
- Type:
- Output-EmptyPayload
setCollaboratorOfUser(payload) → {Output-EmptyPayload}
It sets the rights of a collaborator (member) on the application.
| Name | Type | Description |
|---|---|---|
payload | Input-SetCollaboratorOfUser | Input-SetCollaboratorOfUser |
- Source
The response from the API.
- Type:
- Output-EmptyPayload
updateAPIKey(payload) → {Output-UpdateAPIKey}
It returns the information of the api key that has been created by the user.
| Name | Type | Description |
|---|---|---|
payload | Input-UpdateAPIKeyOfApplication | Input-UpdateAPIKeyOfApplication |
- Source
The response from the API.
- Type:
- Output-UpdateAPIKey
updateGateway(payload) → {Output-UpdateGateway}
It updates the gateway.
| Name | Type | Description |
|---|---|---|
payload | Input-UpdateGateway |
- Source
The response from the API. ----> UpdateGateway
- Type:
- Output-UpdateGateway