Class: Privy::Models::Wallets::BalanceGetParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::Wallets::BalanceGetParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/privy/models/wallets/balance_get_params.rb,
sig/privy/models/wallets/balance_get_params.rbs

Overview

See Also:

• Privy::Resources::Wallets::Balance#get

Defined Under Namespace

Modules: Asset, Chain, IncludeCurrency, Token

Instance Attribute Summary

• #asset ⇒ Symbol, ...

  Named asset(s) to query (e.g. eth, usdc).

• #chain ⇒ Symbol, ...

  Chain(s) to query named assets on (e.g. base, ethereum).

• #include_archived ⇒ Boolean^?

  Include archived wallets in lookup.

• #include_currency ⇒ Symbol, ...

  If set, balances are converted to the specified fiat currency.

• #token ⇒ String, ...

  The token contract address(es) to query in format "chain:address" (e.g., "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v").

• #wallet_id ⇒ String

  ID of the wallet.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(wallet_id:, token: nil, asset: nil, chain: nil, include_archived: nil, include_currency: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BalanceGetParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(wallet_id:, token: nil, asset: nil, chain: nil, include_archived: nil, include_currency: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Privy::Models::Wallets::BalanceGetParams for more details.

Parameters:

• wallet_id (String) —

  ID of the wallet.

• token (String, Array<String>) (defaults to: nil) —

  The token contract address(es) to query in format "chain:address" (e.g., "base:0

• asset (Symbol, Array<Symbol, Privy::Models::WalletAsset>, Privy::Models::Wallets::BalanceGetParams::Asset) (defaults to: nil) —

  Named asset(s) to query (e.g. eth, usdc). Use together with chain to scope

• chain (Symbol, Privy::Models::WalletAssetChainNameInput, Array<Symbol, Privy::Models::WalletAssetChainNameInput>) (defaults to: nil) —

  Chain(s) to query named assets on (e.g. base, ethereum). Use together with `

• include_archived (Boolean) (defaults to: nil) —

  Include archived wallets in lookup. Defaults to false.

• include_currency (Symbol, Privy::Models::Wallets::BalanceGetParams::IncludeCurrency) (defaults to: nil) —

  If set, balances are converted to the specified fiat currency. Not supported whe

• request_options (Privy::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/privy/models/wallets/balance_get_params.rb', line 53

Instance Attribute Details

#asset ⇒ Symbol, ...

Named asset(s) to query (e.g. eth, usdc). Use together with chain to scope the query. Cannot be used with token.

Returns:

• (Symbol, Array<Symbol, Privy::Models::WalletAsset>, Privy::Models::Wallets::BalanceGetParams::Asset, nil)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 31

optional :asset, union: -> { Privy::Wallets::BalanceGetParams::Asset }

#chain ⇒ Symbol, ...

Chain(s) to query named assets on (e.g. base, ethereum). Use together with asset. Cannot be used with token.

Returns:

• (Symbol, Privy::Models::WalletAssetChainNameInput, Array<Symbol, Privy::Models::WalletAssetChainNameInput>, nil)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 38

optional :chain, union: -> { Privy::Wallets::BalanceGetParams::Chain }

#include_archived ⇒ Boolean^?

Include archived wallets in lookup. Defaults to false.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 44

optional :include_archived, Privy::Internal::Type::Boolean

#include_currency ⇒ Symbol, ...

If set, balances are converted to the specified fiat currency. Not supported when token is provided.

Returns:

• (Symbol, Privy::Models::Wallets::BalanceGetParams::IncludeCurrency, nil)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 51

optional :include_currency, enum: -> { Privy::Wallets::BalanceGetParams::IncludeCurrency }

#token ⇒ String, ...

The token contract address(es) to query in format "chain:address" (e.g., "base:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913" or "solana:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"). Cannot be used together with asset/chain or with include_currency.

Returns:

• (String, Array<String>, nil)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 24

optional :token, union: -> { Privy::Wallets::BalanceGetParams::Token }

#wallet_id ⇒ String

ID of the wallet.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/privy/models/wallets/balance_get_params.rb', line 15

required :wallet_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/privy/models/wallets/balance_get_params.rbs', line 59

def to_hash: -> {