Class: WhopSDK::Models::TransferRetrieveResponse

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

Overview

See Also:

  • WhopSDK::Resources::Transfers#retrieve

Defined Under Namespace

Modules: Destination, Origin

Instance Attribute Summary collapse

Class Method 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(id:, name: nil, username: nil, typename: :User) ⇒ Object

Parameters:

  • id (String) —

    User ID.

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

    User display name.

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

    User's username.

  • typename (Symbol, :User) (defaults to: :User) 



# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 73

Instance Attribute Details

#amount ⇒ Float

Transfer amount.

Parameters:

  • value (Float)

Returns:

  • (Float) 


17
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 17

required :amount, Float

#created_at ⇒ Time

When the transfer was created.

Parameters:

  • value (Time)

Returns:

  • (Time) 


23
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 23

required :created_at, Time

#currency ⇒ String

Transfer currency.

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 29

required :currency, String

#destination ⇒ WhopSDK::Models::TransferRetrieveResponse::Destination::Company, WhopSDK::Models::TransferRetrieveResponse::Destination::User

Account or user receiving funds.

Parameters:

  • value (WhopSDK::Models::TransferRetrieveResponse::destination)

Returns:



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

required :destination, union: -> { WhopSDK::Models::TransferRetrieveResponse::Destination }

#destination_ledger_account_id ⇒ String

Destination ledger account ID.

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 41

required :destination_ledger_account_id, String

#fee_amount ⇒ Float?

Fee charged for the transfer.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


59
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 59

optional :fee_amount, Float, nil?: true

#id ⇒ String

Transfer ID.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 11

required :id, String

#metadata ⇒ Hash{Symbol=>Object}?

Custom metadata attached to the transfer.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

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


65
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 65

optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true

#notes ⇒ String?

Transfer note.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


71
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 71

optional :notes, String, nil?: true

#origin ⇒ WhopSDK::Models::TransferRetrieveResponse::Origin::Company, WhopSDK::Models::TransferRetrieveResponse::Origin::User

Account or user sending funds.

Parameters:

  • value (WhopSDK::Models::TransferRetrieveResponse::origin)

Returns:



47
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 47

required :origin, union: -> { WhopSDK::Models::TransferRetrieveResponse::Origin }

#origin_ledger_account_id ⇒ String

Source ledger account ID.

Parameters:

  • value (String)

Returns:

  • (String) 


53
 
# File 'lib/whop_sdk/models/transfer_retrieve_response.rb', line 53

required :origin_ledger_account_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


55
 
# File 'sig/whop_sdk/models/transfer_retrieve_response.rbs', line 55

def to_hash: -> {