Class: XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest

Inherits:

Internal::Type::BaseModel

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

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, MediaType

Instance Attribute Summary

• #additional_context ⇒ String^?

  Audience, constraints, sources, or other writing context.

• #call_to_action ⇒ String^?

  Specific action the draft should request.

• #goal ⇒ Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal

  Editorial goal for the guidance.

• #media_type ⇒ Symbol, ...

  Planned media type.

• #step ⇒ Symbol, :refine
• #tone ⇒ String

  Requested writing tone.

• #topic ⇒ String

  Subject for the post.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(goal:, tone:, topic:, additional_context: nil, call_to_action: nil, media_type: nil, step: :refine) ⇒ 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(goal:, tone:, topic:, additional_context: nil, call_to_action: nil, media_type: nil, step: :refine) ⇒ Object

Parameters:

• goal (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal) —

  Editorial goal for the guidance.

• tone (String) —

  Requested writing tone.

• topic (String) —

  Subject for the post.

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

  Audience, constraints, sources, or other writing context.

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

  Specific action the draft should request.

• media_type (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::MediaType) (defaults to: nil) —

  Planned media type.

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

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

Instance Attribute Details

#additional_context ⇒ String^?

Audience, constraints, sources, or other writing context.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :additional_context, String, api_name: :additionalContext

#call_to_action ⇒ String^?

Specific action the draft should request.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :call_to_action, String, api_name: :callToAction

#goal ⇒ Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal

Editorial goal for the guidance.

Parameters:

• value (XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::goal)

Returns:

• (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::Goal)

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

required :goal, enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::Goal }

#media_type ⇒ Symbol, ...

Planned media type.

Returns:

• (Symbol, XTwitterScraper::Models::ComposeCreateParams::Body::ComposeRefineRequest::MediaType, nil)

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

optional :media_type,
enum: -> { XTwitterScraper::ComposeCreateParams::Body::ComposeRefineRequest::MediaType },
api_name: :mediaType

#step ⇒ Symbol, :refine

Parameters:

• value (:refine)

Returns:

• (Symbol, :refine)

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

required :step, const: :refine

#tone ⇒ String

Requested writing tone.

Parameters:

• value (String)

Returns:

• (String)

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

required :tone, String

#topic ⇒ String

Subject for the post.

Parameters:

• value (String)

Returns:

• (String)

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

required :topic, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {