Class: Increase::Models::BalanceLookup

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/balance_lookup.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_id: , available_balance: , current_balance: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::BalanceLookup for more details.

Represents a request to lookup the balance of an Account at a given point in time.

Parameters:

  • account_id (String) (defaults to: ) —

    The identifier for the account for which the balance was queried.

  • available_balance (Integer) (defaults to: ) —

    The Account’s available balance, representing the current balance less any open

  • current_balance (Integer) (defaults to: ) —

    The Account’s current balance, representing the sum of all posted Transactions o

  • type (Symbol, Increase::Models::BalanceLookup::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




# File 'lib/increase/models/balance_lookup.rb', line 34

Instance Attribute Details

#account_id ⇒ String

The identifier for the account for which the balance was queried.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/balance_lookup.rb', line 11

required :account_id, String

#available_balance ⇒ Integer

The Account’s available balance, representing the current balance less any open Pending Transactions on the Account.

Returns:

  • (Integer) 


18
 
# File 'lib/increase/models/balance_lookup.rb', line 18

required :available_balance, Integer

#current_balance ⇒ Integer

The Account’s current balance, representing the sum of all posted Transactions on the Account.

Returns:

  • (Integer) 


25
 
# File 'lib/increase/models/balance_lookup.rb', line 25

required :current_balance, Integer

#type ⇒ Symbol, Increase::Models::BalanceLookup::Type

A constant representing the object’s type. For this resource it will always be ‘balance_lookup`.

Returns:



32
 
# File 'lib/increase/models/balance_lookup.rb', line 32

required :type, enum: -> { Increase::BalanceLookup::Type }