Module: Dnsimple::Client::Zones

Included in:

ZonesService

Defined in:

lib/dnsimple/client/zones.rb

Instance Method Summary

• #all_zones(account_id, options = {}) ⇒ Dnsimple::CollectionResponse<Dnsimple::Struct::Zone>

  Lists ALL the zones in the account.

• #zone(account_id, zone_id, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Zone>

  Gets a zone from the account.

• #zones(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Zone> (also: #list, #list_zones)

  Lists the zones in the account.

Instance Method Details

#all_zones(account_id, options = {}) ⇒ Dnsimple::CollectionResponse<Dnsimple::Struct::Zone>

Lists ALL the zones in the account.

This method is similar to #zones, but instead of returning the results of a specific page it iterates all the pages and returns the entire collection.

Please use this method carefully, as fetching the entire collection will increase the number of requests you send to the API server and you may eventually risk to hit the throttle limit.

Parameters:

• account_id (Fixnum) —

  the account ID

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

  the filtering and sorting option

Returns:

• (Dnsimple::CollectionResponse<Dnsimple::Struct::Zone>)

Raises:

• (Dnsimple::RequestError)

See Also:

• https://developer.dnsimple.com/v2/zones/#list
• #zones

# File 'lib/dnsimple/client/zones.rb', line 45

def all_zones(account_id, options = {})
  paginate(:zones, account_id, options)
end

#zone(account_id, zone_id, options = {}) ⇒ Dnsimple::Response<Dnsimple::Struct::Zone>

Gets a zone from the account.

Parameters:

• account_id (Fixnum, Dnsimple::Client::WILDCARD_ACCOUNT) —

  the account ID or wildcard

• zone_id (#to_s) —

  the zone name

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

Returns:

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

Raises:

• (Dnsimple::NotFoundError)
• (Dnsimple::RequestError)

See Also:

• https://developer.dnsimple.com/v2/zones/#get

# File 'lib/dnsimple/client/zones.rb', line 60

def zone(account_id, zone_id, options = {})
  response = client.get(Client.versioned("/%s/zones/%s" % [account_id, zone_id]), options)

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

#zones(account_id, options = {}) ⇒ Dnsimple::PaginatedResponse<Dnsimple::Struct::Zone> Also known as: list, list_zones

Lists the zones in the account.

Examples:

List zones in the first page

client.zones.list(1010, "example.com")

List zones, provide a specific page

client.zones.list(1010, "example.com", query: { page: 2 })

Parameters:

• account_id (Fixnum) —

  the account ID

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

  the filtering and sorting option

Returns:

• (Dnsimple::PaginatedResponse<Dnsimple::Struct::Zone>)

Raises:

• (Dnsimple::RequestError)

See Also:

• https://developer.dnsimple.com/v2/zones/#list
• #all_zones

# File 'lib/dnsimple/client/zones.rb', line 21

def zones(account_id, options = {})
  response = client.get(Client.versioned("/%s/zones" % [account_id]), options)

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