Module: Dnsimple::Client::Services

Included in:

ServicesService

Defined in:

lib/dnsimple/client/services.rb

Instance Method Summary

• #service(service, options = {}) ⇒ Struct::Service

  Gets a service.

• #services(options = {}) ⇒ Array<Struct::Service> (also: #list, #list_services)

  Lists the supported services.

Instance Method Details

#service(service, options = {}) ⇒ Struct::Service

Gets a service.

Parameters:

• service (Fixnum) —

  The service id.

Returns:

• (Struct::Service)

Raises:

• (NotFoundError)
• (RequestError) —

  When the request fails.

See Also:

• http://developer.dnsimple.com/v1/services/#get

# File 'lib/dnsimple/client/services.rb', line 29

def service(service, options = {})
  response = client.get(Client.versioned("services/#{service}"), options)

  Struct::Service.new(response["service"])
end

#services(options = {}) ⇒ Array<Struct::Service> Also known as: list, list_services

Lists the supported services.

Returns:

• (Array<Struct::Service>)

Raises:

• (RequestError) —

  When the request fails.

See Also:

• http://developer.dnsimple.com/v1/services/#list

# File 'lib/dnsimple/client/services.rb', line 12

def services(options = {})
  response = client.get(Client.versioned("services"), options)

  response.map { |r| Struct::Service.new(r["service"]) }
end