Class: XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest

Defined in:

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

Defined Under Namespace

Modules: Goal

Instance Attribute Summary

• #goal ⇒ Symbol, ...

  Editorial goal used to order the rules and questions.

• #step ⇒ Symbol, :compose
• #style_username ⇒ String^?

  Username from a style analysis saved to this account.

• #topic ⇒ String

  Subject for the post.

Instance Method Summary

• #initialize(topic:, goal: nil, style_username: nil, step: :compose) ⇒ Object constructor
• #to_hash ⇒ {

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(topic:, goal: nil, style_username: nil, step: :compose) ⇒ Object

Parameters:

• topic (String) —

  Subject for the post.

• goal (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest::Goal) (defaults to: nil) —

  Editorial goal used to order the rules and questions.

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

  Username from a style analysis saved to this account.

• step (Symbol, :compose) (defaults to: :compose)

# File 'lib/x_twitter_scraper/models/compose_create_params.rb', line 56

Instance Attribute Details

#goal ⇒ Symbol, ...

Editorial goal used to order the rules and questions.

Returns:

• (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposePrepareRequest::Goal, nil)

# File 'lib/x_twitter_scraper/models/compose_create_params.rb', line 48

optional :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposePrepareRequest::Goal }

#step ⇒ Symbol, :compose

Parameters:

• value (:compose)

Returns:

• (Symbol, :compose)

# File 'lib/x_twitter_scraper/models/compose_create_params.rb', line 36

required :step, const: :compose

#style_username ⇒ String^?

Username from a style analysis saved to this account.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/compose_create_params.rb', line 54

optional :style_username, String, api_name: :styleUsername

#topic ⇒ String

Subject for the post.

Parameters:

• value (String)

Returns:

• (String)

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

required :topic, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/compose_create_params.rbs', line 65

def to_hash: -> {