Module: RegApi2::Service
Overview
REG.API service category
Instance Method Summary collapse
-
#create(opts = {}) ⇒ Hash(descr, service_id, ...)
Use the function to order new services.
-
#delete(opts = {}) ⇒ void
Removes the service.
-
#get_bills(opts = {}) ⇒ Hash
Use this function to get a list of invoices associated with the defined services.
-
#get_dedicated_server_list(opts = {}) ⇒ Array<Hash>
Get the dedicated server list.
-
#get_depreciated_period(opts = {}) ⇒ Object
Use this function to calculate the number of periods till the service expiration date.
-
#get_details(opts = {}) ⇒ Object
Use this function to get detailed information about the service, including contact data for domains.
-
#get_folders(opts = {}) ⇒ Object
Use this function to get the list of folders the service is associated with.
-
#get_info(opts = {}) ⇒ Object
Use this function to obtain information about all services.
-
#get_list(opts = {}) ⇒ Array<Hash>
Use this function to obtain a list of active services.
-
#get_prices(opts = {}) ⇒ Hash(currency, price_group, show_renew_data, prices)
Get services registration/renewal prices.
-
#get_servtype_details(opts = {}) ⇒ Array(Hash(commonname, ...))
Use this function to get prices for services and general data.
-
#nop(opts = {}) ⇒ Array<Hash>
Return list of specified services with its stats if specified.
-
#partcontrol_grant(opts = {}) ⇒ Object
You can use this function to grant a part of service management rights to other users.
-
#partcontrol_revoke(opts = {}) ⇒ Object
Use this function to stop granting service management rights to other.
-
#refill(opts = {}) ⇒ Hash(service_id, bill_id etc.)
You can use this function to refill balance of you service.
-
#renew(opts = {}) ⇒ Object
Domain or service renewal.
-
#resend_mail(opts = {}) ⇒ Hash(service_id, dname)
Resend mail to user.
-
#resume(opts = {}) ⇒ void
Use this function to resume services (for domains – resume domain delegation).
-
#service_get_details(opts = {}) ⇒ Object
deprecated
Deprecated.
Use #get_info instead.
-
#set_autorenew_flag(opts = {}) ⇒ void
Enables or disables automatic service renewal.
-
#suspend(opts = {}) ⇒ void
Use this function to suspend services (for domains – suspend delegation).
-
#update(opts = {}) ⇒ Object
Service configuration.
-
#upgrade(opts = {}) ⇒ Object
This function upgrades service subtypes (rate plans).
Methods included from Builder
Instance Method Details
#create(opts = {}) ⇒ Hash(descr, service_id, ...)
Accessibility: everyone
Support of service lists: no
Use the function to order new services. TODO: specific options.
95 |
# File 'lib/reg_api2/service.rb', line 95 define :create, required: %w[ servtype ] |
#delete(opts = {}) ⇒ void
Accessibility: clients
Support of service lists: no
This method returns an undefined value.
Removes the service.
121 |
# File 'lib/reg_api2/service.rb', line 121 define :delete, required: %w[ servtype ] |
#get_bills(opts = {}) ⇒ Hash
Accessibility: partners
Support of service lists: yes
Use this function to get a list of invoices associated with the defined services.
223 |
# File 'lib/reg_api2/service.rb', line 223 define :get_bills |
#get_dedicated_server_list(opts = {}) ⇒ Array<Hash>
Accessibility: clients
Support of service lists: no
Get the dedicated server list.
197 |
# File 'lib/reg_api2/service.rb', line 197 define :get_dedicated_server_list, field: :server_list |
#get_depreciated_period(opts = {}) ⇒ Object
Accessibility: clients
Support of service lists: no
Use this function to calculate the number of periods till the service expiration date.
254 |
# File 'lib/reg_api2/service.rb', line 254 define :get_depreciated_period |
#get_details(opts = {}) ⇒ Object
Use this function to get detailed information about the service, including contact data for domains.
165 |
# File 'lib/reg_api2/service.rb', line 165 define :get_details |
#get_folders(opts = {}) ⇒ Object
Use this function to get the list of folders the service is associated with.
160 |
# File 'lib/reg_api2/service.rb', line 160 define :get_folders |
#get_info(opts = {}) ⇒ Object
Accessibility: clients
Support of service lists: yes
Use this function to obtain information about all services.
128 |
# File 'lib/reg_api2/service.rb', line 128 define :get_info |
#get_list(opts = {}) ⇒ Array<Hash>
Accessibility: clients
Use this function to obtain a list of active services.
155 |
# File 'lib/reg_api2/service.rb', line 155 define :get_list, field: :services |
#get_prices(opts = {}) ⇒ Hash(currency, price_group, show_renew_data, prices)
Accessibility: everyone
Support of service lists: no
Get services registration/renewal prices.
37 |
# File 'lib/reg_api2/service.rb', line 37 define :get_prices |
#get_servtype_details(opts = {}) ⇒ Array(Hash(commonname, ...))
To obtain prices for several service types, you can define them in the servtype field delimiting them with commas or include several servtype fields into the request. In this case the field subtype is ignored.
Accessibility: everyone
Use this function to get prices for services and general data.
50 |
# File 'lib/reg_api2/service.rb', line 50 define :get_servtype_details |
#nop(opts = {}) ⇒ Array<Hash>
Accessibility: clients
Support of service lists: yes
Return list of specified services with its stats if specified.
25 |
# File 'lib/reg_api2/service.rb', line 25 define :nop, field: :services |
#partcontrol_grant(opts = {}) ⇒ Object
Accessibility: clients
Support of service lists: no
You can use this function to grant a part of service management rights to other users.
268 |
# File 'lib/reg_api2/service.rb', line 268 define :partcontrol_grant |
#partcontrol_revoke(opts = {}) ⇒ Object
Accessibility: clients
Support of service lists: no
Use this function to stop granting service management rights to other.
275 |
# File 'lib/reg_api2/service.rb', line 275 define :partcontrol_revoke |
#refill(opts = {}) ⇒ Hash(service_id, bill_id etc.)
Accessibility: clients
Support of service lists: no
You can use this function to refill balance of you service. Only Jelastic (srv_jelastic) is supported at the moment.
300 |
# File 'lib/reg_api2/service.rb', line 300 define :refill |
#renew(opts = {}) ⇒ Object
Domain or service renewal.
207 |
# File 'lib/reg_api2/service.rb', line 207 define :renew |
#resend_mail(opts = {}) ⇒ Hash(service_id, dname)
Accessibility: clients
Support of service lists: no
Resend mail to user.
286 |
# File 'lib/reg_api2/service.rb', line 286 define :resend_mail |
#resume(opts = {}) ⇒ void
Accessibility: clients
Support of service lists: no
This method returns an undefined value.
Use this function to resume services (for domains – resume domain delegation).
247 |
# File 'lib/reg_api2/service.rb', line 247 define :resume |
#service_get_details(opts = {}) ⇒ Object
Use #get_info instead.
You can use this function to obtain general information about the ordered service, as well as additional data about the hosting and web forwarding services. It is an obsolete function. For the major part of service it is advisable to use the #get_info function instead.
171 |
# File 'lib/reg_api2/service.rb', line 171 define :service_get_details |
#set_autorenew_flag(opts = {}) ⇒ void
Accessibility: clients
Support of service lists: no
This method returns an undefined value.
Enables or disables automatic service renewal.
231 |
# File 'lib/reg_api2/service.rb', line 231 define :set_autorenew_flag |
#suspend(opts = {}) ⇒ void
Accessibility: clients
Support of service lists: no
This method returns an undefined value.
Use this function to suspend services (for domains – suspend delegation).
239 |
# File 'lib/reg_api2/service.rb', line 239 define :suspend |
#update(opts = {}) ⇒ Object
Service configuration.
202 |
# File 'lib/reg_api2/service.rb', line 202 define :update |
#upgrade(opts = {}) ⇒ Object
Accessibility: clients
Support of service lists: no
This function upgrades service subtypes (rate plans). It can be used for changes of rate plans for virtual hosting ("srv_hosting_ispmgr"), VPS servers("srv_vps") and Additional Disk Space for VPS ("srv_disk_space").
261 |
# File 'lib/reg_api2/service.rb', line 261 define :upgrade |