Class: Plaid::TransactionBase

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transaction_base.rb

Overview

A representation of a transaction

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionBase

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/plaid/models/transaction_base.rb', line 175

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account in which this transaction occurred.



20
21
22
 
# File 'lib/plaid/models/transaction_base.rb', line 20

def 
  @account_id
end

#account_owner ⇒ Object

This field is not typically populated and only relevant when dealing with sub-accounts. A sub-account most commonly exists in cases where a single account is linked to multiple cards, each with its own card number and card holder name; each card will be considered a sub-account. If the account does have sub-accounts, this field will typically be some combination of the sub-account owner’s name and/or the sub-account mask. The format of this field is not standardized and will vary based on institution.



63
64
65
 
# File 'lib/plaid/models/transaction_base.rb', line 63

def 
  @account_owner
end

#amount ⇒ Object

The settled value of the transaction, denominated in the transactions’s currency, as stated in ‘iso_currency_code` or `unofficial_currency_code`. For all products except Income: Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative. For Income endpoints, values are positive when representing income.



23
24
25
 
# File 'lib/plaid/models/transaction_base.rb', line 23

def amount
  @amount
end

#category ⇒ Object

A hierarchical array of the categories to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



32
33
34
 
# File 'lib/plaid/models/transaction_base.rb', line 32

def category
  @category
end

#category_id ⇒ Object

The ID of the category to which this transaction belongs. For a full list of categories, see [‘/categories/get`](plaid.com/docs/api/products/transactions/#categoriesget). All Transactions implementations are recommended to use the new `personal_finance_category` instead of `category`, as it provides greater accuracy and more meaningful categorization. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



35
36
37
 
# File 'lib/plaid/models/transaction_base.rb', line 35

def category_id
  @category_id
end

#check_number ⇒ Object

The check number of the transaction. This field is only populated for check transactions.



38
39
40
 
# File 'lib/plaid/models/transaction_base.rb', line 38

def check_number
  @check_number
end

#date ⇒ Object

For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted. Both dates are returned in an [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DD` ). To receive information about the date that a posted transaction was initiated, see the `authorized_date` field.



41
42
43
 
# File 'lib/plaid/models/transaction_base.rb', line 41

def date
  @date
end

#iso_currency_code ⇒ Object

The ISO-4217 currency code of the transaction. Always ‘null` if `unofficial_currency_code` is non-null.



26
27
28
 
# File 'lib/plaid/models/transaction_base.rb', line 26

def iso_currency_code
  @iso_currency_code
end

#location ⇒ Object

Returns the value of attribute location.



43
44
45
 
# File 'lib/plaid/models/transaction_base.rb', line 43

def location
  @location
end

#logo_url ⇒ Object

The URL of a logo associated with this transaction, if available. The logo will always be 100×100 pixel PNG file.



72
73
74
 
# File 'lib/plaid/models/transaction_base.rb', line 72

def logo_url
  @logo_url
end

#merchant_name ⇒ Object

The merchant name, as enriched by Plaid from the ‘name` field. This is typically a more human-readable version of the merchant counterparty in the transaction. For some bank transactions (such as checks or account transfers) where there is no meaningful merchant name, this value will be `null`.



49
50
51
 
# File 'lib/plaid/models/transaction_base.rb', line 49

def merchant_name
  @merchant_name
end

#name ⇒ Object

The merchant name or transaction description. Note: This is a legacy field that is not actively maintained. Use ‘merchant_name` instead for the merchant name. If the `transactions` object was returned by a Transactions endpoint such as `/transactions/sync` or `/transactions/get`, this field will always appear. If the `transactions` object was returned by an Assets endpoint such as `/asset_report/get/` or `/asset_report/pdf/get`, this field will only appear in an Asset Report with Insights.



46
47
48
 
# File 'lib/plaid/models/transaction_base.rb', line 46

def name
  @name
end

#original_description ⇒ Object

The string returned by the financial institution to describe the transaction. For transactions returned by ‘/transactions/sync` or `/transactions/get`, this field will only be included if the client has set `options.include_original_description` to `true`.



52
53
54
 
# File 'lib/plaid/models/transaction_base.rb', line 52

def original_description
  @original_description
end

#payment_meta ⇒ Object

Returns the value of attribute payment_meta.



54
55
56
 
# File 'lib/plaid/models/transaction_base.rb', line 54

def payment_meta
  @payment_meta
end

#pending ⇒ Object

When ‘true`, identifies the transaction as pending or unsettled. Pending transaction details (name, type, amount, category ID) may change before they are settled. Not all institutions provide pending transactions.



57
58
59
 
# File 'lib/plaid/models/transaction_base.rb', line 57

def pending
  @pending
end

#pending_transaction_id ⇒ Object

The ID of a posted transaction’s associated pending transaction, where applicable. Not all institutions provide pending transactions.



60
61
62
 
# File 'lib/plaid/models/transaction_base.rb', line 60

def pending_transaction_id
  @pending_transaction_id
end

#transaction_id ⇒ Object

The unique ID of the transaction. Like all Plaid identifiers, the ‘transaction_id` is case sensitive.



66
67
68
 
# File 'lib/plaid/models/transaction_base.rb', line 66

def transaction_id
  @transaction_id
end

#transaction_type ⇒ Object

Please use the ‘payment_channel` field, `transaction_type` will be deprecated in the future. `digital:` transactions that took place online. `place:` transactions that were made at a physical location. `special:` transactions that relate to banks, e.g. fees or deposits. `unresolved:` transactions that do not fit into the other three types.



69
70
71
 
# File 'lib/plaid/models/transaction_base.rb', line 69

def transaction_type
  @transaction_type
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the transaction. Always ‘null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.



29
30
31
 
# File 'lib/plaid/models/transaction_base.rb', line 29

def unofficial_currency_code
  @unofficial_currency_code
end

#website ⇒ Object

The website associated with this transaction, if available.



75
76
77
 
# File 'lib/plaid/models/transaction_base.rb', line 75

def website
  @website
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/plaid/models/transaction_base.rb', line 126

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/plaid/models/transaction_base.rb', line 100

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'category' => :'category',
    :'category_id' => :'category_id',
    :'check_number' => :'check_number',
    :'date' => :'date',
    :'location' => :'location',
    :'name' => :'name',
    :'merchant_name' => :'merchant_name',
    :'original_description' => :'original_description',
    :'payment_meta' => :'payment_meta',
    :'pending' => :'pending',
    :'pending_transaction_id' => :'pending_transaction_id',
    :'account_owner' => :'account_owner',
    :'transaction_id' => :'transaction_id',
    :'transaction_type' => :'transaction_type',
    :'logo_url' => :'logo_url',
    :'website' => :'website'
  }
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



363
364
365
 
# File 'lib/plaid/models/transaction_base.rb', line 363

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/plaid/models/transaction_base.rb', line 157

def self.openapi_nullable
  Set.new([
    :'iso_currency_code',
    :'unofficial_currency_code',
    :'category',
    :'category_id',
    :'check_number',
    :'merchant_name',
    :'original_description',
    :'pending_transaction_id',
    :'account_owner',
    :'logo_url',
    :'website'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/plaid/models/transaction_base.rb', line 131

def self.openapi_types
  {
    :'account_id' => :'String',
    :'amount' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String',
    :'category' => :'Array<String>',
    :'category_id' => :'String',
    :'check_number' => :'String',
    :'date' => :'Date',
    :'location' => :'Location',
    :'name' => :'String',
    :'merchant_name' => :'String',
    :'original_description' => :'String',
    :'payment_meta' => :'PaymentMeta',
    :'pending' => :'Boolean',
    :'pending_transaction_id' => :'String',
    :'account_owner' => :'String',
    :'transaction_id' => :'String',
    :'transaction_type' => :'String',
    :'logo_url' => :'String',
    :'website' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/plaid/models/transaction_base.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      amount == o.amount &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code &&
      category == o.category &&
      category_id == o.category_id &&
      check_number == o.check_number &&
      date == o.date &&
      location == o.location &&
      name == o.name &&
      merchant_name == o.merchant_name &&
      original_description == o.original_description &&
      payment_meta == o.payment_meta &&
      pending == o.pending &&
      pending_transaction_id == o.pending_transaction_id &&
       == o. &&
      transaction_id == o.transaction_id &&
      transaction_type == o.transaction_type &&
      logo_url == o.logo_url &&
      website == o.website
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



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/plaid/models/transaction_base.rb', line 394

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



465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/plaid/models/transaction_base.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

#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/plaid/models/transaction_base.rb', line 370

def build_from_hash(attributes)
  return nil 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


350
351
352
 
# File 'lib/plaid/models/transaction_base.rb', line 350

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



356
357
358
 
# File 'lib/plaid/models/transaction_base.rb', line 356

def hash
  [, amount, iso_currency_code, unofficial_currency_code, category, category_id, check_number, date, location, name, merchant_name, original_description, payment_meta, pending, pending_transaction_id, , transaction_id, transaction_type, logo_url, website].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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/plaid/models/transaction_base.rb', line 273

def list_invalid_properties
  invalid_properties = Array.new
  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 @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

  if @transaction_id.nil?
    invalid_properties.push('invalid value for "transaction_id", transaction_id 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/plaid/models/transaction_base.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/plaid/models/transaction_base.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/plaid/models/transaction_base.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



300
301
302
303
304
305
306
307
308
309
 
# File 'lib/plaid/models/transaction_base.rb', line 300

def valid?
  return false if @account_id.nil?
  return false if @amount.nil?
  return false if @date.nil?
  return false if @pending.nil?
  return false if @transaction_id.nil?
  transaction_type_validator = EnumAttributeValidator.new('String', ["digital", "place", "special", "unresolved"])
  return false unless transaction_type_validator.valid?(@transaction_type)
  true
end