Class: WhopSDK::Resources::Deposits

Inherits:

Object

• Object
• WhopSDK::Resources::Deposits

Defined in:

lib/whop_sdk/resources/deposits.rb

Instance Method Summary

• #create(amount:, destination:, metadata: nil, network: nil, request_options: {}) ⇒ WhopSDK::Models::DepositCreateResponse

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

• #initialize(client:) ⇒ Deposits constructor private

  A new instance of Deposits.

Constructor Details

#initialize(client:) ⇒ Deposits

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 Deposits.

Parameters:

• client (WhopSDK::Client)

# File 'lib/whop_sdk/resources/deposits.rb', line 41

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount:, destination:, metadata: nil, network: nil, request_options: {}) ⇒ WhopSDK::Models::DepositCreateResponse

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

Resolves a deposit destination and returns the on-chain addresses that can fund it.

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}) —

  Arbitrary metadata echoed in the response.

• network (String, nil) —

  Optional destination network override.

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

Returns:

• (WhopSDK::Models::DepositCreateResponse)

See Also:

• Models::DepositCreateParams

# File 'lib/whop_sdk/resources/deposits.rb', line 27

def create(params)
  parsed, options = WhopSDK::DepositCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "deposits",
    body: parsed,
    model: WhopSDK::Models::DepositCreateResponse,
    options: options
  )
end