Class: Buildium::RecurringTransactionMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurringTransactionMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/recurring_transaction_message.rb', line 125

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Total amount of the recurring transaction.



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

def amount
  @amount
end

#duration ⇒ Object

Specifies the period of time/occurrences the recurring transaction 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.



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

def duration
  @duration
end

#frequency ⇒ Object

Indicates the frequency at which the recurring transaction is processed.



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

def frequency
  @frequency
end

#id ⇒ Object

The unique identifier for the recurring transaction schedule.



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

def id
  @id
end

#is_expired ⇒ Object

Indicates if the recurring transaction schedule has expired.



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

def is_expired
  @is_expired
end

#lines ⇒ Object

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



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

def lines
  @lines
end

#memo ⇒ Object

Memo associated with the recurring transaction.



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

def memo
  @memo
end

#next_occurrence_date ⇒ Object

The next date the scheduled transaction will be processed.



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

def next_occurrence_date
  @next_occurrence_date
end

#offsetting_gl_account_id ⇒ Object

Offsetting general ledger account identifier. The offsetting general ledger account acts as the expense account. Note, this field is only applicable for ‘Credit` transaction types.



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

def 
  @offsetting_gl_account_id
end

#post_days_in_advance ⇒ Object

The number of days ahead of the transaction date the transaction will post on the lease ledger. This setting is used to add the transaction to the ledger ahead of it’s 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.



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

def post_days_in_advance
  @post_days_in_advance
end

#rent_id ⇒ Object

The unique identifier of the scheduled Rent entity. This field is only applicable for ‘Charge` transaction types.



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

def rent_id
  @rent_id
end

#transaction_type ⇒ Object

Indicates the type of transaction to be applied to the ledger.



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

def transaction_type
  @transaction_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'Id',
    :'transaction_type' => :'TransactionType',
    :'is_expired' => :'IsExpired',
    :'rent_id' => :'RentId',
    :'offsetting_gl_account_id' => :'OffsettingGLAccountId',
    :'lines' => :'Lines',
    :'amount' => :'Amount',
    :'memo' => :'Memo',
    :'next_occurrence_date' => :'NextOccurrenceDate',
    :'post_days_in_advance' => :'PostDaysInAdvance',
    :'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



272
273
274
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 272

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 100

def self.openapi_types
  {
    :'id' => :'Integer',
    :'transaction_type' => :'String',
    :'is_expired' => :'Boolean',
    :'rent_id' => :'Integer',
    :'offsetting_gl_account_id' => :'Integer',
    :'lines' => :'Array<RecurringTransactionLineMessage>',
    :'amount' => :'Float',
    :'memo' => :'String',
    :'next_occurrence_date' => :'Date',
    :'post_days_in_advance' => :'Integer',
    :'frequency' => :'String',
    :'duration' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 240

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      transaction_type == o.transaction_type &&
      is_expired == o.is_expired &&
      rent_id == o.rent_id &&
       == o. &&
      lines == o.lines &&
      amount == o.amount &&
      memo == o.memo &&
      next_occurrence_date == o.next_occurrence_date &&
      post_days_in_advance == o.post_days_in_advance &&
      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



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
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 303

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



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

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 279

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


259
260
261
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 265

def hash
  [id, transaction_type, is_expired, rent_id, , lines, amount, memo, next_occurrence_date, post_days_in_advance, 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



191
192
193
194
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 191

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



350
351
352
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 356

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



344
345
346
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 344

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



198
199
200
201
202
203
204
205
206
 
# File 'lib/buildium-ruby/models/recurring_transaction_message.rb', line 198

def valid?
  transaction_type_validator = EnumAttributeValidator.new('String', ["Bill", "Check", "Charge", "Payment", "Credit", "Refund", "ApplyDeposit", "ElectronicFundsTransfer", "Other", "Deposit", "GeneralJournalEntry", "OwnerContribution", "ReversePayment", "ReverseElectronicFundsTransfer", "VendorCredit", "RentalApplicationFeePayment", "ReverseRentalApplicationFeePayment", "ReverseOwnerContribution", "VendorRefund", "UnreversedPayment", "UnreversedElectronicFundsTransfer", "UnreversedOwnerContribution", "UnreversedRentalApplicationFeePayment"])
  return false unless transaction_type_validator.valid?(@transaction_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