x-twitter-scraper 0.4.5 → 0.5.2

data/rbi/x_twitter_scraper/models/compose_create_params.rbi

@@ -14,150 +14,40 @@ module XTwitterScraper
           )
         end
 
-      # Workflow step
-      sig { returns(XTwitterScraper::ComposeCreateParams::Step::OrSymbol) }
-      attr_accessor :step
-
-      # Extra context or URLs (refine)
-      sig { returns(T.nilable(String)) }
-      attr_reader :additional_context
-
-      sig { params(additional_context: String).void }
-      attr_writer :additional_context
-
-      # Desired call to action (refine)
-      sig { returns(T.nilable(String)) }
-      attr_reader :call_to_action
-
-      sig { params(call_to_action: String).void }
-      attr_writer :call_to_action
-
-      # Tweet draft text to evaluate (score)
-      sig { returns(T.nilable(String)) }
-      attr_reader :draft
-
-      sig { params(draft: String).void }
-      attr_writer :draft
-
-      # Optimization goal
-      sig do
-        returns(T.nilable(XTwitterScraper::ComposeCreateParams::Goal::OrSymbol))
-      end
-      attr_reader :goal
-
-      sig do
-        params(goal: XTwitterScraper::ComposeCreateParams::Goal::OrSymbol).void
-      end
-      attr_writer :goal
-
-      # Whether a link is attached (score)
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :has_link
-
-      sig { params(has_link: T::Boolean).void }
-      attr_writer :has_link
-
-      # Whether media is attached (score)
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :has_media
-
-      sig { params(has_media: T::Boolean).void }
-      attr_writer :has_media
-
-      # Media type (refine)
       sig do
         returns(
-          T.nilable(XTwitterScraper::ComposeCreateParams::MediaType::OrSymbol)
+          T.any(
+            XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest,
+            XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest,
+            XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest
+          )
         )
       end
-      attr_reader :media_type
-
-      sig do
-        params(
-          media_type: XTwitterScraper::ComposeCreateParams::MediaType::OrSymbol
-        ).void
-      end
-      attr_writer :media_type
-
-      # Cached style username for voice matching (compose)
-      sig { returns(T.nilable(String)) }
-      attr_reader :style_username
-
-      sig { params(style_username: String).void }
-      attr_writer :style_username
-
-      # Desired tone (refine)
-      sig { returns(T.nilable(String)) }
-      attr_reader :tone
-
-      sig { params(tone: String).void }
-      attr_writer :tone
-
-      # Tweet topic (compose, refine)
-      sig { returns(T.nilable(String)) }
-      attr_reader :topic
-
-      sig { params(topic: String).void }
-      attr_writer :topic
+      attr_accessor :body
 
       sig do
         params(
-          step: XTwitterScraper::ComposeCreateParams::Step::OrSymbol,
-          additional_context: String,
-          call_to_action: String,
-          draft: String,
-          goal: XTwitterScraper::ComposeCreateParams::Goal::OrSymbol,
-          has_link: T::Boolean,
-          has_media: T::Boolean,
-          media_type: XTwitterScraper::ComposeCreateParams::MediaType::OrSymbol,
-          style_username: String,
-          tone: String,
-          topic: String,
+          body:
+            T.any(
+              XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::OrHash,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::OrHash,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest::OrHash
+            ),
           request_options: XTwitterScraper::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(
-        # Workflow step
-        step:,
-        # Extra context or URLs (refine)
-        additional_context: nil,
-        # Desired call to action (refine)
-        call_to_action: nil,
-        # Tweet draft text to evaluate (score)
-        draft: nil,
-        # Optimization goal
-        goal: nil,
-        # Whether a link is attached (score)
-        has_link: nil,
-        # Whether media is attached (score)
-        has_media: nil,
-        # Media type (refine)
-        media_type: nil,
-        # Cached style username for voice matching (compose)
-        style_username: nil,
-        # Desired tone (refine)
-        tone: nil,
-        # Tweet topic (compose, refine)
-        topic: nil,
-        request_options: {}
-      )
+      def self.new(body:, request_options: {})
       end
 
       sig do
         override.returns(
           {
-            step: XTwitterScraper::ComposeCreateParams::Step::OrSymbol,
-            additional_context: String,
-            call_to_action: String,
-            draft: String,
-            goal: XTwitterScraper::ComposeCreateParams::Goal::OrSymbol,
-            has_link: T::Boolean,
-            has_media: T::Boolean,
-            media_type:
-              XTwitterScraper::ComposeCreateParams::MediaType::OrSymbol,
-            style_username: String,
-            tone: String,
-            topic: String,
+            body:
+              T.any(
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest
+              ),
             request_options: XTwitterScraper::RequestOptions
           }
         )
@@ -165,115 +55,402 @@ module XTwitterScraper
       def to_hash
       end
 
-      # Workflow step
-      module Step
-        extend XTwitterScraper::Internal::Type::Enum
+      module Body
+        extend XTwitterScraper::Internal::Type::Union
 
-        TaggedSymbol =
+        Variants =
           T.type_alias do
-            T.all(Symbol, XTwitterScraper::ComposeCreateParams::Step)
+            T.any(
+              XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest,
+              XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest
+            )
           end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-        COMPOSE =
-          T.let(
-            :compose,
-            XTwitterScraper::ComposeCreateParams::Step::TaggedSymbol
-          )
-        REFINE =
-          T.let(
-            :refine,
-            XTwitterScraper::ComposeCreateParams::Step::TaggedSymbol
-          )
-        SCORE =
-          T.let(
-            :score,
-            XTwitterScraper::ComposeCreateParams::Step::TaggedSymbol
-          )
+        class ComposePrepareRequest < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :step
+
+          # Subject for the post.
+          sig { returns(String) }
+          attr_accessor :topic
+
+          # Editorial goal used to order the rules and questions.
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::OrSymbol
+              )
+            )
+          end
+          attr_reader :goal
 
