x-twitter-scraper 0.3.0

data/lib/x_twitter_scraper/models/credit_topup_balance_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Credits#topup_balance
+    class CreditTopupBalanceResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute success
+      #
+      #   @return [Boolean, true]
+      required :success, const: true
+
+      # @!method initialize(success: true)
+      #   @param success [Boolean, true]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/delivery.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class Delivery < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attempts
+      #
+      #   @return [Integer]
+      required :attempts, Integer
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute status
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute stream_event_id
+      #
+      #   @return [String]
+      required :stream_event_id, String, api_name: :streamEventId
+
+      # @!attribute delivered_at
+      #
+      #   @return [Time, nil]
+      optional :delivered_at, Time, api_name: :deliveredAt
+
+      # @!attribute last_error
+      #
+      #   @return [String, nil]
+      optional :last_error, String, api_name: :lastError
+
+      # @!attribute last_status_code
+      #
+      #   @return [Integer, nil]
+      optional :last_status_code, Integer, api_name: :lastStatusCode
+
+      # @!method initialize(id:, attempts:, created_at:, status:, stream_event_id:, delivered_at: nil, last_error: nil, last_status_code: nil)
+      #   @param id [String]
+      #   @param attempts [Integer]
+      #   @param created_at [Time]
+      #   @param status [String]
+      #   @param stream_event_id [String]
+      #   @param delivered_at [Time]
+      #   @param last_error [String]
+      #   @param last_status_code [Integer]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class Draft < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(id:, created_at:, text:, goal: nil, topic: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param text [String]
+      #   @param goal [String]
+      #   @param topic [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_create_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#create
+    class DraftCreateParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute goal
+      #
+      #   @return [Symbol, XTwitterScraper::Models::DraftCreateParams::Goal, nil]
+      optional :goal, enum: -> { XTwitterScraper::DraftCreateParams::Goal }
+
+      # @!attribute topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(text:, goal: nil, topic: nil, request_options: {})
+      #   @param text [String]
+      #   @param goal [Symbol, XTwitterScraper::Models::DraftCreateParams::Goal]
+      #   @param topic [String]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      module Goal
+        extend XTwitterScraper::Internal::Type::Enum
+
+        ENGAGEMENT = :engagement
+        FOLLOWERS = :followers
+        AUTHORITY = :authority
+        CONVERSATION = :conversation
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_create_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#create
+    class DraftCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(id:, created_at:, text:, updated_at:, goal: nil, topic: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param text [String]
+      #   @param updated_at [Time]
+      #   @param goal [String]
+      #   @param topic [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#delete
+    class DraftDeleteParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_detail.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class DraftDetail < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(id:, created_at:, text:, updated_at:, goal: nil, topic: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param text [String]
+      #   @param updated_at [Time]
+      #   @param goal [String]
+      #   @param topic [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_list_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#list
+    class DraftListParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute after_cursor
+      #   Cursor for pagination
+      #
+      #   @return [String, nil]
+      optional :after_cursor, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after_cursor: nil, limit: nil, request_options: {})
+      #   @param after_cursor [String] Cursor for pagination
+      #
+      #   @param limit [Integer]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_list_response.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#list
+    class DraftListResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute drafts
+      #
+      #   @return [Array<XTwitterScraper::Models::DraftListResponse::Draft>]
+      required :drafts,
+               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::DraftListResponse::Draft] }
+
+      # @!attribute has_more
+      #
+      #   @return [Boolean]
+      required :has_more, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMore
+
+      # @!attribute next_cursor
+      #
+      #   @return [String, nil]
+      optional :next_cursor, String, api_name: :nextCursor
+
+      # @!method initialize(drafts:, has_more:, next_cursor: nil)
+      #   @param drafts [Array<XTwitterScraper::Models::DraftListResponse::Draft>]
+      #   @param has_more [Boolean]
+      #   @param next_cursor [String]
+
+      class Draft < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time, api_name: :createdAt
+
+        # @!attribute text
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute goal
+        #
+        #   @return [String, nil]
+        optional :goal, String
+
+        # @!attribute topic
+        #
+        #   @return [String, nil]
+        optional :topic, String
+
+        # @!method initialize(id:, created_at:, text:, goal: nil, topic: nil)
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param text [String]
+        #   @param goal [String]
+        #   @param topic [String]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#retrieve
+    class DraftRetrieveParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draft_retrieve_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Drafts#retrieve
+    class DraftRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute text
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time, api_name: :updatedAt
+
+      # @!attribute goal
+      #
+      #   @return [String, nil]
+      optional :goal, String
+
+      # @!attribute topic
+      #
+      #   @return [String, nil]
+      optional :topic, String
+
+      # @!method initialize(id:, created_at:, text:, updated_at:, goal: nil, topic: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param text [String]
+      #   @param updated_at [Time]
+      #   @param goal [String]
+      #   @param topic [String]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draw_detail.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class DrawDetail < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute status
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute total_entries
+      #
+      #   @return [Integer]
+      required :total_entries, Integer, api_name: :totalEntries
+
+      # @!attribute tweet_author_username
+      #
+      #   @return [String]
+      required :tweet_author_username, String, api_name: :tweetAuthorUsername
+
+      # @!attribute tweet_id
+      #
+      #   @return [String]
+      required :tweet_id, String, api_name: :tweetId
+
+      # @!attribute tweet_like_count
+      #
+      #   @return [Integer]
+      required :tweet_like_count, Integer, api_name: :tweetLikeCount
+
+      # @!attribute tweet_quote_count
+      #
+      #   @return [Integer]
+      required :tweet_quote_count, Integer, api_name: :tweetQuoteCount
+
+      # @!attribute tweet_reply_count
+      #
+      #   @return [Integer]
+      required :tweet_reply_count, Integer, api_name: :tweetReplyCount
+
+      # @!attribute tweet_retweet_count
+      #
+      #   @return [Integer]
+      required :tweet_retweet_count, Integer, api_name: :tweetRetweetCount
+
+      # @!attribute tweet_text
+      #
+      #   @return [String]
+      required :tweet_text, String, api_name: :tweetText
+
+      # @!attribute tweet_url
+      #
+      #   @return [String]
+      required :tweet_url, String, api_name: :tweetUrl
+
+      # @!attribute valid_entries
+      #
+      #   @return [Integer]
+      required :valid_entries, Integer, api_name: :validEntries
+
+      # @!attribute drawn_at
+      #
+      #   @return [Time, nil]
+      optional :drawn_at, Time, api_name: :drawnAt
+
+      # @!method initialize(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)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param status [String]
+      #   @param total_entries [Integer]
+      #   @param tweet_author_username [String]
+      #   @param tweet_id [String]
+      #   @param tweet_like_count [Integer]
+      #   @param tweet_quote_count [Integer]
+      #   @param tweet_reply_count [Integer]
+      #   @param tweet_retweet_count [Integer]
+      #   @param tweet_text [String]
+      #   @param tweet_url [String]
+      #   @param valid_entries [Integer]
+      #   @param drawn_at [Time]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draw_export_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Draws#export
+    class DrawExportParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute format_
+      #
+      #   @return [Symbol, XTwitterScraper::Models::DrawExportParams::Format, nil]
+      optional :format_, enum: -> { XTwitterScraper::DrawExportParams::Format }
+
+      # @!attribute type
+      #   Export winners or all entries
+      #
+      #   @return [Symbol, XTwitterScraper::Models::DrawExportParams::Type, nil]
+      optional :type, enum: -> { XTwitterScraper::DrawExportParams::Type }
+
+      # @!method initialize(id:, format_: nil, type: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param format_ [Symbol, XTwitterScraper::Models::DrawExportParams::Format]
+      #
+      #   @param type [Symbol, XTwitterScraper::Models::DrawExportParams::Type] Export winners or all entries
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+
+      module Format
+        extend XTwitterScraper::Internal::Type::Enum
+
+        CSV = :csv
+        JSON = :json
+        MD = :md
+        MD_DOCUMENT = :"md-document"
+        PDF = :pdf
+        TXT = :txt
+        XLSX = :xlsx
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Export winners or all entries
+      module Type
+        extend XTwitterScraper::Internal::Type::Enum
+
+        WINNERS = :winners
+        ENTRIES = :entries
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draw_list_item.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    class DrawListItem < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time, api_name: :createdAt
+
+      # @!attribute status
+      #
+      #   @return [String]
+      required :status, String
+
+      # @!attribute total_entries
+      #
+      #   @return [Integer]
+      required :total_entries, Integer, api_name: :totalEntries
+
+      # @!attribute tweet_url
+      #
+      #   @return [String]
+      required :tweet_url, String, api_name: :tweetUrl
+
+      # @!attribute valid_entries
+      #
+      #   @return [Integer]
+      required :valid_entries, Integer, api_name: :validEntries
+
+      # @!attribute drawn_at
+      #
+      #   @return [Time, nil]
+      optional :drawn_at, Time, api_name: :drawnAt
+
+      # @!method initialize(id:, created_at:, status:, total_entries:, tweet_url:, valid_entries:, drawn_at: nil)
+      #   @param id [String]
+      #   @param created_at [Time]
+      #   @param status [String]
+      #   @param total_entries [Integer]
+      #   @param tweet_url [String]
+      #   @param valid_entries [Integer]
+      #   @param drawn_at [Time]
+    end
+  end
+end

data/lib/x_twitter_scraper/models/draw_list_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    # @see XTwitterScraper::Resources::Draws#list
+    class DrawListParams < XTwitterScraper::Internal::Type::BaseModel
+      extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+      include XTwitterScraper::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   Cursor for pagination
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute limit
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(after: nil, limit: nil, request_options: {})
+      #   @param after [String] Cursor for pagination
+      #
+      #   @param limit [Integer]
+      #
+      #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end