onlyfans 0.1.0 → 0.3.0

data/rbi/onlyfans/resources/shared_trial_links.rbi

@@ -17,19 +17,22 @@ module Onlyfans
           account: String,
           limit: Integer,
           offset: Integer,
-          synchronous: T.nilable(T::Boolean),
+          pagination:
+            Onlyfans::SharedTrialLinkListParams::Pagination::OrInteger,
+          synchronous: T::Boolean,
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::SharedTrialLinkListResponse)
       end
       def list(
         # The Account ID
         account,
-        # The number of shared trial links to return. Default `10`
+        # The number of shared trial links to return. Default `10`. Must be at least 1.
+        # Must not be greater than 100.
         limit: nil,
-        # The offset used for pagination. Default `0`
+        # The offset used for pagination. Default `0`. Must be at least 0.
         offset: nil,
-        # Wait for the database sync to finish, instead of running it in the background.
-        # **Will result in longer response times, use with caution**. Default `false`
+        pagination: nil,
+        # Wait for the database sync instead of processing it in the background.
         synchronous: nil,
         request_options: {}
       )

data/rbi/onlyfans/resources/smart_link_postbacks.rbi

@@ -11,6 +11,11 @@ module Onlyfans
           smart_link_scope:
             Onlyfans::SmartLinkPostbackCreateParams::SmartLinkScope::OrSymbol,
           url: String,
+          body: String,
+          headers:
+            T::Array[Onlyfans::SmartLinkPostbackCreateParams::Header::OrHash],
+          http_method:
+            Onlyfans::SmartLinkPostbackCreateParams::HTTPMethod::OrSymbol,
           smart_link_ids: T::Array[String],
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::SmartLinkPostbackCreateResponse)
@@ -21,9 +26,17 @@ module Onlyfans
         # `global` fires for all Smart Links. `campaign_specific` fires only for selected
         # Smart Links.
         smart_link_scope:,
-        # The destination URL. Variables such as `{click_id}`, `{fbclid}`, `{gclid}`, and
-        # `{ttclid}` are replaced when the postback is dispatched.
+        # The destination URL. Variables such as `{external_click_id}`, `{fbclid}`,
+        # `{gclid}`, `{gbraid}`, `{wbraid}`, `{ttclid}`, and `{sccid}` are replaced when
+        # the postback is dispatched.
         url:,
+        # Optional request body template for POST postbacks. Variables are replaced when
+        # the postback is dispatched.
+        body: nil,
+        # Optional request headers. Header values may include postback variables.
+        headers: nil,
+        # HTTP method used for the postback request. Defaults to `GET` when omitted.
+        http_method: nil,
         # Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
         smart_link_ids: nil,
         request_options: {}
@@ -52,6 +65,11 @@ module Onlyfans
           smart_link_scope:
             Onlyfans::SmartLinkPostbackUpdateParams::SmartLinkScope::OrSymbol,
           url: String,
+          body: String,
+          headers:
+            T::Array[Onlyfans::SmartLinkPostbackUpdateParams::Header::OrHash],
+          http_method:
+            Onlyfans::SmartLinkPostbackUpdateParams::HTTPMethod::OrSymbol,
           smart_link_ids: T::Array[String],
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::SmartLinkPostbackUpdateResponse)
@@ -65,6 +83,13 @@ module Onlyfans
         smart_link_scope:,
         # The destination URL.
         url:,
+        # Optional request body template for POST postbacks. Variables are replaced when
+        # the postback is dispatched.
+        body: nil,
+        # Optional request headers. Header values may include postback variables.
+        headers: nil,
+        # HTTP method used for the postback request. Existing value is kept when omitted.
+        http_method: nil,
         # Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
         smart_link_ids: nil,
         request_options: {}

data/rbi/onlyfans/resources/smart_links.rbi

