x-twitter-scraper 0.3.0

data/lib/x_twitter_scraper/models/x/communities/join_delete_all_response.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        # @see XTwitterScraper::Resources::X::Communities::Join#delete_all
+        class JoinDeleteAllResponse < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute community_id
+          #
+          #   @return [String]
+          required :community_id, String, api_name: :communityId
+
+          # @!attribute community_name
+          #
+          #   @return [String]
+          required :community_name, String, api_name: :communityName
+
+          # @!attribute success
+          #
+          #   @return [Boolean, true]
+          required :success, const: true
+
+          # @!method initialize(community_id:, community_name:, success: true)
+          #   @param community_id [String]
+          #   @param community_name [String]
+          #   @param success [Boolean, true]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/communities/tweet_list_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        # @see XTwitterScraper::Resources::X::Communities::Tweets#list
+        class TweetListParams < XTwitterScraper::Internal::Type::BaseModel
+          extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+          include XTwitterScraper::Internal::Type::RequestParameters
+
+          # @!attribute q
+          #   Search query
+          #
+          #   @return [String]
+          required :q, String
+
+          # @!attribute cursor
+          #   Pagination cursor
+          #
+          #   @return [String, nil]
+          optional :cursor, String
+
+          # @!attribute query_type
+          #   Sort order (Latest or Top)
+          #
+          #   @return [String, nil]
+          optional :query_type, String
+
+          # @!method initialize(q:, cursor: nil, query_type: nil, request_options: {})
+          #   @param q [String] Search query
+          #
+          #   @param cursor [String] Pagination cursor
+          #
+          #   @param query_type [String] Sort order (Latest or Top)
+          #
+          #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_action_result.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      class CommunityActionResult < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute community_id
+        #
+        #   @return [String]
+        required :community_id, String, api_name: :communityId
+
+        # @!attribute community_name
+        #
+        #   @return [String]
+        required :community_name, String, api_name: :communityName
+
+        # @!attribute success
+        #
+        #   @return [Boolean, true]
+        required :success, const: true
+
+        # @!method initialize(community_id:, community_name:, success: true)
+        #   @param community_id [String]
+        #   @param community_name [String]
+        #   @param success [Boolean, true]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_create_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#create
+      class CommunityCreateParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute account
+        #   X account (@username or account ID)
+        #
+        #   @return [String]
+        required :account, String
+
+        # @!attribute name
+        #   Community name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute description
+        #   Community description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!method initialize(account:, name:, description: nil, request_options: {})
+        #   @param account [String] X account (@username or account ID)
+        #
+        #   @param name [String] Community name
+        #
+        #   @param description [String] Community description
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_create_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#create
+      class CommunityCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute community_id
+        #
+        #   @return [String]
+        required :community_id, String, api_name: :communityId
+
+        # @!attribute success
+        #
+        #   @return [Boolean, true]
+        required :success, const: true
+
+        # @!attribute community_name
+        #
+        #   @return [String, nil]
+        optional :community_name, String, api_name: :communityName
+
+        # @!method initialize(community_id:, community_name: nil, success: true)
+        #   @param community_id [String]
+        #   @param community_name [String]
+        #   @param success [Boolean, true]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_delete_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#delete
+      class CommunityDeleteParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute account
+        #   X account (@username or account ID)
+        #
+        #   @return [String]
+        required :account, String
+
+        # @!attribute community_name
+        #   Community name for confirmation
+        #
+        #   @return [String]
+        required :community_name, String
+
+        # @!method initialize(id:, account:, community_name:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param account [String] X account (@username or account ID)
+        #
+        #   @param community_name [String] Community name for confirmation
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_delete_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#delete
+      class CommunityDeleteResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute success
+        #
+        #   @return [Boolean, true]
+        required :success, const: true
+
+        # @!method initialize(success: true)
+        #   @param success [Boolean, true]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_retrieve_info_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#retrieve_info
+      class CommunityRetrieveInfoParams < 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
+end

