onlyfans 0.2.0 → 0.3.0

data/rbi/onlyfans/models/media/vault/list_update_params.rbi

@@ -22,14 +22,25 @@ module Onlyfans
           sig { returns(String) }
           attr_accessor :list_id
 
+          # The new name for the vault list. Must not be greater than 255 characters.
+          sig { returns(String) }
+          attr_accessor :name
+
           sig do
             params(
               account: String,
               list_id: String,
+              name: String,
               request_options: Onlyfans::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(account:, list_id:, request_options: {})
+          def self.new(
+            account:,
+            list_id:,
+            # The new name for the vault list. Must not be greater than 255 characters.
+            name:,
+            request_options: {}
+          )
           end
 
           sig do
@@ -37,6 +48,7 @@ module Onlyfans
               {
                 account: String,
                 list_id: String,
+                name: String,
                 request_options: Onlyfans::RequestOptions
               }
             )

data/rbi/onlyfans/models/media/vault_upload_params.rbi

@@ -19,7 +19,9 @@ module Onlyfans
         attr_accessor :account
 
         # Set to `true` to process uploads in the background. Returns a `polling_url` to
-        # check status. Recommended for large files.
+        # check status. Recommended for large files. Instead of polling, you can subscribe
+        # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
+        # they only fire for async uploads.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :async
 
