cloudmersive-validate-api-client 2.1.6 → 2.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +26 -4
  3. data/docs/DomainApi.md +165 -0
  4. data/docs/HtmlSsrfDetectionResult.md +9 -0
  5. data/docs/IsAdminPathResponse.md +9 -0
  6. data/docs/PhishingCheckRequest.md +8 -0
  7. data/docs/PhishingCheckResponse.md +9 -0
  8. data/docs/SqlInjectionCheckBatchRequest.md +9 -0
  9. data/docs/SqlInjectionCheckBatchResponse.md +8 -0
  10. data/docs/SqlInjectionCheckRequestItem.md +8 -0
  11. data/docs/SqlInjectionDetectionResult.md +10 -0
  12. data/docs/TextInputApi.md +288 -1
  13. data/docs/UrlSafetyCheckRequestFull.md +8 -0
  14. data/docs/UrlSafetyCheckResponseFull.md +9 -0
  15. data/docs/XxeDetectionBatchRequest.md +8 -0
  16. data/docs/XxeDetectionBatchResponse.md +8 -0
  17. data/docs/XxeDetectionRequestItem.md +11 -0
  18. data/docs/XxeDetectionResult.md +9 -0
  19. data/lib/cloudmersive-validate-api-client.rb +14 -0
  20. data/lib/cloudmersive-validate-api-client/api/domain_api.rb +162 -0
  21. data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +284 -2
  22. data/lib/cloudmersive-validate-api-client/models/html_ssrf_detection_result.rb +196 -0
  23. data/lib/cloudmersive-validate-api-client/models/is_admin_path_response.rb +196 -0
  24. data/lib/cloudmersive-validate-api-client/models/phishing_check_request.rb +186 -0
  25. data/lib/cloudmersive-validate-api-client/models/phishing_check_response.rb +196 -0
  26. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
  27. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
  28. data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
  29. data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
  30. data/lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb +186 -0
  31. data/lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb +196 -0
  32. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_request.rb +188 -0
  33. data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_response.rb +188 -0
  34. data/lib/cloudmersive-validate-api-client/models/xxe_detection_request_item.rb +220 -0
  35. data/lib/cloudmersive-validate-api-client/models/xxe_detection_result.rb +196 -0
  36. data/lib/cloudmersive-validate-api-client/version.rb +1 -1
  37. data/spec/api/domain_api_spec.rb +36 -0
  38. data/spec/api/text_input_api_spec.rb +65 -1
  39. data/spec/models/html_ssrf_detection_result_spec.rb +47 -0
  40. data/spec/models/is_admin_path_response_spec.rb +47 -0
  41. data/spec/models/phishing_check_request_spec.rb +41 -0
  42. data/spec/models/phishing_check_response_spec.rb +47 -0
  43. data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
  44. data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
  45. data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
  46. data/spec/models/sql_injection_detection_result_spec.rb +53 -0
  47. data/spec/models/url_safety_check_request_full_spec.rb +41 -0
  48. data/spec/models/url_safety_check_response_full_spec.rb +47 -0
  49. data/spec/models/xxe_detection_batch_request_spec.rb +41 -0
  50. data/spec/models/xxe_detection_batch_response_spec.rb +41 -0
  51. data/spec/models/xxe_detection_request_item_spec.rb +59 -0
  52. data/spec/models/xxe_detection_result_spec.rb +47 -0
  53. metadata +44 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: afffb6db20490e6875a2912aae61a195e915e7f227a408a19b8dfc8116bf8c97
4
- data.tar.gz: bd4588635ccdea19658f9cf1becebc2f21fe7316c73a2439a3438719c5d1570a
3
+ metadata.gz: 2fb56107e866366c0bbe0cb0406b1a577b4ecd93769850a24144912c942ca33c
4
+ data.tar.gz: 79013bc0deb6aadca1c1c17bac8d78bcbfbbb2012d4619f797cee37928d3861f
5
5
  SHA512:
