cloudmersive-validate-api-client 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af976c8119e72adb285d9be4eeac657cf36266303727a89d71af599237c9030e
-  data.tar.gz: fa9de07603fd5982bd7936f055302926abaa5307c53995ecff1a89bff0e944f4
+  metadata.gz: 580343d1f2610163655fb867547c08b843993d3c68f01cd59479e40e78d80341
+  data.tar.gz: 5f9844a43674a566b61c5564c1685fd81322293e4aa5394d219e5faf3111e5a4
 SHA512:
-  metadata.gz: 6d39dc860c9ab1c9460e7c165967c1b57b505fbace518aed79f15a71f93b323ff0d0fba9a1aee5fea8eef774a314a2d2a6e8f716773259df74b1114d4afc98dc
-  data.tar.gz: f2cea25c3c298c97928f5dcfb400e52d0b6d19628997e2c3c5b4896437fac8dcf767c4338224696f2bec76b0e5318151e9abed2fb52c65074b4288733586a9ca
+  metadata.gz: a2c34afc7f80fea8724806691dc82b381dc6b33ec2253ffcad3675fbf96bb9c58602f8be6673c0414052c983e9c0f268b9c55cee582d7a2461f4a499be834ecd
+  data.tar.gz: a72610132b934a0d25d1c691a7fbf37fbab351afc53b8f8620658bf3fb47e12e6e51655c29885fbe98e8bbf88e90f0dd0521c092594ac3d4afce774c5d4b9d47

data/README.md

