onlyfans 0.2.0 → 0.3.0

data/lib/onlyfans/resources/tracking_links.rb

@@ -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.
       # @return [Onlyfans::Resources::TrackingLinks::Tags]
       attr_reader :tags
 
@@ -66,25 +74,27 @@ module Onlyfans
       #
       # List all tracking links for the account and revenue data
       #
-      # @overload list(account, end_date: nil, limit: nil, offset: nil, sort: nil, sortby: nil, start_date: nil, synchronous: nil, with_deleted: nil, request_options: {})
+      # @overload list(account, end_date: nil, limit: nil, offset: nil, pagination: nil, sort: nil, sortby: nil, start_date: nil, synchronous: nil, with_deleted: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
-      # @param end_date [String, nil] The end date for Tracking Links. Keep empty to get all.
+      # @param end_date [String, nil] The end date for tracking links. Keep empty to get all. Must not be greater than
       #
-      # @param limit [Integer, nil] The number of tracking links to return. Default `3`
+      # @param limit [Integer] The number of tracking links to return. Default `10`. Must be at least 1. Must n
       #
-      # @param offset [Integer, nil] The offset used for pagination. Default `0`
+      # @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
       #
-      # @param sort [Symbol, Onlyfans::Models::TrackingLinkListParams::Sort, nil] Sort the results. Default `desc`
+      # @param pagination [Integer, Onlyfans::Models::TrackingLinkListParams::Pagination]
       #
-      # @param sortby [Symbol, Onlyfans::Models::TrackingLinkListParams::Sortby, nil] Sort by subscriber count (claims), or creation date
+      # @param sort [Symbol, Onlyfans::Models::TrackingLinkListParams::Sort] Sort direction. Default `desc`.
       #
-      # @param start_date [String, nil] The start date for Tracking Links. Keep empty to get all.
+      # @param sortby [Symbol, Onlyfans::Models::TrackingLinkListParams::Sortby] Sort by subscriber count (`claims`) or creation date (`created_date`).
       #
-      # @param synchronous [Boolean, nil] Wait for the revenue data to finish processing, instead of processing in the bac
+      # @param start_date [String, nil] The start date for tracking links. Keep empty to get all. Must not be greater th
       #
-      # @param with_deleted [Boolean, nil] Whether or not to include deleted tracking links in the response. Default `false
+      # @param synchronous [Boolean] Wait for revenue calculation instead of processing it in the background.
+      #
+      # @param with_deleted [Integer, Onlyfans::Models::TrackingLinkListParams::WithDeleted] Whether to include deleted tracking links. Default `true`.
       #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/onlyfans/resources/transactions.rb

@@ -18,7 +18,7 @@ module Onlyfans
       #
       # @param marker [String] The marker used for pagination. Default: `null`
       #
-      # @param start_date [String] The start date for transactions list. Default: `-30days`
+      # @param start_date [String] The start date for the transactions list. Defaults to 30 days ago.
       #
       # @param tips_source [String] Filter tips by source. Only applies when `type=tips`. Options: `profile`,
       # `post\_

data/lib/onlyfans/resources/trial_links/tags.rb

@@ -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.
         #

data/lib/onlyfans/resources/trial_links.rb

@@ -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.
       # @return [Onlyfans::Resources::TrialLinks::Tags]
       attr_reader :tags
 
@@ -75,32 +83,36 @@ module Onlyfans
       #
       # List all free trial links for the account, including the details and statistics
       #
-      # @overload list(account, limit:, offset:, field: nil, sort: nil, synchronous: nil, request_options: {})
+      # @overload list(account, end_date: nil, field: nil, limit: nil, offset: nil, sort: nil, start_date: nil, synchronous: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
-      # @param limit [Integer] The number of trial links to return. Default `10`
+      # @param end_date [String, nil] The end date for trial links. Keep empty to get all. Must not be greater than 25
       #
-      # @param offset [Integer] The offset used for pagination. Default `0`
+      # @param field [Symbol, Onlyfans::Models::TrialLinkListParams::Field] Field to sort by. Default `create_date`.
       #
-      # @param field [Symbol, Onlyfans::Models::TrialLinkListParams::Field, nil] Sort the results by a field. Default `create_date`
+      # @param limit [Integer] The number of trial links to return. Default `10`. Must be at least 1. Must not
       #
-      # @param sort [Symbol, Onlyfans::Models::TrialLinkListParams::Sort, nil] Sort the results. Default `desc`
+      # @param offset [Integer] The offset used for pagination. Default `0`. Must be at least 0.
       #