@@ -48,25 +48,27 @@ module Onlyfans
       sig do
         params(
           account_ids: T.nilable(String),
+          filter: Onlyfans::SmartLinkListParams::Filter::OrHash,
           limit: Integer,
-          meta_pixel_ids: T.nilable(String),
           name: T.nilable(String),
           offset: Integer,
+          pixel_ids: T.nilable(String),
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::SmartLinkListResponse)
       end
       def list(
         # Comma-separated account prefixed IDs to include.
         account_ids: nil,
+        filter: nil,
         # The number of Smart Links to return. Default `50`. Must be at least 1. Must not
         # be greater than 1000.
         limit: nil,
-        # Comma-separated Meta Pixel IDs to include.
-        meta_pixel_ids: nil,
         # Filter Smart Links by name. Must not be greater than 255 characters.
         name: nil,
         # The offset used for pagination. Default `0`. Must be at least 0.
         offset: nil,
+        # Comma-separated ad platform Pixel IDs to include.
+        pixel_ids: nil,
         request_options: {}
       )
       end
@@ -168,7 +170,9 @@ module Onlyfans
           min_revenue_net: Float,
           min_tips_net: Float,
           offset: Integer,
+          previously_subscribed: T::Boolean,
           sort: Onlyfans::SmartLinkListFansParams::Sort::OrSymbol,
+          subscribed_using_promo: T::Boolean,
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::SmartLinkListFansResponse)
       end
@@ -187,8 +191,13 @@ module Onlyfans
         min_tips_net: nil,
         # Offset for pagination. Default `0`
         offset: nil,
+        # Optional - Filter to returning subscribers (fans previously subscribed before
+        # this subscription)
+        previously_subscribed: nil,
         # Optional sort field. Default `-revenue_net`
         sort: nil,
+        # Optional - Filter to fans who subscribed via a promotion/offer
+        subscribed_using_promo: nil,
         request_options: {}
       )
       end

data/rbi/onlyfans/resources/statistics/reach.rbi

@@ -29,7 +29,7 @@ module Onlyfans
           account,
           # The end date for the period.
           end_date:,
-          # The start date for the period
+          # The start date for the period.
           start_date:,
           # Optionally, filter the results by `chart` or `topCountries`. See example
           # responses.

data/rbi/onlyfans/resources/statistics/statements.rbi

@@ -8,8 +8,8 @@ module Onlyfans
         sig do
           params(
             account: String,
-            start_date: String,
             end_date: String,
+            start_date: String,
             type:
               Onlyfans::Statistics::StatementGetEarningsParams::Type::OrSymbol,
             request_options: Onlyfans::RequestOptions::OrHash
@@ -18,10 +18,10 @@ module Onlyfans
         def get_earnings(
           # The Account ID
           account,
-          # The start date for the period
-          start_date:,
           # The end date for the period.
-          end_date: nil,
+          end_date:,
+          # The start date for the period.
+          start_date:,
           # Filter by All / Subscriptions / Tips / Posts / Messages / Streams
           type: nil,
           request_options: {}

data/rbi/onlyfans/resources/statistics.rbi

@@ -22,9 +22,9 @@ module Onlyfans
         # The Account ID
         account,
         # The end date for the period. Keep empty to calculate everything.
-        end_date:,
+        end_date: nil,
         # The start date for the period. Keep empty to calculate everything.
-        start_date:,
+        start_date: nil,
         request_options: {}
       )
       end
@@ -62,6 +62,10 @@ module Onlyfans
           end_date: String,
           start_date: String,
           detailed: T.nilable(T::Boolean),
+          detailed_type:
+            T.nilable(
+              Onlyfans::StatisticGetSubscriberMetricsParams::DetailedType::OrSymbol
+            ),
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::StatisticGetSubscriberMetricsResponse)
       end
@@ -75,6 +79,9 @@ module Onlyfans
         # Include paid and free fan metrics. Will slow down the response time, and might
         # time out if timeframe is too large. Default = `false`
         detailed: nil,
+        # Use only with `detailed=true` - otherwise, it has no effect. Filter the
+        # subscriber statistics (default = total)
+        detailed_type: nil,
         request_options: {}
       )
       end

data/rbi/onlyfans/resources/stories.rbi

@@ -8,20 +8,33 @@ module Onlyfans
       sig { returns(Onlyfans::Resources::Stories::Highlights) }
       attr_reader :highlights
 
