Class: Buildium::AssociationOwnerPostMessage

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

Overview

This object represents the Association Owner to add when Creating a new OwnershipAccount

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssociationOwnerPostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
193
194
195
196
197
198
199
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 131

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

  if attributes.key?(:'last_name')
    self.last_name = attributes[:'last_name']
  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?(:'board_member_term')
    self.board_member_term = attributes[:'board_member_term']
  end

  if attributes.key?(:'is_owner_occupied')
    self.is_owner_occupied = attributes[:'is_owner_occupied']
  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')
    self.phone_numbers = attributes[:'phone_numbers']
  end

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

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

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

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

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

Instance Attribute Details

#alternate_address ⇒ Object

Returns the value of attribute alternate_address.



27
28
29
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 27

def alternate_address
  @alternate_address
end

#alternate_email ⇒ Object

Alternate email of owner.



38
39
40
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 38

def alternate_email
  @alternate_email
end

#board_member_term ⇒ Object

Returns the value of attribute board_member_term.



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

def board_member_term
  @board_member_term
end

#comment ⇒ Object

Comments about the owner. The value cannot exceed 65,535 characters.



48
49
50
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 48

def comment
  @comment
end

#date_of_birth ⇒ Object

Date Of Birth for the owner. Must be formatted as ‘YYYY-MM-DD`.



43
44
45
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 43

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Email of owner.



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

def email
  @email
end

#emergency_contact ⇒ Object

Returns the value of attribute emergency_contact.



45
46
47
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 45

def emergency_contact
  @emergency_contact
end

#first_name ⇒ Object

First name of the owner. The value cannot exceed 127 characters.



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

def first_name
  @first_name
end

#is_owner_occupied ⇒ Object

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



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

def is_owner_occupied
  @is_owner_occupied
end

#last_name ⇒ Object

Last name of the owner. The value cannot exceed 127 characters.



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

def last_name
  @last_name
end

#mailing_preference ⇒ Object

Mailing preferences for the owner. If an alternate address exists and this value is not provided then the primary address will be set as the preferred address.



51
52
53
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 51

def mailing_preference
  @mailing_preference
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



40
41
42
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 40

def phone_numbers
  @phone_numbers
end

#primary_address ⇒ Object

Returns the value of attribute primary_address.



25
26
27
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 25

def primary_address
  @primary_address
end

#tax_id ⇒ Object

Taxpayer identification number of the owner. Examples of United States identification numbers are Social Security number or a Employer Identification Number. Valid formats are: ‘12-1234567`, `123-12-1234`, `123456789`.



54
55
56
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 54

def tax_id
  @tax_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 79

def self.attribute_map
  {
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'primary_address' => :'PrimaryAddress',
    :'alternate_address' => :'AlternateAddress',
    :'board_member_term' => :'BoardMemberTerm',
    :'is_owner_occupied' => :'IsOwnerOccupied',
    :'email' => :'Email',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'date_of_birth' => :'DateOfBirth',
    :'emergency_contact' => :'EmergencyContact',
    :'comment' => :'Comment',
    :'mailing_preference' => :'MailingPreference',
    :'tax_id' => :'TaxId'
  }
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



282
283
284
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 282

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



124
125
126
127
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 124

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 104

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'primary_address' => :'SaveAddressMessage',
    :'alternate_address' => :'SaveAddressMessage',
    :'board_member_term' => :'AssociationOwnerBoardTermPostMessage',
    :'is_owner_occupied' => :'Boolean',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'PhoneNumbersMessage',
    :'date_of_birth' => :'Date',
    :'emergency_contact' => :'SaveEmergencyContactMessage',
    :'comment' => :'String',
    :'mailing_preference' => :'String',
    :'tax_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      primary_address == o.primary_address &&
      alternate_address == o.alternate_address &&
      board_member_term == o.board_member_term &&
      is_owner_occupied == o.is_owner_occupied &&
      email == o.email &&
      alternate_email == o.alternate_email &&
      phone_numbers == o.phone_numbers &&
      date_of_birth == o.date_of_birth &&
      emergency_contact == o.emergency_contact &&
      comment == o.comment &&
      mailing_preference == o.mailing_preference &&
      tax_id == o.tax_id
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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 313

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 384

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



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_post_message.rb', line 289

def build_from_hash(attributes)
  return nil 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


269
270
271
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 275

def hash
  [first_name, last_name, primary_address, alternate_address, board_member_term, is_owner_occupied, email, alternate_email, phone_numbers, date_of_birth, emergency_contact, comment, mailing_preference, tax_id].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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 203

def list_invalid_properties
  invalid_properties = Array.new
  if @first_name.nil?
    invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
  end

  if @last_name.nil?
    invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
  end

  if @primary_address.nil?
    invalid_properties.push('invalid value for "primary_address", primary_address cannot be nil.')
  end

  if @is_owner_occupied.nil?
    invalid_properties.push('invalid value for "is_owner_occupied", is_owner_occupied cannot be nil.')
  end

  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



360
361
362
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 366

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



354
355
356
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 354

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/buildium-ruby/models/association_owner_post_message.rb', line 226

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @primary_address.nil?
  return false if @is_owner_occupied.nil?
  mailing_preference_validator = EnumAttributeValidator.new('String', ["PrimaryAddress", "AlternateAddress"])
  return false unless mailing_preference_validator.valid?(@mailing_preference)
  true
end