cloudmersive-validate-api-client 1.3.2 → 1.3.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -9
- data/cloudmersive-validate-api-client.gemspec +1 -1
- data/docs/AddressApi.md +63 -0
- data/docs/AddressGetServersResponse.md +2 -2
- data/docs/DomainApi.md +110 -0
- data/docs/FullEmailValidationResponse.md +2 -0
- data/docs/NameApi.md +55 -0
- data/docs/ParseAddressRequest.md +9 -0
- data/docs/ParseAddressResponse.md +15 -0
- data/docs/UserAgentApi.md +63 -0
- data/docs/UserAgentValidateRequest.md +8 -0
- data/docs/UserAgentValidateResponse.md +21 -0
- data/docs/ValidateIdentifierRequest.md +15 -0
- data/docs/ValidateIdentifierResponse.md +9 -0
- data/docs/ValidateUrlRequestFull.md +8 -0
- data/docs/ValidateUrlRequestSyntaxOnly.md +8 -0
- data/docs/ValidateUrlResponseFull.md +12 -0
- data/docs/ValidateUrlResponseSyntaxOnly.md +9 -0
- data/docs/VatLookupRequest.md +1 -1
- data/docs/VatLookupResponse.md +5 -5
- data/lib/cloudmersive-validate-api-client.rb +13 -1
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +78 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +111 -1
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/name_api.rb +56 -1
- data/lib/cloudmersive-validate-api-client/api/phone_number_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api/user_agent_api.rb +78 -0
- data/lib/cloudmersive-validate-api-client/api/vat_api.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api_client.rb +1 -1
- data/lib/cloudmersive-validate-api-client/api_error.rb +1 -1
- data/lib/cloudmersive-validate-api-client/configuration.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/address_get_servers_response.rb +3 -1
- data/lib/cloudmersive-validate-api-client/models/address_verify_syntax_only_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/check_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/first_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/full_email_validation_response.rb +25 -5
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/full_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_gender_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_gender_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/last_name_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/parse_address_request.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/parse_address_response.rb +259 -0
- data/lib/cloudmersive-validate-api-client/models/phone_number_validate_request.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/phone_number_validation_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_request.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb +319 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_request.rb +259 -0
- data/lib/cloudmersive-validate-api-client/models/validate_identifier_response.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_full.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_request_syntax_only.rb +189 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_full.rb +229 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +199 -0
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_request.rb +2 -1
- data/lib/cloudmersive-validate-api-client/models/vat_lookup_response.rb +6 -1
- data/lib/cloudmersive-validate-api-client/models/whois_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/version.rb +2 -2
- data/spec/api/address_api_spec.rb +47 -0
- data/spec/api/domain_api_spec.rb +25 -1
- data/spec/api/email_api_spec.rb +1 -1
- data/spec/api/ip_address_api_spec.rb +1 -1
- data/spec/api/name_api_spec.rb +13 -1
- data/spec/api/phone_number_api_spec.rb +1 -1
- data/spec/api/user_agent_api_spec.rb +47 -0
- data/spec/api/vat_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/address_get_servers_response_spec.rb +1 -1
- data/spec/models/address_verify_syntax_only_response_spec.rb +1 -1
- data/spec/models/check_response_spec.rb +1 -1
- data/spec/models/first_name_validation_request_spec.rb +1 -1
- data/spec/models/first_name_validation_response_spec.rb +1 -1
- data/spec/models/full_email_validation_response_spec.rb +13 -1
- data/spec/models/full_name_validation_request_spec.rb +1 -1
- data/spec/models/full_name_validation_response_spec.rb +1 -1
- data/spec/models/geolocate_response_spec.rb +1 -1
- data/spec/models/get_gender_request_spec.rb +1 -1
- data/spec/models/get_gender_response_spec.rb +1 -1
- data/spec/models/last_name_validation_request_spec.rb +1 -1
- data/spec/models/last_name_validation_response_spec.rb +1 -1
- data/spec/models/parse_address_request_spec.rb +48 -0
- data/spec/models/parse_address_response_spec.rb +84 -0
- data/spec/models/phone_number_validate_request_spec.rb +1 -1
- data/spec/models/phone_number_validation_response_spec.rb +1 -1
- data/spec/models/user_agent_validate_request_spec.rb +42 -0
- data/spec/models/user_agent_validate_response_spec.rb +120 -0
- data/spec/models/validate_identifier_request_spec.rb +84 -0
- data/spec/models/validate_identifier_response_spec.rb +48 -0
- data/spec/models/validate_url_request_full_spec.rb +42 -0
- data/spec/models/validate_url_request_syntax_only_spec.rb +42 -0
- data/spec/models/validate_url_response_full_spec.rb +66 -0
- data/spec/models/validate_url_response_syntax_only_spec.rb +48 -0
- data/spec/models/vat_lookup_request_spec.rb +1 -1
- data/spec/models/vat_lookup_response_spec.rb +1 -1
- data/spec/models/whois_response_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +51 -16
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e6f26be0b3362767667fe698407688872c59b0a2463bfae60d206edecbb785ac
|
4
|
+
data.tar.gz: 6330ac5d1ab93155b4ddc3c5408034a2b2df0d0aa5ac390bb93f0b0683258be7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5e1f9c00dce06668b21f3dd359b660f8bb08121d04390dd11cededef5b91935cda7ba9f911244e4c10f2f6560789bb54ea6ece008792a95ea6bb58c4999faf21
|
7
|
+
data.tar.gz: c1c9daac46befe30649f2a04ea95e0720b07b75d27ab4e5142b15999cc12b284e87af465de39edf055572f4e23ecb9d1c4172bfda0f48d01c91a726d2a9270b6
|
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: 1.3.
|
10
|
+
- Package version: 1.3.7
|
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-1.3.
|
26
|
+
gem install ./cloudmersive-validate-api-client-1.3.7.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-1.3.7.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', '~> 1.3.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 1.3.7'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -62,17 +62,17 @@ CloudmersiveValidateApiClient.configure do |config|
|
|
62
62
|
#config.api_key_prefix['Apikey'] = 'Bearer'
|
63
63
|
end
|
64
64
|
|
65
|
-
api_instance = CloudmersiveValidateApiClient::
|
65
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
66
66
|
|
67
|
-
|
67
|
+
input = CloudmersiveValidateApiClient::ParseAddressRequest.new # ParseAddressRequest | Input parse request
|
68
68
|
|
69
69
|
|
70
70
|
begin
|
71
|
-
#
|
72
|
-
result = api_instance.
|
71
|
+
#Parse an unstructured input text string into an international, formatted address
|
72
|
+
result = api_instance.address_parse_string(input)
|
73
73
|
p result
|
74
74
|
rescue CloudmersiveValidateApiClient::ApiError => e
|
75
|
-
puts "Exception when calling
|
75
|
+
puts "Exception when calling AddressApi->address_parse_string: #{e}"
|
76
76
|
end
|
77
77
|
|
78
78
|
```
|
@@ -83,17 +83,22 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
83
83
|
|
84
84
|
Class | Method | HTTP request | Description
|
85
85
|
------------ | ------------- | ------------- | -------------
|
86
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_parse_string**](docs/AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
86
87
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
87
88
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
89
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
90
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
88
91
|
*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
|
89
92
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
90
93
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
91
94
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
92
95
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
96
|
+
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
93
97
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_first_name**](docs/NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
94
98
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
95
99
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
96
100
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
101
|
+
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
97
102
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Lookup a VAT code
|
98
103
|
|
99
104
|
|
@@ -112,8 +117,18 @@ Class | Method | HTTP request | Description
|
|
112
117
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
113
118
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
114
119
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
120
|
+
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
121
|
+
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
115
122
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
116
123
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
124
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
125
|
+
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
126
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierRequest](docs/ValidateIdentifierRequest.md)
|
127
|
+
- [CloudmersiveValidateApiClient::ValidateIdentifierResponse](docs/ValidateIdentifierResponse.md)
|
128
|
+
- [CloudmersiveValidateApiClient::ValidateUrlRequestFull](docs/ValidateUrlRequestFull.md)
|
129
|
+
- [CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly](docs/ValidateUrlRequestSyntaxOnly.md)
|
130
|
+
- [CloudmersiveValidateApiClient::ValidateUrlResponseFull](docs/ValidateUrlResponseFull.md)
|
131
|
+
- [CloudmersiveValidateApiClient::ValidateUrlResponseSyntaxOnly](docs/ValidateUrlResponseSyntaxOnly.md)
|
117
132
|
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
118
133
|
- [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
|
119
134
|
- [CloudmersiveValidateApiClient::WhoisResponse](docs/WhoisResponse.md)
|
data/docs/AddressApi.md
ADDED
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::AddressApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
8
|
+
|
9
|
+
|
10
|
+
# **address_parse_string**
|
11
|
+
> ParseAddressResponse address_parse_string(input)
|
12
|
+
|
13
|
+
Parse an unstructured input text string into an international, formatted address
|
14
|
+
|
15
|
+
Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-validate-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveValidateApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
30
|
+
|
31
|
+
input = CloudmersiveValidateApiClient::ParseAddressRequest.new # ParseAddressRequest | Input parse request
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Parse an unstructured input text string into an international, formatted address
|
36
|
+
result = api_instance.address_parse_string(input)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
39
|
+
puts "Exception when calling AddressApi->address_parse_string: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**input** | [**ParseAddressRequest**](ParseAddressRequest.md)| Input parse request |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**ParseAddressResponse**](ParseAddressResponse.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**success** | **BOOLEAN** |
|
7
|
-
**servers** | **Array<String>** |
|
6
|
+
**success** | **BOOLEAN** | True if partial address validation was successufl, false otherwise | [optional]
|
7
|
+
**servers** | **Array<String>** | Email servers for this email address | [optional]
|
8
8
|
|
9
9
|
|
data/docs/DomainApi.md
CHANGED
@@ -6,6 +6,8 @@ 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_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
9
|
+
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
10
|
+
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
9
11
|
|
10
12
|
|
11
13
|
# **domain_check**
|
@@ -116,3 +118,111 @@ Name | Type | Description | Notes
|
|
116
118
|
|
117
119
|
|
118
120
|
|
121
|
+
# **domain_url_full**
|
122
|
+
> ValidateUrlResponseFull domain_url_full(request)
|
123
|
+
|
124
|
+
Validate a URL fully
|
125
|
+
|
126
|
+
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.
|
127
|
+
|
128
|
+
### Example
|
129
|
+
```ruby
|
130
|
+
# load the gem
|
131
|
+
require 'cloudmersive-validate-api-client'
|
132
|
+
# setup authorization
|
133
|
+
CloudmersiveValidateApiClient.configure do |config|
|
134
|
+
# Configure API key authorization: Apikey
|
135
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
136
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
137
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
138
|
+
end
|
139
|
+
|
140
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
141
|
+
|
142
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestFull.new # ValidateUrlRequestFull |
|
143
|
+
|
144
|
+
|
145
|
+
begin
|
146
|
+
#Validate a URL fully
|
147
|
+
result = api_instance.domain_url_full(request)
|
148
|
+
p result
|
149
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
150
|
+
puts "Exception when calling DomainApi->domain_url_full: #{e}"
|
151
|
+
end
|
152
|
+
```
|
153
|
+
|
154
|
+
### Parameters
|
155
|
+
|
156
|
+
Name | Type | Description | Notes
|
157
|
+
------------- | ------------- | ------------- | -------------
|
158
|
+
**request** | [**ValidateUrlRequestFull**](ValidateUrlRequestFull.md)| |
|
159
|
+
|
160
|
+
### Return type
|
161
|
+
|
162
|
+
[**ValidateUrlResponseFull**](ValidateUrlResponseFull.md)
|
163
|
+
|
164
|
+
### Authorization
|
165
|
+
|
166
|
+
[Apikey](../README.md#Apikey)
|
167
|
+
|
168
|
+
### HTTP request headers
|
169
|
+
|
170
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
171
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
# **domain_url_syntax_only**
|
176
|
+
> ValidateUrlResponseSyntaxOnly domain_url_syntax_only(request)
|
177
|
+
|
178
|
+
Validate a URL syntactically
|
179
|
+
|
180
|
+
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.
|
181
|
+
|
182
|
+
### Example
|
183
|
+
```ruby
|
184
|
+
# load the gem
|
185
|
+
require 'cloudmersive-validate-api-client'
|
186
|
+
# setup authorization
|
187
|
+
CloudmersiveValidateApiClient.configure do |config|
|
188
|
+
# Configure API key authorization: Apikey
|
189
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
190
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
191
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
192
|
+
end
|
193
|
+
|
194
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
195
|
+
|
196
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly |
|
197
|
+
|
198
|
+
|
199
|
+
begin
|
200
|
+
#Validate a URL syntactically
|
201
|
+
result = api_instance.domain_url_syntax_only(request)
|
202
|
+
p result
|
203
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
204
|
+
puts "Exception when calling DomainApi->domain_url_syntax_only: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
Name | Type | Description | Notes
|
211
|
+
------------- | ------------- | ------------- | -------------
|
212
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| |
|
213
|
+
|
214
|
+
### Return type
|
215
|
+
|
216
|
+
[**ValidateUrlResponseSyntaxOnly**](ValidateUrlResponseSyntaxOnly.md)
|
217
|
+
|
218
|
+
### Authorization
|
219
|
+
|
220
|
+
[Apikey](../README.md#Apikey)
|
221
|
+
|
222
|
+
### HTTP request headers
|
223
|
+
|
224
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
225
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
226
|
+
|
227
|
+
|
228
|
+
|
@@ -10,5 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**valid_smtp** | **BOOLEAN** | True if the email address was verified by the remote server, false otherwise. This is one component of ValidAddress, but not the only one. | [optional]
|
11
11
|
**is_catchall_domain** | **BOOLEAN** | True if the domain is a catch-all domain name, false otherwise. Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails. Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time. | [optional]
|
12
12
|
**domain** | **String** | Domain name of the email address | [optional]
|
13
|
+
**is_free_email_provider** | **BOOLEAN** | True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise. | [optional]
|
14
|
+
**is_disposable** | **BOOLEAN** | True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there. | [optional]
|
13
15
|
|
14
16
|
|
data/docs/NameApi.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
|
[**name_get_gender**](NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
8
|
+
[**name_identifier**](NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
8
9
|
[**name_validate_first_name**](NameApi.md#name_validate_first_name) | **POST** /validate/name/first | Validate a first name
|
9
10
|
[**name_validate_full_name**](NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
10
11
|
[**name_validate_last_name**](NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
@@ -64,6 +65,60 @@ Name | Type | Description | Notes
|
|
64
65
|
|
65
66
|
|
66
67
|
|
68
|
+
# **name_identifier**
|
69
|
+
> ValidateIdentifierResponse name_identifier(input)
|
70
|
+
|
71
|
+
Validate a code identifier
|
72
|
+
|
73
|
+
Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be \"helloWorld\" but not \"hello*World\".
|
74
|
+
|
75
|
+
### Example
|
76
|
+
```ruby
|
77
|
+
# load the gem
|
78
|
+
require 'cloudmersive-validate-api-client'
|
79
|
+
# setup authorization
|
80
|
+
CloudmersiveValidateApiClient.configure do |config|
|
81
|
+
# Configure API key authorization: Apikey
|
82
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
83
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
85
|
+
end
|
86
|
+
|
87
|
+
api_instance = CloudmersiveValidateApiClient::NameApi.new
|
88
|
+
|
89
|
+
input = CloudmersiveValidateApiClient::ValidateIdentifierRequest.new # ValidateIdentifierRequest | Identifier validation request information
|
90
|
+
|
91
|
+
|
92
|
+
begin
|
93
|
+
#Validate a code identifier
|
94
|
+
result = api_instance.name_identifier(input)
|
95
|
+
p result
|
96
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
97
|
+
puts "Exception when calling NameApi->name_identifier: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
### Parameters
|
102
|
+
|
103
|
+
Name | Type | Description | Notes
|
104
|
+
------------- | ------------- | ------------- | -------------
|
105
|
+
**input** | [**ValidateIdentifierRequest**](ValidateIdentifierRequest.md)| Identifier validation request information |
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
[**ValidateIdentifierResponse**](ValidateIdentifierResponse.md)
|
110
|
+
|
111
|
+
### Authorization
|
112
|
+
|
113
|
+
[Apikey](../README.md#Apikey)
|
114
|
+
|
115
|
+
### HTTP request headers
|
116
|
+
|
117
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
118
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
119
|
+
|
120
|
+
|
121
|
+
|
67
122
|
# **name_validate_first_name**
|
68
123
|
> FirstNameValidationResponse name_validate_first_name(input)
|
69
124
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ParseAddressRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**address_string** | **String** | A mailing address or street address formatted as a single text string; this will be parsed into its components | [optional]
|
7
|
+
**capitalization_mode** | **String** | Optional; indicates how the parsed output should be capitalized; default is Title Case; possible values are: \"Uppercase\" will set the capitalization to UPPER CASE; \"Lowercase\" will set the capitalization to lower case; \"Titlecase\" will set the capitalization to Title Case; and \"Originalcase\" will preserve the original casing as much as possible | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::ParseAddressResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if the parsing operation was successful, false otherwise | [optional]
|
7
|
+
**building** | **String** | The name of the building, house or structure if applicable, such as \"Cloudmersive Building 2\". This will often by null. | [optional]
|
8
|
+
**street_number** | **String** | The street number or house number of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"1600\". This value will typically be populated for most addresses. | [optional]
|
9
|
+
**street** | **String** | The name of the street or road of the address. For example, in the address \"1600 Pennsylvania Avenue NW\" the street number would be \"Pennsylvania Avenue NW\". | [optional]
|
10
|
+
**city** | **String** | The city of the address. | [optional]
|
11
|
+
**state_or_province** | **String** | The state or province of the address. | [optional]
|
12
|
+
**postal_code** | **String** | The postal code or zip code of the address. | [optional]
|
13
|
+
**country** | **String** | Country of the address, if present in the address. If not included in the address it will be null. | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::UserAgentApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**user_agent_parse**](UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
8
|
+
|
9
|
+
|
10
|
+
# **user_agent_parse**
|
11
|
+
> UserAgentValidateResponse user_agent_parse(request)
|
12
|
+
|
13
|
+
Parse an HTTP User-Agent string, identify robots
|
14
|
+
|
15
|
+
Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'cloudmersive-validate-api-client'
|
21
|
+
# setup authorization
|
22
|
+
CloudmersiveValidateApiClient.configure do |config|
|
23
|
+
# Configure API key authorization: Apikey
|
24
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = CloudmersiveValidateApiClient::UserAgentApi.new
|
30
|
+
|
31
|
+
request = CloudmersiveValidateApiClient::UserAgentValidateRequest.new # UserAgentValidateRequest | Input parse request
|
32
|
+
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Parse an HTTP User-Agent string, identify robots
|
36
|
+
result = api_instance.user_agent_parse(request)
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
39
|
+
puts "Exception when calling UserAgentApi->user_agent_parse: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
Name | Type | Description | Notes
|
46
|
+
------------- | ------------- | ------------- | -------------
|
47
|
+
**request** | [**UserAgentValidateRequest**](UserAgentValidateRequest.md)| Input parse request |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**UserAgentValidateResponse**](UserAgentValidateResponse.md)
|
52
|
+
|
53
|
+
### Authorization
|
54
|
+
|
55
|
+
[Apikey](../README.md#Apikey)
|
56
|
+
|
57
|
+
### HTTP request headers
|
58
|
+
|
59
|
+
- **Content-Type**: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
|
60
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
61
|
+
|
62
|
+
|
63
|
+
|