Class: Buildium::LeaseRecurringCreditMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeaseRecurringCreditMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
201
202
203
204
205
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

The total amount of the recurring credit based on sum of the ‘Lines.Amount`.



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

def amount
  @amount
end

#credit_type ⇒ Object

Indicates how the credit will be applied. <ul><li>WaiveUnpaid - This credit type allows for reversing one or more charges without losing record of what has changed.</li><li>Exchange - This credit type allows for one of the following: 1) Reimburse a resident for a out-of-pocket expense, 2) Compensate for a service, 3) Write-off a resident balance considered uncollectable.</li><li>PreviouslyDeposited - This credit type allows for issuing a credit against payments that have already been deposited.</li></ul>



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

def credit_type
  @credit_type
end

#duration ⇒ Object

Specifies the period of time/occurrences the recurring payment will be processed. Note, if the ‘Frequency` field is set to `OneTime` this field should be set to `NULL` as any submitted value will be ignored.



58
59
60
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 58

def duration
  @duration
end

#first_occurrence_date ⇒ Object

The date the first occurrence this credit was processed.



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

def first_occurrence_date
  @first_occurrence_date
end

#frequency ⇒ Object

Indicates the frequency at which the recurring credit is processed.



55
56
57
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 55

def frequency
  @frequency
end

#id ⇒ Object

The unique identifier of the recurring credit schedule.



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

def id
  @id
end

#lease_id ⇒ Object

The unique identifier of the lease that the recurring credit will be applied to.



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

def lease_id
  @lease_id
end

#lines ⇒ Object

Line items describing how the credit is to be allocated when the recurring transaction is processed.



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

def lines
  @lines
end

#memo ⇒ Object

Memo associated with the recurring credit.



52
53
54
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 52

def memo
  @memo
end

#next_occurrence_date ⇒ Object

The next date the scheduled credit will be processed.



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

def next_occurrence_date
  @next_occurrence_date
end

#occurrences_remaining ⇒ Object

The number of remaining times this recurring credit will be processed.



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

def occurrences_remaining
  @occurrences_remaining
end

#offsetting_gl_account_id ⇒ Object

Offsetting general ledger account identifier. The offsetting general ledger account acts as the expense account.



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

def 
  @offsetting_gl_account_id
end

#post_days_in_advance ⇒ Object

Specifies the number of days ahead of the transaction date the credit will post on the lease ledger. This setting can be used to add the charge to the ledger ahead of the due date for visibility. For example, if the ‘FirstOccurrenceDate` is set to 8/10/2022 and this value is set to 5 then the charge will added to the ledger on 8/5/2022, but will have transaction date of 8/10/2022.



49
50
51
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 49

def post_days_in_advance
  @post_days_in_advance
end

#posting_rule_gl_account_id ⇒ Object

Indicates whether to apply a posting rule when processing the transaction that would only record the credit if a prior payment has been made. <br /><br /> Set the field value to the Rent Income general ledger account identifier if the credit should only be recorded when a payment was made and applied to the Rent Income general ledger account. <br /><br /> Set the field value to the Accounts Receivable general ledger account identifier if the credit should only be recorded when a payment was made and applied to any general ledger account. <br /><br /> Set the field value to null to always record the credit.



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

def 
  @posting_rule_gl_account_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 83

def self.attribute_map
  {
    :'id' => :'Id',
    :'lease_id' => :'LeaseId',
    :'credit_type' => :'CreditType',
    :'offsetting_gl_account_id' => :'OffsettingGLAccountId',
    :'posting_rule_gl_account_id' => :'PostingRuleGLAccountId',
    :'lines' => :'Lines',
    :'amount' => :'Amount',
    :'occurrences_remaining' => :'OccurrencesRemaining',
    :'first_occurrence_date' => :'FirstOccurrenceDate',
    :'next_occurrence_date' => :'NextOccurrenceDate',
    :'post_days_in_advance' => :'PostDaysInAdvance',
    :'memo' => :'Memo',
    :'frequency' => :'Frequency',
    :'duration' => :'Duration'
  }
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



292
293
294
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 292

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



128
129
130
131
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 108

def self.openapi_types
  {
    :'id' => :'Integer',
    :'lease_id' => :'Integer',
    :'credit_type' => :'String',
    :'offsetting_gl_account_id' => :'Integer',
    :'posting_rule_gl_account_id' => :'Integer',
    :'lines' => :'Array<RecurringTransactionLineMessage>',
    :'amount' => :'Float',
    :'occurrences_remaining' => :'Integer',
    :'first_occurrence_date' => :'Date',
    :'next_occurrence_date' => :'Date',
    :'post_days_in_advance' => :'Integer',
    :'memo' => :'String',
    :'frequency' => :'String',
    :'duration' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      lease_id == o.lease_id &&
      credit_type == o.credit_type &&
       == o. &&
       == o. &&
      lines == o.lines &&
      amount == o.amount &&
      occurrences_remaining == o.occurrences_remaining &&
      first_occurrence_date == o.first_occurrence_date &&
      next_occurrence_date == o.next_occurrence_date &&
      post_days_in_advance == o.post_days_in_advance &&
      memo == o.memo &&
      frequency == o.frequency &&
      duration == o.duration
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



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
357
358
359
360
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 323

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



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

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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 299

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


279
280
281
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 279

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



285
286
287
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 285

def hash
  [id, lease_id, credit_type, , , lines, amount, occurrences_remaining, first_occurrence_date, next_occurrence_date, post_days_in_advance, memo, frequency, duration].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



209
210
211
212
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 209

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



370
371
372
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 370

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 376

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



364
365
366
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 364

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/buildium-ruby/models/lease_recurring_credit_message.rb', line 216

def valid?
  credit_type_validator = EnumAttributeValidator.new('String', ["WaiveUnpaid", "Exchange", "PreviouslyDeposited"])
  return false unless credit_type_validator.valid?(@credit_type)
  frequency_validator = EnumAttributeValidator.new('String', ["Monthly", "Weekly", "Every2Weeks", "Quarterly", "Yearly", "Every2Months", "Daily", "Every6Months", "OneTime"])
  return false unless frequency_validator.valid?(@frequency)
  duration_validator = EnumAttributeValidator.new('String', ["Unspecified", "UntilEndOfTerm", "SpecificNumber", "SpecificDate"])
  return false unless duration_validator.valid?(@duration)
  true
end