Class: WhopSDK::Models::Referrals::Businesses::EarningListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Referrals::Businesses::EarningListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/referrals/businesses/earning_list_params.rb,
sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs

Overview

See Also:

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

Defined Under Namespace

Modules: Direction, Order, Status

Instance Attribute Summary

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

  Sort direction.

• #first ⇒ Integer^?
• #id ⇒ String
• #last ⇒ Integer^?
• #order ⇒ Symbol, ...

  The field to sort earnings by.

• #status ⇒ Symbol, ...

  Filter by earning status.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) ⇒ Object constructor
• #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(id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• after (String) (defaults to: nil)
• before (String) (defaults to: nil)
• created_after (String) (defaults to: nil) —

  Only return earnings created after this timestamp.

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

  Only return earnings created before this timestamp.

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

  Sort direction.

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

  The field to sort earnings by.

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

  Filter by earning status.

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

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 67

Instance Attribute Details

#after ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 20

optional :after, String

#before ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 25

optional :before, String

#created_after ⇒ String^?

Only return earnings created after this timestamp.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 31

optional :created_after, String

#created_before ⇒ String^?

Only return earnings created before this timestamp.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 37

optional :created_before, String

#direction ⇒ Symbol, ...

Sort direction.

Returns:

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

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 43

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

#first ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 48

optional :first, Integer

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#last ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 53

optional :last, Integer

#order ⇒ Symbol, ...

The field to sort earnings by.

Returns:

• (Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order, nil)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 59

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

#status ⇒ Symbol, ...

Filter by earning status.

Returns:

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

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 65

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/whop_sdk/models/referrals/businesses/earning_list_params.rb', line 97

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs', line 82

def to_hash: -> {