Class: XTwitterScraper::Resources::Subscribe

Inherits:

Object

• Object
• XTwitterScraper::Resources::Subscribe

Defined in:

lib/x_twitter_scraper/resources/subscribe.rb,
sig/x_twitter_scraper/resources/subscribe.rbs

Overview

Subscription, billing, and credits

Instance Method Summary

• #create(tier: nil, request_options: {}) ⇒ XTwitterScraper::Models::SubscribeCreateResponse

  Create a subscription checkout or billing-management URL only after the user confirms.

• #initialize(client:) ⇒ Subscribe constructor private

  A new instance of Subscribe.

Constructor Details

#initialize(client:) ⇒ Subscribe

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 Subscribe.

Parameters:

• client (XTwitterScraper::Client)
• client: (XTwitterScraper::Client)

# File 'lib/x_twitter_scraper/resources/subscribe.rb', line 33

def initialize(client:)
  @client = client
end

Instance Method Details

#create(tier: nil, request_options: {}) ⇒ XTwitterScraper::Models::SubscribeCreateResponse

Create a subscription checkout or billing-management URL only after the user confirms. The request never completes payment by itself.

Parameters:

• tier (Symbol, XTwitterScraper::Models::SubscribeCreateParams::Tier) —

  Subscription tier to pre-select.

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

Returns:

• (XTwitterScraper::Models::SubscribeCreateResponse)

See Also:

• Models::SubscribeCreateParams

# File 'lib/x_twitter_scraper/resources/subscribe.rb', line 19

def create(params = {})
  parsed, options = XTwitterScraper::SubscribeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "subscribe",
    body: parsed,
    model: XTwitterScraper::Models::SubscribeCreateResponse,
    options: options
  )
end