Class: XTwitterScraper::Resources::Monitors

Inherits:
Object
  • Object
show all
Defined in:
lib/x_twitter_scraper/resources/monitors.rb

Overview

Real-time X account monitoring

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Monitors

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

Parameters:



118
119
120
 
# File 'lib/x_twitter_scraper/resources/monitors.rb', line 118

def initialize(client:)
  @client = client
end

Instance Method Details

#create(event_types:, username:, request_options: {}) ⇒ XTwitterScraper::Models::MonitorCreateResponse

Create monitor

Parameters:

Returns:

See Also:



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

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

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

Deactivate monitor

Parameters:

Returns:

See Also:



106
107
108
109
110
111
112
113
 
# File 'lib/x_twitter_scraper/resources/monitors.rb', line 106

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

#list(request_options: {}) ⇒ XTwitterScraper::Models::MonitorListResponse

List monitors

Parameters:

Returns:

See Also:



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

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

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

Get monitor

Parameters:

Returns:

See Also:



42
43
44
45
46
47
48
49
 
# File 'lib/x_twitter_scraper/resources/monitors.rb', line 42

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

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

Update monitor

Parameters:

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/x_twitter_scraper/resources/monitors.rb', line 66

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