Class: Onlyfans::Models::FanListTopParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onlyfans/models/fan_list_top_params.rb

Overview

See Also:

Defined Under Namespace

Modules: By

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(account:, by: nil, end_date: nil, start_date: nil, request_options: {}) ⇒ Object

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

Parameters:

  • account (String)
  • by (Symbol, Onlyfans::Models::FanListTopParams::By, nil) (defaults to: nil) —

    Sort by: total (default), subscribes, tips, messages, post, streams.

  • end_date (String, nil) (defaults to: nil) —

    End date for filtering (required with start_date). This field is required when <

  • start_date (String, nil) (defaults to: nil) —

    Start date for filtering (required with end_date). This field is required when <

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



# File 'lib/onlyfans/models/fan_list_top_params.rb', line 35

Instance Attribute Details

#account ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/onlyfans/models/fan_list_top_params.rb', line 13

required :account, String

#by ⇒ Symbol, ...

Sort by: total (default), subscribes, tips, messages, post, streams.

Returns:



19
 
# File 'lib/onlyfans/models/fan_list_top_params.rb', line 19

optional :by, enum: -> { Onlyfans::FanListTopParams::By }, nil?: true

#end_date ⇒ String?

End date for filtering (required with start_date). This field is required when start_date is present.

Returns:

  • (String, nil) 


26
 
# File 'lib/onlyfans/models/fan_list_top_params.rb', line 26

optional :end_date, String, nil?: true

#start_date ⇒ String?

Start date for filtering (required with end_date). This field is required when end_date is present.

Returns:

  • (String, nil) 


33
 
# File 'lib/onlyfans/models/fan_list_top_params.rb', line 33

optional :start_date, String, nil?: true