Class: XTwitterScraper::Models::ExtractionListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• XTwitterScraper::Models::ExtractionListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/extraction_list_params.rb

Overview

See Also:

• Resources::Extractions#list

Defined Under Namespace

Modules: Status, ToolType

Instance Attribute Summary

• #after ⇒ String^?

  Cursor for keyset pagination.

• #limit ⇒ Integer^?

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

• #status ⇒ Symbol, ...

  Filter by job status.

• #tool_type ⇒ Symbol, ...

  Filter by extraction tool type.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(after: nil, limit: nil, status: nil, tool_type: nil, request_options: {}) ⇒ Object constructor

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, limit: nil, status: nil, tool_type: nil, request_options: {}) ⇒ Object

Parameters:

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

  Cursor for keyset pagination

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

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

• status (Symbol, XTwitterScraper::Models::ExtractionListParams::Status) (defaults to: nil) —

  Filter by job status

• tool_type (Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType) (defaults to: nil) —

  Filter by extraction tool type

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

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

Instance Attribute Details

#after ⇒ String^?

Cursor for keyset pagination

Returns:

• (String, nil)

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

optional :after, String

#limit ⇒ Integer^?

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

Returns:

• (Integer, nil)

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

optional :limit, Integer

#status ⇒ Symbol, ...

Filter by job status

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionListParams::Status, nil)

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

optional :status, enum: -> { XTwitterScraper::ExtractionListParams::Status }

#tool_type ⇒ Symbol, ...

Filter by extraction tool type

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionListParams::ToolType, nil)

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

optional :tool_type, enum: -> { XTwitterScraper::ExtractionListParams::ToolType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/x_twitter_scraper/models/extraction_list_params.rb', line 53