Class: WhoisFreaks::WHOISApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WHOISApi

Returns a new instance of WHOISApi.



19
20
21
 
# File 'lib/whoisfreaks/api/whois_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/whois_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#bulk_whois(bulk_whois_request, opts = {}) ⇒ BulkWhoisResponse

Bulk WHOIS Lookup Up to 100 domains in one request. 1 credit per successful domain.

Parameters:

  • bulk_whois_request (BulkWhoisRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (String) — default: default to 'json'

Returns:



28
29
30
31
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 28

def bulk_whois(bulk_whois_request, opts = {})
  data, _status_code, _headers = bulk_whois_with_http_info(bulk_whois_request, opts)
  data
end

#bulk_whois_with_http_info(bulk_whois_request, opts = {}) ⇒ Array<(BulkWhoisResponse, Integer, Hash)>

Bulk WHOIS Lookup Up to 100 domains in one request. 1 credit per successful domain.

Parameters:

  • bulk_whois_request (BulkWhoisRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :format (String) — default: default to 'json'

Returns:

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

    BulkWhoisResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
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
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 39

def bulk_whois_with_http_info(bulk_whois_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.bulk_whois ...'
  end
  # verify the required parameter 'bulk_whois_request' is set
  if @api_client.config.client_side_validation && bulk_whois_request.nil?
    fail ArgumentError, "Missing the required parameter 'bulk_whois_request' when calling WHOISApi.bulk_whois"
  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 = '/v2.0/bulkwhois/live'

  # query parameters
  query_params = opts[:query_params] || {}
  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']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(bulk_whois_request)

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

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

  new_options = opts.merge(
    :operation => :"WHOISApi.bulk_whois",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WHOISApi#bulk_whois\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#whois_history(domain_name, opts = {}) ⇒ WhoisHistoricalResponse

Historical WHOIS records for a domain

Parameters:

  • domain_name (String) —

    Domain to fetch historical WHOIS records for

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :format (String)

Returns:



103
104
105
106
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 103

def whois_history(domain_name, opts = {})
  data, _status_code, _headers = whois_history_with_http_info(domain_name, opts)
  data
end

#whois_history_with_http_info(domain_name, opts = {}) ⇒ Array<(WhoisHistoricalResponse, Integer, Hash)>

Historical WHOIS records for a domain

Parameters:

  • domain_name (String) —

    Domain to fetch historical WHOIS records for

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :format (String)

Returns:

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

    WhoisHistoricalResponse data, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 114

def whois_history_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.whois_history ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling WHOISApi.whois_history"
  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 = '/v2.0/whois/history'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'domainName'] = domain_name
  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] || 'WhoisHistoricalResponse'

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

  new_options = opts.merge(
    :operation => :"WHOISApi.whois_history",
    :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: WHOISApi#whois_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#whois_live(domain_name, opts = {}) ⇒ WhoisResponse

Live WHOIS Lookup Real-time WHOIS lookup from authoritative servers. Cost 1 credit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) — default: default to 'json'

Returns:



175
176
177
178
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 175

def whois_live(domain_name, opts = {})
  data, _status_code, _headers = whois_live_with_http_info(domain_name, opts)
  data
end

#whois_live_with_http_info(domain_name, opts = {}) ⇒ Array<(WhoisResponse, Integer, Hash)>

Live WHOIS Lookup Real-time WHOIS lookup from authoritative servers. Cost 1 credit.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :format (String) — default: default to 'json'

Returns:

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

    WhoisResponse data, response status code and response headers



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 186

def whois_live_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.whois_live ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling WHOISApi.whois_live"
  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 = '/v2.0/whois/live'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'domainName'] = domain_name
  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] || 'WhoisResponse'

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

  new_options = opts.merge(
    :operation => :"WHOISApi.whois_live",
    :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: WHOISApi#whois_live\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#whois_reverse(keyword, opts = {}) ⇒ ReverseWhoisResponse

Reverse WHOIS lookup by keyword

Parameters:

  • keyword (String) —

    Keyword to search across WHOIS records

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :format (String)

Returns:



246
247
248
249
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 246

def whois_reverse(keyword, opts = {})
  data, _status_code, _headers = whois_reverse_with_http_info(keyword, opts)
  data
end

#whois_reverse_with_http_info(keyword, opts = {}) ⇒ Array<(ReverseWhoisResponse, Integer, Hash)>

Reverse WHOIS lookup by keyword

Parameters:

  • keyword (String) —

    Keyword to search across WHOIS records

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :format (String)

Returns:

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

    ReverseWhoisResponse data, response status code and response headers



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 257

def whois_reverse_with_http_info(keyword, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.whois_reverse ...'
  end
  # verify the required parameter 'keyword' is set
  if @api_client.config.client_side_validation && keyword.nil?
    fail ArgumentError, "Missing the required parameter 'keyword' when calling WHOISApi.whois_reverse"
  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 = '/v2.0/whois/reverse'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'keyword'] = keyword
  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] || 'ReverseWhoisResponse'

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

  new_options = opts.merge(
    :operation => :"WHOISApi.whois_reverse",
    :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: WHOISApi#whois_reverse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end