Class: WhopSDK::Models::Referrals::Businesses::EarningListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/referrals/businesses/earning_list_response.rb,
sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs

Overview

See Also:

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

Defined Under Namespace

Modules: Object, Status Classes: Account, FinancialActivity, Product, Resource

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id:, route:, title:) ⇒ Object

Parameters:

  • id (String)
  • route (String)
  • title (String) 



# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 94

Instance Attribute Details

#account ⇒ WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account?

Referred account.

Parameters:

Returns:



18
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 18

required :account, -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account }, nil?: true

#cancelation_reason ⇒ String?

Why the earning was canceled or reversed, if applicable.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


24
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 24

required :cancelation_reason, String, nil?: true

#commission_amount_usd ⇒ String?

What the referrer earns, in USD. Null until the earning settles.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


30
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 30

required :commission_amount_usd, String, nil?: true

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


35
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 35

required :created_at, Time

#financial_activity ⇒ Array<WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity>?

Income and cost lines behind this earning's commission. Null for earnings settled before this data was recorded.

Parameters:

Returns:



42
43
44
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 42

required :financial_activity,
-> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity] },
nil?: true

#id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


12
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 12

required :id, String, nil?: true

#object ⇒ Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object

Parameters:

  • value (WhopSDK::Models::Referrals::Businesses::EarningListResponse::object)

Returns:



49
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 49

required :object, enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object }

#payout_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


54
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 54

required :payout_at, Time, nil?: true

#payout_percentage ⇒ Float?

The referrer's share of Whop's gross profit, as a fraction (0.3 = 30%). Null until the earning settles.

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


61
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 61

required :payout_percentage, Float, nil?: true

#product ⇒ WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product?

Parameters:

Returns:



66
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 66

required :product, -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product }, nil?: true

#resource ⇒ WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource?

The resource that generated the affiliate earning.

Parameters:

Returns:



72
73
74
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 72

required :resource,
-> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource },
nil?: true

#second_tier ⇒ Boolean

Whether this earning is a second-tier (grandparent) commission.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


80
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 80

required :second_tier, WhopSDK::Internal::Type::Boolean

#status ⇒ Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status

Current status of the earning.

Parameters:

  • value (WhopSDK::Models::Referrals::Businesses::EarningListResponse::status)

Returns:



86
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 86

required :status, enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status }

#transaction_amount_usd ⇒ String

The sale amount the commission is calculated from, in USD.

Parameters:

  • value (String)

Returns:

  • (String) 


92
 
# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 92

required :transaction_amount_usd, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/referrals/businesses/earning_list_response.rb', line 223

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


69
 
# File 'sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs', line 69

def to_hash: -> {