Class: Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb,
sig/onlyfans/models/statistics/reach_get_profile_visitors_params.rbs

Overview

See Also:

• Onlyfans::Resources::Statistics::Reach#get_profile_visitors

Defined Under Namespace

Modules: Filter, Type

Instance Attribute Summary

• #account ⇒ String
• #end_date ⇒ String

  The end date for the period.

• #filter ⇒ Symbol, ...

  Optionally, filter the results by chart or topCountries.

• #limit ⇒ Integer^?

  Number of results to return.

• #start_date ⇒ String

  The start date for the period.

• #type ⇒ Symbol, ...

  Filter all / users / guests.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account:, end_date:, start_date:, filter: nil, limit: nil, type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ReachGetProfileVisitorsParams 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(account:, end_date:, start_date:, filter: nil, limit: nil, type: nil, request_options: {}) ⇒ Object

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

Parameters:

• account (String)
• end_date (String) —

  The end date for the period.

• start_date (String) —

  The start date for the period

• filter (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Filter, nil) (defaults to: nil) —

  Optionally, filter the results by chart or topCountries. See example respons

• limit (Integer, nil) (defaults to: nil) —

  Number of results to return

• type (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Type, nil) (defaults to: nil) —

  Filter all / users / guests

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

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 47

Instance Attribute Details

#account ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 14

required :account, String

#end_date ⇒ String

The end date for the period.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 20

required :end_date, String

#filter ⇒ Symbol, ...

Optionally, filter the results by chart or topCountries. See example responses.

Parameters:

• value (Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::filter, nil)

Returns:

• (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Filter, nil)

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

optional :filter, enum: -> { Onlyfans::Statistics::ReachGetProfileVisitorsParams::Filter }, nil?: true

#limit ⇒ Integer^?

Number of results to return

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 39

optional :limit, Integer, nil?: true

#start_date ⇒ String

The start date for the period

Parameters:

• value (String)

Returns:

• (String)

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

required :start_date, String

#type ⇒ Symbol, ...

Filter all / users / guests

Parameters:

• value (Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::type_, nil)

Returns:

• (Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Type, nil)

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 45

optional :type, enum: -> { Onlyfans::Statistics::ReachGetProfileVisitorsParams::Type }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb', line 73

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/onlyfans/models/statistics/reach_get_profile_visitors_params.rbs', line 41

def to_hash: -> {