Method: Dnsimple::Client::Services#services

Defined in:
lib/dnsimple/client/services.rb

#services(options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Service> Also known as: list_services

Lists the available one-click services.

Examples:

List one-click services:

client.services.list_services

List one-click services, provide a specific page:

client.services.list_services(page: 2)

List one-click services, provide a sorting policy:

client.services.list_services(sort: "short_name:asc")

Parameters:

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

    the filtering and sorting options

Options Hash (options):

  • :page (Integer) —

    current page (pagination)

  • :per_page (Integer) —

    number of entries to return (pagination)

  • :sort (String) —

    sorting policy

Returns:

Raises:

See Also:



27
28
29
30
31
32
 
# File 'lib/dnsimple/client/services.rb', line 27

def services(options = {})
  endpoint = Client.versioned("/services")
  response = client.get(endpoint, Options::ListOptions.new(options))

  Dnsimple::PaginatedResponse.new(response, response["data"].map { |r| Struct::Service.new(r) })
end