Class: YNAB::TransactionDetail

Inherits:
Object
  • Object
show all
Defined in:
lib/ynab/models/transaction_detail.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
221
222
223
 
# File 'lib/ynab/models/transaction_detail.rb', line 140

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

  if attributes.has_key?(:'cleared')
    self.cleared = attributes[:'cleared']
  end

  if attributes.has_key?(:'approved')
    self.approved = attributes[:'approved']
  end

  if attributes.has_key?(:'flag_color')
    self.flag_color = attributes[:'flag_color']
  end

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'payee_id')
    self.payee_id = attributes[:'payee_id']
  end

  if attributes.has_key?(:'category_id')
    self.category_id = attributes[:'category_id']
  end

  if attributes.has_key?(:'transfer_account_id')
    self. = attributes[:'transfer_account_id']
  end

  if attributes.has_key?(:'transfer_transaction_id')
    self.transfer_transaction_id = attributes[:'transfer_transaction_id']
  end

  if attributes.has_key?(:'matched_transaction_id')
    self.matched_transaction_id = attributes[:'matched_transaction_id']
  end

  if attributes.has_key?(:'import_id')
    self.import_id = attributes[:'import_id']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.has_key?(:'account_name')
    self. = attributes[:'account_name']
  end

  if attributes.has_key?(:'payee_name')
    self.payee_name = attributes[:'payee_name']
  end

  if attributes.has_key?(:'category_name')
    self.category_name = attributes[:'category_name']
  end

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



36
37
38
 
# File 'lib/ynab/models/transaction_detail.rb', line 36

def 
  @account_id
end

#account_name ⇒ Object

Returns the value of attribute account_name.



57
58
59
 
# File 'lib/ynab/models/transaction_detail.rb', line 57

def 
  @account_name
end

#amount ⇒ Object

The transaction amount in milliunits format



23
24
25
 
# File 'lib/ynab/models/transaction_detail.rb', line 23

def amount
  @amount
end

#approved ⇒ Object

Whether or not the transaction is approved



31
32
33
 
# File 'lib/ynab/models/transaction_detail.rb', line 31

def approved
  @approved
end

#category_id ⇒ Object

Returns the value of attribute category_id.



40
41
42
 
# File 'lib/ynab/models/transaction_detail.rb', line 40

def category_id
  @category_id
end

#category_name ⇒ Object

Returns the value of attribute category_name.



61
62
63
 
# File 'lib/ynab/models/transaction_detail.rb', line 61

def category_name
  @category_name
end

#cleared ⇒ Object

The cleared status of the transaction



28
29
30
 
# File 'lib/ynab/models/transaction_detail.rb', line 28

def cleared
  @cleared
end

#date ⇒ Object

The transaction date in ISO format (e.g. 2016-12-01)



20
21
22
 
# File 'lib/ynab/models/transaction_detail.rb', line 20

def date
  @date
end

#deleted ⇒ Object

Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests.



55
56
57
 
# File 'lib/ynab/models/transaction_detail.rb', line 55

def deleted
  @deleted
end

#flag_color ⇒ Object

The transaction flag



34
35
36
 
# File 'lib/ynab/models/transaction_detail.rb', line 34

def flag_color
  @flag_color
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/ynab/models/transaction_detail.rb', line 17

def id
  @id
end

#import_id ⇒ Object

If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: ‘YNAB::[iso_date]:’. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of ‘YNAB:-294230:2015-12-30:1’. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be ‘YNAB:-294230:2015-12-30:2’.



52
53
54
 
# File 'lib/ynab/models/transaction_detail.rb', line 52

def import_id
  @import_id
end

#matched_transaction_id ⇒ Object

If transaction is matched, the id of the matched transaction



49
50
51
 
# File 'lib/ynab/models/transaction_detail.rb', line 49

def matched_transaction_id
  @matched_transaction_id
end

#memo ⇒ Object

Returns the value of attribute memo.



25
26
27
 
# File 'lib/ynab/models/transaction_detail.rb', line 25

def memo
  @memo
end

#payee_id ⇒ Object

Returns the value of attribute payee_id.



38
39
40
 
# File 'lib/ynab/models/transaction_detail.rb', line 38

def payee_id
  @payee_id
end

#payee_name ⇒ Object

Returns the value of attribute payee_name.



59
60
61
 
# File 'lib/ynab/models/transaction_detail.rb', line 59

def payee_name
  @payee_name
end

#subtransactions ⇒ Object

If a split transaction, the subtransactions.



64
65
66
 
# File 'lib/ynab/models/transaction_detail.rb', line 64

def subtransactions
  @subtransactions
end

#transfer_account_id ⇒ Object

If a transfer transaction, the account to which it transfers



43
44
45
 
# File 'lib/ynab/models/transaction_detail.rb', line 43

