onlyfans 0.2.0 → 0.3.0

data/lib/onlyfans/models/smart_link_postback_update_params.rb

@@ -30,13 +30,36 @@ module Onlyfans
       #   @return [String]
       required :url, String
 
+      # @!attribute body
+      #   Optional request body template for POST postbacks. Variables are replaced when
+      #   the postback is dispatched.
+      #
+      #   @return [String, nil]
+      optional :body, String
+
+      # @!attribute headers
+      #   Optional request headers. Header values may include postback variables.
+      #
+      #   @return [Array<Onlyfans::Models::SmartLinkPostbackUpdateParams::Header>, nil]
+      optional :headers,
+               -> { Onlyfans::Internal::Type::ArrayOf[Onlyfans::SmartLinkPostbackUpdateParams::Header] }
+
+      # @!attribute http_method
+      #   HTTP method used for the postback request. Existing value is kept when omitted.
+      #
+      #   @return [Symbol, Onlyfans::Models::SmartLinkPostbackUpdateParams::HTTPMethod, nil]
+      optional :http_method, enum: -> { Onlyfans::SmartLinkPostbackUpdateParams::HTTPMethod }
+
       # @!attribute smart_link_ids
       #   Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
       #
       #   @return [Array<String>, nil]
       optional :smart_link_ids, Onlyfans::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(postback_id:, conversion_types:, smart_link_scope:, url:, smart_link_ids: nil, request_options: {})
+      # @!method initialize(postback_id:, conversion_types:, smart_link_scope:, url:, body: nil, headers: nil, http_method: nil, smart_link_ids: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Onlyfans::Models::SmartLinkPostbackUpdateParams} for more details.
+      #
       #   @param postback_id [Integer]
       #
       #   @param conversion_types [Array<String>] One or more Smart Link conversion types that should trigger this postback.
@@ -45,6 +68,12 @@ module Onlyfans
       #
       #   @param url [String] The destination URL.
       #
+      #   @param body [String] Optional request body template for POST postbacks. Variables are replaced when t
+      #
+      #   @param headers [Array<Onlyfans::Models::SmartLinkPostbackUpdateParams::Header>] Optional request headers. Header values may include postback variables.
+      #
+      #   @param http_method [Symbol, Onlyfans::Models::SmartLinkPostbackUpdateParams::HTTPMethod] HTTP method used for the postback request. Existing value is kept when omitted.
+      #
       #   @param smart_link_ids [Array<String>] Smart Link ULIDs. Required when `smart_link_scope` is `campaign_specific`.
       #
       #   @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
@@ -59,6 +88,41 @@ module Onlyfans
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Header < Onlyfans::Internal::Type::BaseModel
+        # @!attribute name
+        #   This field is required when <code>headers._.value</code> is present. Must match
+        #   the regex /\A[A-Za-z0-9!#$%&'_+.^\_`|~-]+\z/. Must not be greater than 100
+        #   characters.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute value
+        #   Must not be greater than 2000 characters.
+        #
+        #   @return [String, nil]
+        optional :value, String, nil?: true
+
+        # @!method initialize(name: nil, value: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Onlyfans::Models::SmartLinkPostbackUpdateParams::Header} for more details.
+        #
+        #   @param name [String, nil] This field is required when <code>headers.\*.value</code> is present. Must match
+        #
+        #   @param value [String, nil] Must not be greater than 2000 characters.
+      end
+
+      # HTTP method used for the postback request. Existing value is kept when omitted.
+      module HTTPMethod
+        extend Onlyfans::Internal::Type::Enum
+
+        GET = :GET
+        POST = :POST
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/onlyfans/models/smart_link_postback_update_response.rb

@@ -82,6 +82,11 @@ module Onlyfans
         #   @return [Integer, nil]
         optional :id, Integer
 
+        # @!attribute body
+        #
+        #   @return [String, nil]
+        optional :body, String
+
         # @!attribute conversion_types
         #
         #   @return [Array<String>, nil]
@@ -92,6 +97,17 @@ module Onlyfans
         #   @return [String, nil]
         optional :created_at, String
 
+        # @!attribute headers
+        #
+        #   @return [Array<Onlyfans::Models::SmartLinkPostbackUpdateResponse::Data::Header>, nil]
+        optional :headers,
+                 -> { Onlyfans::Internal::Type::ArrayOf[Onlyfans::Models::SmartLinkPostbackUpdateResponse::Data::Header] }
+
+        # @!attribute http_method
+        #
+        #   @return [String, nil]
+        optional :http_method, String
+
         # @!attribute latest_response
         #
         #   @return [String, nil]
