Class: ThePlaidApi::TotalOutflowAmount

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/total_outflow_amount.rb

Overview

Total amount of credit transactions into the account in the time period of the report. This field will be empty for non-depository accounts. This field only takes into account USD transactions from the account.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(amount:, iso_currency_code:, unofficial_currency_code:, additional_properties: nil) ⇒ TotalOutflowAmount

Returns a new instance of TotalOutflowAmount.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 52

def initialize(amount:, iso_currency_code:, unofficial_currency_code:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @amount = amount
  @iso_currency_code = iso_currency_code
  @unofficial_currency_code = unofficial_currency_code
  @additional_properties = additional_properties
end

Instance Attribute Details

#amount ⇒ Float

Value of amount with up to 2 decimal places.

Returns:

  • (Float) 


16
17
18
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 16

def amount
  @amount
end

#iso_currency_code ⇒ String

The ISO 4217 currency code of the amount or balance.

Returns:

  • (String) 


20
21
22
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 20

def iso_currency_code
  @iso_currency_code
end

#unofficial_currency_code ⇒ String

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.

Returns:

  • (String) 


28
29
30
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 28

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 64

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  amount = hash.key?('amount') ? hash['amount'] : nil
  iso_currency_code =
    hash.key?('iso_currency_code') ? hash['iso_currency_code'] : nil
  unofficial_currency_code =
    hash.key?('unofficial_currency_code') ? hash['unofficial_currency_code'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  TotalOutflowAmount.new(amount: amount,
                         iso_currency_code: iso_currency_code,
                         unofficial_currency_code: unofficial_currency_code,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



31
32
33
34
35
36
37
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 31

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['amount'] = 'amount'
  @_hash['iso_currency_code'] = 'iso_currency_code'
  @_hash['unofficial_currency_code'] = 'unofficial_currency_code'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



45
46
47
48
49
50
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 45

def self.nullables
  %w[
    iso_currency_code
    unofficial_currency_code
  ]
end

.optionals ⇒ Object

An array for optional fields



40
41
42
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 40

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



97
98
99
100
101
102
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 97

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount.inspect}, iso_currency_code:"\
  " #{@iso_currency_code.inspect}, unofficial_currency_code:"\
  " #{@unofficial_currency_code.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



89
90
91
92
93
94
 
# File 'lib/the_plaid_api/models/total_outflow_amount.rb', line 89

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} amount: #{@amount}, iso_currency_code: #{@iso_currency_code},"\
  " unofficial_currency_code: #{@unofficial_currency_code}, additional_properties:"\
  " #{@additional_properties}>"
end