cloudmersive-validate-api-client 2.1.4 → 2.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +33 -4
  3. data/docs/BotCheckResponse.md +8 -0
  4. data/docs/DomainApi.md +275 -0
  5. data/docs/IPAddressApi.md +110 -0
  6. data/docs/IPIntelligenceResponse.md +16 -0
  7. data/docs/PhishingCheckRequest.md +8 -0
  8. data/docs/PhishingCheckResponse.md +9 -0
  9. data/docs/SqlInjectionCheckBatchRequest.md +9 -0
  10. data/docs/SqlInjectionCheckBatchResponse.md +8 -0
  11. data/docs/SqlInjectionCheckRequestItem.md +8 -0
  12. data/docs/SqlInjectionDetectionResult.md +10 -0
  13. data/docs/TextInputApi.md +233 -1
  14. data/docs/UrlSafetyCheckRequestFull.md +8 -0
  15. data/docs/UrlSafetyCheckResponseFull.md +9 -0
  16. data/docs/UrlSsrfRequestBatch.md +8 -0
  17. data/docs/UrlSsrfRequestFull.md +9 -0
  18. data/docs/UrlSsrfResponseBatch.md +8 -0
  19. data/docs/UrlSsrfResponseFull.md +9 -0
  20. data/docs/ValidateUrlResponseSyntaxOnly.md +1 -0
  21. data/docs/XxeDetectionBatchRequest.md +8 -0
  22. data/docs/XxeDetectionBatchResponse.md +8 -0
  23. data/docs/XxeDetectionRequestItem.md +11 -0
  24. data/docs/XxeDetectionResult.md +9 -0
  25. data/lib/cloudmersive-validate-api-client.rb +18 -0
  26. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +270 -0
  27. data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +108 -0
  28. data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +230 -2
  29. data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
  30. data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
  31. data/lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb +266 -0
  32. data/lib/cloudmersive-validate-api-client/models/phishing_check_request.rb +186 -0
  33. data/lib/cloudmersive-validate-api-client/models/phishing_check_response.rb +196 -0
  34. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
  35. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
  36. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
  37. data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
  38. data/lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb +186 -0
  39. data/lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb +196 -0
  40. data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_batch.rb +188 -0
  41. data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_full.rb +198 -0
  42. data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_batch.rb +188 -0
  43. data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_full.rb +196 -0
  44. data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +14 -4
  45. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_request.rb +188 -0
  46. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_response.rb +188 -0
  47. data/lib/cloudmersive-validate-api-client/models/xxe_detection_request_item.rb +220 -0
  48. data/lib/cloudmersive-validate-api-client/models/xxe_detection_result.rb +196 -0
  49. data/lib/cloudmersive-validate-api-client/version.rb +1 -1
  50. data/spec/api/domain_api_spec.rb +60 -0
  51. data/spec/api/ip_address_api_spec.rb +24 -0
  52. data/spec/api/text_input_api_spec.rb +53 -1
  53. data/spec/models/bot_check_response_spec.rb +41 -0
  54. data/spec/models/ip_intelligence_response_spec.rb +89 -0
  55. data/spec/models/phishing_check_request_spec.rb +41 -0
  56. data/spec/models/phishing_check_response_spec.rb +47 -0
  57. data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
  58. data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
  59. data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
  60. data/spec/models/sql_injection_detection_result_spec.rb +53 -0
  61. data/spec/models/url_safety_check_request_full_spec.rb +41 -0
  62. data/spec/models/url_safety_check_response_full_spec.rb +47 -0
  63. data/spec/models/url_ssrf_request_batch_spec.rb +41 -0
  64. data/spec/models/url_ssrf_request_full_spec.rb +47 -0
  65. data/spec/models/url_ssrf_response_batch_spec.rb +41 -0
  66. data/spec/models/url_ssrf_response_full_spec.rb +47 -0
  67. data/spec/models/validate_url_response_syntax_only_spec.rb +6 -0
  68. data/spec/models/xxe_detection_batch_request_spec.rb +41 -0
  69. data/spec/models/xxe_detection_batch_response_spec.rb +41 -0
  70. data/spec/models/xxe_detection_request_item_spec.rb +59 -0
  71. data/spec/models/xxe_detection_result_spec.rb +47 -0
  72. metadata +56 -2
@@ -19,6 +19,7 @@ require 'cloudmersive-validate-api-client/configuration'
19
19
  # Models
20
20
  require 'cloudmersive-validate-api-client/models/address_get_servers_response'
21
21
  require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_response'