@@ -113,6 +129,16 @@ module Onlyfans
         optional :smart_links,
                  -> { Onlyfans::Internal::Type::ArrayOf[Onlyfans::Models::SmartLinkPostbackUpdateResponse::Data::SmartLink] }
 
+        # @!attribute traffic_source_ids
+        #
+        #   @return [Array<Object>, nil]
+        optional :traffic_source_ids, Onlyfans::Internal::Type::ArrayOf[Onlyfans::Internal::Type::Unknown]
+
+        # @!attribute traffic_sources
+        #
+        #   @return [Array<Object>, nil]
+        optional :traffic_sources, Onlyfans::Internal::Type::ArrayOf[Onlyfans::Internal::Type::Unknown]
+
         # @!attribute updated_at
         #
         #   @return [String, nil]
@@ -123,17 +149,38 @@ module Onlyfans
         #   @return [String, nil]
         optional :url, String
 
-        # @!method initialize(id: nil, conversion_types: nil, created_at: nil, latest_response: nil, smart_link_ids: nil, smart_link_scope: nil, smart_links: nil, updated_at: nil, url: nil)
+        # @!method initialize(id: nil, body: nil, conversion_types: nil, created_at: nil, headers: nil, http_method: nil, latest_response: nil, smart_link_ids: nil, smart_link_scope: nil, smart_links: nil, traffic_source_ids: nil, traffic_sources: nil, updated_at: nil, url: nil)
         #   @param id [Integer]
+        #   @param body [String]
         #   @param conversion_types [Array<String>]
         #   @param created_at [String]
+        #   @param headers [Array<Onlyfans::Models::SmartLinkPostbackUpdateResponse::Data::Header>]
+        #   @param http_method [String]
         #   @param latest_response [String, nil]
         #   @param smart_link_ids [Array<String>]
         #   @param smart_link_scope [String]
         #   @param smart_links [Array<Onlyfans::Models::SmartLinkPostbackUpdateResponse::Data::SmartLink>]
+        #   @param traffic_source_ids [Array<Object>]
+        #   @param traffic_sources [Array<Object>]
         #   @param updated_at [String]
         #   @param url [String]
 
+        class Header < Onlyfans::Internal::Type::BaseModel
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute value
+          #
+          #   @return [String, nil]
+          optional :value, String
+
+          # @!method initialize(name: nil, value: nil)
+          #   @param name [String]
+          #   @param value [String]
+        end
+
         class SmartLink < Onlyfans::Internal::Type::BaseModel
           # @!attribute account_display_name
           #

data/lib/onlyfans/models/statistic_calculate_total_transactions_params.rb

@@ -15,16 +15,16 @@ module Onlyfans
       # @!attribute end_date
       #   The end date for the period. Keep empty to calculate everything.
       #
-      #   @return [String]
-      required :end_date, String
+      #   @return [String, nil]
+      optional :end_date, String
 
       # @!attribute start_date
       #   The start date for the period. Keep empty to calculate everything.
       #
-      #   @return [String]
-      required :start_date, String
+      #   @return [String, nil]
+      optional :start_date, String
 
-      # @!method initialize(account:, end_date:, start_date:, request_options: {})
+      # @!method initialize(account:, end_date: nil, start_date: nil, request_options: {})
       #   @param account [String]
       #
       #   @param end_date [String] The end date for the period. Keep empty to calculate everything.

data/lib/onlyfans/models/statistic_get_subscriber_metrics_params.rb

@@ -31,7 +31,16 @@ module Onlyfans
       #   @return [Boolean, nil]
       optional :detailed, Onlyfans::Internal::Type::Boolean, nil?: true
 
-      # @!method initialize(account:, end_date:, start_date:, detailed: nil, request_options: {})
+      # @!attribute detailed_type
+      #   Use only with `detailed=true` - otherwise, it has no effect. Filter the
+      #   subscriber statistics (default = total)
+      #
+      #   @return [Symbol, Onlyfans::Models::StatisticGetSubscriberMetricsParams::DetailedType, nil]
+      optional :detailed_type,
+               enum: -> { Onlyfans::StatisticGetSubscriberMetricsParams::DetailedType },
+               nil?: true
+
+      # @!method initialize(account:, end_date:, start_date:, detailed: nil, detailed_type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Onlyfans::Models::StatisticGetSubscriberMetricsParams} for more details.
       #