data/lib/x_twitter_scraper/models/x/community_retrieve_info_response.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#retrieve_info
+      class CommunityRetrieveInfoResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute community
+        #   Community info object
+        #
+        #   @return [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community]
+        required :community, -> { XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community }
+
+        # @!method initialize(community:)
+        #   @param community [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community] Community info object
+
+        # @see XTwitterScraper::Models::X::CommunityRetrieveInfoResponse#community
+        class Community < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #   Community ID
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute banner_url
+          #   Community banner image URL
+          #
+          #   @return [String, nil]
+          optional :banner_url, String
+
+          # @!attribute created_at
+          #   Community creation timestamp
+          #
+          #   @return [String, nil]
+          optional :created_at, String
+
+          # @!attribute description
+          #   Community description
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute join_policy
+          #   Join policy (open or restricted)
+          #
+          #   @return [String, nil]
+          optional :join_policy, String
+
+          # @!attribute member_count
+          #   Total member count
+          #
+          #   @return [Integer, nil]
+          optional :member_count, Integer
+
+          # @!attribute moderator_count
+          #   Total moderator count
+          #
+          #   @return [Integer, nil]
+          optional :moderator_count, Integer
+
+          # @!attribute name
+          #   Community name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute primary_topic
+          #   Primary topic
+          #
+          #   @return [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic, nil]
+          optional :primary_topic,
+                   -> { XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic }
+
+          # @!attribute rules
+          #   Community rules
+          #
+          #   @return [Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>, nil]
+          optional :rules,
+                   -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule] }
+
+          # @!method initialize(id:, banner_url: nil, created_at: nil, description: nil, join_policy: nil, member_count: nil, moderator_count: nil, name: nil, primary_topic: nil, rules: nil)
+          #   Community info object
+          #
+          #   @param id [String] Community ID
+          #
+          #   @param banner_url [String] Community banner image URL
+          #
+          #   @param created_at [String] Community creation timestamp
+          #
+          #   @param description [String] Community description
+          #
+          #   @param join_policy [String] Join policy (open or restricted)
+          #
+          #   @param member_count [Integer] Total member count
+          #
+          #   @param moderator_count [Integer] Total moderator count
+          #
+          #   @param name [String] Community name
+          #
+          #   @param primary_topic [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic] Primary topic
+          #
+          #   @param rules [Array<XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::Rule>] Community rules
+
+          # @see XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community#primary_topic
+          class PrimaryTopic < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(id: nil, name: nil)
+            #   Primary topic
+            #
+            #   @param id [String]
+            #   @param name [String]
+          end
+
+          class Rule < XTwitterScraper::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute description
+            #
+            #   @return [String, nil]
+            optional :description, String
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(id: nil, description: nil, name: nil)
+            #   @param id [String]
+            #   @param description [String]
+            #   @param name [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_retrieve_members_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#retrieve_members
+      class CommunityRetrieveMembersParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute cursor
+        #   Pagination cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!method initialize(id:, cursor: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param cursor [String] Pagination cursor
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_retrieve_moderators_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#retrieve_moderators
+      class CommunityRetrieveModeratorsParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute cursor
+        #   Pagination cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!method initialize(id:, cursor: nil, request_options: {})
+        #   @param id [String]
+        #
+        #   @param cursor [String] Pagination cursor
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/community_retrieve_search_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Communities#retrieve_search
+      class CommunityRetrieveSearchParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute q
+        #   Search query
+        #
+        #   @return [String]
+        required :q, String
+
+        # @!attribute cursor
+        #   Pagination cursor
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute query_type
+        #   Sort order (Latest or Top)
+        #
+        #   @return [String, nil]
+        optional :query_type, String
+
+        # @!method initialize(q:, cursor: nil, query_type: nil, request_options: {})
+        #   @param q [String] Search query
+        #
+        #   @param cursor [String] Pagination cursor
+        #
+        #   @param query_type [String] Sort order (Latest or Top)
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/dm_retrieve_history_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Dm#retrieve_history
+      class DmRetrieveHistoryParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute cursor
+        #   Pagination cursor from previous response
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute max_id
+        #   Legacy pagination cursor (backward compat)
+        #
+        #   @return [String, nil]
+        optional :max_id, String
+
+        # @!method initialize(user_id:, cursor: nil, max_id: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param cursor [String] Pagination cursor from previous response
+        #
+        #   @param max_id [String] Legacy pagination cursor (backward compat)
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/dm_retrieve_history_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Dm#retrieve_history
+      class DmRetrieveHistoryResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute has_next_page
+        #
+        #   @return [Boolean]
+        required :has_next_page, XTwitterScraper::Internal::Type::Boolean
+
+        # @!attribute messages
+        #
+        #   @return [Array<XTwitterScraper::Models::X::DmRetrieveHistoryResponse::Message>]
+        required :messages,
+                 -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::DmRetrieveHistoryResponse::Message] }
+
+        # @!attribute next_cursor
+        #
+        #   @return [String]
+        required :next_cursor, String
+
+        # @!method initialize(has_next_page:, messages:, next_cursor:)
+        #   @param has_next_page [Boolean]
+        #   @param messages [Array<XTwitterScraper::Models::X::DmRetrieveHistoryResponse::Message>]
+        #   @param next_cursor [String]
+
+        class Message < XTwitterScraper::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #
+          #   @return [String, nil]
+          optional :created_at, String, api_name: :createdAt
+
+          # @!attribute receiver_id
+          #
+          #   @return [String, nil]
+          optional :receiver_id, String, api_name: :receiverId
+
+          # @!attribute sender_id
+          #
+          #   @return [String, nil]
+          optional :sender_id, String, api_name: :senderId
+
+          # @!attribute text
+          #
+          #   @return [String, nil]
+          optional :text, String
+
+          # @!method initialize(id:, created_at: nil, receiver_id: nil, sender_id: nil, text: nil)
+          #   @param id [String]
+          #   @param created_at [String]
+          #   @param receiver_id [String]
+          #   @param sender_id [String]
+          #   @param text [String]
+        end
+      end
+    end
+  end
+end

data/lib/x_twitter_scraper/models/x/dm_send_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Dm#send_
+      class DmSendParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!attribute user_id
+        #
+        #   @return [String]
+        required :user_id, String
+
+        # @!attribute account
+        #   X account (@username or account ID)
+        #
+        #   @return [String]
+        required :account, String
+
+        # @!attribute text
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute media_ids
+        #
+        #   @return [Array<String>, nil]
+        optional :media_ids, XTwitterScraper::Internal::Type::ArrayOf[String]
+
+        # @!attribute reply_to_message_id
+        #
+        #   @return [String, nil]
+        optional :reply_to_message_id, String
+
+        # @!method initialize(user_id:, account:, text:, media_ids: nil, reply_to_message_id: nil, request_options: {})
+        #   @param user_id [String]
+        #
+        #   @param account [String] X account (@username or account ID)
+        #
+        #   @param text [String]
+        #
+        #   @param media_ids [Array<String>]
+        #
+        #   @param reply_to_message_id [String]
+        #
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end