@@ -54,7 +56,9 @@ module Onlyfans
         def self.new(
           account:,
           # Set to `true` to process uploads in the background. Returns a `polling_url` to
-          # check status. Recommended for large files.
+          # check status. Recommended for large files. Instead of polling, you can subscribe
+          # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
+          # they only fire for async uploads.
           async: nil,
           # The file to upload. Required if `file_url` is not provided. Maximum file size:
           # 100 MB (limited by Cloudflare).

data/rbi/onlyfans/models/media_upload_params.rbi

@@ -15,7 +15,9 @@ module Onlyfans
       attr_accessor :account
 
       # Set to `true` to process uploads in the background. Returns a `polling_url` to
-      # check status. Recommended for large files.
+      # check status. Recommended for large files. Instead of polling, you can subscribe
+      # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
+      # they only fire for async uploads.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :async
 
@@ -59,7 +61,9 @@ module Onlyfans
       def self.new(
         account:,
         # Set to `true` to process uploads in the background. Returns a `polling_url` to
-        # check status. Recommended for large files.
+        # check status. Recommended for large files. Instead of polling, you can subscribe
+        # to the `media_uploads.completed` and `media_uploads.failed` webhook events —
+        # they only fire for async uploads.
         async: nil,
         # The file to upload. Required if `file_url` is not provided. Maximum file size:
         # 100 MB (limited by Cloudflare).

data/rbi/onlyfans/models/notification_list_params.rbi

@@ -29,7 +29,7 @@ module Onlyfans
       sig { params(limit: Integer).void }
       attr_writer :limit
 
-      # Whether to skip user details. Default `all`
+      # Whether to skip user details. Defaults to `all`.
       sig do
         returns(
           T.nilable(Onlyfans::NotificationListParams::SkipUsers::OrSymbol)
@@ -72,7 +72,7 @@ module Onlyfans
         from_id: nil,
         # The number of notifications. Default `10`
         limit: nil,
-        # Whether to skip user details. Default `all`
+        # Whether to skip user details. Defaults to `all`.
         skip_users: nil,
         # Filter notifications by a specific type
         type: nil,
@@ -95,7 +95,7 @@ module Onlyfans
       def to_hash
       end
 
-      # Whether to skip user details. Default `all`
+      # Whether to skip user details. Defaults to `all`.
       module SkipUsers
         extend Onlyfans::Internal::Type::Enum
 

data/rbi/onlyfans/models/post_create_params.rbi

@@ -18,6 +18,25 @@ module Onlyfans
       sig { returns(String) }
       attr_accessor :text
 
+      # Screen `text` for OnlyFans banned words and block the post 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::PostCreateParams::BlockBannedWords::OrSymbol)
+        )
+      end
+      attr_reader :block_banned_words
+
+      sig do
+        params(
+          block_banned_words:
+            Onlyfans::PostCreateParams::BlockBannedWords::OrSymbol
+        ).void
+      end
+      attr_writer :block_banned_words
+
       # Number of days after which the post will expire. Between 1 and 30 days. Keep
       # empty for no expiration.
       sig { returns(T.nilable(Integer)) }
@@ -126,6 +145,8 @@ module Onlyfans
         params(
           account: String,
           text: String,
+          block_banned_words:
+            Onlyfans::PostCreateParams::BlockBannedWords::OrSymbol,
           expire_days: Integer,
           fund_raising_target_amount: Integer,
           fund_raising_tips_presets: T::Array[String],
@@ -146,6 +167,11 @@ module Onlyfans
         account:,
         # The post text content
         text:,
+        # Screen `text` for OnlyFans banned words and block the post 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,
         # Number of days after which the post will expire. Between 1 and 30 days. Keep
         # empty for no expiration.
         expire_days: nil,
@@ -188,6 +214,8 @@ module Onlyfans
           {
             account: String,
             text: String,
+            block_banned_words:
+              Onlyfans::PostCreateParams::BlockBannedWords::OrSymbol,
             expire_days: Integer,
             fund_raising_target_amount: Integer,
             fund_raising_tips_presets: T::Array[String],
@@ -208,6 +236,44 @@ module Onlyfans
       def to_hash
       end
 
+      # Screen `text` for OnlyFans banned words and block the post 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::PostCreateParams::BlockBannedWords)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STRICT_BAN =
+          T.let(
+            :strict_ban,
+            Onlyfans::PostCreateParams::BlockBannedWords::TaggedSymbol
+          )
+        RISKY =
+          T.let(
+            :risky,
+            Onlyfans::PostCreateParams::BlockBannedWords::TaggedSymbol
+          )
+        REPLACE_SOFTEN =
+          T.let(
+            :replace_soften,
+            Onlyfans::PostCreateParams::BlockBannedWords::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Onlyfans::PostCreateParams::BlockBannedWords::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Include a poll or quiz within your post.
       module VotingType
         extend Onlyfans::Internal::Type::Enum

data/rbi/onlyfans/models/post_update_params.rbi

@@ -21,6 +21,25 @@ module Onlyfans
       sig { returns(String) }
       attr_accessor :text
 
+      # Screen `text` for OnlyFans banned words and block the update 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::PostUpdateParams::BlockBannedWords::OrSymbol)
+        )
+      end
+      attr_reader :block_banned_words
+
+      sig do
+        params(
+          block_banned_words:
+            Onlyfans::PostUpdateParams::BlockBannedWords::OrSymbol
+        ).void
+      end
+      attr_writer :block_banned_words
+
       # Number of days after which the post will expire. Between 1 and 30 days. Keep
       # empty for no expiration.
       sig { returns(T.nilable(Integer)) }
@@ -129,6 +148,8 @@ module Onlyfans
           account: String,
           post_id: Integer,
           text: String,
+          block_banned_words:
+            Onlyfans::PostUpdateParams::BlockBannedWords::OrSymbol,
           expire_days: Integer,
           fund_raising_target_amount: Integer,
           fund_raising_tips_presets: T::Array[String],
@@ -150,6 +171,11 @@ module Onlyfans
         post_id:,
         # The post text content
         text:,
+        # Screen `text` for OnlyFans banned words and block the update 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,
         # Number of days after which the post will expire. Between 1 and 30 days. Keep
         # empty for no expiration.
         expire_days: nil,
@@ -192,6 +218,8 @@ module Onlyfans
             account: String,
             post_id: Integer,
             text: String,
+            block_banned_words:
+              Onlyfans::PostUpdateParams::BlockBannedWords::OrSymbol,
             expire_days: Integer,
             fund_raising_target_amount: Integer,
             fund_raising_tips_presets: T::Array[String],
@@ -212,6 +240,44 @@ module Onlyfans
       def to_hash
       end
 
+      # Screen `text` for OnlyFans banned words and block the update 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::PostUpdateParams::BlockBannedWords)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STRICT_BAN =
+          T.let(
+            :strict_ban,
+            Onlyfans::PostUpdateParams::BlockBannedWords::TaggedSymbol
+          )
+        RISKY =
+          T.let(
+            :risky,
+            Onlyfans::PostUpdateParams::BlockBannedWords::TaggedSymbol
+          )
+        REPLACE_SOFTEN =
+          T.let(
+            :replace_soften,
+            Onlyfans::PostUpdateParams::BlockBannedWords::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Onlyfans::PostUpdateParams::BlockBannedWords::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Include a poll or quiz within your post.
       module VotingType
         extend Onlyfans::Internal::Type::Enum

data/rbi/onlyfans/models/queue_list_params.rbi

@@ -14,44 +14,67 @@ module Onlyfans
       sig { returns(String) }
       attr_accessor :account
 
-      # Maximum number of queue items to return (default = 20)
-      sig { returns(Integer) }
-      attr_accessor :limit
-
-      # Latest publish date to return
+      # Latest publish date to return. Must be a valid date. Must be a valid date. Must
+      # be a date after or equal to <code>publishDateStart</code>.
       sig { returns(String) }
       attr_accessor :publish_date_end
 
-      # Earliest publish date to return (must be at least today)
+      # Earliest publish date to return (must be at least today). Must be a valid date.
+      # Must be a valid date. Must be a date after or equal to <code>today</code>.
       sig { returns(String) }
       attr_accessor :publish_date_start
 
-      # Time timezone of the provided dates.
-      # [View available timezone values](https://www.php.net/manual/en/timezones.php)
+      # Timezone of the provided dates.
+      # [View available timezone values](https://www.php.net/manual/en/timezones.php).
+      # Must be a valid time zone, such as <code>Africa/Accra</code>.
       sig { returns(String) }
       attr_accessor :timezone
 
+      # Maximum number of queue items to return (default 20). Must be at least 1. Must
+      # not be greater than 100.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        returns(T.nilable(T::Array[Onlyfans::QueueListParams::Type::OrSymbol]))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: T::Array[Onlyfans::QueueListParams::Type::OrSymbol]).void
+      end
+      attr_writer :type
+
       sig do
         params(
           account: String,
-          limit: Integer,
           publish_date_end: String,
           publish_date_start: String,
           timezone: String,
+          limit: Integer,
+          type: T::Array[Onlyfans::QueueListParams::Type::OrSymbol],
           request_options: Onlyfans::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         account:,
-        # Maximum number of queue items to return (default = 20)
-        limit:,
-        # Latest publish date to return
+        # Latest publish date to return. Must be a valid date. Must be a valid date. Must
+        # be a date after or equal to <code>publishDateStart</code>.
         publish_date_end:,
-        # Earliest publish date to return (must be at least today)
+        # Earliest publish date to return (must be at least today). Must be a valid date.
+        # Must be a valid date. Must be a date after or equal to <code>today</code>.
         publish_date_start:,
-        # Time timezone of the provided dates.
-        # [View available timezone values](https://www.php.net/manual/en/timezones.php)
+        # Timezone of the provided dates.
+        # [View available timezone values](https://www.php.net/manual/en/timezones.php).
+        # Must be a valid time zone, such as <code>Africa/Accra</code>.
         timezone:,
+        # Maximum number of queue items to return (default 20). Must be at least 1. Must
+        # not be greater than 100.
+        limit: nil,
+        type: nil,
         request_options: {}
       )
       end
@@ -60,16 +83,36 @@ module Onlyfans
         override.returns(
           {
             account: String,
-            limit: Integer,
             publish_date_end: String,
             publish_date_start: String,
             timezone: String,
+            limit: Integer,
+            type: T::Array[Onlyfans::QueueListParams::Type::OrSymbol],
             request_options: Onlyfans::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      module Type
+        extend Onlyfans::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Onlyfans::QueueListParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CHAT = T.let(:chat, Onlyfans::QueueListParams::Type::TaggedSymbol)
+        POST = T.let(:post, Onlyfans::QueueListParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Onlyfans::QueueListParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/onlyfans/models/release_form_list_taggable_users_response.rbi

@@ -331,11 +331,19 @@ module Onlyfans
         sig { params(next_page: String).void }
         attr_writer :next_page
 
-        sig { params(next_page: String).returns(T.attached_class) }
-        def self.new(next_page: nil)
+        sig { returns(T.nilable(String)) }
+        attr_reader :notice
+
+        sig { params(notice: String).void }
+        attr_writer :notice
+
+        sig do
+          params(next_page: String, notice: String).returns(T.attached_class)
+        end
+        def self.new(next_page: nil, notice: nil)
         end
 
-        sig { override.returns({ next_page: String }) }
+        sig { override.returns({ next_page: String, notice: String }) }
         def to_hash
         end
       end
@@ -349,12 +357,6 @@ module Onlyfans
             )
           end
 
-        sig { returns(T.nilable(T::Boolean)) }
-        attr_reader :has_more
-
-        sig { params(has_more: T::Boolean).void }
-        attr_writer :has_more
-
         sig do
           returns(
             T.nilable(
@@ -378,20 +380,18 @@ module Onlyfans
 
         sig do
           params(
-            has_more: T::Boolean,
             items:
               T::Array[
                 Onlyfans::Models::ReleaseFormListTaggableUsersResponse::Data::Item::OrHash
               ]
           ).returns(T.attached_class)
         end
-        def self.new(has_more: nil, items: nil)
+        def self.new(items: nil)
         end
 
         sig do
           override.returns(
             {
-              has_more: T::Boolean,
               items:
                 T::Array[
                   Onlyfans::Models::ReleaseFormListTaggableUsersResponse::Data::Item