@@ -43,7 +52,22 @@ module Onlyfans
       #
       #   @param detailed [Boolean, nil] Include paid and free fan metrics. Will slow down the response time, and might t
       #
+      #   @param detailed_type [Symbol, Onlyfans::Models::StatisticGetSubscriberMetricsParams::DetailedType, nil] Use only with `detailed=true` - otherwise, it has no effect. Filter the subscrib
+      #
       #   @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
+
+      # Use only with `detailed=true` - otherwise, it has no effect. Filter the
+      # subscriber statistics (default = total)
+      module DetailedType
+        extend Onlyfans::Internal::Type::Enum
+
+        TOTAL = :total
+        RENEW = :renew
+        NEW = :new
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/onlyfans/models/statistics/reach_get_profile_visitors_params.rb

@@ -20,7 +20,7 @@ module Onlyfans
         required :end_date, String
 
         # @!attribute start_date
-        #   The start date for the period
+        #   The start date for the period.
         #
         #   @return [String]
         required :start_date, String
@@ -52,7 +52,7 @@ module Onlyfans
         #
         #   @param end_date [String] The end date for the period.
         #
-        #   @param start_date [String] The start date for the period
+        #   @param start_date [String] The start date for the period.
         #
         #   @param filter [Symbol, Onlyfans::Models::Statistics::ReachGetProfileVisitorsParams::Filter, nil] Optionally, filter the results by `chart` or `topCountries`. See example respons
         #

data/lib/onlyfans/models/statistics/statement_get_earnings_params.rb

@@ -13,17 +13,17 @@ module Onlyfans
         #   @return [String]
         required :account, String
 
-        # @!attribute start_date
-        #   The start date for the period
+        # @!attribute end_date
+        #   The end date for the period.
         #
         #   @return [String]
-        required :start_date, String
+        required :end_date, String
 
-        # @!attribute end_date
-        #   The end date for the period.
+        # @!attribute start_date
+        #   The start date for the period.
         #
-        #   @return [String, nil]
-        optional :end_date, String
+        #   @return [String]
+        required :start_date, String
 
         # @!attribute type
         #   Filter by All / Subscriptions / Tips / Posts / Messages / Streams
@@ -31,13 +31,13 @@ module Onlyfans
         #   @return [Symbol, Onlyfans::Models::Statistics::StatementGetEarningsParams::Type, nil]
         optional :type, enum: -> { Onlyfans::Statistics::StatementGetEarningsParams::Type }
 
-        # @!method initialize(account:, start_date:, end_date: nil, type: nil, request_options: {})
+        # @!method initialize(account:, end_date:, start_date:, type: nil, request_options: {})
         #   @param account [String]
         #
-        #   @param start_date [String] The start date for the period
-        #
         #   @param end_date [String] The end date for the period.
         #
+        #   @param start_date [String] The start date for the period.
+        #
         #   @param type [Symbol, Onlyfans::Models::Statistics::StatementGetEarningsParams::Type] Filter by All / Subscriptions / Tips / Posts / Messages / Streams
         #
         #   @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]

data/lib/onlyfans/models/stored_list_tracking_links_response.rb

@@ -301,6 +301,11 @@ module Onlyfans
             #   @return [String, nil]
             optional :calculated_at, String, api_name: :calculatedAt
 
+            # @!attribute chargebacks
+            #
+            #   @return [Integer, nil]
+            optional :chargebacks, Integer
+
             # @!attribute is_loading
             #
             #   @return [Boolean, nil]
@@ -326,8 +331,9 @@ module Onlyfans
             #   @return [Integer, nil]
             optional :total, Integer
 
-            # @!method initialize(calculated_at: nil, is_loading: nil, revenue_per_click: nil, revenue_per_subscriber: nil, spenders_count: nil, total: nil)
+            # @!method initialize(calculated_at: nil, chargebacks: nil, is_loading: nil, revenue_per_click: nil, revenue_per_subscriber: nil, spenders_count: nil, total: nil)
             #   @param calculated_at [String]
+            #   @param chargebacks [Integer]
             #   @param is_loading [Boolean]
             #   @param revenue_per_click [Float]
             #   @param revenue_per_subscriber [Integer]

data/lib/onlyfans/models/stored_list_trial_links_response.rb

@@ -313,6 +313,11 @@ module Onlyfans
             #   @return [String, nil]
             optional :calculated_at, String, api_name: :calculatedAt
 
