Class: Buildium::RentalTenantPostMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RentalTenantPostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



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

def address
  @address
end

#alternate_address ⇒ Object

Returns the value of attribute alternate_address.



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

def alternate_address
  @alternate_address
end

#alternate_email ⇒ Object

Alternate email of the tenant.



31
32
33
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 31

def alternate_email
  @alternate_email
end

#comment ⇒ Object

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



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

def comment
  @comment
end

#date_of_birth ⇒ Object

Date of birth for the tenant. Must be formatted as ‘YYYY-MM-DD`.



36
37
38
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 36

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Email of the tenant.



28
29
30
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 28

def email
  @email
end

#emergency_contact ⇒ Object

Returns the value of attribute emergency_contact.



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

def emergency_contact
  @emergency_contact
end

#first_name ⇒ Object

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



22
23
24
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 22

def first_name
  @first_name
end

#last_name ⇒ Object

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



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

def last_name
  @last_name
end

#lease_id ⇒ Object

Lease ID to associate the tenant with.



19
20
21
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 19

def lease_id
  @lease_id
end

#mailing_preference ⇒ Object

Mailing preference for the tenant. 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/rental_tenant_post_message.rb', line 51

def mailing_preference
  @mailing_preference
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



33
34
35
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 33

def phone_numbers
  @phone_numbers
end

#tax_id ⇒ Object

Tax identifier of the tenant. Valid formats are: ‘12-1234567`, `123-12-1234`, `123456789`



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

def tax_id
  @tax_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 76

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



310
311
312
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 310

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



119
120
121
122
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 100

def self.openapi_types
  {
    :'lease_id' => :'Integer',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'AssociationTenantPostMessagePhoneNumbers',
    :'date_of_birth' => :'Date',
    :'comment' => :'String',
    :'tax_id' => :'String',
    :'emergency_contact' => :'AssociationTenantPostMessageEmergencyContact',
    :'address' => :'AssociationTenantPostMessagePrimaryAddress',
    :'alternate_address' => :'AssociationTenantPostMessageAlternateAddress',
    :'mailing_preference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 277

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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 341

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 412

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 317

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


297
298
299
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 303

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



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

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

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

  if @first_name.to_s.length < 1
    invalid_properties.push('invalid value for "first_name", the character length must be great than or equal to 1.')
  end

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

  if @last_name.to_s.length < 1
    invalid_properties.push('invalid value for "last_name", the character length must be great than or equal to 1.')
  end

  if @address.nil?
    invalid_properties.push('invalid value for "address", address 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



388
389
390
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 388

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



394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 394

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



382
383
384
 
# File 'lib/buildium-ruby/models/rental_tenant_post_message.rb', line 382

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



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

def valid?
  return false if @lease_id.nil?
  return false if @first_name.nil?
  return false if @first_name.to_s.length < 1
  return false if @last_name.nil?
  return false if @last_name.to_s.length < 1
  return false if @address.nil?
  mailing_preference_validator = EnumAttributeValidator.new('String', ["PrimaryAddress", "AlternateAddress"])
  return false unless mailing_preference_validator.valid?(@mailing_preference)
  true
end