Class: WhopSDK::Models::DepositCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::DepositCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/deposit_create_params.rb

Overview

See Also:

• Resources::Deposits#create

Defined Under Namespace

Modules: Destination

Instance Attribute Summary

• #amount ⇒ Float

  Amount to deposit.

• #destination ⇒ String, WhopSDK::Models::DepositCreateParams::Destination::UnionMember1

  Destination account ID or wallet address.

• #metadata ⇒ Hash{Symbol=>Object}^?

  Arbitrary metadata echoed in the response.

• #network ⇒ String^?

  Optional destination network override.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(amount:, destination:, metadata: nil, network: nil, request_options: {}) ⇒ Object constructor

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

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(amount:, destination:, metadata: nil, network: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::DepositCreateParams for more details.

Parameters:

• amount (Float) —

  Amount to deposit.

• destination (String, WhopSDK::Models::DepositCreateParams::Destination::UnionMember1) —

  Destination account ID or wallet address. Object form is supported for compatibi

• metadata (Hash{Symbol=>Object}) (defaults to: nil) —

  Arbitrary metadata echoed in the response.

• network (String, nil) (defaults to: nil) —

  Optional destination network override.

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

# File 'lib/whop_sdk/models/deposit_create_params.rb', line 35

Instance Attribute Details

#amount ⇒ Float

Amount to deposit.

Returns:

• (Float)

# File 'lib/whop_sdk/models/deposit_create_params.rb', line 14

required :amount, Float

#destination ⇒ String, WhopSDK::Models::DepositCreateParams::Destination::UnionMember1

Destination account ID or wallet address. Object form is supported for compatibility.

Returns:

• (String, WhopSDK::Models::DepositCreateParams::Destination::UnionMember1)

# File 'lib/whop_sdk/models/deposit_create_params.rb', line 21

required :destination, union: -> { WhopSDK::DepositCreateParams::Destination }

#metadata ⇒ Hash{Symbol=>Object}^?

Arbitrary metadata echoed in the response.

Returns:

• (Hash{Symbol=>Object}, nil)

# File 'lib/whop_sdk/models/deposit_create_params.rb', line 27

optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]

#network ⇒ String^?

Optional destination network override.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/deposit_create_params.rb', line 33

optional :network, String, nil?: true