Class: WhopSDK::Models::LedgerAccountRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/ledger_account_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Modules: LedgerType, Owner, PaymentsApprovalStatus Classes: Balance, PayoutAccountDetails

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:, route:, title:, typename: :Company) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company for more details.

A company is a seller on Whop. Companies own products, manage members, and receive payouts.

Parameters:

  • id (String) —

    The unique identifier for the company.

  • route (String) —

    The URL slug for the company’s store page (e.g., ‘pickaxe’ in whop.com/pickaxe).

  • title (String) —

    The display name of the company shown to customers.

  • typename (Symbol, :Company) (defaults to: :Company) —

    The typename of this object




# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 97

Instance Attribute Details

#balances ⇒ Array<WhopSDK::Models::LedgerAccountRetrieveResponse::Balance>

The balances associated with the account.

Returns:



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

required :balances,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::LedgerAccountRetrieveResponse::Balance] }

#id ⇒ String

The unique identifier for the ledger account.

Returns:

  • (String) 


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

required :id, String

#ledger_type ⇒ Symbol, WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerType

The type of ledger account.

Returns:



24
 
# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 24

required :ledger_type, enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::LedgerType }

#owner ⇒ WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User, ...

The owner of the ledger account.

Returns:



30
 
# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 30

required :owner, union: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::Owner }

#payments_approval_status ⇒ Symbol, ...

The different approval statuses an account can have.

Returns:



36
37
38
 
# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 36

required :payments_approval_status,
enum: -> { WhopSDK::Models::LedgerAccountRetrieveResponse::PaymentsApprovalStatus },
nil?: true

#payout_account_details ⇒ WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails?

The payout account associated with the LedgerAccount, if any.

Returns:



44
45
46
 
# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 44

required :payout_account_details,
-> { WhopSDK::Models::LedgerAccountRetrieveResponse::PayoutAccountDetails },
nil?: true

#transfer_fee ⇒ Float?

The fee for transfers, if applicable.

Returns:

  • (Float, nil) 


52
 
# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 52

required :transfer_fee, Float, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 118

.variants ⇒ Array(WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::User, WhopSDK::Models::LedgerAccountRetrieveResponse::Owner::Company)

Returns:




# File 'lib/whop_sdk/models/ledger_account_retrieve_response.rb', line 216