def 
  @transfer_account_id
end

#transfer_transaction_id ⇒ Object

If a transfer transaction, the id of transaction on the other side of the transfer



46
47
48
 
# File 'lib/ynab/models/transaction_detail.rb', line 46

def transfer_transaction_id
  @transfer_transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ynab/models/transaction_detail.rb', line 89

def self.attribute_map
  {
    :'id' => :'id',
    :'date' => :'date',
    :'amount' => :'amount',
    :'memo' => :'memo',
    :'cleared' => :'cleared',
    :'approved' => :'approved',
    :'flag_color' => :'flag_color',
    :'account_id' => :'account_id',
    :'payee_id' => :'payee_id',
    :'category_id' => :'category_id',
    :'transfer_account_id' => :'transfer_account_id',
    :'transfer_transaction_id' => :'transfer_transaction_id',
    :'matched_transaction_id' => :'matched_transaction_id',
    :'import_id' => :'import_id',
    :'deleted' => :'deleted',
    :'account_name' => :'account_name',
    :'payee_name' => :'payee_name',
    :'category_name' => :'category_name',
    :'subtransactions' => :'subtransactions'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/ynab/models/transaction_detail.rb', line 114

def self.swagger_types
  {
    :'id' => :'String',
    :'date' => :'Date',
    :'amount' => :'Integer',
    :'memo' => :'String',
    :'cleared' => :'String',
    :'approved' => :'BOOLEAN',
    :'flag_color' => :'String',
    :'account_id' => :'String',
    :'payee_id' => :'String',
    :'category_id' => :'String',
    :'transfer_account_id' => :'String',
    :'transfer_transaction_id' => :'String',
    :'matched_transaction_id' => :'String',
    :'import_id' => :'String',
    :'deleted' => :'BOOLEAN',
    :'account_name' => :'String',
    :'payee_name' => :'String',
    :'category_name' => :'String',
    :'subtransactions' => :'Array<SubTransaction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/ynab/models/transaction_detail.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date == o.date &&
      amount == o.amount &&
      memo == o.memo &&
      cleared == o.cleared &&
      approved == o.approved &&
      flag_color == o.flag_color &&
       == o. &&
      payee_id == o.payee_id &&
      category_id == o.category_id &&
       == o. &&
      transfer_transaction_id == o.transfer_transaction_id &&
      matched_transaction_id == o.matched_transaction_id &&
      import_id == o.import_id &&
      deleted == o.deleted &&
       == o. &&
      payee_name == o.payee_name &&
      category_name == o.category_name &&
      subtransactions == o.subtransactions
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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/ynab/models/transaction_detail.rb', line 419

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = YNAB.const_get(type).new
    temp_model.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



485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/ynab/models/transaction_detail.rb', line 485

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/ynab/models/transaction_detail.rb', line 398

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


385
386
387
 
# File 'lib/ynab/models/transaction_detail.rb', line 385

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/ynab/models/transaction_detail.rb', line 391

def hash
  [id, date, amount, memo, cleared, approved, flag_color, , payee_id, category_id, , transfer_transaction_id, matched_transaction_id, import_id, deleted, , payee_name, category_name, subtransactions].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



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
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
302
303
304
305
306
 
# File 'lib/ynab/models/transaction_detail.rb', line 227

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if @subtransactions.nil?
    invalid_properties.push('invalid value for "subtransactions", subtransactions 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



465
466
467
 
# File 'lib/ynab/models/transaction_detail.rb', line 465

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



471
472
473
474
475
476
477
478
479
 
# File 'lib/ynab/models/transaction_detail.rb', line 471

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



459
460
461
 
# File 'lib/ynab/models/transaction_detail.rb', line 459

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



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
 
# File 'lib/ynab/models/transaction_detail.rb', line 310

def valid?
  return false if @id.nil?
  return false if @date.nil?
  return false if @amount.nil?
  return false if @memo.nil?
  return false if @cleared.nil?
  cleared_validator = EnumAttributeValidator.new('String', ['cleared', 'uncleared', 'reconciled'])
  return false unless cleared_validator.valid?(@cleared)
  return false if @approved.nil?
  return false if @flag_color.nil?
  flag_color_validator = EnumAttributeValidator.new('String', ['red', 'orange', 'yellow', 'green', 'blue', 'purple'])
  return false unless flag_color_validator.valid?(@flag_color)
  return false if @account_id.nil?
  return false if @payee_id.nil?
  return false if @category_id.nil?
  return false if @transfer_account_id.nil?
  return false if @transfer_transaction_id.nil?
  return false if @matched_transaction_id.nil?
  return false if @import_id.nil?
  return false if @deleted.nil?
  return false if @account_name.nil?
  return false if @payee_name.nil?
  return false if @category_name.nil?
  return false if @subtransactions.nil?
  true
end