./docs/AddressApi.md in cloudmersive-validate-api-client-2.0.9 vs ./docs/AddressApi.md in cloudmersive-validate-api-client-2.1.0

- old
+ new

@@ -5,14 +5,16 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**address_check_eu_membership**](AddressApi.md#address_check_eu_membership) | **POST** /validate/address/country/check-eu-membership | Check if a country is a member of the European Union (EU) [**address_country**](AddressApi.md#address_country) | **POST** /validate/address/country | Validate and normalize country information, return ISO 3166-1 country codes and country name [**address_country_list**](AddressApi.md#address_country_list) | **POST** /validate/address/country/list | Get a list of ISO 3166-1 countries +[**address_geocode**](AddressApi.md#address_geocode) | **POST** /validate/address/geocode | Geocode a street address into latitude and longitude [**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_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 [**address_validate_city**](AddressApi.md#address_validate_city) | **POST** /validate/address/city | Validate a City and State/Province combination, get location information about it [**address_validate_postal_code**](AddressApi.md#address_validate_postal_code) | **POST** /validate/address/postal-code | Validate a postal code, get location information about it [**address_validate_state**](AddressApi.md#address_validate_state) | **POST** /validate/address/state | Validate a state or province, name or abbreviation, get location information about it @@ -171,10 +173,64 @@ - **Content-Type**: Not defined - **Accept**: application/json, text/json, application/xml, text/xml +# **address_geocode** +> ValidateAddressResponse address_geocode(input) + +Geocode a street address into latitude and longitude + +Geocodes a street address into latitude and longitude. + +### 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 + #Geocode a street address into latitude and longitude + result = api_instance.address_geocode(input) + p result +rescue CloudmersiveValidateApiClient::ApiError => e + puts "Exception when calling AddressApi->address_geocode: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **input** | [**ValidateAddressRequest**](ValidateAddressRequest.md)| Input parse request | + +### Return type + +[**ValidateAddressResponse**](ValidateAddressResponse.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_get_country_currency** > ValidateCountryResponse address_get_country_currency(input) Get the currency of the input country @@ -375,9 +431,63 @@ **input** | [**ParseAddressRequest**](ParseAddressRequest.md)| Input parse request | ### Return type [**ParseAddressResponse**](ParseAddressResponse.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_reverse_geocode_address** +> ReverseGeocodeAddressResponse address_reverse_geocode_address(input) + +Reverse geocode a lattitude and longitude into an address + +Converts lattitude and longitude coordinates into an address through reverse-geocoding. + +### 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::ReverseGeocodeAddressRequest.new # ReverseGeocodeAddressRequest | Input reverse geocoding request + + +begin + #Reverse geocode a lattitude and longitude into an address + result = api_instance.address_reverse_geocode_address(input) + p result +rescue CloudmersiveValidateApiClient::ApiError => e + puts "Exception when calling AddressApi->address_reverse_geocode_address: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **input** | [**ReverseGeocodeAddressRequest**](ReverseGeocodeAddressRequest.md)| Input reverse geocoding request | + +### Return type + +[**ReverseGeocodeAddressResponse**](ReverseGeocodeAddressResponse.md) ### Authorization [Apikey](../README.md#Apikey)