Class: SquareConnect::Address
- Inherits:
-
Object
- Object
- SquareConnect::Address
- Defined in:
- lib/square_connect/models/address.rb
Overview
Represents a physical address.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#address_line_1 ⇒ Object
The first line of the address.
-
#address_line_2 ⇒ Object
The second line of the address, if any.
-
#address_line_3 ⇒ Object
The third line of the address, if any.
-
#administrative_district_level_1 ⇒ Object
A civil entity within the address’s country.
-
#administrative_district_level_2 ⇒ Object
A civil entity within the address’s ‘administrative_district_level_1`.
-
#administrative_district_level_3 ⇒ Object
A civil entity within the address’s ‘administrative_district_level_2`, if any.
-
#country ⇒ Object
The address’s country, in ISO 3166-1-alpha-2 format.
-
#first_name ⇒ Object
Optional first name when it’s representing recipient.
-
#last_name ⇒ Object
Optional last name when it’s representing recipient.
-
#locality ⇒ Object
The city or town of the address.
-
#organization ⇒ Object
Optional organization name when it’s representing recipient.
-
#postal_code ⇒ Object
The address’s postal code.
-
#sublocality ⇒ Object
A civil region within the address’s ‘locality`, if any.
-
#sublocality_2 ⇒ Object
A civil region within the address’s ‘sublocality`, if any.
-
#sublocality_3 ⇒ Object
A civil region within the address’s ‘sublocality_2`, if any.
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 = {}) ⇒ Address
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 = {}) ⇒ Address
Initializes the object
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/square_connect/models/address.rb', line 126 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?(:'address_line_1') self.address_line_1 = attributes[:'address_line_1'] end if attributes.has_key?(:'address_line_2') self.address_line_2 = attributes[:'address_line_2'] end if attributes.has_key?(:'address_line_3') self.address_line_3 = attributes[:'address_line_3'] end if attributes.has_key?(:'locality') self.locality = attributes[:'locality'] end if attributes.has_key?(:'sublocality') self.sublocality = attributes[:'sublocality'] end if attributes.has_key?(:'sublocality_2') self.sublocality_2 = attributes[:'sublocality_2'] end if attributes.has_key?(:'sublocality_3') self.sublocality_3 = attributes[:'sublocality_3'] end if attributes.has_key?(:'administrative_district_level_1') self.administrative_district_level_1 = attributes[:'administrative_district_level_1'] end if attributes.has_key?(:'administrative_district_level_2') self.administrative_district_level_2 = attributes[:'administrative_district_level_2'] end if attributes.has_key?(:'administrative_district_level_3') self.administrative_district_level_3 = attributes[:'administrative_district_level_3'] end if attributes.has_key?(:'postal_code') self.postal_code = attributes[:'postal_code'] end if attributes.has_key?(:'country') self.country = attributes[:'country'] end if attributes.has_key?(:'first_name') self.first_name = attributes[:'first_name'] end if attributes.has_key?(:'last_name') self.last_name = attributes[:'last_name'] end if attributes.has_key?(:'organization') self.organization = attributes[:'organization'] end end |
Instance Attribute Details
#address_line_1 ⇒ Object
The first line of the address. Fields that start with ‘address_line` provide the address’s most specific details, like street number, street name, and building name. They do not provide less specific details like city, state/province, or country (these details are provided in other fields).
16 17 18 |
# File 'lib/square_connect/models/address.rb', line 16 def address_line_1 @address_line_1 end |
#address_line_2 ⇒ Object
The second line of the address, if any.
19 20 21 |
# File 'lib/square_connect/models/address.rb', line 19 def address_line_2 @address_line_2 end |
#address_line_3 ⇒ Object
The third line of the address, if any.
22 23 24 |
# File 'lib/square_connect/models/address.rb', line 22 def address_line_3 @address_line_3 end |
#administrative_district_level_1 ⇒ Object
A civil entity within the address’s country. In the US, this is the state.
37 38 39 |
# File 'lib/square_connect/models/address.rb', line 37 def administrative_district_level_1 @administrative_district_level_1 end |
#administrative_district_level_2 ⇒ Object
A civil entity within the address’s ‘administrative_district_level_1`. In the US, this is the county.
40 41 42 |
# File 'lib/square_connect/models/address.rb', line 40 def administrative_district_level_2 @administrative_district_level_2 end |
#administrative_district_level_3 ⇒ Object
A civil entity within the address’s ‘administrative_district_level_2`, if any.
43 44 45 |
# File 'lib/square_connect/models/address.rb', line 43 def administrative_district_level_3 @administrative_district_level_3 end |
#country ⇒ Object
The address’s country, in ISO 3166-1-alpha-2 format.
49 50 51 |
# File 'lib/square_connect/models/address.rb', line 49 def country @country end |
#first_name ⇒ Object
Optional first name when it’s representing recipient.
52 53 54 |
# File 'lib/square_connect/models/address.rb', line 52 def first_name @first_name end |
#last_name ⇒ Object
Optional last name when it’s representing recipient.
55 56 57 |
# File 'lib/square_connect/models/address.rb', line 55 def last_name @last_name end |
#locality ⇒ Object
The city or town of the address.
25 26 27 |
# File 'lib/square_connect/models/address.rb', line 25 def locality @locality end |
#organization ⇒ Object
Optional organization name when it’s representing recipient.
58 59 60 |
# File 'lib/square_connect/models/address.rb', line 58 def organization @organization end |
#postal_code ⇒ Object
The address’s postal code.
46 47 48 |
# File 'lib/square_connect/models/address.rb', line 46 def postal_code @postal_code end |
#sublocality ⇒ Object
A civil region within the address’s ‘locality`, if any.
28 29 30 |
# File 'lib/square_connect/models/address.rb', line 28 def sublocality @sublocality end |
#sublocality_2 ⇒ Object
A civil region within the address’s ‘sublocality`, if any.
31 32 33 |
# File 'lib/square_connect/models/address.rb', line 31 def sublocality_2 @sublocality_2 end |
#sublocality_3 ⇒ Object
A civil region within the address’s ‘sublocality_2`, if any.
34 35 36 |
# File 'lib/square_connect/models/address.rb', line 34 def sublocality_3 @sublocality_3 end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/square_connect/models/address.rb', line 83 def self.attribute_map { :'address_line_1' => :'address_line_1', :'address_line_2' => :'address_line_2', :'address_line_3' => :'address_line_3', :'locality' => :'locality', :'sublocality' => :'sublocality', :'sublocality_2' => :'sublocality_2', :'sublocality_3' => :'sublocality_3', :'administrative_district_level_1' => :'administrative_district_level_1', :'administrative_district_level_2' => :'administrative_district_level_2', :'administrative_district_level_3' => :'administrative_district_level_3', :'postal_code' => :'postal_code', :'country' => :'country', :'first_name' => :'first_name', :'last_name' => :'last_name', :'organization' => :'organization' } end |
.swagger_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/square_connect/models/address.rb', line 104 def self.swagger_types { :'address_line_1' => :'String', :'address_line_2' => :'String', :'address_line_3' => :'String', :'locality' => :'String', :'sublocality' => :'String', :'sublocality_2' => :'String', :'sublocality_3' => :'String', :'administrative_district_level_1' => :'String', :'administrative_district_level_2' => :'String', :'administrative_district_level_3' => :'String', :'postal_code' => :'String', :'country' => :'String', :'first_name' => :'String', :'last_name' => :'String', :'organization' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/square_connect/models/address.rb', line 221 def ==(o) return true if self.equal?(o) self.class == o.class && address_line_1 == o.address_line_1 && address_line_2 == o.address_line_2 && address_line_3 == o.address_line_3 && locality == o.locality && sublocality == o.sublocality && sublocality_2 == o.sublocality_2 && sublocality_3 == o.sublocality_3 && administrative_district_level_1 == o.administrative_district_level_1 && administrative_district_level_2 == o.administrative_district_level_2 && administrative_district_level_3 == o.administrative_district_level_3 && postal_code == o.postal_code && country == o.country && first_name == o.first_name && last_name == o.last_name && organization == o.organization end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/square_connect/models/address.rb', line 277 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 = SquareConnect.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
343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/square_connect/models/address.rb', line 343 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
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/square_connect/models/address.rb', line 256 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 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
243 244 245 |
# File 'lib/square_connect/models/address.rb', line 243 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
249 250 251 |
# File 'lib/square_connect/models/address.rb', line 249 def hash [address_line_1, address_line_2, address_line_3, locality, sublocality, sublocality_2, sublocality_3, administrative_district_level_1, administrative_district_level_2, administrative_district_level_3, postal_code, country, first_name, last_name, organization].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
196 197 198 199 |
# File 'lib/square_connect/models/address.rb', line 196 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
323 324 325 |
# File 'lib/square_connect/models/address.rb', line 323 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
329 330 331 332 333 334 335 336 337 |
# File 'lib/square_connect/models/address.rb', line 329 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
317 318 319 |
# File 'lib/square_connect/models/address.rb', line 317 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
203 204 205 206 207 |
# File 'lib/square_connect/models/address.rb', line 203 def valid? country_validator = EnumAttributeValidator.new('String', ["ZZ", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"]) return false unless country_validator.valid?(@country) return true end |