Class: XTwitterScraper::Resources::Compose

Inherits:

Object

• Object
• XTwitterScraper::Resources::Compose

Defined in:

lib/x_twitter_scraper/resources/compose.rb

Overview

Tweet composition, drafts, writing styles & radar

Instance Method Summary

• #create(step:, additional_context: nil, call_to_action: nil, draft: nil, goal: nil, has_link: nil, has_media: nil, media_type: nil, style_username: nil, tone: nil, topic: nil, request_options: {}) ⇒ XTwitterScraper::Models::ComposeCreateResponse

  Compose, refine, or score a tweet.

• #initialize(client:) ⇒ Compose constructor private

  A new instance of Compose.

Constructor Details

#initialize(client:) ⇒ Compose

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Compose.

Parameters:

• client (XTwitterScraper::Client)

# File 'lib/x_twitter_scraper/resources/compose.rb', line 52

def initialize(client:)
  @client = client
end

Instance Method Details

#create(step:, additional_context: nil, call_to_action: nil, draft: nil, goal: nil, has_link: nil, has_media: nil, media_type: nil, style_username: nil, tone: nil, topic: nil, request_options: {}) ⇒ XTwitterScraper::Models::ComposeCreateResponse

Compose, refine, or score a tweet

Parameters:

• step (Symbol, XTwitterScraper::Models::ComposeCreateParams::Step) —

  Workflow step

• additional_context (String) —

  Extra context or URLs (refine)

• call_to_action (String) —

  Desired call to action (refine)

• draft (String) —

  Tweet draft text to evaluate (score)

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

  Optimization goal

• has_link (Boolean) —

  Whether a link is attached (score)

• has_media (Boolean) —

  Whether media is attached (score)

• media_type (Symbol, XTwitterScraper::Models::ComposeCreateParams::MediaType) —

  Media type (refine)

• style_username (String) —

  Cached style username for voice matching (compose)

• tone (String) —

  Desired tone (refine)

• topic (String) —

  Tweet topic (compose, refine)

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

Returns:

• (XTwitterScraper::Models::ComposeCreateResponse)

See Also:

• Models::ComposeCreateParams

# File 'lib/x_twitter_scraper/resources/compose.rb', line 38

def create(params)
  parsed, options = XTwitterScraper::ComposeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "compose",
    body: parsed,
    model: XTwitterScraper::Models::ComposeCreateResponse,
    options: options
  )
end