Class: Onlyfans::Resources::Analytics::Financial

Inherits:

Object

• Object
• Onlyfans::Resources::Analytics::Financial

Defined in:

lib/onlyfans/resources/analytics/financial.rb,
lib/onlyfans/resources/analytics/financial/transactions.rb,
lib/onlyfans/resources/analytics/financial/profitability.rb

Overview

APIs for retrieving financial analytics data

Defined Under Namespace

Classes: Profitability, Transactions

Instance Attribute Summary

• #profitability ⇒ Onlyfans::Resources::Analytics::Financial::Profitability readonly

  APIs for retrieving financial analytics data.

• #transactions ⇒ Onlyfans::Resources::Analytics::Financial::Transactions readonly

  APIs for retrieving financial analytics data.

Instance Method Summary

• #get_forecast(account_ids:, forecast_days:, historical_days:, metric:, model:, request_options: {}) ⇒ Onlyfans::Models::Analytics::FinancialGetForecastResponse

  Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).

• #initialize(client:) ⇒ Financial constructor private

  A new instance of Financial.

Constructor Details

#initialize(client:) ⇒ Financial

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Financial.

Parameters:

• client (Onlyfans::Client)

# File 'lib/onlyfans/resources/analytics/financial.rb', line 50

def initialize(client:)
  @client = client
  @transactions = Onlyfans::Resources::Analytics::Financial::Transactions.new(client: client)
  @profitability = Onlyfans::Resources::Analytics::Financial::Profitability.new(client: client)
end

Instance Attribute Details

#profitability ⇒ Onlyfans::Resources::Analytics::Financial::Profitability (readonly)

APIs for retrieving financial analytics data

Returns:

• (Onlyfans::Resources::Analytics::Financial::Profitability)

# File 'lib/onlyfans/resources/analytics/financial.rb', line 14

def profitability
  @profitability
end

#transactions ⇒ Onlyfans::Resources::Analytics::Financial::Transactions (readonly)

APIs for retrieving financial analytics data

Returns:

• (Onlyfans::Resources::Analytics::Financial::Transactions)

# File 'lib/onlyfans/resources/analytics/financial.rb', line 10

def transactions
  @transactions
end

Instance Method Details

#get_forecast(account_ids:, forecast_days:, historical_days:, metric:, model:, request_options: {}) ⇒ Onlyfans::Models::Analytics::FinancialGetForecastResponse

Generate revenue or churn forecasts using statistical models (Moving Average, Linear Regression, ARIMA, SARIMA).

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}, nil)

Returns:

• (Onlyfans::Models::Analytics::FinancialGetForecastResponse)

See Also:

• Models::Analytics::FinancialGetForecastParams

# File 'lib/onlyfans/resources/analytics/financial.rb', line 36

def get_forecast(params)
  parsed, options = Onlyfans::Analytics::FinancialGetForecastParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/analytics/financial/forecast",
    body: parsed,
    model: Onlyfans::Models::Analytics::FinancialGetForecastResponse,
    options: options
  )
end