Module: RegApi2::Common

Extended by:
Common
Includes:
Builder
Included in:
Common
Defined in:
lib/reg_api2/common.rb

Overview

REG.API common category

Instance Method Summary collapse

Methods included from Builder

included

Instance Method Details

#get_service_id(opts = {}) ⇒ String

Gets service/domain identifier

Parameters:

  • opts (Hash) (defaults to: {}) —

    The options.

Options Hash (opts):

  • :service_id (FixNum) —

    Service identifier.

Returns:

  • (String) —

    service_id



39
 
# File 'lib/reg_api2/common.rb', line 39

define :get_service_id, field: :service_id

#get_user_id ⇒ String

For testing purposes (returns the identifier of the user logged into the system).

Parameters:

  • None

Returns:

  • (String) —

    user_id



32
 
# File 'lib/reg_api2/common.rb', line 32

define :get_user_id, field: :user_id

#nop ⇒ Hash("login", "user_id")

For testing purposes (do nothing + get the login and identifier of the user logged into the system).

Parameters:

  • None

Returns:

  • (Hash("login", "user_id")) 


16
 
# File 'lib/reg_api2/common.rb', line 16

define :nop

#reseller_nop ⇒ Hash("login", "user_id")

Note:

Accessibility: partners

Note:

Access mode: Secure HTTPS only

Note:

Support of service lists: no

Similar to the nop function, except for the following aspects.

Parameters:

  • None

Returns:

  • (Hash("login", "user_id")) 


25
 
# File 'lib/reg_api2/common.rb', line 25

define :reseller_nop