x-twitter-scraper 0.5.5 → 0.7.0

data/lib/x_twitter_scraper/models/support/ticket_list_response.rb

@@ -11,51 +11,64 @@ module XTwitterScraper
       class TicketListResponse < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute tickets
         #
-        #   @return [Array<XTwitterScraper::Models::Support::TicketListResponse::Ticket>, nil]
-        optional :tickets,
+        #   @return [Array<XTwitterScraper::Models::Support::TicketListResponse::Ticket>]
+        required :tickets,
                  -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::Support::TicketListResponse::Ticket] }
 
-        # @!method initialize(tickets: nil)
+        # @!method initialize(tickets:)
         #   @param tickets [Array<XTwitterScraper::Models::Support::TicketListResponse::Ticket>]
 
         class Ticket < XTwitterScraper::Internal::Type::BaseModel
           # @!attribute created_at
           #
-          #   @return [Time, nil]
-          optional :created_at, Time, api_name: :createdAt
+          #   @return [Time]
+          required :created_at, Time, api_name: :createdAt
 
           # @!attribute message_count
           #
-          #   @return [Integer, nil]
-          optional :message_count, Integer, api_name: :messageCount
+          #   @return [Integer]
+          required :message_count, Integer, api_name: :messageCount
 
           # @!attribute public_id
           #
-          #   @return [String, nil]
-          optional :public_id, String, api_name: :publicId
+          #   @return [String]
+          required :public_id, String, api_name: :publicId
 
           # @!attribute status
           #
-          #   @return [String, nil]
-          optional :status, String
+          #   @return [Symbol, XTwitterScraper::Models::Support::TicketListResponse::Ticket::Status]
+          required :status, enum: -> { XTwitterScraper::Models::Support::TicketListResponse::Ticket::Status }
 
           # @!attribute subject
           #
-          #   @return [String, nil]
-          optional :subject, String
+          #   @return [String]
+          required :subject, String
 
           # @!attribute updated_at
           #
-          #   @return [Time, nil]
-          optional :updated_at, Time, api_name: :updatedAt
+          #   @return [Time]
+          required :updated_at, Time, api_name: :updatedAt
 
-          # @!method initialize(created_at: nil, message_count: nil, public_id: nil, status: nil, subject: nil, updated_at: nil)
+          # @!method initialize(created_at:, message_count:, public_id:, status:, subject:, updated_at:)
           #   @param created_at [Time]
           #   @param message_count [Integer]
           #   @param public_id [String]
-          #   @param status [String]
+          #   @param status [Symbol, XTwitterScraper::Models::Support::TicketListResponse::Ticket::Status]
           #   @param subject [String]
           #   @param updated_at [Time]
+
+          # @see XTwitterScraper::Models::Support::TicketListResponse::Ticket#status
+          module Status
+            extend XTwitterScraper::Internal::Type::Enum
+
+            OPEN = :open
+            IN_PROGRESS = :in_progress
+            RESOLVED = :resolved
+            CLOSED = :closed
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
         end
       end
     end

data/lib/x_twitter_scraper/models/support/ticket_retrieve_response.rb

@@ -11,70 +11,70 @@ module XTwitterScraper
       class TicketRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute created_at
         #
-        #   @return [Time, nil]
-        optional :created_at, Time, api_name: :createdAt
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
 
         # @!attribute messages
         #
-        #   @return [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message>, nil]
-        optional :messages,
+        #   @return [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message>]
+        required :messages,
                  -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::Support::TicketRetrieveResponse::Message] }
 
         # @!attribute public_id
         #
-        #   @return [String, nil]
-        optional :public_id, String, api_name: :publicId
+        #   @return [String]
+        required :public_id, String, api_name: :publicId
 
         # @!attribute status
         #
-        #   @return [String, nil]
-        optional :status, String
+        #   @return [Symbol, XTwitterScraper::Models::Support::TicketRetrieveResponse::Status]
+        required :status, enum: -> { XTwitterScraper::Models::Support::TicketRetrieveResponse::Status }
 
         # @!attribute subject
         #
-        #   @return [String, nil]
-        optional :subject, String
+        #   @return [String]
+        required :subject, String
 
         # @!attribute updated_at
         #
