Class: XTwitterScraper::Models::ExtractionRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/x_twitter_scraper/models/extraction_retrieve_response.rb,
sig/x_twitter_scraper/models/extraction_retrieve_response.rbs

Overview

See Also:

  • XTwitterScraper::Resources::Extractions#retrieve

Instance Attribute Summary collapse

Instance Method Summary collapse

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(has_more:, job:, results:, next_cursor: nil) ⇒ Object

Parameters:

  • has_more (Boolean)
  • job (Hash{Symbol=>Object}) —

    Extraction job metadata — shape varies by tool type (JSON)

  • results (Array<Hash{Symbol=>Object}>)
  • next_cursor (String) (defaults to: nil) 



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

Instance Attribute Details

#has_more ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


10
 
# File 'lib/x_twitter_scraper/models/extraction_retrieve_response.rb', line 10

required :has_more, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMore

#job ⇒ Hash{Symbol=>Object}

Extraction job metadata — shape varies by tool type (JSON)

Parameters:

  • value (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}) 


16
 
# File 'lib/x_twitter_scraper/models/extraction_retrieve_response.rb', line 16

required :job, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#next_cursor ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/x_twitter_scraper/models/extraction_retrieve_response.rb', line 27

optional :next_cursor, String, api_name: :nextCursor

#results ⇒ Array<Hash{Symbol=>Object}>

Parameters:

  • value (::Array[::Hash[Symbol, top]])

Returns:

  • (Array<Hash{Symbol=>Object}>) 


21
22
 
# File 'lib/x_twitter_scraper/models/extraction_retrieve_response.rb', line 21

required :results,
XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


29
 
# File 'sig/x_twitter_scraper/models/extraction_retrieve_response.rbs', line 29

def to_hash: -> {