Class: WhopSDK::Models::ReferralReferredUsersParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::ReferralReferredUsersParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/referral_referred_users_params.rb,
sig/whop_sdk/models/referral_referred_users_params.rbs

Overview

See Also:

• WhopSDK::Resources::Referrals#referred_users

Instance Attribute Summary

• #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 earnings.

• #last ⇒ Integer^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) ⇒ Object

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

Parameters:

• after (String) (defaults to: nil) —

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

• before (String) (defaults to: nil) —

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

• first (Integer) (defaults to: nil) —

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

• has_businesses (Boolean) (defaults to: nil) —

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

• has_earning_businesses (Boolean) (defaults to: nil) —

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

• last (Integer) (defaults to: nil) —

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

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

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 47

Instance Attribute Details

#after ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 14

optional :after, String

#before ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 20

optional :before, String

#first ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 26

optional :first, Integer

#has_businesses ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 32

optional :has_businesses, WhopSDK::Internal::Type::Boolean

#has_earning_businesses ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 39

optional :has_earning_businesses, WhopSDK::Internal::Type::Boolean

#last ⇒ Integer^?

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

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/referral_referred_users_params.rb', line 45

optional :last, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/referral_referred_users_params.rbs', line 52

def to_hash: -> {