Class: XTwitterScraper::Models::ComposeCreateResponse::ComposeRefineResult::ExamplePattern

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::ComposeCreateResponse::ComposeRefineResult::ExamplePattern

Defined in:

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

Instance Attribute Summary

• #description ⇒ String
• #pattern ⇒ String

Instance Method Summary

• #initialize(composition_guidance:, example_patterns:, intent_url:, next_step:) ⇒ ExamplePattern constructor

  A new instance of ExamplePattern.

• #to_hash ⇒ { description: String, pattern: String }

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(composition_guidance:, example_patterns:, intent_url:, next_step:) ⇒ ExamplePattern

Returns a new instance of ExamplePattern.

Parameters:

• composition_guidance (Array<String>) —

  Goal, tone, media, and editorial guidance.

• example_patterns (Array<XTwitterScraper::Models::ComposeCreateResponse::ComposeRefineResult::ExamplePattern>)
• intent_url (String) —

  X post intent seeded with the topic.

• next_step (String)
• description: (String)
• pattern: (String)

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

class ExamplePattern < XTwitterScraper::Internal::Type::BaseModel
  # @!attribute description
  #
  #   @return [String]
  required :description, String

  # @!attribute pattern
  #
  #   @return [String]
  required :pattern, String

  # @!method initialize(description:, pattern:)
  #   @param description [String]
  #   @param pattern [String]
end

Instance Attribute Details

#description ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :description, String

#pattern ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :pattern, String

Instance Method Details

#to_hash ⇒ { description: String, pattern: String }

Returns:

• ({ description: String, pattern: String })

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

def to_hash: -> { description: String, pattern: String }