onlyfans 0.2.0 → 0.3.0

data/lib/onlyfans/models/webhook_create_params.rb

@@ -8,8 +8,9 @@ module Onlyfans
       include Onlyfans::Internal::Type::RequestParameters
 
       # @!attribute account_scope
-      #   The account scope for the webhook. Use "global" for all accounts, "inclusive"
-      #   for only selected accounts, or "exclusive" for all except selected accounts.
+      #   The account scope for the webhook (OnlyFans and Fansly webhooks alike). Use
+      #   "global" for all accounts, "inclusive" for only selected accounts, or
+      #   "exclusive" for all except selected accounts.
       #
       #   @return [String]
       required :account_scope, String
@@ -22,14 +23,16 @@ module Onlyfans
 
       # @!attribute events
       #   An array of webhook events to subscribe to. For all options, refer to our **List
-      #   Available Events** endpoint.
+      #   Available Events** endpoint. A webhook is single-platform: subscribe to either
+      #   OnlyFans events or Fansly (`fansly.*`) events, never both in one webhook.
       #
       #   @return [Array<String>]
       required :events, Onlyfans::Internal::Type::ArrayOf[String]
 
       # @!attribute account_ids
-      #   An array of account IDs to apply the scope to. Required unless account_scope is
-      #   "global".
+      #   An array of account IDs to apply the scope to. Use OnlyFans account IDs
+      #   (`acct_...`) for OnlyFans webhooks and Fansly account IDs (`fansly_acct_...`)
+      #   for Fansly webhooks. Required unless account_scope is "global".
       #
       #   @return [Array<String>, nil]
       optional :account_ids, Onlyfans::Internal::Type::ArrayOf[String]
@@ -44,14 +47,15 @@ module Onlyfans
       #   Some parameter documentations has been truncated, see
       #   {Onlyfans::Models::WebhookCreateParams} for more details.
       #
-      #   @param account_scope [String] The account scope for the webhook. Use "global" for all accounts, "inclusive" fo
+      #   @param account_scope [String] The account scope for the webhook (OnlyFans and Fansly webhooks alike). Use "glo
       #
       #   @param endpoint_url [String] The URL of your webhook endpoint.
       #
       #   @param events [Array<String>] An array of webhook events to subscribe to. For all options, refer to our
       #   \*\*List
       #
-      #   @param account_ids [Array<String>] An array of account IDs to apply the scope to. Required unless account_scope is
+      #   @param account_ids [Array<String>] An array of account IDs to apply the scope to. Use OnlyFans account IDs
+      #   (`acct\_.
       #
       #   @param signing_secret [String, nil] Optionally, add a signing secret to protect your webhook.
       #

data/lib/onlyfans/models/webhook_update_params.rb

@@ -13,8 +13,9 @@ module Onlyfans
       required :webhook_id, String
 
       # @!attribute account_scope
-      #   The account scope for the webhook. Use "global" for all accounts, "inclusive"
-      #   for only selected accounts, or "exclusive" for all except selected accounts.
+      #   The account scope for the webhook (OnlyFans and Fansly webhooks alike). Use
+      #   "global" for all accounts, "inclusive" for only selected accounts, or
+      #   "exclusive" for all except selected accounts.
       #
       #   @return [String]
       required :account_scope, String
@@ -27,14 +28,16 @@ module Onlyfans
 
       # @!attribute events
       #   An array of webhook events to subscribe to. For all options, refer to our **List
-      #   Available Events** endpoint.
+      #   Available Events** endpoint. A webhook is single-platform: subscribe to either
+      #   OnlyFans events or Fansly (`fansly.*`) events, never both in one webhook.
       #
       #   @return [Array<String>]
       required :events, Onlyfans::Internal::Type::ArrayOf[String]
 
       # @!attribute account_ids
