Class: Buildium::TenantMessage

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

Overview

This object represents a rental property tenant.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TenantMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 143

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#alternate_address ⇒ Object

Returns the value of attribute alternate_address.



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

def alternate_address
  @alternate_address
end

#alternate_email ⇒ Object

Alternate email of the tenant.



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

def alternate_email
  @alternate_email
end

#comment ⇒ Object

Comments about the tenant.



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

def comment
  @comment
end

#created_date_time ⇒ Object

Created date of this tenant record.



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

def created_date_time
  @created_date_time
end

#date_of_birth ⇒ Object

Tenant date of birth.



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

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Email for the tenant.



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

def email
  @email
end

#emergency_contact ⇒ Object

Returns the value of attribute emergency_contact.



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

def emergency_contact
  @emergency_contact
end

#first_name ⇒ Object

First name of the tenant.



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

def first_name
  @first_name
end

#id ⇒ Object

Tenant unique identifier.



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

def id
  @id
end

#last_name ⇒ Object

Last name of the tenant.



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

def last_name
  @last_name
end

#leases ⇒ Object

List of leases, regardless of status, that the tenant is associated with.



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

def leases
  @leases
end

#mailing_preference ⇒ Object

Mailing preference for the tenant.



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

def mailing_preference
  @mailing_preference
end

#phone_numbers ⇒ Object

List of phone numbers for the tenant.



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

def phone_numbers
  @phone_numbers
end

#sms_opt_in_status ⇒ Object

Indicates the tenants SMS opt in status. Null if no status exists for the tenant.



46
47
48
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 46

def sms_opt_in_status
  @sms_opt_in_status
end

#tax_id ⇒ Object

TaxId of the tenant.



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

def tax_id
  @tax_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



109
110
111
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 87

def self.attribute_map
  {
    :'id' => :'Id',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'email' => :'Email',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'created_date_time' => :'CreatedDateTime',
    :'emergency_contact' => :'EmergencyContact',
    :'date_of_birth' => :'DateOfBirth',
    :'sms_opt_in_status' => :'SMSOptInStatus',
    :'address' => :'Address',
    :'alternate_address' => :'AlternateAddress',
    :'mailing_preference' => :'MailingPreference',
    :'leases' => :'Leases',
    :'comment' => :'Comment',
    :'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



288
289
290
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 288

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



136
137
138
139
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 136

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

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 114

def self.openapi_types
  {
    :'id' => :'Integer',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'Array<PhoneNumberMessage>',
    :'created_date_time' => :'Time',
    :'emergency_contact' => :'EmergencyContactMessage',
    :'date_of_birth' => :'Date',
    :'sms_opt_in_status' => :'String',
    :'address' => :'AddressMessage',
    :'alternate_address' => :'AddressMessage',
    :'mailing_preference' => :'String',
    :'leases' => :'Array<LeaseMessage>',
    :'comment' => :'String',
    :'tax_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 252

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 &&
      created_date_time == o.created_date_time &&
      emergency_contact == o.emergency_contact &&
      date_of_birth == o.date_of_birth &&
      sms_opt_in_status == o.sms_opt_in_status &&
      address == o.address &&
      alternate_address == o.alternate_address &&
      mailing_preference == o.mailing_preference &&
      leases == o.leases &&
      comment == o.comment &&
      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



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
351
352
353
354
355
356
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 319

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 390

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 295

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



281
282
283
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 281

def hash
  [id, first_name, last_name, email, alternate_email, phone_numbers, created_date_time, emergency_contact, date_of_birth, sms_opt_in_status, address, alternate_address, mailing_preference, leases, comment, 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



227
228
229
230
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 227

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



366
367
368
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 366

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 372

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



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

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



234
235
236
237
238
 
# File 'lib/buildium-ruby/models/tenant_message.rb', line 234

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