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



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

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
  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 `MoneyKit::TransactionResponse`. 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?(:'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 or leaving 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.



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

def category
  @category
end

#currency ⇒ Object

The ISO-4217 currency code of the transaction.



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

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.



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

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.



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

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.



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

def description
  @description
end

#enrichment ⇒ Object

Returns the value of attribute enrichment.



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

def enrichment
  @enrichment
end

#original_id ⇒ Object

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



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

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.



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

def pending
  @pending
end

#raw_description ⇒ Object

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



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

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

Returns the value of attribute type.



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

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



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

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



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

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



121
122
123
124
 
# File 'lib/moneykit/models/transaction_response.rb', line 121

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/moneykit/models/transaction_response.rb', line 102

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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/moneykit/models/transaction_response.rb', line 260

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



388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/moneykit/models/transaction_response.rb', line 388

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


280
281
282
 
# File 'lib/moneykit/models/transaction_response.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



286
287
288
 
# File 'lib/moneykit/models/transaction_response.rb', line 286

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



210
211
212
213
214
215
216
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
 
# File 'lib/moneykit/models/transaction_response.rb', line 210

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



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

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



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

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



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

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



246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/moneykit/models/transaction_response.rb', line 246

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