Class: CloudmersiveValidateApiClient::NormalizeAddressResponse
- Inherits:
-
Object
- Object
- CloudmersiveValidateApiClient::NormalizeAddressResponse
- Defined in:
- lib/cloudmersive-validate-api-client/models/normalize_address_response.rb
Overview
Result of validating a street address
Instance Attribute Summary collapse
-
#building ⇒ Object
The name of the building, house or structure if applicable, such as "Cloudmersive Building 2".
-
#city ⇒ Object
The city of the address.
-
#country_full_name ⇒ Object
Country of the address, if present in the address.
-
#iso_two_letter_code ⇒ Object
Two-letter ISO 3166-1 country code.
-
#latitude ⇒ Object
If the address is valid, the degrees latitude of the validated address, null otherwise.
-
#longitude ⇒ Object
If the address is valid, the degrees longitude of the validated address, null otherwise.
-
#postal_code ⇒ Object
The postal code or zip code of the address.
-
#state_or_province ⇒ Object
The state or province of the address.
-
#street ⇒ Object
The name of the street or road of the address.
-
#street_number ⇒ Object
The street number or house number of the address.
-
#valid_address ⇒ Object
True if the address is valid, false otherwise.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ NormalizeAddressResponse
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ NormalizeAddressResponse
Initializes the object
87 88 89 90 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 130 131 132 133 134 135 136 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 87 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'ValidAddress') self.valid_address = attributes[:'ValidAddress'] end if attributes.has_key?(:'Building') self.building = attributes[:'Building'] end if attributes.has_key?(:'StreetNumber') self.street_number = attributes[:'StreetNumber'] end if attributes.has_key?(:'Street') self.street = attributes[:'Street'] end if attributes.has_key?(:'City') self.city = attributes[:'City'] end if attributes.has_key?(:'StateOrProvince') self.state_or_province = attributes[:'StateOrProvince'] end if attributes.has_key?(:'PostalCode') self.postal_code = attributes[:'PostalCode'] end if attributes.has_key?(:'CountryFullName') self.country_full_name = attributes[:'CountryFullName'] end if attributes.has_key?(:'ISOTwoLetterCode') self.iso_two_letter_code = attributes[:'ISOTwoLetterCode'] end if attributes.has_key?(:'Latitude') self.latitude = attributes[:'Latitude'] end if attributes.has_key?(:'Longitude') self.longitude = attributes[:'Longitude'] end end |
Instance Attribute Details
#building ⇒ Object
The name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.
22 23 24 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 22 def building @building end |
#city ⇒ Object
The city of the address.
31 32 33 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 31 def city @city end |
#country_full_name ⇒ Object
Country of the address, if present in the address. If not included in the address it will be null.
40 41 42 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 40 def country_full_name @country_full_name end |
#iso_two_letter_code ⇒ Object
Two-letter ISO 3166-1 country code
43 44 45 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 43 def iso_two_letter_code @iso_two_letter_code end |
#latitude ⇒ Object
If the address is valid, the degrees latitude of the validated address, null otherwise
46 47 48 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 46 def latitude @latitude end |
#longitude ⇒ Object
If the address is valid, the degrees longitude of the validated address, null otherwise
49 50 51 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 49 def longitude @longitude end |
#postal_code ⇒ Object
The postal code or zip code of the address.
37 38 39 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 37 def postal_code @postal_code end |
#state_or_province ⇒ Object
The state or province of the address.
34 35 36 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 34 def state_or_province @state_or_province end |
#street ⇒ Object
The name of the street or road of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "Pennsylvania Avenue NW".
28 29 30 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 28 def street @street end |
#street_number ⇒ Object
The street number or house number of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "1600". This value will typically be populated for most addresses.
25 26 27 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 25 def street_number @street_number end |
#valid_address ⇒ Object
True if the address is valid, false otherwise
19 20 21 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 19 def valid_address @valid_address end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 52 def self.attribute_map { :'valid_address' => :'ValidAddress', :'building' => :'Building', :'street_number' => :'StreetNumber', :'street' => :'Street', :'city' => :'City', :'state_or_province' => :'StateOrProvince', :'postal_code' => :'PostalCode', :'country_full_name' => :'CountryFullName', :'iso_two_letter_code' => :'ISOTwoLetterCode', :'latitude' => :'Latitude', :'longitude' => :'Longitude' } end |
.swagger_types ⇒ Object
Attribute type mapping.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 69 def self.swagger_types { :'valid_address' => :'BOOLEAN', :'building' => :'String', :'street_number' => :'String', :'street' => :'String', :'city' => :'String', :'state_or_province' => :'String', :'postal_code' => :'String', :'country_full_name' => :'String', :'iso_two_letter_code' => :'String', :'latitude' => :'Float', :'longitude' => :'Float' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 153 def ==(o) return true if self.equal?(o) self.class == o.class && valid_address == o.valid_address && building == o.building && street_number == o.street_number && street == o.street && city == o.city && state_or_province == o.state_or_province && postal_code == o.postal_code && country_full_name == o.country_full_name && iso_two_letter_code == o.iso_two_letter_code && latitude == o.latitude && longitude == o.longitude end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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/models/normalize_address_response.rb', line 205 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :BOOLEAN if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model temp_model = CloudmersiveValidateApiClient.const_get(type).new temp_model.build_from_hash(value) end end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
271 272 273 274 275 276 277 278 279 280 281 282 283 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 271 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 184 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(o) ⇒ Boolean
171 172 173 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 171 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
177 178 179 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 177 def hash [valid_address, building, street_number, street, city, state_or_province, postal_code, country_full_name, iso_two_letter_code, latitude, longitude].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
140 141 142 143 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 140 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
251 252 253 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 251 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
257 258 259 260 261 262 263 264 265 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 257 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
245 246 247 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 245 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
147 148 149 |
# File 'lib/cloudmersive-validate-api-client/models/normalize_address_response.rb', line 147 def valid? true end |