Class: XTwitterScraper::Models::X::Communities::JoinCreateResponse

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

Overview

See Also:

  • XTwitterScraper::Resources::X::Communities::Join#create

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/communities/join_create_response.rb', line 252

Instance Attribute Details

#account ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::Account?

Connected account selected for the write.

Parameters:

Returns:



22
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 22

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

#action ⇒ Symbol, XTwitterScraper::Models::X::Communities::JoinCreateResponse::Action

Parameters:

  • value (XTwitterScraper::Models::X::Communities::JoinCreateResponse::action)

Returns:



27
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 27

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

#billing ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::Billing

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

Parameters:

Returns:



34
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 34

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

#charged ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


39
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 39

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

#charged_credits ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 44

required :charged_credits, String, api_name: :chargedCredits

#community_id ⇒ String?

Compatibility field for a confirmed community ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


134
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 134

optional :community_id, String, api_name: :communityId

#community_name ⇒ String?

Confirmed community name when available.

Parameters:

  • (String)

Returns:

  • (String, nil) 


140
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 140

optional :community_name, String, api_name: :communityName

#completed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


145
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 145

optional :completed_at, Time, api_name: :completedAt

#confirmation_attempts ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


150
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 150

optional :confirmation_attempts, Integer, api_name: :confirmationAttempts

#confirmation_checked_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


155
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 155

optional :confirmation_checked_at, Time, api_name: :confirmationCheckedAt

#confirmed_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


160
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 160

optional :confirmed_at, Time, api_name: :confirmedAt

#created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


165
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 165

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) 


171
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 171

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

#error ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


176
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 176

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) 


183
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 183

optional :expires_at, Time, api_name: :expiresAt

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 16

required :id, String

#idempotent ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


188
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 188

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) 


194
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 194

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) 


200
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 200

optional :media_id, String, api_name: :mediaId

#media_url ⇒ String?

Public media URL when the upload creates one.

Parameters:

  • (String)

Returns:

  • (String, nil) 


206
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 206

optional :media_url, String, api_name: :mediaUrl

#message ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


211
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 211

optional :message, String

#message_id ⇒ String?

Compatibility field for a confirmed direct message ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


217
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 217

optional :message_id, String, api_name: :messageId

#next_action ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::NextAction?

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

Parameters:

Returns:



50
51
52
53
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 50

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

#object ⇒ Symbol, :x_write_action

Parameters:

  • value (:x_write_action)

Returns:

  • (Symbol, :x_write_action) 


58
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 58

required :object, const: :x_write_action

#poll_after_ms ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


63
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 63

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

#request ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::Request

Stable fingerprint and sanitized payload for replay checks.

Parameters:

Returns:



69
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 69

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

#request_hash ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


222
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 222

optional :request_hash, String, api_name: :requestHash

#request_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


227
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 227

optional :request_id, String, api_name: :requestId

#result ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::Result?

Confirmed result produced by the write, when available.

Parameters:

Returns:



75
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 75

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

#result_id ⇒ String?

Compatibility result ID for other write actions.

Parameters:

  • (String)

Returns:

  • (String, nil) 


233
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 233

optional :result_id, String, api_name: :resultId

#retryable ⇒ Boolean

True only when a new attempt can reasonably succeed.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


81
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 81

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) 


87
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 87

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

#send_dispatched ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


92
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 92

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) 


239
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 239

optional :send_dispatched_at, Time, api_name: :sendDispatchedAt

#status ⇒ Symbol, XTwitterScraper::Models::X::Communities::JoinCreateResponse::Status

Parameters:

  • value (XTwitterScraper::Models::X::Communities::JoinCreateResponse::status)

Returns:



97
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 97

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

#status_url ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


102
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 102

required :status_url, String, api_name: :statusUrl

#success ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


107
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 107

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

#target ⇒ XTwitterScraper::Models::X::Communities::JoinCreateResponse::Target?

Existing X resource targeted by the write, when applicable.

Parameters:

Returns:



113
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 113

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

#target_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


118
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 118

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

#terminal ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


123
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 123

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

#tweet_id ⇒ String?

Compatibility field for a confirmed tweet result ID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


245
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 245

optional :tweet_id, String, api_name: :tweetId

#updated_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


250
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 250

optional :updated_at, Time, api_name: :updatedAt

#write_action_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


128
 
# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 128

required :write_action_id, String, api_name: :writeActionId

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/x_twitter_scraper/models/x/communities/join_create_response.rb', line 388

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


233
 
# File 'sig/x_twitter_scraper/models/x/communities/join_create_response.rbs', line 233

def to_hash: -> {