x-twitter-scraper 0.3.0 → 0.4.0

data/lib/x_twitter_scraper/models/webhook.rb

@@ -2,6 +2,7 @@
 
 module XTwitterScraper
   module Models
+    # @see XTwitterScraper::Resources::Webhooks#update
     class Webhook < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute id
       #
@@ -14,10 +15,11 @@ module XTwitterScraper
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::Webhook::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Webhook::EventType] },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute is_active
@@ -31,25 +33,17 @@ module XTwitterScraper
       required :url, String
 
       # @!method initialize(id:, created_at:, event_types:, is_active:, url:)
+      #   Webhook endpoint registered to receive event deliveries.
+      #
       #   @param id [String]
+      #
       #   @param created_at [Time]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::Webhook::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param is_active [Boolean]
+      #
       #   @param url [String]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_create_params.rb

@@ -8,12 +8,11 @@ module XTwitterScraper
       include XTwitterScraper::Internal::Type::RequestParameters
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::WebhookCreateParams::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::WebhookCreateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute url
@@ -23,25 +22,11 @@ module XTwitterScraper
       required :url, String
 
       # @!method initialize(event_types:, url:, request_options: {})
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookCreateParams::EventType>]
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
       #
       #   @param url [String] HTTPS URL
       #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_create_response.rb

@@ -15,10 +15,11 @@ module XTwitterScraper
       required :created_at, Time, api_name: :createdAt
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::WebhookCreateResponse::EventType>]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>]
       required :event_types,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::WebhookCreateResponse::EventType] },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute secret
@@ -33,24 +34,14 @@ module XTwitterScraper
 
       # @!method initialize(id:, created_at:, event_types:, secret:, url:)
       #   @param id [String]
+      #
       #   @param created_at [Time]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookCreateResponse::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param secret [String]
+      #
       #   @param url [String]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_list_deliveries_response.rb

@@ -6,64 +6,11 @@ module XTwitterScraper
     class WebhookListDeliveriesResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute deliveries
       #
-      #   @return [Array<XTwitterScraper::Models::WebhookListDeliveriesResponse::Delivery>]
-      required :deliveries,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::WebhookListDeliveriesResponse::Delivery] }
+      #   @return [Array<XTwitterScraper::Models::Delivery>]
+      required :deliveries, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Delivery] }
 
       # @!method initialize(deliveries:)
-      #   @param deliveries [Array<XTwitterScraper::Models::WebhookListDeliveriesResponse::Delivery>]
-
-      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
+      #   @param deliveries [Array<XTwitterScraper::Models::Delivery>]
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_list_response.rb

@@ -6,62 +6,11 @@ module XTwitterScraper
     class WebhookListResponse < XTwitterScraper::Internal::Type::BaseModel
       # @!attribute webhooks
       #
-      #   @return [Array<XTwitterScraper::Models::WebhookListResponse::Webhook>]
-      required :webhooks,
-               -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::WebhookListResponse::Webhook] }
+      #   @return [Array<XTwitterScraper::Models::Webhook>]
+      required :webhooks, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Webhook] }
 
       # @!method initialize(webhooks:)
-      #   @param webhooks [Array<XTwitterScraper::Models::WebhookListResponse::Webhook>]
-
-      class Webhook < XTwitterScraper::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time, api_name: :createdAt
-
-        # @!attribute event_types
-        #
-        #   @return [Array<Symbol, XTwitterScraper::Models::WebhookListResponse::Webhook::EventType>]
-        required :event_types,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::Models::WebhookListResponse::Webhook::EventType] },
-                 api_name: :eventTypes
-
-        # @!attribute is_active
-        #
-        #   @return [Boolean]
-        required :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
-
-        # @!attribute url
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!method initialize(id:, created_at:, event_types:, is_active:, url:)
-        #   @param id [String]
-        #   @param created_at [Time]
-        #   @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookListResponse::Webhook::EventType>]
-        #   @param is_active [Boolean]
-        #   @param url [String]
-
-        module EventType
-          extend XTwitterScraper::Internal::Type::Enum
-
-          TWEET_NEW = :"tweet.new"
-          TWEET_REPLY = :"tweet.reply"
-          TWEET_RETWEET = :"tweet.retweet"
-          TWEET_QUOTE = :"tweet.quote"
-          FOLLOWER_GAINED = :"follower.gained"
-          FOLLOWER_LOST = :"follower.lost"
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param webhooks [Array<XTwitterScraper::Models::Webhook>]
     end
   end
 end

data/lib/x_twitter_scraper/models/webhook_update_params.rb

@@ -13,12 +13,11 @@ module XTwitterScraper
       required :id, String
 
       # @!attribute event_types
+      #   Array of event types to subscribe to.
       #
-      #   @return [Array<Symbol, XTwitterScraper::Models::WebhookUpdateParams::EventType>, nil]
+      #   @return [Array<Symbol, XTwitterScraper::Models::EventType>, nil]
       optional :event_types,
