Class: ScrapeBadger::TwitterApi

Inherits:
Object
  • Object
show all
Defined in:
lib/scrapebadger/api/twitter_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TwitterApi

Returns a new instance of TwitterApi.



19
20
21
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#twitter_advanced_tweet_search(query, opts = {}) ⇒ Object

Advanced tweet search Search tweets with advanced options.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_type (String)
  • :count (Integer)
  • :cursor (String)

Returns:

  • (Object) 


30
31
32
33
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 30

def twitter_advanced_tweet_search(query, opts = {})
  data, _status_code, _headers = twitter_advanced_tweet_search_with_http_info(query, opts)
  data
end

#twitter_advanced_tweet_search_with_http_info(query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Advanced tweet search Search tweets with advanced options.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query_type (String)
  • :count (Integer)
  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 43

def twitter_advanced_tweet_search_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_advanced_tweet_search ...'
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling TwitterApi.twitter_advanced_tweet_search"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/advanced_search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'query_type'] = opts[:'query_type'] if !opts[:'query_type'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_advanced_tweet_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_advanced_tweet_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_batch_get_users_by_ids(user_ids, opts = {}) ⇒ Object

Batch get users by IDs Get multiple user profiles by their numeric IDs (comma-separated).

Parameters:

  • user_ids (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


100
101
102
103
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 100

def twitter_batch_get_users_by_ids(user_ids, opts = {})
  data, _status_code, _headers = twitter_batch_get_users_by_ids_with_http_info(user_ids, opts)
  data
end

#twitter_batch_get_users_by_ids_with_http_info(user_ids, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Batch get users by IDs Get multiple user profiles by their numeric IDs (comma-separated).

Parameters:

  • user_ids (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 110

def twitter_batch_get_users_by_ids_with_http_info(user_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_batch_get_users_by_ids ...'
  end
  # verify the required parameter 'user_ids' is set
  if @api_client.config.client_side_validation && user_ids.nil?
    fail ArgumentError, "Missing the required parameter 'user_ids' when calling TwitterApi.twitter_batch_get_users_by_ids"
  end
  # resource path
  local_var_path = '/v1/twitter/users/batch_by_ids'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'user_ids'] = user_ids

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_batch_get_users_by_ids",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_batch_get_users_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_batch_get_users_by_usernames(usernames, opts = {}) ⇒ Object

Batch get users by usernames Get multiple user profiles by their usernames (comma-separated).

Parameters:

  • usernames (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


164
165
166
167
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 164

def twitter_batch_get_users_by_usernames(usernames, opts = {})
  data, _status_code, _headers = twitter_batch_get_users_by_usernames_with_http_info(usernames, opts)
  data
end

#twitter_batch_get_users_by_usernames_with_http_info(usernames, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Batch get users by usernames Get multiple user profiles by their usernames (comma-separated).

Parameters:

  • usernames (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 174

def twitter_batch_get_users_by_usernames_with_http_info(usernames, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_batch_get_users_by_usernames ...'
  end
  # verify the required parameter 'usernames' is set
  if @api_client.config.client_side_validation && usernames.nil?
    fail ArgumentError, "Missing the required parameter 'usernames' when calling TwitterApi.twitter_batch_get_users_by_usernames"
  end
  # resource path
  local_var_path = '/v1/twitter/users/batch_by_usernames'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'usernames'] = usernames

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_batch_get_users_by_usernames",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_batch_get_users_by_usernames\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_configure_webhook_on_a_monitor(webhook_create, opts = {}) ⇒ WebhookResponse

Configure webhook on a monitor Configure a webhook delivery URL on a stream monitor. The secret is returned only once on creation. Subsequent calls show secret_set: bool. If monitor already has a webhook, delete it first (409 is returned).

Parameters:

  • webhook_create (WebhookCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



228
229
230
231
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 228

def twitter_configure_webhook_on_a_monitor(webhook_create, opts = {})
  data, _status_code, _headers = twitter_configure_webhook_on_a_monitor_with_http_info(webhook_create, opts)
  data
end

#twitter_configure_webhook_on_a_monitor_with_http_info(webhook_create, opts = {}) ⇒ Array<(WebhookResponse, Integer, Hash)>

Configure webhook on a monitor Configure a webhook delivery URL on a stream monitor. The secret is returned only once on creation. Subsequent calls show secret_set: bool. If monitor already has a webhook, delete it first (409 is returned).

Parameters:

  • webhook_create (WebhookCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WebhookResponse, Integer, Hash)>) —

    WebhookResponse data, response status code and response headers



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 238

def twitter_configure_webhook_on_a_monitor_with_http_info(webhook_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_configure_webhook_on_a_monitor ...'
  end
  # verify the required parameter 'webhook_create' is set
  if @api_client.config.client_side_validation && webhook_create.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_create' when calling TwitterApi.twitter_configure_webhook_on_a_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_create)

  # return_type
  return_type = opts[:debug_return_type] || 'WebhookResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_configure_webhook_on_a_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_configure_webhook_on_a_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_create_filter_rule(filter_rule_create, opts = {}) ⇒ FilterRuleResponse

Create filter rule Create a new query-based tweet filter rule. The rule starts in 'active' status immediately. Credits must be positive. The (api_key_id, tag) pair must be unique.

Parameters:

  • filter_rule_create (FilterRuleCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



296
297
298
299
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 296

def twitter_create_filter_rule(filter_rule_create, opts = {})
  data, _status_code, _headers = twitter_create_filter_rule_with_http_info(filter_rule_create, opts)
  data
end

#twitter_create_filter_rule_with_http_info(filter_rule_create, opts = {}) ⇒ Array<(FilterRuleResponse, Integer, Hash)>

Create filter rule Create a new query-based tweet filter rule. The rule starts in 'active' status immediately. Credits must be positive. The (api_key_id, tag) pair must be unique.

Parameters:

  • filter_rule_create (FilterRuleCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FilterRuleResponse, Integer, Hash)>) —

    FilterRuleResponse data, response status code and response headers



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 306

def twitter_create_filter_rule_with_http_info(filter_rule_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_create_filter_rule ...'
  end
  # verify the required parameter 'filter_rule_create' is set
  if @api_client.config.client_side_validation && filter_rule_create.nil?
    fail ArgumentError, "Missing the required parameter 'filter_rule_create' when calling TwitterApi.twitter_create_filter_rule"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(filter_rule_create)

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_create_filter_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_create_filter_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_create_stream_monitor(stream_monitor_create, opts = {}) ⇒ StreamMonitorResponse

Create stream monitor Create a new stream monitor to watch Twitter accounts in real-time.

Parameters:

  • stream_monitor_create (StreamMonitorCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



364
365
366
367
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 364

def twitter_create_stream_monitor(stream_monitor_create, opts = {})
  data, _status_code, _headers = twitter_create_stream_monitor_with_http_info(stream_monitor_create, opts)
  data
end

#twitter_create_stream_monitor_with_http_info(stream_monitor_create, opts = {}) ⇒ Array<(StreamMonitorResponse, Integer, Hash)>

Create stream monitor Create a new stream monitor to watch Twitter accounts in real-time.

Parameters:

  • stream_monitor_create (StreamMonitorCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StreamMonitorResponse, Integer, Hash)>) —

    StreamMonitorResponse data, response status code and response headers



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 374

def twitter_create_stream_monitor_with_http_info(stream_monitor_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_create_stream_monitor ...'
  end
  # verify the required parameter 'stream_monitor_create' is set
  if @api_client.config.client_side_validation && stream_monitor_create.nil?
    fail ArgumentError, "Missing the required parameter 'stream_monitor_create' when calling TwitterApi.twitter_create_stream_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/monitors'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stream_monitor_create)

  # return_type
  return_type = opts[:debug_return_type] || 'StreamMonitorResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_create_stream_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_create_stream_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_delete_filter_rule(rule_id, opts = {}) ⇒ nil

Delete filter rule Delete a filter rule and all its logs.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


432
433
434
435
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 432

def twitter_delete_filter_rule(rule_id, opts = {})
  twitter_delete_filter_rule_with_http_info(rule_id, opts)
  nil
end

#twitter_delete_filter_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete filter rule Delete a filter rule and all its logs.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 442

def twitter_delete_filter_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_delete_filter_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling TwitterApi.twitter_delete_filter_rule"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_delete_filter_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_delete_filter_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_delete_stream_monitor(monitor_id, opts = {}) ⇒ nil

Delete stream monitor Delete a stream monitor and all its logs.

Parameters:

  • monitor_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


495
496
497
498
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 495

def twitter_delete_stream_monitor(monitor_id, opts = {})
  twitter_delete_stream_monitor_with_http_info(monitor_id, opts)
  nil
end

#twitter_delete_stream_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete stream monitor Delete a stream monitor and all its logs.

Parameters:

  • monitor_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 505

def twitter_delete_stream_monitor_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_delete_stream_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling TwitterApi.twitter_delete_stream_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/monitors/{monitor_id}'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_delete_stream_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_delete_stream_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_article_by_id(article_id, opts = {}) ⇒ Object

Get article by ID Get a long-form article by its ID.

Parameters:

  • article_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


558
559
560
561
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 558

def twitter_get_article_by_id(article_id, opts = {})
  data, _status_code, _headers = twitter_get_article_by_id_with_http_info(article_id, opts)
  data
end

#twitter_get_article_by_id_with_http_info(article_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get article by ID Get a long-form article by its ID.

Parameters:

  • article_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 568

def twitter_get_article_by_id_with_http_info(article_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_article_by_id ...'
  end
  # verify the required parameter 'article_id' is set
  if @api_client.config.client_side_validation && article_id.nil?
    fail ArgumentError, "Missing the required parameter 'article_id' when calling TwitterApi.twitter_get_article_by_id"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/article/{article_id}'.sub('{' + 'article_id' + '}', CGI.escape(article_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_article_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_article_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_broadcast_details(broadcast_id, opts = {}) ⇒ Object

Get broadcast details Get details of a live video broadcast.

Parameters:

  • broadcast_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


621
622
623
624
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 621

def twitter_get_broadcast_details(broadcast_id, opts = {})
  data, _status_code, _headers = twitter_get_broadcast_details_with_http_info(broadcast_id, opts)
  data
end

#twitter_get_broadcast_details_with_http_info(broadcast_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get broadcast details Get details of a live video broadcast.

Parameters:

  • broadcast_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 631

def twitter_get_broadcast_details_with_http_info(broadcast_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_broadcast_details ...'
  end
  # verify the required parameter 'broadcast_id' is set
  if @api_client.config.client_side_validation && broadcast_id.nil?
    fail ArgumentError, "Missing the required parameter 'broadcast_id' when calling TwitterApi.twitter_get_broadcast_details"
  end
  # resource path
  local_var_path = '/v1/twitter/spaces/broadcast/{broadcast_id}'.sub('{' + 'broadcast_id' + '}', CGI.escape(broadcast_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_broadcast_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_broadcast_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_community_details(community_id, opts = {}) ⇒ Object

Get community details Get details of a specific community.

Parameters:

  • community_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


684
685
686
687
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 684

def twitter_get_community_details(community_id, opts = {})
  data, _status_code, _headers = twitter_get_community_details_with_http_info(community_id, opts)
  data
end

#twitter_get_community_details_with_http_info(community_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get community details Get details of a specific community.

Parameters:

  • community_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 694

def twitter_get_community_details_with_http_info(community_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_community_details ...'
  end
  # verify the required parameter 'community_id' is set
  if @api_client.config.client_side_validation && community_id.nil?
    fail ArgumentError, "Missing the required parameter 'community_id' when calling TwitterApi.twitter_get_community_details"
  end
  # resource path
  local_var_path = '/v1/twitter/communities/{community_id}'.sub('{' + 'community_id' + '}', CGI.escape(community_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_community_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_community_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_community_notes(tweet_id, opts = {}) ⇒ Object

Get community notes Get community notes (Birdwatch) for a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


747
748
749
750
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 747

def twitter_get_community_notes(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_community_notes_with_http_info(tweet_id, opts)
  data
end

#twitter_get_community_notes_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get community notes Get community notes (Birdwatch) for a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 757

def twitter_get_community_notes_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_community_notes ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_community_notes"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/community_notes'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_community_notes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_community_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_community_tweets(community_id, opts = {}) ⇒ Object

Get community tweets Get tweets from a specific community.

Parameters:

  • community_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :tweet_type (String)
  • :cursor (String)

Returns:

  • (Object) 


812
813
814
815
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 812

def twitter_get_community_tweets(community_id, opts = {})
  data, _status_code, _headers = twitter_get_community_tweets_with_http_info(community_id, opts)
  data
end

#twitter_get_community_tweets_with_http_info(community_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get community tweets Get tweets from a specific community.

Parameters:

  • community_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :tweet_type (String)
  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 824

def twitter_get_community_tweets_with_http_info(community_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_community_tweets ...'
  end
  # verify the required parameter 'community_id' is set
  if @api_client.config.client_side_validation && community_id.nil?
    fail ArgumentError, "Missing the required parameter 'community_id' when calling TwitterApi.twitter_get_community_tweets"
  end
  # resource path
  local_var_path = '/v1/twitter/communities/{community_id}/tweets'.sub('{' + 'community_id' + '}', CGI.escape(community_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'tweet_type'] = opts[:'tweet_type'] if !opts[:'tweet_type'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_community_tweets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_community_tweets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_filter_rule(rule_id, opts = {}) ⇒ FilterRuleResponse

Get filter rule Get a single filter rule by ID.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



879
880
881
882
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 879

def twitter_get_filter_rule(rule_id, opts = {})
  data, _status_code, _headers = twitter_get_filter_rule_with_http_info(rule_id, opts)
  data
end

#twitter_get_filter_rule_per_poll_rates(opts = {}) ⇒ PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse

Get filter rule per-poll rates Current per-poll rates (auth required — used by SDK + dashboard).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



941
942
943
944
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 941

def twitter_get_filter_rule_per_poll_rates(opts = {})
  data, _status_code, _headers = twitter_get_filter_rule_per_poll_rates_with_http_info(opts)
  data
end

#twitter_get_filter_rule_per_poll_rates_with_http_info(opts = {}) ⇒ Array<(PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse, Integer, Hash)>

Get filter rule per-poll rates Current per-poll rates (auth required — used by SDK + dashboard).

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 950

def twitter_get_filter_rule_per_poll_rates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_filter_rule_per_poll_rates ...'
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules-pricing'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PortalApiRoutersV1TwitterFilterRulesFilterRulePricingResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_filter_rule_per_poll_rates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_filter_rule_per_poll_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_filter_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(FilterRuleResponse, Integer, Hash)>

Get filter rule Get a single filter rule by ID.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FilterRuleResponse, Integer, Hash)>) —

    FilterRuleResponse data, response status code and response headers



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 889

def twitter_get_filter_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_filter_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling TwitterApi.twitter_get_filter_rule"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_filter_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_filter_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_list_details(list_id, opts = {}) ⇒ Object

Get list details Get details of a specific list.

Parameters:

  • list_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


999
1000
1001
1002
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 999

def twitter_get_list_details(list_id, opts = {})
  data, _status_code, _headers = twitter_get_list_details_with_http_info(list_id, opts)
  data
end

#twitter_get_list_details_with_http_info(list_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get list details Get details of a specific list.

Parameters:

  • list_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1009

def twitter_get_list_details_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_list_details ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling TwitterApi.twitter_get_list_details"
  end
  # resource path
  local_var_path = '/v1/twitter/lists/{list_id}/detail'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_list_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_list_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_list_tweets(list_id, opts = {}) ⇒ Object

Get list tweets Get tweets from a specific list.

Parameters:

  • list_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1063
1064
1065
1066
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1063

def twitter_get_list_tweets(list_id, opts = {})
  data, _status_code, _headers = twitter_get_list_tweets_with_http_info(list_id, opts)
  data
end

#twitter_get_list_tweets_with_http_info(list_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get list tweets Get tweets from a specific list.

Parameters:

  • list_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1074

def twitter_get_list_tweets_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_list_tweets ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling TwitterApi.twitter_get_list_tweets"
  end
  # resource path
  local_var_path = '/v1/twitter/lists/{list_id}/tweets'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_list_tweets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_list_tweets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_place_details(place_id, opts = {}) ⇒ Object

Get place details Get details of a specific place.

Parameters:

  • place_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1128
1129
1130
1131
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1128

def twitter_get_place_details(place_id, opts = {})
  data, _status_code, _headers = twitter_get_place_details_with_http_info(place_id, opts)
  data
end

#twitter_get_place_details_with_http_info(place_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get place details Get details of a specific place.

Parameters:

  • place_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1138

def twitter_get_place_details_with_http_info(place_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_place_details ...'
  end
  # verify the required parameter 'place_id' is set
  if @api_client.config.client_side_validation && place_id.nil?
    fail ArgumentError, "Missing the required parameter 'place_id' when calling TwitterApi.twitter_get_place_details"
  end
  # resource path
  local_var_path = '/v1/twitter/geo/places/{place_id}'.sub('{' + 'place_id' + '}', CGI.escape(place_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_place_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_place_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_similar_tweets(tweet_id, opts = {}) ⇒ Object

Get similar tweets Get tweets similar to a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1191
1192
1193
1194
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1191

def twitter_get_similar_tweets(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_similar_tweets_with_http_info(tweet_id, opts)
  data
end

#twitter_get_similar_tweets_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get similar tweets Get tweets similar to a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1201

def twitter_get_similar_tweets_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_similar_tweets ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_similar_tweets"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/similar'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_similar_tweets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_similar_tweets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_space_details(space_id, opts = {}) ⇒ Object

Get Space details Get details of a Twitter Space.

Parameters:

  • space_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1254
1255
1256
1257
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1254

def twitter_get_space_details(space_id, opts = {})
  data, _status_code, _headers = twitter_get_space_details_with_http_info(space_id, opts)
  data
end

#twitter_get_space_details_with_http_info(space_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get Space details Get details of a Twitter Space.

Parameters:

  • space_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1264

def twitter_get_space_details_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_space_details ...'
  end
  # verify the required parameter 'space_id' is set
  if @api_client.config.client_side_validation && space_id.nil?
    fail ArgumentError, "Missing the required parameter 'space_id' when calling TwitterApi.twitter_get_space_details"
  end
  # resource path
  local_var_path = '/v1/twitter/spaces/{space_id}'.sub('{' + 'space_id' + '}', CGI.escape(space_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_space_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_space_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_stream_monitor(monitor_id, opts = {}) ⇒ StreamMonitorResponse

Get stream monitor Get a single stream monitor by ID.

Parameters:

  • monitor_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1317
1318
1319
1320
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1317

def twitter_get_stream_monitor(monitor_id, opts = {})
  data, _status_code, _headers = twitter_get_stream_monitor_with_http_info(monitor_id, opts)
  data
end

#twitter_get_stream_monitor_with_http_info(monitor_id, opts = {}) ⇒ Array<(StreamMonitorResponse, Integer, Hash)>

Get stream monitor Get a single stream monitor by ID.

Parameters:

  • monitor_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StreamMonitorResponse, Integer, Hash)>) —

    StreamMonitorResponse data, response status code and response headers



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1327

def twitter_get_stream_monitor_with_http_info(monitor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_stream_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling TwitterApi.twitter_get_stream_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/monitors/{monitor_id}'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StreamMonitorResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_stream_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_stream_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_trending_topics(opts = {}) ⇒ Object

Get trending topics Get trending topics.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :count (Integer)

Returns:

  • (Object) 


1381
1382
1383
1384
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1381

def twitter_get_trending_topics(opts = {})
  data, _status_code, _headers = twitter_get_trending_topics_with_http_info(opts)
  data
end

#twitter_get_trending_topics_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get trending topics Get trending topics.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :category (String)
  • :count (Integer)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1392

def twitter_get_trending_topics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_trending_topics ...'
  end
  # resource path
  local_var_path = '/v1/twitter/trends/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_trending_topics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_trending_topics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_trends_by_location(woeid, opts = {}) ⇒ Object

Get trends by location Get trending topics for a specific location (WOEID).

Parameters:

  • woeid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1443
1444
1445
1446
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1443

def twitter_get_trends_by_location(woeid, opts = {})
  data, _status_code, _headers = twitter_get_trends_by_location_with_http_info(woeid, opts)
  data
end

#twitter_get_trends_by_location_with_http_info(woeid, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get trends by location Get trending topics for a specific location (WOEID).

Parameters:

  • woeid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1453

def twitter_get_trends_by_location_with_http_info(woeid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_trends_by_location ...'
  end
  # verify the required parameter 'woeid' is set
  if @api_client.config.client_side_validation && woeid.nil?
    fail ArgumentError, "Missing the required parameter 'woeid' when calling TwitterApi.twitter_get_trends_by_location"
  end
  # resource path
  local_var_path = '/v1/twitter/trends/place/{woeid}'.sub('{' + 'woeid' + '}', CGI.escape(woeid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_trends_by_location",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_trends_by_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_details(tweet_id, opts = {}) ⇒ Object

Get tweet details Get detailed information about a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1507
1508
1509
1510
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1507

def twitter_get_tweet_details(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_details_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_details_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet details Get detailed information about a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1518

def twitter_get_tweet_details_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_details ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_details"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_details",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_edit_history(tweet_id, opts = {}) ⇒ Object

Get tweet edit history Get the edit history of a tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1572
1573
1574
1575
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1572

def twitter_get_tweet_edit_history(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_edit_history_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_edit_history_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet edit history Get the edit history of a tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1582

def twitter_get_tweet_edit_history_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_edit_history ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_edit_history"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/edit_history'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_edit_history",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_edit_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_favoriters(tweet_id, opts = {}) ⇒ Object

Get tweet favoriters Get users who favorited a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1636
1637
1638
1639
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1636

def twitter_get_tweet_favoriters(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_favoriters_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_favoriters_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet favoriters Get users who favorited a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1647

def twitter_get_tweet_favoriters_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_favoriters ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_favoriters"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/favoriters'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_favoriters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_favoriters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_quotes(tweet_id, opts = {}) ⇒ Object

Get tweet quotes Get tweets that quote a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1702
1703
1704
1705
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1702

def twitter_get_tweet_quotes(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_quotes_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_quotes_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet quotes Get tweets that quote a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1713

def twitter_get_tweet_quotes_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_quotes ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_quotes"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/quotes'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_quotes",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_quotes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_replies(tweet_id, opts = {}) ⇒ Object

Get tweet replies Get replies to a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1768
1769
1770
1771
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1768

def twitter_get_tweet_replies(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_replies_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_replies_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet replies Get replies to a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1779

def twitter_get_tweet_replies_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_replies ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_replies"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/replies'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_replies",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_replies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweet_retweeters(tweet_id, opts = {}) ⇒ Object

Get tweet retweeters Get users who retweeted a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1834
1835
1836
1837
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1834

def twitter_get_tweet_retweeters(tweet_id, opts = {})
  data, _status_code, _headers = twitter_get_tweet_retweeters_with_http_info(tweet_id, opts)
  data
end

#twitter_get_tweet_retweeters_with_http_info(tweet_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweet retweeters Get users who retweeted a specific tweet.

Parameters:

  • tweet_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1845

def twitter_get_tweet_retweeters_with_http_info(tweet_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweet_retweeters ...'
  end
  # verify the required parameter 'tweet_id' is set
  if @api_client.config.client_side_validation && tweet_id.nil?
    fail ArgumentError, "Missing the required parameter 'tweet_id' when calling TwitterApi.twitter_get_tweet_retweeters"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/tweet/{tweet_id}/retweeters'.sub('{' + 'tweet_id' + '}', CGI.escape(tweet_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweet_retweeters",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweet_retweeters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_tweets_by_ids(tweets, opts = {}) ⇒ Object

Get tweets by IDs Get multiple tweets by their IDs.

Parameters:

  • tweets (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


1899
1900
1901
1902
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1899

def twitter_get_tweets_by_ids(tweets, opts = {})
  data, _status_code, _headers = twitter_get_tweets_by_ids_with_http_info(tweets, opts)
  data
end

#twitter_get_tweets_by_ids_with_http_info(tweets, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get tweets by IDs Get multiple tweets by their IDs.

Parameters:

  • tweets (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1909

def twitter_get_tweets_by_ids_with_http_info(tweets, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_tweets_by_ids ...'
  end
  # verify the required parameter 'tweets' is set
  if @api_client.config.client_side_validation && tweets.nil?
    fail ArgumentError, "Missing the required parameter 'tweets' when calling TwitterApi.twitter_get_tweets_by_ids"
  end
  # resource path
  local_var_path = '/v1/twitter/tweets/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'tweets'] = tweets

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_tweets_by_ids",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_tweets_by_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_articles(user_id, opts = {}) ⇒ Object

Get user articles Get long-form articles written by a user.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


1964
1965
1966
1967
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1964

def twitter_get_user_articles(user_id, opts = {})
  data, _status_code, _headers = twitter_get_user_articles_with_http_info(user_id, opts)
  data
end

#twitter_get_user_articles_with_http_info(user_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user articles Get long-form articles written by a user.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 1975

def twitter_get_user_articles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_articles ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling TwitterApi.twitter_get_user_articles"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{user_id}/articles'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_articles",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_articles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_by_id(user_id, opts = {}) ⇒ Object

Get user by ID Get user profile by user ID.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


2029
2030
2031
2032
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2029

def twitter_get_user_by_id(user_id, opts = {})
  data, _status_code, _headers = twitter_get_user_by_id_with_http_info(user_id, opts)
  data
end

#twitter_get_user_by_id_with_http_info(user_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user by ID Get user profile by user ID.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2039

def twitter_get_user_by_id_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_by_id ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling TwitterApi.twitter_get_user_by_id"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{user_id}/by_id'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_by_username(username, opts = {}) ⇒ Object

Get user by username Get user profile by username.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


2092
2093
2094
2095
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2092

def twitter_get_user_by_username(username, opts = {})
  data, _status_code, _headers = twitter_get_user_by_username_with_http_info(username, opts)
  data
end

#twitter_get_user_by_username_with_http_info(username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user by username Get user profile by username.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2102

def twitter_get_user_by_username_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_by_username ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling TwitterApi.twitter_get_user_by_username"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{username}/by_username'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_by_username",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_by_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_followers(username, opts = {}) ⇒ Object

Get user followers Get followers of a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


2156
2157
2158
2159
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2156

def twitter_get_user_followers(username, opts = {})
  data, _status_code, _headers = twitter_get_user_followers_with_http_info(username, opts)
  data
end

#twitter_get_user_followers_with_http_info(username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user followers Get followers of a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2167

def twitter_get_user_followers_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_followers ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling TwitterApi.twitter_get_user_followers"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{username}/followers'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_followers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_followers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_following(username, opts = {}) ⇒ Object

Get user following Get users that a specific user is following.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


2222
2223
2224
2225
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2222

def twitter_get_user_following(username, opts = {})
  data, _status_code, _headers = twitter_get_user_following_with_http_info(username, opts)
  data
end

#twitter_get_user_following_with_http_info(username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user following Get users that a specific user is following.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2233

def twitter_get_user_following_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_following ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling TwitterApi.twitter_get_user_following"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{username}/followings'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_following",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_following\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_mentions(username, opts = {}) ⇒ Object

Get user mentions Get tweets mentioning a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :count (Integer)
  • :cursor (String)

Returns:

  • (Object) 


2289
2290
2291
2292
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2289

def twitter_get_user_mentions(username, opts = {})
  data, _status_code, _headers = twitter_get_user_mentions_with_http_info(username, opts)
  data
end

#twitter_get_user_mentions_with_http_info(username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user mentions Get tweets mentioning a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :count (Integer)
  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2301

def twitter_get_user_mentions_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_mentions ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling TwitterApi.twitter_get_user_mentions"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{username}/mentions'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_mentions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_mentions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_subscriptions(user_id, opts = {}) ⇒ Object

Get user subscriptions Get subscriptions of a specific user.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


2357
2358
2359
2360
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2357

def twitter_get_user_subscriptions(user_id, opts = {})
  data, _status_code, _headers = twitter_get_user_subscriptions_with_http_info(user_id, opts)
  data
end

#twitter_get_user_subscriptions_with_http_info(user_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user subscriptions Get subscriptions of a specific user.

Parameters:

  • user_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2368

def twitter_get_user_subscriptions_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_subscriptions ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling TwitterApi.twitter_get_user_subscriptions"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{user_id}/subscriptions'.sub('{' + 'user_id' + '}', CGI.escape(user_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_subscriptions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_get_user_tweets(username, opts = {}) ⇒ Object

Get user tweets Get latest tweets from a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


2423
2424
2425
2426
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2423

def twitter_get_user_tweets(username, opts = {})
  data, _status_code, _headers = twitter_get_user_tweets_with_http_info(username, opts)
  data
end

#twitter_get_user_tweets_with_http_info(username, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Get user tweets Get latest tweets from a specific user.

Parameters:

  • username (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2434

def twitter_get_user_tweets_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_get_user_tweets ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling TwitterApi.twitter_get_user_tweets"
  end
  # resource path
  local_var_path = '/v1/twitter/users/{username}/latest_tweets'.sub('{' + 'username' + '}', CGI.escape(username.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_get_user_tweets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_get_user_tweets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_billing_logs(opts = {}) ⇒ BillingLogListResponse

List billing logs List billing activity logs for the authenticated API key's monitors.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:



2490
2491
2492
2493
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2490

def twitter_list_billing_logs(opts = {})
  data, _status_code, _headers = twitter_list_billing_logs_with_http_info(opts)
  data
end

#twitter_list_billing_logs_with_http_info(opts = {}) ⇒ Array<(BillingLogListResponse, Integer, Hash)>

List billing logs List billing activity logs for the authenticated API key's monitors.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:

  • (Array<(BillingLogListResponse, Integer, Hash)>) —

    BillingLogListResponse data, response status code and response headers



2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2502

def twitter_list_billing_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_billing_logs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TwitterApi.twitter_list_billing_logs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_billing_logs, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_billing_logs, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/twitter/stream/billing-logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'monitor_id'] = opts[:'monitor_id'] if !opts[:'monitor_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'BillingLogListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_billing_logs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_billing_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_delivery_logs_for_a_filter_rule(rule_id, opts = {}) ⇒ FilterRuleDeliveryLogListResponse

List delivery logs for a filter rule List tweet delivery logs for a specific filter rule.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :delivery_status (String)
  • :author_username (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20
  • :sort (String) — default: default to 'desc'

Returns:



2571
2572
2573
2574
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2571

def twitter_list_delivery_logs_for_a_filter_rule(rule_id, opts = {})
  data, _status_code, _headers = twitter_list_delivery_logs_for_a_filter_rule_with_http_info(rule_id, opts)
  data
end

#twitter_list_delivery_logs_for_a_filter_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(FilterRuleDeliveryLogListResponse, Integer, Hash)>

List delivery logs for a filter rule List tweet delivery logs for a specific filter rule.

Parameters:

  • rule_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :delivery_status (String)
  • :author_username (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20
  • :sort (String) — default: default to 'desc'

Returns:



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2586

def twitter_list_delivery_logs_for_a_filter_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_delivery_logs_for_a_filter_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling TwitterApi.twitter_list_delivery_logs_for_a_filter_rule"
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TwitterApi.twitter_list_delivery_logs_for_a_filter_rule, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_delivery_logs_for_a_filter_rule, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_delivery_logs_for_a_filter_rule, must be greater than or equal to 1.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules/{rule_id}/logs'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'delivery_status'] = opts[:'delivery_status'] if !opts[:'delivery_status'].nil?
  query_params[:'author_username'] = opts[:'author_username'] if !opts[:'author_username'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleDeliveryLogListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_delivery_logs_for_a_filter_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_delivery_logs_for_a_filter_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_filter_rules(opts = {}) ⇒ FilterRuleListResponse

List filter rules List all filter rules for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:



2662
2663
2664
2665
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2662

def twitter_list_filter_rules(opts = {})
  data, _status_code, _headers = twitter_list_filter_rules_with_http_info(opts)
  data
end

#twitter_list_filter_rules_with_http_info(opts = {}) ⇒ Array<(FilterRuleListResponse, Integer, Hash)>

List filter rules List all filter rules for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:

  • (Array<(FilterRuleListResponse, Integer, Hash)>) —

    FilterRuleListResponse data, response status code and response headers



2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2674

def twitter_list_filter_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_filter_rules ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TwitterApi.twitter_list_filter_rules, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_filter_rules, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_filter_rules, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_filter_rules",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_filter_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_stream_monitors(opts = {}) ⇒ StreamMonitorListResponse

List stream monitors List all stream monitors for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:



2740
2741
2742
2743
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2740

def twitter_list_stream_monitors(opts = {})
  data, _status_code, _headers = twitter_list_stream_monitors_with_http_info(opts)
  data
end

#twitter_list_stream_monitors_with_http_info(opts = {}) ⇒ Array<(StreamMonitorListResponse, Integer, Hash)>

List stream monitors List all stream monitors for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20

Returns:

  • (Array<(StreamMonitorListResponse, Integer, Hash)>) —

    StreamMonitorListResponse data, response status code and response headers



2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2752

def twitter_list_stream_monitors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_stream_monitors ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TwitterApi.twitter_list_stream_monitors, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_stream_monitors, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_stream_monitors, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/v1/twitter/stream/monitors'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'StreamMonitorListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_stream_monitors",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_stream_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_tweet_delivery_logs(opts = {}) ⇒ TweetDeliveryLogListResponse

List tweet delivery logs List tweet delivery logs for the authenticated API key's monitors.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)
  • :author_username (String)
  • :delivery_status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20
  • :sort (String) — default: default to 'desc'

Returns:



2821
2822
2823
2824
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2821

def twitter_list_tweet_delivery_logs(opts = {})
  data, _status_code, _headers = twitter_list_tweet_delivery_logs_with_http_info(opts)
  data
end

#twitter_list_tweet_delivery_logs_with_http_info(opts = {}) ⇒ Array<(TweetDeliveryLogListResponse, Integer, Hash)>

List tweet delivery logs List tweet delivery logs for the authenticated API key's monitors.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)
  • :author_username (String)
  • :delivery_status (String)
  • :page (Integer) — default: default to 1
  • :page_size (Integer) — default: default to 20
  • :sort (String) — default: default to 'desc'

Returns:



2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2836

def twitter_list_tweet_delivery_logs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_tweet_delivery_logs ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TwitterApi.twitter_list_tweet_delivery_logs, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_tweet_delivery_logs, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling TwitterApi.twitter_list_tweet_delivery_logs, must be greater than or equal to 1.'
  end

  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
    fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/logs'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'monitor_id'] = opts[:'monitor_id'] if !opts[:'monitor_id'].nil?
  query_params[:'author_username'] = opts[:'author_username'] if !opts[:'author_username'].nil?
  query_params[:'delivery_status'] = opts[:'delivery_status'] if !opts[:'delivery_status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TweetDeliveryLogListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_tweet_delivery_logs",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_tweet_delivery_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_list_webhooks(opts = {}) ⇒ WebhookListResponse

List webhooks List all webhook-configured monitors for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)

Returns:



2907
2908
2909
2910
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2907

def twitter_list_webhooks(opts = {})
  data, _status_code, _headers = twitter_list_webhooks_with_http_info(opts)
  data
end

#twitter_list_webhooks_with_http_info(opts = {}) ⇒ Array<(WebhookListResponse, Integer, Hash)>

List webhooks List all webhook-configured monitors for the authenticated API key.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :monitor_id (String)

Returns:

  • (Array<(WebhookListResponse, Integer, Hash)>) —

    WebhookListResponse data, response status code and response headers



2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2917

def twitter_list_webhooks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_list_webhooks ...'
  end
  # resource path
  local_var_path = '/v1/twitter/stream/webhooks'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'monitor_id'] = opts[:'monitor_id'] if !opts[:'monitor_id'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'WebhookListResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_list_webhooks",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_list_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_remove_webhook_from_monitor(webhook_id, opts = {}) ⇒ nil

Remove webhook from monitor Remove webhook configuration from a monitor. webhook_id is the monitor_id.

Parameters:

  • webhook_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


2967
2968
2969
2970
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2967

def twitter_remove_webhook_from_monitor(webhook_id, opts = {})
  twitter_remove_webhook_from_monitor_with_http_info(webhook_id, opts)
  nil
end

#twitter_remove_webhook_from_monitor_with_http_info(webhook_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove webhook from monitor Remove webhook configuration from a monitor. webhook_id is the monitor_id.

Parameters:

  • webhook_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 2977

def twitter_remove_webhook_from_monitor_with_http_info(webhook_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_remove_webhook_from_monitor ...'
  end
  # verify the required parameter 'webhook_id' is set
  if @api_client.config.client_side_validation && webhook_id.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_id' when calling TwitterApi.twitter_remove_webhook_from_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/webhooks/{webhook_id}'.sub('{' + 'webhook_id' + '}', CGI.escape(webhook_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_remove_webhook_from_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_remove_webhook_from_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_search_communities(query, opts = {}) ⇒ Object

Search communities Search for communities by query.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


3031
3032
3033
3034
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3031

def twitter_search_communities(query, opts = {})
  data, _status_code, _headers = twitter_search_communities_with_http_info(query, opts)
  data
end

#twitter_search_communities_with_http_info(query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Search communities Search for communities by query.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3042

def twitter_search_communities_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_search_communities ...'
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling TwitterApi.twitter_search_communities"
  end
  # resource path
  local_var_path = '/v1/twitter/communities/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_search_communities",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_search_communities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_search_list_tweets(list_id, query, opts = {}) ⇒ Object

Search list tweets Search tweets within a specific list.

Parameters:

  • list_id (String)
  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


3099
3100
3101
3102
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3099

def twitter_search_list_tweets(list_id, query, opts = {})
  data, _status_code, _headers = twitter_search_list_tweets_with_http_info(list_id, query, opts)
  data
end

#twitter_search_list_tweets_with_http_info(list_id, query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Search list tweets Search tweets within a specific list.

Parameters:

  • list_id (String)
  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3111

def twitter_search_list_tweets_with_http_info(list_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_search_list_tweets ...'
  end
  # verify the required parameter 'list_id' is set
  if @api_client.config.client_side_validation && list_id.nil?
    fail ArgumentError, "Missing the required parameter 'list_id' when calling TwitterApi.twitter_search_list_tweets"
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling TwitterApi.twitter_search_list_tweets"
  end
  # resource path
  local_var_path = '/v1/twitter/lists/{list_id}/search_tweets'.sub('{' + 'list_id' + '}', CGI.escape(list_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_search_list_tweets",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_search_list_tweets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_search_places(opts = {}) ⇒ Object

Search places Search for places by query or coordinates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String)
  • :lat (Float)
  • :long (Float)

Returns:

  • (Object) 


3172
3173
3174
3175
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3172

def twitter_search_places(opts = {})
  data, _status_code, _headers = twitter_search_places_with_http_info(opts)
  data
end

#twitter_search_places_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Search places Search for places by query or coordinates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :query (String)
  • :lat (Float)
  • :long (Float)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3184

def twitter_search_places_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_search_places ...'
  end
  # resource path
  local_var_path = '/v1/twitter/geo/search'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?
  query_params[:'lat'] = opts[:'lat'] if !opts[:'lat'].nil?
  query_params[:'long'] = opts[:'long'] if !opts[:'long'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_search_places",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_search_places\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_search_users(query, opts = {}) ⇒ Object

Search users Search for users by query.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Object) 


3237
3238
3239
3240
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3237

def twitter_search_users(query, opts = {})
  data, _status_code, _headers = twitter_search_users_with_http_info(query, opts)
  data
end

#twitter_search_users_with_http_info(query, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Search users Search for users by query.

Parameters:

  • query (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cursor (String)

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3248

def twitter_search_users_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_search_users ...'
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling TwitterApi.twitter_search_users"
  end
  # resource path
  local_var_path = '/v1/twitter/users/search_users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'query'] = query
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_search_users",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_search_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_test_webhook_delivery(webhook_test_request, opts = {}) ⇒ WebhookTestResponse

Test webhook delivery Send a test payload to a monitor's webhook URL. The test payload has type="test" instead of type="tweet". Makes a synchronous HTTP POST and returns the delivery result.

Parameters:

  • webhook_test_request (WebhookTestRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3303
3304
3305
3306
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3303

def twitter_test_webhook_delivery(webhook_test_request, opts = {})
  data, _status_code, _headers = twitter_test_webhook_delivery_with_http_info(webhook_test_request, opts)
  data
end

#twitter_test_webhook_delivery_with_http_info(webhook_test_request, opts = {}) ⇒ Array<(WebhookTestResponse, Integer, Hash)>

Test webhook delivery Send a test payload to a monitor's webhook URL. The test payload has type=&quot;test&quot; instead of type=&quot;tweet&quot;. Makes a synchronous HTTP POST and returns the delivery result.

Parameters:

  • webhook_test_request (WebhookTestRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WebhookTestResponse, Integer, Hash)>) —

    WebhookTestResponse data, response status code and response headers



3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3313

def twitter_test_webhook_delivery_with_http_info(webhook_test_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_test_webhook_delivery ...'
  end
  # verify the required parameter 'webhook_test_request' is set
  if @api_client.config.client_side_validation && webhook_test_request.nil?
    fail ArgumentError, "Missing the required parameter 'webhook_test_request' when calling TwitterApi.twitter_test_webhook_delivery"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/webhooks/test'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_test_request)

  # return_type
  return_type = opts[:debug_return_type] || 'WebhookTestResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_test_webhook_delivery",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_test_webhook_delivery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_twitter_scraper_health_check(opts = {}) ⇒ Object

Twitter scraper health check Check health of the Twitter scraper service. Accepts HEAD so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


3370
3371
3372
3373
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3370

def twitter_twitter_scraper_health_check(opts = {})
  data, _status_code, _headers = twitter_twitter_scraper_health_check_with_http_info(opts)
  data
end

#twitter_twitter_scraper_health_check_head(opts = {}) ⇒ Object

Twitter scraper health check Check health of the Twitter scraper service. Accepts HEAD so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Object) 


3427
3428
3429
3430
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3427

def twitter_twitter_scraper_health_check_head(opts = {})
  data, _status_code, _headers = twitter_twitter_scraper_health_check_head_with_http_info(opts)
  data
end

#twitter_twitter_scraper_health_check_head_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Twitter scraper health check Check health of the Twitter scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3436

def twitter_twitter_scraper_health_check_head_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_twitter_scraper_health_check_head ...'
  end
  # resource path
  local_var_path = '/v1/twitter/health'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_twitter_scraper_health_check_head",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_twitter_scraper_health_check_head\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_twitter_scraper_health_check_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

Twitter scraper health check Check health of the Twitter scraper service. Accepts ``HEAD`` so external uptime checkers (UptimeRobot uses HEAD by default for HTTP monitors) don't get a 405 Method Not Allowed.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3379

def twitter_twitter_scraper_health_check_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_twitter_scraper_health_check ...'
  end
  # resource path
  local_var_path = '/v1/twitter/health'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_twitter_scraper_health_check",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_twitter_scraper_health_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_update_filter_rule(rule_id, filter_rule_update, opts = {}) ⇒ FilterRuleResponse

Update filter rule Partially update a filter rule. Setting status='active' on a paused rule performs a credit check.

Parameters:

  • rule_id (String)
  • filter_rule_update (FilterRuleUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3486
3487
3488
3489
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3486

def twitter_update_filter_rule(rule_id, filter_rule_update, opts = {})
  data, _status_code, _headers = twitter_update_filter_rule_with_http_info(rule_id, filter_rule_update, opts)
  data
end

#twitter_update_filter_rule_with_http_info(rule_id, filter_rule_update, opts = {}) ⇒ Array<(FilterRuleResponse, Integer, Hash)>

Update filter rule Partially update a filter rule. Setting status='active' on a paused rule performs a credit check.

Parameters:

  • rule_id (String)
  • filter_rule_update (FilterRuleUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FilterRuleResponse, Integer, Hash)>) —

    FilterRuleResponse data, response status code and response headers



3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3497

def twitter_update_filter_rule_with_http_info(rule_id, filter_rule_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_update_filter_rule ...'
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling TwitterApi.twitter_update_filter_rule"
  end
  # verify the required parameter 'filter_rule_update' is set
  if @api_client.config.client_side_validation && filter_rule_update.nil?
    fail ArgumentError, "Missing the required parameter 'filter_rule_update' when calling TwitterApi.twitter_update_filter_rule"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules/{rule_id}'.sub('{' + 'rule_id' + '}', CGI.escape(rule_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(filter_rule_update)

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_update_filter_rule",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_update_filter_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_update_stream_monitor(monitor_id, stream_monitor_update, opts = {}) ⇒ StreamMonitorResponse

Update stream monitor Partially update a stream monitor.

Parameters:

  • monitor_id (String)
  • stream_monitor_update (StreamMonitorUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3560
3561
3562
3563
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3560

def twitter_update_stream_monitor(monitor_id, stream_monitor_update, opts = {})
  data, _status_code, _headers = twitter_update_stream_monitor_with_http_info(monitor_id, stream_monitor_update, opts)
  data
end

#twitter_update_stream_monitor_with_http_info(monitor_id, stream_monitor_update, opts = {}) ⇒ Array<(StreamMonitorResponse, Integer, Hash)>

Update stream monitor Partially update a stream monitor.

Parameters:

  • monitor_id (String)
  • stream_monitor_update (StreamMonitorUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(StreamMonitorResponse, Integer, Hash)>) —

    StreamMonitorResponse data, response status code and response headers



3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3571

def twitter_update_stream_monitor_with_http_info(monitor_id, stream_monitor_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_update_stream_monitor ...'
  end
  # verify the required parameter 'monitor_id' is set
  if @api_client.config.client_side_validation && monitor_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitor_id' when calling TwitterApi.twitter_update_stream_monitor"
  end
  # verify the required parameter 'stream_monitor_update' is set
  if @api_client.config.client_side_validation && stream_monitor_update.nil?
    fail ArgumentError, "Missing the required parameter 'stream_monitor_update' when calling TwitterApi.twitter_update_stream_monitor"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/monitors/{monitor_id}'.sub('{' + 'monitor_id' + '}', CGI.escape(monitor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(stream_monitor_update)

  # return_type
  return_type = opts[:debug_return_type] || 'StreamMonitorResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_update_stream_monitor",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_update_stream_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#twitter_validate_search_query(filter_rule_validate_request, opts = {}) ⇒ FilterRuleValidateResponse

Validate search query Validate a Twitter search query string. Performs basic structural validation without making a live Twitter request. Returns valid=True if the query passes syntax checks.

Parameters:

Returns:



3633
3634
3635
3636
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3633

def twitter_validate_search_query(filter_rule_validate_request, opts = {})
  data, _status_code, _headers = twitter_validate_search_query_with_http_info(filter_rule_validate_request, opts)
  data
end

#twitter_validate_search_query_with_http_info(filter_rule_validate_request, opts = {}) ⇒ Array<(FilterRuleValidateResponse, Integer, Hash)>

Validate search query Validate a Twitter search query string. Performs basic structural validation without making a live Twitter request. Returns valid=True if the query passes syntax checks.

Parameters:

Returns:

  • (Array<(FilterRuleValidateResponse, Integer, Hash)>) —

    FilterRuleValidateResponse data, response status code and response headers



3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
 
# File 'lib/scrapebadger/api/twitter_api.rb', line 3643

def twitter_validate_search_query_with_http_info(filter_rule_validate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TwitterApi.twitter_validate_search_query ...'
  end
  # verify the required parameter 'filter_rule_validate_request' is set
  if @api_client.config.client_side_validation && filter_rule_validate_request.nil?
    fail ArgumentError, "Missing the required parameter 'filter_rule_validate_request' when calling TwitterApi.twitter_validate_search_query"
  end
  # resource path
  local_var_path = '/v1/twitter/stream/filter-rules/validate'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(filter_rule_validate_request)

  # return_type
  return_type = opts[:debug_return_type] || 'FilterRuleValidateResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"TwitterApi.twitter_validate_search_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TwitterApi#twitter_validate_search_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end