cloudmersive-validate-api-client 2.2.2 → 2.2.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +12 -5
- data/docs/DomainApi.md +59 -4
- data/docs/EmailLead.md +8 -0
- data/docs/HtmlSsrfDetectionResult.md +9 -0
- data/docs/LeadEnrichmentApi.md +53 -0
- data/docs/TextInputApi.md +55 -0
- data/docs/UrlHtmlSsrfRequestFull.md +8 -0
- data/docs/UrlHtmlSsrfResponseFull.md +9 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +58 -4
- data/lib/cloudmersive-validate-api-client/api/lead_enrichment_api.rb +52 -0
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/models/email_lead.rb +184 -0
- data/lib/cloudmersive-validate-api-client/models/html_ssrf_detection_result.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/url_html_ssrf_request_full.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/url_html_ssrf_response_full.rb +196 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/lib/cloudmersive-validate-api-client.rb +4 -0
- data/spec/api/domain_api_spec.rb +14 -2
- data/spec/api/lead_enrichment_api_spec.rb +11 -0
- data/spec/api/text_input_api_spec.rb +12 -0
- data/spec/models/email_lead_spec.rb +41 -0
- data/spec/models/html_ssrf_detection_result_spec.rb +47 -0
- data/spec/models/url_html_ssrf_request_full_spec.rb +41 -0
- data/spec/models/url_html_ssrf_response_full_spec.rb +47 -0
- metadata +14 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6eced1f0005e1d25a42ac4809b4112292bae4c750b285795d22761339fb79eeb
|
4
|
+
data.tar.gz: 726969fc56bee4cf40921619f06479c8b304e293d23ffeff7c79cb735fba504d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: fc16b7c25e271cd03544a8acab8e311201361ee55228da1180f7614ec8db0a39b7851c5fcafdbb776eaee13251c192f468e97c05a7b9c863e4b56b229d9ad6b1
|
7
|
+
data.tar.gz: 3dbad4a9baac018d5fce20f23a1a10a764f80ccd60fafc7f201c217253d3ba17d83282007bb9af07bb3d2b8645b3d595f85f46abfd56e08e1a493aa19ed7436b
|
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.2.
|
10
|
+
- Package version: 2.2.5
|
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.2.
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.2.5.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.5.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.2.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.2.5'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -103,7 +103,7 @@ 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 server administration path
|
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
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
|
108
108
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
109
109
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
@@ -111,6 +111,7 @@ Class | Method | HTTP request | Description
|
|
111
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
|
112
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
|
113
113
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
114
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_html_ssrf_check**](docs/DomainApi.md#domain_url_html_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check/html-embedded | Check a URL for HTML embedded SSRF threats
|
114
115
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
115
116
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
|
116
117
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
@@ -123,12 +124,14 @@ Class | Method | HTTP request | Description
|
|
123
124
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
124
125
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_reverse_domain_lookup**](docs/IPAddressApi.md#i_p_address_reverse_domain_lookup) | **POST** /validate/ip/reverse-domain-lookup | Perform a reverse domain name (DNS) lookup on an IP address
|
125
126
|
*CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_enrich_lead**](docs/LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
|
127
|
+
*CloudmersiveValidateApiClient::LeadEnrichmentApi* | [**lead_enrichment_get_company_information**](docs/LeadEnrichmentApi.md#lead_enrichment_get_company_information) | **POST** /validate/lead-enrichment/lead/email/company-information | Get company information from email address
|
126
128
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
127
129
|
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
128
130
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
129
131
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
130
132
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
131
133
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
134
|
+
*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
|
132
135
|
*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
|
133
136
|
*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
|
134
137
|
*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
|
@@ -153,6 +156,7 @@ Class | Method | HTTP request | Description
|
|
153
156
|
- [CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest](docs/DateTimeStandardizedParseRequest.md)
|
154
157
|
- [CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse](docs/DateTimeStandardizedParseResponse.md)
|
155
158
|
- [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
|
159
|
+
- [CloudmersiveValidateApiClient::EmailLead](docs/EmailLead.md)
|
156
160
|
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
157
161
|
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
158
162
|
- [CloudmersiveValidateApiClient::FullEmailValidationResponse](docs/FullEmailValidationResponse.md)
|
@@ -165,6 +169,7 @@ Class | Method | HTTP request | Description
|
|
165
169
|
- [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
|
166
170
|
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
167
171
|
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
172
|
+
- [CloudmersiveValidateApiClient::HtmlSsrfDetectionResult](docs/HtmlSsrfDetectionResult.md)
|
168
173
|
- [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
|
169
174
|
- [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
|
170
175
|
- [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
|
@@ -190,6 +195,8 @@ Class | Method | HTTP request | Description
|
|
190
195
|
- [CloudmersiveValidateApiClient::SqlInjectionDetectionResult](docs/SqlInjectionDetectionResult.md)
|
191
196
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
192
197
|
- [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
|
198
|
+
- [CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull](docs/UrlHtmlSsrfRequestFull.md)
|
199
|
+
- [CloudmersiveValidateApiClient::UrlHtmlSsrfResponseFull](docs/UrlHtmlSsrfResponseFull.md)
|
193
200
|
- [CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull](docs/UrlSafetyCheckRequestFull.md)
|
194
201
|
- [CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull](docs/UrlSafetyCheckResponseFull.md)
|
195
202
|
- [CloudmersiveValidateApiClient::UrlSsrfRequestBatch](docs/UrlSsrfRequestBatch.md)
|
data/docs/DomainApi.md
CHANGED
@@ -6,7 +6,7 @@ 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 server administration path
|
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
10
|
[**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
|
11
11
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
12
12
|
[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
14
14
|
[**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
15
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
|
16
16
|
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
17
|
+
[**domain_url_html_ssrf_check**](DomainApi.md#domain_url_html_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check/html-embedded | Check a URL for HTML embedded SSRF threats
|
17
18
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
18
19
|
|
19
20
|
|
@@ -128,9 +129,9 @@ Name | Type | Description | Notes
|
|
128
129
|
# **domain_is_admin_path**
|
129
130
|
> IsAdminPathResponse domain_is_admin_path(value)
|
130
131
|
|
131
|
-
Check if path is a high-risk server administration path
|
132
|
+
Check if path is a high-risk or vulnerable server administration path
|
132
133
|
|
133
|
-
Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
|
134
|
+
Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.
|
134
135
|
|
135
136
|
### Example
|
136
137
|
```ruby
|
@@ -150,7 +151,7 @@ value = 'value_example' # String | URL or relative path to check, e.g. \"/admin/
|
|
150
151
|
|
151
152
|
|
152
153
|
begin
|
153
|
-
#Check if path is a high-risk server administration path
|
154
|
+
#Check if path is a high-risk or vulnerable server administration path
|
154
155
|
result = api_instance.domain_is_admin_path(value)
|
155
156
|
p result
|
156
157
|
rescue CloudmersiveValidateApiClient::ApiError => e
|
@@ -557,6 +558,60 @@ Name | Type | Description | Notes
|
|
557
558
|
|
558
559
|
|
559
560
|
|
561
|
+
# **domain_url_html_ssrf_check**
|
562
|
+
> UrlHtmlSsrfResponseFull domain_url_html_ssrf_check(request)
|
563
|
+
|
564
|
+
Check a URL for HTML embedded SSRF threats
|
565
|
+
|
566
|
+
Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.
|
567
|
+
|
568
|
+
### Example
|
569
|
+
```ruby
|
570
|
+
# load the gem
|
571
|
+
require 'cloudmersive-validate-api-client'
|
572
|
+
# setup authorization
|
573
|
+
CloudmersiveValidateApiClient.configure do |config|
|
574
|
+
# Configure API key authorization: Apikey
|
575
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
576
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
577
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
578
|
+
end
|
579
|
+
|
580
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
581
|
+
|
582
|
+
request = CloudmersiveValidateApiClient::UrlHtmlSsrfRequestFull.new # UrlHtmlSsrfRequestFull | Input URL request
|
583
|
+
|
584
|
+
|
585
|
+
begin
|
586
|
+
#Check a URL for HTML embedded SSRF threats
|
587
|
+
result = api_instance.domain_url_html_ssrf_check(request)
|
588
|
+
p result
|
589
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
590
|
+
puts "Exception when calling DomainApi->domain_url_html_ssrf_check: #{e}"
|
591
|
+
end
|
592
|
+
```
|
593
|
+
|
594
|
+
### Parameters
|
595
|
+
|
596
|
+
Name | Type | Description | Notes
|
597
|
+
------------- | ------------- | ------------- | -------------
|
598
|
+
**request** | [**UrlHtmlSsrfRequestFull**](UrlHtmlSsrfRequestFull.md)| Input URL request |
|
599
|
+
|
600
|
+
### Return type
|
601
|
+
|
602
|
+
[**UrlHtmlSsrfResponseFull**](UrlHtmlSsrfResponseFull.md)
|
603
|
+
|
604
|
+
### Authorization
|
605
|
+
|
606
|
+
[Apikey](../README.md#Apikey)
|
607
|
+
|
608
|
+
### HTTP request headers
|
609
|
+
|
610
|
+
- **Content-Type**: application/json, text/json
|
611
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
612
|
+
|
613
|
+
|
614
|
+
|
560
615
|
# **domain_url_syntax_only**
|
561
616
|
> ValidateUrlResponseSyntaxOnly domain_url_syntax_only(request)
|
562
617
|
|
data/docs/EmailLead.md
ADDED
@@ -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
|
+
|
data/docs/LeadEnrichmentApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**lead_enrichment_enrich_lead**](LeadEnrichmentApi.md#lead_enrichment_enrich_lead) | **POST** /validate/lead-enrichment/lead/enrich | Enrich an input lead with additional fields of data
|
8
|
+
[**lead_enrichment_get_company_information**](LeadEnrichmentApi.md#lead_enrichment_get_company_information) | **POST** /validate/lead-enrichment/lead/email/company-information | Get company information from email address
|
8
9
|
|
9
10
|
|
10
11
|
# **lead_enrichment_enrich_lead**
|
@@ -59,3 +60,55 @@ Name | Type | Description | Notes
|
|
59
60
|
|
60
61
|
|
61
62
|
|
63
|
+
# **lead_enrichment_get_company_information**
|
64
|
+
> LeadEnrichmentResponse lead_enrichment_get_company_information(request)
|
65
|
+
|
66
|
+
Get company information from email address
|
67
|
+
|
68
|
+
### Example
|
69
|
+
```ruby
|
70
|
+
# load the gem
|
71
|
+
require 'cloudmersive-validate-api-client'
|
72
|
+
# setup authorization
|
73
|
+
CloudmersiveValidateApiClient.configure do |config|
|
74
|
+
# Configure API key authorization: Apikey
|
75
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
76
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
77
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
78
|
+
end
|
79
|
+
|
80
|
+
api_instance = CloudmersiveValidateApiClient::LeadEnrichmentApi.new
|
81
|
+
|
82
|
+
request = CloudmersiveValidateApiClient::EmailLead.new # EmailLead | Input email address lead
|
83
|
+
|
84
|
+
|
85
|
+
begin
|
86
|
+
#Get company information from email address
|
87
|
+
result = api_instance.lead_enrichment_get_company_information(request)
|
88
|
+
p result
|
89
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
90
|
+
puts "Exception when calling LeadEnrichmentApi->lead_enrichment_get_company_information: #{e}"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
### Parameters
|
95
|
+
|
96
|
+
Name | Type | Description | Notes
|
97
|
+
------------- | ------------- | ------------- | -------------
|
98
|
+
**request** | [**EmailLead**](EmailLead.md)| Input email address lead |
|
99
|
+
|
100
|
+
### Return type
|
101
|
+
|
102
|
+
[**LeadEnrichmentResponse**](LeadEnrichmentResponse.md)
|
103
|
+
|
104
|
+
### Authorization
|
105
|
+
|
106
|
+
[Apikey](../README.md#Apikey)
|
107
|
+
|
108
|
+
### HTTP request headers
|
109
|
+
|
110
|
+
- **Content-Type**: application/json, text/json
|
111
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
112
|
+
|
113
|
+
|
114
|
+
|
data/docs/TextInputApi.md
CHANGED
@@ -4,6 +4,7 @@ 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
|
7
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
|
8
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
|
9
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
|
@@ -13,6 +14,60 @@ Method | HTTP request | Description
|
|
13
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
|
14
15
|
|
15
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
|
+
|
16
71
|
# **text_input_check_sql_injection**
|
17
72
|
> SqlInjectionDetectionResult text_input_check_sql_injection(value, opts)
|
18
73
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UrlHtmlSsrfResponseFull
|
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 an SSRF threat or attack | [optional]
|
7
|
+
**http_response_code** | **Integer** | HTTP response code from the URL | [optional]
|
8
|
+
|
9
|
+
|
@@ -127,8 +127,8 @@ module CloudmersiveValidateApiClient
|
|
127
127
|
end
|
128
128
|
return data, status_code, headers
|
129
129
|
end
|
130
|
-
# Check if path is a high-risk server administration path
|
131
|
-
# Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
|
130
|
+
# Check if path is a high-risk or vulnerable server administration path
|
131
|
+
# Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.
|
132
132
|
# @param value URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes.
|
133
133
|
# @param [Hash] opts the optional parameters
|
134
134
|
# @return [IsAdminPathResponse]
|
@@ -137,8 +137,8 @@ module CloudmersiveValidateApiClient
|
|
137
137
|
data
|
138
138
|
end
|
139
139
|
|
140
|
-
# Check if path is a high-risk server administration path
|
141
|
-
# Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
|
140
|
+
# Check if path is a high-risk or vulnerable server administration path
|
141
|
+
# Check if the input URL or relative path is a server Administration Path, and therefore a risk or vulnerability for remote access.
|
142
142
|
# @param value URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes.
|
143
143
|
# @param [Hash] opts the optional parameters
|
144
144
|
# @return [Array<(IsAdminPathResponse, Fixnum, Hash)>] IsAdminPathResponse data, response status code and response headers
|
@@ -559,6 +559,60 @@ module CloudmersiveValidateApiClient
|
|
559
559
|
end
|
560
560
|
return data, status_code, headers
|
561
561
|
end
|
562
|
+
# Check a URL for HTML embedded SSRF threats
|
563
|
+
# Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.
|
564
|
+
# @param request Input URL request
|
565
|
+
# @param [Hash] opts the optional parameters
|
566
|
+
# @return [UrlHtmlSsrfResponseFull]
|
567
|
+
def domain_url_html_ssrf_check(request, opts = {})
|
568
|
+
data, _status_code, _headers = domain_url_html_ssrf_check_with_http_info(request, opts)
|
569
|
+
data
|
570
|
+
end
|
571
|
+
|
572
|
+
# Check a URL for HTML embedded SSRF threats
|
573
|
+
# Checks if an input URL HTML is at risk of containing one or more embedded SSRF (Server-side request forgery) threats or attacks.
|
574
|
+
# @param request Input URL request
|
575
|
+
# @param [Hash] opts the optional parameters
|
576
|
+
# @return [Array<(UrlHtmlSsrfResponseFull, Fixnum, Hash)>] UrlHtmlSsrfResponseFull data, response status code and response headers
|
577
|
+
def domain_url_html_ssrf_check_with_http_info(request, opts = {})
|
578
|
+
if @api_client.config.debugging
|
579
|
+
@api_client.config.logger.debug 'Calling API: DomainApi.domain_url_html_ssrf_check ...'
|
580
|
+
end
|
581
|
+
# verify the required parameter 'request' is set
|
582
|
+
if @api_client.config.client_side_validation && request.nil?
|
583
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling DomainApi.domain_url_html_ssrf_check"
|
584
|
+
end
|
585
|
+
# resource path
|
586
|
+
local_var_path = '/validate/domain/url/ssrf-threat-check/html-embedded'
|
587
|
+
|
588
|
+
# query parameters
|
589
|
+
query_params = {}
|
590
|
+
|
591
|
+
# header parameters
|
592
|
+
header_params = {}
|
593
|
+
# HTTP header 'Accept' (if needed)
|
594
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
595
|
+
# HTTP header 'Content-Type'
|
596
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
597
|
+
|
598
|
+
# form parameters
|
599
|
+
form_params = {}
|
600
|
+
|
601
|
+
# http body (model)
|
602
|
+
post_body = @api_client.object_to_http_body(request)
|
603
|
+
auth_names = ['Apikey']
|
604
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
605
|
+
:header_params => header_params,
|
606
|
+
:query_params => query_params,
|
607
|
+
:form_params => form_params,
|
608
|
+
:body => post_body,
|
609
|
+
:auth_names => auth_names,
|
610
|
+
:return_type => 'UrlHtmlSsrfResponseFull')
|
611
|
+
if @api_client.config.debugging
|
612
|
+
@api_client.config.logger.debug "API called: DomainApi#domain_url_html_ssrf_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
613
|
+
end
|
614
|
+
return data, status_code, headers
|
615
|
+
end
|
562
616
|
# Validate a URL syntactically
|
563
617
|
# Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.
|
564
618
|
# @param request Input URL information
|
@@ -71,5 +71,57 @@ module CloudmersiveValidateApiClient
|
|
71
71
|
end
|
72
72
|
return data, status_code, headers
|
73
73
|
end
|
74
|
+
# Get company information from email address
|
75
|
+
# @param request Input email address lead
|
76
|
+
# @param [Hash] opts the optional parameters
|
77
|
+
# @return [LeadEnrichmentResponse]
|
78
|
+
def lead_enrichment_get_company_information(request, opts = {})
|
79
|
+
data, _status_code, _headers = lead_enrichment_get_company_information_with_http_info(request, opts)
|
80
|
+
data
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get company information from email address
|
84
|
+
# @param request Input email address lead
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @return [Array<(LeadEnrichmentResponse, Fixnum, Hash)>] LeadEnrichmentResponse data, response status code and response headers
|
87
|
+
def lead_enrichment_get_company_information_with_http_info(request, opts = {})
|
88
|
+
if @api_client.config.debugging
|
89
|
+
@api_client.config.logger.debug 'Calling API: LeadEnrichmentApi.lead_enrichment_get_company_information ...'
|
90
|
+
end
|
91
|
+
# verify the required parameter 'request' is set
|
92
|
+
if @api_client.config.client_side_validation && request.nil?
|
93
|
+
fail ArgumentError, "Missing the required parameter 'request' when calling LeadEnrichmentApi.lead_enrichment_get_company_information"
|
94
|
+
end
|
95
|
+
# resource path
|
96
|
+
local_var_path = '/validate/lead-enrichment/lead/email/company-information'
|
97
|
+
|
98
|
+
# query parameters
|
99
|
+
query_params = {}
|
100
|
+
|
101
|
+
# header parameters
|
102
|
+
header_params = {}
|
103
|
+
# HTTP header 'Accept' (if needed)
|
104
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
105
|
+
# HTTP header 'Content-Type'
|
106
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
107
|
+
|
108
|
+
# form parameters
|
109
|
+
form_params = {}
|
110
|
+
|
111
|
+
# http body (model)
|
112
|
+
post_body = @api_client.object_to_http_body(request)
|
113
|
+
auth_names = ['Apikey']
|
114
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
115
|
+
:header_params => header_params,
|
116
|
+
:query_params => query_params,
|
117
|
+
:form_params => form_params,
|
118
|
+
:body => post_body,
|
119
|
+
:auth_names => auth_names,
|
120
|
+
:return_type => 'LeadEnrichmentResponse')
|
121
|
+
if @api_client.config.debugging
|
122
|
+
@api_client.config.logger.debug "API called: LeadEnrichmentApi#lead_enrichment_get_company_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
123
|
+
end
|
124
|
+
return data, status_code, headers
|
125
|
+
end
|
74
126
|
end
|
75
127
|
end
|
@@ -19,6 +19,60 @@ module CloudmersiveValidateApiClient
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Protect html input from Server-side Request Forgery (SSRF) attacks
|
23
|
+
# 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.
|
24
|
+
# @param value User-facing HTML input.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [HtmlSsrfDetectionResult]
|
27
|
+
def text_input_check_html_ssrf(value, opts = {})
|
28
|
+
data, _status_code, _headers = text_input_check_html_ssrf_with_http_info(value, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Protect html input from Server-side Request Forgery (SSRF) attacks
|
33
|
+
# 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.
|
34
|
+
# @param value User-facing HTML input.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(HtmlSsrfDetectionResult, Fixnum, Hash)>] HtmlSsrfDetectionResult data, response status code and response headers
|
37
|
+
def text_input_check_html_ssrf_with_http_info(value, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: TextInputApi.text_input_check_html_ssrf ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'value' is set
|
42
|
+
if @api_client.config.client_side_validation && value.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'value' when calling TextInputApi.text_input_check_html_ssrf"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/validate/text-input/html/check/ssrf'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
|
57
|
+
|
58
|
+
# form parameters
|
59
|
+
form_params = {}
|
60
|
+
|
61
|
+
# http body (model)
|
62
|
+
post_body = @api_client.object_to_http_body(value)
|
63
|
+
auth_names = ['Apikey']
|
64
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
65
|
+
:header_params => header_params,
|
66
|
+
:query_params => query_params,
|
67
|
+
:form_params => form_params,
|
68
|
+
:body => post_body,
|
69
|
+
:auth_names => auth_names,
|
70
|
+
:return_type => 'HtmlSsrfDetectionResult')
|
71
|
+
if @api_client.config.debugging
|
72
|
+
@api_client.config.logger.debug "API called: TextInputApi#text_input_check_html_ssrf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
73
|
+
end
|
74
|
+
return data, status_code, headers
|
75
|
+
end
|
22
76
|
# Check text input for SQL Injection (SQLI) attacks
|
23
77
|
# Detects SQL Injection (SQLI) attacks from text input.
|
24
78
|
# @param value User-facing text input.
|