Class: WhopSDK::Resources::LedgerAccounts

Inherits:

Object

• Object
• WhopSDK::Resources::LedgerAccounts

Defined in:

lib/whop_sdk/resources/ledger_accounts.rb

Instance Method Summary

• #initialize(client:) ⇒ LedgerAccounts constructor private

  A new instance of LedgerAccounts.

• #retrieve(id, request_options: {}) ⇒ WhopSDK::Models::LedgerAccountRetrieveResponse

  Retrieves a ledger account by ID.

Constructor Details

#initialize(client:) ⇒ LedgerAccounts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LedgerAccounts.

Parameters:

• client (WhopSDK::Client)

# File 'lib/whop_sdk/resources/ledger_accounts.rb', line 32

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(id, request_options: {}) ⇒ WhopSDK::Models::LedgerAccountRetrieveResponse

Retrieves a ledger account by ID

Required permissions:

• ‘company:balance:read`

Parameters:

• id (String)
• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (WhopSDK::Models::LedgerAccountRetrieveResponse)

See Also:

• Models::LedgerAccountRetrieveParams

# File 'lib/whop_sdk/resources/ledger_accounts.rb', line 20

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["ledger_accounts/%1$s", id],
    model: WhopSDK::Models::LedgerAccountRetrieveResponse,
    options: params[:request_options]
  )
end