cloudmersive-validate-api-client 2.1.0 → 2.1.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +32 -4
- data/docs/AddressApi.md +55 -0
- data/docs/BotCheckResponse.md +8 -0
- data/docs/DateTimeApi.md +222 -0
- data/docs/DateTimeNaturalLanguageParseRequest.md +8 -0
- data/docs/DateTimeNowResult.md +10 -0
- data/docs/DateTimeStandardizedParseRequest.md +9 -0
- data/docs/DateTimeStandardizedParseResponse.md +16 -0
- data/docs/DomainApi.md +3 -3
- data/docs/EmailApi.md +3 -3
- data/docs/GeolocateStreetAddressResponse.md +13 -0
- data/docs/GetPublicHolidaysRequest.md +9 -0
- data/docs/IPAddressApi.md +223 -3
- data/docs/IPIntelligenceResponse.md +16 -0
- data/docs/IPReverseDNSLookupResponse.md +9 -0
- data/docs/NormalizeAddressResponse.md +18 -0
- data/docs/PublicHolidayOccurrence.md +12 -0
- data/docs/PublicHolidaysResponse.md +9 -0
- data/docs/TextInputApi.md +173 -0
- data/docs/XssProtectionBatchRequest.md +8 -0
- data/docs/XssProtectionBatchResponse.md +8 -0
- data/docs/XssProtectionRequestItem.md +8 -0
- data/docs/XssProtectionResult.md +11 -0
- data/lib/cloudmersive-validate-api-client.rb +18 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/api/date_time_api.rb +231 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +219 -3
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +185 -0
- data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_natural_language_parse_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_now_result.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/geolocate_street_address_response.rb +236 -0
- data/lib/cloudmersive-validate-api-client/models/get_public_holidays_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/normalize_address_response.rb +286 -0
- data/lib/cloudmersive-validate-api-client/models/public_holiday_occurrence.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/public_holidays_response.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_batch_request.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_request_item.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_result.rb +216 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/address_api_spec.rb +12 -0
- data/spec/api/date_time_api_spec.rb +82 -0
- data/spec/api/ip_address_api_spec.rb +48 -0
- data/spec/api/text_input_api_spec.rb +71 -0
- data/spec/models/bot_check_response_spec.rb +41 -0
- data/spec/models/date_time_natural_language_parse_request_spec.rb +41 -0
- data/spec/models/date_time_now_result_spec.rb +53 -0
- data/spec/models/date_time_standardized_parse_request_spec.rb +47 -0
- data/spec/models/date_time_standardized_parse_response_spec.rb +89 -0
- data/spec/models/geolocate_street_address_response_spec.rb +71 -0
- data/spec/models/get_public_holidays_request_spec.rb +47 -0
- data/spec/models/ip_intelligence_response_spec.rb +89 -0
- data/spec/models/ip_reverse_dns_lookup_response_spec.rb +47 -0
- data/spec/models/normalize_address_response_spec.rb +101 -0
- data/spec/models/public_holiday_occurrence_spec.rb +65 -0
- data/spec/models/public_holidays_response_spec.rb +47 -0
- data/spec/models/xss_protection_batch_request_spec.rb +41 -0
- data/spec/models/xss_protection_batch_response_spec.rb +41 -0
- data/spec/models/xss_protection_request_item_spec.rb +41 -0
- data/spec/models/xss_protection_result_spec.rb +59 -0
- metadata +56 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4f896a47826183614618fd426ca8a512d17bdb280e1896d7028808b92e5745df
|
4
|
+
data.tar.gz: d0b93394baf070b8d91989afd8fd25bcd6419b13268c82a0a79338db62831b60
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a03bb74df4fd2297b9a17ba954b4d1bdde7d000e14beb289e06ba83008e998b6ec55f92325102e33b6b841f10ffc493cd58acd2cd06b3d42d400737c4df6db0d
|
7
|
+
data.tar.gz: 2a105cc05b48b0badedbdba89322982781b8b0ba5ea5ddd50cc98693f367594fdac80be03bd6a13e41c4fa6ce08bd100b2e57edc6ff1bf10614b4e1fc9d9698c
|
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.
|
10
|
+
- Package version: 2.1.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.1.
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.1.5.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.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.1.
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.1.5'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -90,12 +90,17 @@ Class | Method | HTTP request | Description
|
|
90
90
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_currency**](docs/AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
91
91
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_country_region**](docs/AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
|
92
92
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_get_timezone**](docs/AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
93
|
+
*CloudmersiveValidateApiClient::AddressApi* | [**address_normalize_address**](docs/AddressApi.md#address_normalize_address) | **POST** /validate/address/street-address/normalize | Normalize a street address
|
93
94
|
*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
|
94
95
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_reverse_geocode_address**](docs/AddressApi.md#address_reverse_geocode_address) | **POST** /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address
|
95
96
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
96
97
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_city**](docs/AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it
|
97
98
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_postal_code**](docs/AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it
|
98
99
|
*CloudmersiveValidateApiClient::AddressApi* | [**address_validate_state**](docs/AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it
|
100
|
+
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_get_now_simple**](docs/DateTimeApi.md#date_time_get_now_simple) | **GET** /validate/date-time/get/now | Get current date and time as of now
|
101
|
+
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_get_public_holidays**](docs/DateTimeApi.md#date_time_get_public_holidays) | **POST** /validate/date-time/get/holidays | Get public holidays in the specified country and year
|
102
|
+
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_natural_language_date_time**](docs/DateTimeApi.md#date_time_parse_natural_language_date_time) | **POST** /validate/date-time/parse/date-time/natural-language | Parses a free-form natural language date and time string into a date and time
|
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
|
99
104
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
100
105
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
101
106
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
@@ -104,9 +109,13 @@ Class | Method | HTTP request | Description
|
|
104
109
|
*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
|
105
110
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_full_validation**](docs/EmailApi.md#email_full_validation) | **POST** /validate/email/address/full | Fully validate an email address
|
106
111
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_post**](docs/EmailApi.md#email_post) | **POST** /validate/email/address/syntaxOnly | Validate email adddress for syntactic correctness only
|
112
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_geolocate_street_address**](docs/IPAddressApi.md#i_p_address_geolocate_street_address) | **POST** /validate/ip/geolocate/street-address | Geolocate an IP address to a street address
|
113
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_ip_intelligence**](docs/IPAddressApi.md#i_p_address_ip_intelligence) | **POST** /validate/ip/intelligence | Get intelligence on an IP address
|
114
|
+
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_bot**](docs/IPAddressApi.md#i_p_address_is_bot) | **POST** /validate/ip/is-bot | Check if IP address is a Bot client
|
107
115
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_threat**](docs/IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
|
108
116
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_is_tor_node**](docs/IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
|
109
117
|
*CloudmersiveValidateApiClient::IPAddressApi* | [**i_p_address_post**](docs/IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
118
|
+
*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
|
110
119
|
*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
|
111
120
|
*CloudmersiveValidateApiClient::NameApi* | [**name_get_gender**](docs/NameApi.md#name_get_gender) | **POST** /validate/name/get-gender | Get the gender of a first name
|
112
121
|
*CloudmersiveValidateApiClient::NameApi* | [**name_identifier**](docs/NameApi.md#name_identifier) | **POST** /validate/name/identifier | Validate a code identifier
|
@@ -114,6 +123,9 @@ Class | Method | HTTP request | Description
|
|
114
123
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
115
124
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
116
125
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
126
|
+
*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
|
127
|
+
*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
|
128
|
+
*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
|
117
129
|
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
118
130
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
119
131
|
|
@@ -122,9 +134,14 @@ Class | Method | HTTP request | Description
|
|
122
134
|
|
123
135
|
- [CloudmersiveValidateApiClient::AddressGetServersResponse](docs/AddressGetServersResponse.md)
|
124
136
|
- [CloudmersiveValidateApiClient::AddressVerifySyntaxOnlyResponse](docs/AddressVerifySyntaxOnlyResponse.md)
|
137
|
+
- [CloudmersiveValidateApiClient::BotCheckResponse](docs/BotCheckResponse.md)
|
125
138
|
- [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
|
126
139
|
- [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
|
127
140
|
- [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
|
141
|
+
- [CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest](docs/DateTimeNaturalLanguageParseRequest.md)
|
142
|
+
- [CloudmersiveValidateApiClient::DateTimeNowResult](docs/DateTimeNowResult.md)
|
143
|
+
- [CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest](docs/DateTimeStandardizedParseRequest.md)
|
144
|
+
- [CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse](docs/DateTimeStandardizedParseResponse.md)
|
128
145
|
- [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
|
129
146
|
- [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
|
130
147
|
- [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
|
@@ -132,19 +149,26 @@ Class | Method | HTTP request | Description
|
|
132
149
|
- [CloudmersiveValidateApiClient::FullNameValidationRequest](docs/FullNameValidationRequest.md)
|
133
150
|
- [CloudmersiveValidateApiClient::FullNameValidationResponse](docs/FullNameValidationResponse.md)
|
134
151
|
- [CloudmersiveValidateApiClient::GeolocateResponse](docs/GeolocateResponse.md)
|
152
|
+
- [CloudmersiveValidateApiClient::GeolocateStreetAddressResponse](docs/GeolocateStreetAddressResponse.md)
|
135
153
|
- [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
|
136
154
|
- [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
|
155
|
+
- [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
|
137
156
|
- [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
|
138
157
|
- [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
|
158
|
+
- [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
|
159
|
+
- [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
|
139
160
|
- [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
|
140
161
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
141
162
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
142
163
|
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
143
164
|
- [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
|
165
|
+
- [CloudmersiveValidateApiClient::NormalizeAddressResponse](docs/NormalizeAddressResponse.md)
|
144
166
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
145
167
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
146
168
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
147
169
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
170
|
+
- [CloudmersiveValidateApiClient::PublicHolidayOccurrence](docs/PublicHolidayOccurrence.md)
|
171
|
+
- [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
|
148
172
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
|
149
173
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
|
150
174
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
@@ -170,6 +194,10 @@ Class | Method | HTTP request | Description
|
|
170
194
|
- [CloudmersiveValidateApiClient::VatLookupRequest](docs/VatLookupRequest.md)
|
171
195
|
- [CloudmersiveValidateApiClient::VatLookupResponse](docs/VatLookupResponse.md)
|
172
196
|
- [CloudmersiveValidateApiClient::WhoisResponse](docs/WhoisResponse.md)
|
197
|
+
- [CloudmersiveValidateApiClient::XssProtectionBatchRequest](docs/XssProtectionBatchRequest.md)
|
198
|
+
- [CloudmersiveValidateApiClient::XssProtectionBatchResponse](docs/XssProtectionBatchResponse.md)
|
199
|
+
- [CloudmersiveValidateApiClient::XssProtectionRequestItem](docs/XssProtectionRequestItem.md)
|
200
|
+
- [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
|
173
201
|
|
174
202
|
|
175
203
|
## Documentation for Authorization
|
data/docs/AddressApi.md
CHANGED
@@ -11,6 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
[**address_get_country_currency**](AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
|
12
12
|
[**address_get_country_region**](AddressApi.md#address_get_country_region) | **POST** /validate/address/country/get-region | Get the region, subregion and continent of the country
|
13
13
|
[**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
|
14
|
+
[**address_normalize_address**](AddressApi.md#address_normalize_address) | **POST** /validate/address/street-address/normalize | Normalize a street address
|
14
15
|
[**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
|
15
16
|
[**address_reverse_geocode_address**](AddressApi.md#address_reverse_geocode_address) | **POST** /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address
|
16
17
|
[**address_validate_address**](AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
|
@@ -391,6 +392,60 @@ Name | Type | Description | Notes
|
|
391
392
|
|
392
393
|
|
393
394
|
|
395
|
+
# **address_normalize_address**
|
396
|
+
> NormalizeAddressResponse address_normalize_address(input)
|
397
|
+
|
398
|
+
Normalize a street address
|
399
|
+
|
400
|
+
Normalizes an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.
|
401
|
+
|
402
|
+
### Example
|
403
|
+
```ruby
|
404
|
+
# load the gem
|
405
|
+
require 'cloudmersive-validate-api-client'
|
406
|
+
# setup authorization
|
407
|
+
CloudmersiveValidateApiClient.configure do |config|
|
408
|
+
# Configure API key authorization: Apikey
|
409
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
410
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
411
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
412
|
+
end
|
413
|
+
|
414
|
+
api_instance = CloudmersiveValidateApiClient::AddressApi.new
|
415
|
+
|
416
|
+
input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
|
417
|
+
|
418
|
+
|
419
|
+
begin
|
420
|
+
#Normalize a street address
|
421
|
+
result = api_instance.address_normalize_address(input)
|
422
|
+
p result
|
423
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
424
|
+
puts "Exception when calling AddressApi->address_normalize_address: #{e}"
|
425
|
+
end
|
426
|
+
```
|
427
|
+
|
428
|
+
### Parameters
|
429
|
+
|
430
|
+
Name | Type | Description | Notes
|
431
|
+
------------- | ------------- | ------------- | -------------
|
432
|
+
**input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request |
|
433
|
+
|
434
|
+
### Return type
|
435
|
+
|
436
|
+
[**NormalizeAddressResponse**](NormalizeAddressResponse.md)
|
437
|
+
|
438
|
+
### Authorization
|
439
|
+
|
440
|
+
[Apikey](../README.md#Apikey)
|
441
|
+
|
442
|
+
### HTTP request headers
|
443
|
+
|
444
|
+
- **Content-Type**: application/json, text/json
|
445
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
446
|
+
|
447
|
+
|
448
|
+
|
394
449
|
# **address_parse_string**
|
395
450
|
> ParseAddressResponse address_parse_string(input)
|
396
451
|
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::BotCheckResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**is_bot** | **BOOLEAN** | True if the input IP address is a Bot or Robot, false otherwise | [optional]
|
7
|
+
|
8
|
+
|
data/docs/DateTimeApi.md
ADDED
@@ -0,0 +1,222 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloudmersive.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**date_time_get_now_simple**](DateTimeApi.md#date_time_get_now_simple) | **GET** /validate/date-time/get/now | Get current date and time as of now
|
8
|
+
[**date_time_get_public_holidays**](DateTimeApi.md#date_time_get_public_holidays) | **POST** /validate/date-time/get/holidays | Get public holidays in the specified country and year
|
9
|
+
[**date_time_parse_natural_language_date_time**](DateTimeApi.md#date_time_parse_natural_language_date_time) | **POST** /validate/date-time/parse/date-time/natural-language | Parses a free-form natural language date and time string into a date and time
|
10
|
+
[**date_time_parse_standard_date_time**](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
|
11
|
+
|
12
|
+
|
13
|
+
# **date_time_get_now_simple**
|
14
|
+
> DateTimeNowResult date_time_get_now_simple
|
15
|
+
|
16
|
+
Get current date and time as of now
|
17
|
+
|
18
|
+
Gets the current date and time. Response time is syncronized with atomic clocks, and represents a monotonic, centrally available, consistent clock.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'cloudmersive-validate-api-client'
|
24
|
+
# setup authorization
|
25
|
+
CloudmersiveValidateApiClient.configure do |config|
|
26
|
+
# Configure API key authorization: Apikey
|
27
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Get current date and time as of now
|
36
|
+
result = api_instance.date_time_get_now_simple
|
37
|
+
p result
|
38
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
39
|
+
puts "Exception when calling DateTimeApi->date_time_get_now_simple: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
This endpoint does not need any parameter.
|
45
|
+
|
46
|
+
### Return type
|
47
|
+
|
48
|
+
[**DateTimeNowResult**](DateTimeNowResult.md)
|
49
|
+
|
50
|
+
### Authorization
|
51
|
+
|
52
|
+
[Apikey](../README.md#Apikey)
|
53
|
+
|
54
|
+
### HTTP request headers
|
55
|
+
|
56
|
+
- **Content-Type**: Not defined
|
57
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
# **date_time_get_public_holidays**
|
62
|
+
> PublicHolidaysResponse date_time_get_public_holidays(input)
|
63
|
+
|
64
|
+
Get public holidays in the specified country and year
|
65
|
+
|
66
|
+
Enumerates all public holidays in a given country for a given year. Supports over 100 countries.
|
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::DateTimeApi.new
|
81
|
+
|
82
|
+
input = CloudmersiveValidateApiClient::GetPublicHolidaysRequest.new # GetPublicHolidaysRequest | Input request
|
83
|
+
|
84
|
+
|
85
|
+
begin
|
86
|
+
#Get public holidays in the specified country and year
|
87
|
+
result = api_instance.date_time_get_public_holidays(input)
|
88
|
+
p result
|
89
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
90
|
+
puts "Exception when calling DateTimeApi->date_time_get_public_holidays: #{e}"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
### Parameters
|
95
|
+
|
96
|
+
Name | Type | Description | Notes
|
97
|
+
------------- | ------------- | ------------- | -------------
|
98
|
+
**input** | [**GetPublicHolidaysRequest**](GetPublicHolidaysRequest.md)| Input request |
|
99
|
+
|
100
|
+
### Return type
|
101
|
+
|
102
|
+
[**PublicHolidaysResponse**](PublicHolidaysResponse.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
|
+
|
115
|
+
# **date_time_parse_natural_language_date_time**
|
116
|
+
> DateTimeStandardizedParseResponse date_time_parse_natural_language_date_time(input)
|
117
|
+
|
118
|
+
Parses a free-form natural language date and time string into a date and time
|
119
|
+
|
120
|
+
Parses an unstructured, free-form, natural language date and time string into a date time object. This is intended for lightweight human-entered input, such as \"tomorrow at 3pm\" or \"tuesday\".
|
121
|
+
|
122
|
+
### Example
|
123
|
+
```ruby
|
124
|
+
# load the gem
|
125
|
+
require 'cloudmersive-validate-api-client'
|
126
|
+
# setup authorization
|
127
|
+
CloudmersiveValidateApiClient.configure do |config|
|
128
|
+
# Configure API key authorization: Apikey
|
129
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
131
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
132
|
+
end
|
133
|
+
|
134
|
+
api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
|
135
|
+
|
136
|
+
input = CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest.new # DateTimeNaturalLanguageParseRequest | Input request
|
137
|
+
|
138
|
+
|
139
|
+
begin
|
140
|
+
#Parses a free-form natural language date and time string into a date and time
|
141
|
+
result = api_instance.date_time_parse_natural_language_date_time(input)
|
142
|
+
p result
|
143
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
144
|
+
puts "Exception when calling DateTimeApi->date_time_parse_natural_language_date_time: #{e}"
|
145
|
+
end
|
146
|
+
```
|
147
|
+
|
148
|
+
### Parameters
|
149
|
+
|
150
|
+
Name | Type | Description | Notes
|
151
|
+
------------- | ------------- | ------------- | -------------
|
152
|
+
**input** | [**DateTimeNaturalLanguageParseRequest**](DateTimeNaturalLanguageParseRequest.md)| Input request |
|
153
|
+
|
154
|
+
### Return type
|
155
|
+
|
156
|
+
[**DateTimeStandardizedParseResponse**](DateTimeStandardizedParseResponse.md)
|
157
|
+
|
158
|
+
### Authorization
|
159
|
+
|
160
|
+
[Apikey](../README.md#Apikey)
|
161
|
+
|
162
|
+
### HTTP request headers
|
163
|
+
|
164
|
+
- **Content-Type**: application/json, text/json
|
165
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
# **date_time_parse_standard_date_time**
|
170
|
+
> DateTimeStandardizedParseResponse date_time_parse_standard_date_time(input)
|
171
|
+
|
172
|
+
Parses a standardized date and time string into a date and time
|
173
|
+
|
174
|
+
Parses a structured date and time string into a date time object. This is intended for standardized date strings that adhere to formatting conventions, rather than natural language input.
|
175
|
+
|
176
|
+
### Example
|
177
|
+
```ruby
|
178
|
+
# load the gem
|
179
|
+
require 'cloudmersive-validate-api-client'
|
180
|
+
# setup authorization
|
181
|
+
CloudmersiveValidateApiClient.configure do |config|
|
182
|
+
# Configure API key authorization: Apikey
|
183
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
184
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
185
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
186
|
+
end
|
187
|
+
|
188
|
+
api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
|
189
|
+
|
190
|
+
input = CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest.new # DateTimeStandardizedParseRequest | Input request
|
191
|
+
|
192
|
+
|
193
|
+
begin
|
194
|
+
#Parses a standardized date and time string into a date and time
|
195
|
+
result = api_instance.date_time_parse_standard_date_time(input)
|
196
|
+
p result
|
197
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
198
|
+
puts "Exception when calling DateTimeApi->date_time_parse_standard_date_time: #{e}"
|
199
|
+
end
|
200
|
+
```
|
201
|
+
|
202
|
+
### Parameters
|
203
|
+
|
204
|
+
Name | Type | Description | Notes
|
205
|
+
------------- | ------------- | ------------- | -------------
|
206
|
+
**input** | [**DateTimeStandardizedParseRequest**](DateTimeStandardizedParseRequest.md)| Input request |
|
207
|
+
|
208
|
+
### Return type
|
209
|
+
|
210
|
+
[**DateTimeStandardizedParseResponse**](DateTimeStandardizedParseResponse.md)
|
211
|
+
|
212
|
+
### Authorization
|
213
|
+
|
214
|
+
[Apikey](../README.md#Apikey)
|
215
|
+
|
216
|
+
### HTTP request headers
|
217
|
+
|
218
|
+
- **Content-Type**: application/json, text/json
|
219
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
220
|
+
|
221
|
+
|
222
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**raw_date_time_input** | **String** | Raw string input of a natural language-formatted date and time for parsing | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeNowResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
7
|
+
**now** | **DateTime** | Current date, time, and time zone in standard JSON date format | [optional]
|
8
|
+
**now_gmt** | **DateTime** | Current GMT-time-zone date, time, and time zone in standard JSON date format | [optional]
|
9
|
+
|
10
|
+
|