Class: Buildium::LeaseRenewalPostMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeaseRenewalPostMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'cosigners')
    if (value = attributes[:'cosigners']).is_a?(Array)
      self.cosigners = 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?(:'tenants')
    if (value = attributes[:'tenants']).is_a?(Array)
      self.tenants = value
    end
  end

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

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

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

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

Instance Attribute Details

#automatically_move_out_tenants ⇒ Object

Indicates whether to automatically move out all tenants assigned to the lease and set the lease status to past when the lease ends.



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

def automatically_move_out_tenants
  @automatically_move_out_tenants
end

#cosigners ⇒ Object

List of the cosigners to create on the lease.



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

def cosigners
  @cosigners
end

#lease_to_date ⇒ Object

End date of the lease. This is required if ‘LeaseType` is `Fixed` or `FixedWithRollover`



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

def lease_to_date
  @lease_to_date
end

#lease_type ⇒ Object

Describes the type of lease.



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

def lease_type
  @lease_type
end

#recurring_charges_to_create ⇒ Object

List of new recurring charges to create.



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

def recurring_charges_to_create
  @recurring_charges_to_create
end

#recurring_charges_to_stop ⇒ Object

Unique identifiers of existing recurring charges on the lease to stop.



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

def recurring_charges_to_stop
  @recurring_charges_to_stop
end

#recurring_charges_to_update ⇒ Object

List of existing recurring charges to update.



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

def recurring_charges_to_update
  @recurring_charges_to_update
end

#rent ⇒ Object

Returns the value of attribute rent.



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

def rent
  @rent
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.



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

def send_welcome_email
  @send_welcome_email
end

#tenant_ids ⇒ Object

Unique identifiers of existing tenants to include on the lease. The request must include at least one tenant in this property OR the ‘Tenants` property.



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

def tenant_ids
  @tenant_ids
end

#tenants ⇒ Object

List of new tenants to create on the lease. The request must include at least one tenant in this property OR the ‘TenantIds` property.



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

def tenants
  @tenants
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 73

def self.attribute_map
  {
    :'lease_type' => :'LeaseType',
    :'lease_to_date' => :'LeaseToDate',
    :'automatically_move_out_tenants' => :'AutomaticallyMoveOutTenants',
    :'rent' => :'Rent',
    :'cosigners' => :'Cosigners',
    :'tenant_ids' => :'TenantIds',
    :'tenants' => :'Tenants',
    :'send_welcome_email' => :'SendWelcomeEmail',
    :'recurring_charges_to_stop' => :'RecurringChargesToStop',
    :'recurring_charges_to_create' => :'RecurringChargesToCreate',
    :'recurring_charges_to_update' => :'RecurringChargesToUpdate'
  }
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



262
263
264
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 262

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 95

def self.openapi_types
  {
    :'lease_type' => :'String',
    :'lease_to_date' => :'Date',
    :'automatically_move_out_tenants' => :'Boolean',
    :'rent' => :'LeaseRentPostMessage',
    :'cosigners' => :'Array<LeaseCosignerPostMessage>',
    :'tenant_ids' => :'Array<Integer>',
    :'tenants' => :'Array<RentalTenantRenewalPostMessage>',
    :'send_welcome_email' => :'Boolean',
    :'recurring_charges_to_stop' => :'Array<Integer>',
    :'recurring_charges_to_create' => :'Array<ChargeRecurringTransactionPostMessage>',
    :'recurring_charges_to_update' => :'Array<ChargeRecurringTransactionPutMessage>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      lease_type == o.lease_type &&
      lease_to_date == o.lease_to_date &&
      automatically_move_out_tenants == o.automatically_move_out_tenants &&
      rent == o.rent &&
      cosigners == o.cosigners &&
      tenant_ids == o.tenant_ids &&
      tenants == o.tenants &&
      send_welcome_email == o.send_welcome_email &&
      recurring_charges_to_stop == o.recurring_charges_to_stop &&
      recurring_charges_to_create == o.recurring_charges_to_create &&
      recurring_charges_to_update == o.recurring_charges_to_update
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



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
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 293

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



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

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 269

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


249
250
251
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 255

def hash
  [lease_type, lease_to_date, automatically_move_out_tenants, rent, cosigners, tenant_ids, tenants, send_welcome_email, recurring_charges_to_stop, recurring_charges_to_create, recurring_charges_to_update].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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 191

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



340
341
342
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 340

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 346

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



334
335
336
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 334

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



210
211
212
213
214
215
216
217
 
# File 'lib/buildium-ruby/models/lease_renewal_post_message.rb', line 210

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 @rent.nil?
  return false if @send_welcome_email.nil?
  true
end