Class: WhoisFreaks::SubdomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/whoisfreaks/api/subdomains_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubdomainsApi

Returns a new instance of SubdomainsApi.



19
20
21
 
# File 'lib/whoisfreaks/api/subdomains_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/whoisfreaks/api/subdomains_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#subdomains(api_key, domain, opts = {}) ⇒ SubdomainsResponse

Subdomains Lookup All subdomains including nested. 2 credits per query.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (Date)
  • :before (Date)
  • :status (String)
  • :page (Integer) — default: default to 1
  • :format (String) — default: default to 'json'

Returns:



33
34
35
36
 
# File 'lib/whoisfreaks/api/subdomains_api.rb', line 33

def subdomains(api_key, domain, opts = {})
  data, _status_code, _headers = subdomains_with_http_info(api_key, domain, opts)
  data
end

#subdomains_with_http_info(api_key, domain, opts = {}) ⇒ Array<(SubdomainsResponse, Integer, Hash)>

Subdomains Lookup All subdomains including nested. 2 credits per query.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • domain (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :after (Date)
  • :before (Date)
  • :status (String)
  • :page (Integer) — default: default to 1
  • :format (String) — default: default to 'json'

Returns:

  • (Array<(SubdomainsResponse, Integer, Hash)>) —

    SubdomainsResponse data, response status code and response headers



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/whoisfreaks/api/subdomains_api.rb', line 49

def subdomains_with_http_info(api_key, domain, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubdomainsApi.subdomains ...'
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling SubdomainsApi.subdomains"
  end
  # verify the required parameter 'domain' is set
  if @api_client.config.client_side_validation && domain.nil?
    fail ArgumentError, "Missing the required parameter 'domain' when calling SubdomainsApi.subdomains"
  end
  allowable_values = ["active", "inactive"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  allowable_values = ["json", "xml"]
  if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
    fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1.0/subdomains'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key
  query_params[:'domain'] = domain
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'SubdomainsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"SubdomainsApi.subdomains",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubdomainsApi#subdomains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end