Class: XTwitterScraper::Models::DrawRunParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/draw_run_params.rb

Overview

See Also:

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(tweet_url:, backup_count: nil, filter_account_age_days: nil, filter_language: nil, filter_min_followers: nil, must_follow_username: nil, must_retweet: nil, required_hashtags: nil, required_keywords: nil, required_mentions: nil, unique_authors_only: nil, winner_count: nil, request_options: {}) ⇒ Object

Parameters:

  • tweet_url (String)
  • backup_count (Integer) (defaults to: nil)
  • filter_account_age_days (Integer) (defaults to: nil)
  • filter_language (String) (defaults to: nil)
  • filter_min_followers (Integer) (defaults to: nil)
  • must_follow_username (String) (defaults to: nil)
  • must_retweet (Boolean) (defaults to: nil)
  • required_hashtags (Array<String>) (defaults to: nil)
  • required_keywords (Array<String>) (defaults to: nil)
  • required_mentions (Array<String>) (defaults to: nil)
  • unique_authors_only (Boolean) (defaults to: nil)
  • winner_count (Integer) (defaults to: nil)
  • request_options (XTwitterScraper::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 76

Instance Attribute Details

#backup_count ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :backup_count, Integer, api_name: :backupCount

#filter_account_age_days ⇒ Integer?

Returns:

  • (Integer, nil) 


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

optional :filter_account_age_days, Integer, api_name: :filterAccountAgeDays

#filter_language ⇒ String?

Returns:

  • (String, nil) 


28
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 28

optional :filter_language, String, api_name: :filterLanguage

#filter_min_followers ⇒ Integer?

Returns:

  • (Integer, nil) 


33
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 33

optional :filter_min_followers, Integer, api_name: :filterMinFollowers

#must_follow_username ⇒ String?

Returns:

  • (String, nil) 


38
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 38

optional :must_follow_username, String, api_name: :mustFollowUsername

#must_retweet ⇒ Boolean?

Returns:

  • (Boolean, nil) 


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

optional :must_retweet, XTwitterScraper::Internal::Type::Boolean, api_name: :mustRetweet

#required_hashtags ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


48
49
50
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 48

optional :required_hashtags,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :requiredHashtags

#required_keywords ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


55
56
57
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 55

optional :required_keywords,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :requiredKeywords

#required_mentions ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


62
63
64
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 62

optional :required_mentions,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :requiredMentions

#tweet_url ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 13

required :tweet_url, String, api_name: :tweetUrl

#unique_authors_only ⇒ Boolean?

Returns:

  • (Boolean, nil) 


69
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 69

optional :unique_authors_only, XTwitterScraper::Internal::Type::Boolean, api_name: :uniqueAuthorsOnly

#winner_count ⇒ Integer?

Returns:

  • (Integer, nil) 


74
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 74

optional :winner_count, Integer, api_name: :winnerCount