Class: WHMCS::Module

Inherits:
Base
  • Object
show all
Defined in:
lib/whmcs/module.rb

Overview

WHMCS::Module is the class for working with hosting account modules

Class Method Summary collapse

Methods inherited from Base

parse_response, send_request

Class Method Details

.module_change_package(params = {}) ⇒ Object

Module Change Package

This command is used to run the change package module command

Parameters:

*:serviceid - ID of the service in WHMCS to run the module command

See:

docs.whmcs.com/API:Module_Change_Package



75
76
77
78
 
# File 'lib/whmcs/module.rb', line 75

def self.module_change_package(params = {})
	params.merge!(:action => 'modulechangepackage')
	send_request(params)
end

.module_change_password(params = {}) ⇒ Object

Module Change Password

This command is used to issue the change password command to the module for a service.

Params:

  • :serviceid - the unique id of the service to perform the action on (aka tblhosting.id)

Optional attributes:

  • :servicepassword - Specify to update the password on the service before calling

See:

docs.whmcs.com/API:Module_Change_Password



94
95
96
97
 
# File 'lib/whmcs/module.rb', line 94

def self.module_change_password(params = {})
	params.merge!(:action => 'modulechangepw')
	send_request(params)
end

.module_create(params = {}) ⇒ Object

docs.whmcs.com/API:Module_Create



14
15
16
17
 
# File 'lib/whmcs/module.rb', line 14

def self.module_create(params = {})
  params.merge!(:action => 'modulecreate')
  send_request(params)
end

.module_suspend(params = {}) ⇒ Object

docs.whmcs.com/API:Module_Suspend



31
32
33
34
 
# File 'lib/whmcs/module.rb', line 31

def self.module_suspend(params = {})
  params.merge!(:action => 'modulesuspend')
  send_request(params)
end

.module_terminate(params = {}) ⇒ Object

docs.whmcs.com/API:Module_Terminate



59
60
61
62
 
# File 'lib/whmcs/module.rb', line 59

def self.module_terminate(params = {})
  params.merge!(:action => 'moduleterminate')
  send_request(params)
end

.module_unsuspend(params = {}) ⇒ Object

docs.whmcs.com/API:Module_Unsuspend



45
46
47
48
 
# File 'lib/whmcs/module.rb', line 45

def self.module_unsuspend(params = {})
  params.merge!(:action => 'moduleunsuspend')
  send_request(params)
end