-               -> {
-                 XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::WebhookUpdateParams::EventType]
-               },
+               -> { XTwitterScraper::Internal::Type::ArrayOf[enum: XTwitterScraper::EventType] },
                api_name: :eventTypes
 
       # @!attribute is_active
@@ -33,24 +32,14 @@ module XTwitterScraper
 
       # @!method initialize(id:, event_types: nil, is_active: nil, url: nil, request_options: {})
       #   @param id [String]
-      #   @param event_types [Array<Symbol, XTwitterScraper::Models::WebhookUpdateParams::EventType>]
+      #
+      #   @param event_types [Array<Symbol, XTwitterScraper::Models::EventType>] Array of event types to subscribe to.
+      #
       #   @param is_active [Boolean]
+      #
       #   @param url [String]
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
-
-      module EventType
-        extend XTwitterScraper::Internal::Type::Enum
-
-        TWEET_NEW = :"tweet.new"
-        TWEET_REPLY = :"tweet.reply"
-        TWEET_RETWEET = :"tweet.retweet"
-        TWEET_QUOTE = :"tweet.quote"
-        FOLLOWER_GAINED = :"follower.gained"
-        FOLLOWER_LOST = :"follower.lost"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/x_twitter_scraper/models/winner.rb

@@ -24,6 +24,8 @@ module XTwitterScraper
       required :tweet_id, String, api_name: :tweetId
 
       # @!method initialize(author_username:, is_backup:, position:, tweet_id:)
+      #   Giveaway draw winner with position and backup flag.
+      #
       #   @param author_username [String]
       #   @param is_backup [Boolean]
       #   @param position [Integer]

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Accounts#bulk_retry
+      class AccountBulkRetryParams < XTwitterScraper::Internal::Type::BaseModel
+        extend XTwitterScraper::Internal::Type::RequestParameters::Converter
+        include XTwitterScraper::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      # @see XTwitterScraper::Resources::X::Accounts#bulk_retry
+      class AccountBulkRetryResponse < XTwitterScraper::Internal::Type::BaseModel
+        # @!attribute cleared
+        #   Number of accounts cleared
+        #
+        #   @return [Integer]
+        required :cleared, Integer
+
+        # @!method initialize(cleared:)
+        #   @param cleared [Integer] Number of accounts cleared
+      end
+    end
+  end
+end

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

@@ -7,46 +7,11 @@ module XTwitterScraper
       class AccountListResponse < XTwitterScraper::Internal::Type::BaseModel
         # @!attribute accounts
         #
-        #   @return [Array<XTwitterScraper::Models::X::AccountListResponse::Account>]
-        required :accounts,
-                 -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::AccountListResponse::Account] }
+        #   @return [Array<XTwitterScraper::Models::X::XAccount>]
+        required :accounts, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::X::XAccount] }
 
         # @!method initialize(accounts:)
-        #   @param accounts [Array<XTwitterScraper::Models::X::AccountListResponse::Account>]
-
-        class Account < 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 x_user_id
-          #
-          #   @return [String]
-          required :x_user_id, String, api_name: :xUserId
-
-          # @!attribute x_username
-          #
-          #   @return [String]
-          required :x_username, String, api_name: :xUsername
-
-          # @!method initialize(id:, created_at:, status:, x_user_id:, x_username:)
-          #   @param id [String]
-          #   @param created_at [Time]
-          #   @param status [String]
-          #   @param x_user_id [String]
-          #   @param x_username [String]
-        end
+        #   @param accounts [Array<XTwitterScraper::Models::X::XAccount>]
       end
     end
   end

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

@@ -14,13 +14,13 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute password
-        #   Account password
+        #   Updated account password
         #
         #   @return [String]
         required :password, String
 
         # @!attribute totp_secret
-        #   TOTP secret for 2FA
+        #   TOTP secret for 2FA re-authentication
         #
         #   @return [String, nil]
         optional :totp_secret, String
@@ -28,9 +28,9 @@ module XTwitterScraper
         # @!method initialize(id:, password:, totp_secret: nil, request_options: {})
         #   @param id [String]
         #
-        #   @param password [String] Account password
+        #   @param password [String] Updated account password
         #
-        #   @param totp_secret [String] TOTP secret for 2FA
+        #   @param totp_secret [String] TOTP secret for 2FA re-authentication
         #
         #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute cursor
-        #   Pagination cursor from previous response
+        #   Pagination cursor for bookmarks
         #
         #   @return [String, nil]
         optional :cursor, String
@@ -21,7 +21,7 @@ module XTwitterScraper
         optional :folder_id, String
 
         # @!method initialize(cursor: nil, folder_id: nil, request_options: {})
-        #   @param cursor [String] Pagination cursor from previous response
+        #   @param cursor [String] Pagination cursor for bookmarks
         #
         #   @param folder_id [String] Optional bookmark folder ID
         #

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