-      #   An array of account IDs to apply the scope to. Required unless account_scope is
-      #   "global".
+      #   An array of account IDs to apply the scope to. Use OnlyFans account IDs
+      #   (`acct_...`) for OnlyFans webhooks and Fansly account IDs (`fansly_acct_...`)
+      #   for Fansly webhooks. Required unless account_scope is "global".
       #
       #   @return [Array<String>, nil]
       optional :account_ids, Onlyfans::Internal::Type::ArrayOf[String]
@@ -52,14 +55,15 @@ module Onlyfans
       #
       #   @param webhook_id [String]
       #
-      #   @param account_scope [String] The account scope for the webhook. Use "global" for all accounts, "inclusive" fo
+      #   @param account_scope [String] The account scope for the webhook (OnlyFans and Fansly webhooks alike). Use "glo
       #
       #   @param endpoint_url [String] The URL of your webhook endpoint.
       #
       #   @param events [Array<String>] An array of webhook events to subscribe to. For all options, refer to our
       #   \*\*List
       #
-      #   @param account_ids [Array<String>] An array of account IDs to apply the scope to. Required unless account_scope is
+      #   @param account_ids [Array<String>] An array of account IDs to apply the scope to. Use OnlyFans account IDs
+      #   (`acct\_.
       #
       #   @param enabled [Boolean, nil] Optionally, enabled/disable the webhook. This will stop/resume the sending of ev
       #

data/lib/onlyfans/models.rb

@@ -163,8 +163,6 @@ module Onlyfans
 
   MeRetrieveParams = Onlyfans::Models::MeRetrieveParams
 
-  MessageAttachTagsParams = Onlyfans::Models::MessageAttachTagsParams
-
   NotificationGetCountsParams = Onlyfans::Models::NotificationGetCountsParams
 
   NotificationListParams = Onlyfans::Models::NotificationListParams

data/lib/onlyfans/resources/analytics/financial/profitability.rb

@@ -22,7 +22,7 @@ module Onlyfans
           #
           # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Array<Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponseItem>]
+          # @return [Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse]
           #
           # @see Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryParams
           def get_history(account, params)
@@ -32,7 +32,7 @@ module Onlyfans
               method: :get,
               path: ["api/analytics/financial/profitability/%1$s/history", account],
               query: query,
-              model: Onlyfans::Internal::Type::ArrayOf[Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponseItem],
+              model: Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse,
               options: options
             )
           end
@@ -50,7 +50,7 @@ module Onlyfans
           #
           # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          # @return [Array<Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponseItem>]
+          # @return [Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse]
           #
           # @see Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityParams
           def get_profitability(params)
@@ -60,7 +60,7 @@ module Onlyfans
               method: :post,
               path: "api/analytics/financial/profitability",
               body: parsed,
-              model: Onlyfans::Internal::Type::ArrayOf[Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponseItem],
+              model: Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse,
               options: options
             )
           end

data/lib/onlyfans/resources/chats/messages.rb

@@ -41,7 +41,10 @@ module Onlyfans
         # Some parameter documentations has been truncated, see
         # {Onlyfans::Models::Chats::MessageListParams} for more details.
         #
-        # Get messages from a specific chat.
+        # Get messages from a specific chat. Use `filter=pinned` or
+        # [List Pinned Chat Messages](https://docs.onlyfansapi.com/api-reference/chat-messages/list-pinned-chat-messages)
+        # to retrieve only pinned messages. Follow `_pagination.next_page` until it is
+        # null; a short page can still have more results.
         #
         # @overload list(chat_id, account:, filter: nil, first_id: nil, last_id: nil, limit: nil, order: nil, skip_users: nil, request_options: {})
         #
@@ -51,7 +54,7 @@ module Onlyfans
         #
         # @param filter [Symbol, Onlyfans::Models::Chats::MessageListParams::Filter] Query param: Filter by certain messages. Currently, only pins are filterable.
         #
-        # @param first_id [String, nil] Query param: Use for pagination when `order=desc` (newest to oldest). Include th
+        # @param first_id [String, nil] Query param: Use for pagination when `order=desc` (newest to oldest). Pass the l
         #
         # @param last_id [String, nil] Query param: Use for pagination when `order=asc` (oldest to newest). Include thi
         #
