Class: XeroRuby::Accounting::AddressForOrganisation

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/address_for_organisation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

POBOX =
"POBOX".freeze
STREET =
"STREET".freeze
DELIVERY =
"DELIVERY".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddressForOrganisation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


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
157
158
159
160
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 108

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::AddressForOrganisation` 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::AddressForOrganisation`. 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_line1Object

max length = 500


26
27
28
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 26

def address_line1
  @address_line1
end

#address_line2Object

max length = 500


29
30
31
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 29

def address_line2
  @address_line2
end

#address_line3Object

max length = 500


32
33
34
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 32

def address_line3
  @address_line3
end

#address_line4Object

max length = 500


35
36
37
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 35

def address_line4
  @address_line4
end

#address_typeObject

define the type of address


20
21
22
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 20

def address_type
  @address_type
end

#attention_toObject

max length = 255


50
51
52
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 50

def attention_to
  @attention_to
end

#cityObject

max length = 255


38
39
40
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 38

def city
  @city
end

#countryObject

max length = 50, [A-Z], [a-z] only


47
48
49
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 47

def country
  @country
end

#postal_codeObject

max length = 50


44
45
46
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 44

def postal_code
  @postal_code
end

#regionObject

max length = 255


41
42
43
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 41

def region
  @region
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 75

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

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


354
355
356
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 354

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_typesObject

Attribute type mapping.


91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 91

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.

Parameters:

  • Object (Object)

    to be compared


324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 324

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

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


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
414
415
416
417
418
419
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 382

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 :BigDecimal
    BigDecimal(value.to_s)
  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, downcase: false) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 455

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 361

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

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

341
342
343
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 341

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


347
348
349
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 347

def hash
  [address_type, address_line1, address_line2, address_line3, address_line4, city, region, postal_code, country, attention_to].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


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
200
201
202
203
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 164

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


471
472
473
474
475
476
477
478
479
480
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 471

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


447
448
449
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 447

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


429
430
431
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 429

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


435
436
437
438
439
440
441
442
443
444
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 435

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


423
424
425
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 423

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/xero-ruby/models/accounting/address_for_organisation.rb', line 207

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