Class: Propertyware::ChargeTx

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/models/charge_tx.rb

Overview

Charge Transaction

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChargeTx

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/propertyware/models/charge_tx.rb', line 134

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Amount.



20
21
22
 
# File 'lib/propertyware/models/charge_tx.rb', line 20

def amount
  @amount
end

#amount_due ⇒ Object

The amount due for the charge.



23
24
25
 
# File 'lib/propertyware/models/charge_tx.rb', line 23

def amount_due
  @amount_due
end

#amount_paid ⇒ Object

The amount paid for the charge.



26
27
28
 
# File 'lib/propertyware/models/charge_tx.rb', line 26

def amount_paid
  @amount_paid
end

#charge_status ⇒ Object

Status of the charge.



29
30
31
 
# File 'lib/propertyware/models/charge_tx.rb', line 29

def charge_status
  @charge_status
end

#comments ⇒ Object

Comments.



32
33
34
 
# File 'lib/propertyware/models/charge_tx.rb', line 32

def comments
  @comments
end

#created_by ⇒ Object

User who created the record.



35
36
37
 
# File 'lib/propertyware/models/charge_tx.rb', line 35

def created_by
  @created_by
end

#created_date_time ⇒ Object

Date and time the record was created. (Timezone: UTC)



38
39
40
 
# File 'lib/propertyware/models/charge_tx.rb', line 38

def created_date_time
  @created_date_time
end

#date ⇒ Object

Post date.



41
42
43
 
# File 'lib/propertyware/models/charge_tx.rb', line 41

def date
  @date
end

#gl_account_id ⇒ Object

Id of the general ledger account associated with this charge.



44
45
46
 
# File 'lib/propertyware/models/charge_tx.rb', line 44

def 
  @gl_account_id
end

#id ⇒ Object

Unique identifier.



47
48
49
 
# File 'lib/propertyware/models/charge_tx.rb', line 47

def id
  @id
end

#last_modified_by ⇒ Object

User who last modified the record.



50
51
52
 
# File 'lib/propertyware/models/charge_tx.rb', line 50

def last_modified_by
  @last_modified_by
end

#last_modified_date_time ⇒ Object

Date and time the record was last modified. (Timezone: UTC)



53
54
55
 
# File 'lib/propertyware/models/charge_tx.rb', line 53

def last_modified_date_time
  @last_modified_date_time
end

#lease_id ⇒ Object

Id of the lease associated with this charge.



56
57
58
 
# File 'lib/propertyware/models/charge_tx.rb', line 56

def lease_id
  @lease_id
end

#parent_tx_id ⇒ Object

Parent Charge ID. If parent charge date and recharge date are same consider it as a hidden recharge and do not include it in ledger balance calculation.



59
60
61
 
# File 'lib/propertyware/models/charge_tx.rb', line 59

def parent_tx_id
  @parent_tx_id
end

#payments ⇒ Object

List of payment charge history.



62
63
64
 
# File 'lib/propertyware/models/charge_tx.rb', line 62

def payments
  @payments
end

#portfolio_id ⇒ Object

Id of the portfolio associated with this charge.



65
66
67
 
# File 'lib/propertyware/models/charge_tx.rb', line 65

def portfolio_id
  @portfolio_id
end

#ref_no ⇒ Object

Reference number.



68
69
70
 
# File 'lib/propertyware/models/charge_tx.rb', line 68

def ref_no
  @ref_no
end

#status ⇒ Object

The status of the lease.



71
72
73
 
# File 'lib/propertyware/models/charge_tx.rb', line 71

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/propertyware/models/charge_tx.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/propertyware/models/charge_tx.rb', line 74

def self.attribute_map
  {
    :'amount' => :'amount',
    :'amount_due' => :'amountDue',
    :'amount_paid' => :'amountPaid',
    :'charge_status' => :'chargeStatus',
    :'comments' => :'comments',
    :'created_by' => :'createdBy',
    :'created_date_time' => :'createdDateTime',
    :'date' => :'date',
    :'gl_account_id' => :'glAccountID',
    :'id' => :'id',
    :'last_modified_by' => :'lastModifiedBy',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'lease_id' => :'leaseID',
    :'parent_tx_id' => :'parentTxID',
    :'payments' => :'payments',
    :'portfolio_id' => :'portfolioID',
    :'ref_no' => :'refNo',
    :'status' => :'status'
  }
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



285
286
287
 
# File 'lib/propertyware/models/charge_tx.rb', line 285

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/propertyware/models/charge_tx.rb', line 127

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
120
121
122
123
124
 
# File 'lib/propertyware/models/charge_tx.rb', line 103

def self.openapi_types
  {
    :'amount' => :'Float',
    :'amount_due' => :'Float',
    :'amount_paid' => :'Float',
    :'charge_status' => :'String',
    :'comments' => :'String',
    :'created_by' => :'String',
    :'created_date_time' => :'Time',
    :'date' => :'Date',
    :'gl_account_id' => :'Integer',
    :'id' => :'Integer',
    :'last_modified_by' => :'String',
    :'last_modified_date_time' => :'Time',
    :'lease_id' => :'Integer',
    :'parent_tx_id' => :'Integer',
    :'payments' => :'Array<PaymentCharge>',
    :'portfolio_id' => :'Integer',
    :'ref_no' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/propertyware/models/charge_tx.rb', line 247

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      amount_due == o.amount_due &&
      amount_paid == o.amount_paid &&
      charge_status == o.charge_status &&
      comments == o.comments &&
      created_by == o.created_by &&
      created_date_time == o.created_date_time &&
      date == o.date &&
       == o. &&
      id == o.id &&
      last_modified_by == o.last_modified_by &&
      last_modified_date_time == o.last_modified_date_time &&
      lease_id == o.lease_id &&
      parent_tx_id == o.parent_tx_id &&
      payments == o.payments &&
      portfolio_id == o.portfolio_id &&
      ref_no == o.ref_no &&
      status == o.status
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



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
350
351
352
353
 
# File 'lib/propertyware/models/charge_tx.rb', line 316

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 = Propertyware.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



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/propertyware/models/charge_tx.rb', line 387

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/propertyware/models/charge_tx.rb', line 292

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


272
273
274
 
# File 'lib/propertyware/models/charge_tx.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/propertyware/models/charge_tx.rb', line 278

def hash
  [amount, amount_due, amount_paid, charge_status, comments, created_by, created_date_time, date, , id, last_modified_by, last_modified_date_time, lease_id, parent_tx_id, payments, portfolio_id, ref_no, status].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



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/propertyware/models/charge_tx.rb', line 224

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  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



363
364
365
 
# File 'lib/propertyware/models/charge_tx.rb', line 363

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



369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/propertyware/models/charge_tx.rb', line 369

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



357
358
359
 
# File 'lib/propertyware/models/charge_tx.rb', line 357

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



239
240
241
242
243
 
# File 'lib/propertyware/models/charge_tx.rb', line 239

def valid?
  return false if @amount.nil?
  return false if @date.nil?
  true
end