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_check_eu_membership(input, opts = {}) ⇒ ValidateCountryResponse
Check if a country is a member of the European Union (EU) Checks if the input country is a member of the European Union or not.
-
#address_check_eu_membership_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Check if a country is a member of the European Union (EU) Checks if the input country is a member of the European Union or not.
-
#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, as well as whether it is a member of the European Union.
-
#address_country_list(opts = {}) ⇒ CountryListResult
Get a list of ISO 3166-1 countries Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
-
#address_country_list_with_http_info(opts = {}) ⇒ Array<(CountryListResult, Fixnum, Hash)>
Get a list of ISO 3166-1 countries Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
-
#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, as well as whether it is a member of the European Union.
-
#address_geocode(input, opts = {}) ⇒ ValidateAddressResponse
Geocode a street address into latitude and longitude Geocodes a street address into latitude and longitude.
-
#address_geocode_with_http_info(input, opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>
Geocode a street address into latitude and longitude Geocodes a street address into latitude and longitude.
-
#address_get_country_currency(input, opts = {}) ⇒ ValidateCountryResponse
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.
-
#address_get_country_currency_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
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.
-
#address_get_country_region(input, opts = {}) ⇒ ValidateCountryResponse
Get the region, subregion and continent of the country Gets the continent information including region and subregion for the input country.
-
#address_get_country_region_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Get the region, subregion and continent of the country Gets the continent information including region and subregion for the input 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_normalize_address(input, opts = {}) ⇒ NormalizeAddressResponse
Normalize a street address Normalizes an input structured street address is valid or invalid.
-
#address_normalize_address_with_http_info(input, opts = {}) ⇒ Array<(NormalizeAddressResponse, Fixnum, Hash)>
Normalize a street address Normalizes an input structured street address is valid or invalid.
-
#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_reverse_geocode_address(input, opts = {}) ⇒ ReverseGeocodeAddressResponse
Reverse geocode a lattitude and longitude into an address Converts lattitude and longitude coordinates into an address through reverse-geocoding.
-
#address_reverse_geocode_address_with_http_info(input, opts = {}) ⇒ Array<(ReverseGeocodeAddressResponse, Fixnum, Hash)>
Reverse geocode a lattitude and longitude into an address Converts lattitude and longitude coordinates into an address through reverse-geocoding.
-
#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.
-
#address_validate_city(input, opts = {}) ⇒ ValidateCityResponse
Validate a City and State/Province combination, get location information about it Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more.
-
#address_validate_city_with_http_info(input, opts = {}) ⇒ Array<(ValidateCityResponse, Fixnum, Hash)>
Validate a City and State/Province combination, get location information about it Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more.
-
#address_validate_postal_code(input, opts = {}) ⇒ ValidatePostalCodeResponse
Validate a postal code, get location information about it Checks if the input postal code is valid, and returns information about it such as City, State and more.
-
#address_validate_postal_code_with_http_info(input, opts = {}) ⇒ Array<(ValidatePostalCodeResponse, Fixnum, Hash)>
Validate a postal code, get location information about it Checks if the input postal code is valid, and returns information about it such as City, State and more.
-
#address_validate_state(input, opts = {}) ⇒ ValidateStateResponse
Validate a state or province, name or abbreviation, get location information about it Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.
-
#address_validate_state_with_http_info(input, opts = {}) ⇒ Array<(ValidateStateResponse, Fixnum, Hash)>
Validate a state or province, name or abbreviation, get location information about it Checks if the input state name or code is valid, and returns information about it such as normalized State name and more.
-
#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_check_eu_membership(input, opts = {}) ⇒ ValidateCountryResponse
Check if a country is a member of the European Union (EU) Checks if the input country is a member of the European Union or not.
27 28 29 30 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 27 def address_check_eu_membership(input, opts = {}) data, _status_code, _headers = address_check_eu_membership_with_http_info(input, opts) data end |
#address_check_eu_membership_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Check if a country is a member of the European Union (EU) Checks if the input country is a member of the European Union or not.
37 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 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 37 def address_check_eu_membership_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_check_eu_membership ...' 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_check_eu_membership" end # resource path local_var_path = '/validate/address/country/check-eu-membership' # 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_check_eu_membership\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#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, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.
81 82 83 84 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 81 def address_country(input, opts = {}) data, _status_code, _headers = address_country_with_http_info(input, opts) data end |
#address_country_list(opts = {}) ⇒ CountryListResult
Get a list of ISO 3166-1 countries Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
134 135 136 137 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 134 def address_country_list(opts = {}) data, _status_code, _headers = address_country_list_with_http_info(opts) data end |
#address_country_list_with_http_info(opts = {}) ⇒ Array<(CountryListResult, Fixnum, Hash)>
Get a list of ISO 3166-1 countries Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.
143 144 145 146 147 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 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 143 def address_country_list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_country_list ...' end # resource path local_var_path = '/validate/address/country/list' # 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']) # form parameters form_params = {} # http body (model) post_body = nil 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 => 'CountryListResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_country_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers 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, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.
91 92 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 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 91 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_geocode(input, opts = {}) ⇒ ValidateAddressResponse
Geocode a street address into latitude and longitude Geocodes a street address into latitude and longitude.
181 182 183 184 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 181 def address_geocode(input, opts = {}) data, _status_code, _headers = address_geocode_with_http_info(input, opts) data end |
#address_geocode_with_http_info(input, opts = {}) ⇒ Array<(ValidateAddressResponse, Fixnum, Hash)>
Geocode a street address into latitude and longitude Geocodes a street address into latitude and longitude.
191 192 193 194 195 196 197 198 199 200 201 202 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 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 191 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 |
#address_get_country_currency(input, opts = {}) ⇒ ValidateCountryResponse
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.
235 236 237 238 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 235 def address_get_country_currency(input, opts = {}) data, _status_code, _headers = address_get_country_currency_with_http_info(input, opts) data end |
#address_get_country_currency_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
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.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 245 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 |
#address_get_country_region(input, opts = {}) ⇒ ValidateCountryResponse
Get the region, subregion and continent of the country Gets the continent information including region and subregion for the input country.
289 290 291 292 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 289 def address_get_country_region(input, opts = {}) data, _status_code, _headers = address_get_country_region_with_http_info(input, opts) data end |
#address_get_country_region_with_http_info(input, opts = {}) ⇒ Array<(ValidateCountryResponse, Fixnum, Hash)>
Get the region, subregion and continent of the country Gets the continent information including region and subregion for the input country.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 299 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 |
#address_get_timezone(input, opts = {}) ⇒ GetTimezonesResponse
Gets IANA/Olsen time zones for a country Gets the IANA/Olsen time zones for a country.
343 344 345 346 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 343 def address_get_timezone(input, opts = {}) data, _status_code, _headers = address_get_timezone_with_http_info(input, opts) 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.
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 353 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_normalize_address(input, opts = {}) ⇒ NormalizeAddressResponse
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.
397 398 399 400 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 397 def address_normalize_address(input, opts = {}) data, _status_code, _headers = address_normalize_address_with_http_info(input, opts) data end |
#address_normalize_address_with_http_info(input, opts = {}) ⇒ Array<(NormalizeAddressResponse, Fixnum, Hash)>
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.
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 407 def address_normalize_address_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_normalize_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_normalize_address" end # resource path local_var_path = '/validate/address/street-address/normalize' # 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 => 'NormalizeAddressResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_normalize_address\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.
451 452 453 454 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 451 def address_parse_string(input, opts = {}) data, _status_code, _headers = address_parse_string_with_http_info(input, opts) 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.
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 461 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_reverse_geocode_address(input, opts = {}) ⇒ ReverseGeocodeAddressResponse
Reverse geocode a lattitude and longitude into an address Converts lattitude and longitude coordinates into an address through reverse-geocoding.
505 506 507 508 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 505 def address_reverse_geocode_address(input, opts = {}) data, _status_code, _headers = address_reverse_geocode_address_with_http_info(input, opts) data end |
#address_reverse_geocode_address_with_http_info(input, opts = {}) ⇒ Array<(ReverseGeocodeAddressResponse, Fixnum, Hash)>
Reverse geocode a lattitude and longitude into an address Converts lattitude and longitude coordinates into an address through reverse-geocoding.
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 515 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 |
#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. Supports all major international addresses.
559 560 561 562 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 559 def address_validate_address(input, opts = {}) data, _status_code, _headers = address_validate_address_with_http_info(input, opts) 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. Supports all major international addresses.
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 569 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 |
#address_validate_city(input, opts = {}) ⇒ ValidateCityResponse
Validate a City and State/Province combination, get location information about it Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.
613 614 615 616 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 613 def address_validate_city(input, opts = {}) data, _status_code, _headers = address_validate_city_with_http_info(input, opts) data end |
#address_validate_city_with_http_info(input, opts = {}) ⇒ Array<(ValidateCityResponse, Fixnum, Hash)>
Validate a City and State/Province combination, get location information about it Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 623 def address_validate_city_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_city ...' 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_city" end # resource path local_var_path = '/validate/address/city' # 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 => 'ValidateCityResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_validate_city\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#address_validate_postal_code(input, opts = {}) ⇒ ValidatePostalCodeResponse
Validate a postal code, get location information about it Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.
667 668 669 670 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 667 def address_validate_postal_code(input, opts = {}) data, _status_code, _headers = address_validate_postal_code_with_http_info(input, opts) data end |
#address_validate_postal_code_with_http_info(input, opts = {}) ⇒ Array<(ValidatePostalCodeResponse, Fixnum, Hash)>
Validate a postal code, get location information about it Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 677 def address_validate_postal_code_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_postal_code ...' 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_postal_code" end # resource path local_var_path = '/validate/address/postal-code' # 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 => 'ValidatePostalCodeResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_validate_postal_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#address_validate_state(input, opts = {}) ⇒ ValidateStateResponse
Validate a state or province, name or abbreviation, get location information about it Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.
721 722 723 724 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 721 def address_validate_state(input, opts = {}) data, _status_code, _headers = address_validate_state_with_http_info(input, opts) data end |
#address_validate_state_with_http_info(input, opts = {}) ⇒ Array<(ValidateStateResponse, Fixnum, Hash)>
Validate a state or province, name or abbreviation, get location information about it Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 |
# File 'lib/cloudmersive-validate-api-client/api/address_api.rb', line 731 def address_validate_state_with_http_info(input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AddressApi.address_validate_state ...' 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_state" end # resource path local_var_path = '/validate/address/state' # 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 => 'ValidateStateResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AddressApi#address_validate_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |