Class: Buildium::LeaseRecurringPaymentMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LeaseRecurringPaymentMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

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



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

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



51
52
53
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 51

def duration
  @duration
end

#first_occurrence_date ⇒ Object

The date the first occurrence this payment was processed.



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

def first_occurrence_date
  @first_occurrence_date
end

#frequency ⇒ Object

Indicates the frequency at which the recurring payment is processed.



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

def frequency
  @frequency
end

#id ⇒ Object

The unique identifier for the recurring payment schedule.



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

def id
  @id
end

#lease_id ⇒ Object

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



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

def lease_id
  @lease_id
end

#lines ⇒ Object

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



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

def lines
  @lines
end

#memo ⇒ Object

Memo associated with the recurring payment.



54
55
56
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 54

def memo
  @memo
end

#next_occurrence_date ⇒ Object

The next date the scheduled payment will be processed.



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

def next_occurrence_date
  @next_occurrence_date
end

#occurrences_remaining ⇒ Object

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



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

def occurrences_remaining
  @occurrences_remaining
end

#payer ⇒ Object

Returns the value of attribute payer.



24
25
26
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 24

def payer
  @payer
end

#payment_method ⇒ Object

The method of payment for the transaction.



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

def payment_method
  @payment_method
end

#post_days_in_advance ⇒ Object

Specifies the number of days ahead of the transaction date the payment 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.



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

def post_days_in_advance
  @post_days_in_advance
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



281
282
283
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 281

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      lease_id == o.lease_id &&
      payer == o.payer &&
      payment_method == o.payment_method &&
      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 &&
      frequency == o.frequency &&
      duration == o.duration &&
      memo == o.memo
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



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

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



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 383

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 288

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


268
269
270
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 268

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



274
275
276
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 274

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



199
200
201
202
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 199

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



359
360
361
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 359

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



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

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



353
354
355
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 353

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



206
207
208
209
210
211
212
213
214
 
# File 'lib/buildium-ruby/models/lease_recurring_payment_message.rb', line 206

def valid?
  payment_method_validator = EnumAttributeValidator.new('String', ["None", "Check", "Cash", "MoneyOrder", "CashierCheck", "DirectDeposit", "CreditCard", "ElectronicPayment", "RetailCash"])
  return false unless payment_method_validator.valid?(@payment_method)
  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