Class: XTwitterScraper::Models::X::TweetGetRepliesParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb,
sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::X::Tweets#get_replies

Defined Under Namespace

Modules: MediaType, Mode, Quotes, Replies, Retweets

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, any_words: nil, cashtags: nil, conversation_id: nil, cursor: nil, exact_phrase: nil, exclude_words: nil, from_user: nil, hashtags: nil, in_reply_to_tweet_id: nil, language: nil, limit: nil, media_type: nil, mentioning: nil, min_faves: nil, min_quotes: nil, min_replies: nil, min_retweets: nil, mode: nil, page_size: nil, quotes: nil, quotes_of_tweet_id: nil, replies: nil, retweets: nil, retweets_of_tweet_id: nil, since_date: nil, since_time: nil, to_user: nil, until_date: nil, until_time: nil, url: nil, verified_only: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::X::TweetGetRepliesParams for more details.

Parameters:

  • id (String)
  • any_words (String) (defaults to: nil) —

    Words or quoted phrases where any one can match. Separate with spaces, commas, o

  • cashtags (String) (defaults to: nil) —

    Cashtags separated by spaces, commas, or lines.

  • conversation_id (String) (defaults to: nil) —

    Conversation ID filter.

  • cursor (String) (defaults to: nil) —

    Pagination cursor for tweet replies

  • exact_phrase (String) (defaults to: nil) —

    Exact phrase to match.

  • exclude_words (String) (defaults to: nil) —

    Words or quoted phrases to exclude. Separate with spaces, commas, or lines.

  • from_user (String) (defaults to: nil) —

    Filter by author username.

  • hashtags (String) (defaults to: nil) —

    Hashtags separated by spaces, commas, or lines.

  • in_reply_to_tweet_id (String) (defaults to: nil) —

    Only replies to this tweet ID.

  • language (String) (defaults to: nil) —

    Language code filter, e.g. en or tr.

  • limit (Integer) (defaults to: nil) —

    With mode=complete, maximum combined direct and nested reply rows (1-25000). Wit

  • media_type (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::MediaType) (defaults to: nil) —

    Filter by media type.

  • mentioning (String) (defaults to: nil) —

    Filter tweets mentioning a username.

  • min_faves (Integer) (defaults to: nil) —

    Minimum likes threshold.

  • min_quotes (Integer) (defaults to: nil) —

    Minimum quote count threshold.

  • min_replies (Integer) (defaults to: nil) —

    Minimum replies threshold.

  • min_retweets (Integer) (defaults to: nil) —

    Minimum retweets threshold.

  • mode (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Mode) (defaults to: nil) —

    Set complete for maximum-coverage collection. Complete mode accepts only limit.

  • page_size (Integer) (defaults to: nil) —

    Maximum page items (1-100, default 20). Source, filters, or credits can reduce r

  • quotes (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Quotes) (defaults to: nil) —

    Quote mode.

  • quotes_of_tweet_id (String) (defaults to: nil) —

    Only quotes of this tweet ID.

  • replies (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Replies) (defaults to: nil) —

    Reply mode.

  • retweets (Symbol, XTwitterScraper::Models::X::TweetGetRepliesParams::Retweets) (defaults to: nil) —

    Retweet mode.

  • retweets_of_tweet_id (String) (defaults to: nil) —

    Only retweets of this tweet ID.

  • since_date (Date) (defaults to: nil) —

    Start date in YYYY-MM-DD format.

  • since_time (String) (defaults to: nil) —

    Unix timestamp - return replies posted after this time

  • to_user (String) (defaults to: nil) —

    Filter replies sent to a username.

  • until_date (Date) (defaults to: nil) —

    End date in YYYY-MM-DD format.

  • until_time (String) (defaults to: nil) —

    Unix timestamp - return replies posted before this time

  • url (String) (defaults to: nil) —

    URL substring or domain filter.

  • verified_only (Boolean) (defaults to: nil) —

    Only return tweets from verified authors.

  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 212

Instance Attribute Details

#any_words ⇒ String?

Words or quoted phrases where any one can match. Separate with spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 25

optional :any_words, String

#cashtags ⇒ String?

Cashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 31

optional :cashtags, String

#conversation_id ⇒ String?

Conversation ID filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 37

