Class: Privy::Models::WalletListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::WalletListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/privy/models/wallet_list_params.rb,
sig/privy/models/wallet_list_params.rbs

Overview

See Also:

• Privy::Resources::Wallets#list

Instance Attribute Summary

• #address ⇒ String^?

  A blockchain wallet address.

• #authorization_key ⇒ String^?

  Filter wallets by authorization public key.

• #chain_type ⇒ Symbol, ...

  The wallet chain types.

• #cursor ⇒ String^?
• #external_id ⇒ String^?

  Filter wallets by external ID.

• #include_archived ⇒ Boolean^?

  Include archived wallets in lookup.

• #limit ⇒ Float^?
• #user_id ⇒ String^?

  Filter wallets by user ID.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(address: nil, authorization_key: nil, chain_type: nil, cursor: nil, external_id: nil, include_archived: nil, limit: nil, user_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see WalletListParams 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(address: nil, authorization_key: nil, chain_type: nil, cursor: nil, external_id: nil, include_archived: nil, limit: nil, user_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• address (String) (defaults to: nil) —

  A blockchain wallet address. Ethereum addresses are normalized to EIP-55 checksu

• authorization_key (String) (defaults to: nil) —

  Filter wallets by authorization public key. Returns wallets owned by key quorums

• chain_type (Symbol, Privy::Models::WalletChainType) (defaults to: nil) —

  The wallet chain types.

• cursor (String) (defaults to: nil)
• external_id (String) (defaults to: nil) —

  Filter wallets by external ID.

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

  Include archived wallets in lookup. Defaults to false.

• limit (Float, nil) (defaults to: nil)
• user_id (String) (defaults to: nil) —

  Filter wallets by user ID. Cannot be used together with authorization_key.

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

# File 'lib/privy/models/wallet_list_params.rb', line 60

Instance Attribute Details

#address ⇒ String^?

A blockchain wallet address. Ethereum addresses are normalized to EIP-55 checksum format. Solana addresses are validated as base58. All other chain addresses (Stellar, Tron, Sui, Aptos, etc.) are accepted as-is.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 16

optional :address, String

#authorization_key ⇒ String^?

Filter wallets by authorization public key. Returns wallets owned by key quorums that include the specified P-256 public key (base64-encoded DER format). Cannot be used together with user_id.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :authorization_key, String

#chain_type ⇒ Symbol, ...

The wallet chain types.

Returns:

• (Symbol, Privy::Models::WalletChainType, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 30

optional :chain_type, enum: -> { Privy::WalletChainType }

#cursor ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 35

optional :cursor, String

#external_id ⇒ String^?

Filter wallets by external ID.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 41

optional :external_id, String

#include_archived ⇒ Boolean^?

Include archived wallets in lookup. Defaults to false.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 47

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

#limit ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 52

optional :limit, Float, nil?: true

#user_id ⇒ String^?

Filter wallets by user ID. Cannot be used together with authorization_key.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallet_list_params.rb', line 58

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/privy/models/wallet_list_params.rbs', line 64

def to_hash: -> {