@@ -59,7 +62,7 @@ module Onlyfans
         #
         # @param order [String] Query param: Sort order for messages (desc or asc)
         #
-        # @param skip_users [String] Query param: Whether to skip user details (all or none)
+        # @param skip_users [String] Query param: Whether to skip user details (`all` or `none`).
         #
         # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -149,7 +152,10 @@ module Onlyfans
           )
         end
 
-        # Pin a message from a chat.
+        # Pin a message from a chat. Requires API-key write permission. No request body is
+        # needed. Use
+        # [List Pinned Chat Messages](https://docs.onlyfansapi.com/api-reference/chat-messages/list-pinned-chat-messages)
+        # to read the current pins.
         #
         # @overload pin(message_id, account:, chat_id:, request_options: {})
         #
@@ -219,12 +225,38 @@ module Onlyfans
         #
         # Send a new message to a chat.
         #
-        # @overload send_(chat_id, account:, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, reply_to_message_id: nil, rf_guest: nil, rf_partner: nil, rf_tag: nil, text: nil, request_options: {})
+        # **Idempotency.** Pass an `Idempotency-Key` header to make retries safe. The
+        # first request with a given key is executed normally and its response is stored
+        # for **24 hours**; any later request with the same key returns that stored
+        # response, plus an `Idempotent-Replayed: true` header, without contacting
+        # OnlyFans and without consuming credits. The replayed body is the original
+        # response with its `_meta._credits` block rewritten to show `used: 0` and your
+        # current balance.
+        #
+        # Keys are scoped to your team, this endpoint and the account in the URL, so the
+        # same value can be reused safely against a different account. Use a fresh, unique
+        # value (a UUID works well) for each message you send; it must be 1-255 printable
+        # ASCII characters.
+        #
+        # - `400 IDEMPOTENCY_KEY_INVALID` — the header value is empty, too long, or
+        #   contains non-ASCII characters.
+        # - `409 IDEMPOTENCY_CONFLICT` — an earlier request with this key is still
+        #   running. Retry once it finishes.
+        # - `422 IDEMPOTENCY_KEY_MISMATCH` — this key was already used with a different
+        #   request body or chat.
+        #
+        # Responses with a `5xx` status (and `408`/`429`) are never stored, so a failed
+        # send can be retried with the same key. The header is optional: omit it and the
+        # endpoint behaves exactly as before.
+        #
+        # @overload send_(chat_id, account:, block_banned_words: nil, giphy_id: nil, locked_text: nil, media_files: nil, previews: nil, price: nil, reply_to_message_id: nil, rf_guest: nil, rf_partner: nil, rf_tag: nil, text: nil, idempotency_key: nil, request_options: {})
         #
         # @param chat_id [String] Path param: The ID of the chat (usually a fan's OnlyFans User ID)
         #
         # @param account [String] Path param: The Account ID
         #
+        # @param block_banned_words [Symbol, Onlyfans::Models::Chats::MessageSendParams::BlockBannedWords] Body param: Screen `text` for OnlyFans banned words and block the send if any ar
+        #
         # @param giphy_id [String] Body param: The ID of the Giphy GIF to attach to the message. Get IDs from the G
         #
         # @param locked_text [Boolean] Body param: Whether the text should be shown or hidden
@@ -233,7 +265,7 @@ module Onlyfans
         #
         # @param previews [Array<Object>] Body param: Direct file uploads, OFAPI `ofapi_media_` IDs, OF vault IDs, or inte
         #
-        # @param price [Integer] Body param: Price for paid content (0 or between 3-200). In case this is not zer
+        # @param price [Float] Body param: Price for paid content in USD (0 or between 3-200). In case this is
         #
         # @param reply_to_message_id [Integer] Body param: Mark this message as a reply to another (can be either your own, or
         #
