Class: Buildium::AssociationOwnerMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/buildium-ruby/models/association_owner_message.rb

Overview

This object represents an owner of a unit(s) that exists within a home owner association.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssociationOwnerMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 153

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Buildium::AssociationOwnerMessage` 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 `Buildium::AssociationOwnerMessage`. 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?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'first_name')
    self.first_name = attributes[:'first_name']
  end

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.key?(:'alternate_email')
    self.alternate_email = attributes[:'alternate_email']
  end

  if attributes.key?(:'phone_numbers')
    if (value = attributes[:'phone_numbers']).is_a?(Array)
      self.phone_numbers = value
    end
  end

  if attributes.key?(:'primary_address')
    self.primary_address = attributes[:'primary_address']
  end

  if attributes.key?(:'alternate_address')
    self.alternate_address = attributes[:'alternate_address']
  end

  if attributes.key?(:'comment')
    self.comment = attributes[:'comment']
  end

  if attributes.key?(:'emergency_contact')
    self.emergency_contact = attributes[:'emergency_contact']
  end

  if attributes.key?(:'ownership_accounts')
    if (value = attributes[:'ownership_accounts']).is_a?(Array)
      self.ownership_accounts = value
    end
  end

  if attributes.key?(:'mailing_preference')
    self.mailing_preference = attributes[:'mailing_preference']
  end

  if attributes.key?(:'vehicles')
    if (value = attributes[:'vehicles']).is_a?(Array)
      self.vehicles = value
    end
  end

  if attributes.key?(:'occupies_unit')
    self.occupies_unit = attributes[:'occupies_unit']
  end

  if attributes.key?(:'board_member_terms')
    if (value = attributes[:'board_member_terms']).is_a?(Array)
      self.board_member_terms = value
    end
  end

  if attributes.key?(:'created_date_time')
    self.created_date_time = attributes[:'created_date_time']
  end

  if attributes.key?(:'tax_id')
    self.tax_id = attributes[:'tax_id']
  end

  if attributes.key?(:'delinquency_status')
    self.delinquency_status = attributes[:'delinquency_status']
  end
end

Instance Attribute Details

#alternate_address ⇒ Object

Returns the value of attribute alternate_address.



39
40
41
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 39

def alternate_address
  @alternate_address
end

#alternate_email ⇒ Object

Alternate email.



32
33
34
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 32

def alternate_email
  @alternate_email
end

#board_member_terms ⇒ Object

List of Board Member Terms for the given Association Owner(s)



59
60
61
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 59

def board_member_terms
  @board_member_terms
end

#comment ⇒ Object

General comments.



42
43
44
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 42

def comment
  @comment
end

#created_date_time ⇒ Object

Date and time the association owner was created.



62
63
64
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 62

def created_date_time
  @created_date_time
end

#delinquency_status ⇒ Object

Indicates the delinquency status of the association owner.



68
69
70
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 68

def delinquency_status
  @delinquency_status
end

#email ⇒ Object

Email.



29
30
31
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 29

def email
  @email
end

#emergency_contact ⇒ Object

Returns the value of attribute emergency_contact.



44
45
46
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 44

def emergency_contact
  @emergency_contact
end

#first_name ⇒ Object

First name.



23
24
25
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 23

def first_name
  @first_name
end

#id ⇒ Object

Unique identifier.



20
21
22
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 20

def id
  @id
end

#last_name ⇒ Object

Last name.



26
27
28
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 26

def last_name
  @last_name
end

#mailing_preference ⇒ Object

Indicates the association owner’s mailing preference.



50
51
52
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 50

def mailing_preference
  @mailing_preference
end

#occupies_unit ⇒ Object

Indicates if the association owner occupies a unit(s) within the association.



56
57
58
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 56

def occupies_unit
  @occupies_unit
end

#ownership_accounts ⇒ Object

List of associated ownership accounts.



47
48
49
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 47

def ownership_accounts
  @ownership_accounts
end

#phone_numbers ⇒ Object

List of phone numbers of the association user.



35
36
37
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 35

def phone_numbers
  @phone_numbers
end

#primary_address ⇒ Object

Returns the value of attribute primary_address.



37
38
39
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 37

def primary_address
  @primary_address
end

#tax_id ⇒ Object

Taxpayer identification number. Examples of United States identification numbers are Social Security number or a Employer Identification Number.



65
66
67
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 65

def tax_id
  @tax_id
end

#vehicles ⇒ Object

List of vehicles associated with the association owner.



53
54
55
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 53

def vehicles
  @vehicles
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 93

def self.attribute_map
  {
    :'id' => :'Id',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'email' => :'Email',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'primary_address' => :'PrimaryAddress',
    :'alternate_address' => :'AlternateAddress',
    :'comment' => :'Comment',
    :'emergency_contact' => :'EmergencyContact',
    :'ownership_accounts' => :'OwnershipAccounts',
    :'mailing_preference' => :'MailingPreference',
    :'vehicles' => :'Vehicles',
    :'occupies_unit' => :'OccupiesUnit',
    :'board_member_terms' => :'BoardMemberTerms',
    :'created_date_time' => :'CreatedDateTime',
    :'tax_id' => :'TaxId',
    :'delinquency_status' => :'DelinquencyStatus'
  }
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



324
325
326
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 324

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 146

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 122

def self.openapi_types
  {
    :'id' => :'Integer',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'Array<PhoneNumberMessage>',
    :'primary_address' => :'AddressMessage',
    :'alternate_address' => :'AddressMessage',
    :'comment' => :'String',
    :'emergency_contact' => :'EmergencyContactMessage',
    :'ownership_accounts' => :'Array<AssociationOwnershipAccountMessage>',
    :'mailing_preference' => :'String',
    :'vehicles' => :'Array<VehicleMessage>',
    :'occupies_unit' => :'Boolean',
    :'board_member_terms' => :'Array<AssociationOwnerBoardTermMessage>',
    :'created_date_time' => :'Time',
    :'tax_id' => :'String',
    :'delinquency_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      email == o.email &&
      alternate_email == o.alternate_email &&
      phone_numbers == o.phone_numbers &&
      primary_address == o.primary_address &&
      alternate_address == o.alternate_address &&
      comment == o.comment &&
      emergency_contact == o.emergency_contact &&
      ownership_accounts == o.ownership_accounts &&
      mailing_preference == o.mailing_preference &&
      vehicles == o.vehicles &&
      occupies_unit == o.occupies_unit &&
      board_member_terms == o.board_member_terms &&
      created_date_time == o.created_date_time &&
      tax_id == o.tax_id &&
      delinquency_status == o.delinquency_status
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



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
392
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 355

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Buildium.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 426

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 331

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 317

def hash
  [id, first_name, last_name, email, alternate_email, phone_numbers, primary_address, alternate_address, comment, emergency_contact, ownership_accounts, mailing_preference, vehicles, occupies_unit, board_member_terms, created_date_time, tax_id, delinquency_status].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



249
250
251
252
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 249

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 402

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 408

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



396
397
398
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 396

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



256
257
258
259
260
261
262
 
# File 'lib/buildium-ruby/models/association_owner_message.rb', line 256

def valid?
  mailing_preference_validator = EnumAttributeValidator.new('String', ["PrimaryAddress", "AlternateAddress"])
  return false unless mailing_preference_validator.valid?(@mailing_preference)
  delinquency_status_validator = EnumAttributeValidator.new('String', ["NoDelinquency", "InCollections", "InForeclosure", "Foreclosed"])
  return false unless delinquency_status_validator.valid?(@delinquency_status)
  true
end