Class: XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/compose_create_response.rb,
sig/x_twitter_scraper/models/compose_create_response.rbs

Defined Under Namespace

Classes: ContentRule, EngagementMultiplier, SavedStyle, ScorerWeight

Instance Attribute Summary collapse

Instance Method Summary collapse

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(context:, signal:, weight:) ⇒ Object

Parameters:

  • context (String) —

    Signal direction and publication limit.

  • signal (String) —

    Signal name from X's public ranking repository.

  • weight (nil) —

    X does not publish the production weight.




# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 135

Instance Attribute Details

#content_rules ⇒ Array<XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::ContentRule>

Xquik editorial heuristics, ordered for the goal.

Parameters:

Returns:



24
25
26
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 24

required :content_rules,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::ContentRule] },
api_name: :contentRules

#engagement_multipliers ⇒ Array<XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::EngagementMultiplier>

Published engagement signal names. Production multipliers are not published.

Parameters:

Returns:



32
33
34
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 32

required :engagement_multipliers,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::EngagementMultiplier] },
api_name: :engagementMultipliers

#engagement_velocity ⇒ String

Publication limit for timing and decay claims.

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 40

required :engagement_velocity, String, api_name: :engagementVelocity

#follow_up_questions ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


45
46
47
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 45

required :follow_up_questions,
XTwitterScraper::Internal::Type::ArrayOf[String],
api_name: :followUpQuestions

#intent_url ⇒ String

X post intent seeded with the topic.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :intent_url, String, api_name: :intentUrl

#next_step ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


58
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 58

required :next_step, String, api_name: :nextStep

#saved_styles ⇒ Array<XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::SavedStyle>?

Style analyses saved to the account.

Returns:



84
85
86
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 84

optional :saved_styles,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::SavedStyle] },
api_name: :savedStyles

#scorer_weights ⇒ Array<XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::ScorerWeight>

Published signal names with unpublished weights as null.

Parameters:

Returns:



64
65
66
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 64

required :scorer_weights,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::ComposeCreateResponse::ComposePrepareResult::ScorerWeight] },
api_name: :scorerWeights

#source ⇒ String

Signal source and evidence limits.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :source, String

#style_note ⇒ String?

Next action when no cached style is available.

Parameters:

  • (String)

Returns:

  • (String, nil) 


92
 
# File 'lib/x_twitter_scraper/models/compose_create_response.rb', line 92

optional :style_note, String, api_name: :styleNote

#style_tweets ⇒ Array<String>?

Cached examples for the requested style username.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :style_tweets, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :styleTweets

#top_penalties ⇒ Array<String>

Negative engagement predictions in the public model.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

required :top_penalties, XTwitterScraper::Internal::Type::ArrayOf[String], api_name: :topPenalties

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


79
 
# File 'sig/x_twitter_scraper/models/compose_create_response.rbs', line 79

def to_hash: -> {