cloudmersive-validate-api-client 2.0.6 → 2.1.1

data/docs/IPAddressApi.md

@@ -4,11 +4,66 @@ All URIs are relative to *https://api.cloudmersive.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**i_p_address_geolocate_street_address**](IPAddressApi.md#i_p_address_geolocate_street_address) | **POST** /validate/ip/geolocate/street-address | Geolocate an IP address to a street address
 [**i_p_address_is_threat**](IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
 [**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
 [**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
 
 
+# **i_p_address_geolocate_street_address**
+> GeolocateStreetAddressResponse i_p_address_geolocate_street_address(value)
+
+Geolocate an IP address to a street address
+
+Identify an IP address's street address.  Useful for security and UX applications.
+
+### 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::IPAddressApi.new
+
+value = 'value_example' # String | IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes.
+
+
+begin
+  #Geolocate an IP address to a street address
+  result = api_instance.i_p_address_geolocate_street_address(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling IPAddressApi->i_p_address_geolocate_street_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| IP address to geolocate, e.g. \"55.55.55.55\".  The input is a string so be sure to enclose it in double-quotes. | 
+
+### Return type
+
+[**GeolocateStreetAddressResponse**](GeolocateStreetAddressResponse.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
 # **i_p_address_is_threat**
 > IPThreatResponse i_p_address_is_threat(value)
 

data/docs/ReverseGeocodeAddressRequest.md

@@ -0,0 +1,9 @@
+# CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**latitude** | **Float** | Latitude coordinate in WGS84 format | [optional] 
+**longitude** | **Float** | Longitude coordinate in WGS84 format | [optional] 
+
+

data/docs/ReverseGeocodeAddressResponse.md

@@ -0,0 +1,14 @@
+# CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the address operation was successful, false otherwise | [optional] 
+**street_address** | **String** | Street address to validate, such as '2950 Buskirk Ave.' | [optional] 
+**city** | **String** | City part of the addrerss to validate, such as 'Walnut Creek' | [optional] 
+**state_or_province** | **String** | State or province of the address to validate, such as 'CA' or 'California' | [optional] 
+**postal_code** | **String** | Zip code or postal code of the address to validate, such as '94597' | [optional] 
+**country_full_name** | **String** | Name of the country, such as 'United States'.  Global countries are supported. | [optional] 
+**country_code** | **String** | Three-letter ISO 3166-1 country code | [optional] 
+
+

data/docs/TextInputApi.md

@@ -0,0 +1,118 @@
+# CloudmersiveValidateApiClient::TextInputApi
+
+All URIs are relative to *https://api.cloudmersive.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**text_input_check_xss**](TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
+[**text_input_protect_xss**](TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+
+
+# **text_input_check_xss**
+> XssProtectionResult text_input_check_xss(value)
+
+Check text input for Cross-Site-Scripting (XSS) attacks
+
+Detects XSS (Cross-Site-Scripting) attacks from text 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::TextInputApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Check text input for Cross-Site-Scripting (XSS) attacks
+  result = api_instance.text_input_check_xss(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_check_xss: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**XssProtectionResult**](XssProtectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+
+# **text_input_protect_xss**
+> XssProtectionResult text_input_protect_xss(value)
+
+Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+
+Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization.  Returns the normalized result, as well as information on whether the original input contained an XSS risk.
+
+### 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::TextInputApi.new
+
+value = 'value_example' # String | User-facing text input.
+
+
+begin
+  #Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
+  result = api_instance.text_input_protect_xss(value)
+  p result
+rescue CloudmersiveValidateApiClient::ApiError => e
+  puts "Exception when calling TextInputApi->text_input_protect_xss: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **value** | **String**| User-facing text input. | 
+
+### Return type
+
+[**XssProtectionResult**](XssProtectionResult.md)
+
+### Authorization
+
+[Apikey](../README.md#Apikey)
+
+### HTTP request headers
+
+ - **Content-Type**: text/javascript, application/json, text/json
+ - **Accept**: application/json, text/json, application/xml, text/xml
+
+
+

data/docs/ValidateCountryResponse.md

@@ -10,5 +10,10 @@ Name | Type | Description | Notes
 **three_letter_code** | **String** | Three-letter ISO 3166-1 country code | [optional] 
 **is_european_union_member** | **BOOLEAN** | True if this country is currently a member of the European Union (EU), false otherwise | [optional] 
 **timezones** | [**Array<Timezone>**](Timezone.md) | Time zones (IANA/Olsen) in the country | [optional] 
+**iso_currency_code** | **String** | ISO 4217 currency three-letter code associated with the country | [optional] 
+**currency_symbol** | **String** | Symbol associated with the currency | [optional] 
+**currency_english_name** | **String** | Full name of the currency | [optional] 
+**region** | **String** | Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania | [optional] 
+**subregion** | **String** | Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean, | [optional] 
 
 

data/docs/XssProtectionResult.md

@@ -0,0 +1,11 @@
+# CloudmersiveValidateApiClient::XssProtectionResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional] 
+**contained_xss** | **BOOLEAN** | True if the input contained XSS scripting, false otherwise | [optional] 
+**original_input** | **String** | Original input string | [optional] 
+**normalized_result** | **String** | Normalized string result, with XSS removed | [optional] 
+
+

data/lib/cloudmersive-validate-api-client.rb

@@ -22,12 +22,14 @@ require 'cloudmersive-validate-api-client/models/address_verify_syntax_only_resp
 require 'cloudmersive-validate-api-client/models/check_response'
 require 'cloudmersive-validate-api-client/models/country_details'
 require 'cloudmersive-validate-api-client/models/country_list_result'
+require 'cloudmersive-validate-api-client/models/domain_quality_response'
 require 'cloudmersive-validate-api-client/models/first_name_validation_request'
 require 'cloudmersive-validate-api-client/models/first_name_validation_response'
 require 'cloudmersive-validate-api-client/models/full_email_validation_response'
 require 'cloudmersive-validate-api-client/models/full_name_validation_request'
 require 'cloudmersive-validate-api-client/models/full_name_validation_response'
 require 'cloudmersive-validate-api-client/models/geolocate_response'
+require 'cloudmersive-validate-api-client/models/geolocate_street_address_response'
 require 'cloudmersive-validate-api-client/models/get_gender_request'
 require 'cloudmersive-validate-api-client/models/get_gender_response'
 require 'cloudmersive-validate-api-client/models/get_timezones_request'
@@ -41,6 +43,8 @@ require 'cloudmersive-validate-api-client/models/parse_address_request'
 require 'cloudmersive-validate-api-client/models/parse_address_response'
 require 'cloudmersive-validate-api-client/models/phone_number_validate_request'
 require 'cloudmersive-validate-api-client/models/phone_number_validation_response'
+require 'cloudmersive-validate-api-client/models/reverse_geocode_address_request'
+require 'cloudmersive-validate-api-client/models/reverse_geocode_address_response'
 require 'cloudmersive-validate-api-client/models/timezone'
 require 'cloudmersive-validate-api-client/models/tor_node_response'
 require 'cloudmersive-validate-api-client/models/user_agent_validate_request'
@@ -64,6 +68,7 @@ require 'cloudmersive-validate-api-client/models/validate_url_response_syntax_on
 require 'cloudmersive-validate-api-client/models/vat_lookup_request'
 require 'cloudmersive-validate-api-client/models/vat_lookup_response'
 require 'cloudmersive-validate-api-client/models/whois_response'
+require 'cloudmersive-validate-api-client/models/xss_protection_result'
 
 # APIs
 require 'cloudmersive-validate-api-client/api/address_api'
@@ -73,6 +78,7 @@ require 'cloudmersive-validate-api-client/api/ip_address_api'
 require 'cloudmersive-validate-api-client/api/lead_enrichment_api'
 require 'cloudmersive-validate-api-client/api/name_api'
 require 'cloudmersive-validate-api-client/api/phone_number_api'
+require 'cloudmersive-validate-api-client/api/text_input_api'
 require 'cloudmersive-validate-api-client/api/user_agent_api'
 require 'cloudmersive-validate-api-client/api/vat_api'
 

data/lib/cloudmersive-validate-api-client/api/address_api.rb

@@ -173,6 +173,168 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Geocode a street address into latitude and longitude
+    # Geocodes a street address into latitude and longitude.
+    # @param input Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateAddressResponse]
+    def address_geocode(input, opts = {})
+      data, _status_code, _headers = address_geocode_with_http_info(input, opts)
+      data
+    end
+
+    # Geocode a street address into latitude and longitude
+    # Geocodes a street address into latitude and longitude.
+    # @param input Input parse request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateAddressResponse, Fixnum, Hash)>] ValidateAddressResponse data, response status code and response headers
+    def address_geocode_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.address_geocode ...'
+      end
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_geocode"
+      end
+      # resource path
+      local_var_path = '/validate/address/geocode'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(input)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ValidateAddressResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#address_geocode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get the currency of the input country
+    # Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
+    # @param input Input request
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateCountryResponse]
+    def address_get_country_currency(input, opts = {})
+      data, _status_code, _headers = address_get_country_currency_with_http_info(input, opts)
+      data
+    end
+
+    # Get the currency of the input country
+    # Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.
+    # @param input Input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateCountryResponse, Fixnum, Hash)>] ValidateCountryResponse data, response status code and response headers
+    def address_get_country_currency_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.address_get_country_currency ...'
+      end
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_get_country_currency"
+      end
+      # resource path
+      local_var_path = '/validate/address/country/get-currency'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(input)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ValidateCountryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#address_get_country_currency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Get the region, subregion and continent of the country
+    # Gets the continent information including region and subregion for the input country.
+    # @param input Input request
+    # @param [Hash] opts the optional parameters
+    # @return [ValidateCountryResponse]
+    def address_get_country_region(input, opts = {})
+      data, _status_code, _headers = address_get_country_region_with_http_info(input, opts)
+      data
+    end
+
+    # Get the region, subregion and continent of the country
+    # Gets the continent information including region and subregion for the input country.
+    # @param input Input request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ValidateCountryResponse, Fixnum, Hash)>] ValidateCountryResponse data, response status code and response headers
+    def address_get_country_region_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.address_get_country_region ...'
+      end
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_get_country_region"
+      end
+      # resource path
+      local_var_path = '/validate/address/country/get-region'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(input)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ValidateCountryResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#address_get_country_region\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Gets IANA/Olsen time zones for a country
     # Gets the IANA/Olsen time zones for a country.
     # @param input Input request
@@ -281,6 +443,60 @@ module CloudmersiveValidateApiClient
       end
       return data, status_code, headers
     end
+    # Reverse geocode a lattitude and longitude into an address
+    # Converts lattitude and longitude coordinates into an address through reverse-geocoding.
+    # @param input Input reverse geocoding request
+    # @param [Hash] opts the optional parameters
+    # @return [ReverseGeocodeAddressResponse]
+    def address_reverse_geocode_address(input, opts = {})
+      data, _status_code, _headers = address_reverse_geocode_address_with_http_info(input, opts)
+      data
+    end
+
+    # Reverse geocode a lattitude and longitude into an address
+    # Converts lattitude and longitude coordinates into an address through reverse-geocoding.
+    # @param input Input reverse geocoding request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReverseGeocodeAddressResponse, Fixnum, Hash)>] ReverseGeocodeAddressResponse data, response status code and response headers
+    def address_reverse_geocode_address_with_http_info(input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AddressApi.address_reverse_geocode_address ...'
+      end
+      # verify the required parameter 'input' is set
+      if @api_client.config.client_side_validation && input.nil?
+        fail ArgumentError, "Missing the required parameter 'input' when calling AddressApi.address_reverse_geocode_address"
+      end
+      # resource path
+      local_var_path = '/validate/address/geocode/reverse'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(input)
+      auth_names = ['Apikey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ReverseGeocodeAddressResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AddressApi#address_reverse_geocode_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Validate a street address
     # Determines if 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.
     # @param input Input parse request