class Ultradns::Api::Account

Attributes

account_name[R]

Public Class Methods

new(client, account_name) click to toggle source
Calls superclass method Ultradns::Api::ClientAccessor::new
# File lib/ultradns/api/account.rb, line 13
def initialize(client, account_name)
  super(client)
  @account_name = account_name
end

Public Instance Methods

users() click to toggle source

List users for this account

# File lib/ultradns/api/account.rb, line 48
def users()
  client.with_auth_retry {|c| c.get "/accounts/#{@account_name}/users", request_options }
end
zones(options={}) click to toggle source

List zones for this account

Optional Parameters

  • :q - The search parameters, in a hash. Valid keys are:

    name - substring match of the zone name
    zone_type - one of :
        PRIMARY
        SECONDARY
        ALIAS
  • :sort - The sort column used to order the list. Valid values for the sort field are:

    NAME
    ACCOUNT_NAME
    RECORD_COUNT
    ZONE_TYPE
    
  • :reverse - Whether the list is ascending(false) or descending(true). Defaults to true

  • :offset - The position in the list for the first returned element(0 based)

  • :limit - The maximum number of zones to be returned.

Examples

client.account('myaccount').zones
client.account('myaccount').zones(q: {name: 'foo', zone_type: 'PRIMARY'}, sort: 'NAME', reverse: true, offset:10, limit:50)
# File lib/ultradns/api/account.rb, line 43
def zones(options={})
  client.with_auth_retry {|c| c.get("/accounts/#{@account_name}/zones", request_options(options)) }
end