Module: Dnsimple::Client::DomainsResearch

Included in:

DomainsService

Defined in:

lib/dnsimple/client/domains_research.rb

Instance Method Summary

• #domain_research_status(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::DomainResearchStatus>

  Research a domain name for availability and registration status information.

Instance Method Details

#domain_research_status(account_id, domain_name, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::DomainResearchStatus>

Research a domain name for availability and registration status information.

This endpoint provides information about a domain’s availability status.

Examples:

Research the domain example.com:

client.domains.domain_research_status(1010, "example.com")

Parameters:

• account_id (Integer) —

  the account ID

• domain_name (#to_s) —

  the domain name to research

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

Returns:

• (Dnsimple::Response<Dnsimple::Struct::DomainResearchStatus>)

Raises:

• (Dnsimple::RequestError) —

  When the request fails.

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

def domain_research_status(account_id, domain_name, options = {})
  endpoint = Client.versioned("/%s/domains/research/status" % [account_id])
  options = options.merge(query: { domain: domain_name })
  response = client.get(endpoint, options)

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