Class: XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic

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

Defined Under Namespace

Classes: Strategy

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(diagnostic:, has_next_page: nil, next_cursor: nil) ⇒ Object

Paginated user profiles. No-mode follower, following, and verified follower requests merge independent views automatically. Response fields, page size, aliases, filters, and per-returned-profile billing stay unchanged. Existing unprefixed cursors retain legacy behavior. Follow next_cursor while has_next_page is true.

Parameters:



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 55

class Diagnostic < XTwitterScraper::Internal::Type::BaseModel
  # @!attribute complete
  #   True when every strategy exhausted its source.
  #
  #   @return [Boolean]
  required :complete, XTwitterScraper::Internal::Type::Boolean

  # @!attribute cursor_failure_count
  #
  #   @return [Integer]
  required :cursor_failure_count, Integer, api_name: :cursorFailureCount

  # @!attribute deadline_reached
  #
  #   @return [Boolean]
  required :deadline_reached, XTwitterScraper::Internal::Type::Boolean, api_name: :deadlineReached

  # @!attribute duplicate_count
  #
  #   @return [Integer]
  required :duplicate_count, Integer, api_name: :duplicateCount

  # @!attribute failed_strategy_count
  #
  #   @return [Integer]
  required :failed_strategy_count, Integer, api_name: :failedStrategyCount

  # @!attribute malformed_count
  #
  #   @return [Integer]
  required :malformed_count, Integer, api_name: :malformedCount

  # @!attribute pages_fetched
  #
  #   @return [Integer]
  required :pages_fetched, Integer, api_name: :pagesFetched

  # @!attribute response_truncated
  #   Whether credits or the requested limit reduced output.
  #
  #   @return [Boolean]
  required :response_truncated,
           XTwitterScraper::Internal::Type::Boolean,
           api_name: :responseTruncated

  # @!attribute result_limit_reached
  #
  #   @return [Boolean]
  required :result_limit_reached,
           XTwitterScraper::Internal::Type::Boolean,
           api_name: :resultLimitReached

  # @!attribute returned_users
  #
  #   @return [Integer]
  required :returned_users, Integer, api_name: :returnedUsers

  # @!attribute stalled_strategy_count
  #
  #   @return [Integer]
  required :stalled_strategy_count, Integer, api_name: :stalledStrategyCount

  # @!attribute strategies
  #
  #   @return [Array<XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy>]
  required :strategies,
           -> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy] }

  # @!attribute strategy_count
  #
  #   @return [Integer]
  required :strategy_count, Integer, api_name: :strategyCount

  # @!attribute unique_users
  #
  #   @return [Integer]
  required :unique_users, Integer, api_name: :uniqueUsers

  # @!method initialize(complete:, cursor_failure_count:, deadline_reached:, duplicate_count:, failed_strategy_count:, malformed_count:, pages_fetched:, response_truncated:, result_limit_reached:, returned_users:, stalled_strategy_count:, strategies:, strategy_count:, unique_users:)
  #   Coverage evidence across parallel relationship strategies.
  #
  #   @param complete [Boolean] True when every strategy exhausted its source.
  #
  #   @param cursor_failure_count [Integer]
  #
  #   @param deadline_reached [Boolean]
  #
  #   @param duplicate_count [Integer]
  #
  #   @param failed_strategy_count [Integer]
  #
  #   @param malformed_count [Integer]
  #
  #   @param pages_fetched [Integer]
  #
  #   @param response_truncated [Boolean] Whether credits or the requested limit reduced output.
  #
  #   @param result_limit_reached [Boolean]
  #
  #   @param returned_users [Integer]
  #
  #   @param stalled_strategy_count [Integer]
  #
  #   @param strategies [Array<XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy>]
  #
  #   @param strategy_count [Integer]
  #
  #   @param unique_users [Integer]

  class Strategy < XTwitterScraper::Internal::Type::BaseModel
    # @!attribute duplicate_count
    #
    #   @return [Integer]
    required :duplicate_count, Integer, api_name: :duplicateCount

    # @!attribute pages_fetched
    #
    #   @return [Integer]
    required :pages_fetched, Integer, api_name: :pagesFetched

    # @!attribute stop_reason
    #
    #   @return [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
    required :stop_reason,
             enum: -> { XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason },
             api_name: :stopReason

    # @!attribute strategy
    #
    #   @return [Integer]
    required :strategy, Integer

    # @!attribute unique_added
    #
    #   @return [Integer]
    required :unique_added, Integer, api_name: :uniqueAdded

    # @!method initialize(duplicate_count:, pages_fetched:, stop_reason:, strategy:, unique_added:)
    #   @param duplicate_count [Integer]
    #   @param pages_fetched [Integer]
    #   @param stop_reason [Symbol, XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy::StopReason]
    #   @param strategy [Integer]
    #   @param unique_added [Integer]

    # @see XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy#stop_reason
    module StopReason
      extend XTwitterScraper::Internal::Type::Enum

      CURSOR_FAILURE = :cursor_failure
      DEADLINE = :deadline
      EXHAUSTED = :exhausted
      FAILED = :failed
      PAGE_LIMIT = :page_limit
      RESULT_LIMIT = :result_limit
      STALLED = :stalled

      # @!method self.values
      #   @return [Array<Symbol>]
    end
  end
end

Instance Attribute Details

#complete ⇒ Boolean

True when every strategy exhausted its source.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


60
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 60

required :complete, XTwitterScraper::Internal::Type::Boolean

#cursor_failure_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


65
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 65

required :cursor_failure_count, Integer, api_name: :cursorFailureCount

#deadline_reached ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


70
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 70

required :deadline_reached, XTwitterScraper::Internal::Type::Boolean, api_name: :deadlineReached

#duplicate_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :duplicate_count, Integer, api_name: :duplicateCount

#failed_strategy_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :failed_strategy_count, Integer, api_name: :failedStrategyCount

#malformed_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


85
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 85

required :malformed_count, Integer, api_name: :malformedCount

#pages_fetched ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


90
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 90

required :pages_fetched, Integer, api_name: :pagesFetched

#response_truncated ⇒ Boolean

Whether credits or the requested limit reduced output.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 96

required :response_truncated,
XTwitterScraper::Internal::Type::Boolean,
api_name: :responseTruncated

#result_limit_reached ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 103

required :result_limit_reached,
XTwitterScraper::Internal::Type::Boolean,
api_name: :resultLimitReached

#returned_users ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


110
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 110

required :returned_users, Integer, api_name: :returnedUsers

#stalled_strategy_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


115
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 115

required :stalled_strategy_count, Integer, api_name: :stalledStrategyCount

#strategies ⇒ Array<XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy>

Parameters:

Returns:



120
121
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 120

required :strategies,
-> { XTwitterScraper::Internal::Type::ArrayOf[XTwitterScraper::Models::X::UserRetrieveFollowingResponse::UserListCoverageResponse::Diagnostic::Strategy] }

#strategy_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


126
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 126

required :strategy_count, Integer, api_name: :strategyCount

#unique_users ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


131
 
# File 'lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb', line 131

required :unique_users, Integer, api_name: :uniqueUsers

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


113
 
# File 'sig/x_twitter_scraper/models/x/user_retrieve_following_response.rbs', line 113

def to_hash: -> {