@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: v1
-- Package version: 2.1.1
+- Package version: 2.1.2
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./cloudmersive-validate-api-client-2.1.1.gem
+gem install ./cloudmersive-validate-api-client-2.1.2.gem
 ```
-(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.1.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'cloudmersive-validate-api-client', '~> 2.1.1'
+    gem 'cloudmersive-validate-api-client', '~> 2.1.2'
 
 ### Install from Git
 
@@ -90,12 +90,17 @@ Class | Method | HTTP request | Description
 *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
 *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
 *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
+*CloudmersiveValidateApiClient::AddressApi* | [**address_normalize_address**](docs/AddressApi.md#address_normalize_address) | **POST** /validate/address/street-address/normalize | Normalize a street address
 *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
 *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
 *CloudmersiveValidateApiClient::AddressApi* | [**address_validate_address**](docs/AddressApi.md#address_validate_address) | **POST** /validate/address/street-address | Validate a street address
 *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
 *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
 *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
+*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
+*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
+*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
+*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
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
 *CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
@@ -128,6 +133,10 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::CheckResponse](docs/CheckResponse.md)
  - [CloudmersiveValidateApiClient::CountryDetails](docs/CountryDetails.md)
  - [CloudmersiveValidateApiClient::CountryListResult](docs/CountryListResult.md)
+ - [CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest](docs/DateTimeNaturalLanguageParseRequest.md)
+ - [CloudmersiveValidateApiClient::DateTimeNowResult](docs/DateTimeNowResult.md)
+ - [CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest](docs/DateTimeStandardizedParseRequest.md)
+ - [CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse](docs/DateTimeStandardizedParseResponse.md)
  - [CloudmersiveValidateApiClient::DomainQualityResponse](docs/DomainQualityResponse.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationRequest](docs/FirstNameValidationRequest.md)
  - [CloudmersiveValidateApiClient::FirstNameValidationResponse](docs/FirstNameValidationResponse.md)
@@ -138,6 +147,7 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::GeolocateStreetAddressResponse](docs/GeolocateStreetAddressResponse.md)
  - [CloudmersiveValidateApiClient::GetGenderRequest](docs/GetGenderRequest.md)
  - [CloudmersiveValidateApiClient::GetGenderResponse](docs/GetGenderResponse.md)
+ - [CloudmersiveValidateApiClient::GetPublicHolidaysRequest](docs/GetPublicHolidaysRequest.md)
  - [CloudmersiveValidateApiClient::GetTimezonesRequest](docs/GetTimezonesRequest.md)
  - [CloudmersiveValidateApiClient::GetTimezonesResponse](docs/GetTimezonesResponse.md)
  - [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
@@ -145,10 +155,13 @@ Class | Method | HTTP request | Description
  - [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
  - [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
  - [CloudmersiveValidateApiClient::LeadEnrichmentResponse](docs/LeadEnrichmentResponse.md)
+ - [CloudmersiveValidateApiClient::NormalizeAddressResponse](docs/NormalizeAddressResponse.md)
  - [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
  - [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
  - [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
+ - [CloudmersiveValidateApiClient::PublicHolidayOccurrence](docs/PublicHolidayOccurrence.md)
+ - [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
  - [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
  - [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)

data/docs/AddressApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**address_get_country_currency**](AddressApi.md#address_get_country_currency) | **POST** /validate/address/country/get-currency | Get the currency of the input country
 [**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
 [**address_get_timezone**](AddressApi.md#address_get_timezone) | **POST** /validate/address/country/get-timezones | Gets IANA/Olsen time zones for a country
+[**address_normalize_address**](AddressApi.md#address_normalize_address) | **POST** /validate/address/street-address/normalize | Normalize a street address
 [**address_parse_string**](AddressApi.md#address_parse_string) | **POST** /validate/address/parse | Parse an unstructured input text string into an international, formatted address
 [**address_reverse_geocode_address**](AddressApi.md#address_reverse_geocode_address) | **POST** /validate/address/geocode/reverse | Reverse geocode a lattitude and longitude into an address
 [**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
 
 
 
+# **address_normalize_address**
+> NormalizeAddressResponse address_normalize_address(input)
+
+Normalize a street address
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::AddressApi.new
+
+input = CloudmersiveValidateApiClient::ValidateAddressRequest.new # ValidateAddressRequest | Input parse request
+
+
+begin
+  #Normalize a street address
+  result = api_instance.address_normalize_address(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling AddressApi->address_normalize_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request | 
+
+### Return type
+
+[**NormalizeAddressResponse**](NormalizeAddressResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **address_parse_string**
 > ParseAddressResponse address_parse_string(input)
 

data/docs/DateTimeApi.md

@@ -0,0 +1,222 @@
+# CloudmersiveValidateApiClient::DateTimeApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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
+[**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
+[**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
+[**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
+
+
+# **date_time_get_now_simple**
+> DateTimeNowResult date_time_get_now_simple
+
+Get current date and time as of now
+
+Gets the current date and time.  Response time is syncronized with atomic clocks, and represents a monotonic, centrally available, consistent clock.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
+
+begin
+  #Get current date and time as of now
+  result = api_instance.date_time_get_now_simple
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DateTimeApi->date_time_get_now_simple: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**DateTimeNowResult**](DateTimeNowResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **date_time_get_public_holidays**
+> PublicHolidaysResponse date_time_get_public_holidays(input)
+
+Get public holidays in the specified country and year
+
+Enumerates all public holidays in a given country for a given year.  Supports over 100 countries.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
+
+input = CloudmersiveValidateApiClient::GetPublicHolidaysRequest.new # GetPublicHolidaysRequest | Input request
+
+
+begin
+  #Get public holidays in the specified country and year
+  result = api_instance.date_time_get_public_holidays(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DateTimeApi->date_time_get_public_holidays: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**GetPublicHolidaysRequest**](GetPublicHolidaysRequest.md)| Input request | 
+
+### Return type
+
+[**PublicHolidaysResponse**](PublicHolidaysResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **date_time_parse_natural_language_date_time**
+> DateTimeStandardizedParseResponse date_time_parse_natural_language_date_time(input)
+
+Parses a free-form natural language date and time string into a date and time
+
+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\".
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
+
+input = CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest.new # DateTimeNaturalLanguageParseRequest | Input request
+
+
+begin
+  #Parses a free-form natural language date and time string into a date and time
+  result = api_instance.date_time_parse_natural_language_date_time(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DateTimeApi->date_time_parse_natural_language_date_time: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DateTimeNaturalLanguageParseRequest**](DateTimeNaturalLanguageParseRequest.md)| Input request | 
+
+### Return type
+
+[**DateTimeStandardizedParseResponse**](DateTimeStandardizedParseResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **date_time_parse_standard_date_time**
+> DateTimeStandardizedParseResponse date_time_parse_standard_date_time(input)
+
+Parses a standardized date and time string into a date and time
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'cloudmersive-validate-api-client'
+# setup authorization
+CloudmersiveValidateApiClient.configure do |config|
+  # Configure API key authorization: Apikey
+  config.api_key['Apikey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Apikey'] = 'Bearer'
+end
+
+api_instance = CloudmersiveValidateApiClient::DateTimeApi.new
+
+input = CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest.new # DateTimeStandardizedParseRequest | Input request
+
+
+begin
+  #Parses a standardized date and time string into a date and time
+  result = api_instance.date_time_parse_standard_date_time(input)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling DateTimeApi->date_time_parse_standard_date_time: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **input** | [**DateTimeStandardizedParseRequest**](DateTimeStandardizedParseRequest.md)| Input request | 
+
+### Return type
+
+[**DateTimeStandardizedParseResponse**](DateTimeStandardizedParseResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/DateTimeNaturalLanguageParseRequest.md

@@ -0,0 +1,8 @@
+# CloudmersiveValidateApiClient::DateTimeNaturalLanguageParseRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**raw_date_time_input** | **String** | Raw string input of a natural language-formatted date and time for parsing | [optional] 
+
+

data/docs/DateTimeNowResult.md

@@ -0,0 +1,10 @@
+# CloudmersiveValidateApiClient::DateTimeNowResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**now** | **DateTime** | Current date, time, and time zone in standard JSON date format | [optional] 
+**now_gmt** | **DateTime** | Current GMT-time-zone date, time, and time zone in standard JSON date format | [optional] 
+
+

data/docs/DateTimeStandardizedParseRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**raw_date_time_input** | **String** | Raw string input of a standard-formatted date and time for parsing | [optional] 
+**country_code** | **String** | Optional: specify the two-letter country code to optimzie date formatting; default is US | [optional] 
+
+

data/docs/DateTimeStandardizedParseResponse.md

@@ -0,0 +1,16 @@
+# CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if successful, false otherwise | [optional] 
+**parsed_date_result** | **DateTime** | Result of performing a date time parsing | [optional] 
+**year** | **Integer** | Year of the parsed date time result | [optional] 
+**month** | **Integer** | Month of the parsed date time result | [optional] 
+**day** | **Integer** | Day of the parsed date time result | [optional] 
+**hour** | **Integer** | Hour of the parsed date time result (24-hour) | [optional] 
+**minute** | **Integer** | Minute of the parsed date time result | [optional] 
+**second** | **Integer** | Second of the parsed date time result | [optional] 
+**day_of_week** | **String** | Day of week | [optional] 
+
+

data/docs/DomainApi.md

@@ -60,7 +60,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: text/javascript, application/json, text/json
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -114,7 +114,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: text/javascript, application/json, text/json
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml
 
 
@@ -168,7 +168,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: text/javascript, application/json, text/json
+ - **Content-Type**: application/json, text/json
  - **Accept**: application/json, text/json, application/xml, text/xml