Class: Namecheap::Domains

Inherits:
Api
  • Object
show all
Defined in:
lib/namecheap/domains.rb

Constant Summary

Constants inherited from Api

Api::ENDPOINT, Api::ENVIRONMENT, Api::PRODUCTION, Api::SANDBOX

Instance Method Summary collapse

Methods inherited from Api

#delete, #get, #init_args, #post, #put, #request

Instance Method Details

#check(domains = [], options = {}) ⇒ Object

Checks the availability of domains.

See Also:



38
39
40
41
42
43
44
45
 
# File 'lib/namecheap/domains.rb', line 38

def check(domains = [], options = {})
  if domains.respond_to?(:join)
    domains = domains.join(',')
  end
  
  options = {:DomainList => domains}.merge(options)
  get 'domains.check', options
end

#create(domain, options = {}) ⇒ Object

Registers a domain.

See Also:



18
19
20
21
 
# File 'lib/namecheap/domains.rb', line 18

def create(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.create', options
end

#get_contacts(domain, options = {}) ⇒ Object

Gets contact information for the requested domain.

See Also:



11
12
13
14
 
# File 'lib/namecheap/domains.rb', line 11

def get_contacts(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.getContacts', options
end

#get_info(domain, options = {}) ⇒ Object

Returns information about the requested domain.

See Also:



77
78
79
80
 
# File 'lib/namecheap/domains.rb', line 77

def get_info(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.getInfo', options
end

#get_list(options = {}) ⇒ Object

Returns a list of domains for the particular user.

See Also:



5
6
7
 
# File 'lib/namecheap/domains.rb', line 5

def get_list(options = {})
  get 'domains.getList', options
end

#get_registrar_lock(domain, options = {}) ⇒ Object

Gets the status of RegistrarLock for the requested domain.

See Also:



63
64
65
66
 
# File 'lib/namecheap/domains.rb', line 63

def get_registrar_lock(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.getRegistrarLock', options
end

#get_tld_list(options = {}) ⇒ Object

Returns a list of tlds.

See Also:



25
26
27
 
# File 'lib/namecheap/domains.rb', line 25

def get_tld_list(options = {})
  get 'domains.getTldList', options
end

#reactivate(domain, options = {}) ⇒ Object

Reactivates an expired domain.

See Also:



49
50
51
52
 
# File 'lib/namecheap/domains.rb', line 49

def reactivate(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.reactivate', options
end

#renew(domain, options = {}) ⇒ Object

Renews an expiring domain. developer.namecheap.com/docs/doku.php?id=api-reference:domains:renew



56
57
58
59
 
# File 'lib/namecheap/domains.rb', line 56

def renew(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.renew', options
end

#set_contacts(domain, options = {}) ⇒ Object

Sets contact information for the requested domain.

See Also:



31
32
33
34
 
# File 'lib/namecheap/domains.rb', line 31

def set_contacts(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.setContacts', options
end

#set_registrar_lock(domain, options = {}) ⇒ Object

Sets the RegistrarLock status for a domain.

See Also:



70
71
72
73
 
# File 'lib/namecheap/domains.rb', line 70

def set_registrar_lock(domain, options = {})
  options = {:DomainName => domain}.merge(options)
  get 'domains.setRegistrarLock', options
end