Module: Dnsimple::Client::RegistrarWhoisPrivacy

Included in:

RegistrarService

Defined in:

lib/dnsimple/client/registrar_whois_privacy.rb

Instance Method Summary

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

  Disables whois privacy for the domain.

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

  Enables whois privacy for the domain.

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 (Integer) —

  the account ID

• domain_name (#to_s) —

  The domain name

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

Returns:

• (Struct::WhoisPrivacy)

Raises:

• (RequestError) —

  When the request fails.

See Also:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#disable

# File 'lib/dnsimple/client/registrar_whois_privacy.rb', line 39

def disable_whois_privacy(account_id, domain_name, options = {})
  endpoint = whois_privacy_endpoint(account_id, 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 (Integer) —

  the account ID

• domain_name (#to_s) —

  the domain name

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

Returns:

• (Struct::WhoisPrivacy)

Raises:

• (RequestError) —

  When the request fails.

See Also:

• https://developer.dnsimple.com/v2/registrar/whois-privacy/#enable

# File 'lib/dnsimple/client/registrar_whois_privacy.rb', line 19

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

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