onlyfans 0.1.0 → 0.3.0

data/rbi/onlyfans/models/fan_list_all_params.rbi

@@ -20,8 +20,8 @@ module Onlyfans
       sig { params(filter: Onlyfans::FanListAllParams::Filter::OrHash).void }
       attr_writer :filter
 
-      # Number of fans to return (1-50). Must be at least 1. Must not be greater
-      # than 20.
+      # Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
+      # Must be at least 1. Must not be greater than 20.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -60,8 +60,8 @@ module Onlyfans
       def self.new(
         account:,
         filter: nil,
-        # Number of fans to return (1-50). Must be at least 1. Must not be greater
-        # than 20.
+        # Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
+        # Must be at least 1. Must not be greater than 20.
         limit: nil,
         # Number of fans to skip. Must be at least 0.
         offset: nil,
@@ -98,14 +98,45 @@ module Onlyfans
             )
           end
 
-        # Filter by minimum subscription duration in months. Must be at least 0.
+        # Filter by minimum subscription duration in months. Must use bracket syntax:
+        # filter[duration]=1 — the dot form (filter.duration=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_duration` and the filter could not be
+        # applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :duration
 
         sig { params(duration: Integer).void }
         attr_writer :duration
 
-        # Filter by online status (`1` for online fans).
+        # Filter by **maximum** amount total spent by a fan — use
+        # `filter[max_total_spent]=0` to isolate fans who have never spent. Combine with
+        # `filter[total_spent]` for a range. Must use bracket syntax:
+        # filter[max_total_spent]=0 — the dot form is rejected with a 422, because PHP
+        # rewrites it to `filter_max_total_spent` and the filter could not be applied.
+        #
+        # OnlyFans itself has no maximum-spend filter, so this one is resolved against
+        # OnlyFansAPI's own fan index instead of being proxied. The fan objects in
+        # `data.list` are still fetched live from OnlyFans and are re-checked against your
+        # filters before being returned, but only fans we have already indexed for this
+        # account can appear. Each response reports its own coverage under `data._source`;
+        # when `data._source.is_complete` is `false` a full-base backfill is queued
+        # automatically, so retry later for a complete answer.
+        #
+        # `data._source.omitted_from_page` counts fans that matched your filters but which
+        # OnlyFans returned no usable data for on that page (a deleted account, or a
+        # partial response). They are left out of `data.list` and not revisited later in
+        # the same walk, so a non-zero value means that page was short — start a fresh
+        # walk to retry them. Cannot be combined with `filter[online]`. Must be at
+        # least 0.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :max_total_spent
+
+        sig { params(max_total_spent: Float).void }
+        attr_writer :max_total_spent
+
+        # Filter by online status (`1` for online fans). Must use bracket syntax:
+        # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_online` and the filter could not be applied.
         sig do
           returns(
             T.nilable(Onlyfans::FanListAllParams::Filter::Online::OrInteger)
@@ -113,14 +144,19 @@ module Onlyfans
         end
         attr_accessor :online
 
-        # Filter by minimum tips. Must be at least 0.
+        # Filter by minimum tips. Must use bracket syntax: filter[tips]=100 — the dot form
+        # (filter.tips=100) is rejected with a 422, because PHP rewrites it to
+        # `filter_tips` and the filter could not be applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :tips
 
         sig { params(tips: Integer).void }
         attr_writer :tips
 
-        # Filter by minimum amount total spent by a fan. Must be at least 0.
+        # Filter by minimum amount total spent by a fan. Must use bracket syntax:
+        # filter[total_spent]=100 — the dot form (filter.total_spent=100) is rejected with
+        # a 422, because PHP rewrites it to `filter_total_spent` and the filter could not
+        # be applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :total_spent
 
@@ -130,6 +166,7 @@ module Onlyfans
         sig do
           params(
             duration: Integer,
+            max_total_spent: Float,
             online:
               T.nilable(Onlyfans::FanListAllParams::Filter::Online::OrInteger),
             tips: Integer,
@@ -137,13 +174,44 @@ module Onlyfans
           ).returns(T.attached_class)
         end
         def self.new(
-          # Filter by minimum subscription duration in months. Must be at least 0.
+          # Filter by minimum subscription duration in months. Must use bracket syntax:
+          # filter[duration]=1 — the dot form (filter.duration=1) is rejected with a 422,
+          # because PHP rewrites it to `filter_duration` and the filter could not be
+          # applied. Must be at least 0.
           duration: nil,
-          # Filter by online status (`1` for online fans).
+          # Filter by **maximum** amount total spent by a fan — use
+          # `filter[max_total_spent]=0` to isolate fans who have never spent. Combine with
+          # `filter[total_spent]` for a range. Must use bracket syntax:
+          # filter[max_total_spent]=0 — the dot form is rejected with a 422, because PHP
+          # rewrites it to `filter_max_total_spent` and the filter could not be applied.
+          #
+          # OnlyFans itself has no maximum-spend filter, so this one is resolved against
+          # OnlyFansAPI's own fan index instead of being proxied. The fan objects in
+          # `data.list` are still fetched live from OnlyFans and are re-checked against your
+          # filters before being returned, but only fans we have already indexed for this
+          # account can appear. Each response reports its own coverage under `data._source`;
+          # when `data._source.is_complete` is `false` a full-base backfill is queued
+          # automatically, so retry later for a complete answer.
+          #
+          # `data._source.omitted_from_page` counts fans that matched your filters but which
+          # OnlyFans returned no usable data for on that page (a deleted account, or a
+          # partial response). They are left out of `data.list` and not revisited later in
+          # the same walk, so a non-zero value means that page was short — start a fresh
+          # walk to retry them. Cannot be combined with `filter[online]`. Must be at
+          # least 0.
+          max_total_spent: nil,
+          # Filter by online status (`1` for online fans). Must use bracket syntax:
+          # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+          # because PHP rewrites it to `filter_online` and the filter could not be applied.
           online: nil,
-          # Filter by minimum tips. Must be at least 0.
+          # Filter by minimum tips. Must use bracket syntax: filter[tips]=100 — the dot form
+          # (filter.tips=100) is rejected with a 422, because PHP rewrites it to
+          # `filter_tips` and the filter could not be applied. Must be at least 0.
           tips: nil,
-          # Filter by minimum amount total spent by a fan. Must be at least 0.
+          # Filter by minimum amount total spent by a fan. Must use bracket syntax:
+          # filter[total_spent]=100 — the dot form (filter.total_spent=100) is rejected with
+          # a 422, because PHP rewrites it to `filter_total_spent` and the filter could not
+          # be applied. Must be at least 0.
           total_spent: nil
         )
         end
@@ -152,6 +220,7 @@ module Onlyfans
           override.returns(
             {
               duration: Integer,
+              max_total_spent: Float,
               online:
                 T.nilable(
                   Onlyfans::FanListAllParams::Filter::Online::OrInteger
@@ -164,7 +233,9 @@ module Onlyfans
         def to_hash
         end
 
-        # Filter by online status (`1` for online fans).
+        # Filter by online status (`1` for online fans). Must use bracket syntax:
+        # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_online` and the filter could not be applied.
         module Online
           extend Onlyfans::Internal::Type::Enum
 

data/rbi/onlyfans/models/fan_list_expired_params.rbi

@@ -22,8 +22,8 @@ module Onlyfans
       end
       attr_writer :filter
 
-      # Number of fans to return (1-50). Must be at least 1. Must not be greater
-      # than 20.
+      # Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
+      # Must be at least 1. Must not be greater than 20.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -62,8 +62,8 @@ module Onlyfans
       def self.new(
         account:,
         filter: nil,
-        # Number of fans to return (1-50). Must be at least 1. Must not be greater
-        # than 20.
+        # Number of fans to return (1-20). OnlyFans does not allow more than 20 per page.
+        # Must be at least 1. Must not be greater than 20.
         limit: nil,
         # Number of fans to skip. Must be at least 0.
         offset: nil,
@@ -100,14 +100,45 @@ module Onlyfans
             )
           end
 
-        # Filter by minimum subscription duration in months. Must be at least 0.
+        # Filter by minimum subscription duration in months. Must use bracket syntax:
+        # filter[duration]=1 — the dot form (filter.duration=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_duration` and the filter could not be
+        # applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :duration
 
         sig { params(duration: Integer).void }
         attr_writer :duration
 
-        # Filter by online status (`1` for online fans).
+        # Filter by **maximum** amount total spent by a fan — use
+        # `filter[max_total_spent]=0` to isolate fans who have never spent. Combine with
+        # `filter[total_spent]` for a range. Must use bracket syntax:
+        # filter[max_total_spent]=0 — the dot form is rejected with a 422, because PHP
+        # rewrites it to `filter_max_total_spent` and the filter could not be applied.
+        #
+        # OnlyFans itself has no maximum-spend filter, so this one is resolved against
+        # OnlyFansAPI's own fan index instead of being proxied. The fan objects in
+        # `data.list` are still fetched live from OnlyFans and are re-checked against your
+        # filters before being returned, but only fans we have already indexed for this
+        # account can appear. Each response reports its own coverage under `data._source`;
+        # when `data._source.is_complete` is `false` a full-base backfill is queued
+        # automatically, so retry later for a complete answer.
+        #
+        # `data._source.omitted_from_page` counts fans that matched your filters but which
+        # OnlyFans returned no usable data for on that page (a deleted account, or a
+        # partial response). They are left out of `data.list` and not revisited later in
+        # the same walk, so a non-zero value means that page was short — start a fresh
+        # walk to retry them. Cannot be combined with `filter[online]`. Must be at
+        # least 0.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :max_total_spent
+
+        sig { params(max_total_spent: Float).void }
+        attr_writer :max_total_spent
+
+        # Filter by online status (`1` for online fans). Must use bracket syntax:
+        # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_online` and the filter could not be applied.
         sig do
           returns(
             T.nilable(Onlyfans::FanListExpiredParams::Filter::Online::OrInteger)
@@ -115,14 +146,19 @@ module Onlyfans
         end
         attr_accessor :online
 
-        # Filter by minimum tips. Must be at least 0.
+        # Filter by minimum tips. Must use bracket syntax: filter[tips]=100 — the dot form
+        # (filter.tips=100) is rejected with a 422, because PHP rewrites it to
+        # `filter_tips` and the filter could not be applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :tips
 
         sig { params(tips: Integer).void }
         attr_writer :tips
 
-        # Filter by minimum amount total spent by a fan. Must be at least 0.
+        # Filter by minimum amount total spent by a fan. Must use bracket syntax:
+        # filter[total_spent]=100 — the dot form (filter.total_spent=100) is rejected with
+        # a 422, because PHP rewrites it to `filter_total_spent` and the filter could not
+        # be applied. Must be at least 0.
         sig { returns(T.nilable(Integer)) }
         attr_reader :total_spent
 
@@ -132,6 +168,7 @@ module Onlyfans
         sig do
           params(
             duration: Integer,
+            max_total_spent: Float,
             online:
               T.nilable(
                 Onlyfans::FanListExpiredParams::Filter::Online::OrInteger
@@ -141,13 +178,44 @@ module Onlyfans
           ).returns(T.attached_class)
         end
         def self.new(
-          # Filter by minimum subscription duration in months. Must be at least 0.
+          # Filter by minimum subscription duration in months. Must use bracket syntax:
+          # filter[duration]=1 — the dot form (filter.duration=1) is rejected with a 422,
+          # because PHP rewrites it to `filter_duration` and the filter could not be
+          # applied. Must be at least 0.
           duration: nil,
-          # Filter by online status (`1` for online fans).
+          # Filter by **maximum** amount total spent by a fan — use
+          # `filter[max_total_spent]=0` to isolate fans who have never spent. Combine with
+          # `filter[total_spent]` for a range. Must use bracket syntax:
+          # filter[max_total_spent]=0 — the dot form is rejected with a 422, because PHP
+          # rewrites it to `filter_max_total_spent` and the filter could not be applied.
+          #
+          # OnlyFans itself has no maximum-spend filter, so this one is resolved against
+          # OnlyFansAPI's own fan index instead of being proxied. The fan objects in
+          # `data.list` are still fetched live from OnlyFans and are re-checked against your
+          # filters before being returned, but only fans we have already indexed for this
+          # account can appear. Each response reports its own coverage under `data._source`;
+          # when `data._source.is_complete` is `false` a full-base backfill is queued
+          # automatically, so retry later for a complete answer.
+          #
+          # `data._source.omitted_from_page` counts fans that matched your filters but which
+          # OnlyFans returned no usable data for on that page (a deleted account, or a
+          # partial response). They are left out of `data.list` and not revisited later in
+          # the same walk, so a non-zero value means that page was short — start a fresh
+          # walk to retry them. Cannot be combined with `filter[online]`. Must be at
+          # least 0.
+          max_total_spent: nil,
+          # Filter by online status (`1` for online fans). Must use bracket syntax:
+          # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+          # because PHP rewrites it to `filter_online` and the filter could not be applied.
           online: nil,
-          # Filter by minimum tips. Must be at least 0.
+          # Filter by minimum tips. Must use bracket syntax: filter[tips]=100 — the dot form
+          # (filter.tips=100) is rejected with a 422, because PHP rewrites it to
+          # `filter_tips` and the filter could not be applied. Must be at least 0.
           tips: nil,
-          # Filter by minimum amount total spent by a fan. Must be at least 0.
+          # Filter by minimum amount total spent by a fan. Must use bracket syntax:
+          # filter[total_spent]=100 — the dot form (filter.total_spent=100) is rejected with
+          # a 422, because PHP rewrites it to `filter_total_spent` and the filter could not
+          # be applied. Must be at least 0.
           total_spent: nil
         )
         end
@@ -156,6 +224,7 @@ module Onlyfans
           override.returns(
             {
               duration: Integer,
+              max_total_spent: Float,
               online:
                 T.nilable(
                   Onlyfans::FanListExpiredParams::Filter::Online::OrInteger
@@ -168,7 +237,9 @@ module Onlyfans
         def to_hash
         end
 
-        # Filter by online status (`1` for online fans).
+        # Filter by online status (`1` for online fans). Must use bracket syntax:
+        # filter[online]=1 — the dot form (filter.online=1) is rejected with a 422,
+        # because PHP rewrites it to `filter_online` and the filter could not be applied.
         module Online
           extend Onlyfans::Internal::Type::Enum
 

data/rbi/onlyfans/models/fan_list_latest_params.rbi

@@ -14,13 +14,13 @@ module Onlyfans
       sig { returns(String) }
       attr_accessor :account
 
-      # End date for filtering (required with start_date). This field is required when
-      # <code>start_date</code> is present.
+      # End date for filtering (required with start_date). Must be a valid date. Must
+      # not be greater than 255 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :end_date
 
       # Number of fans to return (1-50). Must be at least 1. Must not be greater
-      # than 100.
+      # than 50.
       sig { returns(T.nilable(Integer)) }
       attr_reader :limit
 
@@ -34,8 +34,8 @@ module Onlyfans
       sig { params(offset: Integer).void }
       attr_writer :offset
 
-      # Start date for filtering (required with end_date). This field is required when
-      # <code>end_date</code> is present.
+      # Start date for filtering (required with end_date). Must be a valid date. Must
+      # not be greater than 255 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :start_date
 
@@ -56,16 +56,16 @@ module Onlyfans
       end
       def self.new(
         account:,
-        # End date for filtering (required with start_date). This field is required when
-        # <code>start_date</code> is present.
+        # End date for filtering (required with start_date). Must be a valid date. Must
+        # not be greater than 255 characters.
         end_date: nil,
         # Number of fans to return (1-50). Must be at least 1. Must not be greater
-        # than 100.
+        # than 50.
         limit: nil,
         # Number of fans to skip. Must be at least 0.
         offset: nil,
-        # Start date for filtering (required with end_date). This field is required when
-        # <code>end_date</code> is present.
+        # Start date for filtering (required with end_date). Must be a valid date. Must
+        # not be greater than 255 characters.
         start_date: nil,
         # Filter by type: total, renew, or new.
         type: nil,

data/rbi/onlyfans/models/fan_list_top_params.rbi

@@ -18,13 +18,13 @@ module Onlyfans
       sig { returns(T.nilable(Onlyfans::FanListTopParams::By::OrSymbol)) }
       attr_accessor :by
 
-      # End date for filtering (required with start_date). This field is required when
-      # <code>start_date</code> is present.
+      # End date for filtering (required with start_date). Must be a valid date. Must
+      # not be greater than 255 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :end_date
 
-      # Start date for filtering (required with end_date). This field is required when
-      # <code>end_date</code> is present.
+      # Start date for filtering (required with end_date). Must be a valid date. Must
+      # not be greater than 255 characters.
       sig { returns(T.nilable(String)) }
       attr_accessor :start_date
 
@@ -41,11 +41,11 @@ module Onlyfans
         account:,
         # Sort by: total (default), subscribes, tips, messages, post, streams.
         by: nil,
-        # End date for filtering (required with start_date). This field is required when
-        # <code>start_date</code> is present.
+        # End date for filtering (required with start_date). Must be a valid date. Must
+        # not be greater than 255 characters.
         end_date: nil,
-        # Start date for filtering (required with end_date). This field is required when
-        # <code>end_date</code> is present.
+        # Start date for filtering (required with end_date). Must be a valid date. Must
+        # not be greater than 255 characters.
         start_date: nil,
         request_options: {}
       )

data/rbi/onlyfans/models/fans/summary_get_summary_response.rbi

@@ -18,6 +18,27 @@ module Onlyfans
         sig { params(analyzed_message_count: Integer).void }
         attr_writer :analyzed_message_count
 
+        sig do
+          returns(
+            T.nilable(
+              T::Array[
+                Onlyfans::Models::Fans::SummaryGetSummaryResponse::CustomField
+              ]
+            )
+          )
+        end
+        attr_reader :custom_fields
+
+        sig do
+          params(
+            custom_fields:
+              T::Array[
+                Onlyfans::Models::Fans::SummaryGetSummaryResponse::CustomField::OrHash
+              ]
+          ).void
+        end
+        attr_writer :custom_fields
+
         sig { returns(T.nilable(String)) }
         attr_accessor :error_message
 
@@ -27,6 +48,12 @@ module Onlyfans
         sig { params(last_analyzed_at: String).void }
         attr_writer :last_analyzed_at
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :last_buy_date
+
+        sig { params(last_buy_date: String).void }
+        attr_writer :last_buy_date
+
         sig { returns(T.nilable(String)) }
         attr_reader :status
 
@@ -53,8 +80,13 @@ module Onlyfans
         sig do
           params(
             analyzed_message_count: Integer,
+            custom_fields:
+              T::Array[
+                Onlyfans::Models::Fans::SummaryGetSummaryResponse::CustomField::OrHash
+              ],
             error_message: T.nilable(String),
             last_analyzed_at: String,
+            last_buy_date: String,
             status: String,
             summary_data:
               Onlyfans::Models::Fans::SummaryGetSummaryResponse::SummaryData::OrHash
@@ -62,8 +94,10 @@ module Onlyfans
         end
         def self.new(
           analyzed_message_count: nil,
+          custom_fields: nil,
           error_message: nil,
           last_analyzed_at: nil,
+          last_buy_date: nil,
           status: nil,
           summary_data: nil
         )
@@ -73,8 +107,13 @@ module Onlyfans
           override.returns(
             {
               analyzed_message_count: Integer,
+              custom_fields:
+                T::Array[
+                  Onlyfans::Models::Fans::SummaryGetSummaryResponse::CustomField
+                ],
               error_message: T.nilable(String),
               last_analyzed_at: String,
+              last_buy_date: String,
               status: String,
               summary_data:
                 Onlyfans::Models::Fans::SummaryGetSummaryResponse::SummaryData
@@ -84,6 +123,36 @@ module Onlyfans
         def to_hash
         end
 
+        class CustomField < Onlyfans::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Onlyfans::Models::Fans::SummaryGetSummaryResponse::CustomField,
+                Onlyfans::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :key
+
+          sig { params(key: String).void }
+          attr_writer :key
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :label
+
+          sig { params(label: String).void }
+          attr_writer :label
+
+          sig { params(key: String, label: String).returns(T.attached_class) }
+          def self.new(key: nil, label: nil)
+          end
+
+          sig { override.returns({ key: String, label: String }) }
+          def to_hash
+          end
+        end
+
         class SummaryData < Onlyfans::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -93,12 +162,24 @@ module Onlyfans
               )
             end
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :content_dislikes
+
+          sig { params(content_dislikes: String).void }
+          attr_writer :content_dislikes
+
           sig { returns(T.nilable(String)) }
           attr_reader :content_preferences
 
           sig { params(content_preferences: String).void }
           attr_writer :content_preferences
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :dos_and_donts
+
+          sig { params(dos_and_donts: String).void }
+          attr_writer :dos_and_donts
+
           sig { returns(T.nilable(String)) }
           attr_reader :family_pets
 
@@ -147,6 +228,12 @@ module Onlyfans
           sig { params(requests: String).void }
           attr_writer :requests
 
+          sig { returns(T.nilable(String)) }
+          attr_reader :spend_cadence
+
+          sig { params(spend_cadence: String).void }
+          attr_writer :spend_cadence
+
           sig { returns(T.nilable(String)) }
           attr_reader :themes
 
@@ -161,7 +248,9 @@ module Onlyfans
 
           sig do
             params(
+              content_dislikes: String,
               content_preferences: String,
+              dos_and_donts: String,
               family_pets: String,
               hobbies: String,
               interests: String,
@@ -170,12 +259,15 @@ module Onlyfans
               other_notes: String,
               preferred_name: String,
               requests: String,
+              spend_cadence: String,
               themes: String,
               travel_plans: String
             ).returns(T.attached_class)
           end
           def self.new(
+            content_dislikes: nil,
             content_preferences: nil,
+            dos_and_donts: nil,
             family_pets: nil,
             hobbies: nil,
             interests: nil,
@@ -184,6 +276,7 @@ module Onlyfans
             other_notes: nil,
             preferred_name: nil,
             requests: nil,
+            spend_cadence: nil,
             themes: nil,
             travel_plans: nil
           )
@@ -192,7 +285,9 @@ module Onlyfans
           sig do
             override.returns(
               {
+                content_dislikes: String,
                 content_preferences: String,
+                dos_and_donts: String,
                 family_pets: String,
                 hobbies: String,
                 interests: String,
@@ -201,6 +296,7 @@ module Onlyfans
                 other_notes: String,
                 preferred_name: String,
                 requests: String,
+                spend_cadence: String,
                 themes: String,
                 travel_plans: String
               }