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,
sig/x_twitter_scraper/models/draw_run_params.rbs

Overview

See Also:

  • XTwitterScraper::Resources::Draws#run

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(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 80

Instance Attribute Details

#backup_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :backup_count, Integer, api_name: :backupCount

#filter_account_age_days ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :filter_account_age_days, Integer, api_name: :filterAccountAgeDays

#filter_language ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :filter_language, String, api_name: :filterLanguage

#filter_min_followers ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :filter_min_followers, Integer, api_name: :filterMinFollowers

#must_follow_username ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :must_follow_username, String, api_name: :mustFollowUsername

#must_retweet ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

#required_hashtags ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


52
53
54
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 52

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

#required_keywords ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


59
60
61
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 59

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

#required_mentions ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


66
67
68
 
# File 'lib/x_twitter_scraper/models/draw_run_params.rb', line 66

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

#tweet_url ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :tweet_url, String, api_name: :tweetUrl

#unique_authors_only ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

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

#winner_count ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :winner_count, Integer, api_name: :winnerCount

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


90
 
# File 'sig/x_twitter_scraper/models/draw_run_params.rbs', line 90

def to_hash: -> {