22
+ require 'cloudmersive-validate-api-client/models/bot_check_response'
22
23
  require 'cloudmersive-validate-api-client/models/check_response'
23
24
  require 'cloudmersive-validate-api-client/models/country_details'
24
25
  require 'cloudmersive-validate-api-client/models/country_list_result'
@@ -39,6 +40,7 @@ require 'cloudmersive-validate-api-client/models/get_gender_response'
39
40
  require 'cloudmersive-validate-api-client/models/get_public_holidays_request'
40
41
  require 'cloudmersive-validate-api-client/models/get_timezones_request'
41
42
  require 'cloudmersive-validate-api-client/models/get_timezones_response'
43
+ require 'cloudmersive-validate-api-client/models/ip_intelligence_response'
42
44
  require 'cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response'
43
45
  require 'cloudmersive-validate-api-client/models/ip_threat_response'
44
46
  require 'cloudmersive-validate-api-client/models/last_name_validation_request'
@@ -48,14 +50,26 @@ require 'cloudmersive-validate-api-client/models/lead_enrichment_response'
48
50
  require 'cloudmersive-validate-api-client/models/normalize_address_response'
49
51
  require 'cloudmersive-validate-api-client/models/parse_address_request'
50
52
  require 'cloudmersive-validate-api-client/models/parse_address_response'
53
+ require 'cloudmersive-validate-api-client/models/phishing_check_request'
54
+ require 'cloudmersive-validate-api-client/models/phishing_check_response'
51
55
  require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
52
56
  require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
53
57
  require 'cloudmersive-validate-api-client/models/public_holiday_occurrence'
54
58
  require 'cloudmersive-validate-api-client/models/public_holidays_response'
55
59
  require 'cloudmersive-validate-api-client/models/reverse_geocode_address_request'
56
60
  require 'cloudmersive-validate-api-client/models/reverse_geocode_address_response'
61
+ require 'cloudmersive-validate-api-client/models/sql_injection_check_batch_request'
62
+ require 'cloudmersive-validate-api-client/models/sql_injection_check_batch_response'
63
+ require 'cloudmersive-validate-api-client/models/sql_injection_check_request_item'
64
+ require 'cloudmersive-validate-api-client/models/sql_injection_detection_result'
57
65
  require 'cloudmersive-validate-api-client/models/timezone'
58
66
  require 'cloudmersive-validate-api-client/models/tor_node_response'
67
+ require 'cloudmersive-validate-api-client/models/url_safety_check_request_full'
68
+ require 'cloudmersive-validate-api-client/models/url_safety_check_response_full'
69
+ require 'cloudmersive-validate-api-client/models/url_ssrf_request_batch'
70
+ require 'cloudmersive-validate-api-client/models/url_ssrf_request_full'
71
+ require 'cloudmersive-validate-api-client/models/url_ssrf_response_batch'
72
+ require 'cloudmersive-validate-api-client/models/url_ssrf_response_full'
59
73
  require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
60
74
  require 'cloudmersive-validate-api-client/models/user_agent_validate_response'
61
75
  require 'cloudmersive-validate-api-client/models/validate_address_request'
@@ -81,6 +95,10 @@ require 'cloudmersive-validate-api-client/models/xss_protection_batch_request'
81
95
  require 'cloudmersive-validate-api-client/models/xss_protection_batch_response'
82
96
  require 'cloudmersive-validate-api-client/models/xss_protection_request_item'
83
97
  require 'cloudmersive-validate-api-client/models/xss_protection_result'
98
+ require 'cloudmersive-validate-api-client/models/xxe_detection_batch_request'
99
+ require 'cloudmersive-validate-api-client/models/xxe_detection_batch_response'
100
+ require 'cloudmersive-validate-api-client/models/xxe_detection_request_item'
101
+ require 'cloudmersive-validate-api-client/models/xxe_detection_result'
84
102
 
85
103
  # APIs
86
104
  require 'cloudmersive-validate-api-client/api/address_api'
@@ -73,6 +73,114 @@ module CloudmersiveValidateApiClient
73
73
  end
74
74
  return data, status_code, headers
75
75
  end
