Class: Onlyfans::Resources::Engagement::Messages

Inherits:
Object
  • Object
show all
Defined in:
lib/onlyfans/resources/engagement/messages.rb,
lib/onlyfans/resources/engagement/messages/mass_messages.rb,
lib/onlyfans/resources/engagement/messages/direct_messages.rb

Defined Under Namespace

Classes: DirectMessages, MassMessages

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Messages

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

Parameters:



85
86
87
88
89
 
# File 'lib/onlyfans/resources/engagement/messages.rb', line 85

def initialize(client:)
  @client = client
  @mass_messages = Onlyfans::Resources::Engagement::Messages::MassMessages.new(client: client)
  @direct_messages = Onlyfans::Resources::Engagement::Messages::DirectMessages.new(client: client)
end

Instance Attribute Details

#direct_messages ⇒ Onlyfans::Resources::Engagement::Messages::DirectMessages (readonly)

Returns:



11
12
13
 
# File 'lib/onlyfans/resources/engagement/messages.rb', line 11

def direct_messages
  @direct_messages
end

#mass_messages ⇒ Onlyfans::Resources::Engagement::Messages::MassMessages (readonly)

Returns:



8
9
10
 
# File 'lib/onlyfans/resources/engagement/messages.rb', line 8

def mass_messages
  @mass_messages
end

Instance Method Details

#get_message_buyers(message_id, account:, limit: nil, marker: nil, offset: nil, skip_users: nil, skip_users_dups: nil, request_options: {}) ⇒ Onlyfans::Models::Engagement::MessageGetMessageBuyersResponse

List buyers for a specific message.

Parameters:

  • message_id (String) —

    Path param: The ID of the message.

  • account (String) —

    Path param: The Account ID

  • limit (Integer) —

    Query param: Number of buyers to return (default = 10)

  • marker (Integer) —

    Query param: Marker for pagination

  • offset (Integer) —

    Query param: Offset for pagination (default = 0)

  • skip_users (String) —

    Query param: Optional flag for subsequent pages (example: all)

  • skip_users_dups (Integer) —

    Query param: Skip duplicate users in results (0/1). Default = 1

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

Returns:

See Also:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/onlyfans/resources/engagement/messages.rb', line 36

def get_message_buyers(message_id, params)
  parsed, options = Onlyfans::Engagement::MessageGetMessageBuyersParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
   =
    parsed.delete(:account) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/%1$s/engagement/messages/%2$s/buyers", , message_id],
    query: query,
    model: Onlyfans::Models::Engagement::MessageGetMessageBuyersResponse,
    options: options
  )
end

#get_top_message(account, end_date: nil, start_date: nil, request_options: {}) ⇒ Onlyfans::Models::Engagement::MessageGetTopMessageResponse

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

Get the top performing message by purchases in the selected timeframe.

Parameters:

  • account (String) —

    The Account ID

  • end_date (String) —

    The end date for the period. Keep empty to retrieve until now. MUST BE DATE AFTE

  • start_date (String) —

    The start date for the period. Keep empty to retrieve from the model start date.

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

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/onlyfans/resources/engagement/messages.rb', line 70

def get_top_message(, params = {})
  parsed, options = Onlyfans::Engagement::MessageGetTopMessageParams.dump_request(params)
  query = Onlyfans::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["api/%1$s/engagement/messages/top-message", ],
    query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
    model: Onlyfans::Models::Engagement::MessageGetTopMessageResponse,
    options: options
  )
end