Class: Buildium::GeneralLedgerTransactionMessage

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

Overview

This is an object that represents a financial transaction

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneralLedgerTransactionMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#check_number ⇒ Object

Check number associated with the transaction, if applicable.



32
33
34
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 32

def check_number
  @check_number
end

#date ⇒ Object

Date of the transaction.



23
24
25
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 23

def date
  @date
end

#deposit_details ⇒ Object

Returns the value of attribute deposit_details.



44
45
46
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 44

def deposit_details
  @deposit_details
end

#id ⇒ Object

Transaction unique identifier.



20
21
22
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 20

def id
  @id
end

#journal ⇒ Object

Returns the value of attribute journal.



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

def journal
  @journal
end

#payment_detail ⇒ Object

Returns the value of attribute payment_detail.



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

def payment_detail
  @payment_detail
end

#total_amount ⇒ Object

Sum of all ‘Journal.Lines.Amount` entries in the transaction.



29
30
31
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 29

def total_amount
  @total_amount
end

#transaction_type ⇒ Object

Type of transaction that occurred



26
27
28
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 26

def transaction_type
  @transaction_type
end

#unit_agreement ⇒ Object

Returns the value of attribute unit_agreement.



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

def unit_agreement
  @unit_agreement
end

#unit_id ⇒ Object

Unit unique identifier associated with the transaction, if applicable. Null if value is not set.



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

def unit_id
  @unit_id
end

#unit_number ⇒ Object

Unit number associated with the transaction, if applicable. Null if value is not set.



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

def unit_number
  @unit_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'Id',
    :'date' => :'Date',
    :'transaction_type' => :'TransactionType',
    :'total_amount' => :'TotalAmount',
    :'check_number' => :'CheckNumber',
    :'unit_agreement' => :'UnitAgreement',
    :'unit_id' => :'UnitId',
    :'unit_number' => :'UnitNumber',
    :'payment_detail' => :'PaymentDetail',
    :'deposit_details' => :'DepositDetails',
    :'journal' => :'Journal'
  }
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



233
234
235
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 233

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



110
111
112
113
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 110

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'date' => :'Date',
    :'transaction_type' => :'String',
    :'total_amount' => :'Float',
    :'check_number' => :'String',
    :'unit_agreement' => :'UnitAgreementMessage',
    :'unit_id' => :'Integer',
    :'unit_number' => :'String',
    :'payment_detail' => :'PaymentDetailMessage',
    :'deposit_details' => :'DepositDetailMessage',
    :'journal' => :'GeneralLedgerJournalMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 202

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date == o.date &&
      transaction_type == o.transaction_type &&
      total_amount == o.total_amount &&
      check_number == o.check_number &&
      unit_agreement == o.unit_agreement &&
      unit_id == o.unit_id &&
      unit_number == o.unit_number &&
      payment_detail == o.payment_detail &&
      deposit_details == o.deposit_details &&
      journal == o.journal
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 264

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 335

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



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

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


220
221
222
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 226

def hash
  [id, date, transaction_type, total_amount, check_number, unit_agreement, unit_id, unit_number, payment_detail, deposit_details, journal].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



177
178
179
180
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 177

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



311
312
313
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 317

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



305
306
307
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 305

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



184
185
186
187
188
 
# File 'lib/buildium-ruby/models/general_ledger_transaction_message.rb', line 184

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)
  true
end