Class: CloudmersiveValidateApiClient::AddressApi
- Inherits:
-
Object
- Object
- CloudmersiveValidateApiClient::AddressApi
- Defined in:
- lib/cloudmersive-validate-api-client/api/address_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#address_country(input, opts = {}) ⇒ ValidateCountryResponse
Validate and normalize country information, return ISO 3166-1 country codes and country name Validates and normalizes country information, and returns key information about a country.
-
#address_country_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Validate and normalize country information, return ISO 3166-1 country codes and country name Validates and normalizes country information, and returns key information about a country.
-
#address_get_timezone(input, opts = {}) ⇒ GetTimezonesResponse
Gets IANA/Olsen time zones for a country Gets the IANA/Olsen time zones for a country.
-
#address_get_timezone_with_http_info(input, opts = {}) ⇒ Array<(GetTimezonesResponse, Fixnum, Hash)>
Gets IANA/Olsen time zones for a country Gets the IANA/Olsen time zones for a country.
-
#address_parse_string(input, opts = {}) ⇒ ParseAddressResponse
Parse an unstructured input text string into an international, formatted address 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.
-
#address_parse_string_with_http_info(input, opts = {}) ⇒ Array<(ParseAddressResponse, Fixnum, Hash)>
Parse an unstructured input text string into an international, formatted address 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.
-
#address_validate_address(input, opts = {}) ⇒ ValidateAddressResponse
Validate a street address Determines if an input structured street address is valid or invalid.
-
#address_validate_address_with_http_info(input, opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>
Validate a street address Determines if an input structured street address is valid or invalid.
-
#initialize(api_client = ApiClient.default) ⇒ AddressApi
constructor
A new instance of AddressApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AddressApi
Returns a new instance of AddressApi.
19 20 21 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#address_country(input, opts = {}) ⇒ ValidateCountryResponse
Validate and normalize country information, return ISO 3166-1 country codes and country name Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
28 29 30 31 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 28 def address_country(input, opts = {}) data, _status_code, _headers = address_country_with_http_info(input, opts) return data end |
#address_country_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Validate and normalize country information, return ISO 3166-1 country codes and country name Validates and normalizes country information, and returns key information about a country. Also returns distinct time zones in the country.
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 38 def address_country_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.address_country ..." 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_country" end # resource path local_var_path = "/validate/address/country" # 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_country\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#address_get_timezone(input, opts = {}) ⇒ GetTimezonesResponse
Gets IANA/Olsen time zones for a country Gets the IANA/Olsen time zones for a country.
83 84 85 86 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 83 def address_get_timezone(input, opts = {}) data, _status_code, _headers = address_get_timezone_with_http_info(input, opts) return data end |
#address_get_timezone_with_http_info(input, opts = {}) ⇒ Array<(GetTimezonesResponse, Fixnum, Hash)>
Gets IANA/Olsen time zones for a country Gets the IANA/Olsen time zones for a country.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 93 def address_get_timezone_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.address_get_timezone ..." 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_timezone" end # resource path local_var_path = "/validate/address/country/get-timezones" # 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 => 'GetTimezonesResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_get_timezone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#address_parse_string(input, opts = {}) ⇒ ParseAddressResponse
Parse an unstructured input text string into an international, formatted address 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.
138 139 140 141 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 138 def address_parse_string(input, opts = {}) data, _status_code, _headers = address_parse_string_with_http_info(input, opts) return data end |
#address_parse_string_with_http_info(input, opts = {}) ⇒ Array<(ParseAddressResponse, Fixnum, Hash)>
Parse an unstructured input text string into an international, formatted address 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.
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 148 def address_parse_string_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.address_parse_string ..." 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_parse_string" end # resource path local_var_path = "/validate/address/parse" # 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 => 'ParseAddressResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_parse_string\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#address_validate_address(input, opts = {}) ⇒ ValidateAddressResponse
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.
193 194 195 196 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 193 def address_validate_address(input, opts = {}) data, _status_code, _headers = address_validate_address_with_http_info(input, opts) return data end |
#address_validate_address_with_http_info(input, opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>
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.
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 203 def address_validate_address_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AddressApi.address_validate_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_validate_address" end # resource path local_var_path = "/validate/address/street-address" # 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_validate_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |