x-twitter-scraper 0.7.2 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (157) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +3 -3
  4. data/lib/x_twitter_scraper/models/credit_topup_balance_response.rb +5 -5
  5. data/lib/x_twitter_scraper/models/draw_export_params.rb +8 -3
  6. data/lib/x_twitter_scraper/models/draw_list_params.rb +2 -2
  7. data/lib/x_twitter_scraper/models/error.rb +8 -0
  8. data/lib/x_twitter_scraper/models/event_list_params.rb +13 -5
  9. data/lib/x_twitter_scraper/models/extraction_estimate_cost_params.rb +731 -82
  10. data/lib/x_twitter_scraper/models/extraction_estimate_cost_response.rb +1 -0
  11. data/lib/x_twitter_scraper/models/extraction_export_results_params.rb +145 -1
  12. data/lib/x_twitter_scraper/models/extraction_list_params.rb +2 -2
  13. data/lib/x_twitter_scraper/models/extraction_retrieve_params.rb +70 -3
  14. data/lib/x_twitter_scraper/models/extraction_run_params.rb +662 -1
  15. data/lib/x_twitter_scraper/models/extraction_run_response.rb +27 -48
  16. data/lib/x_twitter_scraper/models/guest_wallet_create_response.rb +8 -8
  17. data/lib/x_twitter_scraper/models/guest_wallet_topup_response.rb +9 -9
  18. data/lib/x_twitter_scraper/models/monitor.rb +29 -1
  19. data/lib/x_twitter_scraper/models/paginated_tweets.rb +4 -4
  20. data/lib/x_twitter_scraper/models/paginated_users.rb +5 -5
  21. data/lib/x_twitter_scraper/models/support/attachment_download_params.rb +28 -0
  22. data/lib/x_twitter_scraper/models/x/community_retrieve_members_params.rb +113 -1
  23. data/lib/x_twitter_scraper/models/x/community_retrieve_moderators_params.rb +117 -1
  24. data/lib/x_twitter_scraper/models/x/list_retrieve_followers_params.rb +117 -6
  25. data/lib/x_twitter_scraper/models/x/list_retrieve_members_params.rb +116 -1
  26. data/lib/x_twitter_scraper/models/x/tweet_get_favoriters_params.rb +117 -6
  27. data/lib/x_twitter_scraper/models/x/tweet_get_quotes_params.rb +153 -1
  28. data/lib/x_twitter_scraper/models/x/tweet_get_replies_params.rb +246 -16
  29. data/lib/x_twitter_scraper/models/x/tweet_get_replies_response.rb +3 -2
  30. data/lib/x_twitter_scraper/models/x/tweet_get_retweeters_params.rb +117 -6
  31. data/lib/x_twitter_scraper/models/x/tweet_search_params.rb +187 -14
  32. data/lib/x_twitter_scraper/models/x/tweet_search_response.rb +299 -0
  33. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_params.rb +143 -10
  34. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_response.rb +241 -0
  35. data/lib/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rb +117 -6
  36. data/lib/x_twitter_scraper/models/x/user_retrieve_following_params.rb +143 -10
  37. data/lib/x_twitter_scraper/models/x/user_retrieve_following_response.rb +241 -0
  38. data/lib/x_twitter_scraper/models/x/user_retrieve_likes_params.rb +153 -1
  39. data/lib/x_twitter_scraper/models/x/user_retrieve_media_params.rb +153 -1
  40. data/lib/x_twitter_scraper/models/x/user_retrieve_mentions_params.rb +153 -1
  41. data/lib/x_twitter_scraper/models/x/user_retrieve_replies_params.rb +159 -7
  42. data/lib/x_twitter_scraper/models/x/user_retrieve_search_params.rb +116 -1
  43. data/lib/x_twitter_scraper/models/x/user_retrieve_tweets_params.rb +159 -7
  44. data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rb +157 -8
  45. data/lib/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rb +245 -0
  46. data/lib/x_twitter_scraper/models/x/x_account.rb +7 -11
  47. data/lib/x_twitter_scraper/resources/credits.rb +2 -2
  48. data/lib/x_twitter_scraper/resources/draws.rb +5 -2
  49. data/lib/x_twitter_scraper/resources/events.rb +10 -4
  50. data/lib/x_twitter_scraper/resources/extractions.rb +383 -84
  51. data/lib/x_twitter_scraper/resources/guest_wallets.rb +9 -13
  52. data/lib/x_twitter_scraper/resources/support/attachments.rb +42 -0
  53. data/lib/x_twitter_scraper/resources/support.rb +5 -0
  54. data/lib/x_twitter_scraper/resources/x/communities.rb +95 -4
  55. data/lib/x_twitter_scraper/resources/x/lists.rb +96 -5
  56. data/lib/x_twitter_scraper/resources/x/tweets.rb +286 -28
  57. data/lib/x_twitter_scraper/resources/x/users.rb +531 -41
  58. data/lib/x_twitter_scraper/version.rb +1 -1
  59. data/lib/x_twitter_scraper.rb +7 -1
  60. data/rbi/x_twitter_scraper/models/credit_topup_balance_response.rbi +6 -6
  61. data/rbi/x_twitter_scraper/models/draw_export_params.rbi +6 -3
  62. data/rbi/x_twitter_scraper/models/draw_list_params.rbi +2 -2
  63. data/rbi/x_twitter_scraper/models/error.rbi +40 -0
  64. data/rbi/x_twitter_scraper/models/event_list_params.rbi +15 -4
  65. data/rbi/x_twitter_scraper/models/extraction_estimate_cost_params.rbi +1338 -86
  66. data/rbi/x_twitter_scraper/models/extraction_estimate_cost_response.rbi +5 -0
  67. data/rbi/x_twitter_scraper/models/extraction_export_results_params.rbi +198 -0
  68. data/rbi/x_twitter_scraper/models/extraction_list_params.rbi +2 -2
  69. data/rbi/x_twitter_scraper/models/extraction_retrieve_params.rbi +194 -2
  70. data/rbi/x_twitter_scraper/models/extraction_run_params.rbi +1221 -0
  71. data/rbi/x_twitter_scraper/models/extraction_run_response.rbi +35 -162
  72. data/rbi/x_twitter_scraper/models/guest_wallet_create_response.rbi +8 -6
  73. data/rbi/x_twitter_scraper/models/guest_wallet_topup_response.rbi +9 -7
  74. data/rbi/x_twitter_scraper/models/monitor.rbi +54 -3
  75. data/rbi/x_twitter_scraper/models/paginated_tweets.rbi +4 -4
  76. data/rbi/x_twitter_scraper/models/paginated_users.rbi +5 -5
  77. data/rbi/x_twitter_scraper/models/support/attachment_download_params.rbi +51 -0
  78. data/rbi/x_twitter_scraper/models/x/community_retrieve_members_params.rbi +154 -0
  79. data/rbi/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbi +154 -0
  80. data/rbi/x_twitter_scraper/models/x/list_retrieve_followers_params.rbi +160 -8
  81. data/rbi/x_twitter_scraper/models/x/list_retrieve_members_params.rbi +154 -0
  82. data/rbi/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbi +160 -8
  83. data/rbi/x_twitter_scraper/models/x/tweet_get_quotes_params.rbi +209 -0
  84. data/rbi/x_twitter_scraper/models/x/tweet_get_replies_params.rbi +403 -20
  85. data/rbi/x_twitter_scraper/models/x/tweet_get_replies_response.rbi +3 -2
  86. data/rbi/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbi +160 -8
  87. data/rbi/x_twitter_scraper/models/x/tweet_search_params.rbi +279 -16
  88. data/rbi/x_twitter_scraper/models/x/tweet_search_response.rbi +543 -0
  89. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_params.rbi +228 -12
  90. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_response.rbi +440 -0
  91. data/rbi/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbi +160 -8
  92. data/rbi/x_twitter_scraper/models/x/user_retrieve_following_params.rbi +228 -12
  93. data/rbi/x_twitter_scraper/models/x/user_retrieve_following_response.rbi +440 -0
  94. data/rbi/x_twitter_scraper/models/x/user_retrieve_likes_params.rbi +209 -0
  95. data/rbi/x_twitter_scraper/models/x/user_retrieve_media_params.rbi +209 -0
  96. data/rbi/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbi +209 -0
  97. data/rbi/x_twitter_scraper/models/x/user_retrieve_replies_params.rbi +217 -8
  98. data/rbi/x_twitter_scraper/models/x/user_retrieve_search_params.rbi +154 -0
  99. data/rbi/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbi +217 -8
  100. data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbi +248 -10
  101. data/rbi/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbi +440 -0
  102. data/rbi/x_twitter_scraper/models/x/x_account.rbi +9 -15
  103. data/rbi/x_twitter_scraper/resources/credits.rbi +2 -2
  104. data/rbi/x_twitter_scraper/resources/draws.rbi +3 -2
  105. data/rbi/x_twitter_scraper/resources/events.rbi +5 -2
  106. data/rbi/x_twitter_scraper/resources/extractions.rbi +525 -83
  107. data/rbi/x_twitter_scraper/resources/guest_wallets.rbi +9 -13
  108. data/rbi/x_twitter_scraper/resources/support/attachments.rbi +35 -0
  109. data/rbi/x_twitter_scraper/resources/support.rbi +4 -0
  110. data/rbi/x_twitter_scraper/resources/x/communities.rbi +84 -0
  111. data/rbi/x_twitter_scraper/resources/x/lists.rbi +87 -4
  112. data/rbi/x_twitter_scraper/resources/x/tweets.rbi +307 -31
  113. data/rbi/x_twitter_scraper/resources/x/users.rbi +558 -34
  114. data/sig/x_twitter_scraper/models/error.rbs +16 -0
  115. data/sig/x_twitter_scraper/models/event_list_params.rbs +7 -0
  116. data/sig/x_twitter_scraper/models/extraction_estimate_cost_params.rbs +605 -1
  117. data/sig/x_twitter_scraper/models/extraction_estimate_cost_response.rbs +2 -0
  118. data/sig/x_twitter_scraper/models/extraction_export_results_params.rbs +127 -1
  119. data/sig/x_twitter_scraper/models/extraction_retrieve_params.rbs +74 -1
  120. data/sig/x_twitter_scraper/models/extraction_run_params.rbs +611 -1
  121. data/sig/x_twitter_scraper/models/extraction_run_response.rbs +29 -67
  122. data/sig/x_twitter_scraper/models/guest_wallet_create_response.rbs +4 -4
  123. data/sig/x_twitter_scraper/models/guest_wallet_topup_response.rbs +4 -4
  124. data/sig/x_twitter_scraper/models/monitor.rbs +29 -3
  125. data/sig/x_twitter_scraper/models/support/attachment_download_params.rbs +32 -0
  126. data/sig/x_twitter_scraper/models/x/community_retrieve_members_params.rbs +103 -1
  127. data/sig/x_twitter_scraper/models/x/community_retrieve_moderators_params.rbs +102 -1
  128. data/sig/x_twitter_scraper/models/x/list_retrieve_followers_params.rbs +103 -1
  129. data/sig/x_twitter_scraper/models/x/list_retrieve_members_params.rbs +103 -1
  130. data/sig/x_twitter_scraper/models/x/tweet_get_favoriters_params.rbs +103 -1
  131. data/sig/x_twitter_scraper/models/x/tweet_get_quotes_params.rbs +134 -1
  132. data/sig/x_twitter_scraper/models/x/tweet_get_replies_params.rbs +207 -2
  133. data/sig/x_twitter_scraper/models/x/tweet_get_retweeters_params.rbs +103 -1
  134. data/sig/x_twitter_scraper/models/x/tweet_search_params.rbs +154 -1
  135. data/sig/x_twitter_scraper/models/x/tweet_search_response.rbs +258 -0
  136. data/sig/x_twitter_scraper/models/x/user_retrieve_followers_params.rbs +119 -1
  137. data/sig/x_twitter_scraper/models/x/user_retrieve_followers_response.rbs +216 -0
  138. data/sig/x_twitter_scraper/models/x/user_retrieve_followers_you_know_params.rbs +103 -1
  139. data/sig/x_twitter_scraper/models/x/user_retrieve_following_params.rbs +119 -1
  140. data/sig/x_twitter_scraper/models/x/user_retrieve_following_response.rbs +216 -0
  141. data/sig/x_twitter_scraper/models/x/user_retrieve_likes_params.rbs +134 -1
  142. data/sig/x_twitter_scraper/models/x/user_retrieve_media_params.rbs +134 -1
  143. data/sig/x_twitter_scraper/models/x/user_retrieve_mentions_params.rbs +134 -1
  144. data/sig/x_twitter_scraper/models/x/user_retrieve_replies_params.rbs +134 -1
  145. data/sig/x_twitter_scraper/models/x/user_retrieve_search_params.rbs +102 -1
  146. data/sig/x_twitter_scraper/models/x/user_retrieve_tweets_params.rbs +134 -1
  147. data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_params.rbs +137 -1
  148. data/sig/x_twitter_scraper/models/x/user_retrieve_verified_followers_response.rbs +216 -0
  149. data/sig/x_twitter_scraper/resources/events.rbs +1 -0
  150. data/sig/x_twitter_scraper/resources/extractions.rbs +137 -0
  151. data/sig/x_twitter_scraper/resources/support/attachments.rbs +15 -0
  152. data/sig/x_twitter_scraper/resources/support.rbs +2 -0
  153. data/sig/x_twitter_scraper/resources/x/communities.rbs +28 -0
  154. data/sig/x_twitter_scraper/resources/x/lists.rbs +28 -0
  155. data/sig/x_twitter_scraper/resources/x/tweets.rbs +93 -1
  156. data/sig/x_twitter_scraper/resources/x/users.rbs +173 -3
  157. metadata +19 -1
@@ -17,30 +17,141 @@ module XTwitterScraper
17
17
  # @return [String]
18
18
  required :id, String
19
19
 
20
+ # @!attribute bio_contains
21
+ # Match any comma-separated or line-separated bio term, ignoring case.
22
+ #
23
+ # @return [String, nil]
24
+ optional :bio_contains, String
25
+
20
26
  # @!attribute cursor
21
27
  # Pagination cursor for list followers
22
28
  #
23
29
  # @return [String, nil]
24
30
  optional :cursor, String
25
31
 
32
+ # @!attribute has_location
33
+ # Only return profiles with a location.
34
+ #
35
+ # @return [Boolean, nil]
36
+ optional :has_location, XTwitterScraper::Internal::Type::Boolean
37
+
38
+ # @!attribute has_website
39
+ # Only return profiles with a website.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :has_website, XTwitterScraper::Internal::Type::Boolean
43
+
44
+ # @!attribute location_contains
45
+ # Match a location substring, ignoring case.
46
+ #
47
+ # @return [String, nil]
48
+ optional :location_contains, String
49
+
50
+ # @!attribute max_followers
51
+ # Maximum follower count. Missing counts pass this maximum.
52
+ #
53
+ # @return [Integer, nil]
54
+ optional :max_followers, Integer
55
+
56
+ # @!attribute max_following
57
+ # Maximum following count.
58
+ #
59
+ # @return [Integer, nil]
60
+ optional :max_following, Integer
61
+
62
+ # @!attribute max_statuses
63
+ # Maximum post count. maxPosts is also accepted.
64
+ #
65
+ # @return [Integer, nil]
66
+ optional :max_statuses, Integer
67
+
68
+ # @!attribute min_account_age_days
69
+ # Minimum account age in whole days.
70
+ #
71
+ # @return [Integer, nil]
72
+ optional :min_account_age_days, Integer
73
+
74
+ # @!attribute min_followers
75
+ # Minimum follower count. Filtering happens before billing.
76
+ #
77
+ # @return [Integer, nil]
78
+ optional :min_followers, Integer
79
+
80
+ # @!attribute min_following
81
+ # Minimum following count.
82
+ #
83
+ # @return [Integer, nil]
84
+ optional :min_following, Integer
85
+
86
+ # @!attribute min_statuses
87
+ # Minimum post count. minPosts is also accepted.
88
+ #
89
+ # @return [Integer, nil]
90
+ optional :min_statuses, Integer
91
+
26
92
  # @!attribute page_size
27
- # Maximum user profiles requested from this page (20-200, default 200). The
28
- # response can contain fewer profiles because the source returned fewer or
29
- # remaining credits cover fewer results. Keep requesting next_cursor while
30
- # has_next_page is true. The deprecated limit and count aliases remain accepted.
93
+ # Maximum user profiles requested from this page (20-200, default 200). Source,
94
+ # filters, or credits can return fewer profiles. Keep requesting next_cursor while
95
+ # has_next_page is true. Deprecated aliases remain accepted.
31
96
  #
32
97
  # @return [Integer, nil]
33
98
  optional :page_size, Integer
34
99
 
35
- # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
100
+ # @!attribute username_contains
101
+ # Match a username substring, ignoring case.
102
+ #
103
+ # @return [String, nil]
104
+ optional :username_contains, String
105
+
106
+ # @!attribute verified_only
107
+ # Only return verified profiles.
108
+ #
109
+ # @return [Boolean, nil]
110
+ optional :verified_only, XTwitterScraper::Internal::Type::Boolean
111
+
112
+ # @!attribute verified_type
113
+ # Match the verification type exactly, ignoring case.
114
+ #
115
+ # @return [String, nil]
116
+ optional :verified_type, String
117
+
118
+ # @!method initialize(id:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
36
119
  # Some parameter documentations has been truncated, see
37
120
  # {XTwitterScraper::Models::X::ListRetrieveFollowersParams} for more details.
38
121
  #
39
122
  # @param id [String]
40
123
  #
124
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
125
+ #
41
126
  # @param cursor [String] Pagination cursor for list followers
42
127
  #
43
- # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
128
+ # @param has_location [Boolean] Only return profiles with a location.
129
+ #
130
+ # @param has_website [Boolean] Only return profiles with a website.
131
+ #
132
+ # @param location_contains [String] Match a location substring, ignoring case.
133
+ #
134
+ # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
135
+ #
136
+ # @param max_following [Integer] Maximum following count.
137
+ #
138
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
139
+ #
140
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
141
+ #
142
+ # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
143
+ #
144
+ # @param min_following [Integer] Minimum following count.
145
+ #
146
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
147
+ #
148
+ # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). Source, fi
149
+ #
150
+ # @param username_contains [String] Match a username substring, ignoring case.
151
+ #
152
+ # @param verified_only [Boolean] Only return verified profiles.
153
+ #
154
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
44
155
  #
45
156
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
46
157
  end
@@ -17,25 +17,140 @@ module XTwitterScraper
17
17
  # @return [String]
18
18
  required :id, String
19
19
 
20
+ # @!attribute bio_contains
21
+ # Match any comma-separated or line-separated bio term, ignoring case.
22
+ #
23
+ # @return [String, nil]
24
+ optional :bio_contains, String
25
+
20
26
  # @!attribute cursor
21
27
  # Pagination cursor for list members
22
28
  #
23
29
  # @return [String, nil]
24
30
  optional :cursor, String
25
31
 
32
+ # @!attribute has_location
33
+ # Only return profiles with a location.
34
+ #
35
+ # @return [Boolean, nil]
36
+ optional :has_location, XTwitterScraper::Internal::Type::Boolean
37
+
38
+ # @!attribute has_website
39
+ # Only return profiles with a website.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :has_website, XTwitterScraper::Internal::Type::Boolean
43
+
44
+ # @!attribute location_contains
45
+ # Match a location substring, ignoring case.
46
+ #
47
+ # @return [String, nil]
48
+ optional :location_contains, String
49
+
50
+ # @!attribute max_followers
51
+ # Maximum follower count. Missing counts pass this maximum.
52
+ #
53
+ # @return [Integer, nil]
54
+ optional :max_followers, Integer
55
+
56
+ # @!attribute max_following
57
+ # Maximum following count.
58
+ #
59
+ # @return [Integer, nil]
60
+ optional :max_following, Integer
61
+
62
+ # @!attribute max_statuses
63
+ # Maximum post count. maxPosts is also accepted.
64
+ #
65
+ # @return [Integer, nil]
66
+ optional :max_statuses, Integer
67
+
68
+ # @!attribute min_account_age_days
69
+ # Minimum account age in whole days.
70
+ #
71
+ # @return [Integer, nil]
72
+ optional :min_account_age_days, Integer
73
+
74
+ # @!attribute min_followers
75
+ # Minimum follower count. Filtering happens before billing.
76
+ #
77
+ # @return [Integer, nil]
78
+ optional :min_followers, Integer
79
+
80
+ # @!attribute min_following
81
+ # Minimum following count.
82
+ #
83
+ # @return [Integer, nil]
84
+ optional :min_following, Integer
85
+
86
+ # @!attribute min_statuses
87
+ # Minimum post count. minPosts is also accepted.
88
+ #
89
+ # @return [Integer, nil]
90
+ optional :min_statuses, Integer
91
+
26
92
  # @!attribute page_size
27
93
  # Members per page (20-200, default 20)
28
94
  #
29
95
  # @return [Integer, nil]
30
96
  optional :page_size, Integer
31
97
 
32
- # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
98
+ # @!attribute username_contains
99
+ # Match a username substring, ignoring case.
100
+ #
101
+ # @return [String, nil]
102
+ optional :username_contains, String
103
+
104
+ # @!attribute verified_only
105
+ # Only return verified profiles.
106
+ #
107
+ # @return [Boolean, nil]
108
+ optional :verified_only, XTwitterScraper::Internal::Type::Boolean
109
+
110
+ # @!attribute verified_type
111
+ # Match the verification type exactly, ignoring case.
112
+ #
113
+ # @return [String, nil]
114
+ optional :verified_type, String
115
+
116
+ # @!method initialize(id:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
117
+ # Some parameter documentations has been truncated, see
118
+ # {XTwitterScraper::Models::X::ListRetrieveMembersParams} for more details.
119
+ #
33
120
  # @param id [String]
34
121
  #
122
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
123
+ #
35
124
  # @param cursor [String] Pagination cursor for list members
36
125
  #
126
+ # @param has_location [Boolean] Only return profiles with a location.
127
+ #
128
+ # @param has_website [Boolean] Only return profiles with a website.
129
+ #
130
+ # @param location_contains [String] Match a location substring, ignoring case.
131
+ #
132
+ # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
133
+ #
134
+ # @param max_following [Integer] Maximum following count.
135
+ #
136
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
137
+ #
138
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
139
+ #
140
+ # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
141
+ #
142
+ # @param min_following [Integer] Minimum following count.
143
+ #
144
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
145
+ #
37
146
  # @param page_size [Integer] Members per page (20-200, default 20)
38
147
  #
148
+ # @param username_contains [String] Match a username substring, ignoring case.
149
+ #
150
+ # @param verified_only [Boolean] Only return verified profiles.
151
+ #
152
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
153
+ #
39
154
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
40
155
  end
41
156
  end
@@ -17,30 +17,141 @@ module XTwitterScraper
17
17
  # @return [String]
18
18
  required :id, String
19
19
 
20
+ # @!attribute bio_contains
21
+ # Match any comma-separated or line-separated bio term, ignoring case.
22
+ #
23
+ # @return [String, nil]
24
+ optional :bio_contains, String
25
+
20
26
  # @!attribute cursor
21
27
  # Pagination cursor for favoriters
22
28
  #
23
29
  # @return [String, nil]
24
30
  optional :cursor, String
25
31
 
32
+ # @!attribute has_location
33
+ # Only return profiles with a location.
34
+ #
35
+ # @return [Boolean, nil]
36
+ optional :has_location, XTwitterScraper::Internal::Type::Boolean
37
+
38
+ # @!attribute has_website
39
+ # Only return profiles with a website.
40
+ #
41
+ # @return [Boolean, nil]
42
+ optional :has_website, XTwitterScraper::Internal::Type::Boolean
43
+
44
+ # @!attribute location_contains
45
+ # Match a location substring, ignoring case.
46
+ #
47
+ # @return [String, nil]
48
+ optional :location_contains, String
49
+
50
+ # @!attribute max_followers
51
+ # Maximum follower count. Missing counts pass this maximum.
52
+ #
53
+ # @return [Integer, nil]
54
+ optional :max_followers, Integer
55
+
56
+ # @!attribute max_following
57
+ # Maximum following count.
58
+ #
59
+ # @return [Integer, nil]
60
+ optional :max_following, Integer
61
+
62
+ # @!attribute max_statuses
63
+ # Maximum post count. maxPosts is also accepted.
64
+ #
65
+ # @return [Integer, nil]
66
+ optional :max_statuses, Integer
67
+
68
+ # @!attribute min_account_age_days
69
+ # Minimum account age in whole days.
70
+ #
71
+ # @return [Integer, nil]
72
+ optional :min_account_age_days, Integer
73
+
74
+ # @!attribute min_followers
75
+ # Minimum follower count. Filtering happens before billing.
76
+ #
77
+ # @return [Integer, nil]
78
+ optional :min_followers, Integer
79
+
80
+ # @!attribute min_following
81
+ # Minimum following count.
82
+ #
83
+ # @return [Integer, nil]
84
+ optional :min_following, Integer
85
+
86
+ # @!attribute min_statuses
87
+ # Minimum post count. minPosts is also accepted.
88
+ #
89
+ # @return [Integer, nil]
90
+ optional :min_statuses, Integer
91
+
26
92
  # @!attribute page_size