@@ -245,6 +277,8 @@ module Onlyfans
         #
         # @param text [String] Body param: The message text content. Required unless a media file is present.
         #
+        # @param idempotency_key [String] Header param
+        #
         # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Onlyfans::Models::Chats::MessageSendResponse]
@@ -256,10 +290,12 @@ module Onlyfans
             parsed.delete(:account) do
               raise ArgumentError.new("missing required path argument #{_1}")
             end
+          header_params = {idempotency_key: "idempotency-key"}
           @client.request(
             method: :post,
             path: ["api/%1$s/chats/%2$s/messages", account, chat_id],
-            body: parsed,
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
             model: Onlyfans::Models::Chats::MessageSendResponse,
             options: options
           )
@@ -298,7 +334,10 @@ module Onlyfans
           )
         end
 
-        # Unpin a message from a chat.
+        # Unpin a message from a chat. Requires API-key delete permission; a read_write
+        # key cannot unpin. No request body is needed. Use
+        # [List Pinned Chat Messages](https://docs.onlyfansapi.com/api-reference/chat-messages/list-pinned-chat-messages)
+        # to read the current pins.
         #
         # @overload unpin(message_id, account:, chat_id:, request_options: {})
         #

data/lib/onlyfans/resources/chats.rb

@@ -9,6 +9,9 @@ module Onlyfans
       # @return [Onlyfans::Resources::Chats::MarkAllAsRead]
       attr_reader :mark_all_as_read
 
+      # Some parameter documentations has been truncated, see
+      # {Onlyfans::Models::ChatListParams} for more details.
+      #
       # Get the list of chats for an Account.
       #
       # @overload list(account, filter: nil, limit: nil, offset: nil, order: nil, query: nil, skip_users: nil, request_options: {})
@@ -25,7 +28,7 @@ module Onlyfans
       #
       # @param query [String] Search query to filter chats
       #
-      # @param skip_users [Symbol, Onlyfans::Models::ChatListParams::SkipUsers] Whether to skip user details in response (all or none). Default = all
+      # @param skip_users [Symbol, Onlyfans::Models::ChatListParams::SkipUsers] Whether to skip user details in the response (`all` or `none`). Defaults to `all
       #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -114,7 +117,7 @@ module Onlyfans
       #
       # @param offset [String] Query param: Number of medias to skip for pagination
       #
-      # @param skip_users [String] Query param: Whether to skip user details in response (all or none). Default = a
+      # @param skip_users [String] Query param: Whether to skip user details in the response (`all` or `none`). Def
       #
       # @param type [Symbol, Onlyfans::Models::ChatListMediaParams::Type, nil] Query param: Filter by specific media types. Keep empty to return all.
       #
@@ -222,8 +225,8 @@ module Onlyfans
       end
 
       # Calling this endpoint will show the target fan a "Model is typing..." note in
-      # the chat for ~4 seconds. If you want to continue showing the indicator call this
-      # endpoint multiple times. Free - no credits charged.
+      # the chat for ~4 seconds. Duplicate calls for the same account and chat are
+      # coalesced during that window.
       #
       # @overload start_typing(chat_id, account:, request_options: {})
       #

data/lib/onlyfans/resources/data_exports.rb

@@ -18,7 +18,7 @@ module Onlyfans
       #
       # @param start_date [String] The start date for the export (ISO 8601 format).
       #
-      # @param type [Symbol, Onlyfans::Models::DataExportCreateParams::Type] The type of data to export
+      # @param type [Symbol, Onlyfans::Models::DataExportCreateParams::Type] The type of data to export. Use `fansly_chat_messages` to export Fansly chat mes
       #
       # @param account_ids [Array<String>] Array of account prefixed IDs to export data from. Not required for `public_prof
       #

data/lib/onlyfans/resources/engagement/messages/direct_messages.rb

@@ -15,7 +15,7 @@ module Onlyfans
           #
           # @param account [String] The Account ID
           #
