Module: RegApi2::Domain

Extended by:
Domain
Includes:
Builder
Included in:
Domain
Defined in:
lib/reg_api2/domain.rb

Overview

REG.API domain category

Instance Method Summary collapse

Methods included from Builder

included

Instance Method Details

#accept_or_refuse_entering_list(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Accept or decline domains transferred to this account.

Parameters:

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

    Options.



191
 
# File 'lib/reg_api2/domain.rb', line 191

define :accept_or_refuse_entering_list, field: :domains

#cancel_transfer(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Use this function for cancelling domain transfers

Parameters:

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

    Options.



198
 
# File 'lib/reg_api2/domain.rb', line 198

define :cancel_transfer

#check(opts = {}) ⇒ Object

Note:

Accessibility: partners

Note:

Support of service lists: yes

This function serves to check availability of domains for registration.

Parameters:

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

    Options.



72
 
# File 'lib/reg_api2/domain.rb', line 72

define :check, field: :domains

#create(opts = {}) ⇒ Object

Note:

Accessibility: clients

Note:

Support of service lists: For privileged clients only

Apply for domain name registration.

Parameters:

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

    Options.



79
 
# File 'lib/reg_api2/domain.rb', line 79

define :create

#delegate(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Use this this function to set the domain delegation flag.

Parameters:

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

    Options.



163
 
# File 'lib/reg_api2/domain.rb', line 163

define :delegate

#delete_ns(opts = {}) ⇒ Object

Note:

Accessibility: everyone.

Note:

Support of service lists: no

Deletion of a domain from the NSI registry (for international domains only).

Parameters:

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

    Options.



142
 
# File 'lib/reg_api2/domain.rb', line 142

define :delete_ns

#get_deleted(opts = {}) ⇒ Object

Note:

Accessibility: partners

Note:

Support of service lists: no

Get a list of deleted domains. The function is similar to the Deleted Domains page. Maximum returned elements in list equals to 50000.

Examples:

Typical usage

RegApi2.domain.get_deleted(
    tlds:         'ru',
    deleted_from: '2013-10-01',
    deleted_to:   '2013-11-01',
    min_pr:       2,
    min_cy:       1
)

Parameters:

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

    Options.



65
 
# File 'lib/reg_api2/domain.rb', line 65

define :get_deleted, field: :domains

#get_docs_upload_uri(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: no

Use this function to get a hyperlink for uploading documents on .RU/.SU/.РФ domains.

Parameters:

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

    Options.



114
 
# File 'lib/reg_api2/domain.rb', line 114

define :get_docs_upload_uri

#get_nss(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: yes

You can use this function to get DNSs for domains.

Parameters:

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

    Options.



149
 
# File 'lib/reg_api2/domain.rb', line 149

define :get_nss

#get_premium(opts = {}) ⇒ Object

Note:

Accessibility: partners

Note:

Support of service lists: no

Gets the list of available premium domain registration, the function works like the Reg.Premium service

Parameters:

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

    Options.



49
 
# File 'lib/reg_api2/domain.rb', line 49

define :get_premium, field: :domains

#get_prices(opts = {}) ⇒ Hash(currency, price_group, prices)

Note:

Accessibility: everyone

Note:

Support of service lists: no

Get domain registration/renewal prices in all zones available.

Parameters:

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

    Options.

Options Hash (opts):

  • :show_renew_data (Fixnum) —

    With this flag enabled the System will return the price of registration renewal (1/0). Optional field.

  • :show_update_data (Fixnum) —

    Флаг возврата цен для обновления домена (1/0). Необязательное поле.

  • :currency (String) —

    Identifier of the currency in which the prices will be quoted: RUR (default), UAH, USD, EUR. Optional field.

Returns:

  • (Hash(currency, price_group, prices)) —

    Prices sorted by domain zones. The prices are quoted for the period of 1 year. For some of the zones the minimum registration period exceeds 1 year. If a zone allows Cyrillic domains and the price for them differ from the price for domains in Latin characters, for such a zone the system will return an additional record with the prefix '__idn.'.



26
 
# File 'lib/reg_api2/domain.rb', line 26

define :get_prices

#get_rereg_data(opts = {}) ⇒ Object

Note:

Accessibility: clients

Note:

Support of service lists: no

Use this function to get a list of “to be released” domains and their details. The data is updated every 90 minutes.

Parameters:

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

    Options.



93
 
# File 'lib/reg_api2/domain.rb', line 93

define :get_rereg_data

#get_suggest(opts = {}) ⇒ Array<Hash(name, avail_in)>

Note:

Accessibility: partners

Note:

Support of service lists: no

Suggest a domain name using keywords. The function is similar to the Reg.Choice service.

Examples:

Suggest for house and new

RegApi2.domain.get_suggest word: 'house', additional_word: 'new', use_hyphen: false, tlds: [ :ru ]

Parameters:

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

    Options.

