Class: CloudmersiveValidateApiClient::IPAddressApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudmersive-validate-api-client/api/ip_address_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IPAddressApi

Returns a new instance of IPAddressApi.



19
20
21
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_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/cloudmersive-validate-api-client/api/ip_address_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#i_p_address_geolocate_street_address(value, opts = {}) ⇒ GeolocateStreetAddressResponse

Geolocate an IP address to a street address Identify an IP address’s street address. Useful for security and UX applications.

Parameters:

  • value —

    IP address to geolocate, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 27

def i_p_address_geolocate_street_address(value, opts = {})
  data, _status_code, _headers = i_p_address_geolocate_street_address_with_http_info(value, opts)
  data
end

#i_p_address_geolocate_street_address_with_http_info(value, opts = {}) ⇒ Array<(GeolocateStreetAddressResponse, Fixnum, Hash)>

Geolocate an IP address to a street address Identify an IP address&#39;s street address. Useful for security and UX applications.

Parameters:

  • value —

    IP address to geolocate, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



37
38
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
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 37

def i_p_address_geolocate_street_address_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_geolocate_street_address ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_geolocate_street_address"
  end
  # resource path
  local_var_path = '/validate/ip/geolocate/street-address'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GeolocateStreetAddressResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_geolocate_street_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_ip_intelligence(value, opts = {}) ⇒ IPIntelligenceResponse

Get intelligence on an IP address Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.

Parameters:

  • value —

    IP address to process, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



81
82
83
84
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 81

def i_p_address_ip_intelligence(value, opts = {})
  data, _status_code, _headers = i_p_address_ip_intelligence_with_http_info(value, opts)
  data
end

#i_p_address_ip_intelligence_with_http_info(value, opts = {}) ⇒ Array<(IPIntelligenceResponse, Fixnum, Hash)>

Get intelligence on an IP address Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.

Parameters:

  • value —

    IP address to process, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(IPIntelligenceResponse, Fixnum, Hash)>) —

    IPIntelligenceResponse data, response status code and response headers



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 91

def i_p_address_ip_intelligence_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_ip_intelligence ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_ip_intelligence"
  end
  # resource path
  local_var_path = '/validate/ip/intelligence'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IPIntelligenceResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_ip_intelligence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_is_bot(value, opts = {}) ⇒ BotCheckResponse

Check if IP address is a Bot client Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 135

def i_p_address_is_bot(value, opts = {})
  data, _status_code, _headers = i_p_address_is_bot_with_http_info(value, opts)
  data
end

#i_p_address_is_bot_with_http_info(value, opts = {}) ⇒ Array<(BotCheckResponse, Fixnum, Hash)>

Check if IP address is a Bot client Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(BotCheckResponse, Fixnum, Hash)>) —

    BotCheckResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 145

def i_p_address_is_bot_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_is_bot ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_is_bot"
  end
  # resource path
  local_var_path = '/validate/ip/is-bot'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BotCheckResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_is_bot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_is_threat(value, opts = {}) ⇒ IPThreatResponse

Check if IP address is a known threat Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 189

def i_p_address_is_threat(value, opts = {})
  data, _status_code, _headers = i_p_address_is_threat_with_http_info(value, opts)
  data
end

#i_p_address_is_threat_with_http_info(value, opts = {}) ⇒ Array<(IPThreatResponse, Fixnum, Hash)>

Check if IP address is a known threat Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(IPThreatResponse, Fixnum, Hash)>) —

    IPThreatResponse data, response status code and response headers



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
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 199

def i_p_address_is_threat_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_is_threat ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_is_threat"
  end
  # resource path
  local_var_path = '/validate/ip/is-threat'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IPThreatResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_is_threat\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_is_tor_node(value, opts = {}) ⇒ TorNodeResponse

Check if IP address is a Tor node server Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



243
244
245
246
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 243

def i_p_address_is_tor_node(value, opts = {})
  data, _status_code, _headers = i_p_address_is_tor_node_with_http_info(value, opts)
  data
end

#i_p_address_is_tor_node_with_http_info(value, opts = {}) ⇒ Array<(TorNodeResponse, Fixnum, Hash)>

Check if IP address is a Tor node server Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(TorNodeResponse, Fixnum, Hash)>) —

    TorNodeResponse data, response status code and response headers



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/cloudmersive-validate-api-client/api/ip_address_api.rb', line 253

def i_p_address_is_tor_node_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_is_tor_node ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_is_tor_node"
  end
  # resource path
  local_var_path = '/validate/ip/is-tor-node'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TorNodeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_is_tor_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_post(value, opts = {}) ⇒ GeolocateResponse

Geolocate an IP address Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.

Parameters:

  • value —

    IP address to geolocate, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



297
298
299
300
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 297

def i_p_address_post(value, opts = {})
  data, _status_code, _headers = i_p_address_post_with_http_info(value, opts)
  data
end

#i_p_address_post_with_http_info(value, opts = {}) ⇒ Array<(GeolocateResponse, Fixnum, Hash)>

Geolocate an IP address Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.

Parameters:

  • value —

    IP address to geolocate, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(GeolocateResponse, Fixnum, Hash)>) —

    GeolocateResponse data, response status code and response headers



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 307

def i_p_address_post_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_post ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_post"
  end
  # resource path
  local_var_path = '/validate/ip/geolocate'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'GeolocateResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#i_p_address_reverse_domain_lookup(value, opts = {}) ⇒ IPReverseDNSLookupResponse

Perform a reverse domain name (DNS) lookup on an IP address Gets the domain name, if any, associated with the IP address.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:



351
352
353
354
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 351

def i_p_address_reverse_domain_lookup(value, opts = {})
  data, _status_code, _headers = i_p_address_reverse_domain_lookup_with_http_info(value, opts)
  data
end

#i_p_address_reverse_domain_lookup_with_http_info(value, opts = {}) ⇒ Array<(IPReverseDNSLookupResponse, Fixnum, Hash)>

Perform a reverse domain name (DNS) lookup on an IP address Gets the domain name, if any, associated with the IP address.

Parameters:

  • value —

    IP address to check, e.g. &quot;55.55.55.55&quot;. The input is a string so be sure to enclose it in double-quotes.

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

    the optional parameters

Returns:

  • (Array<(IPReverseDNSLookupResponse, Fixnum, Hash)>) —

    IPReverseDNSLookupResponse data, response status code and response headers



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/cloudmersive-validate-api-client/api/ip_address_api.rb', line 361

def i_p_address_reverse_domain_lookup_with_http_info(value, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_reverse_domain_lookup ...'
  end
  # verify the required parameter 'value' is set
  if @api_client.config.client_side_validation && value.nil?
    fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_reverse_domain_lookup"
  end
  # resource path
  local_var_path = '/validate/ip/reverse-domain-lookup'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(value)
  auth_names = ['Apikey']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'IPReverseDNSLookupResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_reverse_domain_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end