-          # @param end_date [String] The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `start
+          # @param end_date [String] The latest message to retrieve. Keep empty to get all. It must be after `startDa
           #
           # @param limit [Integer] Number of messages to return (default = 10)
           #
@@ -49,7 +49,7 @@ module Onlyfans
           #
           # @param account [String] The Account ID
           #
-          # @param end_date [String] End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.
+          # @param end_date [String] End of the chart window in `Y-m-d H:i:s` format. It must be after `startDate`.
           #
           # @param start_date [String] Start of the chart window in `Y-m-d H:i:s` format.
           #

data/lib/onlyfans/resources/engagement/messages/mass_messages.rb

@@ -15,7 +15,7 @@ module Onlyfans
           #
           # @param account [String] The Account ID
           #
-          # @param end_date [String] The latest message to retrieve. Keep empty to get all. MUST BE DATE AFTER `start
+          # @param end_date [String] The latest message to retrieve. Keep empty to get all. It must be after `startDa
           #
           # @param limit [Integer] Number of messages to return (default = 10)
           #
@@ -47,7 +47,7 @@ module Onlyfans
           #
           # @param account [String] The Account ID
           #
-          # @param end_date [String] End of the chart window in `Y-m-d H:i:s` format. Must be after `startDate`.
+          # @param end_date [String] End of the chart window in `Y-m-d H:i:s` format. It must be after `startDate`.
           #
           # @param start_date [String] Start of the chart window in `Y-m-d H:i:s` format.
           #

data/lib/onlyfans/resources/engagement/messages.rb

@@ -24,7 +24,7 @@ module Onlyfans
         #
         # @param offset [Integer] Query param: Offset for pagination (default = 0)
         #
-        # @param skip_users [String] Query param: Optional flag for subsequent pages (example: all)
+        # @param skip_users [String] Query param: Optional flag for subsequent pages (example: all).
         #
         # @param skip_users_dups [Integer] Query param: Skip duplicate users in results (0/1). Default = 1
         #
@@ -58,7 +58,7 @@ module Onlyfans
         #
         # @param account [String] The Account ID
         #
-        # @param end_date [String] The end date for the period. Keep empty to retrieve until now. MUST BE DATE AFTE
+        # @param end_date [String] The end date for the period. Keep empty to retrieve until now. It must be after
         #
         # @param start_date [String] The start date for the period. Keep empty to retrieve from the model start date.
         #

data/lib/onlyfans/resources/fans.rb

@@ -43,7 +43,19 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::FanListActiveParams} for more details.
       #
-      # Get a paginated list of fans for an Account. Newest fans are first.
+      # Get a paginated list of fans for an Account. Newest fans are first. Paginate by
+      # following `_pagination.next_page` until it is null (`data.hasMore` is the
+      # authoritative flag). Do NOT use the page's item count to detect the last page —
+      # OnlyFans occasionally returns fewer than `limit` items (e.g. 19 for limit=20) on
+      # a non-final page because it filters entries server-side; no fans are skipped. To
+      # track progress, GET `/{account}/me` returns data.subscribersCount (the current
+      # active-subscriber count) as a total.
+      #
+      # Supports `filter[max_total_spent]` (e.g. `filter[max_total_spent]=0` for fans
+      # who have never spent), which OnlyFans itself cannot do. Those requests are
+      # answered from OnlyFansAPI's own fan index rather than proxied, so the page is
+      # limited to fans we have already indexed for this account — see `data._source` in
+      # the response.
       #
       # @overload list_active(account, filter: nil, limit: nil, offset: nil, query: nil, type: nil, request_options: {})
       #
@@ -51,7 +63,7 @@ module Onlyfans
       #
       # @param filter [Onlyfans::Models::FanListActiveParams::Filter]
       #
-      # @param limit [Integer] Number of fans to return (1-50). Must be at least 1. Must not be greater than 20
+      # @param limit [Integer] Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
       #
       # @param offset [Integer] Number of fans to skip. Must be at least 0.
       #