27
- # Maximum user profiles requested from this page (20-200, default 200). The
28
- # response can contain fewer profiles because the source returned fewer or
29
- # remaining credits cover fewer results. Keep requesting next_cursor while
30
- # has_next_page is true. The deprecated limit and count aliases remain accepted.
93
+ # Maximum user profiles requested from this page (20-200, default 200). Source,
94
+ # filters, or credits can return fewer profiles. Keep requesting next_cursor while
95
+ # has_next_page is true. Deprecated aliases remain accepted.
31
96
  #
32
97
  # @return [Integer, nil]
33
98
  optional :page_size, Integer
34
99
 
35
- # @!method initialize(id:, cursor: nil, page_size: nil, request_options: {})
100
+ # @!attribute username_contains
101
+ # Match a username substring, ignoring case.
102
+ #
103
+ # @return [String, nil]
104
+ optional :username_contains, String
105
+
106
+ # @!attribute verified_only
107
+ # Only return verified profiles.
108
+ #
109
+ # @return [Boolean, nil]
110
+ optional :verified_only, XTwitterScraper::Internal::Type::Boolean
111
+
112
+ # @!attribute verified_type
113
+ # Match the verification type exactly, ignoring case.
114
+ #
115
+ # @return [String, nil]
116
+ optional :verified_type, String
117
+
118
+ # @!method initialize(id:, bio_contains: nil, cursor: nil, has_location: nil, has_website: nil, location_contains: nil, max_followers: nil, max_following: nil, max_statuses: nil, min_account_age_days: nil, min_followers: nil, min_following: nil, min_statuses: nil, page_size: nil, username_contains: nil, verified_only: nil, verified_type: nil, request_options: {})
36
119
  # Some parameter documentations has been truncated, see
37
120
  # {XTwitterScraper::Models::X::TweetGetFavoritersParams} for more details.
38
121
  #
39
122
  # @param id [String]
40
123
  #
124
+ # @param bio_contains [String] Match any comma-separated or line-separated bio term, ignoring case.
125
+ #
41
126
  # @param cursor [String] Pagination cursor for favoriters
42
127
  #
43
- # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). The respon
128
+ # @param has_location [Boolean] Only return profiles with a location.
129
+ #
130
+ # @param has_website [Boolean] Only return profiles with a website.
131
+ #
132
+ # @param location_contains [String] Match a location substring, ignoring case.
133
+ #
134
+ # @param max_followers [Integer] Maximum follower count. Missing counts pass this maximum.
135
+ #
136
+ # @param max_following [Integer] Maximum following count.
137
+ #
138
+ # @param max_statuses [Integer] Maximum post count. maxPosts is also accepted.
139
+ #
140
+ # @param min_account_age_days [Integer] Minimum account age in whole days.
141
+ #
142
+ # @param min_followers [Integer] Minimum follower count. Filtering happens before billing.
143
+ #
144
+ # @param min_following [Integer] Minimum following count.
145
+ #
146
+ # @param min_statuses [Integer] Minimum post count. minPosts is also accepted.
147
+ #
148
+ # @param page_size [Integer] Maximum user profiles requested from this page (20-200, default 200). Source, fi
149
+ #
150
+ # @param username_contains [String] Match a username substring, ignoring case.
151
+ #
152
+ # @param verified_only [Boolean] Only return verified profiles.
153
+ #
154
+ # @param verified_type [String] Match the verification type exactly, ignoring case.
44
155
  #
45
156
  # @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
46
157
  end