optional :conversation_id, String

#cursor ⇒ String?

Pagination cursor for tweet replies

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 43

optional :cursor, String

#exact_phrase ⇒ String?

Exact phrase to match.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 49

optional :exact_phrase, String

#exclude_words ⇒ String?

Words or quoted phrases to exclude. Separate with spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 55

optional :exclude_words, String

#from_user ⇒ String?

Filter by author username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 61

optional :from_user, String

#hashtags ⇒ String?

Hashtags separated by spaces, commas, or lines.

Parameters:

  • (String)

Returns:

  • (String, nil) 


67
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 67

optional :hashtags, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 18

required :id, String

#in_reply_to_tweet_id ⇒ String?

Only replies to this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


73
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 73

optional :in_reply_to_tweet_id, String

#language ⇒ String?

Language code filter, e.g. en or tr.

Parameters:

  • (String)

Returns:

  • (String, nil) 


79
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 79

optional :language, String

#limit ⇒ Integer?

With mode=complete, maximum combined direct and nested reply rows (1-25000). Without complete mode, this is the deprecated pageSize alias and uses the normal 1-100 page range.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


87
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 87

optional :limit, Integer

#media_type ⇒ Symbol, ...

Filter by media type.

Returns:



93
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 93

optional :media_type, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::MediaType }

#mentioning ⇒ String?

Filter tweets mentioning a username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


99
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 99

optional :mentioning, String

#min_faves ⇒ Integer?

Minimum likes threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


105
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 105

optional :min_faves, Integer

#min_quotes ⇒ Integer?

Minimum quote count threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


111
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 111

optional :min_quotes, Integer

#min_replies ⇒ Integer?

Minimum replies threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


117
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 117

optional :min_replies, Integer

#min_retweets ⇒ Integer?

Minimum retweets threshold.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


123
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 123

optional :min_retweets, Integer

#mode ⇒ Symbol, ...

Set complete for maximum-coverage collection. Complete mode accepts only limit. Remove cursor, pageSize, count, time ranges, and tweet filters.

Returns:



130
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 130

optional :mode, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Mode }

#page_size ⇒ Integer?

Maximum page items (1-100, default 20). Source, filters, or credits can reduce results. Continue while has_next_page is true. Deprecated limit and count aliases remain accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


138
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 138

optional :page_size, Integer

#quotes ⇒ Symbol, ...

Quote mode.

Returns:



144
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 144

optional :quotes, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Quotes }

#quotes_of_tweet_id ⇒ String?

Only quotes of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


150
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 150

optional :quotes_of_tweet_id, String

#replies ⇒ Symbol, ...

Reply mode.

Returns:



156
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 156

optional :replies, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Replies }

#retweets ⇒ Symbol, ...

Retweet mode.

Returns:



162
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 162

optional :retweets, enum: -> { XTwitterScraper::X::TweetGetRepliesParams::Retweets }

#retweets_of_tweet_id ⇒ String?

Only retweets of this tweet ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


168
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 168

optional :retweets_of_tweet_id, String

#since_date ⇒ Date?

Start date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


174
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 174

optional :since_date, Date

#since_time ⇒ String?

Unix timestamp - return replies posted after this time

Parameters:

  • (String)

Returns:

  • (String, nil) 


180
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 180

optional :since_time, String

#to_user ⇒ String?

Filter replies sent to a username.

Parameters:

  • (String)

Returns:

  • (String, nil) 


186
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 186

optional :to_user, String

#until_date ⇒ Date?

End date in YYYY-MM-DD format.

Parameters:

  • (Date)

Returns:

  • (Date, nil) 


192
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 192

optional :until_date, Date

#until_time ⇒ String?

Unix timestamp - return replies posted before this time

Parameters:

  • (String)

Returns:

  • (String, nil) 


198
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 198

optional :until_time, String

#url ⇒ String?

URL substring or domain filter.

Parameters:

  • (String)

Returns:

  • (String, nil) 


204
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 204

optional :url, String

#verified_only ⇒ Boolean?

Only return tweets from verified authors.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


210
 
# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 210

optional :verified_only, XTwitterScraper::Internal::Type::Boolean

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb', line 293

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


221
 
# File 'sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs', line 221

def to_hash: -> {