Constructor
new Modules(config)
Parameters:
| Name |
Type |
Description |
config |
Object
|
Object containing your API credentials.
Properties
| Name |
Type |
Attributes |
Description |
serverUrl |
string
|
|
URL to your installation. Remember to point to /includes/api.php |
username |
string
|
<optional>
|
|
password |
string
|
<optional>
|
|
identifier |
string
|
<optional>
|
|
secret |
string
|
<optional>
|
|
|
- Source:
Extends
Methods
activateModule(opts)
Activates a given module. - https://developers.whmcs.com/api-reference/activatemodule/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
moduleType |
String
|
|
The module type to be activated |
moduleName |
String
|
|
The module name to be activated |
parameters |
Array
|
<optional>
|
An array of configuration parameters to set for the given module. Use GetModuleConfigurationParameters to obtain a list of fields for a given module. |
|
- Source:
deactivateModule(opts)
Deactivates a given module. - https://developers.whmcs.com/api-reference/deactivatemodule/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
moduleType |
String
|
The module type to be deactivated |
moduleName |
String
|
The module name to be deactivated |
|
- Source:
getModuleConfigurationParameters(opts)
Obtains the Module Configuration Parameters - https://developers.whmcs.com/api-reference/getmoduleconfigurationparameters/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Description |
moduleType |
String
|
The module type to be activated |
moduleName |
String
|
The module name to be activated |
|
- Source:
getModuleQueue(opts)
Obtains the Module Queue for Incomplete Failed Actions - https://developers.whmcs.com/api-reference/getmodulequeue/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
serviceType |
String
|
<optional>
|
The type of service to load (‘domain’, ‘service’ or “)) |
moduleName |
String
|
<optional>
|
The module name to obtain the queue for in system format. eg cpanel |
moduleAction |
String
|
<optional>
|
The module action to obtain the queue for. eg CreateAccount, SuspendAccount |
since |
String
|
<optional>
|
The date/time since to obtain the items. Format Y-m-d Can include H:i:s |
|
- Source:
updateModuleConfiguration(opts)
Activates a given module. - https://developers.whmcs.com/api-reference/updatemoduleconfiguration/
Parameters:
| Name |
Type |
Description |
opts |
Object
|
Properties
| Name |
Type |
Attributes |
Description |
moduleType |
String
|
|
The module type to be activated |
moduleName |
String
|
|
The module name to be activated |
parameters |
Array
|
<optional>
|
An array of configuration parameters to set for the given module. Use GetModuleConfigurationParameters to obtain a list of fields for a given module. |
|
- Source: