Module: Dnsimple::Client::VanityNameServers

Included in:

VanityNameServersService

Defined in:

lib/dnsimple/client/vanity_name_servers.rb

Instance Method Summary

• #disable_vanity_name_servers(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<nil>

  Disable vanity name servers for the domain.

• #enable_vanity_name_servers(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<Array>

  Enable vanity name servers for the domain.

Instance Method Details

#disable_vanity_name_servers(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<nil>

Disable vanity name servers for the domain.

Examples:

Disable vanity name servers for example.com:

client.vanity_name_servers.disable(1010, "example.com")

Parameters:

• account_id (Integer) —

  the account ID

• domain_name (#to_s) —

  the domain name

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

Returns:

• (Dnsimple::Response<nil>)

Raises:

• (RequestError) —

  When the request fails.

See Also:

• https://developer.dnsimple.com/v2/vanity/#disable

# File 'lib/dnsimple/client/vanity_name_servers.rb', line 38

def disable_vanity_name_servers(account_id, domain_name, options = {})
  endpoint = Client.versioned("/%s/vanity/%s" % [account_id, domain_name])
  response = client.delete(endpoint, options)

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

#enable_vanity_name_servers(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<Array>

Enable vanity name servers for the domain.

Examples:

Enable vanity name servers for example.com:

client.vanity_name_servers.enable(1010, "example.com")

Parameters:

• account_id (Integer) —

  the account ID

• domain_name (#to_s) —

  the domain name

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

Returns:

• (Dnsimple::Response<Array>)

Raises:

• (RequestError) —

  When the request fails.

See Also:

• https://developer.dnsimple.com/v2/vanity/#enable

# File 'lib/dnsimple/client/vanity_name_servers.rb', line 18

def enable_vanity_name_servers(account_id, domain_name, options = {})
  endpoint = Client.versioned("/%s/vanity/%s" % [account_id, domain_name])
  response = client.put(endpoint, options)

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