-        sig do
-          override.returns(
-            T::Array[XTwitterScraper::ComposeCreateParams::Step::TaggedSymbol]
+          sig do
+            params(
+              goal:
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::OrSymbol
+            ).void
+          end
+          attr_writer :goal
+
+          # Username from a style analysis saved to this account.
+          sig { returns(T.nilable(String)) }
+          attr_reader :style_username
+
+          sig { params(style_username: String).void }
+          attr_writer :style_username
+
+          sig do
+            params(
+              topic: String,
+              goal:
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::OrSymbol,
+              style_username: String,
+              step: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Subject for the post.
+            topic:,
+            # Editorial goal used to order the rules and questions.
+            goal: nil,
+            # Username from a style analysis saved to this account.
+            style_username: nil,
+            step: :compose
           )
+          end
+
+          sig do
+            override.returns(
+              {
+                step: Symbol,
+                topic: String,
+                goal:
+                  XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::OrSymbol,
+                style_username: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Editorial goal used to order the rules and questions.
+          module Goal
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENGAGEMENT =
+              T.let(
+                :engagement,
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::TaggedSymbol
+              )
+            FOLLOWERS =
+              T.let(
+                :followers,
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::TaggedSymbol
+              )
+            AUTHORITY =
+              T.let(
+                :authority,
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::TaggedSymbol
+              )
+            CONVERSATION =
+              T.let(
+                :conversation,
+                XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
-        def self.values
-        end
-      end
 
-      # Optimization goal
-      module Goal
-        extend XTwitterScraper::Internal::Type::Enum
+        class ComposeRefineRequest < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          # Editorial goal for the guidance.
+          sig do
+            returns(
+              XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::OrSymbol
+            )
+          end
+          attr_accessor :goal
 
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, XTwitterScraper::ComposeCreateParams::Goal)
+          sig { returns(Symbol) }
+          attr_accessor :step
+
+          # Requested writing tone.
+          sig { returns(String) }
+          attr_accessor :tone
+
+          # Subject for the post.
+          sig { returns(String) }
+          attr_accessor :topic
+
+          # Audience, constraints, sources, or other writing context.
+          sig { returns(T.nilable(String)) }
+          attr_reader :additional_context
+
+          sig { params(additional_context: String).void }
+          attr_writer :additional_context
+
+          # Specific action the draft should request.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_to_action
+
+          sig { params(call_to_action: String).void }
+          attr_writer :call_to_action
+
+          # Planned media type.
+          sig do
+            returns(
+              T.nilable(
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::OrSymbol
+              )
+            )
           end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
+          attr_reader :media_type
 
-        ENGAGEMENT =
-          T.let(
-            :engagement,
-            XTwitterScraper::ComposeCreateParams::Goal::TaggedSymbol
-          )
-        FOLLOWERS =
-          T.let(
-            :followers,
-            XTwitterScraper::ComposeCreateParams::Goal::TaggedSymbol
-          )
-        AUTHORITY =
-          T.let(
-            :authority,
-            XTwitterScraper::ComposeCreateParams::Goal::TaggedSymbol
-          )
-        CONVERSATION =
-          T.let(
-            :conversation,
-            XTwitterScraper::ComposeCreateParams::Goal::TaggedSymbol
+          sig do
+            params(
+              media_type:
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::OrSymbol
+            ).void
+          end
+          attr_writer :media_type
+
+          sig do
+            params(
+              goal:
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::OrSymbol,
+              tone: String,
+              topic: String,
+              additional_context: String,
+              call_to_action: String,
+              media_type:
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::OrSymbol,
+              step: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Editorial goal for the guidance.
+            goal:,
+            # Requested writing tone.
+            tone:,
+            # Subject for the post.
+            topic:,
+            # Audience, constraints, sources, or other writing context.
+            additional_context: nil,
+            # Specific action the draft should request.
+            call_to_action: nil,
+            # Planned media type.
+            media_type: nil,
+            step: :refine
           )
+          end
 
-        sig do
-          override.returns(
-            T::Array[XTwitterScraper::ComposeCreateParams::Goal::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
+          sig do
+            override.returns(
+              {
+                goal:
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::OrSymbol,
+                step: Symbol,
+                tone: String,
+                topic: String,
+                additional_context: String,
+                call_to_action: String,
+                media_type:
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::OrSymbol
+              }
+            )
+          end
+          def to_hash
+          end
 
-      # Media type (refine)
-      module MediaType
-        extend XTwitterScraper::Internal::Type::Enum
+          # Editorial goal for the guidance.
+          module Goal
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ENGAGEMENT =
+              T.let(
+                :engagement,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::TaggedSymbol
+              )
+            FOLLOWERS =
+              T.let(
+                :followers,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::TaggedSymbol
+              )
+            AUTHORITY =
+              T.let(
+                :authority,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::TaggedSymbol
+              )
+            CONVERSATION =
+              T.let(
+                :conversation,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
 
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, XTwitterScraper::ComposeCreateParams::MediaType)
+          # Planned media type.
+          module MediaType
+            extend XTwitterScraper::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PHOTO =
+              T.let(
+                :photo,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::TaggedSymbol
+              )
+            VIDEO =
+              T.let(
+                :video,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::TaggedSymbol
+              )
+            NONE =
+              T.let(
+                :none,
+                XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
+        end
 
-        PHOTO =
-          T.let(
-            :photo,
-            XTwitterScraper::ComposeCreateParams::MediaType::TaggedSymbol
-          )
-        VIDEO =
-          T.let(
-            :video,
-            XTwitterScraper::ComposeCreateParams::MediaType::TaggedSymbol
-          )
-        NONE =
-          T.let(
-            :none,
-            XTwitterScraper::ComposeCreateParams::MediaType::TaggedSymbol
+        class ComposeScoreRequest < XTwitterScraper::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                XTwitterScraper::ComposeCreateParams::Body::ComposeScoreRequest,
+                XTwitterScraper::Internal::AnyHash
+              )
+            end
+
+          # Full post text for deterministic editorial checks.
+          sig { returns(String) }
+          attr_accessor :draft
+
+          sig { returns(Symbol) }
+          attr_accessor :step
+
+          # True when a separate link card is attached.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_link
+
+          sig { params(has_link: T::Boolean).void }
+          attr_writer :has_link
+
+          # Accepted for backward compatibility. Text checks ignore this field.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_media
+
+          sig { params(has_media: T::Boolean).void }
+          attr_writer :has_media
+
+          sig do
+            params(
+              draft: String,
+              has_link: T::Boolean,
+              has_media: T::Boolean,
+              step: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Full post text for deterministic editorial checks.
+            draft:,
+            # True when a separate link card is attached.
+            has_link: nil,
+            # Accepted for backward compatibility. Text checks ignore this field.
+            has_media: nil,
+            step: :score
           )
+          end
+
+          sig do
+            override.returns(
+              {
+                draft: String,
+                step: Symbol,
+                has_link: T::Boolean,
+                has_media: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+        end
 
         sig do
           override.returns(
-            T::Array[
-              XTwitterScraper::ComposeCreateParams::MediaType::TaggedSymbol
-            ]
+            T::Array[XTwitterScraper::ComposeCreateParams::Body::Variants]
           )
         end
-        def self.values
+        def self.variants
         end
       end
     end