-        #   @return [Time, nil]
-        optional :updated_at, Time, api_name: :updatedAt
+        #   @return [Time]
+        required :updated_at, Time, api_name: :updatedAt
 
-        # @!method initialize(created_at: nil, messages: nil, public_id: nil, status: nil, subject: nil, updated_at: nil)
+        # @!method initialize(created_at:, messages:, public_id:, status:, subject:, updated_at:)
         #   @param created_at [Time]
         #   @param messages [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message>]
         #   @param public_id [String]
-        #   @param status [String]
+        #   @param status [Symbol, XTwitterScraper::Models::Support::TicketRetrieveResponse::Status]
         #   @param subject [String]
         #   @param updated_at [Time]
 
         class Message < XTwitterScraper::Internal::Type::BaseModel
           # @!attribute attachments
           #
-          #   @return [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Attachment>, nil]
-          optional :attachments,
+          #   @return [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Attachment>]
+          required :attachments,
                    -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Attachment] }
 
           # @!attribute body
           #
-          #   @return [String, nil]
-          optional :body, String
+          #   @return [String]
+          required :body, String
 
           # @!attribute created_at
           #
-          #   @return [Time, nil]
-          optional :created_at, Time, api_name: :createdAt
+          #   @return [Time]
+          required :created_at, Time, api_name: :createdAt
 
           # @!attribute sender
           #
-          #   @return [String, nil]
-          optional :sender, String
+          #   @return [Symbol, XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Sender]
+          required :sender, enum: -> { XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Sender }
 
-          # @!method initialize(attachments: nil, body: nil, created_at: nil, sender: nil)
+          # @!method initialize(attachments:, body:, created_at:, sender:)
           #   @param attachments [Array<XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Attachment>]
           #   @param body [String]
           #   @param created_at [Time]
-          #   @param sender [String]
+          #   @param sender [Symbol, XTwitterScraper::Models::Support::TicketRetrieveResponse::Message::Sender]
 
           class Attachment < XTwitterScraper::Internal::Type::BaseModel
             # @!attribute content_type
@@ -181,6 +181,31 @@ module XTwitterScraper
               #   @return [Array<Symbol>]
             end
           end
+
+          # @see XTwitterScraper::Models::Support::TicketRetrieveResponse::Message#sender
+          module Sender
+            extend XTwitterScraper::Internal::Type::Enum
+
+            USER = :user
+            SUPPORT = :support
+            SYSTEM = :system
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see XTwitterScraper::Models::Support::TicketRetrieveResponse#status
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          OPEN = :open
+          IN_PROGRESS = :in_progress
+          RESOLVED = :resolved
+          CLOSED = :closed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end

data/lib/x_twitter_scraper/models/support/ticket_update_response.rb

@@ -11,17 +11,29 @@ module XTwitterScraper
       class TicketUpdateResponse < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute public_id
         #
-        #   @return [String, nil]
-        optional :public_id, String, api_name: :publicId
+        #   @return [String]
+        required :public_id, String, api_name: :publicId
 
         # @!attribute status
         #
-        #   @return [String, nil]
-        optional :status, String
+        #   @return [Symbol, XTwitterScraper::Models::Support::TicketUpdateResponse::Status]
+        required :status, enum: -> { XTwitterScraper::Models::Support::TicketUpdateResponse::Status }
 
-        # @!method initialize(public_id: nil, status: nil)
+        # @!method initialize(public_id:, status:)
         #   @param public_id [String]
-        #   @param status [String]
+        #   @param status [Symbol, XTwitterScraper::Models::Support::TicketUpdateResponse::Status]
+
+        # @see XTwitterScraper::Models::Support::TicketUpdateResponse#status
+        module Status
+          extend XTwitterScraper::Internal::Type::Enum
+
+          OPEN = :open
+          RESOLVED = :resolved
+          CLOSED = :closed
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/x_twitter_scraper/models/trend_list_response.rb

@@ -40,6 +40,12 @@ module XTwitterScraper
         #   @return [String, nil]
         optional :description, String
 
+        # @!attribute promoted_content
+        #   Promotion identifier from X. Null for organic trends.
+        #
+        #   @return [String, nil]
+        optional :promoted_content, String, api_name: :promotedContent, nil?: true
+
         # @!attribute query
         #
         #   @return [String, nil]