-      # Post a new media or vault file to your story.
+      # Post a new media or vault file to your story, optionally with text overlays,
+      # @mentions, and a question sticker. Overlay elements are rendered by OnlyFans on
+      # top of your story media at view time.
       sig do
         params(
           account: String,
           media_files: T::Array[String],
+          canvas_height: Integer,
+          canvas_width: Integer,
+          question: Onlyfans::StoryCreateParams::Question::OrHash,
+          texts: T::Array[Onlyfans::StoryCreateParams::Text::OrHash],
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::StoryCreateResponse)
       end
       def create(
         # The Account ID
         account,
-        # Array of media file upload prefixed_ids, or OF media IDs (required if price is
-        # not 0).
+        # Array of media file upload prefixed_ids, or OF vault media IDs.
         media_files:,
+        # Canvas height overlay positions are relative to. Default `1920`.
+        canvas_height: nil,
+        # Canvas width overlay positions are relative to. Default `1080`.
+        canvas_width: nil,
+        # Interactive question sticker viewers can answer.
+        question: nil,
+        # Text and @mention overlays.
+        texts: nil,
         request_options: {}
       )
       end

data/rbi/onlyfans/resources/tracking_links/tags.rbi

@@ -3,7 +3,11 @@
 module Onlyfans
   module Resources
     class TrackingLinks
-      # APIs for managing tracking links
+      # APIs for managing tracking links. Revenue totals are net earnings after refunds
+      # and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total` in stats)
+      # is the positive cached net amount already excluded from revenue; do not subtract
+      # it again. Spender responses include chargebacks across all attributed periods
+      # for each fan with positive net revenue.
       class Tags
         # Get tags for a specific tracking link. This is a free endpoint.
         sig do

data/rbi/onlyfans/resources/tracking_links.rbi

@@ -2,9 +2,17 @@
 
 module Onlyfans
   module Resources
-    # APIs for managing tracking links
+    # APIs for managing tracking links. Revenue totals are net earnings after refunds
+    # and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total` in stats)
+    # is the positive cached net amount already excluded from revenue; do not subtract
+    # it again. Spender responses include chargebacks across all attributed periods
+    # for each fan with positive net revenue.
     class TrackingLinks
-      # APIs for managing tracking links
+      # APIs for managing tracking links. Revenue totals are net earnings after refunds
+      # and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total` in stats)
+      # is the positive cached net amount already excluded from revenue; do not subtract
+      # it again. Spender responses include chargebacks across all attributed periods
+      # for each fan with positive net revenue.
       sig { returns(Onlyfans::Resources::TrackingLinks::Tags) }
       attr_reader :tags
 
@@ -50,37 +58,40 @@ module Onlyfans
         params(
           account: String,
           end_date: T.nilable(String),
-          limit: T.nilable(Integer),
-          offset: T.nilable(Integer),
-          sort: T.nilable(Onlyfans::TrackingLinkListParams::Sort::OrSymbol),
-          sortby: T.nilable(Onlyfans::TrackingLinkListParams::Sortby::OrSymbol),
+          limit: Integer,
+          offset: Integer,
+          pagination: Onlyfans::TrackingLinkListParams::Pagination::OrInteger,
+          sort: Onlyfans::TrackingLinkListParams::Sort::OrSymbol,
+          sortby: Onlyfans::TrackingLinkListParams::Sortby::OrSymbol,
           start_date: T.nilable(String),
-          synchronous: T.nilable(T::Boolean),
-          with_deleted: T.nilable(T::Boolean),
+          synchronous: T::Boolean,
+          with_deleted:
+            Onlyfans::TrackingLinkListParams::WithDeleted::OrInteger,
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::TrackingLinkListResponse)
       end
       def list(
         # The Account ID
         account,
-        # The end date for Tracking Links. Keep empty to get all.
+        # The end date for tracking links. Keep empty to get all. Must not be greater than
+        # 255 characters.
         end_date: nil,
-        # The number of tracking links to return. Default `3`
+        # The number of tracking links to return. Default `10`. Must be at least 1. Must
+        # not be greater than 100.
         limit: nil,
-        # The offset used for pagination. Default `0`
+        # The offset used for pagination. Default `0`. Must be at least 0.
         offset: nil,
-        # Sort the results. Default `desc`
+        pagination: nil,
+        # Sort direction. Default `desc`.
         sort: nil,
-        # Sort by subscriber count (claims), or creation date
+        # Sort by subscriber count (`claims`) or creation date (`created_date`).
         sortby: nil,
-        # The start date for Tracking Links. Keep empty to get all.
+        # The start date for tracking links. Keep empty to get all. Must not be greater
+        # than 255 characters.
         start_date: nil,
-        # Wait for the revenue data to finish processing, instead of processing in the
-        # background. **Will result in longer response times, use with caution**. Default
-        # `false`
+        # Wait for revenue calculation instead of processing it in the background.
         synchronous: nil,
-        # Whether or not to include deleted tracking links in the response. Default
-        # `false`
+        # Whether to include deleted tracking links. Default `true`.
         with_deleted: nil,
         request_options: {}
       )