@@ -79,7 +91,17 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::FanListAllParams} for more details.
       #
-      # Get a paginated list of fans for an Account. Newest fans are first.
+      # Get a paginated list of fans for an Account. Newest fans are first. Paginate by
+      # following `_pagination.next_page` until it is null (`data.hasMore` is the
+      # authoritative flag). Do NOT use the page's item count to detect the last page —
+      # OnlyFans occasionally returns fewer than `limit` items (e.g. 19 for limit=20) on
+      # a non-final page because it filters entries server-side; no fans are skipped.
+      #
+      # Supports `filter[max_total_spent]` (e.g. `filter[max_total_spent]=0` for fans
+      # who have never spent), which OnlyFans itself cannot do. Those requests are
+      # answered from OnlyFansAPI's own fan index rather than proxied, so the page is
+      # limited to fans we have already indexed for this account — see `data._source` in
+      # the response.
       #
       # @overload list_all(account, filter: nil, limit: nil, offset: nil, query: nil, type: nil, request_options: {})
       #
@@ -87,7 +109,7 @@ module Onlyfans
       #
       # @param filter [Onlyfans::Models::FanListAllParams::Filter]
       #
-      # @param limit [Integer] Number of fans to return (1-50). Must be at least 1. Must not be greater than 20
+      # @param limit [Integer] Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
       #
       # @param offset [Integer] Number of fans to skip. Must be at least 0.
       #
@@ -116,6 +138,17 @@ module Onlyfans
       # {Onlyfans::Models::FanListExpiredParams} for more details.
       #
       # Get a paginated list of expired fans for an Account. Newest fans are first.
+      # Paginate by following `_pagination.next_page` until it is null (`data.hasMore`
+      # is the authoritative flag). Do NOT use the page's item count to detect the last
+      # page — OnlyFans occasionally returns fewer than `limit` items (e.g. 19 for
+      # limit=20) on a non-final page because it filters entries server-side; no fans
+      # are skipped.
+      #
+      # Supports `filter[max_total_spent]` (e.g. `filter[max_total_spent]=0` for fans
+      # who have never spent), which OnlyFans itself cannot do. Those requests are
+      # answered from OnlyFansAPI's own fan index rather than proxied, so the page is
+      # limited to fans we have already indexed for this account — see `data._source` in
+      # the response.
       #
       # @overload list_expired(account, filter: nil, limit: nil, offset: nil, query: nil, type: nil, request_options: {})
       #
@@ -123,7 +156,7 @@ module Onlyfans
       #
       # @param filter [Onlyfans::Models::FanListExpiredParams::Filter]
       #
-      # @param limit [Integer] Number of fans to return (1-50). Must be at least 1. Must not be greater than 20
+      # @param limit [Integer] Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
       #
       # @param offset [Integer] Number of fans to skip. Must be at least 0.
       #
@@ -158,13 +191,13 @@ module Onlyfans
       #
       # @param account [String] The Account ID
       #
-      # @param end_date [String, nil] End date for filtering (required with start_date). This field is required when <
+      # @param end_date [String, nil] End date for filtering (required with start_date). Must be a valid date. Must no
       #
-      # @param limit [Integer] Number of fans to return (1-50). Must be at least 1. Must not be greater than 10
+      # @param limit [Integer] Number of fans to return (1-50). Must be at least 1. Must not be greater than 50
       #
       # @param offset [Integer] Number of fans to skip. Must be at least 0.
       #
-      # @param start_date [String, nil] Start date for filtering (required with end_date). This field is required when <
+      # @param start_date [String, nil] Start date for filtering (required with end_date). Must be a valid date. Must no
       #
       # @param type [Symbol, Onlyfans::Models::FanListLatestParams::Type, nil] Filter by type: total, renew, or new.
       #
@@ -197,9 +230,9 @@ module Onlyfans
       #
       # @param by [Symbol, Onlyfans::Models::FanListTopParams::By, nil] Sort by: total (default), subscribes, tips, messages, post, streams.
       #
