Class: MoneyKit::PlaidCompatible::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb

Overview

A representation of a transaction

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 114

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::PlaidCompatible::Transaction` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::PlaidCompatible::Transaction`. 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
  end

  self. = attributes[:account_id] if attributes.key?(:account_id)

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

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

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

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

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

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

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

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

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

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

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

  return unless attributes.key?(:personal_finance_category)

  self.personal_finance_category = attributes[:personal_finance_category]
end

Instance Attribute Details

#account_id ⇒ Object

The ID of the account in which this transaction occurred.



19
20
21
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 19

def 
  @account_id
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`. 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.



22
23
24
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 22

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



28
29
30
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 28

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



31
32
33
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 31

def category_id
  @category_id
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` ).



34
35
36
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 34

def date
  @date
end

#datetime ⇒ Object

Date and time when a transaction was posted in [ISO 8601](wikipedia.org/wiki/ISO_8601) format ( ‘YYYY-MM-DDTHH:mm:ssZ` ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). This field is only populated in API version 2019-05-29 and later.



52
53
54
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 52

def datetime
  @datetime
end

#iso_currency_code ⇒ Object

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



25
26
27
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 25

def iso_currency_code
  @iso_currency_code
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`.



40
41
42
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 40

def merchant_name
  @merchant_name
end

#name ⇒ Object

The merchant name or transaction description. If the ‘transactions` object was returned by a Transactions endpoint such as `/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.



37
38
39
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 37

def name
  @name
end

#original_description ⇒ Object

The string returned by the financial institution to describe the transaction. For transactions returned by ‘/transactions/get`, this field is in beta and will be omitted unless the client is both enrolled in the closed beta program and has set `options.include_original_description` to `true`.



43
44
45
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 43

def original_description
  @original_description
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.



46
47
48
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 46

def pending
  @pending
end

#personal_finance_category ⇒ Object

Returns the value of attribute personal_finance_category.



54
55
56
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 54

def personal_finance_category
  @personal_finance_category
end

#transaction_id ⇒ Object

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



49
50
51
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 49

def transaction_id
  @transaction_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 57

def self.attribute_map
  {
    'account_id': :account_id,
    'amount': :amount,
    'iso_currency_code': :iso_currency_code,
    'category': :category,
    'category_id': :category_id,
    'date': :date,
    'name': :name,
    'merchant_name': :merchant_name,
    'original_description': :original_description,
    'pending': :pending,
    'transaction_id': :transaction_id,
    'datetime': :datetime,
    'personal_finance_category': :personal_finance_category
  }
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



232
233
234
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 232

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 100

def self.openapi_nullable
  Set.new(%i[
            iso_currency_code
            category
            category_id
            merchant_name
            original_description
            datetime
            personal_finance_category
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 81

def self.openapi_types
  {
    'account_id': :String,
    'amount': :Float,
    'iso_currency_code': :String,
    'category': :'Array<String>',
    'category_id': :String,
    'date': :Date,
    'name': :String,
    'merchant_name': :String,
    'original_description': :String,
    'pending': :Boolean,
    'transaction_id': :String,
    'datetime': :Time,
    'personal_finance_category': :PersonalFinanceCategory
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 197

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
     == other. &&
    amount == other.amount &&
    iso_currency_code == other.iso_currency_code &&
    category == other.category &&
    category_id == other.category_id &&
    date == other.date &&
    name == other.name &&
    merchant_name == other.merchant_name &&
    original_description == other.original_description &&
    pending == other.pending &&
    transaction_id == other.transaction_id &&
    datetime == other.datetime &&
    personal_finance_category == other.personal_finance_category
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



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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 265

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 = MoneyKit::PlaidCompatible.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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 336

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 239

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


218
219
220
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 218

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



224
225
226
227
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 224

def hash
  [, amount, iso_currency_code, category, category_id, date, name, merchant_name, original_description,
   pending, transaction_id, datetime, personal_finance_category].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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 163

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "account_id", account_id cannot be nil.') if @account_id.nil?

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

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

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

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

  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



312
313
314
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 312

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



318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 318

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



306
307
308
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 306

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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/transaction.rb', line 184

def valid?
  return false if @account_id.nil?
  return false if @amount.nil?
  return false if @date.nil?
  return false if @name.nil?
  return false if @pending.nil?
  return false if @transaction_id.nil?

  true
end