Class: XeroRuby::Accounting::Address
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Address
- Defined in:
- lib/xero-ruby/models/accounting/address.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#address_line1 ⇒ Object
max length = 500.
-
#address_line2 ⇒ Object
max length = 500.
-
#address_line3 ⇒ Object
max length = 500.
-
#address_line4 ⇒ Object
max length = 500.
-
#address_type ⇒ Object
define the type of address.
-
#attention_to ⇒ Object
max length = 255.
-
#city ⇒ Object
max length = 255.
-
#country ⇒ Object
max length = 50, [A-Z], [a-z] only.
-
#postal_code ⇒ Object
max length = 50.
-
#region ⇒ Object
max length = 255.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_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 ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Address
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#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
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 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 104 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Address` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::Address`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'address_type') self.address_type = attributes[:'address_type'] end if attributes.key?(:'address_line1') self.address_line1 = attributes[:'address_line1'] end if attributes.key?(:'address_line2') self.address_line2 = attributes[:'address_line2'] end if attributes.key?(:'address_line3') self.address_line3 = attributes[:'address_line3'] end if attributes.key?(:'address_line4') self.address_line4 = attributes[:'address_line4'] end if attributes.key?(:'city') self.city = attributes[:'city'] end if attributes.key?(:'region') self.region = attributes[:'region'] end if attributes.key?(:'postal_code') self.postal_code = attributes[:'postal_code'] end if attributes.key?(:'country') self.country = attributes[:'country'] end if attributes.key?(:'attention_to') self.attention_to = attributes[:'attention_to'] end end |
Instance Attribute Details
#address_line1 ⇒ Object
max length = 500
22 23 24 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 22 def address_line1 @address_line1 end |
#address_line2 ⇒ Object
max length = 500
25 26 27 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 25 def address_line2 @address_line2 end |
#address_line3 ⇒ Object
max length = 500
28 29 30 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 28 def address_line3 @address_line3 end |
#address_line4 ⇒ Object
max length = 500
31 32 33 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 31 def address_line4 @address_line4 end |
#address_type ⇒ Object
define the type of address
19 20 21 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 19 def address_type @address_type end |
#attention_to ⇒ Object
max length = 255
46 47 48 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 46 def attention_to @attention_to end |
#city ⇒ Object
max length = 255
34 35 36 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 34 def city @city end |
#country ⇒ Object
max length = 50, [A-Z], [a-z] only
43 44 45 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 43 def country @country end |
#postal_code ⇒ Object
max length = 50
40 41 42 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 40 def postal_code @postal_code end |
#region ⇒ Object
max length = 255
37 38 39 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 37 def region @region end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 71 def self.attribute_map { :'address_type' => :'AddressType', :'address_line1' => :'AddressLine1', :'address_line2' => :'AddressLine2', :'address_line3' => :'AddressLine3', :'address_line4' => :'AddressLine4', :'city' => :'City', :'region' => :'Region', :'postal_code' => :'PostalCode', :'country' => :'Country', :'attention_to' => :'AttentionTo' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
350 351 352 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 350 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 87 def self.openapi_types { :'address_type' => :'String', :'address_line1' => :'String', :'address_line2' => :'String', :'address_line3' => :'String', :'address_line4' => :'String', :'city' => :'String', :'region' => :'String', :'postal_code' => :'String', :'country' => :'String', :'attention_to' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 320 def ==(o) return true if self.equal?(o) self.class == o.class && address_type == o.address_type && address_line1 == o.address_line1 && address_line2 == o.address_line2 && address_line3 == o.address_line3 && address_line4 == o.address_line4 && city == o.city && region == o.region && postal_code == o.postal_code && country == o.country && attention_to == o.attention_to end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 378 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(parse_date(value)) when :Date Date.parse(parse_date(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 XeroRuby::Accounting.const_get(type).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
443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 443 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
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 357 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_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
337 338 339 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 337 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
343 344 345 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 343 def hash [address_type, address_line1, address_line2, address_line3, address_line4, city, region, postal_code, country, attention_to].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 193 194 195 196 197 198 199 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 160 def list_invalid_properties invalid_properties = Array.new if !@address_line1.nil? && @address_line1.to_s.length > 500 invalid_properties.push('invalid value for "address_line1", the character length must be smaller than or equal to 500.') end if !@address_line2.nil? && @address_line2.to_s.length > 500 invalid_properties.push('invalid value for "address_line2", the character length must be smaller than or equal to 500.') end if !@address_line3.nil? && @address_line3.to_s.length > 500 invalid_properties.push('invalid value for "address_line3", the character length must be smaller than or equal to 500.') end if !@address_line4.nil? && @address_line4.to_s.length > 500 invalid_properties.push('invalid value for "address_line4", the character length must be smaller than or equal to 500.') end if !@city.nil? && @city.to_s.length > 255 invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 255.') end if !@region.nil? && @region.to_s.length > 255 invalid_properties.push('invalid value for "region", the character length must be smaller than or equal to 255.') end if !@postal_code.nil? && @postal_code.to_s.length > 50 invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 50.') end if !@country.nil? && @country.to_s.length > 50 invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 50.') end if !@attention_to.nil? && @attention_to.to_s.length > 255 invalid_properties.push('invalid value for "attention_to", the character length must be smaller than or equal to 255.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
458 459 460 461 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 458 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
423 424 425 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 423 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
429 430 431 432 433 434 435 436 437 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 429 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
417 418 419 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 417 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 208 209 210 211 212 213 214 215 216 |
# File 'lib/xero-ruby/models/accounting/address.rb', line 203 def valid? address_type_validator = EnumAttributeValidator.new('String', ["POBOX", "STREET", "DELIVERY"]) return false unless address_type_validator.valid?(@address_type) return false if !@address_line1.nil? && @address_line1.to_s.length > 500 return false if !@address_line2.nil? && @address_line2.to_s.length > 500 return false if !@address_line3.nil? && @address_line3.to_s.length > 500 return false if !@address_line4.nil? && @address_line4.to_s.length > 500 return false if !@city.nil? && @city.to_s.length > 255 return false if !@region.nil? && @region.to_s.length > 255 return false if !@postal_code.nil? && @postal_code.to_s.length > 50 return false if !@country.nil? && @country.to_s.length > 50 return false if !@attention_to.nil? && @attention_to.to_s.length > 255 true end |