Module: Dnsimple::Client::RegistrarWhoisPrivacy

Included in:
RegistrarService
Defined in:
lib/dnsimple/client/registrar_whois_privacy.rb

Instance Method Summary collapse

Instance Method Details

#disable_whois_privacy(account_id, domain_name, options = {}) ⇒ Struct::WhoisPrivacy

Disables whois privacy for the domain.

Examples:

Disable whois privacy for “example.com”:

client.registrar.disable_whois_privacy(1010, "example.com")

Parameters:

  • account_id (Fixnum) —

    the account ID

  • domain_name (#to_s) —

    The domain name to check.

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



58
59
60
61
62
63
 
# File 'lib/dnsimple/client/registrar_whois_privacy.rb', line 58

def disable_whois_privacy(, domain_name, options = {})
  endpoint = whois_privacy_endpoint(, domain_name)
  response = client.delete(endpoint, nil, options)

  Dnsimple::Response.new(response, Struct::WhoisPrivacy.new(response["data"]))
end

#enable_whois_privacy(account_id, domain_name, options = {}) ⇒ Struct::WhoisPrivacy

Enables whois privacy for the domain.

Examples:

Enable whois privacy for “example.com”:

client.registrar.enable_whois_privacy(1010, "example.com")

Parameters:

  • account_id (Fixnum) —

    the account ID

  • domain_name (#to_s) —

    the domain name

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



38
39
40
41
42
43
 
# File 'lib/dnsimple/client/registrar_whois_privacy.rb', line 38

def enable_whois_privacy(, domain_name, options = {})
  endpoint = whois_privacy_endpoint(, domain_name)
  response = client.put(endpoint, nil, options)

  Dnsimple::Response.new(response, Struct::WhoisPrivacy.new(response["data"]))
end

#whois_privacy(account_id, domain_name, options = {}) ⇒ Struct::WhoisPrivacy

Gets the whois privacy for the domain.

Examples:

Get the whois privacy for “example.com”:

client.registrar.whois_privacy(1010, "example.com")

Parameters:

  • account_id (Fixnum) —

    the account ID

  • domain_name (#to_s) —

    the domain name

  • options (Hash) (defaults to: {})

Returns:

Raises:

See Also:



18
19
20
21
22
23
 
# File 'lib/dnsimple/client/registrar_whois_privacy.rb', line 18

def whois_privacy(, domain_name, options = {})
  endpoint = whois_privacy_endpoint(, domain_name)
  response = client.get(endpoint, options)

  Dnsimple::Response.new(response, Struct::WhoisPrivacy.new(response["data"]))
end