Class: XTwitterScraper::Models::EventListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/x_twitter_scraper/models/event_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(after: nil, event_type: nil, limit: nil, monitor_id: nil, request_options: {}) ⇒ Object

Parameters:

  • after (String) (defaults to: nil) —

    Cursor for keyset pagination

  • event_type (Symbol, XTwitterScraper::Models::EventType) (defaults to: nil) —

    Filter events by type

  • limit (Integer) (defaults to: nil) —

    Maximum number of items to return (1-100, default 50)

  • monitor_id (String) (defaults to: nil) —

    Filter events by monitor ID

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



# File 'lib/x_twitter_scraper/models/event_list_params.rb', line 34

Instance Attribute Details

#after ⇒ String?

Cursor for keyset pagination

Returns:

  • (String, nil) 


14
 
# File 'lib/x_twitter_scraper/models/event_list_params.rb', line 14

optional :after, String

#event_type ⇒ Symbol, ...

Filter events by type

Returns:



20
 
# File 'lib/x_twitter_scraper/models/event_list_params.rb', line 20

optional :event_type, enum: -> { XTwitterScraper::EventType }

#limit ⇒ Integer?

Maximum number of items to return (1-100, default 50)

Returns:

  • (Integer, nil) 


26
 
# File 'lib/x_twitter_scraper/models/event_list_params.rb', line 26

optional :limit, Integer

#monitor_id ⇒ String?

Filter events by monitor ID

Returns:

  • (String, nil) 


32
 
# File 'lib/x_twitter_scraper/models/event_list_params.rb', line 32

optional :monitor_id, String