6
- metadata.gz: 8e4bb3b1b307b45ee352fd353330b5fb40c2eae83e6de7731936fb8f929e704a836f019dbd152926595cd31cafeb6226972d2c32466ce4ed2a0108391bfc567b
7
- data.tar.gz: cf5ed08ccb9440cfcc3ccb1ce2ff197a63e1e6b9adc5893381d77d1e1041c6a57ea1a27800fba11dcd95a2225cfe6dc5bddc8935f6159b57e0044b8476ddefcf
6
+ metadata.gz: 43fd253ae8999d42507d0fe7a8fbf5aeb2b43891b21cb2d53d16c4a1584ccfda4a6aa9f91457b5600dbc2e2180d90cccf2f5a00b106078b9187a3400061292b8
7
+ data.tar.gz: 0d0456435a45f680ed768b49b778b50cd72115f8da1515374ac369e0008d64cc6ec84bc717516ccf0db0b93a3028cba1f4b449caee45ed06b7d34c7965f92d48
data/README.md CHANGED
@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.1.6
10
+ - Package version: 2.2.3
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-validate-api-client-2.1.6.gem
26
+ gem install ./cloudmersive-validate-api-client-2.2.3.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.6.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.3.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-validate-api-client', '~> 2.1.6'
34
+ gem 'cloudmersive-validate-api-client', '~> 2.2.3'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -103,8 +103,11 @@ Class | Method | HTTP request | Description
103
103
  *CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_standard_date_time**](docs/DateTimeApi.md#date_time_parse_standard_date_time) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
104
104
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
105
105
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_get_top_level_domain_from_url**](docs/DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
106
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_is_admin_path**](docs/DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk or vulnerable server administration path
107
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_phishing_check**](docs/DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
106
108
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
107
109
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
110
+ *CloudmersiveValidateApiClient::DomainApi* | [**domain_safety_check**](docs/DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
108
111
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check**](docs/DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
109
112
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check_batch**](docs/DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
110
113
  *CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
@@ -126,8 +129,13 @@ Class | Method | HTTP request | Description
126
129
  *CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
127
130
  *CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
128
131
  *CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
132
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_html_ssrf**](docs/TextInputApi.md#text_input_check_html_ssrf) | **POST** /validate/text-input/html/check/ssrf | Protect html input from Server-side Request Forgery (SSRF) attacks
133
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection**](docs/TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
134
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection_batch**](docs/TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
129
135
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss**](docs/TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
130
136
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss_batch**](docs/TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
137
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe**](docs/TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
138
+ *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe_batch**](docs/TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
131
139
  *CloudmersiveValidateApiClient::TextInputApi* | [**text_input_protect_xss**](docs/TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
132
140
  *CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
133
141
  *CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
@@ -158,9 +166,11 @@ Class | Method | HTTP request | Description
158
166
  - [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
159
167
  - [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
160
168
  - [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
169
+ - [CloudmersiveValidateApiClient::HtmlSsrfDetectionResult](docs/HtmlSsrfDetectionResult.md)
161
170
  - [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
162
171
  - [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
163
172
  - [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
173
+ - [CloudmersiveValidateApiClient::IsAdminPathResponse](docs/IsAdminPathResponse.md)
164
174
  - [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
165
175
  - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
166
176
  - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
@@ -168,14 +178,22 @@ Class | Method | HTTP request | Description
168
178
  - [CloudmersiveValidateApiClient::NormalizeAddressResponse](docs/NormalizeAddressResponse.md)
169
179
  - [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
170
180
  - [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
181
+ - [CloudmersiveValidateApiClient::PhishingCheckRequest](docs/PhishingCheckRequest.md)
182
+ - [CloudmersiveValidateApiClient::PhishingCheckResponse](docs/PhishingCheckResponse.md)
171
183
  - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
172
184
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
173
185
  - [CloudmersiveValidateApiClient::PublicHolidayOccurrence](docs/PublicHolidayOccurrence.md)
174
186
  - [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
175
187
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
176
188
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
189
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest](docs/SqlInjectionCheckBatchRequest.md)
190
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse](docs/SqlInjectionCheckBatchResponse.md)
191
+ - [CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem](docs/SqlInjectionCheckRequestItem.md)
192
+ - [CloudmersiveValidateApiClient::SqlInjectionDetectionResult](docs/SqlInjectionDetectionResult.md)
177
193
  - [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
178
194
  - [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
195
+ - [CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull](docs/UrlSafetyCheckRequestFull.md)
196
+ - [CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull](docs/UrlSafetyCheckResponseFull.md)
179
197
  - [CloudmersiveValidateApiClient::UrlSsrfRequestBatch](docs/UrlSsrfRequestBatch.md)
180
198
  - [CloudmersiveValidateApiClient::UrlSsrfRequestFull](docs/UrlSsrfRequestFull.md)
181
199
  - [CloudmersiveValidateApiClient::UrlSsrfResponseBatch](docs/UrlSsrfResponseBatch.md)
@@ -205,6 +223,10 @@ Class | Method | HTTP request | Description
205
223
  - [CloudmersiveValidateApiClient::XssProtectionBatchResponse](docs/XssProtectionBatchResponse.md)
206
224
  - [CloudmersiveValidateApiClient::XssProtectionRequestItem](docs/XssProtectionRequestItem.md)
207
225
  - [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
226
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchRequest](docs/XxeDetectionBatchRequest.md)
227
+ - [CloudmersiveValidateApiClient::XxeDetectionBatchResponse](docs/XxeDetectionBatchResponse.md)
228
+ - [CloudmersiveValidateApiClient::XxeDetectionRequestItem](docs/XxeDetectionRequestItem.md)
229
+ - [CloudmersiveValidateApiClient::XxeDetectionResult](docs/XxeDetectionResult.md)
208
230
 
209
231
 
210
232
  ## Documentation for Authorization
data/docs/DomainApi.md CHANGED
@@ -6,8 +6,11 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
8
8
  [**domain_get_top_level_domain_from_url**](DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
9
+ [**domain_is_admin_path**](DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk or vulnerable server administration path
10
+ [**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
9
11
  [**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
10
12
  [**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
13
+ [**domain_safety_check**](DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
11
14
  [**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
12
15
  [**domain_ssrf_check_batch**](DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
13
16
  [**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
@@ -122,6 +125,114 @@ Name | Type | Description | Notes
122
125
 
123
126
 
124
127
 
128
+ # **domain_is_admin_path**
129
+ > IsAdminPathResponse domain_is_admin_path(value)
130
+
131
+ Check if path is a high-risk or vulnerable server administration path
132
+
133
+ Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.
134
+
135
+ ### Example
136
+ ```ruby
137
+ # load the gem
138
+ require 'cloudmersive-validate-api-client'
139
+ # setup authorization
140
+ CloudmersiveValidateApiClient.configure do |config|
141
+ # Configure API key authorization: Apikey
142
+ config.api_key['Apikey'] = 'YOUR API KEY'
143
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
144
+ #config.api_key_prefix['Apikey'] = 'Bearer'
145
+ end
146
+
147
+ api_instance = CloudmersiveValidateApiClient::DomainApi.new
148
+
149
+ value = 'value_example' # String | URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes.
150
+
151
+
152
+ begin
153
+ #Check if path is a high-risk or vulnerable server administration path
154
+ result = api_instance.domain_is_admin_path(value)
155
+ p result
156
+ rescue CloudmersiveValidateApiClient::ApiError => e
157
+ puts "Exception when calling DomainApi->domain_is_admin_path: #{e}"
158
+ end
159
+ ```
160
+
161
+ ### Parameters
162
+
163
+ Name | Type | Description | Notes
164
+ ------------- | ------------- | ------------- | -------------
165
+ **value** | **String**| URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes. |
166
+
167
+ ### Return type
168
+
169
+ [**IsAdminPathResponse**](IsAdminPathResponse.md)
170
+
171
+ ### Authorization
172
+
173
+ [Apikey](../README.md#Apikey)
174
+
175
+ ### HTTP request headers
176
+
177
+ - **Content-Type**: application/json, text/json
178
+ - **Accept**: application/json, text/json, application/xml, text/xml
179
+
180
+
181
+
182
+ # **domain_phishing_check**
183
+ > PhishingCheckResponse domain_phishing_check(request)
184
+
185
+ Check a URL for Phishing threats
186
+
187
+ 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.
188
+
189
+ ### Example
190
+ ```ruby
191
+ # load the gem
192
+ require 'cloudmersive-validate-api-client'
193
+ # setup authorization
194
+ CloudmersiveValidateApiClient.configure do |config|
195
+ # Configure API key authorization: Apikey
196
+ config.api_key['Apikey'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ #config.api_key_prefix['Apikey'] = 'Bearer'
199
+ end
200
+
201
+ api_instance = CloudmersiveValidateApiClient::DomainApi.new
202
+
203
+ request = CloudmersiveValidateApiClient::PhishingCheckRequest.new # PhishingCheckRequest | Input URL request
204
+
205
+
206
+ begin
207
+ #Check a URL for Phishing threats
208
+ result = api_instance.domain_phishing_check(request)
209
+ p result
210
+ rescue CloudmersiveValidateApiClient::ApiError => e
211
+ puts "Exception when calling DomainApi->domain_phishing_check: #{e}"
212
+ end
213
+ ```
214
+
215
+ ### Parameters
216
+
217
+ Name | Type | Description | Notes
218
+ ------------- | ------------- | ------------- | -------------
219
+ **request** | [**PhishingCheckRequest**](PhishingCheckRequest.md)| Input URL request |
220
+
221
+ ### Return type
222
+
223
+ [**PhishingCheckResponse**](PhishingCheckResponse.md)
224
+
225
+ ### Authorization
226
+
227
+ [Apikey](../README.md#Apikey)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: application/json, text/json
232
+ - **Accept**: application/json, text/json, application/xml, text/xml
233
+
234
+
235
+
125
236
  # **domain_post**
126
237
  > WhoisResponse domain_post(domain)
127
238
 
@@ -230,6 +341,60 @@ Name | Type | Description | Notes
230
341
 
231
342
 
232
343
 
344
+ # **domain_safety_check**
345
+ > UrlSafetyCheckResponseFull domain_safety_check(request)
346
+
347
+ Check a URL for safety threats
348
+
349
+ Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
350
+
351
+ ### Example
352
+ ```ruby
353
+ # load the gem
354
+ require 'cloudmersive-validate-api-client'
355
+ # setup authorization
356
+ CloudmersiveValidateApiClient.configure do |config|
357
+ # Configure API key authorization: Apikey
358
+ config.api_key['Apikey'] = 'YOUR API KEY'
359
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
360
+ #config.api_key_prefix['Apikey'] = 'Bearer'
361
+ end
362
+
363
+ api_instance = CloudmersiveValidateApiClient::DomainApi.new
364
+
365
+ request = CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull.new # UrlSafetyCheckRequestFull | Input URL request
366
+
367
+
368
+ begin
369
+ #Check a URL for safety threats
370
+ result = api_instance.domain_safety_check(request)
371
+ p result
372
+ rescue CloudmersiveValidateApiClient::ApiError => e
373
+ puts "Exception when calling DomainApi->domain_safety_check: #{e}"
374
+ end
375
+ ```
376
+
377
+ ### Parameters
378
+
379
+ Name | Type | Description | Notes
380
+ ------------- | ------------- | ------------- | -------------
381
+ **request** | [**UrlSafetyCheckRequestFull**](UrlSafetyCheckRequestFull.md)| Input URL request |
382
+
383
+ ### Return type
384
+
385
+ [**UrlSafetyCheckResponseFull**](UrlSafetyCheckResponseFull.md)
386
+
387
+ ### Authorization
388
+
389
+ [Apikey](../README.md#Apikey)
390
+
391
+ ### HTTP request headers
392
+
393
+ - **Content-Type**: application/json, text/json
394
+ - **Accept**: application/json, text/json, application/xml, text/xml
395
+
396
+
397
+
233
398
  # **domain_ssrf_check**
234
399
  > UrlSsrfResponseFull domain_ssrf_check(request)
235
400
 
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::HtmlSsrfDetectionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **contained_threats** | **BOOLEAN** | True if the input contained SSRF threats, false otherwise | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::IsAdminPathResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **is_admin_path_node** | **BOOLEAN** | True if the input IP address is an Admin Path, and false otherwise | [optional]
7
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::PhishingCheckRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **url** | **String** | URL to validate | [optional]
7
+
8
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::PhishingCheckResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **clean_url** | **BOOLEAN** | True if the URL is clean, false if it is at risk of containing a Phishing threat or attack | [optional]
7
+ **threat_type** | **String** | Threat type of the Phishing threat; possible values are VerifiedPhishingURL, UnverifiedPhishingURL, or VerifiedPhishingDomain | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **request_items** | [**Array<SqlInjectionCheckRequestItem>**](SqlInjectionCheckRequestItem.md) | Multiple items to detect for SQL Injection | [optional]
7
+ **detection_level** | **String** | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended). | [optional]
8
+
9
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **result_items** | [**Array<SqlInjectionDetectionResult>**](SqlInjectionDetectionResult.md) | Results from performing a batch SQL Injection detection operation; order is preserved from input data | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **input_text** | **String** | Individual input text item to check for SQL Injection | [optional]
7
+
8
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveValidateApiClient::SqlInjectionDetectionResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **contained_sql_injection_attack** | **BOOLEAN** | True if the input contained SQL Injection attacks, false otherwise | [optional]
8
+ **original_input** | **String** | Original input string | [optional]
9
+
10
+
data/docs/TextInputApi.md CHANGED
@@ -4,11 +4,182 @@ All URIs are relative to *https://api.cloudmersive.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**text_input_check_html_ssrf**](TextInputApi.md#text_input_check_html_ssrf) | **POST** /validate/text-input/html/check/ssrf | Protect html input from Server-side Request Forgery (SSRF) attacks
8
+ [**text_input_check_sql_injection**](TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
9
+ [**text_input_check_sql_injection_batch**](TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
7
10
  [**text_input_check_xss**](TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
8
11
  [**text_input_check_xss_batch**](TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
12
+ [**text_input_check_xxe**](TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
13
+ [**text_input_check_xxe_batch**](TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
9
14
  [**text_input_protect_xss**](TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
10
15
 
11
16
 
17
+ # **text_input_check_html_ssrf**
18
+ > HtmlSsrfDetectionResult text_input_check_html_ssrf(value)
19
+
20
+ Protect html input from Server-side Request Forgery (SSRF) attacks
21
+
22
+ Detects SSRF (Server-side request forgery) attacks and unsafe URL attacks from HTML text input, where attackers can attempt to access unsafe local or network paths in the server environment by injecting them into HTML.
23
+
24
+ ### Example
25
+ ```ruby
26
+ # load the gem
27
+ require 'cloudmersive-validate-api-client'
28
+ # setup authorization
29
+ CloudmersiveValidateApiClient.configure do |config|
30
+ # Configure API key authorization: Apikey
31
+ config.api_key['Apikey'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ #config.api_key_prefix['Apikey'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
37
+
38
+ value = 'value_example' # String | User-facing HTML input.
39
+
40
+
41
+ begin
42
+ #Protect html input from Server-side Request Forgery (SSRF) attacks
43
+ result = api_instance.text_input_check_html_ssrf(value)
44
+ p result
45
+ rescue CloudmersiveValidateApiClient::ApiError => e
46
+ puts "Exception when calling TextInputApi->text_input_check_html_ssrf: #{e}"
47
+ end
48
+ ```
49
+
50
+ ### Parameters
51
+
52
+ Name | Type | Description | Notes
53
+ ------------- | ------------- | ------------- | -------------
54
+ **value** | **String**| User-facing HTML input. |
55
+
56
+ ### Return type
57
+
58
+ [**HtmlSsrfDetectionResult**](HtmlSsrfDetectionResult.md)
59
+
60
+ ### Authorization
61
+
62
+ [Apikey](../README.md#Apikey)
63
+
64
+ ### HTTP request headers
65
+
66
+ - **Content-Type**: application/json, text/json
67
+ - **Accept**: application/json, text/json, application/xml, text/xml
68
+
69
+
70
+
71
+ # **text_input_check_sql_injection**
72
+ > SqlInjectionDetectionResult text_input_check_sql_injection(value, opts)
73
+
74
+ Check text input for SQL Injection (SQLI) attacks
75
+
76
+ Detects SQL Injection (SQLI) attacks from text input.
77
+
78
+ ### Example
79
+ ```ruby
80
+ # load the gem
81
+ require 'cloudmersive-validate-api-client'
82
+ # setup authorization
83
+ CloudmersiveValidateApiClient.configure do |config|
84
+ # Configure API key authorization: Apikey
85
+ config.api_key['Apikey'] = 'YOUR API KEY'
86
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
87
+ #config.api_key_prefix['Apikey'] = 'Bearer'
88
+ end
89
+
90
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
91
+
92
+ value = 'value_example' # String | User-facing text input.
93
+
94
+ opts = {
95
+ detection_level: 'detection_level_example' # String | Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended).
96
+ }
97
+
98
+ begin
99
+ #Check text input for SQL Injection (SQLI) attacks
100
+ result = api_instance.text_input_check_sql_injection(value, opts)
101
+ p result
102
+ rescue CloudmersiveValidateApiClient::ApiError => e
103
+ puts "Exception when calling TextInputApi->text_input_check_sql_injection: #{e}"
104
+ end
105
+ ```
106
+
107
+ ### Parameters
108
+
109
+ Name | Type | Description | Notes
110
+ ------------- | ------------- | ------------- | -------------
111
+ **value** | **String**| User-facing text input. |
112
+ **detection_level** | **String**| Set to Normal to target a high-security SQL Injection detection level with a very low false positive rate; select High to target a very-high security SQL Injection detection level with higher false positives. Default is Normal (recommended). | [optional]
113
+
114
+ ### Return type
115
+
116
+ [**SqlInjectionDetectionResult**](SqlInjectionDetectionResult.md)
117
+
118
+ ### Authorization
119
+
120
+ [Apikey](../README.md#Apikey)
121
+
122
+ ### HTTP request headers
123
+
124
+ - **Content-Type**: application/json, text/json
125
+ - **Accept**: application/json, text/json, application/xml, text/xml
126
+
127
+
128
+
129
+ # **text_input_check_sql_injection_batch**
130
+ > SqlInjectionCheckBatchResponse text_input_check_sql_injection_batch(value)
131
+
132
+ Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
133
+
134
+ Detects SQL Injection (SQLI) attacks from multiple text inputs. Output preverses order of input items.
135
+
136
+ ### Example
137
+ ```ruby
138
+ # load the gem
139
+ require 'cloudmersive-validate-api-client'
140
+ # setup authorization
141
+ CloudmersiveValidateApiClient.configure do |config|
142
+ # Configure API key authorization: Apikey
143
+ config.api_key['Apikey'] = 'YOUR API KEY'
144
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
145
+ #config.api_key_prefix['Apikey'] = 'Bearer'
146
+ end
147
+
148
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
149
+
150
+ value = CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest.new # SqlInjectionCheckBatchRequest | User-facing text input.
151
+
152
+
153
+ begin
154
+ #Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
155
+ result = api_instance.text_input_check_sql_injection_batch(value)
156
+ p result
157
+ rescue CloudmersiveValidateApiClient::ApiError => e
158
+ puts "Exception when calling TextInputApi->text_input_check_sql_injection_batch: #{e}"
159
+ end
160
+ ```
161
+
162
+ ### Parameters
163
+
164
+ Name | Type | Description | Notes
165
+ ------------- | ------------- | ------------- | -------------
166
+ **value** | [**SqlInjectionCheckBatchRequest**](SqlInjectionCheckBatchRequest.md)| User-facing text input. |
167
+
168
+ ### Return type
169
+
170
+ [**SqlInjectionCheckBatchResponse**](SqlInjectionCheckBatchResponse.md)
171
+
172
+ ### Authorization
173
+
174
+ [Apikey](../README.md#Apikey)
175
+
176
+ ### HTTP request headers
177
+
178
+ - **Content-Type**: application/json, text/json
179
+ - **Accept**: application/json, text/json, application/xml, text/xml
180
+
181
+
182
+
12
183
  # **text_input_check_xss**
13
184
  > XssProtectionResult text_input_check_xss(value)
14
185
 
@@ -68,7 +239,7 @@ Name | Type | Description | Notes
68
239
 
69
240
  Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
70
241
 
71
- Detects XSS (Cross-Site-Scripting) attacks from multiple text input. Output preverses order of input items.
242
+ Detects XSS (Cross-Site-Scripting) attacks from multiple text inputs. Output preverses order of input items.
72
243
 
73
244
  ### Example
74
245
  ```ruby
@@ -117,6 +288,122 @@ Name | Type | Description | Notes
117
288
 
118
289
 
119
290
 
291
+ # **text_input_check_xxe**
292
+ > XxeDetectionResult text_input_check_xxe(value, opts)
293
+
294
+ Protect text input from XML External Entity (XXE) attacks
295
+
296
+ Detects XXE (XML External Entity) attacks from text input.
297
+
298
+ ### Example
299
+ ```ruby
300
+ # load the gem
301
+ require 'cloudmersive-validate-api-client'
302
+ # setup authorization
303
+ CloudmersiveValidateApiClient.configure do |config|
304
+ # Configure API key authorization: Apikey
305
+ config.api_key['Apikey'] = 'YOUR API KEY'
306
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
307
+ #config.api_key_prefix['Apikey'] = 'Bearer'
308
+ end
309
+
310
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
311
+
312
+ value = 'value_example' # String | User-facing text input.
313
+
314
+ opts = {
315
+ allow_internet_urls: true, # BOOLEAN | Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false.
316
+ known_safe_urls: 'known_safe_urls_example', # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe.
317
+ known_unsafe_urls: 'known_unsafe_urls_example' # String | Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe.
318
+ }
319
+
320
+ begin
321
+ #Protect text input from XML External Entity (XXE) attacks
322
+ result = api_instance.text_input_check_xxe(value, opts)
323
+ p result
324
+ rescue CloudmersiveValidateApiClient::ApiError => e
325
+ puts "Exception when calling TextInputApi->text_input_check_xxe: #{e}"
326
+ end
327
+ ```
328
+
329
+ ### Parameters
330
+
331
+ Name | Type | Description | Notes
332
+ ------------- | ------------- | ------------- | -------------
333
+ **value** | **String**| User-facing text input. |
334
+ **allow_internet_urls** | **BOOLEAN**| Optional: Set to true to allow Internet-based dependency URLs for DTDs and other XML External Entitites, set to false to block. Default is false. | [optional]
335
+ **known_safe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered safe. | [optional]
336
+ **known_unsafe_urls** | **String**| Optional: Comma separated list of fully-qualified URLs that will automatically be considered unsafe. | [optional]
337
+
338
+ ### Return type
339
+
340
+ [**XxeDetectionResult**](XxeDetectionResult.md)
341
+
342
+ ### Authorization
343
+
344
+ [Apikey](../README.md#Apikey)
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: application/json, text/json
349
+ - **Accept**: application/json, text/json, application/xml, text/xml
350
+
351
+
352
+
353
+ # **text_input_check_xxe_batch**
354
+ > XxeDetectionBatchResponse text_input_check_xxe_batch(request)
355
+
356
+ Protect text input from XML External Entity (XXE) attacks
357
+
358
+ Detects XXE (XML External Entity) attacks from text input.
359
+
360
+ ### Example
361
+ ```ruby
362
+ # load the gem
363
+ require 'cloudmersive-validate-api-client'
364
+ # setup authorization
365
+ CloudmersiveValidateApiClient.configure do |config|
366
+ # Configure API key authorization: Apikey
367
+ config.api_key['Apikey'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ #config.api_key_prefix['Apikey'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = CloudmersiveValidateApiClient::TextInputApi.new
373
+
374
+ request = CloudmersiveValidateApiClient::XxeDetectionBatchRequest.new # XxeDetectionBatchRequest |
375
+
376
+
377
+ begin
378
+ #Protect text input from XML External Entity (XXE) attacks
379
+ result = api_instance.text_input_check_xxe_batch(request)
380
+ p result
381
+ rescue CloudmersiveValidateApiClient::ApiError => e
382
+ puts "Exception when calling TextInputApi->text_input_check_xxe_batch: #{e}"
383
+ end
384
+ ```
385
+
386
+ ### Parameters
387
+
388
+ Name | Type | Description | Notes
389
+ ------------- | ------------- | ------------- | -------------
390
+ **request** | [**XxeDetectionBatchRequest**](XxeDetectionBatchRequest.md)| |
391
+
392
+ ### Return type
393
+
394
+ [**XxeDetectionBatchResponse**](XxeDetectionBatchResponse.md)
395
+
396
+ ### Authorization
397
+
398
+ [Apikey](../README.md#Apikey)
399
+
400
+ ### HTTP request headers
401
+
402
+ - **Content-Type**: application/json, text/json
403
+ - **Accept**: application/json, text/json, application/xml, text/xml
404
+
405
+
406
+
120
407
  # **text_input_protect_xss**
121
408
  > XssProtectionResult text_input_protect_xss(value)
122
409