Class: Onlyfans::Resources::Whoami

Inherits:

Object

• Object
• Onlyfans::Resources::Whoami

Defined in:

lib/onlyfans/resources/whoami.rb

Instance Method Summary

• #initialize(client:) ⇒ Whoami constructor private

  A new instance of Whoami.

• #retrieve(request_options: {}) ⇒ Onlyfans::Models::WhoamiRetrieveResponse

  Get details about the currently used API Key & the relevant Team.

Constructor Details

#initialize(client:) ⇒ Whoami

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

Parameters:

• client (Onlyfans::Client)

# File 'lib/onlyfans/resources/whoami.rb', line 27

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(request_options: {}) ⇒ Onlyfans::Models::WhoamiRetrieveResponse

Get details about the currently used API Key & the relevant Team

Parameters:

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

Returns:

• (Onlyfans::Models::WhoamiRetrieveResponse)

See Also:

• Models::WhoamiRetrieveParams

# File 'lib/onlyfans/resources/whoami.rb', line 15

def retrieve(params = {})
  @client.request(
    method: :get,
    path: "api/whoami",
    model: Onlyfans::Models::WhoamiRetrieveResponse,
    options: params[:request_options]
  )
end