Class: Onlyfans::Resources::Me

Inherits:

Object

• Object
• Onlyfans::Resources::Me

Defined in:

lib/onlyfans/resources/me.rb

Overview

Endpoints for your linked accounts

Instance Method Summary

• #get_model_start_date(account, request_options: {}) ⇒ Onlyfans::Models::MeGetModelStartDateResponse

  Get the start date of the model (the date+time monetization was enabled).

• #get_top_percentage(account, request_options: {}) ⇒ Onlyfans::Models::MeGetTopPercentageResponse

  Get the top percentage of the model (e.g., top 0.02% of all creators).

• #initialize(client:) ⇒ Me constructor private

  A new instance of Me.

• #retrieve(account, request_options: {}) ⇒ Onlyfans::Models::MeRetrieveResponse

  Get OnlyFans Profile details for the currently used Account.

Constructor Details

#initialize(client:) ⇒ Me

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 Me.

Parameters:

• client (Onlyfans::Client)

# File 'lib/onlyfans/resources/me.rb', line 70

def initialize(client:)
  @client = client
end

Instance Method Details

#get_model_start_date(account, request_options: {}) ⇒ Onlyfans::Models::MeGetModelStartDateResponse

Get the start date of the model (the date+time monetization was enabled)

Parameters:

• account (String) —

  The Account ID

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

Returns:

• (Onlyfans::Models::MeGetModelStartDateResponse)

See Also:

• Models::MeGetModelStartDateParams

# File 'lib/onlyfans/resources/me.rb', line 38

def get_model_start_date(account, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/me/model-start-date", account],
    model: Onlyfans::Models::MeGetModelStartDateResponse,
    options: params[:request_options]
  )
end

#get_top_percentage(account, request_options: {}) ⇒ Onlyfans::Models::MeGetTopPercentageResponse

Get the top percentage of the model (e.g., top 0.02% of all creators)

Parameters:

• account (String) —

  The Account ID

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

Returns:

• (Onlyfans::Models::MeGetTopPercentageResponse)

See Also:

• Models::MeGetTopPercentageParams

# File 'lib/onlyfans/resources/me.rb', line 58

def get_top_percentage(account, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/me/top-percentage", account],
    model: Onlyfans::Models::MeGetTopPercentageResponse,
    options: params[:request_options]
  )
end

#retrieve(account, request_options: {}) ⇒ Onlyfans::Models::MeRetrieveResponse

Get OnlyFans Profile details for the currently used Account

Parameters:

• account (String) —

  The Account ID

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

Returns:

• (Onlyfans::Models::MeRetrieveResponse)

See Also:

• Models::MeRetrieveParams

# File 'lib/onlyfans/resources/me.rb', line 18

def retrieve(account, params = {})
  @client.request(
    method: :get,
    path: ["api/%1$s/me", account],
    model: Onlyfans::Models::MeRetrieveResponse,
    options: params[:request_options]
  )
end