Class: XTwitterScraper::Models::ExtractionRetrieveParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/x_twitter_scraper/models/extraction_retrieve_params.rb,
sig/x_twitter_scraper/models/extraction_retrieve_params.rbs

Overview

See Also:

• XTwitterScraper::Resources::Extractions#retrieve

Defined Under Namespace

Modules: FieldStyle, OutputMode, OutputPreset

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::XTwitterScraper

Instance Attribute Summary

• #cursor ⇒ String^?

  Previous nextCursor.

• #field_style ⇒ Symbol, ...

  Preserve source keys or convert result field names.

• #id ⇒ String
• #include_raw ⇒ Boolean^?

  Use outputMode=raw instead.

• #limit ⇒ Integer^?

  Maximum number of results to return (1-1000, default 100).

• #output_mode ⇒ Symbol, ...

  Select compact, full, or raw-compatible result fields.

• #output_preset ⇒ Symbol, ...

  Keep enrichment nested or merge it into each result.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, cursor: nil, field_style: nil, include_raw: nil, limit: nil, output_mode: nil, output_preset: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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(id:, cursor: nil, field_style: nil, include_raw: nil, limit: nil, output_mode: nil, output_preset: nil, request_options: {}) ⇒ Object

Parameters:

• id (String)
• cursor (String) (defaults to: nil) —

  Previous nextCursor.

• field_style (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::FieldStyle) (defaults to: nil) —

  Preserve source keys or convert result field names.

• include_raw (Boolean) (defaults to: nil) —

  Use outputMode=raw instead.

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

  Maximum number of results to return (1-1000, default 100)

• output_mode (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputMode) (defaults to: nil) —

  Select compact, full, or raw-compatible result fields.

• output_preset (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputPreset) (defaults to: nil) —

  Keep enrichment nested or merge it into each result.

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

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 55

Instance Attribute Details

#cursor ⇒ String^?

Previous nextCursor.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 23

optional :cursor, String

#field_style ⇒ Symbol, ...

Preserve source keys or convert result field names.

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::FieldStyle, nil)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 29

optional :field_style, enum: -> { XTwitterScraper::ExtractionRetrieveParams::FieldStyle }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 17

required :id, String

#include_raw ⇒ Boolean^?

Use outputMode=raw instead.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 35

optional :include_raw, XTwitterScraper::Internal::Type::Boolean

#limit ⇒ Integer^?

Maximum number of results to return (1-1000, default 100)

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 41

optional :limit, Integer

#output_mode ⇒ Symbol, ...

Select compact, full, or raw-compatible result fields.

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputMode, nil)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 47

optional :output_mode, enum: -> { XTwitterScraper::ExtractionRetrieveParams::OutputMode }

#output_preset ⇒ Symbol, ...

Keep enrichment nested or merge it into each result.

Returns:

• (Symbol, XTwitterScraper::Models::ExtractionRetrieveParams::OutputPreset, nil)

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

optional :output_preset, enum: -> { XTwitterScraper::ExtractionRetrieveParams::OutputPreset }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/x_twitter_scraper/models/extraction_retrieve_params.rb', line 80

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/extraction_retrieve_params.rbs', line 66

def to_hash: -> {