Class: XTwitterScraper::Models::X::TweetCreateParams

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

Overview

See Also:

  • XTwitterScraper::Resources::X::Tweets#create

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(account:, attachment_url: nil, community_id: nil, is_note_tweet: nil, media: nil, reply_to_tweet_id: nil, text: nil, request_options: {}) ⇒ Object

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

Parameters:

  • account (String) —

    X account (@username or account ID)

  • attachment_url (String) (defaults to: nil)
  • community_id (String) (defaults to: nil)
  • is_note_tweet (Boolean) (defaults to: nil)
  • media (Array<String>) (defaults to: nil) —

    Array of public media URLs to attach. Supports up to 4 images or exactly 1 MP4 v

  • reply_to_tweet_id (String) (defaults to: nil)
  • text (String) (defaults to: nil) —

    Tweet text (optional when media is provided)

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



# File 'lib/x_twitter_scraper/models/x/tweet_create_params.rb', line 51

Instance Attribute Details

#account ⇒ String

X account (@username or account ID)

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/x_twitter_scraper/models/x/tweet_create_params.rb', line 15

required :account, String

#attachment_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


20
 
# File 'lib/x_twitter_scraper/models/x/tweet_create_params.rb', line 20

optional :attachment_url, String

#community_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :community_id, String

#is_note_tweet ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :is_note_tweet, XTwitterScraper::Internal::Type::Boolean

#media ⇒ Array<String>?

Array of public media URLs to attach. Supports up to 4 images or exactly 1 MP4 video up to 100 MB. Each URL must be publicly reachable. Attached media adds 2 credits per started MB across all files.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :media, XTwitterScraper::Internal::Type::ArrayOf[String]

#reply_to_tweet_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :reply_to_tweet_id, String

#text ⇒ String?

Tweet text (optional when media is provided)

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :text, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


57
 
# File 'sig/x_twitter_scraper/models/x/tweet_create_params.rbs', line 57

def to_hash: -> {