Class: WhopSDK::Resources::Referrals

Inherits:
Object
  • Object
show all
Defined in:
lib/whop_sdk/resources/referrals.rb,
lib/whop_sdk/resources/referrals/partners.rb,
lib/whop_sdk/resources/referrals/businesses.rb,
lib/whop_sdk/resources/referrals/businesses/earnings.rb,
sig/whop_sdk/resources/referrals.rbs,
sig/whop_sdk/resources/referrals/partners.rbs,
sig/whop_sdk/resources/referrals/businesses.rbs,
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.

Defined Under Namespace

Classes: Businesses, Partners

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Referrals

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

Parameters:



70
71
72
73
74
 
# File 'lib/whop_sdk/resources/referrals.rb', line 70

def initialize(client:)
  @client = client
  @businesses = WhopSDK::Resources::Referrals::Businesses.new(client: client)
  @partners = WhopSDK::Resources::Referrals::Partners.new(client: client)
end

Instance Attribute Details

#businesses ⇒ WhopSDK::Resources::Referrals::Businesses (readonly)

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.

Returns:



19
20
21
 
# File 'lib/whop_sdk/resources/referrals.rb', line 19

def businesses
  @businesses
end

#partners ⇒ WhopSDK::Resources::Referrals::Partners (readonly)

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.

Returns:



28
29
30
 
# File 'lib/whop_sdk/resources/referrals.rb', line 28

def partners
  @partners
end

Instance Method Details

#referred_users(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) ⇒ WhopSDK::Models::ReferralReferredUsersResponse

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

Lists the users the caller referred onto Whop (newest first), each with the second-tier earnings the caller has made from that user's businesses.

Parameters:

  • after (String) —

    Cursor to fetch the page after (from page_info.end_cursor).

  • before (String) —

    Cursor to fetch the page before (from page_info.start_cursor).

  • first (Integer) —

    Number of referred users to return from the start of the window.

  • has_businesses (Boolean) —

    When true, only referred users who brought at least one business onto Whop.

  • has_earning_businesses (Boolean) —

    When true, only referred users with at least one business that has generated ear

  • last (Integer) —

    Number of referred users to return from the end of the window.

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

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/whop_sdk/resources/referrals.rb', line 55

def referred_users(params = {})
  parsed, options = WhopSDK::ReferralReferredUsersParams.dump_request(params)
  query = WhopSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "partners/referred_users",
    query: query,
    model: WhopSDK::Models::ReferralReferredUsersResponse,
    options: options
  )
end