Class: Onlyfans::Models::Analytics::FinancialGetForecastParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Onlyfans::Models::Analytics::FinancialGetForecastParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/onlyfans/models/analytics/financial_get_forecast_params.rb

Overview

See Also:

• Resources::Analytics::Financial#get_forecast

Defined Under Namespace

Modules: Metric, Model

Instance Attribute Summary

• #account_ids ⇒ Array<String>

  Array of account prefixed IDs.

• #forecast_days ⇒ Integer

  Number of days to forecast (7-365).

• #historical_days ⇒ Integer

  Number of historical days to analyze (30-730).

• #metric ⇒ Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Metric

  The metric to forecast.

• #model ⇒ Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Model

  The forecasting model to use.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account_ids:, forecast_days:, historical_days:, metric:, model:, request_options: {}) ⇒ Object constructor

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_ids:, forecast_days:, historical_days:, metric:, model:, request_options: {}) ⇒ Object

Parameters:

• account_ids (Array<String>) —

  Array of account prefixed IDs

• forecast_days (Integer) —

  Number of days to forecast (7-365)

• historical_days (Integer) —

  Number of historical days to analyze (30-730)

• metric (Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Metric) —

  The metric to forecast

• model (Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Model) —

  The forecasting model to use

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

# File 'lib/onlyfans/models/analytics/financial_get_forecast_params.rb', line 41

Instance Attribute Details

#account_ids ⇒ Array<String>

Array of account prefixed IDs

Returns:

• (Array<String>)

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

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

#forecast_days ⇒ Integer

Number of days to forecast (7-365)

Returns:

• (Integer)

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

required :forecast_days, Integer

#historical_days ⇒ Integer

Number of historical days to analyze (30-730)

Returns:

• (Integer)

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

required :historical_days, Integer

#metric ⇒ Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Metric

The metric to forecast

Returns:

• (Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Metric)

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

required :metric, enum: -> { Onlyfans::Analytics::FinancialGetForecastParams::Metric }

#model ⇒ Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Model

The forecasting model to use

Returns:

• (Symbol, Onlyfans::Models::Analytics::FinancialGetForecastParams::Model)

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

required :model, enum: -> { Onlyfans::Analytics::FinancialGetForecastParams::Model }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/onlyfans/models/analytics/financial_get_forecast_params.rb', line 61