feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 102
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik%2Fx-twitter-scraper-61e27e87d4182e5230beae1edaf864a00a5c5f9b96defcdb9a4503544463328f.yml
-openapi_spec_hash: 782f8974cd27e51c8a7993f61b139f72
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik%2Fx-twitter-scraper-ec9b23603f987503f8837da5992b5db4c59a2bc627b090557539791a2b2b64a5.yml
+openapi_spec_hash: faf6a6deaadba884a07e970fd05ac570
 config_hash: 8894c96caeb6df84c9394518810221bd

README.md

@@ -202,7 +202,7 @@ import com.x_twitter_scraper.api.models.x.media.MediaUploadResponse;
 import java.nio.file.Paths;
 
 MediaUploadParams params = MediaUploadParams.builder()
-    .account("account")
+    .account("@elonmusk")
     .file(Paths.get("/path/to/file"))
     .build();
 MediaUploadResponse response = client.x().media().upload(params);
@@ -216,7 +216,7 @@ import com.x_twitter_scraper.api.models.x.media.MediaUploadResponse;
 import java.net.URL;
 
 MediaUploadParams params = MediaUploadParams.builder()
-    .account("account")
+    .account("@elonmusk")
     .file(new URL("https://example.com//path/to/file").openStream())
     .build();
 MediaUploadResponse response = client.x().media().upload(params);
@@ -229,7 +229,7 @@ import com.x_twitter_scraper.api.models.x.media.MediaUploadParams;
 import com.x_twitter_scraper.api.models.x.media.MediaUploadResponse;
 
 MediaUploadParams params = MediaUploadParams.builder()
-    .account("account")
+    .account("@elonmusk")
     .file("content".getBytes())
     .build();
 MediaUploadResponse response = client.x().media().upload(params);
@@ -245,7 +245,7 @@ import java.io.InputStream;
 import java.net.URL;
 
 MediaUploadParams params = MediaUploadParams.builder()
-    .account("account")
+    .account("@elonmusk")
     .file(MultipartField.<InputStream>builder()
         .value(new URL("https://example.com//path/to/file").openStream())
         .filename("/path/to/file")

buildSrc/src/main/kotlin/x-twitter-scraper.publish.gradle.kts

@@ -43,7 +43,7 @@ configure<MavenPublishBaseExtension> {
 
     pom {
         name.set("Xquik API")
-        description.set("X real-time data platform — extractions, giveaway draws, monitoring, webhooks.")
+        description.set("Xquik is an all-in-one X (Twitter) automation API with 40+ endpoints for\nreading, writing, and monitoring X data. **Read endpoints** let you look up\ntweets, search tweets, fetch user profiles, list followers & following, browse\ntimelines, bookmarks, notifications, communities, lists, trending topics, and\ndownload media. **Write endpoints** let you post tweets, reply, like, unlike,\nretweet, unretweet, follow, unfollow, send DMs, upload media, update profiles,\nand manage communities. **Automation endpoints** power bulk data extractions (20\ntool types), giveaway draws from tweet replies, real-time account monitoring\nwith webhooks & Telegram integrations, tweet composition with AI, and writing\nstyle analysis. Authenticate with an API key or OAuth 2.1 bearer token.\nPay-per-use endpoints are also available without an account.")
         url.set("https://xquik.com")
 
         licenses {

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/Error.kt

@@ -17,6 +17,7 @@ import java.util.Collections
 import java.util.Objects
 import kotlin.jvm.optionals.getOrNull
 
+/** Error response containing a machine-readable error code. */
 class Error
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/EventType.kt

@@ -7,6 +7,7 @@ import com.x_twitter_scraper.api.core.Enum
 import com.x_twitter_scraper.api.core.JsonField
 import com.x_twitter_scraper.api.errors.XTwitterScraperInvalidDataException
 
+/** Type of monitor event fired when account activity occurs. */
 class EventType @JsonCreator private constructor(private val value: JsonField<String>) : Enum {
 
     /**

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/PaginatedTweets.kt

@@ -19,6 +19,7 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
+/** Paginated list of tweets with cursor-based navigation. */
 class PaginatedTweets
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(
@@ -244,6 +245,7 @@ private constructor(
             (if (nextCursor.asKnown().isPresent) 1 else 0) +
             (tweets.asKnown().getOrNull()?.sumOf { it.validity().toInt() } ?: 0)
 
+    /** Tweet returned from search results with inline author info. */
     class Tweet
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(
@@ -336,7 +338,7 @@ private constructor(
         fun createdAt(): Optional<String> = createdAt.getOptional("createdAt")
 
         /**
-         * Whether this is a Note Tweet (long-form post, up to 25,000 characters)
+         * True for Note Tweets (long-form content, up to 25,000 characters)
          *
          * @throws XTwitterScraperInvalidDataException if the JSON field has an unexpected type
          *   (e.g. if the server responded with an unexpected value).
@@ -573,7 +575,7 @@ private constructor(
              */
             fun createdAt(createdAt: JsonField<String>) = apply { this.createdAt = createdAt }
 
-            /** Whether this is a Note Tweet (long-form post, up to 25,000 characters) */
+            /** True for Note Tweets (long-form content, up to 25,000 characters) */
             fun isNoteTweet(isNoteTweet: Boolean) = isNoteTweet(JsonField.of(isNoteTweet))
 
             /**

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/PaginatedUsers.kt

@@ -19,6 +19,7 @@ import java.util.Objects
 import java.util.Optional
 import kotlin.jvm.optionals.getOrNull
 
+/** Paginated list of user profiles with cursor-based navigation. */
 class PaginatedUsers
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(
@@ -242,6 +243,7 @@ private constructor(
             (if (nextCursor.asKnown().isPresent) 1 else 0) +
             (users.asKnown().getOrNull()?.sumOf { it.validity().toInt() } ?: 0)
 
+    /** X user profile with bio, follower counts, and verification status. */
     class User
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/apikeys/ApiKey.kt

@@ -17,6 +17,7 @@ import java.util.Collections
 import java.util.Objects
 import java.util.Optional
 
+/** API key metadata returned when listing keys. */
 class ApiKey
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/apikeys/ApiKeyListResponse.kt

@@ -167,6 +167,7 @@ private constructor(
     internal fun validity(): Int =
         (keys.asKnown().getOrNull()?.sumOf { it.validity().toInt() } ?: 0)
 
+    /** API key metadata returned when listing keys. */
     class Key
     @JsonCreator(mode = JsonCreator.Mode.DISABLED)
     private constructor(

x-twitter-scraper-java-core/src/main/kotlin/com/x_twitter_scraper/api/models/drafts/Draft.kt

@@ -17,6 +17,7 @@ import java.util.Collections
 import java.util.Objects
 import java.util.Optional
 
+/** Saved tweet draft with optional topic and goal. */
 class Draft
 @JsonCreator(mode = JsonCreator.Mode.DISABLED)
 private constructor(