Class: Onlyfans::Resources::Bundles

Inherits:

Object

• Object
• Onlyfans::Resources::Bundles

Defined in:

lib/onlyfans/resources/bundles.rb

Instance Method Summary

• #create(account, discount:, duration:, request_options: {}) ⇒ Onlyfans::Models::BundleCreateResponse

  Create a new bundle for the account.

• #delete(bundle_id, account:, request_options: {}) ⇒ Onlyfans::Models::BundleDeleteResponse

  Delete a bundle for the account.

• #initialize(client:) ⇒ Bundles constructor private

  A new instance of Bundles.

• #list(account, request_options: {}) ⇒ Onlyfans::Models::BundleListResponse

  List all bundles for the account.

Constructor Details

#initialize(client:) ⇒ Bundles

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

Parameters:

• client (Onlyfans::Client)

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

def initialize(client:)
  @client = client
end

Instance Method Details

#create(account, discount:, duration:, request_options: {}) ⇒ Onlyfans::Models::BundleCreateResponse

Create a new bundle for the account.

Parameters:

• account (String) —

  The Account ID

• discount (Integer, Onlyfans::Models::BundleCreateParams::Discount) —

  The bundle’s discount percentage.

• duration (Integer, Onlyfans::Models::BundleCreateParams::Duration) —

  The bundle’s duration in months.

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

Returns:

• (Onlyfans::Models::BundleCreateResponse)

See Also:

• Models::BundleCreateParams

# File 'lib/onlyfans/resources/bundles.rb', line 21

def create(account, params)
  parsed, options = Onlyfans::BundleCreateParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :post,
    path: ["api/%1$s/bundles", account],
    query: query,
    model: Onlyfans::Models::BundleCreateResponse,
    options: options
  )
end

#delete(bundle_id, account:, request_options: {}) ⇒ Onlyfans::Models::BundleDeleteResponse

Delete a bundle for the account.

Parameters:

• bundle_id (String) —

  The ID of the bundle to delete.

• account (String) —

  The Account ID

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

Returns:

• (Onlyfans::Models::BundleDeleteResponse)

See Also:

• Models::BundleDeleteParams

# File 'lib/onlyfans/resources/bundles.rb', line 66

def delete(bundle_id, params)
  parsed, options = Onlyfans::BundleDeleteParams.dump_request(params)
  account =
    parsed.delete(:account) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/%1$s/bundles/%2$s", account, bundle_id],
    model: Onlyfans::Models::BundleDeleteResponse,
    options: options
  )
end

#list(account, request_options: {}) ⇒ Onlyfans::Models::BundleListResponse

List all bundles for the account.

Parameters:

• account (String) —

  The Account ID

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

Returns:

• (Onlyfans::Models::BundleListResponse)

See Also:

• Models::BundleListParams

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

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