Class: MoneyKit::TransactionResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/models/transaction_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionResponse

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
 
# File 'lib/moneykit/models/transaction_response.rb', line 134

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MoneyKit::TransactionResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MoneyKit::TransactionResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'transaction_id')
    self.transaction_id = attributes[:'transaction_id']
  else
    self.transaction_id = nil
  end

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  else
    self.currency = nil
  end

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

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

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

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

  if attributes.key?(:'pending')
    self.pending = attributes[:'pending']
  else
    self.pending = nil
  end

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account in which this transaction occurred.



22
23
24
 
# File 'lib/moneykit/models/transaction_response.rb', line 22

def 
  @account_id
end

#amount ⇒ Object

The amount of this transaction, denominated in account currency. This amount is always non-negative. The type field indicates whether it is entering (type=credit) or leaving (type=debit) the account.



25
26
27
 
# File 'lib/moneykit/models/transaction_response.rb', line 25

def amount
  @amount
end

#category ⇒ Object

(deprecated) Refer to enrichment.category.



49
50
51
 
# File 'lib/moneykit/models/transaction_response.rb', line 49

def category
  @category
end

#currency ⇒ Object

The ISO-4217 currency code of the transaction.



31
32
33
 
# File 'lib/moneykit/models/transaction_response.rb', line 31

def currency
  @currency
end

#date ⇒ Object

The effective (posted) date of the transaction, in ISO-8601 format. For pending transactions, this date is when the transaction was initiated.



34
35
36
 
# File 'lib/moneykit/models/transaction_response.rb', line 34

def date
  @date
end

#datetime ⇒ Object

If the institution has provided the actual time of the transaction, this field contains the full date and time of the transaction, in ISO-8601 format. If the time is not available, this field will be null. <p>Note that the time is generally reported in the timezone of the institution or the account holder.



37
38
39
 
# File 'lib/moneykit/models/transaction_response.rb', line 37

def datetime
  @datetime
end

#description ⇒ Object

A normalized, cleaned transaction description suitable for presentation to the end user. Commonly this will be the merchant or counterparty name.



40
41
42
 
# File 'lib/moneykit/models/transaction_response.rb', line 40

def description
  @description
end

#enrichment ⇒ Object

Returns the value of attribute enrichment.



51
52
53
 
# File 'lib/moneykit/models/transaction_response.rb', line 51

def enrichment
  @enrichment
end

#original_id ⇒ Object

The original ID of this transaction, if supplied (by you) during an import.



54
55
56
 
# File 'lib/moneykit/models/transaction_response.rb', line 54

def original_id
  @original_id
end

#pending ⇒ Object

If true, this transaction is pending or unsettled and has not yet affected the account. Commonly these are credit card transactions, particularly approvals (holds) such as for hotel or restaurant reservations placed in advance where the final amount is still to be determined.



46
47
48
 
# File 'lib/moneykit/models/transaction_response.rb', line 46

def pending
  @pending
end

#raw_description ⇒ Object

The raw transaction description as provided by the institution, where available.



43
44
45
 
# File 'lib/moneykit/models/transaction_response.rb', line 43

def raw_description
  @raw_description
end

#transaction_id ⇒ Object

The unique ID for this transaction.



19
20
21
 
# File 'lib/moneykit/models/transaction_response.rb', line 19

def transaction_id
  @transaction_id
end

#type ⇒ Object

A debit indicates money leaving the account (e.g., a payment); a credit indicates money entering the account (e.g., a deposit). The account type does not affect transaction type; transaction types indicate the same direction for all account types. (The account type does, however, change the way balances are reported; see <a href="/api/operation/get_account#account-account_type">account response</a> for details.)



28
29
30
 
# File 'lib/moneykit/models/transaction_response.rb', line 28

def type
  @type
end

Class Method Details

._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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/moneykit/models/transaction_response.rb', line 394

def self._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 = MoneyKit.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



98
99
100
 
# File 'lib/moneykit/models/transaction_response.rb', line 98

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



103
104
105
 
# File 'lib/moneykit/models/transaction_response.rb', line 103

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/moneykit/models/transaction_response.rb', line 79

def self.attribute_map
  {
    :'transaction_id' => :'transaction_id',
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'type' => :'type',
    :'currency' => :'currency',
    :'date' => :'date',
    :'datetime' => :'datetime',
    :'description' => :'description',
    :'raw_description' => :'raw_description',
    :'pending' => :'pending',
    :'category' => :'category',
    :'enrichment' => :'enrichment',
    :'original_id' => :'original_id'
  }
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



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/moneykit/models/transaction_response.rb', line 370

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



127
128
129
130
 
# File 'lib/moneykit/models/transaction_response.rb', line 127

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/moneykit/models/transaction_response.rb', line 108

def self.openapi_types
  {
    :'transaction_id' => :'String',
    :'account_id' => :'String',
    :'amount' => :'String',
    :'type' => :'TransactionType',
    :'currency' => :'String',
    :'date' => :'Date',
    :'datetime' => :'Time',
    :'description' => :'String',
    :'raw_description' => :'String',
    :'pending' => :'Boolean',
    :'category' => :'String',
    :'enrichment' => :'TransactionEnrichmentResponse',
    :'original_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/moneykit/models/transaction_response.rb', line 337

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_id == o.transaction_id &&
       == o. &&
      amount == o.amount &&
      type == o.type &&
      currency == o.currency &&
      date == o.date &&
      datetime == o.datetime &&
      description == o.description &&
      raw_description == o.raw_description &&
      pending == o.pending &&
      category == o.category &&
      enrichment == o.enrichment &&
      original_id == o.original_id
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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/moneykit/models/transaction_response.rb', line 465

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


357
358
359
 
# File 'lib/moneykit/models/transaction_response.rb', line 357

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



363
364
365
 
# File 'lib/moneykit/models/transaction_response.rb', line 363

def hash
  [transaction_id, , amount, type, currency, date, datetime, description, raw_description, pending, category, enrichment, original_id].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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/moneykit/models/transaction_response.rb', line 217

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @transaction_id.nil?
    invalid_properties.push('invalid value for "transaction_id", transaction_id cannot be nil.')
  end

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

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

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

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

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

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



441
442
443
 
# File 'lib/moneykit/models/transaction_response.rb', line 441

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



447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/moneykit/models/transaction_response.rb', line 447

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



435
436
437
 
# File 'lib/moneykit/models/transaction_response.rb', line 435

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



253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/moneykit/models/transaction_response.rb', line 253

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @transaction_id.nil?
  return false if @account_id.nil?
  return false if @amount.nil?
  return false if @type.nil?
  return false if @currency.nil?
  return false if @date.nil?
  return false if @pending.nil?
  true
end