+            # @!attribute chargebacks
+            #
+            #   @return [Float, nil]
+            optional :chargebacks, Float
+
             # @!attribute is_loading
             #
             #   @return [Boolean, nil]
@@ -333,8 +338,9 @@ module Onlyfans
             #   @return [Float, nil]
             optional :total, Float
 
-            # @!method initialize(calculated_at: nil, is_loading: nil, revenue_per_subscriber: nil, spenders_count: nil, total: nil)
+            # @!method initialize(calculated_at: nil, chargebacks: nil, is_loading: nil, revenue_per_subscriber: nil, spenders_count: nil, total: nil)
             #   @param calculated_at [String]
+            #   @param chargebacks [Float]
             #   @param is_loading [Boolean]
             #   @param revenue_per_subscriber [Float]
             #   @param spenders_count [Integer]

data/lib/onlyfans/models/story_create_params.rb

@@ -13,21 +13,308 @@ module Onlyfans
       required :account, String
 
       # @!attribute media_files
-      #   Array of media file upload prefixed_ids, or OF media IDs (required if price is
-      #   not 0).
+      #   Array of media file upload prefixed_ids, or OF vault media IDs.
       #
       #   @return [Array<String>]
       required :media_files, Onlyfans::Internal::Type::ArrayOf[String], api_name: :mediaFiles
 
-      # @!method initialize(account:, media_files:, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Onlyfans::Models::StoryCreateParams} for more details.
+      # @!attribute canvas_height
+      #   Canvas height overlay positions are relative to. Default `1920`.
       #
+      #   @return [Integer, nil]
+      optional :canvas_height, Integer, api_name: :canvasHeight
+
+      # @!attribute canvas_width
+      #   Canvas width overlay positions are relative to. Default `1080`.
+      #
+      #   @return [Integer, nil]
+      optional :canvas_width, Integer, api_name: :canvasWidth
+
+      # @!attribute question
+      #   Interactive question sticker viewers can answer.
+      #
+      #   @return [Onlyfans::Models::StoryCreateParams::Question, nil]
+      optional :question, -> { Onlyfans::StoryCreateParams::Question }
+
+      # @!attribute texts
+      #   Text and @mention overlays.
+      #
+      #   @return [Array<Onlyfans::Models::StoryCreateParams::Text>, nil]
+      optional :texts, -> { Onlyfans::Internal::Type::ArrayOf[Onlyfans::StoryCreateParams::Text] }
+
+      # @!method initialize(account:, media_files:, canvas_height: nil, canvas_width: nil, question: nil, texts: nil, request_options: {})
       #   @param account [String]
       #
-      #   @param media_files [Array<String>] Array of media file upload prefixed_ids, or OF media IDs (required if price is n
+      #   @param media_files [Array<String>] Array of media file upload prefixed_ids, or OF vault media IDs.
+      #
+      #   @param canvas_height [Integer] Canvas height overlay positions are relative to. Default `1920`.
+      #
+      #   @param canvas_width [Integer] Canvas width overlay positions are relative to. Default `1080`.
+      #
+      #   @param question [Onlyfans::Models::StoryCreateParams::Question] Interactive question sticker viewers can answer.
+      #
+      #   @param texts [Array<Onlyfans::Models::StoryCreateParams::Text>] Text and @mention overlays.
       #
       #   @param request_options [Onlyfans::RequestOptions, Hash{Symbol=>Object}]
