Class: XTwitterScraper::Resources::Credits

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/credits.rb,
sig/x_twitter_scraper/resources/credits.rbs

Overview

Subscription, billing, and credits

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Credits

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

Parameters:



100
101
102
 
# File 'lib/x_twitter_scraper/resources/credits.rb', line 100

def initialize(client:)
  @client = client
end

Instance Method Details

#redirect_topup_checkout(session_id:, request_options: {}) ⇒ nil

Redirect to an active top-up payment page

Parameters:

  • session_id (String) —

    Billing session ID returned by the top-up billing flow.

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

Returns:

  • (nil)

See Also:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/x_twitter_scraper/resources/credits.rb', line 18

def redirect_topup_checkout(params)
  parsed, options = XTwitterScraper::CreditRedirectTopupCheckoutParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "credits/topup/redirect",
    query: query,
    model: NilClass,
    security: {},
    options: options
  )
end

#retrieve_balance(request_options: {}) ⇒ XTwitterScraper::Models::CreditRetrieveBalanceResponse

Get credits balance

Parameters:

Returns:

See Also:



40
41
42
43
44
45
46
47
 
# File 'lib/x_twitter_scraper/resources/credits.rb', line 40

def retrieve_balance(params = {})
  @client.request(
    method: :get,
    path: "credits",
    model: XTwitterScraper::Models::CreditRetrieveBalanceResponse,
    options: params[:request_options]
  )
end

#retrieve_topup_status(session_id:, request_options: {}) ⇒ XTwitterScraper::Models::CreditRetrieveTopupStatusResponse

Get top-up billing status

Parameters:

  • session_id (String) —

    Billing session ID returned by the top-up billing flow.

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

Returns:

See Also:



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/x_twitter_scraper/resources/credits.rb', line 60

def retrieve_topup_status(params)
  parsed, options = XTwitterScraper::CreditRetrieveTopupStatusParams.dump_request(params)
  query = XTwitterScraper::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "credits/topup/status",
    query: query,
    model: XTwitterScraper::Models::CreditRetrieveTopupStatusResponse,
    options: options
  )
end

#topup_balance(dollars:, locale: nil, request_options: {}) ⇒ XTwitterScraper::Models::CreditTopupBalanceResponse

Create a Stripe Checkout session only after the user confirms. The request never completes payment or adds credits by itself.

Parameters:

  • dollars (Integer) —

    Amount to top up in US dollars. Minimum 10.

  • locale (String) —

    Optional checkout locale. Defaults to en.

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

Returns:

See Also:



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/x_twitter_scraper/resources/credits.rb', line 86

def topup_balance(params)
  parsed, options = XTwitterScraper::CreditTopupBalanceParams.dump_request(params)
  @client.request(
    method: :post,
    path: "credits/topup",
    body: parsed,
    model: XTwitterScraper::Models::CreditTopupBalanceResponse,
    options: options
  )
end