x-twitter-scraper 0.3.0

data/rbi/x_twitter_scraper/models/draw_export_params.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawExportParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::DrawExportParams,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        returns(T.nilable(XTwitterScraper::DrawExportParams::Format::OrSymbol))
+      end
+      attr_reader :format_
+
+      sig do
+        params(
+          format_: XTwitterScraper::DrawExportParams::Format::OrSymbol
+        ).void
+      end
+      attr_writer :format_
+
+      # Export winners or all entries
+      sig do
+        returns(T.nilable(XTwitterScraper::DrawExportParams::Type::OrSymbol))
+      end
+      attr_reader :type
+
+      sig do
+        params(type: XTwitterScraper::DrawExportParams::Type::OrSymbol).void
+      end
+      attr_writer :type
+
+      sig do
+        params(
+          id: String,
+          format_: XTwitterScraper::DrawExportParams::Format::OrSymbol,
+          type: XTwitterScraper::DrawExportParams::Type::OrSymbol,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        format_: nil,
+        # Export winners or all entries
+        type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            format_: XTwitterScraper::DrawExportParams::Format::OrSymbol,
+            type: XTwitterScraper::DrawExportParams::Type::OrSymbol,
+            request_options: XTwitterScraper::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Format
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, XTwitterScraper::DrawExportParams::Format)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CSV =
+          T.let(:csv, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+        JSON =
+          T.let(:json, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+        MD = T.let(:md, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+        MD_DOCUMENT =
+          T.let(
+            :"md-document",
+            XTwitterScraper::DrawExportParams::Format::TaggedSymbol
+          )
+        PDF =
+          T.let(:pdf, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+        TXT =
+          T.let(:txt, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+        XLSX =
+          T.let(:xlsx, XTwitterScraper::DrawExportParams::Format::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::DrawExportParams::Format::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Export winners or all entries
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, XTwitterScraper::DrawExportParams::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        WINNERS =
+          T.let(:winners, XTwitterScraper::DrawExportParams::Type::TaggedSymbol)
+        ENTRIES =
+          T.let(:entries, XTwitterScraper::DrawExportParams::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[XTwitterScraper::DrawExportParams::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/draw_list_item.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawListItem < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::DrawListItem,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      sig { returns(String) }
+      attr_accessor :status
+
+      sig { returns(Integer) }
+      attr_accessor :total_entries
+
+      sig { returns(String) }
+      attr_accessor :tweet_url
+
+      sig { returns(Integer) }
+      attr_accessor :valid_entries
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :drawn_at
+
+      sig { params(drawn_at: Time).void }
+      attr_writer :drawn_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          status: String,
+          total_entries: Integer,
+          tweet_url: String,
+          valid_entries: Integer,
+          drawn_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        status:,
+        total_entries:,
+        tweet_url:,
+        valid_entries:,
+        drawn_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            status: String,
+            total_entries: Integer,
+            tweet_url: String,
+            valid_entries: Integer,
+            drawn_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/draw_list_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawListParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::DrawListParams,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      # Cursor for pagination
+      sig { returns(T.nilable(String)) }
+      attr_reader :after
+
+      sig { params(after: String).void }
+      attr_writer :after
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          after: String,
+          limit: Integer,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Cursor for pagination
+        after: nil,
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after: String,
+            limit: Integer,
+            request_options: XTwitterScraper::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/draw_list_response.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawListResponse < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::Models::DrawListResponse,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[XTwitterScraper::Models::DrawListResponse::Draw]) }
+      attr_accessor :draws
+
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :next_cursor
+
+      sig { params(next_cursor: String).void }
+      attr_writer :next_cursor
+
+      sig do
+        params(
+          draws:
+            T::Array[XTwitterScraper::Models::DrawListResponse::Draw::OrHash],
+          has_more: T::Boolean,
+          next_cursor: String
+        ).returns(T.attached_class)
+      end
+      def self.new(draws:, has_more:, next_cursor: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            draws: T::Array[XTwitterScraper::Models::DrawListResponse::Draw],
+            has_more: T::Boolean,
+            next_cursor: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Draw < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::DrawListResponse::Draw,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { returns(Integer) }
+        attr_accessor :total_entries
+
+        sig { returns(String) }
+        attr_accessor :tweet_url
+
+        sig { returns(Integer) }
+        attr_accessor :valid_entries
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :drawn_at
+
+        sig { params(drawn_at: Time).void }
+        attr_writer :drawn_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            status: String,
+            total_entries: Integer,
+            tweet_url: String,
+            valid_entries: Integer,
+            drawn_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          status:,
+          total_entries:,
+          tweet_url:,
+          valid_entries:,
+          drawn_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              status: String,
+              total_entries: Integer,
+              tweet_url: String,
+              valid_entries: Integer,
+              drawn_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/draw_retrieve_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::DrawRetrieveParams,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig do
+        params(
+          id: String,
+          request_options: XTwitterScraper::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { id: String, request_options: XTwitterScraper::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/x_twitter_scraper/models/draw_retrieve_response.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module XTwitterScraper
+  module Models
+    class DrawRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            XTwitterScraper::Models::DrawRetrieveResponse,
+            XTwitterScraper::Internal::AnyHash
+          )
+        end
+
+      sig { returns(XTwitterScraper::Models::DrawRetrieveResponse::Draw) }
+      attr_reader :draw
+
+      sig do
+        params(
+          draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw::OrHash
+        ).void
+      end
+      attr_writer :draw
+
+      sig do
+        returns(T::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner])
+      end
+      attr_accessor :winners
+
+      sig do
+        params(
+          draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw::OrHash,
+          winners:
+            T::Array[
+              XTwitterScraper::Models::DrawRetrieveResponse::Winner::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(draw:, winners:)
+      end
+
+      sig do
+        override.returns(
+          {
+            draw: XTwitterScraper::Models::DrawRetrieveResponse::Draw,
+            winners:
+              T::Array[XTwitterScraper::Models::DrawRetrieveResponse::Winner]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Draw < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::DrawRetrieveResponse::Draw,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :status
+
+        sig { returns(Integer) }
+        attr_accessor :total_entries
+
+        sig { returns(String) }
+        attr_accessor :tweet_author_username
+
+        sig { returns(String) }
+        attr_accessor :tweet_id
+
+        sig { returns(Integer) }
+        attr_accessor :tweet_like_count
+
+        sig { returns(Integer) }
+        attr_accessor :tweet_quote_count
+
+        sig { returns(Integer) }
+        attr_accessor :tweet_reply_count
+
+        sig { returns(Integer) }
+        attr_accessor :tweet_retweet_count
+
+        sig { returns(String) }
+        attr_accessor :tweet_text
+
+        sig { returns(String) }
+        attr_accessor :tweet_url
+
+        sig { returns(Integer) }
+        attr_accessor :valid_entries
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :drawn_at
+
+        sig { params(drawn_at: Time).void }
+        attr_writer :drawn_at
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            status: String,
+            total_entries: Integer,
+            tweet_author_username: String,
+            tweet_id: String,
+            tweet_like_count: Integer,
+            tweet_quote_count: Integer,
+            tweet_reply_count: Integer,
+            tweet_retweet_count: Integer,
+            tweet_text: String,
+            tweet_url: String,
+            valid_entries: Integer,
+            drawn_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          status:,
+          total_entries:,
+          tweet_author_username:,
+          tweet_id:,
+          tweet_like_count:,
+          tweet_quote_count:,
+          tweet_reply_count:,
+          tweet_retweet_count:,
+          tweet_text:,
+          tweet_url:,
+          valid_entries:,
+          drawn_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              status: String,
+              total_entries: Integer,
+              tweet_author_username: String,
+              tweet_id: String,
+              tweet_like_count: Integer,
+              tweet_quote_count: Integer,
+              tweet_reply_count: Integer,
+              tweet_retweet_count: Integer,
+              tweet_text: String,
+              tweet_url: String,
+              valid_entries: Integer,
+              drawn_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Winner < XTwitterScraper::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              XTwitterScraper::Models::DrawRetrieveResponse::Winner,
+              XTwitterScraper::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :author_username
+
+        sig { returns(T::Boolean) }
+        attr_accessor :is_backup
+
+        sig { returns(Integer) }
+        attr_accessor :position
+
+        sig { returns(String) }
+        attr_accessor :tweet_id
+
+        sig do
+          params(
+            author_username: String,
+            is_backup: T::Boolean,
+            position: Integer,
+            tweet_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(author_username:, is_backup:, position:, tweet_id:)
+        end
+
+        sig do
+          override.returns(
+            {
+              author_username: String,
+              is_backup: T::Boolean,
+              position: Integer,
+              tweet_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end