-      # @param end_date [String, nil] End date for filtering (required with start_date). This field is required when <
+      # @param end_date [String, nil] End date for filtering (required with start_date). Must be a valid date. Must no
       #
-      # @param start_date [String, nil] Start date for filtering (required with end_date). This field is required when <
+      # @param start_date [String, nil] Start date for filtering (required with end_date). Must be a valid date. Must no
       #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/onlyfans/resources/following.rb

@@ -7,9 +7,18 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::FollowingListActiveParams} for more details.
       #
-      # Get a paginated list of followings for an Account. Newest followings are first.
-      #
-      # @overload list_active(account, filter: nil, limit: nil, offset: nil, query: nil, request_options: {})
+      # Get a paginated list of followings for an Account. By default OnlyFans returns
+      # this list newest-first, sorted by `subscribedByData.subscribeAt` descending. The
+      # expired list does not share this order, so do not assume it applies there. Pass
+      # `sort` (optionally with `sortDirection`) to reorder the list — see the parameter
+      # description for the caveat that OnlyFans persists the chosen order account-wide.
+      # An empty page is not the end of the list: OnlyFans applies `offset` to the whole
+      # following collection before filtering it down to the requested list, so a page
+      # can come back empty while more results follow. Keep following
+      # `_pagination.next_page` until it is `null` instead of stopping at the first
+      # empty page.
+      #
+      # @overload list_active(account, filter: nil, limit: nil, offset: nil, query: nil, sort: nil, sort_direction: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
@@ -21,6 +30,10 @@ module Onlyfans
       #
       # @param query [String, nil] Search within following name/username.
       #
+      # @param sort [Symbol, Onlyfans::Models::FollowingListActiveParams::Sort, nil] Order the list by `last_activity` (the followed creator's last activity), `expir
+      #
+      # @param sort_direction [Symbol, Onlyfans::Models::FollowingListActiveParams::SortDirection, nil] Direction for `sort`: `desc` (default) or `asc`. Requires `sort` to be set. Exce
+      #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Onlyfans::Models::FollowingListActiveResponse]
@@ -32,7 +45,7 @@ module Onlyfans
         @client.request(
           method: :get,
           path: ["api/%1$s/following/active", account],
-          query: query,
+          query: query.transform_keys(sort_direction: "sortDirection"),
           model: Onlyfans::Models::FollowingListActiveResponse,
           options: options
         )
@@ -41,9 +54,18 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::FollowingListAllParams} for more details.
       #
-      # Get a paginated list of followings for an Account. Newest followings are first.
+      # Get a paginated list of followings for an Account. By default OnlyFans returns
+      # this list newest-first, sorted by `subscribedByData.subscribeAt` descending. The
+      # expired list does not share this order, so do not assume it applies there. Pass
+      # `sort` (optionally with `sortDirection`) to reorder the list — see the parameter
+      # description for the caveat that OnlyFans persists the chosen order account-wide.
+      # An empty page is not the end of the list: OnlyFans applies `offset` to the whole
+      # following collection before filtering it down to the requested list, so a page
+      # can come back empty while more results follow. Keep following
+      # `_pagination.next_page` until it is `null` instead of stopping at the first
+      # empty page.
       #
-      # @overload list_all(account, filter: nil, limit: nil, offset: nil, query: nil, request_options: {})
+      # @overload list_all(account, filter: nil, limit: nil, offset: nil, query: nil, sort: nil, sort_direction: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
@@ -55,6 +77,10 @@ module Onlyfans
       #
       # @param query [String, nil] Search within following name/username.
       #
