Class: Onlyfans::Resources::ReleaseForms

Inherits:

Object

• Object
• Onlyfans::Resources::ReleaseForms

Defined in:

lib/onlyfans/resources/release_forms.rb,
sig/onlyfans/resources/release_forms.rbs

Overview

APIs for managing OnlyFans release forms

Instance Method Summary

• #create_invitation_link(account, name:, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormCreateInvitationLinkResponse

  Create a new invitation link for release forms.

• #create_release_form(account, name:, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormCreateReleaseFormResponse

  Create a new release form link.

• #initialize(client:) ⇒ ReleaseForms constructor private

  A new instance of ReleaseForms.

• #list_taggable_users(account, filter: nil, limit: nil, name: nil, offset: nil, sort: nil, sort_direction: nil, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormListTaggableUsersResponse

  Some parameter documentations has been truncated, see Models::ReleaseFormListTaggableUsersParams for more details.

Constructor Details

#initialize(client:) ⇒ ReleaseForms

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

Parameters:

• client (Onlyfans::Client)
• client: (Onlyfans::Client)

# File 'lib/onlyfans/resources/release_forms.rb', line 98

def initialize(client:)
  @client = client
end

Instance Method Details

#create_invitation_link(account, name:, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormCreateInvitationLinkResponse

Create a new invitation link for release forms.

Parameters:

• account (String) —

  The Account ID

• name (String) —

  The name of the invitation link.

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

Returns:

• (Onlyfans::Models::ReleaseFormCreateInvitationLinkResponse)

See Also:

• Models::ReleaseFormCreateInvitationLinkParams

# File 'lib/onlyfans/resources/release_forms.rb', line 20

def create_invitation_link(account, params)
  parsed, options = Onlyfans::ReleaseFormCreateInvitationLinkParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/%1$s/release-forms/create-invitation-link", account],
    body: parsed,
    model: Onlyfans::Models::ReleaseFormCreateInvitationLinkResponse,
    options: options
  )
end

#create_release_form(account, name:, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormCreateReleaseFormResponse

Create a new release form link.

Parameters:

• account (String) —

  The Account ID

• name (String) —

  The name of the release form.

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

Returns:

• (Onlyfans::Models::ReleaseFormCreateReleaseFormResponse)

See Also:

• Models::ReleaseFormCreateReleaseFormParams

# File 'lib/onlyfans/resources/release_forms.rb', line 44

def create_release_form(account, params)
  parsed, options = Onlyfans::ReleaseFormCreateReleaseFormParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/%1$s/release-forms/create-release-form", account],
    body: parsed,
    model: Onlyfans::Models::ReleaseFormCreateReleaseFormResponse,
    options: options
  )
end

#list_taggable_users(account, filter: nil, limit: nil, name: nil, offset: nil, sort: nil, sort_direction: nil, request_options: {}) ⇒ Onlyfans::Models::ReleaseFormListTaggableUsersResponse

Some parameter documentations has been truncated, see Models::ReleaseFormListTaggableUsersParams for more details.

Get a paginated list of users that can be tagged in release forms. These are verified creators who have signed release forms to appear in your content. Use offset and limit for pagination.

Parameters:

• account (String) —

  The Account ID

• filter (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Filter, nil) —

  Filter users by type: all or pending.

• limit (Integer) —

  Number of users to return per page (1-50). Must be at least 1. Must not be great

• name (String, nil) —

  Filter users by name or username.

• offset (Integer) —

  Number of users to skip for pagination. Must be at least 0.

• sort (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::Sort, nil) —

  Sort field: date or name.

• sort_direction (Symbol, Onlyfans::Models::ReleaseFormListTaggableUsersParams::SortDirection, nil) —

  Sort direction: desc or asc.

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

Returns:

• (Onlyfans::Models::ReleaseFormListTaggableUsersResponse)

See Also:

• Models::ReleaseFormListTaggableUsersParams

# File 'lib/onlyfans/resources/release_forms.rb', line 83

def list_taggable_users(account, params = {})
  parsed, options = Onlyfans::ReleaseFormListTaggableUsersParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/%1$s/release-forms/taggable-users", account],
    query: query.transform_keys(sort_direction: "sortDirection"),
    model: Onlyfans::Models::ReleaseFormListTaggableUsersResponse,
    options: options
  )
end