Class: ThePlaidApi::BankTransferBalance

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

Overview

Information about the balance of a bank transfer

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(available:, transactable:, additional_properties: nil) ⇒ BankTransferBalance

Returns a new instance of BankTransferBalance.



41
42
43
44
45
46
47
48
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 41

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

  @available = available
  @transactable = transactable
  @additional_properties = additional_properties
end

Instance Attribute Details

#available ⇒ String

The total available balance - the sum of all successful debit transfer amounts minus all credit transfer amounts.

Returns:

  • (String) 


15
16
17
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 15

def available
  @available
end

#transactable ⇒ String

The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance.

Returns:

  • (String) 


21
22
23
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 21

def transactable
  @transactable
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  available = hash.key?('available') ? hash['available'] : nil
  transactable = hash.key?('transactable') ? hash['transactable'] : 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.
  BankTransferBalance.new(available: available,
                          transactable: transactable,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



24
25
26
27
28
29
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 24

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['available'] = 'available'
  @_hash['transactable'] = 'transactable'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



32
33
34
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 32

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



79
80
81
82
83
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 79

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



72
73
74
75
76
 
# File 'lib/the_plaid_api/models/bank_transfer_balance.rb', line 72

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