Class: Plaid::CreditBankIncomeTransaction

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

Overview

The transactions data for the end user’s income source(s).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreditBankIncomeTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 93

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

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

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

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

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

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

  if attributes.key?(:'check_number')
    self.check_number = attributes[:'check_number']
  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
end

Instance Attribute Details

#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, credit card purchases are positive; credit card payment, direct deposits, and refunds are negative.



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

def amount
  @amount
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/credit_bank_income_transaction.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 format (YYYY-MM-DD).



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

def date
  @date
end

#iso_currency_code ⇒ Object

The ISO 4217 currency code of the amount or balance.



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

def iso_currency_code
  @iso_currency_code
end

#name ⇒ Object

The merchant name or transaction description.



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

def name
  @name
end

#original_description ⇒ Object

The string returned by the financial institution to describe the transaction.



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

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.



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

def pending
  @pending
end

#transaction_id ⇒ Object

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



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

def transaction_id
  @transaction_id
end

#unofficial_currency_code ⇒ Object

The unofficial currency code associated with the amount or balance. 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.



44
45
46
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 44

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 47

def self.attribute_map
  {
    :'amount' => :'amount',
    :'date' => :'date',
    :'name' => :'name',
    :'original_description' => :'original_description',
    :'pending' => :'pending',
    :'transaction_id' => :'transaction_id',
    :'check_number' => :'check_number',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code'
  }
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



187
188
189
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 187

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
87
88
89
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 82

def self.openapi_nullable
  Set.new([
    :'original_description',
    :'check_number',
    :'iso_currency_code',
    :'unofficial_currency_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 67

def self.openapi_types
  {
    :'amount' => :'Float',
    :'date' => :'Date',
    :'name' => :'String',
    :'original_description' => :'String',
    :'pending' => :'Boolean',
    :'transaction_id' => :'String',
    :'check_number' => :'String',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      date == o.date &&
      name == o.name &&
      original_description == o.original_description &&
      pending == o.pending &&
      transaction_id == o.transaction_id &&
      check_number == o.check_number &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code
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



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
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 217

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 288

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 194

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


174
175
176
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



180
181
182
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 180

def hash
  [amount, date, name, original_description, pending, transaction_id, check_number, iso_currency_code, unofficial_currency_code].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



145
146
147
148
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 145

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



264
265
266
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 264

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 270

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



258
259
260
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 258

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



152
153
154
 
# File 'lib/plaid/models/credit_bank_income_transaction.rb', line 152

def valid?
  true
end