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(api_key, bulk_whois_request, opts = {}) ⇒ BulkWhois200Response

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

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Options Hash (opts):

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

Returns:



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

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

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

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

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Options Hash (opts):

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

Returns:

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

    BulkWhois200Response data, response status code and response headers



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
96
97
98
99
100
101
102
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 41

def bulk_whois_with_http_info(api_key, bulk_whois_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.bulk_whois ...'
  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 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[:'apiKey'] = api_key
  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] || 'BulkWhois200Response'

  # 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_historical_or_reverse(api_key, whois, opts = {}) ⇒ WhoisHistoricalOrReverse200Response

WHOIS Historical or Reverse Lookup Historical WHOIS (all records since 1986) or Reverse WHOIS (search by keyword/email/owner/company). Historical: 2 credits/page (100 records). Reverse: 5 credits/page.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Options Hash (opts):

  • :domain_name (String) —

    Required for historical lookup

  • :keyword (String) —

    For reverse — domain keyword search

  • :email (String) —

    For reverse — registrant email search

  • :owner (String) —

    For reverse — registrant name search

  • :company (String) —

    For reverse — company name search

  • :mode (String) — default: default to 'default'
  • :exact (Boolean) — default: default to true
  • :page (Integer) — default: default to 1
  • :format (String) — default: default to 'json'

Returns:



119
120
121
122
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 119

def whois_historical_or_reverse(api_key, whois, opts = {})
  data, _status_code, _headers = whois_historical_or_reverse_with_http_info(api_key, whois, opts)
  data
end

#whois_historical_or_reverse_with_http_info(api_key, whois, opts = {}) ⇒ Array<(WhoisHistoricalOrReverse200Response, Integer, Hash)>

WHOIS Historical or Reverse Lookup Historical WHOIS (all records since 1986) or Reverse WHOIS (search by keyword/email/owner/company). Historical: 2 credits/page (100 records). Reverse: 5 credits/page.

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Options Hash (opts):

  • :domain_name (String) —

    Required for historical lookup

  • :keyword (String) —

    For reverse — domain keyword search

  • :email (String) —

    For reverse — registrant email search

  • :owner (String) —

    For reverse — registrant name search

  • :company (String) —

    For reverse — company name search

  • :mode (String) — default: default to 'default'
  • :exact (Boolean) — default: default to true
  • :page (Integer) — default: default to 1
  • :format (String) — default: default to 'json'

Returns:



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
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
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 139

def whois_historical_or_reverse_with_http_info(api_key, whois, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.whois_historical_or_reverse ...'
  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 WHOISApi.whois_historical_or_reverse"
  end
  # verify the required parameter 'whois' is set
  if @api_client.config.client_side_validation && whois.nil?
    fail ArgumentError, "Missing the required parameter 'whois' when calling WHOISApi.whois_historical_or_reverse"
  end
  # verify enum value
  allowable_values = ["historical", "reverse"]
  if @api_client.config.client_side_validation && !allowable_values.include?(whois)
    fail ArgumentError, "invalid value for \"whois\", must be one of #{allowable_values}"
  end
  allowable_values = ["default", "mini"]
  if @api_client.config.client_side_validation && opts[:'mode'] && !allowable_values.include?(opts[:'mode'])
    fail ArgumentError, "invalid value for \"mode\", 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/whois'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'apiKey'] = api_key
  query_params[:'whois'] = whois
  query_params[:'domainName'] = opts[:'domain_name'] if !opts[:'domain_name'].nil?
  query_params[:'keyword'] = opts[:'keyword'] if !opts[:'keyword'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  query_params[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?
  query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
  query_params[:'mode'] = opts[:'mode'] if !opts[:'mode'].nil?
  query_params[:'exact'] = opts[:'exact'] if !opts[:'exact'].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] || 'WhoisHistoricalOrReverse200Response'

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

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

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

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

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

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

    the optional parameters

Options Hash (opts):

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

Returns:



222
223
224
225
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 222

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

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

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

Parameters:

  • api_key (String) —

    Your WHOISFreaks API key

  • 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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
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
 
# File 'lib/whoisfreaks/api/whois_api.rb', line 234

def whois_live_with_http_info(api_key, domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WHOISApi.whois_live ...'
  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 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[:'apiKey'] = api_key
  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