Class: XTwitterScraper::Models::X::WriteActionRetrieveResponse

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

Overview

See Also:

  • XTwitterScraper::Resources::X::WriteActions#retrieve

Defined Under Namespace

Modules: Action, Status Classes: Account, Billing, NextAction, Request, Result, Target

Instance Attribute Summary collapse

Class Method 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(hash_:, payload:) ⇒ Object

Stable fingerprint and sanitized payload for replay checks.

Parameters:

  • hash_ (String, nil) —

    Stable hash of account, action, target, and payload.

  • payload (Hash{Symbol=>Object}, nil) —

    Exact sanitized payload dispatched for this action.




# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 251

Instance Attribute Details

#account ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::Account?

Connected account selected for the write.

Parameters:

Returns:



21
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 21

required :account, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Account }, nil?: true

#action ⇒ Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Action

Parameters:

  • value (XTwitterScraper::Models::X::WriteActionRetrieveResponse::action)

Returns:



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

required :action, enum: -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Action }

#billing ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::Billing

plannedCredits is the approved maximum. chargedCredits comes from the settled credit ledger. Pending or failed writes are not charged.

Parameters:

Returns:



33
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 33

required :billing, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Billing }

#charged ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


38
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 38

required :charged, XTwitterScraper::Internal::Type::Boolean

#charged_credits ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 43

required :charged_credits, String, api_name: :chargedCredits

#community_id ⇒ String?

Compatibility field for a confirmed community ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


133
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 133

optional :community_id, String, api_name: :communityId

#community_name ⇒ String?

Confirmed community name when available.

Parameters:

  • (String)

Returns:

  • (String, nil) 


139
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 139

optional :community_name, String, api_name: :communityName

#completed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


144
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 144

optional :completed_at, Time, api_name: :completedAt

#confirmation_attempts ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


149
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 149

optional :confirmation_attempts, Integer, api_name: :confirmationAttempts

#confirmation_checked_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


154
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 154

optional :confirmation_checked_at, Time, api_name: :confirmationCheckedAt

#confirmed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


159
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 159

optional :confirmed_at, Time, api_name: :confirmedAt

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


164
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 164

optional :created_at, Time, api_name: :createdAt

#details ⇒ Hash{Symbol=>Object}?

Structured recovery context for a failed write.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


170
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 170

optional :details, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#error ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


175
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 175

optional :error, String

#expires_at ⇒ Time?

Deadline for resolving a non-terminal write. This is not the Idempotency-Key retention deadline.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


182
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 182

optional :expires_at, Time, api_name: :expiresAt

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 15

required :id, String

#idempotent ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


187
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 187

optional :idempotent, XTwitterScraper::Internal::Type::Boolean

#media ⇒ Hash{Symbol=>Object}?

Media count, kind, size, and billing details when used.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


193
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 193

optional :media, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]

#media_id ⇒ String?

Compatibility field for a confirmed media upload ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


199
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 199

optional :media_id, String, api_name: :mediaId

#media_url ⇒ String?

Public media URL when the upload creates one.

Parameters:

  • (String)

Returns:

  • (String, nil) 


205
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 205

optional :media_url, String, api_name: :mediaUrl

#message ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


210
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 210

optional :message, String

#message_id ⇒ String?

Compatibility field for a confirmed direct message ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


216
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 216

optional :message_id, String, api_name: :messageId

#next_action ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::NextAction?

Exact follow-up an API client or agent should perform.

Parameters:

Returns:



49
50
51
52
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 49

required :next_action,
-> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::NextAction },
api_name: :nextAction,
nil?: true

#object ⇒ Symbol, :x_write_action

Parameters:

  • value (:x_write_action)

Returns:

  • (Symbol, :x_write_action) 


57
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 57

required :object, const: :x_write_action

#poll_after_ms ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


62
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 62

required :poll_after_ms, Integer, api_name: :pollAfterMs, nil?: true

#request ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::Request

Stable fingerprint and sanitized payload for replay checks.

Parameters:

Returns:



68
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 68

required :request, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Request }

#request_hash ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


221
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 221

optional :request_hash, String, api_name: :requestHash

#request_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


226
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 226

optional :request_id, String, api_name: :requestId

#result ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::Result?

Confirmed result produced by the write, when available.

Parameters:

Returns:



74
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 74

required :result, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Result }, nil?: true

#result_id ⇒ String?

Compatibility result ID for other write actions.

Parameters:

  • (String)

Returns:

  • (String, nil) 


232
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 232

optional :result_id, String, api_name: :resultId

#retryable ⇒ Boolean

True only when a new attempt can reasonably succeed.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


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

required :retryable, XTwitterScraper::Internal::Type::Boolean

#safe_to_retry ⇒ Boolean

True only when no write was dispatched and a new idempotency key may be used.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


86
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 86

required :safe_to_retry, XTwitterScraper::Internal::Type::Boolean, api_name: :safeToRetry

#send_dispatched ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


91
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 91

required :send_dispatched, XTwitterScraper::Internal::Type::Boolean, api_name: :sendDispatched

#send_dispatched_at ⇒ Time?

Dispatch timestamp when the write reached execution.

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


238
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 238

optional :send_dispatched_at, Time, api_name: :sendDispatchedAt

#status ⇒ Symbol, XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status

Parameters:

  • value (XTwitterScraper::Models::X::WriteActionRetrieveResponse::status)

Returns:



96
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 96

required :status, enum: -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Status }

#status_url ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


101
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 101

required :status_url, String, api_name: :statusUrl

#success ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


106
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 106

required :success, XTwitterScraper::Internal::Type::Boolean

#target ⇒ XTwitterScraper::Models::X::WriteActionRetrieveResponse::Target?

Existing X resource targeted by the write, when applicable.

Parameters:

Returns:



112
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 112

required :target, -> { XTwitterScraper::Models::X::WriteActionRetrieveResponse::Target }, nil?: true

#target_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


117
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 117

required :target_id, String, api_name: :targetId, nil?: true

#terminal ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


122
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 122

required :terminal, XTwitterScraper::Internal::Type::Boolean

#tweet_id ⇒ String?

Compatibility field for a confirmed tweet result ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


244
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 244

optional :tweet_id, String, api_name: :tweetId

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


249
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 249

optional :updated_at, Time, api_name: :updatedAt

#write_action_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


127
 
# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 127

required :write_action_id, String, api_name: :writeActionId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/x/write_action_retrieve_response.rb', line 387

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


232
 
# File 'sig/x_twitter_scraper/models/x/write_action_retrieve_response.rbs', line 232

def to_hash: -> {