data/rbi/onlyfans/resources/transactions.rbi

@@ -24,7 +24,7 @@ module Onlyfans
         limit: nil,
         # The marker used for pagination. Default: `null`
         marker: nil,
-        # The start date for transactions list. Default: `-30days`
+        # The start date for the transactions list. Defaults to 30 days ago.
         start_date: nil,
         # Filter tips by source. Only applies when `type=tips`. Options: `profile`,
         # `post_all`, `chat`, `stream`, `story`

data/rbi/onlyfans/resources/trial_links/tags.rbi

@@ -3,7 +3,11 @@
 module Onlyfans
   module Resources
     class TrialLinks
-      # APIs for managing Free Trial Links
+      # APIs for managing Free Trial Links. Revenue totals are net earnings after
+      # refunds and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total`
+      # in stats) is the positive cached net amount already excluded from revenue; do
+      # not subtract it again. Spender responses include chargebacks across all
+      # attributed periods for each fan with positive net revenue.
       class Tags
         # Get tags for a specific free trial link. This is a free endpoint.
         sig do

data/rbi/onlyfans/resources/trial_links.rbi

@@ -2,9 +2,17 @@
 
 module Onlyfans
   module Resources
-    # APIs for managing Free Trial Links
+    # APIs for managing Free Trial Links. Revenue totals are net earnings after
+    # refunds and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total`
+    # in stats) is the positive cached net amount already excluded from revenue; do
+    # not subtract it again. Spender responses include chargebacks across all
+    # attributed periods for each fan with positive net revenue.
     class TrialLinks
-      # APIs for managing Free Trial Links
+      # APIs for managing Free Trial Links. Revenue totals are net earnings after
+      # refunds and chargebacks. `revenue.chargebacks` (or `summary.chargebacks_total`
+      # in stats) is the positive cached net amount already excluded from revenue; do
+      # not subtract it again. Spender responses include chargebacks across all
+      # attributed periods for each fan with positive net revenue.
       sig { returns(Onlyfans::Resources::TrialLinks::Tags) }
       attr_reader :tags
 
@@ -61,28 +69,35 @@ module Onlyfans
       sig do
         params(
           account: String,
+          end_date: T.nilable(String),
+          field: Onlyfans::TrialLinkListParams::Field::OrSymbol,
           limit: Integer,
           offset: Integer,
-          field: T.nilable(Onlyfans::TrialLinkListParams::Field::OrSymbol),
-          sort: T.nilable(Onlyfans::TrialLinkListParams::Sort::OrSymbol),
-          synchronous: T.nilable(T::Boolean),
+          sort: Onlyfans::TrialLinkListParams::Sort::OrSymbol,
+          start_date: T.nilable(String),
+          synchronous: T::Boolean,
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::TrialLinkListResponse)
       end
       def list(
         # The Account ID
         account,
-        # The number of trial links to return. Default `10`
-        limit:,
-        # The offset used for pagination. Default `0`
-        offset:,
-        # Sort the results by a field. Default `create_date`
+        # The end date for trial links. Keep empty to get all. Must not be greater than
+        # 255 characters.
+        end_date: nil,
+        # Field to sort by. Default `create_date`.
         field: nil,
-        # Sort the results. Default `desc`
+        # The number of trial links to return. Default `10`. Must be at least 1. Must not
+        # be greater than 100.
+        limit: nil,
+        # The offset used for pagination. Default `0`. Must be at least 0.
+        offset: nil,
+        # Sort direction. Default `desc`.
         sort: nil,
-        # Wait for the revenue data to finish processing, instead of processing in the
-        # background. **Will result in longer response times, use with caution**. Default
-        # `false`
+        # The start date for trial links. Keep empty to get all. Must not be greater than
+        # 255 characters.
+        start_date: nil,
+        # Wait for revenue calculation instead of processing it in the background.
         synchronous: nil,
         request_options: {}
       )