76
+ # Get top-level domain name from URL
77
+ # Gets the top-level domain name from a URL, such as mydomain.com.
78
+ # @param request Input URL information
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [ValidateUrlResponseSyntaxOnly]
81
+ def domain_get_top_level_domain_from_url(request, opts = {})
82
+ data, _status_code, _headers = domain_get_top_level_domain_from_url_with_http_info(request, opts)
83
+ data
84
+ end
85
+
86
+ # Get top-level domain name from URL
87
+ # Gets the top-level domain name from a URL, such as mydomain.com.
88
+ # @param request Input URL information
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(ValidateUrlResponseSyntaxOnly, Fixnum, Hash)>] ValidateUrlResponseSyntaxOnly data, response status code and response headers
91
+ def domain_get_top_level_domain_from_url_with_http_info(request, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: DomainApi.domain_get_top_level_domain_from_url ...'
94
+ end
95
+ # verify the required parameter 'request' is set
96
+ if @api_client.config.client_side_validation && request.nil?
97
+ fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_get_top_level_domain_from_url"
98
+ end
99
+ # resource path
100
+ local_var_path = '/validate/domain/url/get-top-level-domain'
101
+
102
+ # query parameters
103
+ query_params = {}
104
+
105
+ # header parameters
106
+ header_params = {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
109
+ # HTTP header 'Content-Type'
110
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
111
+
112
+ # form parameters
113
+ form_params = {}
114
+
115
+ # http body (model)
116
+ post_body = @api_client.object_to_http_body(request)
117
+ auth_names = ['Apikey']
118
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => 'ValidateUrlResponseSyntaxOnly')
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "API called: DomainApi#domain_get_top_level_domain_from_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+ # Check a URL for Phishing threats
131
+ # Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
132
+ # @param request Input URL request
133
+ # @param [Hash] opts the optional parameters
134
+ # @return [PhishingCheckResponse]
135
+ def domain_phishing_check(request, opts = {})
136
+ data, _status_code, _headers = domain_phishing_check_with_http_info(request, opts)
137
+ data
138
+ end
139
+
140
+ # Check a URL for Phishing threats
141
+ # Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
142
+ # @param request Input URL request
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [Array<(PhishingCheckResponse, Fixnum, Hash)>] PhishingCheckResponse data, response status code and response headers
145
+ def domain_phishing_check_with_http_info(request, opts = {})
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug 'Calling API: DomainApi.domain_phishing_check ...'
148
+ end
149
+ # verify the required parameter 'request' is set
150
+ if @api_client.config.client_side_validation && request.nil?
151
+ fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_phishing_check"
152
+ end
153
+ # resource path
154
+ local_var_path = '/validate/domain/url/phishing-threat-check'
155
+
156
+ # query parameters
157
+ query_params = {}
158
+
159
+ # header parameters
160
+ header_params = {}
161
+ # HTTP header 'Accept' (if needed)
162
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
163
+ # HTTP header 'Content-Type'
164
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
165
+
166
+ # form parameters
167
+ form_params = {}
168
+
169
+ # http body (model)
170
+ post_body = @api_client.object_to_http_body(request)
171
+ auth_names = ['Apikey']
172
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
173
+ :header_params => header_params,
174
+ :query_params => query_params,
175
+ :form_params => form_params,
176
+ :body => post_body,
177
+ :auth_names => auth_names,
178
+ :return_type => 'PhishingCheckResponse')
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug "API called: DomainApi#domain_phishing_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
181
+ end
182
+ return data, status_code, headers
183
+ end
76
184
  # Get WHOIS information for a domain
77
185
  # Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain's owners.
78
186
  # @param domain Domain name to check, for example \&quot;cloudmersive.com\&quot;. The input is a string so be sure to enclose it in double-quotes.
@@ -181,6 +289,168 @@ module CloudmersiveValidateApiClient
181
289
  end
182
290
  return data, status_code, headers
183
291
  end
292
+ # Check a URL for safety threats
293
+ # Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
294
+ # @param request Input URL request
295
+ # @param [Hash] opts the optional parameters
296
+ # @return [UrlSafetyCheckResponseFull]
297
+ def domain_safety_check(request, opts = {})
298
+ data, _status_code, _headers = domain_safety_check_with_http_info(request, opts)
299
+ data
300
+ end
301
+
302
+ # Check a URL for safety threats
303
+ # Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
304
+ # @param request Input URL request
305
+ # @param [Hash] opts the optional parameters
306
+ # @return [Array<(UrlSafetyCheckResponseFull, Fixnum, Hash)>] UrlSafetyCheckResponseFull data, response status code and response headers
307
+ def domain_safety_check_with_http_info(request, opts = {})
308
+ if @api_client.config.debugging
309
+ @api_client.config.logger.debug 'Calling API: DomainApi.domain_safety_check ...'
310
+ end
311
+ # verify the required parameter 'request' is set
312
+ if @api_client.config.client_side_validation && request.nil?
313
+ fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_safety_check"
314
+ end
315
+ # resource path
316
+ local_var_path = '/validate/domain/url/safety-threat-check'
317
+
318
+ # query parameters
319
+ query_params = {}
320
+
321
+ # header parameters
322
+ header_params = {}
323
+ # HTTP header 'Accept' (if needed)
324
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
325
+ # HTTP header 'Content-Type'
326
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
327
+
328
+ # form parameters
329
+ form_params = {}
330
+
331
+ # http body (model)
332
+ post_body = @api_client.object_to_http_body(request)
333
+ auth_names = ['Apikey']
334
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
335
+ :header_params => header_params,
336
+ :query_params => query_params,
337
+ :form_params => form_params,
338
+ :body => post_body,
339
+ :auth_names => auth_names,
340
+ :return_type => 'UrlSafetyCheckResponseFull')
341
+ if @api_client.config.debugging
342
+ @api_client.config.logger.debug "API called: DomainApi#domain_safety_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
343
+ end
344
+ return data, status_code, headers
345
+ end
346
+ # Check a URL for SSRF threats
347
+ # Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
348
+ # @param request Input URL request
349
+ # @param [Hash] opts the optional parameters
350
+ # @return [UrlSsrfResponseFull]
351
+ def domain_ssrf_check(request, opts = {})
352
+ data, _status_code, _headers = domain_ssrf_check_with_http_info(request, opts)
353
+ data
354
+ end
355
+
356
+ # Check a URL for SSRF threats
357
+ # Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
358
+ # @param request Input URL request
359
+ # @param [Hash] opts the optional parameters
360
+ # @return [Array<(UrlSsrfResponseFull, Fixnum, Hash)>] UrlSsrfResponseFull data, response status code and response headers
361
+ def domain_ssrf_check_with_http_info(request, opts = {})
362
+ if @api_client.config.debugging
363
+ @api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check ...'
364
+ end
365
+ # verify the required parameter 'request' is set
366
+ if @api_client.config.client_side_validation && request.nil?
367
+ fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_ssrf_check"
368
+ end
369
+ # resource path
370
+ local_var_path = '/validate/domain/url/ssrf-threat-check'
371
+
372
+ # query parameters
373
+ query_params = {}
374
+
375
+ # header parameters
376
+ header_params = {}
377
+ # HTTP header 'Accept' (if needed)
378
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
379
+ # HTTP header 'Content-Type'
380
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
381
+
382
+ # form parameters
383
+ form_params = {}
384
+
385
+ # http body (model)
386
+ post_body = @api_client.object_to_http_body(request)
387
+ auth_names = ['Apikey']
388
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
389
+ :header_params => header_params,
390
+ :query_params => query_params,
391
+ :form_params => form_params,
392
+ :body => post_body,
393
+ :auth_names => auth_names,
394
+ :return_type => 'UrlSsrfResponseFull')
395
+ if @api_client.config.debugging
396
+ @api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
397
+ end
398
+ return data, status_code, headers
399
+ end
400
+ # Check a URL for SSRF threats in batches
401
+ # Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
402
+ # @param request Input URL request as a batch of multiple URLs
403
+ # @param [Hash] opts the optional parameters
404
+ # @return [UrlSsrfResponseBatch]
405
+ def domain_ssrf_check_batch(request, opts = {})
406
+ data, _status_code, _headers = domain_ssrf_check_batch_with_http_info(request, opts)
407
+ data
408
+ end
409
+
410
+ # Check a URL for SSRF threats in batches
411
+ # Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
412
+ # @param request Input URL request as a batch of multiple URLs
413
+ # @param [Hash] opts the optional parameters
414
+ # @return [Array<(UrlSsrfResponseBatch, Fixnum, Hash)>] UrlSsrfResponseBatch data, response status code and response headers
415
+ def domain_ssrf_check_batch_with_http_info(request, opts = {})
416
+ if @api_client.config.debugging
417
+ @api_client.config.logger.debug 'Calling API: DomainApi.domain_ssrf_check_batch ...'
418
+ end
419
+ # verify the required parameter 'request' is set
420
+ if @api_client.config.client_side_validation && request.nil?
421
+ fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_ssrf_check_batch"
422
+ end
423
+ # resource path
424
+ local_var_path = '/validate/domain/url/ssrf-threat-check/batch'
425
+
426
+ # query parameters
427
+ query_params = {}
428
+
429
+ # header parameters
430
+ header_params = {}
431
+ # HTTP header 'Accept' (if needed)
432
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
433
+ # HTTP header 'Content-Type'
434
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
435
+
436
+ # form parameters
437
+ form_params = {}
438
+
439
+ # http body (model)
440
+ post_body = @api_client.object_to_http_body(request)
441
+ auth_names = ['Apikey']
442
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
443
+ :header_params => header_params,
444
+ :query_params => query_params,
445
+ :form_params => form_params,
446
+ :body => post_body,
447
+ :auth_names => auth_names,
448
+ :return_type => 'UrlSsrfResponseBatch')
449
+ if @api_client.config.debugging
450
+ @api_client.config.logger.debug "API called: DomainApi#domain_ssrf_check_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
451
+ end
452
+ return data, status_code, headers
453
+ end
184
454
  # Validate a URL fully