+      # @param sort [Symbol, Onlyfans::Models::FollowingListAllParams::Sort, nil] Order the list by `last_activity` (the followed creator's last activity), `expir
+      #
+      # @param sort_direction [Symbol, Onlyfans::Models::FollowingListAllParams::SortDirection, nil] Direction for `sort`: `desc` (default) or `asc`. Requires `sort` to be set. Exce
+      #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Onlyfans::Models::FollowingListAllResponse]
@@ -66,7 +92,7 @@ module Onlyfans
         @client.request(
           method: :get,
           path: ["api/%1$s/following/all", account],
-          query: query,
+          query: query.transform_keys(sort_direction: "sortDirection"),
           model: Onlyfans::Models::FollowingListAllResponse,
           options: options
         )
@@ -75,10 +101,26 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::FollowingListExpiredParams} for more details.
       #
-      # Get a paginated list of expired followings for an Account. Newest followings are
-      # first.
-      #
-      # @overload list_expired(account, filter: nil, limit: nil, offset: nil, query: nil, request_options: {})
+      # Get a paginated list of expired followings for an Account. This list has no
+      # order guarantee. Unlike the all and active lists, it is sorted by neither
+      # `subscribedByData.subscribeAt` nor `subscribedByData.expiredAt`. To poll for new
+      # expirations, page through the full list each cycle (`limit=50`, follow
+      # `_pagination.next_page` until it is null) and diff it against your own store
+      # using `subscribedByData.expiredAt`. Do NOT stop early at the first entry you
+      # have already seen, as that can silently skip real expirations. An empty page is
+      # not the end of the list either: OnlyFans applies `offset` to the whole following
+      # collection and only then filters that window down to expired subscriptions, so
+      # early pages can come back empty while hundreds of expired rows still follow.
+      # Keep following `_pagination.next_page` until it is `null` instead of stopping at
+      # the first empty page. Pass `sort=expire_date` (optionally with `sortDirection`)
+      # to get a deterministic order instead — see the parameter description for the
+      # caveat that OnlyFans persists the chosen order account-wide. Ordering by expiry
+      # descending puts the still-active subscriptions first and moves the expired rows
+      # to the tail of the collection, so prefer `sortDirection=asc` or
+      # `sort=is_expired` for expired-first results; for that reason `sort=expire_date`
+      # defaults to `asc` on this list when no `sortDirection` is given.
+      #
+      # @overload list_expired(account, filter: nil, limit: nil, offset: nil, query: nil, sort: nil, sort_direction: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
@@ -90,6 +132,10 @@ module Onlyfans
       #
       # @param query [String, nil] Search within following name/username.
       #
+      # @param sort [Symbol, Onlyfans::Models::FollowingListExpiredParams::Sort, nil] Order the list by `last_activity` (the followed creator's last activity), `expir
+      #
+      # @param sort_direction [Symbol, Onlyfans::Models::FollowingListExpiredParams::SortDirection, nil] Direction for `sort`: `desc` (default) or `asc`. Requires `sort` to be set. Exce
+      #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Onlyfans::Models::FollowingListExpiredResponse]
@@ -101,7 +147,7 @@ module Onlyfans
         @client.request(
           method: :get,
           path: ["api/%1$s/following/expired", account],
-          query: query,
+          query: query.transform_keys(sort_direction: "sortDirection"),
           model: Onlyfans::Models::FollowingListExpiredResponse,
           options: options
         )

data/lib/onlyfans/resources/link_tags.rb

@@ -2,14 +2,14 @@
 
 module Onlyfans
   module Resources
-    # APIs for managing tags on free trial links and tracking links
+    # APIs for managing tags on free trial links, tracking links, and Smart Links
     class LinkTags
-      # Get all existing tags that have been used on free trial links and/or tracking
-      # links for this account. This is a free endpoint.
+      # Get all existing tags that have been used on free trial links, tracking links,
+      # and/or Smart Links for this account. This is a free endpoint.
       #
       # @overload list(type: nil, request_options: {})
       #
-      # @param type [Symbol, Onlyfans::Models::LinkTagListParams::Type] Filter by link type. If not provided, returns tags for both types.
+      # @param type [Symbol, Onlyfans::Models::LinkTagListParams::Type] Filter by link type. If not provided, returns tags for all types.
       #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #