Class: WhopSDK::Models::UserBalance

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/user_balance.rb,
sig/whop_sdk/models/user_balance.rbs

Defined Under Namespace

Classes: Business, Cash, Crypto

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(balance:, balance_usd:, currency:, pending_balance_usd:, reserve_balance_usd:, total_withdrawable_balance:) ⇒ Object

Per-currency fiat cash balances.

Parameters:

  • balance (Float) —

    Available balance in the native currency.

  • balance_usd (Float) —

    Available balance converted to USD.

  • currency (String) —

    Lowercase ISO currency code, such as usd or eur.

  • pending_balance_usd (Float) —

    Pending balance converted to USD.

  • reserve_balance_usd (Float) —

    Reserved balance converted to USD.

  • total_withdrawable_balance (Float) —

    Withdrawable amount in the native currency.




# File 'lib/whop_sdk/models/user_balance.rb', line 106

Instance Attribute Details

#businesses ⇒ Array<WhopSDK::Models::UserBalance::Business>

Parameters:

  • value (::Array[WhopSDK::UserBalance::Business])

Returns:



9
 
# File 'lib/whop_sdk/models/user_balance.rb', line 9

required :businesses, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Business] }

#businesses_total_usd ⇒ String

Combined USD balance across every account the user owns.

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/whop_sdk/models/user_balance.rb', line 15

required :businesses_total_usd, String

#cash ⇒ Array<WhopSDK::Models::UserBalance::Cash>

Parameters:

  • value (::Array[WhopSDK::UserBalance::Cash])

Returns:



20
 
# File 'lib/whop_sdk/models/user_balance.rb', line 20

required :cash, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Cash] }

#cash_usd ⇒ String

Fiat cash in USD, including pending and reserve.

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/whop_sdk/models/user_balance.rb', line 26

required :cash_usd, String

#crypto ⇒ Array<WhopSDK::Models::UserBalance::Crypto>

Parameters:

  • value (::Array[WhopSDK::UserBalance::Crypto])

Returns:



31
 
# File 'lib/whop_sdk/models/user_balance.rb', line 31

required :crypto, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::UserBalance::Crypto] }

#crypto_usd ⇒ String

Crypto holdings in USD.

Parameters:

  • value (String)

Returns:

  • (String) 


37
 
# File 'lib/whop_sdk/models/user_balance.rb', line 37

required :crypto_usd, String

#pending_usd ⇒ String

Pending funds in USD: fiat pending + in-flight treasury deposits.

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/whop_sdk/models/user_balance.rb', line 43

required :pending_usd, String

#total_usd ⇒ String

The user's personal balance in USD: cash (available + pending + reserve) + crypto + in-flight treasury deposits. Excludes account balances (see businesses_total_usd).

Parameters:

  • value (String)

Returns:

  • (String) 


51
 
# File 'lib/whop_sdk/models/user_balance.rb', line 51

required :total_usd, String

#treasury_pending_usd ⇒ String

Balance-to-wallet USDT0 withdrawals still in flight, in USD.

Parameters:

  • value (String)

Returns:

  • (String) 


57
 
# File 'lib/whop_sdk/models/user_balance.rb', line 57

required :treasury_pending_usd, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


47
 
# File 'sig/whop_sdk/models/user_balance.rbs', line 47

def to_hash: -> {