@@ -15,7 +15,7 @@ module XTwitterScraper
           required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
@@ -23,7 +23,7 @@ module XTwitterScraper
           # @!method initialize(id:, account:, request_options: {})
           #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

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

@@ -15,7 +15,7 @@ module XTwitterScraper
           required :id, String
 
           # @!attribute account
-          #   X account (@username or account ID)
+          #   X account identifier (@username or account ID)
           #
           #   @return [String]
           required :account, String
@@ -23,7 +23,7 @@ module XTwitterScraper
           # @!method initialize(id:, account:, request_options: {})
           #   @param id [String]
           #
-          #   @param account [String] X account (@username or account ID)
+          #   @param account [String] X account identifier (@username or account ID)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module XTwitterScraper
+  module Models
+    module X
+      module Communities
+        # @see XTwitterScraper::Resources::X::Communities::Tweets#list_by_community
+        class TweetListByCommunityParams < 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 for community tweets
+          #
+          #   @return [String, nil]
+          optional :cursor, String
+
+          # @!method initialize(id:, cursor: nil, request_options: {})
+          #   @param id [String]
+          #
+          #   @param cursor [String] Pagination cursor for community tweets
+          #
+          #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -10,29 +10,29 @@ module XTwitterScraper
           include XTwitterScraper::Internal::Type::RequestParameters
 
           # @!attribute q
-          #   Search query
+          #   Search query for cross-community tweets
           #
           #   @return [String]
           required :q, String
 
           # @!attribute cursor
-          #   Pagination cursor
+          #   Pagination cursor for cross-community results
           #
           #   @return [String, nil]
           optional :cursor, String
 
           # @!attribute query_type
-          #   Sort order (Latest or Top)
+          #   Sort order for cross-community results (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 q [String] Search query for cross-community tweets
           #
-          #   @param cursor [String] Pagination cursor
+          #   @param cursor [String] Pagination cursor for cross-community results
           #
-          #   @param query_type [String] Sort order (Latest or Top)
+          #   @param query_type [String] Sort order for cross-community results (Latest or Top)
           #
           #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
         end

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

@@ -20,6 +20,8 @@ module XTwitterScraper
         required :success, const: true
 
         # @!method initialize(community_id:, community_name:, success: true)
+        #   Result of a community join or leave action.
+        #
         #   @param community_id [String]
         #   @param community_name [String]
         #   @param success [Boolean, true]

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

@@ -9,7 +9,7 @@ module XTwitterScraper
         include XTwitterScraper::Internal::Type::RequestParameters
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) creating the community
         #
         #   @return [String]
         required :account, String
@@ -27,7 +27,7 @@ module XTwitterScraper
         optional :description, String
 
         # @!method initialize(account:, name:, description: nil, request_options: {})
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) creating the community
         #
         #   @param name [String] Community name
         #

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

@@ -14,7 +14,7 @@ module XTwitterScraper
         required :id, String
 
         # @!attribute account
-        #   X account (@username or account ID)
+        #   X account (@username or ID) deleting the community
         #
         #   @return [String]
         required :account, String
@@ -28,7 +28,7 @@ module XTwitterScraper
         # @!method initialize(id:, account:, community_name:, request_options: {})
         #   @param id [String]
         #
-        #   @param account [String] X account (@username or account ID)
+        #   @param account [String] X account (@username or ID) deleting the community
         #
         #   @param community_name [String] Community name for confirmation
         #

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

@@ -17,7 +17,7 @@ module XTwitterScraper
         # @see XTwitterScraper::Models::X::CommunityRetrieveInfoResponse#community
         class Community < XTwitterScraper::Internal::Type::BaseModel
           # @!attribute id
-          #   Community ID
+          #   Unique community identifier
           #
           #   @return [String]
           required :id, String
@@ -35,7 +35,7 @@ module XTwitterScraper
           optional :created_at, String
 
           # @!attribute description
-          #   Community description
+          #   About text for the community
           #
           #   @return [String, nil]
           optional :description, String
@@ -59,7 +59,7 @@ module XTwitterScraper
           optional :moderator_count, Integer
 
           # @!attribute name
-          #   Community name
+          #   Display name of the community
           #
           #   @return [String, nil]
           optional :name, String
@@ -81,13 +81,13 @@ module XTwitterScraper
           # @!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 id [String] Unique community identifier
           #
           #   @param banner_url [String] Community banner image URL
           #
           #   @param created_at [String] Community creation timestamp
           #
-          #   @param description [String] Community description
+          #   @param description [String] About text for the community
           #
           #   @param join_policy [String] Join policy (open or restricted)
           #
@@ -95,7 +95,7 @@ module XTwitterScraper
           #
           #   @param moderator_count [Integer] Total moderator count
           #
-          #   @param name [String] Community name
+          #   @param name [String] Display name of the community
           #
           #   @param primary_topic [XTwitterScraper::Models::X::CommunityRetrieveInfoResponse::Community::PrimaryTopic] Primary topic
           #