Class: XTwitterScraper::Models::ExtractionExportResultsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::ExtractionExportResultsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/extraction_export_results_params.rb,
sig/x_twitter_scraper/models/extraction_export_results_params.rbs

Overview

See Also:

• XTwitterScraper::Resources::Extractions#export_results

Defined Under Namespace

Modules: Format

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary

• #format_ ⇒ Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format

  Export file format.

• #has_description ⇒ Boolean^?

  Require a non-empty description.

• #has_location ⇒ Boolean^?

  Require a non-empty location.

• #has_media ⇒ Boolean^?

  Require media.

• #id ⇒ String
• #lang ⇒ String^?

  Filter by language code.

• #max_followers ⇒ Integer^?

  Maximum follower count.

• #max_following ⇒ Integer^?

  Maximum following count.

• #max_posts ⇒ Integer^?

  Maximum post count.

• #min_followers ⇒ Integer^?

  Minimum follower count.

• #min_following ⇒ Integer^?

  Minimum following count.

• #min_likes ⇒ Integer^?

  Minimum like count.

• #min_posts ⇒ Integer^?

  Minimum post count.

• #min_replies ⇒ Integer^?

  Minimum reply count.

• #min_retweets ⇒ Integer^?

  Minimum repost count.

• #min_views ⇒ Integer^?

  Minimum view count.

• #search ⇒ String^?

  Search exported result text.

• #since_date ⇒ Date^?

  Include results on or after this date.

• #until_date ⇒ Date^?

  Include results on or before this date.

• #verified ⇒ Boolean^?

  Filter by verified status.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, format_:, has_description: nil, has_location: nil, has_media: nil, lang: nil, max_followers: nil, max_following: nil, max_posts: nil, min_followers: nil, min_following: nil, min_likes: nil, min_posts: nil, min_replies: nil, min_retweets: nil, min_views: nil, search: nil, since_date: nil, until_date: nil, verified: nil, request_options: {}) ⇒ Object constructor
• #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:, format_:, has_description: nil, has_location: nil, has_media: nil, lang: nil, max_followers: nil, max_following: nil, max_posts: nil, min_followers: nil, min_following: nil, min_likes: nil, min_posts: nil, min_replies: nil, min_retweets: nil, min_views: nil, search: nil, since_date: nil, until_date: nil, verified: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• format_ (Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format) —

  Export file format

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

  Require a non-empty description.

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

  Require a non-empty location.

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

  Require media.

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

  Filter by language code.

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

  Maximum follower count.

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

  Maximum following count.

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

  Maximum post count.

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

  Minimum follower count.

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

  Minimum following count.

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

  Minimum like count.

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

  Minimum post count.

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

  Minimum reply count.

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

  Minimum repost count.

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

  Minimum view count.

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

  Search exported result text.

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

  Include results on or after this date.

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

  Include results on or before this date.

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

  Filter by verified status.

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

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 133

Instance Attribute Details

#format_ ⇒ Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format

Export file format

Parameters:

• value (XTwitterScraper::Models::ExtractionExportResultsParams::format_)

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionExportResultsParams::Format)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 23

required :format_, enum: -> { XTwitterScraper::ExtractionExportResultsParams::Format }

#has_description ⇒ Boolean^?

Require a non-empty description.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 29

optional :has_description, XTwitterScraper::Internal::Type::Boolean

#has_location ⇒ Boolean^?

Require a non-empty location.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 35

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

#has_media ⇒ Boolean^?

Require media.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 41

optional :has_media, XTwitterScraper::Internal::Type::Boolean

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 17

required :id, String

#lang ⇒ String^?

Filter by language code.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 47

optional :lang, String

#max_followers ⇒ Integer^?

Maximum follower count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 53

optional :max_followers, Integer

#max_following ⇒ Integer^?

Maximum following count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 59

optional :max_following, Integer

#max_posts ⇒ Integer^?

Maximum post count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 65

optional :max_posts, Integer

#min_followers ⇒ Integer^?

Minimum follower count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 71

optional :min_followers, Integer

#min_following ⇒ Integer^?

Minimum following count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 77

optional :min_following, Integer

#min_likes ⇒ Integer^?

Minimum like count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 83

optional :min_likes, Integer

#min_posts ⇒ Integer^?

Minimum post count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 89

optional :min_posts, Integer

#min_replies ⇒ Integer^?

Minimum reply count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 95

optional :min_replies, Integer

#min_retweets ⇒ Integer^?

Minimum repost count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 101

optional :min_retweets, Integer

#min_views ⇒ Integer^?

Minimum view count.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 107

optional :min_views, Integer

#search ⇒ String^?

Search exported result text.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 113

optional :search, String

#since_date ⇒ Date^?

Include results on or after this date.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 119

optional :since_date, Date

#until_date ⇒ Date^?

Include results on or before this date.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 125

optional :until_date, Date

#verified ⇒ Boolean^?

Filter by verified status.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/extraction_export_results_params.rb', line 131

optional :verified, XTwitterScraper::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/extraction_export_results_params.rbs', line 136

def to_hash: -> {