29 | const WHMCS = require('../whmcs')
30 |
31 | /**
32 | * Allows you to manage your Services module in WHMCS.
33 | * @extends WHMCS
34 | */
35 | class Services extends WHMCS {
36 | /**
37 | * @param {Object} config Object containing your API credentials.
38 | * @param {string} config.serverUrl URL to your installation. Remember to point to /includes/api.php
39 | * @param {string} [config.username]
40 | * @param {string} [config.password]
41 | * @param {string} [config.identifier]
42 | * @param {string} [config.secret]
43 | */
44 | constructor (config) {
45 | super(config)
46 | }
47 | /**
48 | * Runs a change package action for a given service. - https://developers.whmcs.com/api-reference/modulechangepackage/
49 | * @param {Object} opts
50 | * @param {Number} opts.serviceid The service ID to run the action for
51 | */
52 | moduleChangePackage (opts) {
53 | const options = {
54 | action: 'ModuleChangePackage',
55 | ...opts
56 | }
57 | return this.callApi(options)
58 | }
59 | /**
60 | * Runs a change password action for a given service. - https://developers.whmcs.com/api-reference/modulechangepw/
61 | * @param {Object} opts
62 | * @param {Number} opts.serviceid The service ID to run the action for
63 | * @param {String} [opts.servicepassword] A new password to assign to the service
64 | */
65 | moduleChangePw (opts) {
66 | const options = {
67 | action: 'ModuleChangePw',
68 | ...opts
69 | }
70 | return this.callApi(options)
71 | }
72 | /**
73 | * Updates a Client Service - https://developers.whmcs.com/api-reference/updateclientproduct/
74 | * @param {Object} opts
75 | * @param {Number} opts.serviceid The id of the client service to update
76 | * @param {Number} [opts.pid] The package id to associate with the service
77 | * @param {Number} [opts.serverid] The server id to associate with the service
78 | * @param {String} [opts.nextduedate] The next due date of the service (Y-m-d)
79 | * @param {String} [opts.terminationDate] Update the termination date of the service (Y-m-d)
80 | * @param {String} [opts.completedDate] Update the completed date of the service (Y-m-d)
81 | * @param {String} [opts.domain] The domain name to be changed to
82 | * @param {Number} [opts.firstpaymentamount] The first payment amount on the service
83 | * @param {Number} [opts.recurringamount] The recurring amount for automatic renewal invoices
84 | * @param {String} [opts.paymentmethod] The payment method to associate in system format (eg paypal)
85 | * @param {String} [opts.billingcycle] The term in which the product is billed on (eg One-Time, Monthly, Quarterly, etc)
86 | * @param {String} [opts.subscriptionid] The subscription ID to associate with the service
87 | * @param {String} [opts.status] The status to change the service to
88 | * @param {String} [opts.notes] The admin notes for the service
89 | * @param {String} [opts.serviceusername] The service username
90 | * @param {String} [opts.servicepassword] The service password
91 | * @param {String} [opts.overideautosuspend] Should override auto suspend be provided (‘on’ or ‘off’)
92 | * @param {String} [opts.overidesuspenduntil] Update the Override Suspend date of the service (Y-m-d)
93 | * @param {String} [opts.ns1] (VPS/Dedicated servers only)
94 | * @param {String} [opts.ns2] (VPS/Dedicated servers only)
95 | * @param {String} [opts.dedicatedip]
96 | * @param {String} [opts.assignedips] (VPS/Dedicated servers only)
97 | * @param {Number} [opts.diskusage] The disk usage in bytes
98 | * @param {Number} [opts.disklimit] The disk limit in bytes
99 | * @param {Number} [opts.bwusage] The bandwidth usage in bytes
100 | * @param {Number} [opts.bwlimit] The bandwidth limit in bytes
101 | * @param {String} [opts.overidesuspenduntil]
102 | * @param {String} [opts.suspendreason]
103 | * @param {Number} [opts.promoid] The promotion Id to associate
104 | * @param {Array} [opts.unset] An array of items to unset. Can be one of: ‘domain’, ‘serviceusername’, ‘servicepassword’, ‘subscriptionid’, ‘ns1’, ‘ns2’, ‘dedicatedip’, ‘assignedips’, ‘notes’, ‘suspendreason’
105 | * @param {Boolean} [opts.autorecalc] Should the recurring amount of the service be automatically recalculated (this will ignore any passed $recurringamount)
106 | * @param {String} [opts.customfields] Base64 encoded serialized array of custom field values - base64_encode(serialize(array(“1”=>“Yahoo”)));
107 | * @param {String} [opts.configoptions] Base64 encoded serialized array of configurable option field values - base64_encode(serialize(array(configoptionid => dropdownoptionid, XXX => array(‘optionid’ => YYY, ‘qty’ => ZZZ)))) - XXX is the ID of the configurable option - YYY is the optionid found in tblhostingconfigoption.optionid - ZZZ is the quantity you want to use for that option
108 | */
109 | updateClientProduct (opts) {
110 | const options = {
111 | action: 'UpdateClientProduct',
112 | ...opts
113 | }
114 | return this.callApi(options)
115 | }
116 | /**
117 | * Runs a custom module action for a given service. - https://developers.whmcs.com/api-reference/modulecustom/
118 | * @param {Object} opts
119 | * @param {Number} opts.serviceid The service ID to run the action for
120 | * @param {String} opts.func_name The name of the custom function to run
121 | */
122 | moduleCustom (opts) {
123 | const options = {
124 | action: 'ModuleCustom',
125 | ...opts
126 | }
127 | return this.callApi(options)
128 | }
129 | /**
130 | * Runs the module suspend action for a given service. - https://developers.whmcs.com/api-reference/modulesuspend/
131 | * @param {Object} opts
132 | * @param {Number} opts.serviceid The service ID to run the action for
133 | * @param {String} [opts.suspendreason] A reason for the suspension
134 | */
135 | moduleSuspend (opts) {
136 | const options = {
137 | action: 'ModuleSuspend',
138 | ...opts
139 | }
140 | return this.callApi(options)
141 | }
142 | /**
143 | * Runs an unsuspend action for a given service. - https://developers.whmcs.com/api-reference/moduleunsuspend/
144 | * @param {Object} opts
145 | * @param {Number} opts.serviceid The service ID to run the action for
146 | */
147 | moduleUnsuspend (opts) {
148 | const options = {
149 | action: 'ModuleUnsuspend',
150 | ...opts
151 | }
152 | return this.callApi(options)
153 | }
154 | /**
155 | * Runs the module create action for a given service. - https://developers.whmcs.com/api-reference/modulecreate/
156 | * @param {Object} opts
157 | * @param {Number} opts.serviceid The service ID to run the action for
158 | */
159 | moduleCreate (opts) {
160 | const options = {
161 | action: 'ModuleCreate',
162 | ...opts
163 | }
164 | return this.callApi(options)
165 | }
166 | /**
167 | * Runs a terminate action for a given service. - https://developers.whmcs.com/api-reference/moduleterminate/
168 | * @param {Object} opts
169 | * @param {Number} opts.serviceid The service ID to run the action for
170 | */
171 | moduleTerminate (opts) {
172 | const options = {
173 | action: 'ModuleTerminate',
174 | ...opts
175 | }
176 | return this.callApi(options)
177 | }
178 | /**
179 | * Upgrade, or calculate an upgrade on, a product - https://developers.whmcs.com/api-reference/upgradeproduct/
180 | * @param {Object} opts
181 | * @param {Number} opts.serviceid The ID of the service to update
182 | * @param {Boolean} [opts.calconly] Only calculate the upgrade amount
183 | * @param {String} opts.paymentmethod The upgrade payment method in system format (e.g. paypal)
184 | * @param {String} opts.type The type of upgrade (‘product’, ‘configoptions’)
185 | * @param {Number} [opts.newproductid] The Id of the new product
186 | * @param {String} [opts.newproductbillingcycle] The new products billing cycle
187 | * @param {String} [opts.promocode] The promotion code to apply to the upgrade
188 | * @param {Array} [opts.configoptions] An array of config options to upgrade
189 | * @param {Number} [opts.configoptions[id]] The id of the config option
190 | * @param {Number} [opts.configoptions[optiontype]] The config option type
191 | * @param {Number} [opts.configoptions[selectedvalue]] The config option selected value
192 | * @param {Number} [opts.configoptions[selectedqty]] The config option quantity selected
193 | */
194 | upgradeProduct (opts) {
195 | const options = {
196 | action: 'UpgradeProduct',
197 | ...opts
198 | }
199 | return this.callApi(options)
200 | }
201 | }
202 |
203 | module.exports = Services
204 |
205 |
206 |