185
455
  # Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.
186
456
  # @param request Input URL request
@@ -73,6 +73,114 @@ module CloudmersiveValidateApiClient
73
73
  end
74
74
  return data, status_code, headers
75
75
  end
76
+ # Get intelligence on an IP address
77
+ # 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.
78
+ # @param 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.
79
+ # @param [Hash] opts the optional parameters
80
+ # @return [IPIntelligenceResponse]
81
+ def i_p_address_ip_intelligence(value, opts = {})
82
+ data, _status_code, _headers = i_p_address_ip_intelligence_with_http_info(value, opts)
83
+ data
84
+ end
85
+
86
+ # Get intelligence on an IP address
87
+ # 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.
88
+ # @param 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.
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(IPIntelligenceResponse, Fixnum, Hash)>] IPIntelligenceResponse data, response status code and response headers
91
+ def i_p_address_ip_intelligence_with_http_info(value, opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_ip_intelligence ...'
94
+ end
95
+ # verify the required parameter 'value' is set
96
+ if @api_client.config.client_side_validation && value.nil?
97
+ fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_ip_intelligence"
98
+ end
99
+ # resource path
100
+ local_var_path = '/validate/ip/intelligence'
101
+
102
+ # query parameters
103
+ query_params = {}
104
+
105
+ # header parameters
106
+ header_params = {}
107
+ # HTTP header 'Accept' (if needed)
108
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
109
+ # HTTP header 'Content-Type'
110
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
111
+
112
+ # form parameters
113
+ form_params = {}
114
+
115
+ # http body (model)
116
+ post_body = @api_client.object_to_http_body(value)
117
+ auth_names = ['Apikey']
118
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => 'IPIntelligenceResponse')
125
+ if @api_client.config.debugging
126
+ @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_ip_intelligence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
127
+ end
128
+ return data, status_code, headers
129
+ end
130
+ # Check if IP address is a Bot client
131
+ # 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..
132
+ # @param 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.
133
+ # @param [Hash] opts the optional parameters
134
+ # @return [BotCheckResponse]
135
+ def i_p_address_is_bot(value, opts = {})
136
+ data, _status_code, _headers = i_p_address_is_bot_with_http_info(value, opts)
137
+ data
138
+ end
139
+
140
+ # Check if IP address is a Bot client
141
+ # 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..
142
+ # @param 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.
143
+ # @param [Hash] opts the optional parameters
144
+ # @return [Array<(BotCheckResponse, Fixnum, Hash)>] BotCheckResponse data, response status code and response headers
145
+ def i_p_address_is_bot_with_http_info(value, opts = {})
146
+ if @api_client.config.debugging
147
+ @api_client.config.logger.debug 'Calling API: IPAddressApi.i_p_address_is_bot ...'
148
+ end
149
+ # verify the required parameter 'value' is set
150
+ if @api_client.config.client_side_validation && value.nil?
151
+ fail ArgumentError, "Missing the required parameter 'value' when calling IPAddressApi.i_p_address_is_bot"
152
+ end
153
+ # resource path
154
+ local_var_path = '/validate/ip/is-bot'
155
+
156
+ # query parameters
157
+ query_params = {}
158
+
159
+ # header parameters
160
+ header_params = {}
161
+ # HTTP header 'Accept' (if needed)
162
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
163
+ # HTTP header 'Content-Type'
164
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
165
+
166
+ # form parameters
167
+ form_params = {}
168
+
169
+ # http body (model)
170
+ post_body = @api_client.object_to_http_body(value)
171
+ auth_names = ['Apikey']
172
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
173
+ :header_params => header_params,
174
+ :query_params => query_params,
175
+ :form_params => form_params,
176
+ :body => post_body,
177
+ :auth_names => auth_names,
178
+ :return_type => 'BotCheckResponse')
179
+ if @api_client.config.debugging
180
+ @api_client.config.logger.debug "API called: IPAddressApi#i_p_address_is_bot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
181
+ end
182
+ return data, status_code, headers
183
+ end
76
184
  # Check if IP address is a known threat
77
185
  # 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.
78
186
  # @param 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.