Class: Buildium::AssociationTenantPutMessage

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssociationTenantPutMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 94

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

Instance Attribute Details

#alternate_address ⇒ Object

Returns the value of attribute alternate_address.



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

def alternate_address
  @alternate_address
end

#alternate_email ⇒ Object

Alternate email of tenant.



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

def alternate_email
  @alternate_email
end

#comment ⇒ Object

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



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

def comment
  @comment
end

#date_of_birth ⇒ Object

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



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

def date_of_birth
  @date_of_birth
end

#email ⇒ Object

Email of tenant.



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

def email
  @email
end

#emergency_contact ⇒ Object

Returns the value of attribute emergency_contact.



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

def emergency_contact
  @emergency_contact
end

#first_name ⇒ Object

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



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

def first_name
  @first_name
end

#last_name ⇒ Object

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



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

def last_name
  @last_name
end

#move_out_date ⇒ Object

Move out date for the tenant. Must be formatted as ‘YYYY-MM-DD`.



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

def move_out_date
  @move_out_date
end

#phone_numbers ⇒ Object

Returns the value of attribute phone_numbers.



30
31
32
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 30

def phone_numbers
  @phone_numbers
end

#primary_address ⇒ Object

Returns the value of attribute primary_address.



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

def primary_address
  @primary_address
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 48

def self.attribute_map
  {
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'email' => :'Email',
    :'alternate_email' => :'AlternateEmail',
    :'phone_numbers' => :'PhoneNumbers',
    :'date_of_birth' => :'DateOfBirth',
    :'comment' => :'Comment',
    :'emergency_contact' => :'EmergencyContact',
    :'primary_address' => :'PrimaryAddress',
    :'alternate_address' => :'AlternateAddress',
    :'move_out_date' => :'MoveOutDate'
  }
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



251
252
253
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 251

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 70

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'email' => :'String',
    :'alternate_email' => :'String',
    :'phone_numbers' => :'AssociationTenantPutMessagePhoneNumbers',
    :'date_of_birth' => :'Date',
    :'comment' => :'String',
    :'emergency_contact' => :'AssociationTenantPostMessageEmergencyContact',
    :'primary_address' => :'AssociationTenantPostMessagePrimaryAddress',
    :'alternate_address' => :'AssociationTenantPostMessageAlternateAddress',
    :'move_out_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 220

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      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 &&
      emergency_contact == o.emergency_contact &&
      primary_address == o.primary_address &&
      alternate_address == o.alternate_address &&
      move_out_date == o.move_out_date
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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 282

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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 353

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 258

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


238
239
240
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 244

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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 154

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



329
330
331
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 335

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



323
324
325
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 323

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



181
182
183
184
185
186
187
188
 
# File 'lib/buildium-ruby/models/association_tenant_put_message.rb', line 181

def valid?
  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 @primary_address.nil?
  true
end