-      # @param synchronous [Boolean, nil] Wait for the revenue data to finish processing, instead of processing in the bac
+      # @param sort [Symbol, Onlyfans::Models::TrialLinkListParams::Sort] Sort direction. Default `desc`.
+      #
+      # @param start_date [String, nil] The start date for trial links. Keep empty to get all. Must not be greater than
+      #
+      # @param synchronous [Boolean] Wait for revenue calculation instead of processing it in the background.
       #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Onlyfans::Models::TrialLinkListResponse]
       #
       # @see Onlyfans::Models::TrialLinkListParams
-      def list(account, params)
+      def list(account, params = {})
         parsed, options = Onlyfans::TrialLinkListParams.dump_request(params)
         query = Onlyfans::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["api/%1$s/trial-links", account],
-          query: query,
+          query: query.transform_keys(end_date: "endDate", start_date: "startDate"),
           model: Onlyfans::Models::TrialLinkListResponse,
           options: options
         )

data/lib/onlyfans/resources/user_lists/users.rb

@@ -37,9 +37,12 @@ module Onlyfans
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Onlyfans::Models::UserLists::UserAddParams} for more details.
+        #
         # Add multiple Users To OnlyFans User List
         #
-        # @overload add(user_list_id, account:, ids:, request_options: {})
+        # @overload add(user_list_id, account:, ids:, skip_invalid: nil, request_options: {})
         #
         # @param user_list_id [String] Path param: OnlyFans User List ID, or a default list name like `tagged`
         #
@@ -47,9 +50,11 @@ module Onlyfans
         #
         # @param ids [Array<String>] Body param: Array of OnlyFans User IDs to be added into the list
         #
+        # @param skip_invalid [Boolean] Body param: Set to `true` to skip the User IDs OnlyFans refuses instead of faili
+        #
         # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Onlyfans::Models::UserLists::UserAddResponse]
+        # @return [Onlyfans::Models::UserLists::UserAddResponse::UnionMember0, Onlyfans::Models::UserLists::UserAddResponse::UnionMember1]
         #
         # @see Onlyfans::Models::UserLists::UserAddParams
         def add(user_list_id, params)

data/lib/onlyfans/resources/user_lists.rb

@@ -95,9 +95,10 @@ module Onlyfans
       # Some parameter documentations has been truncated, see
       # {Onlyfans::Models::UserListListParams} for more details.
       #
-      # 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`
       #
-      # @overload list(account, limit: nil, offset: nil, request_options: {})
+      # @overload list(account, limit: nil, offset: nil, view: nil, request_options: {})
       #
       # @param account [String] The Account ID
       #
@@ -105,6 +106,8 @@ module Onlyfans
       #
       # @param offset [Integer, nil] Must be at least 0.
       #
+      # @param view [Symbol, Onlyfans::Models::UserListListParams::View] How to return the results. `queue` returns the user lists that are available for
+      #
       # @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Onlyfans::Models::UserListListResponse]

data/lib/onlyfans/resources/users.rb

@@ -16,13 +16,16 @@ module Onlyfans
       # @return [Onlyfans::Resources::Users::Subscribe]
       attr_reader :subscribe
 
+      # Some parameter documentations has been truncated, see
+      # {Onlyfans::Models::UserRetrieveParams} for more details.
+      #
       # Get OnlyFans Profile details for a given username. User details are retrieved
       # using the current `{account}` so fields like `subscribedOnData` which include
       # potential subscription details will be included.
       #
       # @overload retrieve(username, account:, request_options: {})
       #
-      # @param username [String] The OnlyFans username of the user to retrieve details for.
+      # @param username [String] The OnlyFans username or numeric user ID to retrieve details for. Display names
       #
       # @param account [String] The Account ID
       #

data/lib/onlyfans/resources/webhooks.rb

@@ -10,14 +10,15 @@ module Onlyfans
       #
       # @overload create(account_scope:, endpoint_url:, events:, account_ids: nil, signing_secret: nil, request_options: {})
       #
-      # @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.
       #
@@ -66,14 +67,15 @@ module Onlyfans
       #
       # @param webhook_id [String] The ID of the webhook
       #
-      # @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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onlyfans
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/onlyfans.rb

@@ -245,7 +245,6 @@ require_relative "onlyfans/models/media/vault_retrieve_response"
 require_relative "onlyfans/models/media/vault_upload_params"
 require_relative "onlyfans/models/media/vault_upload_response"
 require_relative "onlyfans/models/media_download_params"
-require_relative "onlyfans/models/media_download_response"
 require_relative "onlyfans/models/media_scrape_params"
 require_relative "onlyfans/models/media_scrape_response"
 require_relative "onlyfans/models/media_upload_params"