+
+      class Question < Onlyfans::Internal::Type::BaseModel
+        # @!attribute color
+        #   Sticker accent color (hex). Default `#FF51DC`.
+        #
+        #   @return [String, nil]
+        optional :color, String
+
+        # @!attribute height
+        #   Sticker height in canvas px. Default `160`.
+        #
+        #   @return [Float, nil]
+        optional :height, Float
+
+        # @!attribute left
+        #   Horizontal position as a percentage of the canvas width (0-100). Default `25`.
+        #
+        #   @return [Float, nil]
+        optional :left, Float
+
+        # @!attribute text
+        #   The question to ask.
+        #
+        #   @return [String, nil]
+        optional :text, String
+
+        # @!attribute top
+        #   Vertical position as a percentage of the canvas height (0-100). Default `30`.
+        #
+        #   @return [Float, nil]
+        optional :top, Float
+
+        # @!attribute width
+        #   Sticker width in canvas px. Default `257`.
+        #
+        #   @return [Float, nil]
+        optional :width, Float
+
+        # @!method initialize(color: nil, height: nil, left: nil, text: nil, top: nil, width: nil)
+        #   Interactive question sticker viewers can answer.
+        #
+        #   @param color [String] Sticker accent color (hex). Default `#FF51DC`.
+        #
+        #   @param height [Float] Sticker height in canvas px. Default `160`.
+        #
+        #   @param left [Float] Horizontal position as a percentage of the canvas width (0-100). Default `25`.
+        #
+        #   @param text [String] The question to ask.
+        #
+        #   @param top [Float] Vertical position as a percentage of the canvas height (0-100). Default `30`.
+        #
+        #   @param width [Float] Sticker width in canvas px. Default `257`.
+      end
+
+      class Text < Onlyfans::Internal::Type::BaseModel
+        # @!attribute text
+        #   The overlay text. For mentions this must be the `@username` to mention (OnlyFans
+        #   resolves the user and adds them to the story's release forms).
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute angle
+        #   Rotation in degrees. Default `0`.
+        #
+        #   @return [Float, nil]
+        optional :angle, Float
+
+        # @!attribute bg_color
+        #   Background color (hex, `#00000000` = transparent). Native editor palette:
+        #   #FFFFFF #000000 #69818C #FF51DC #FF4081 #FA3240 #FF8040 #FCA800 #70CF27 #00C864
+        #   #00B1CC #2196F3 #7953F5 #A832BF. Default: transparent for texts, white for
+        #   mentions.
+        #
+        #   @return [String, nil]
+        optional :bg_color, String, api_name: :bgColor
+
+        # @!attribute color
+        #   Text color (hex). Defaults to the native editor behavior: white on a colored
+        #   background, black on a white background (mentions: OnlyFans blue `#0091EA` on
+        #   white).
+        #
+        #   @return [String, nil]
+        optional :color, String
+
+        # @!attribute font_family
+        #   Font family. Families support specific weights only: Roboto (400/500/700),
+        #   PTMono (400), ShantellSans (400), SofiaSans (400, renders uppercase),
+        #   YanoneKaffeesatz (700), RubikMedium (500), RubikBlack (700). Default `Roboto`.
+        #   Ignored for mentions (always Roboto 500).
+        #
+        #   @return [Symbol, Onlyfans::Models::StoryCreateParams::Text::FontFamily, nil]
+        optional :font_family,
+                 enum: -> {
+                   Onlyfans::StoryCreateParams::Text::FontFamily
+                 },
+                 api_name: :fontFamily
+
+        # @!attribute font_size
+        #   Font size in canvas px (8-100). The native editor uses 9-36. Default `20`.
+        #
+        #   @return [Float, nil]
+        optional :font_size, Float, api_name: :fontSize
+
+        # @!attribute font_weight
+        #   Font weight; must match the chosen family (see `fontFamily`).
+        #
+        #   @return [Integer, Onlyfans::Models::StoryCreateParams::Text::FontWeight, nil]
+        optional :font_weight,
+                 enum: -> {
+                   Onlyfans::StoryCreateParams::Text::FontWeight
+                 },
+                 api_name: :fontWeight
+
+        # @!attribute left
+        #   Horizontal position as a percentage of the canvas width (0-100). Default `25`.
+        #
+        #   @return [Float, nil]
+        optional :left, Float
+
+        # @!attribute scale
+        #   Scale factor. Default `1`.
+        #
+        #   @return [Float, nil]
+        optional :scale, Float
+
+        # @!attribute text_align
+        #   Text alignment. Default `left`.
+        #
+        #   @return [Symbol, Onlyfans::Models::StoryCreateParams::Text::TextAlign, nil]
+        optional :text_align, enum: -> { Onlyfans::StoryCreateParams::Text::TextAlign }, api_name: :textAlign
+
+        # @!attribute text_height
+        #   Rendered text box height in canvas px. Estimated automatically when omitted.
+        #
+        #   @return [Float, nil]
+        optional :text_height, Float, api_name: :textHeight
+
+        # @!attribute text_width
+        #   Rendered text box width in canvas px. Estimated automatically when omitted.
+        #
+        #   @return [Float, nil]
+        optional :text_width, Float, api_name: :textWidth
+
+        # @!attribute top
+        #   Vertical position as a percentage of the canvas height (0-100). Defaults stagger
+        #   each overlay below the previous one.
+        #
+        #   @return [Float, nil]
+        optional :top, Float
+
+        # @!attribute type
+        #   Overlay type. Default `text`.
+        #
+        #   @return [Symbol, Onlyfans::Models::StoryCreateParams::Text::Type, nil]
+        optional :type, enum: -> { Onlyfans::StoryCreateParams::Text::Type }
+
+        # @!attribute z_index
+        #   Stacking order. Defaults to placement order.
+        #
+        #   @return [Integer, nil]
+        optional :z_index, Integer, api_name: :zIndex
+
+        # @!method initialize(text:, angle: nil, bg_color: nil, color: nil, font_family: nil, font_size: nil, font_weight: nil, left: nil, scale: nil, text_align: nil, text_height: nil, text_width: nil, top: nil, type: nil, z_index: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Onlyfans::Models::StoryCreateParams::Text} for more details.
+        #
+        #   @param text [String] The overlay text. For mentions this must be the `@username` to mention (OnlyFans
+        #
+        #   @param angle [Float] Rotation in degrees. Default `0`.
+        #
+        #   @param bg_color [String] Background color (hex, `#00000000` = transparent). Native editor palette: #FFFFF
+        #
+        #   @param color [String] Text color (hex). Defaults to the native editor behavior: white on a colored bac
+        #
+        #   @param font_family [Symbol, Onlyfans::Models::StoryCreateParams::Text::FontFamily] Font family. Families support specific weights only: Roboto (400/500/700), PTMon
+        #
+        #   @param font_size [Float] Font size in canvas px (8-100). The native editor uses 9-36. Default `20`.
+        #
+        #   @param font_weight [Integer, Onlyfans::Models::StoryCreateParams::Text::FontWeight] Font weight; must match the chosen family (see `fontFamily`).
+        #
+        #   @param left [Float] Horizontal position as a percentage of the canvas width (0-100). Default `25`.
+        #
+        #   @param scale [Float] Scale factor. Default `1`.
+        #
+        #   @param text_align [Symbol, Onlyfans::Models::StoryCreateParams::Text::TextAlign] Text alignment. Default `left`.
+        #
+        #   @param text_height [Float] Rendered text box height in canvas px. Estimated automatically when omitted.
+        #
+        #   @param text_width [Float] Rendered text box width in canvas px. Estimated automatically when omitted.
+        #
+        #   @param top [Float] Vertical position as a percentage of the canvas height (0-100). Defaults stagger
+        #
+        #   @param type [Symbol, Onlyfans::Models::StoryCreateParams::Text::Type] Overlay type. Default `text`.
+        #
+        #   @param z_index [Integer] Stacking order. Defaults to placement order.
+
+        # Font family. Families support specific weights only: Roboto (400/500/700),
+        # PTMono (400), ShantellSans (400), SofiaSans (400, renders uppercase),
+        # YanoneKaffeesatz (700), RubikMedium (500), RubikBlack (700). Default `Roboto`.
+        # Ignored for mentions (always Roboto 500).
+        #
+        # @see Onlyfans::Models::StoryCreateParams::Text#font_family
+        module FontFamily
+          extend Onlyfans::Internal::Type::Enum
+
+          ROBOTO = :Roboto
+          PT_MONO = :PTMono
+          SHANTELL_SANS = :ShantellSans
+          SOFIA_SANS = :SofiaSans
+          YANONE_KAFFEESATZ = :YanoneKaffeesatz
+          RUBIK_MEDIUM = :RubikMedium
+          RUBIK_BLACK = :RubikBlack
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Font weight; must match the chosen family (see `fontFamily`).
+        #
+        # @see Onlyfans::Models::StoryCreateParams::Text#font_weight
+        module FontWeight
+          extend Onlyfans::Internal::Type::Enum
+
+          FONT_WEIGHT_400 = 400
+          FONT_WEIGHT_500 = 500
+          FONT_WEIGHT_700 = 700
+
+          # @!method self.values
+          #   @return [Array<Integer>]
+        end
+
+        # Text alignment. Default `left`.
+        #
+        # @see Onlyfans::Models::StoryCreateParams::Text#text_align
+        module TextAlign
+          extend Onlyfans::Internal::Type::Enum
+
+          LEFT = :left
+          CENTER = :center
+          RIGHT = :right
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Overlay type. Default `text`.
+        #
+        # @see Onlyfans::Models::StoryCreateParams::Text#type
+        module Type
+          extend Onlyfans::Internal::Type::Enum
+
+          TEXT = :text
+          MENTION = :mention
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end