onlyfans 0.2.0 → 0.3.0

data/rbi/onlyfans/models/analytics/financial/profitability_get_profitability_response.rbi

@@ -4,112 +4,234 @@ module Onlyfans
   module Models
     module Analytics
       module Financial
-        class ProfitabilityGetProfitabilityResponseItem < Onlyfans::Internal::Type::BaseModel
+        class ProfitabilityGetProfitabilityResponse < Onlyfans::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponseItem,
+                Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse,
                 Onlyfans::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :commission
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse::Data
+                ]
+              )
+            )
+          end
+          attr_reader :data
 
-          sig { params(commission: Float).void }
-          attr_writer :commission
+          sig do
+            params(
+              data:
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse::Data::OrHash
+                ]
+            ).void
+          end
+          attr_writer :data
 
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :creator_id
+          sig do
+            params(
+              data:
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse::Data::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(data: nil)
+          end
 
-          sig { params(creator_id: Integer).void }
-          attr_writer :creator_id
+          sig do
+            override.returns(
+              {
+                data:
+                  T::Array[
+                    Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse::Data
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :gross_revenue
+          class Data < Onlyfans::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponse::Data,
+                  Onlyfans::Internal::AnyHash
+                )
+              end
 
-          sig { params(gross_revenue: Float).void }
-          attr_writer :gross_revenue
+            sig { returns(T.nilable(String)) }
+            attr_accessor :active_milestones
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :margin
+            sig { returns(T.nilable(String)) }
+            attr_reader :agency_earnings
 
-          sig { params(margin: Float).void }
-          attr_writer :margin
+            sig { params(agency_earnings: String).void }
+            attr_writer :agency_earnings
 
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
+            sig { returns(T.nilable(String)) }
+            attr_reader :commission_amount
 
-          sig { params(name: String).void }
-          attr_writer :name
+            sig { params(commission_amount: String).void }
+            attr_writer :commission_amount
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :net_revenue
+            sig { returns(T.nilable(String)) }
+            attr_reader :commission_rate
 
-          sig { params(net_revenue: Float).void }
-          attr_writer :net_revenue
+            sig { params(commission_rate: String).void }
+            attr_writer :commission_rate
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :profit
+            sig { returns(T.nilable(T::Array[T.anything])) }
+            attr_reader :costs
 
-          sig { params(profit: Float).void }
-          attr_writer :profit
+            sig { params(costs: T::Array[T.anything]).void }
+            attr_writer :costs
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :total_costs
+            sig { returns(T.nilable(String)) }
+            attr_reader :creator_name
 
-          sig { params(total_costs: Float).void }
-          attr_writer :total_costs
+            sig { params(creator_name: String).void }
+            attr_writer :creator_name
 
-          sig do
-            params(
-              commission: Float,
-              creator_id: Integer,
-              gross_revenue: Float,
-              margin: Float,
-              name: String,
-              net_revenue: Float,
-              profit: Float,
-              total_costs: Float
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            commission: nil,
-            creator_id: nil,
-            gross_revenue: nil,
-            margin: nil,
-            name: nil,
-            net_revenue: nil,
-            profit: nil,
-            total_costs: nil
-          )
-          end
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :has_commission_for_period
 
-          sig do
-            override.returns(
-              {
-                commission: Float,
-                creator_id: Integer,
-                gross_revenue: Float,
-                margin: Float,
-                name: String,
-                net_revenue: Float,
-                profit: Float,
-                total_costs: Float
-              }
+            sig { params(has_commission_for_period: T::Boolean).void }
+            attr_writer :has_commission_for_period
+
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :has_costs_for_period
+
+            sig { params(has_costs_for_period: T::Boolean).void }
+            attr_writer :has_costs_for_period
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :margin_percentage
+
+            sig { params(margin_percentage: String).void }
+            attr_writer :margin_percentage
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :month
+
+            sig { params(month: Integer).void }
+            attr_writer :month
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :only_fans_user_id
+
+            sig { params(only_fans_user_id: Integer).void }
+            attr_writer :only_fans_user_id
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :profit
+
+            sig { params(profit: String).void }
+            attr_writer :profit
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :projected_net
+
+            sig { params(projected_net: String).void }
+            attr_writer :projected_net
+
+            sig { returns(T.nilable(T::Array[T.anything])) }
+            attr_reader :rate_periods
+
+            sig { params(rate_periods: T::Array[T.anything]).void }
+            attr_writer :rate_periods
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :referral_note
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :total_costs
+
+            sig { params(total_costs: String).void }
+            attr_writer :total_costs
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :year
+
+            sig { params(year: Integer).void }
+            attr_writer :year
+
+            sig do
+              params(
+                active_milestones: T.nilable(String),
+                agency_earnings: String,
+                commission_amount: String,
+                commission_rate: String,
+                costs: T::Array[T.anything],
+                creator_name: String,
+                has_commission_for_period: T::Boolean,
+                has_costs_for_period: T::Boolean,
+                margin_percentage: String,
+                month: Integer,
+                only_fans_user_id: Integer,
+                profit: String,
+                projected_net: String,
+                rate_periods: T::Array[T.anything],
+                referral_note: T.nilable(String),
+                total_costs: String,
+                year: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              active_milestones: nil,
+              agency_earnings: nil,
+              commission_amount: nil,
+              commission_rate: nil,
+              costs: nil,
+              creator_name: nil,
+              has_commission_for_period: nil,
+              has_costs_for_period: nil,
+              margin_percentage: nil,
+              month: nil,
+              only_fans_user_id: nil,
+              profit: nil,
+              projected_net: nil,
+              rate_periods: nil,
+              referral_note: nil,
+              total_costs: nil,
+              year: nil
             )
-          end
-          def to_hash
+            end
+
+            sig do
+              override.returns(
+                {
+                  active_milestones: T.nilable(String),
+                  agency_earnings: String,
+                  commission_amount: String,
+                  commission_rate: String,
+                  costs: T::Array[T.anything],
+                  creator_name: String,
+                  has_commission_for_period: T::Boolean,
+                  has_costs_for_period: T::Boolean,
+                  margin_percentage: String,
+                  month: Integer,
+                  only_fans_user_id: Integer,
+                  profit: String,
+                  projected_net: String,
+                  rate_periods: T::Array[T.anything],
+                  referral_note: T.nilable(String),
+                  total_costs: String,
+                  year: Integer
+                }
+              )
+            end
+            def to_hash
+            end
           end
         end
-
-        ProfitabilityGetProfitabilityResponse =
-          T.let(
-            Onlyfans::Internal::Type::ArrayOf[
-              Onlyfans::Models::Analytics::Financial::ProfitabilityGetProfitabilityResponseItem
-            ],
-            Onlyfans::Internal::Type::Converter
-          )
       end
     end
   end

data/rbi/onlyfans/models/authenticate_start_params.rbi

@@ -316,6 +316,11 @@ module Onlyfans
             :uk,
             Onlyfans::AuthenticateStartParams::ProxyCountry::TaggedSymbol
           )
+        GB =
+          T.let(
+            :gb,
+            Onlyfans::AuthenticateStartParams::ProxyCountry::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/onlyfans/models/chat_list_media_params.rbi

@@ -31,7 +31,8 @@ module Onlyfans
       sig { params(offset: String).void }
       attr_writer :offset
 
-      # Whether to skip user details in response (all or none). Default = all
+      # Whether to skip user details in the response (`all` or `none`). Defaults to
+      # `all`.
       sig { returns(T.nilable(String)) }
       attr_reader :skip_users
 
@@ -60,7 +61,8 @@ module Onlyfans
         limit: nil,
         # Number of medias to skip for pagination
         offset: nil,
-        # Whether to skip user details in response (all or none). Default = all
+        # Whether to skip user details in the response (`all` or `none`). Defaults to
+        # `all`.
         skip_users: nil,
         # Filter by specific media types. Keep empty to return all.
         type: nil,

data/rbi/onlyfans/models/chat_list_params.rbi

@@ -49,7 +49,8 @@ module Onlyfans
       sig { params(query: String).void }
       attr_writer :query
 
-      # Whether to skip user details in response (all or none). Default = all
+      # Whether to skip user details in the response (`all` or `none`). Defaults to
+      # `all`.
       sig { returns(T.nilable(Onlyfans::ChatListParams::SkipUsers::OrSymbol)) }
       attr_reader :skip_users
 
@@ -82,7 +83,8 @@ module Onlyfans
         order: nil,
         # Search query to filter chats
         query: nil,
-        # Whether to skip user details in response (all or none). Default = all
+        # Whether to skip user details in the response (`all` or `none`). Defaults to
+        # `all`.
         skip_users: nil,
         request_options: {}
       )
@@ -154,7 +156,8 @@ module Onlyfans
         end
       end
 
-      # Whether to skip user details in response (all or none). Default = all
+      # Whether to skip user details in the response (`all` or `none`). Defaults to
+      # `all`.
       module SkipUsers
         extend Onlyfans::Internal::Type::Enum
 

data/rbi/onlyfans/models/chats/message_list_params.rbi

@@ -36,9 +36,9 @@ module Onlyfans
         end
         attr_writer :filter
 
-        # Use for pagination when `order=desc` (newest to oldest). Include this message ID
-        # as the first message in the results. Used to retrieve messages from e.g. the
-        # Search Chat Messages endpoint IDs.
+        # Use for pagination when `order=desc` (newest to oldest). Pass the last message
+        # ID from the previous page to retrieve older messages, excluding that cursor
+        # message.
         sig { returns(T.nilable(String)) }
         attr_accessor :first_id
 
@@ -63,7 +63,7 @@ module Onlyfans
         sig { params(order: String).void }
         attr_writer :order
 
-        # Whether to skip user details (all or none)
+        # Whether to skip user details (`all` or `none`).
         sig { returns(T.nilable(String)) }
         attr_reader :skip_users
 
@@ -88,9 +88,9 @@ module Onlyfans
           chat_id:,
           # Filter by certain messages. Currently, only pins are filterable.
           filter: nil,
-          # Use for pagination when `order=desc` (newest to oldest). Include this message ID
-          # as the first message in the results. Used to retrieve messages from e.g. the
-          # Search Chat Messages endpoint IDs.
+          # Use for pagination when `order=desc` (newest to oldest). Pass the last message
+          # ID from the previous page to retrieve older messages, excluding that cursor
+          # message.
           first_id: nil,
           # Use for pagination when `order=asc` (oldest to newest). Include this message ID
           # as the first message in the results. WARNING! The response list of messages will
@@ -101,7 +101,7 @@ module Onlyfans
           limit: nil,
           # Sort order for messages (desc or asc)
           order: nil,
-          # Whether to skip user details (all or none)
+          # Whether to skip user details (`all` or `none`).
           skip_users: nil,
           request_options: {}
         )

data/rbi/onlyfans/models/chats/message_send_params.rbi

@@ -21,6 +21,27 @@ module Onlyfans
         sig { returns(String) }
         attr_accessor :chat_id
 
+        # Screen `text` for OnlyFans banned words and block the send if any are found
+        # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
+        # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
+        # only. Omit to disable screening.
+        sig do
+          returns(
+            T.nilable(
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::OrSymbol
+            )
+          )
+        end
+        attr_reader :block_banned_words
+
+        sig do
+          params(
+            block_banned_words:
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::OrSymbol
+          ).void
+        end
+        attr_writer :block_banned_words
+
         # The ID of the Giphy GIF to attach to the message. Get IDs from the Giphy listing
         # endpoints (`/giphy/trending`, `/giphy/search`).
         sig { returns(T.nilable(String)) }
@@ -53,12 +74,12 @@ module Onlyfans
         sig { params(previews: T::Array[T.anything]).void }
         attr_writer :previews
 
-        # Price for paid content (0 or between 3-200). In case this is not zero,
+        # Price for paid content in USD (0 or between 3-200). In case this is not zero,
         # **mediaFiles** is required
-        sig { returns(T.nilable(Integer)) }
+        sig { returns(T.nilable(Float)) }
         attr_reader :price
 
-        sig { params(price: Integer).void }
+        sig { params(price: Float).void }
         attr_writer :price
 
         # Mark this message as a reply to another (can be either your own, or the
@@ -97,26 +118,40 @@ module Onlyfans
         sig { params(text: String).void }
         attr_writer :text
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
         sig do
           params(
             account: String,
             chat_id: String,
+            block_banned_words:
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::OrSymbol,
             giphy_id: String,
             locked_text: T::Boolean,
             media_files: T::Array[T.anything],
             previews: T::Array[T.anything],
-            price: Integer,
+            price: Float,
             reply_to_message_id: Integer,
             rf_guest: String,
             rf_partner: String,
             rf_tag: String,
             text: String,
+            idempotency_key: String,
             request_options: Onlyfans::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           account:,
           chat_id:,
+          # Screen `text` for OnlyFans banned words and block the send if any are found
+          # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
+          # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
+          # only. Omit to disable screening.
+          block_banned_words: nil,
           # The ID of the Giphy GIF to attach to the message. Get IDs from the Giphy listing
           # endpoints (`/giphy/trending`, `/giphy/search`).
           giphy_id: nil,
@@ -129,7 +164,7 @@ module Onlyfans
           # referencing uploaded files in `mediaFiles`. Will be shown if `price` is
           # provided.
           previews: nil,
-          # Price for paid content (0 or between 3-200). In case this is not zero,
+          # Price for paid content in USD (0 or between 3-200). In case this is not zero,
           # **mediaFiles** is required
           price: nil,
           # Mark this message as a reply to another (can be either your own, or the
@@ -143,6 +178,7 @@ module Onlyfans
           rf_tag: nil,
           # The message text content. Required unless a media file is present.
           text: nil,
+          idempotency_key: nil,
           request_options: {}
         )
         end
@@ -152,22 +188,68 @@ module Onlyfans
             {
               account: String,
               chat_id: String,
+              block_banned_words:
+                Onlyfans::Chats::MessageSendParams::BlockBannedWords::OrSymbol,
               giphy_id: String,
               locked_text: T::Boolean,
               media_files: T::Array[T.anything],
               previews: T::Array[T.anything],
-              price: Integer,
+              price: Float,
               reply_to_message_id: Integer,
               rf_guest: String,
               rf_partner: String,
               rf_tag: String,
               text: String,
+              idempotency_key: String,
               request_options: Onlyfans::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        # Screen `text` for OnlyFans banned words and block the send if any are found
+        # (returns a 422 listing the offending words). `strict_ban` blocks all tiers,
+        # `risky` blocks Risky + Replace/soften, `replace_soften` blocks Replace/soften
+        # only. Omit to disable screening.
+        module BlockBannedWords
+          extend Onlyfans::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Onlyfans::Chats::MessageSendParams::BlockBannedWords
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          STRICT_BAN =
+            T.let(
+              :strict_ban,
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::TaggedSymbol
+            )
+          RISKY =
+            T.let(
+              :risky,
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::TaggedSymbol
+            )
+          REPLACE_SOFTEN =
+            T.let(
+              :replace_soften,
+              Onlyfans::Chats::MessageSendParams::BlockBannedWords::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Onlyfans::Chats::MessageSendParams::BlockBannedWords::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/onlyfans/models/client_session_create_params.rbi

@@ -88,6 +88,11 @@ module Onlyfans
             :uk,
             Onlyfans::ClientSessionCreateParams::ProxyCountry::TaggedSymbol
           )
+        GB =
+          T.let(
+            :gb,
+            Onlyfans::ClientSessionCreateParams::ProxyCountry::TaggedSymbol
+          )
 
         sig do
           override.returns(