Class: XTwitterScraper::Models::X::UserRetrieveBatchResponse

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

Overview

See Also:

  • XTwitterScraper::Resources::X::Users#retrieve_batch

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(next_cursor:, processed_count:, requested_count:, returned_count:, unavailable_ids:, unprocessed_ids:, users:, has_next_page: false) ⇒ Object

Some parameter documentations has been truncated, see XTwitterScraper::Models::X::UserRetrieveBatchResponse for more details.

Batch user lookup results. Duplicate requested IDs are ignored while preserving first-seen order. unavailable_ids identifies processed IDs with no returned profile. unprocessed_ids identifies IDs skipped when available credits limit processing.

Parameters:

  • next_cursor (String) —

    Empty because batch lookups never paginate.

  • processed_count (Integer) —

    Number of requested IDs included in the lookup.

  • requested_count (Integer) —

    Number of unique IDs requested.

  • returned_count (Integer) —

    Number of user profiles returned and charged.

  • unavailable_ids (Array<String>) —

    Processed IDs with no returned profile, in first-seen request order.

  • unprocessed_ids (Array<String>) —

    Requested IDs skipped because available credits limited processing. Retry these

  • users (Array<XTwitterScraper::Models::UserProfile>)
  • has_next_page (Boolean, false) (defaults to: false) —

    Batch lookups never paginate.




# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 56

Instance Attribute Details

#has_next_page ⇒ Boolean, false

Batch lookups never paginate.

Parameters:

  • value (false)

Returns:

  • (Boolean, false) 


12
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 12

required :has_next_page, const: false

#next_cursor ⇒ String

Empty because batch lookups never paginate.

Parameters:

  • value (String)

Returns:

  • (String) 


18
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 18

required :next_cursor, String

#processed_count ⇒ Integer

Number of requested IDs included in the lookup.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


24
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 24

required :processed_count, Integer

#requested_count ⇒ Integer

Number of unique IDs requested.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


30
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 30

required :requested_count, Integer

#returned_count ⇒ Integer

Number of user profiles returned and charged.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


36
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 36

required :returned_count, Integer

#unavailable_ids ⇒ Array<String>

Processed IDs with no returned profile, in first-seen request order.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


42
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 42

required :unavailable_ids, XTwitterScraper::Internal::Type::ArrayOf[String]

#unprocessed_ids ⇒ Array<String>

Requested IDs skipped because available credits limited processing. Retry these IDs after adding credits.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


49
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 49

required :unprocessed_ids, XTwitterScraper::Internal::Type::ArrayOf[String]

#users ⇒ Array<XTwitterScraper::Models::UserProfile>

Parameters:

Returns:



54
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_batch_response.rb', line 54

required :users, -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::UserProfile] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


44
 
# File 'sig/x_twitter_scraper/models/x/user_retrieve_batch_response.rbs', line 44

def to_hash: -> {