Class: WhopSDK::Resources::Referrals::Businesses::Earnings

Inherits:

Object

• Object
• WhopSDK::Resources::Referrals::Businesses::Earnings

Defined in:

lib/whop_sdk/resources/referrals/businesses/earnings.rb,
sig/whop_sdk/resources/referrals/businesses/earnings.rbs

Overview

The Referrals API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard.

Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard.

Instance Method Summary

• #initialize(client:) ⇒ Earnings constructor private

  A new instance of Earnings.

• #list(id, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::Referrals::Businesses::EarningListResponse>

  Lists the earnings Whop pays out for one referred business's activity, most recent first.

Constructor Details

#initialize(client:) ⇒ Earnings

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

Parameters:

• client (WhopSDK::Client)
• client: (WhopSDK::Client)

# File 'lib/whop_sdk/resources/referrals/businesses/earnings.rb', line 60

def initialize(client:)
  @client = client
end

Instance Method Details

#list(id, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) ⇒ WhopSDK::Internal::CursorPage<WhopSDK::Models::Referrals::Businesses::EarningListResponse>

Lists the earnings Whop pays out for one referred business's activity, most recent first.

Parameters:

• id (String) —

  The business referral ID (a coma_ identifier).

• after (String)
• before (String)
• created_after (String) —

  Only return earnings created after this timestamp.

• created_before (String) —

  Only return earnings created before this timestamp.

• direction (Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Direction) —

  Sort direction.

• first (Integer)
• last (Integer)
• order (Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order) —

  The field to sort earnings by.

• status (Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Status) —

  Filter by earning status.

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

Returns:

• (WhopSDK::Internal::CursorPage<WhopSDK::Models::Referrals::Businesses::EarningListResponse>)

See Also:

• Models::Referrals::Businesses::EarningListParams

# File 'lib/whop_sdk/resources/referrals/businesses/earnings.rb', line 44

def list(id, params = {})
  parsed, options = WhopSDK::Referrals::Businesses::EarningListParams.dump_request(params)
  query = WhopSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["partners/businesses/%1$s/earnings", id],
    query: query,
    page: WhopSDK::Internal::CursorPage,
    model: WhopSDK::Models::Referrals::Businesses::EarningListResponse,
    options: options
  )
end