Class: XTwitterScraper::Models::Error

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: Error

Instance Attribute Summary

• #error ⇒ Symbol, ...
• #message ⇒ String^?

  Human-readable error guidance.

• #reason ⇒ String^?

  Machine-readable reason for a login cooldown.

• #retry_after ⇒ Integer^?

  Seconds until the next permitted request.

• #retry_after_ms ⇒ Integer^?

  Required wait in milliseconds.

Instance Method Summary

• #initialize(error:, message: nil, reason: nil, retry_after: nil, retry_after_ms: nil) ⇒ Object constructor

  Error response.

• #to_hash ⇒ {

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(error:, message: nil, reason: nil, retry_after: nil, retry_after_ms: nil) ⇒ Object

Error response. Default v1 returns a legacy string error code. Send xquik-api-contract: 2026-04-29 to receive the structured best-practice error object.

Parameters:

• error (Symbol, XTwitterScraper::Models::Error::Error::LegacyErrorCode, XTwitterScraper::Models::Error::Error::StructuredError)
• message (String) (defaults to: nil) —

  Human-readable error guidance.

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

  Machine-readable reason for a login cooldown.

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

  Seconds until the next permitted request.

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

  Required wait in milliseconds.

# File 'lib/x_twitter_scraper/models/error.rb', line 39

Instance Attribute Details

#error ⇒ Symbol, ...

Parameters:

• value (XTwitterScraper::Models::Error::error)

Returns:

• (Symbol, XTwitterScraper::Models::Error::Error::LegacyErrorCode, XTwitterScraper::Models::Error::Error::StructuredError)

# File 'lib/x_twitter_scraper/models/error.rb', line 13

required :error, union: -> { XTwitterScraper::Error::Error }

#message ⇒ String^?

Human-readable error guidance.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/error.rb', line 19

optional :message, String

#reason ⇒ String^?

Machine-readable reason for a login cooldown.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/x_twitter_scraper/models/error.rb', line 25

optional :reason, String

#retry_after ⇒ Integer^?

Seconds until the next permitted request.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/error.rb', line 31

optional :retry_after, Integer, api_name: :retryAfter

#retry_after_ms ⇒ Integer^?

Required wait in milliseconds.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/x_twitter_scraper/models/error.rb', line 37

optional :retry_after_ms, Integer, api_name: :retryAfterMs

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/x_twitter_scraper/models/error.rbs', line 43

def to_hash: -> {