Class: XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::X::UserRetrieveFollowersYouKnowParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb,
sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbs

Overview

See Also:

• XTwitterScraper::Resources::X::Users#retrieve_followers_you_know

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary

• #bio_contains ⇒ String^?

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

• #cursor ⇒ String^?

  Pagination cursor for followers-you-know.

• #has_location ⇒ Boolean^?

  Only return profiles with a location.

• #has_website ⇒ Boolean^?

  Only return profiles with a website.

• #id ⇒ String
• #location_contains ⇒ String^?

  Match a location substring, ignoring case.

• #max_followers ⇒ Integer^?

  Maximum follower count.

• #max_following ⇒ Integer^?

  Maximum following count.

• #max_statuses ⇒ Integer^?

  Maximum post count.

• #min_account_age_days ⇒ Integer^?

  Minimum account age in whole days.

• #min_followers ⇒ Integer^?

  Minimum follower count.

• #min_following ⇒ Integer^?

  Minimum following count.

• #min_statuses ⇒ Integer^?

  Minimum post count.

• #page_size ⇒ Integer^?

  Maximum user profiles requested from this page (20-200, default 200).

• #username_contains ⇒ String^?

  Match a username substring, ignoring case.

• #verified_only ⇒ Boolean^?

  Only return verified profiles.

• #verified_type ⇒ String^?

  Match the verification type exactly, ignoring case.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, 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, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see UserRetrieveFollowersYouKnowParams for more details.

• #to_hash ⇒ {

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:, 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, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• 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 followers-you-know

• 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.

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

  Maximum user profiles requested from this page (20-200, default 200). Source, fi

• 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_followers_you_know_params.rb', line 118

Instance Attribute Details

#bio_contains ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 24

optional :bio_contains, String

#cursor ⇒ String^?

Pagination cursor for followers-you-know

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 30

optional :cursor, String

#has_location ⇒ Boolean^?

Only return profiles with a location.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 36

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

#has_website ⇒ Boolean^?

Only return profiles with a website.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 42

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#location_contains ⇒ String^?

Match a location substring, ignoring case.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 48

optional :location_contains, String

#max_followers ⇒ Integer^?

Maximum follower count. Missing counts pass this maximum.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 54

optional :max_followers, Integer

#max_following ⇒ Integer^?

Maximum following count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 60

optional :max_following, Integer

#max_statuses ⇒ Integer^?

Maximum post count. maxPosts is also accepted.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 66

optional :max_statuses, Integer

#min_account_age_days ⇒ Integer^?

Minimum account age in whole days.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 72

optional :min_account_age_days, Integer

#min_followers ⇒ Integer^?

Minimum follower count. Filtering happens before billing.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 78

optional :min_followers, Integer

#min_following ⇒ Integer^?

Minimum following count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 84

optional :min_following, Integer

#min_statuses ⇒ Integer^?

Minimum post count. minPosts is also accepted.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 90

optional :min_statuses, Integer

#page_size ⇒ Integer^?

Maximum user profiles requested from this page (20-200, default 200). Source, filters, or credits can return fewer profiles. Keep requesting next_cursor while has_next_page is true. Deprecated aliases remain accepted.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 98

optional :page_size, Integer

#username_contains ⇒ String^?

Match a username substring, ignoring case.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 104

optional :username_contains, String

#verified_only ⇒ Boolean^?

Only return verified profiles.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 110

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

#verified_type ⇒ String^?

Match the verification type exactly, ignoring case.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb', line 116

optional :verified_type, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbs', line 121

def to_hash: -> {