Class: Buildium::GeneralLedgerEntryMessage

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneralLedgerEntryMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 99

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

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

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

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

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

Instance Attribute Details

#accounting_entity ⇒ Object

Returns the value of attribute accounting_entity.



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

def accounting_entity
  @accounting_entity
end

#amount ⇒ Object

Entry amount.



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

def amount
  @amount
end

#balance ⇒ Object

The general ledger account balance after this entry was recorded.



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

def balance
  @balance
end

#date ⇒ Object

Date of the transaction.



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

def date
  @date
end

#description ⇒ Object

Transaction description.



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

def description
  @description
end

#id ⇒ Object

The unique identifier of the transaction associated with the entry.



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

def id
  @id
end

#transaction_type ⇒ Object

Indicates the type of transaction that occurred.



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

def transaction_type
  @transaction_type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 61

def self.attribute_map
  {
    :'id' => :'Id',
    :'date' => :'Date',
    :'description' => :'Description',
    :'amount' => :'Amount',
    :'balance' => :'Balance',
    :'transaction_type' => :'TransactionType',
    :'accounting_entity' => :'AccountingEntity'
  }
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



195
196
197
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 195

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 79

def self.openapi_types
  {
    :'id' => :'Integer',
    :'date' => :'Date',
    :'description' => :'String',
    :'amount' => :'Float',
    :'balance' => :'Float',
    :'transaction_type' => :'String',
    :'accounting_entity' => :'AccountingEntityMessage'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date == o.date &&
      description == o.description &&
      amount == o.amount &&
      balance == o.balance &&
      transaction_type == o.transaction_type &&
      accounting_entity == o.accounting_entity
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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 226

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 297

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



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

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


182
183
184
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 188

def hash
  [id, date, description, amount, balance, transaction_type, accounting_entity].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



143
144
145
146
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 143

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



273
274
275
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 279

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



267
268
269
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 267

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



150
151
152
153
154
 
# File 'lib/buildium-ruby/models/general_ledger_entry_message.rb', line 150

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