@@ -50,11 +56,32 @@ module XTwitterScraper
         #   @return [Integer, nil]
         optional :rank, Integer
 
-        # @!method initialize(name:, description: nil, query: nil, rank: nil)
+        # @!attribute tweet_volume
+        #   Approximate public post volume when X supplies it.
+        #
+        #   @return [Integer, nil]
+        optional :tweet_volume, Integer, api_name: :tweetVolume, nil?: true
+
+        # @!attribute url
+        #   X search URL for the trend.
+        #
+        #   @return [String, nil]
+        optional :url, String
+
+        # @!method initialize(name:, description: nil, promoted_content: nil, query: nil, rank: nil, tweet_volume: nil, url: nil)
         #   @param name [String]
+        #
         #   @param description [String]
+        #
+        #   @param promoted_content [String, nil] Promotion identifier from X. Null for organic trends.
+        #
         #   @param query [String]
+        #
         #   @param rank [Integer]
+        #
+        #   @param tweet_volume [Integer, nil] Approximate public post volume when X supplies it.
+        #
+        #   @param url [String] X search URL for the trend.
       end
     end
   end

data/lib/x_twitter_scraper/models/tweet_media.rb

@@ -24,6 +24,102 @@ module XTwitterScraper
       #   @return [String]
       required :url, String
 
+      # @!attribute id
+      #   X media entity ID.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute allow_download
+      #   Whether X permits direct media download.
+      #
+      #   @return [Boolean, nil]
+      optional :allow_download, XTwitterScraper::Internal::Type::Boolean, api_name: :allowDownload
+
+      # @!attribute alt_text
+      #   Accessibility text supplied for the media.
+      #
+      #   @return [String, nil]
+      optional :alt_text, String, api_name: :altText
+
+      # @!attribute aspect_ratio
+      #   Video aspect ratio as width and height.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :aspect_ratio, XTwitterScraper::Internal::Type::ArrayOf[Integer], api_name: :aspectRatio
+
+      # @!attribute availability_status
+      #   Media availability state reported by X.
+      #
+      #   @return [String, nil]
+      optional :availability_status, String, api_name: :availabilityStatus
+
+      # @!attribute display_url
+      #   Display-friendly media URL reported by X.
+      #
+      #   @return [String, nil]
+      optional :display_url, String, api_name: :displayUrl
+
+      # @!attribute duration_millis
+      #   Video duration in milliseconds.
+      #
+      #   @return [Integer, nil]
+      optional :duration_millis, Integer, api_name: :durationMillis
+
+      # @!attribute expanded_url
+      #   Expanded X media URL.
+      #
+      #   @return [String, nil]
+      optional :expanded_url, String, api_name: :expandedUrl
+
+      # @!attribute face_rects
+      #   Face-aware crop rectangles grouped by media size.
+      #
+      #   @return [Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}, nil]
+      optional :face_rects,
+               -> {
+                 XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FaceRect]]
+               },
+               api_name: :faceRects
+
+      # @!attribute focus_rects
+      #   Suggested image crops reported by X.
+      #
+      #   @return [Array<XTwitterScraper::Models::TweetMedia::FocusRect>, nil]
+      optional :focus_rects,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::FocusRect] },
+               api_name: :focusRects
+
+      # @!attribute height
+      #   Original media height.
+      #
+      #   @return [Integer, nil]
+      optional :height, Integer
+
+      # @!attribute indices
+      #   Media entity offsets in the tweet text.
+      #
+      #   @return [Array<Integer>, nil]
+      optional :indices, XTwitterScraper::Internal::Type::ArrayOf[Integer]
+
+      # @!attribute media_key
+      #   Stable X media key.
+      #
+      #   @return [String, nil]
+      optional :media_key, String, api_name: :mediaKey
+
+      # @!attribute monetizable
+      #   Whether X reports the media as monetizable.
+      #
+      #   @return [Boolean, nil]
+      optional :monetizable, XTwitterScraper::Internal::Type::Boolean
+
+      # @!attribute sizes
+      #   Named media renditions and resize modes.
+      #
+      #   @return [Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}, nil]
+      optional :sizes, -> { XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::TweetMedia::Size] }
+
       # @!attribute video_variants
       #   Available video encodings, ordered as returned
       #
