Class: WhopSDK::Models::Referrals::BusinessListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/referrals/business_list_params.rb,
sig/whop_sdk/models/referrals/business_list_params.rbs

Overview

See Also:

  • WhopSDK::Resources::Referrals::Businesses#list

Defined Under Namespace

Modules: Direction, Order, Status, Tier

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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, created_after: nil, created_before: nil, direction: nil, first: nil, has_earnings: nil, last: nil, order: nil, referred_user_id: nil, referred_username: nil, status: nil, tier: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see WhopSDK::Models::Referrals::BusinessListParams 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).

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

    Only return business referrals created after this timestamp.

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

    Only return business referrals created before this timestamp.

  • direction (Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction) (defaults to: nil) —

    Sort direction.

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

    Number of business referrals to return from the start of the window.

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

    When true, only businesses with pending or completed earnings paid to the caller

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

    Number of business referrals to return from the end of the window.

  • order (Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order) (defaults to: nil) —

    The field to sort business referrals by.

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

    Filter to referrals attributed to this user. For first-tier referrals, this is t

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

    Filter by the referred user's exact username. Ignored when referred_user_id is

  • status (Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status) (defaults to: nil) —

    Filter by referral status.

  • tier (Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier) (defaults to: nil) —

    Filter to only first-tier referrals or only second-tier referrals.

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



# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 93

Instance Attribute Details

#after ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


15
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 15

optional :after, String

#before ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


21
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 21

optional :before, String

#created_after ⇒ String?

Only return business referrals created after this timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 27

optional :created_after, String

#created_before ⇒ String?

Only return business referrals created before this timestamp.

Parameters:

  • (String)

Returns:

  • (String, nil) 


33
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 33

optional :created_before, String

#direction ⇒ Symbol, ...

Sort direction.

Returns:



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

optional :direction, enum: -> { WhopSDK::Referrals::BusinessListParams::Direction }

#first ⇒ Integer?

Number of business referrals to return from the start of the window.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :first, Integer

#has_earnings ⇒ Boolean?

When true, only businesses with pending or completed earnings paid to the caller.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


52
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 52

optional :has_earnings, WhopSDK::Internal::Type::Boolean

#last ⇒ Integer?

Number of business referrals to return from the end of the window.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


58
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 58

optional :last, Integer

#order ⇒ Symbol, ...

The field to sort business referrals by.

Returns:



64
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 64

optional :order, enum: -> { WhopSDK::Referrals::BusinessListParams::Order }

#referred_user_id ⇒ String?

Filter to referrals attributed to this user. For first-tier referrals, this is the referred account owner; for second-tier referrals, this is the partner you recruited.

Parameters:

  • (String)

Returns:

  • (String, nil) 


72
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 72

optional :referred_user_id, String

#referred_username ⇒ String?

Filter by the referred user's exact username. Ignored when referred_user_id is present.

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 79

optional :referred_username, String

#status ⇒ Symbol, ...

Filter by referral status.

Returns:



85
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 85

optional :status, enum: -> { WhopSDK::Referrals::BusinessListParams::Status }

#tier ⇒ Symbol, ...

Filter to only first-tier referrals or only second-tier referrals.

Returns:



91
 
# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 91

optional :tier, enum: -> { WhopSDK::Referrals::BusinessListParams::Tier }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/referrals/business_list_params.rb', line 132

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


103
 
# File 'sig/whop_sdk/models/referrals/business_list_params.rbs', line 103

def to_hash: -> {