data/rbi/onlyfans/resources/user_lists/users.rbi

@@ -33,8 +33,9 @@ module Onlyfans
             user_list_id: String,
             account: String,
             ids: T::Array[String],
+            skip_invalid: T::Boolean,
             request_options: Onlyfans::RequestOptions::OrHash
-          ).returns(Onlyfans::Models::UserLists::UserAddResponse)
+          ).returns(Onlyfans::Models::UserLists::UserAddResponse::Variants)
         end
         def add(
           # Path param: OnlyFans User List ID, or a default list name like `tagged`
@@ -43,6 +44,14 @@ module Onlyfans
           account:,
           # Body param: Array of OnlyFans User IDs to be added into the list
           ids:,
+          # Body param: Set to `true` to skip the User IDs OnlyFans refuses instead of
+          # failing the whole batch. We drop the rejected IDs and retry the remainder for
+          # you (up to 5 OnlyFans attempts, each costing 1 credit), then respond `200` with
+          # `data.added` (the IDs that made it in) and `data.failed` (an object mapping each
+          # rejected User ID to the reason OnlyFans gave). Note this changes the shape of
+          # `data` — see the example responses. Failures that are not about individual users
+          # (e.g. an invalid or inaccessible list ID) still return the regular `400`.
+          skip_invalid: nil,
           request_options: {}
         )
         end

data/rbi/onlyfans/resources/user_lists.rbi

@@ -64,12 +64,14 @@ module Onlyfans
       )
       end
 
-      # Get a list of OnlyFans Collections - User Lists
+      # Get a list of OnlyFans Collections - User Lists. If you only want to get User
+      # Lists available for sending a Mass-Message, use `?view=queue`
       sig do
         params(
           account: String,
           limit: T.nilable(Integer),
           offset: T.nilable(Integer),
+          view: Onlyfans::UserListListParams::View::OrSymbol,
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(Onlyfans::Models::UserListListResponse)
       end
@@ -81,6 +83,9 @@ module Onlyfans
         limit: nil,
         # Must be at least 0.
         offset: nil,
+        # How to return the results. `queue` returns the user lists that are available for
+        # Mass-Messaging.
+        view: nil,
         request_options: {}
       )
       end

data/rbi/onlyfans/resources/users.rbi

@@ -27,7 +27,8 @@ module Onlyfans
         ).returns(Onlyfans::Models::UserRetrieveResponse)
       end
       def retrieve(
-        # The OnlyFans username of the user to retrieve details for.
+        # The OnlyFans username or numeric user ID to retrieve details for. Display names
+        # and profile URLs are not accepted.
         username,
         # The Account ID
         account:,

data/rbi/onlyfans/resources/webhooks.rbi

@@ -15,16 +15,19 @@ module Onlyfans
         ).returns(Onlyfans::Models::WebhookCreateResponse)
       end
       def create(
-        # 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.
         account_scope:,
         # The URL of your webhook endpoint.
         endpoint_url:,
         # 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.
         events:,
-        # 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".
         account_ids: nil,
         # Optionally, add a signing secret to protect your webhook.
         signing_secret: nil,
@@ -61,16 +64,19 @@ module Onlyfans
       def update(
         # The ID of the webhook
         webhook_id,
-        # 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.
         account_scope:,
         # The URL of your webhook endpoint.
         endpoint_url:,
         # 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.
         events:,
-        # 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".
         account_ids: nil,
         # Optionally, enabled/disable the webhook. This will stop/resume the sending of
         # events, without having to delete the webhook.