@@ -32,7 +128,13 @@ module XTwitterScraper
                -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::TweetMedia::VideoVariant] },
                api_name: :videoVariants
 
-      # @!method initialize(media_url:, type:, url:, video_variants: nil)
+      # @!attribute width
+      #   Original media width.
+      #
+      #   @return [Integer, nil]
+      optional :width, Integer
+
+      # @!method initialize(media_url:, type:, url:, id: nil, allow_download: nil, alt_text: nil, aspect_ratio: nil, availability_status: nil, display_url: nil, duration_millis: nil, expanded_url: nil, face_rects: nil, focus_rects: nil, height: nil, indices: nil, media_key: nil, monetizable: nil, sizes: nil, video_variants: nil, width: nil)
       #   Normalized media attached to a tweet.
       #
       #   @param media_url [String] Media preview URL
@@ -41,7 +143,39 @@ module XTwitterScraper
       #
       #   @param url [String] X media link from the tweet
       #
+      #   @param id [String] X media entity ID.
+      #
+      #   @param allow_download [Boolean] Whether X permits direct media download.
+      #
+      #   @param alt_text [String] Accessibility text supplied for the media.
+      #
+      #   @param aspect_ratio [Array<Integer>] Video aspect ratio as width and height.
+      #
+      #   @param availability_status [String] Media availability state reported by X.
+      #
+      #   @param display_url [String] Display-friendly media URL reported by X.
+      #
+      #   @param duration_millis [Integer] Video duration in milliseconds.
+      #
+      #   @param expanded_url [String] Expanded X media URL.
+      #
+      #   @param face_rects [Hash{Symbol=>Array<XTwitterScraper::Models::TweetMedia::FaceRect>}] Face-aware crop rectangles grouped by media size.
+      #
+      #   @param focus_rects [Array<XTwitterScraper::Models::TweetMedia::FocusRect>] Suggested image crops reported by X.
+      #
+      #   @param height [Integer] Original media height.
+      #
+      #   @param indices [Array<Integer>] Media entity offsets in the tweet text.
+      #
+      #   @param media_key [String] Stable X media key.
+      #
+      #   @param monetizable [Boolean] Whether X reports the media as monetizable.
+      #
+      #   @param sizes [Hash{Symbol=>XTwitterScraper::Models::TweetMedia::Size}] Named media renditions and resize modes.
+      #
       #   @param video_variants [Array<XTwitterScraper::Models::TweetMedia::VideoVariant>] Available video encodings, ordered as returned
+      #
+      #   @param width [Integer] Original media width.
 
       # @see XTwitterScraper::Models::TweetMedia#type
       module Type
@@ -55,6 +189,84 @@ module XTwitterScraper
         #   @return [Array<Symbol>]
       end
 
+      class FaceRect < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!attribute x
+        #
+        #   @return [Integer]
+        required :x, Integer
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer, api_name: :y
+
+        # @!method initialize(h:, w:, x:, y_:)
+        #   @param h [Integer]
+        #   @param w [Integer]
+        #   @param x [Integer]
+        #   @param y_ [Integer]
+      end
+
+      class FocusRect < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!attribute x
+        #
+        #   @return [Integer]
+        required :x, Integer
+
+        # @!attribute y_
+        #
+        #   @return [Integer]
+        required :y_, Integer, api_name: :y
+
+        # @!method initialize(h:, w:, x:, y_:)
+        #   @param h [Integer]
+        #   @param w [Integer]
+        #   @param x [Integer]
+        #   @param y_ [Integer]
+      end
+
+      class Size < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute h
+        #
+        #   @return [Integer]
+        required :h, Integer
+
+        # @!attribute resize
+        #
+        #   @return [String]
+        required :resize, String
+
+        # @!attribute w
+        #
+        #   @return [Integer]
+        required :w, Integer
+
+        # @!method initialize(h:, resize:, w:)
+        #   @param h [Integer]
+        #   @param resize [String]
+        #   @param w [Integer]
+      end
+
       class VideoVariant < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute content_type
         #