@@ -256,8 +255,6 @@ require_relative "onlyfans/models/me_get_top_percentage_params"
 require_relative "onlyfans/models/me_get_top_percentage_response"
 require_relative "onlyfans/models/me_retrieve_params"
 require_relative "onlyfans/models/me_retrieve_response"
-require_relative "onlyfans/models/message_attach_tags_params"
-require_relative "onlyfans/models/message_attach_tags_response"
 require_relative "onlyfans/models/notification_get_counts_params"
 require_relative "onlyfans/models/notification_get_counts_response"
 require_relative "onlyfans/models/notification_list_params"

data/rbi/onlyfans/client.rbi

@@ -63,14 +63,18 @@ module Onlyfans
     sig { returns(Onlyfans::Resources::Following) }
     attr_reader :following
 
-    # 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) }
     attr_reader :trial_links
 
     sig { returns(Onlyfans::Resources::Giphy) }
     attr_reader :giphy
 
-    # APIs for managing tags on free trial links and tracking links
+    # APIs for managing tags on free trial links, tracking links, and Smart Links
     sig { returns(Onlyfans::Resources::LinkTags) }
     attr_reader :link_tags
 
@@ -148,7 +152,11 @@ module Onlyfans
     sig { returns(Onlyfans::Resources::Bundles) }
     attr_reader :bundles
 
-    # 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) }
     attr_reader :tracking_links
 

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

@@ -4,94 +4,234 @@ module Onlyfans
   module Models
     module Analytics
       module Financial
-        class ProfitabilityGetHistoryResponseItem < Onlyfans::Internal::Type::BaseModel
+        class ProfitabilityGetHistoryResponse < Onlyfans::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponseItem,
+                Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse,
                 Onlyfans::Internal::AnyHash
               )
             end
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :gross_revenue
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse::Data
+                ]
+              )
+            )
+          end
+          attr_reader :data
 
-          sig { params(gross_revenue: Float).void }
-          attr_writer :gross_revenue
+          sig do
+            params(
+              data:
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse::Data::OrHash
+                ]
+            ).void
+          end
+          attr_writer :data
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :margin
+          sig do
+            params(
+              data:
+                T::Array[
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse::Data::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(data: nil)
+          end
 
-          sig { params(margin: Float).void }
-          attr_writer :margin
+          sig do
+            override.returns(
+              {
+                data:
+                  T::Array[
+                    Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse::Data
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
 
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :month
+          class Data < Onlyfans::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponse::Data,
+                  Onlyfans::Internal::AnyHash
+                )
+              end
 
-          sig { params(month: Integer).void }
-          attr_writer :month
+            sig { returns(T.nilable(String)) }
+            attr_accessor :active_milestones
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :net_revenue
+            sig { returns(T.nilable(String)) }
+            attr_reader :agency_earnings
 
-          sig { params(net_revenue: Float).void }
-          attr_writer :net_revenue
+            sig { params(agency_earnings: String).void }
+            attr_writer :agency_earnings
 
-          sig { returns(T.nilable(Float)) }
-          attr_reader :profit
+            sig { returns(T.nilable(String)) }
+            attr_reader :commission_amount
 
-          sig { params(profit: Float).void }
-          attr_writer :profit
+            sig { params(commission_amount: String).void }
+            attr_writer :commission_amount
 
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :year
+            sig { returns(T.nilable(String)) }
+            attr_reader :commission_rate
 
-          sig { params(year: Integer).void }
-          attr_writer :year
+            sig { params(commission_rate: String).void }
+            attr_writer :commission_rate
 
-          sig do
-            params(
-              gross_revenue: Float,
-              margin: Float,
-              month: Integer,
-              net_revenue: Float,
-              profit: Float,
-              year: Integer
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            gross_revenue: nil,
-            margin: nil,
-            month: nil,
-            net_revenue: nil,
-            profit: nil,
-            year: nil
-          )
-          end
+            sig { returns(T.nilable(T::Array[T.anything])) }
+            attr_reader :costs
 
-          sig do
-            override.returns(
-              {
-                gross_revenue: Float,
-                margin: Float,
+            sig { params(costs: T::Array[T.anything]).void }
+            attr_writer :costs
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :creator_name
+
+            sig { params(creator_name: String).void }
+            attr_writer :creator_name
+
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :has_commission_for_period
+
+            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,
-                net_revenue: Float,
-                profit: Float,
+                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
-
-        ProfitabilityGetHistoryResponse =
-          T.let(
-            Onlyfans::Internal::Type::ArrayOf[
-              Onlyfans::Models::Analytics::Financial::ProfitabilityGetHistoryResponseItem
-            ],
-            Onlyfans::Internal::Type::Converter
-          )
       end
     end
   end