Class: Onlyfans::Models::Analytics::SummaryGetPeriodComparisonParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb,
sig/onlyfans/models/analytics/summary_get_period_comparison_params.rbs

Overview

See Also:

  • Onlyfans::Resources::Analytics::Summary#get_period_comparison

Defined Under Namespace

Modules: Granularity, StatType Classes: PeriodA, PeriodB

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(end_:, start:) ⇒ Object

Some parameter documentations has been truncated, see PeriodB for more details.

Second period to compare

Parameters:

  • end_ (String) —

    Must be a valid date. Must be a date after or equal to period_b.start</cod

  • start (String) —

    Must be a valid date.




# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 68

Instance Attribute Details

#account_ids ⇒ Array<String>

Array of account prefixed IDs to compare

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


15
 
# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 15

required :account_ids, Onlyfans::Internal::Type::ArrayOf[String]

#granularity ⇒ Symbol, ...

Comparison granularity

Returns:



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

optional :granularity, enum: -> { Onlyfans::Analytics::SummaryGetPeriodComparisonParams::Granularity }

#period_a ⇒ Onlyfans::Models::Analytics::SummaryGetPeriodComparisonParams::PeriodA

First period to compare

Parameters:

  • value (Onlyfans::Analytics::SummaryGetPeriodComparisonParams::PeriodA)

Returns:



21
 
# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 21

required :period_a, -> { Onlyfans::Analytics::SummaryGetPeriodComparisonParams::PeriodA }

#period_b ⇒ Onlyfans::Models::Analytics::SummaryGetPeriodComparisonParams::PeriodB

Second period to compare

Parameters:

  • value (Onlyfans::Analytics::SummaryGetPeriodComparisonParams::PeriodB)

Returns:



27
 
# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 27

required :period_b, -> { Onlyfans::Analytics::SummaryGetPeriodComparisonParams::PeriodB }

#stat_type ⇒ Symbol, ...

The statistic type to compare

Returns:



39
 
# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 39

optional :stat_type, enum: -> { Onlyfans::Analytics::SummaryGetPeriodComparisonParams::StatType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/onlyfans/models/analytics/summary_get_period_comparison_params.rb', line 115

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


45
 
# File 'sig/onlyfans/models/analytics/summary_get_period_comparison_params.rbs', line 45

def to_hash: -> {