Class: XTwitterScraper::Models::X::UserRetrieveSearchParams

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

Overview

See Also:

  • XTwitterScraper::Resources::X::Users#retrieve_search

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(q:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {}) ⇒ Object

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

Parameters:

  • q (String) —

    User search query

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

    Match any comma-separated or line-separated bio term, ignoring case.

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

    Pagination cursor for user search

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

    Only return profiles with a location.

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

    Only return profiles with a website.

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

    Match a location substring, ignoring case.

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

    Maximum follower count. Missing counts pass this maximum.

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

    Maximum following count.

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

    Maximum post count. maxPosts is also accepted.

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

    Minimum account age in whole days.

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

    Minimum follower count. Filtering happens before billing.

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

    Minimum following count.

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

    Minimum post count. minPosts is also accepted.

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

    Match a username substring, ignoring case.

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

    Only return verified profiles.

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

    Match the verification type exactly, ignoring case.

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



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

Instance Attribute Details

#bio_contains ⇒ String?

Match any comma-separated or line-separated bio term, ignoring case.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :bio_contains, String

#cursor ⇒ String?

Pagination cursor for user search

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :cursor, String

#has_location ⇒ Boolean?

Only return profiles with a location.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :has_location, XTwitterScraper::Internal::Type::Boolean

#has_website ⇒ Boolean?

Only return profiles with a website.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :has_website, XTwitterScraper::Internal::Type::Boolean

#location_contains ⇒ String?

Match a location substring, ignoring case.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :location_contains, String

#max_followers ⇒ Integer?

Maximum follower count. Missing counts pass this maximum.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :max_followers, Integer

#max_following ⇒ Integer?

Maximum following count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :max_following, Integer

#max_statuses ⇒ Integer?

Maximum post count. maxPosts is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :max_statuses, Integer

#min_account_age_days ⇒ Integer?

Minimum account age in whole days.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :min_account_age_days, Integer

#min_followers ⇒ Integer?

Minimum follower count. Filtering happens before billing.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :min_followers, Integer

#min_following ⇒ Integer?

Minimum following count.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


85
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 85

optional :min_following, Integer

#min_statuses ⇒ Integer?

Minimum post count. minPosts is also accepted.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


91
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 91

optional :min_statuses, Integer

#q ⇒ String

User search query

Parameters:

  • value (String)

Returns:

  • (String) 


19
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 19

required :q, String

#username_contains ⇒ String?

Match a username substring, ignoring case.

Parameters:

  • (String)

Returns:

  • (String, nil) 


97
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 97

optional :username_contains, String

#verified_only ⇒ Boolean?

Only return verified profiles.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


103
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 103

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

#verified_type ⇒ String?

Match the verification type exactly, ignoring case.

Parameters:

  • (String)

Returns:

  • (String, nil) 


109
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb', line 109

optional :verified_type, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


115
 
# File 'sig/x_twitter_scraper/models/x/user_retrieve_search_params.rbs', line 115

def to_hash: -> {