Class: Buildium::LeasePostMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeasePostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/buildium-ruby/models/lease_post_message.rb', line 128

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#applicant_ids ⇒ Object

List of identifiers for applicants to become tenants on the lease. Identifiers must refer to applicants with a Status of ‘Approved`. The list cannot exceed five applicants.



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

def applicant_ids
  @applicant_ids
end

#cosigners ⇒ Object

List of the cosigners on the lease.



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

def cosigners
  @cosigners
end

#lease_from_date ⇒ Object

Start date of the lease.



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

def lease_from_date
  @lease_from_date
end

#lease_to_date ⇒ Object

End date of the lease.



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

def lease_to_date
  @lease_to_date
end

#lease_type ⇒ Object

Describes the type of lease.<br /><br /> ‘AtWill` leases are month-to-month leases. Setting a lease as at will tells Buildium when the tenant’s lease initially started, but since there is no lease end date, Buildium will never move the lease to expired, and it will continue to post any automatic transactions (like recurring monthly rent charges or late fees) until you manually end the lease. <br /><br /> ‘Fixed` leases are leases that have specific start and end dates.When the end date occurs, the lease will move from active to expired, and any transactions set to post automatically(like recurring monthly rent charges or late fees) will stop posting. <br /><br /> `FixedWithRollover` leases are similar to fixed leases, but instead of Buildium moving this lease to expired as of the end date, it will move the lease to an at will status, which tells Buildium to continue posting monthly rent charges, late fees for you until you manually end the lease.



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

def lease_type
  @lease_type
end

#prorated_first_month_rent ⇒ Object

Prorated rent charged for the first month of the lease. Must be null if the lease begins on the first day of a month.



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

def prorated_first_month_rent
  @prorated_first_month_rent
end

#prorated_last_month_rent ⇒ Object

Prorated rent charged for the last month of the lease. Must be null if the lease ends on the last day of a month.



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

def prorated_last_month_rent
  @prorated_last_month_rent
end

#rent ⇒ Object

Returns the value of attribute rent.



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

def rent
  @rent
end

#security_deposit ⇒ Object

Returns the value of attribute security_deposit.



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

def security_deposit
  @security_deposit
end

#send_welcome_email ⇒ Object

Indicates whether to send a welcome email to all tenants on the lease inviting them to the resident center website.



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

def send_welcome_email
  @send_welcome_email
end

#tenant_ids ⇒ Object

List of identifiers for existing tenants to add to the lease. The list cannot exceed five tenants.



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

def tenant_ids
  @tenant_ids
end

#tenants ⇒ Object

List of new tenants to add to the lease. The list cannot exceed five tenants.



34
35
36
 
# File 'lib/buildium-ruby/models/lease_post_message.rb', line 34

def tenants
  @tenants
end

#unit_id ⇒ Object

Unit unique identifier associated with the lease.



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

def unit_id
  @unit_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



97
98
99
 
# File 'lib/buildium-ruby/models/lease_post_message.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'lease_type' => :'LeaseType',
    :'unit_id' => :'UnitId',
    :'lease_from_date' => :'LeaseFromDate',
    :'lease_to_date' => :'LeaseToDate',
    :'send_welcome_email' => :'SendWelcomeEmail',
    :'tenants' => :'Tenants',
    :'tenant_ids' => :'TenantIds',
    :'applicant_ids' => :'ApplicantIds',
    :'cosigners' => :'Cosigners',
    :'rent' => :'Rent',
    :'security_deposit' => :'SecurityDeposit',
    :'prorated_first_month_rent' => :'ProratedFirstMonthRent',
    :'prorated_last_month_rent' => :'ProratedLastMonthRent'
  }
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/lease_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



121
122
123
124
 
# File 'lib/buildium-ruby/models/lease_post_message.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'lease_type' => :'String',
    :'unit_id' => :'Integer',
    :'lease_from_date' => :'Date',
    :'lease_to_date' => :'Date',
    :'send_welcome_email' => :'Boolean',
    :'tenants' => :'Array<RentalTenantPutMessage>',
    :'tenant_ids' => :'Array<Integer>',
    :'applicant_ids' => :'Array<Integer>',
    :'cosigners' => :'Array<LeaseCosignerPostMessage>',
    :'rent' => :'LeaseRentPostMessage',
    :'security_deposit' => :'LeaseSecurityDepositPostMessage',
    :'prorated_first_month_rent' => :'Float',
    :'prorated_last_month_rent' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      lease_type == o.lease_type &&
      unit_id == o.unit_id &&
      lease_from_date == o.lease_from_date &&
      lease_to_date == o.lease_to_date &&
      send_welcome_email == o.send_welcome_email &&
      tenants == o.tenants &&
      tenant_ids == o.tenant_ids &&
      applicant_ids == o.applicant_ids &&
      cosigners == o.cosigners &&
      rent == o.rent &&
      security_deposit == o.security_deposit &&
      prorated_first_month_rent == o.prorated_first_month_rent &&
      prorated_last_month_rent == o.prorated_last_month_rent
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/lease_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/lease_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/lease_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/lease_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/lease_post_message.rb', line 275

def hash
  [lease_type, unit_id, lease_from_date, lease_to_date, send_welcome_email, tenants, tenant_ids, applicant_ids, cosigners, rent, security_deposit, prorated_first_month_rent, prorated_last_month_rent].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



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/lease_post_message.rb', line 204

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

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

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

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



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

def valid?
  return false if @lease_type.nil?
  lease_type_validator = EnumAttributeValidator.new('String', ["Fixed", "FixedWithRollover", "AtWill"])
  return false unless lease_type_validator.valid?(@lease_type)
  return false if @unit_id.nil?
  return false if @lease_from_date.nil?
  return false if @send_welcome_email.nil?
  true
end