Class: Onlyfans::Resources::LinkTags

Inherits:

Object

• Object
• Onlyfans::Resources::LinkTags

Defined in:

lib/onlyfans/resources/link_tags.rb

Overview

APIs for managing tags on free trial links and tracking links

Instance Method Summary

• #initialize(client:) ⇒ LinkTags constructor private

  A new instance of LinkTags.

• #list(type: nil, request_options: {}) ⇒ Onlyfans::Models::LinkTagListResponse

  Get all existing tags that have been used on free trial links and/or tracking links for this account.

Constructor Details

#initialize(client:) ⇒ LinkTags

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

Parameters:

• client (Onlyfans::Client)

# File 'lib/onlyfans/resources/link_tags.rb', line 34

def initialize(client:)
  @client = client
end

Instance Method Details

#list(type: nil, request_options: {}) ⇒ Onlyfans::Models::LinkTagListResponse

Get all existing tags that have been used on free trial links and/or tracking links for this account. This is a free endpoint.

Parameters:

• type (Symbol, Onlyfans::Models::LinkTagListParams::Type) —

  Filter by link type. If not provided, returns tags for both types.

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

Returns:

• (Onlyfans::Models::LinkTagListResponse)

See Also:

• Models::LinkTagListParams

# File 'lib/onlyfans/resources/link_tags.rb', line 19

def list(params = {})
  parsed, options = Onlyfans::LinkTagListParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/link-tags",
    query: query,
    model: Onlyfans::Models::LinkTagListResponse,
    options: options
  )
end