Options Hash (opts):

  • :word (String) —

    Main keyword. For example, «domain». Mandatory field.

  • :additional_word (String) —

    Additional keyword. For example, «new» or «best». Optional field.

  • :category (String/Symbol) —

    The category of picked up names. Valid values: pattern — names matching defined patterns («name + prefix»), search_trends – current search trends, all (default) – all categories.

  • :tlds (String/Array<String>) —

    The zone in which the domain name should be checked for availability. Valid zones: ru, рф, su, com, net, org, biz, info. If a request does not contain a single tlds field, the domains will be searched in all the above-mentioned zones.

  • :use_hyphen (Boolean) —

    Use hyphens to delimit words in domain names (for example, “best- domain”). Valid values: false (do not use hyphens) and true (use hyphens). By default hyphens are not used (“bestdomain”).

  • :use_plural (Boolean) —

    Suggest plural forms for domain names. Valid values: false (do not suggest plural forms) and true (suggest plural forms). Optional field.

Returns:

  • (Array<Hash(name, avail_in)>) —

    An array with domain name alternatives. Each element includes the field name (name alternative) and the array avail_in with a list of zones in which this name is available for registration. Maximum array size: 100.



42
 
# File 'lib/reg_api2/domain.rb', line 42

define :get_suggest, required: %w[ word ], field: :suggestions

#get_user_rereg_bids(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: yes

Use this function to get the list with information about bids placed on them. The list also includes domains with overbids.

Parameters:

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

    Options.



107
 
# File 'lib/reg_api2/domain.rb', line 107

define :get_user_rereg_bids

#look_at_entering_list(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Use this function to view the list of domains transferred to this account.

Parameters:

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

    Options.



184
 
# File 'lib/reg_api2/domain.rb', line 184

define :look_at_entering_list, field: :messages

#nop(opts = {}) ⇒ NilClass or String

For testing purposes. Also, with the help of this function you can check accessibility of a domain and get its ID. For this, pass username+password+dname.

Parameters:

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

    Options.

Options Hash (opts):

  • :dname (String) —

    Domain name to check.

Returns:

  • (NilClass or String) —

    nil or Domain identifier, available only when the domain name is passed in the field domain_name/dname.



15
 
# File 'lib/reg_api2/domain.rb', line 15

define :nop

#register_ns(opts = {}) ⇒ Object

Note:

Accessibility: everyone.

Note:

Support of service lists: no

Domain registration in the NSI registry (for internatonal domains only).

Parameters:

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

    Options.



135
 
# File 'lib/reg_api2/domain.rb', line 135

define :register_ns

#request_to_transfer(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: no

Send request to domain transfer.

Parameters:

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

    Options.



205
 
# File 'lib/reg_api2/domain.rb', line 205

define :request_to_transfer, field: :domains

#set_rereg_bids(opts = {}) ⇒ Object

Note:

Accessibility: clients. Partners can make an advance payment in the amount of 225 rub. and to pay the balance upon the successful fulfillment of the application for registration within 10 days of its execution (see the instalment parameter below). In case of choosing this payment procedure the domain will be registered, and after payment of the full amount it will be re-registered automatically on the specified data. In case of payment violation of the full amount by the due date, the pre-payment will be considered as firfeit and will not be refunded. See more information: Clauses 2.16, 2.17, 3.2.9, 6.11 of the agreement.

Note:

Support of service lists: yes

Use this function to place bids for “to be released” domains. Click here for details.

Parameters:

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

    Options.



100
 
# File 'lib/reg_api2/domain.rb', line 100

define :set_rereg_bids

#transfer(opts = {}) ⇒ Object

Note:

Accessibility: clients

Note:

Support of service lists: For privileged clients only

With the help of this function you can apply for a transfer of a domain from another registrar.

Parameters:

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

    Options.



86
 
# File 'lib/reg_api2/domain.rb', line 86

define :transfer

#transfer_to_another_account(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Full transfer of a domain to another account.

Parameters:

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

    Options.



177
 
# File 'lib/reg_api2/domain.rb', line 177

define :transfer_to_another_account, field: :domains

#undelegate(opts = {}) ⇒ Object

Note:

Accessibility: partners.

Note:

Support of service lists: yes

Use this flag to clear the domain delegation flag.

Parameters:

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

    Options.



170
 
# File 'lib/reg_api2/domain.rb', line 170

define :undelegate

#update_contacts(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: yes

With the help of this function you can make changes in the domain contact data.

Parameters:

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

    Options.



121
 
# File 'lib/reg_api2/domain.rb', line 121

define :update_contacts

#update_nss(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: yes

Use this function to change DNS servers of the domain. Also this function enables/disables domain delegation (for partners only).

Parameters:

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

    Options.



156
 
# File 'lib/reg_api2/domain.rb', line 156

define :update_nss, field: :domains

#update_private_person_flag(opts = {}) ⇒ Object

Note:

Accessibility: clients.

Note:

Support of service lists: yes

Use this function to change settings of the Private Person and Total Private Person flags (show/hide contact data in WHOIS).

Parameters:

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

    Options.



128
 
# File 'lib/reg_api2/domain.rb', line 128

define :update_private_person_flag