Class: XTwitterScraper::Resources::Monitors::Keywords

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

Overview

Real-time X account monitoring

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Keywords

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

Parameters:



122
123
124
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 122

def initialize(client:)
  @client = client
end

Instance Method Details

#create(event_types:, query:, request_options: {}) ⇒ XTwitterScraper::Models::Monitors::KeywordCreateResponse

Creates an instant keyword monitor. Keyword monitors are unlimited. Active monitors check every 1 second and cost 21 credits per hour. Events and webhook deliveries are included. Creation requires available credits for the first hourly charge.

Parameters:

Returns:

See Also:



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 24

def create(params)
  parsed, options = XTwitterScraper::Monitors::KeywordCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "monitors/keywords",
    body: parsed,
    model: XTwitterScraper::Models::Monitors::KeywordCreateResponse,
    options: options
  )
end

#deactivate(id, request_options: {}) ⇒ XTwitterScraper::Models::Monitors::KeywordDeactivateResponse

Delete keyword monitor

Parameters:

  • id (String) —

    Resource ID returned by the matching create or list endpoint.

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

Returns:

See Also:



110
111
112
113
114
115
116
117
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 110

def deactivate(id, params = {})
  @client.request(
    method: :delete,
    path: ["monitors/keywords/%1$s", id],
    model: XTwitterScraper::Models::Monitors::KeywordDeactivateResponse,
    options: params[:request_options]
  )
end

#list(request_options: {}) ⇒ XTwitterScraper::Models::Monitors::KeywordListResponse

List keyword monitors

Parameters:

Returns:

See Also:



90
91
92
93
94
95
96
97
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 90

def list(params = {})
  @client.request(
    method: :get,
    path: "monitors/keywords",
    model: XTwitterScraper::Models::Monitors::KeywordListResponse,
    options: params[:request_options]
  )
end

#retrieve(id, request_options: {}) ⇒ XTwitterScraper::Models::Monitors::KeywordRetrieveResponse

Get keyword monitor

Parameters:

  • id (String) —

    Resource ID returned by the matching create or list endpoint.

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

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 46

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["monitors/keywords/%1$s", id],
    model: XTwitterScraper::Models::Monitors::KeywordRetrieveResponse,
    options: params[:request_options]
  )
end

#update(id, event_types: nil, is_active: nil, request_options: {}) ⇒ XTwitterScraper::Models::Monitors::KeywordUpdateResponse

Update keyword monitor

Parameters:

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/x_twitter_scraper/resources/monitors/keywords.rb', line 70

def update(id, params = {})
  parsed, options = XTwitterScraper::Monitors::KeywordUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["monitors/keywords/%1$s", id],
    body: parsed,
    model: XTwitterScraper::Models::Monitors::KeywordUpdateResponse,
    options: options
  )
end