feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 124
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik/x-twitter-scraper-7bcac1557175956021a62532c55ce29b8822b5a41d0d59ae67787a6326c0ef8a.yml
-openapi_spec_hash: 04e28f19097d9b59119101492100c4ab
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik/x-twitter-scraper-f688ec225c65653bb6ba3f51fe643fc69e329fa93cdc13117060d56de13823cc.yml
+openapi_spec_hash: 4ad185ef874409f7cd359beed23f448f
 config_hash: 217d68ca6999ad03cfc4922e9658297e

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

@@ -24,8 +24,8 @@ import java.util.Objects
 import java.util.Optional
 
 /**
- * Create a Stripe Checkout session only after the user confirms. The request never completes
- * payment or adds credits by itself.
+ * Create a hosted checkout only after the user confirms. The request never completes payment or
+ * adds credits.
  */
 class CreditTopupBalanceParams
 private constructor(

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

@@ -36,16 +36,16 @@ private constructor(
     ) : this(redirectUrl, url, mutableMapOf())
 
     /**
-     * Stable first-party Xquik redirect URL for the active Stripe Checkout session.
+     * Stable Xquik redirect URL for the active checkout.
      *
      * @throws XTwitterScraperInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
     fun redirectUrl(): String = redirectUrl.getRequired("redirect_url")
 
     /**
-     * Same stable first-party Xquik redirect URL as redirect_url. The response never exposes a raw
-     * Stripe Checkout URL.
+     * Same stable Xquik redirect URL as redirect_url. The response never exposes the hosted
+     * checkout URL.
      *
      * @throws XTwitterScraperInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -108,7 +108,7 @@ private constructor(
             additionalProperties = creditTopupBalanceResponse.additionalProperties.toMutableMap()
         }
 
-        /** Stable first-party Xquik redirect URL for the active Stripe Checkout session. */
+        /** Stable Xquik redirect URL for the active checkout. */
         fun redirectUrl(redirectUrl: String) = redirectUrl(JsonField.of(redirectUrl))
 
         /**
@@ -121,8 +121,8 @@ private constructor(
         fun redirectUrl(redirectUrl: JsonField<String>) = apply { this.redirectUrl = redirectUrl }
 
         /**
-         * Same stable first-party Xquik redirect URL as redirect_url. The response never exposes a
-         * raw Stripe Checkout URL.
+         * Same stable Xquik redirect URL as redirect_url. The response never exposes the hosted
+         * checkout URL.
          */
         fun url(url: String) = url(JsonField.of(url))
 

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

@@ -23,10 +23,8 @@ import java.util.Collections
 import java.util.Objects
 
 /**
- * Create a one-use Stripe-hosted checkout after the user explicitly confirms a $10-$250 USD amount.
- * This request creates no charge by itself. The user opens checkout_url on Stripe. This endpoint
- * returns the paid-read API key without requiring an Xquik account, email, dashboard, or Xquik web
- * page. An idempotent replay returns the same key.
+ * Create a one-use hosted checkout after the user confirms $10-$250 USD. The request creates no
+ * charge. It returns a paid-read API key without an Xquik account. Replays return the same key.
  */
 class GuestWalletCreateParams
 private constructor(

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

@@ -34,7 +34,7 @@ private constructor(
     private val credentialNotice: JsonValue,
     private val credits: JsonField<String>,
     private val expiresAt: JsonField<OffsetDateTime>,
-    private val instructions: JsonValue,
+    private val instructions: JsonField<String>,
     private val pollAfterSeconds: JsonValue,
     private val purchaseId: JsonField<String>,
     private val requiresUserInteraction: JsonValue,
@@ -66,7 +66,9 @@ private constructor(
         @JsonProperty("expires_at")
         @ExcludeMissing
         expiresAt: JsonField<OffsetDateTime> = JsonMissing.of(),
-        @JsonProperty("instructions") @ExcludeMissing instructions: JsonValue = JsonMissing.of(),
+        @JsonProperty("instructions")
+        @ExcludeMissing
+        instructions: JsonField<String> = JsonMissing.of(),
         @JsonProperty("poll_after_seconds")
         @ExcludeMissing
         pollAfterSeconds: JsonValue = JsonMissing.of(),
@@ -135,7 +137,7 @@ private constructor(
     fun authorization(): Authorization = authorization.getRequired("authorization")
 
     /**
-     * Raw Stripe-hosted checkout URL for user interaction.
+     * Hosted checkout URL for user interaction.
      *
      * @throws XTwitterScraperInvalidDataException if the JSON field has an unexpected type or is
      *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
@@ -172,15 +174,12 @@ private constructor(
     fun expiresAt(): OffsetDateTime = expiresAt.getRequired("expires_at")
 
     /**
-     * Expected to always return the following:
-     * ```java
-     * JsonValue.from("Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.")
-     * ```
+     * Hosted checkout and status polling instructions.
      *
-     * However, this method can be useful for debugging and logging (e.g. if the server responded
-     * with an unexpected value).
+     * @throws XTwitterScraperInvalidDataException if the JSON field has an unexpected type or is
+     *   unexpectedly missing or null (e.g. if the server responded with an unexpected value).
      */
-    @JsonProperty("instructions") @ExcludeMissing fun _instructions(): JsonValue = instructions
+    fun instructions(): String = instructions.getRequired("instructions")
 
     /**
      * Wait at least this long before polling status_url.
@@ -287,6 +286,15 @@ private constructor(
     @ExcludeMissing
     fun _expiresAt(): JsonField<OffsetDateTime> = expiresAt
 
+    /**
+     * Returns the raw JSON value of [instructions].
+     *
+     * Unlike [instructions], this method doesn't throw if the JSON field has an unexpected type.
+     */
+    @JsonProperty("instructions")
+    @ExcludeMissing
+    fun _instructions(): JsonField<String> = instructions
+
     /**
      * Returns the raw JSON value of [purchaseId].
      *
@@ -333,6 +341,7 @@ private constructor(
          * .checkoutUrl()
          * .credits()
          * .expiresAt()
+         * .instructions()
          * .purchaseId()
          * .status()
          * .walletId()
@@ -355,10 +364,7 @@ private constructor(
             )
         private var credits: JsonField<String>? = null
         private var expiresAt: JsonField<OffsetDateTime>? = null
-        private var instructions: JsonValue =
-            JsonValue.from(
-                "Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."
-            )
+        private var instructions: JsonField<String>? = null
         private var pollAfterSeconds: JsonValue = JsonValue.from(2)
         private var purchaseId: JsonField<String>? = null
         private var requiresUserInteraction: JsonValue = JsonValue.from(true)
@@ -443,7 +449,7 @@ private constructor(
             this.authorization = authorization
         }
 
-        /** Raw Stripe-hosted checkout URL for user interaction. */
+        /** Hosted checkout URL for user interaction. */
         fun checkoutUrl(checkoutUrl: String) = checkoutUrl(JsonField.of(checkoutUrl))
 
         /**
@@ -494,19 +500,19 @@ private constructor(
          */
         fun expiresAt(expiresAt: JsonField<OffsetDateTime>) = apply { this.expiresAt = expiresAt }
 
+        /** Hosted checkout and status polling instructions. */
+        fun instructions(instructions: String) = instructions(JsonField.of(instructions))
+
         /**
-         * Sets the field to an arbitrary JSON value.
-         *
-         * It is usually unnecessary to call this method because the field defaults to the
-         * following:
-         * ```java
-         * JsonValue.from("Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending.")
-         * ```
+         * Sets [Builder.instructions] to an arbitrary JSON value.
          *
+         * You should usually call [Builder.instructions] with a well-typed [String] value instead.
          * This method is primarily for setting the field to an undocumented or not yet supported
          * value.
          */
-        fun instructions(instructions: JsonValue) = apply { this.instructions = instructions }
+        fun instructions(instructions: JsonField<String>) = apply {
+            this.instructions = instructions
+        }
 
         /**
          * Sets the field to an arbitrary JSON value.
@@ -617,6 +623,7 @@ private constructor(
          * .checkoutUrl()
          * .credits()
          * .expiresAt()
+         * .instructions()
          * .purchaseId()
          * .status()
          * .walletId()
@@ -634,7 +641,7 @@ private constructor(
                 credentialNotice,
                 checkRequired("credits", credits),
                 checkRequired("expiresAt", expiresAt),
-                instructions,
+                checkRequired("instructions", instructions),
                 pollAfterSeconds,
                 checkRequired("purchaseId", purchaseId),
                 requiresUserInteraction,
@@ -685,16 +692,7 @@ private constructor(
         }
         credits()
         expiresAt()
-        _instructions().let {
-            if (
-                it !=
-                    JsonValue.from(
-                        "Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."
-                    )
-            ) {
-                throw XTwitterScraperInvalidDataException("'instructions' is invalid, received $it")
-            }
-        }
+        instructions()
         _pollAfterSeconds().let {
             if (it != JsonValue.from(2)) {
                 throw XTwitterScraperInvalidDataException(
@@ -752,16 +750,7 @@ private constructor(
             } +
             (if (credits.asKnown().isPresent) 1 else 0) +
             (if (expiresAt.asKnown().isPresent) 1 else 0) +
-            instructions.let {
-                if (
-                    it ==
-                        JsonValue.from(
-                            "Give checkout_url to the user. They must complete payment on Stripe. Never submit payment for them. After payment, poll status_url every poll_after_seconds until latest_purchase.status is no longer pending."
-                        )
-                )
-                    1
-                else 0
-            } +
+            (if (instructions.asKnown().isPresent) 1 else 0) +
             pollAfterSeconds.let { if (it == JsonValue.from(2)) 1 else 0 } +
             (if (purchaseId.asKnown().isPresent) 1 else 0) +
             requiresUserInteraction.let { if (it == JsonValue.from(true)) 1 else 0 } +

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

@@ -12,9 +12,9 @@ import com.x_twitter_scraper.api.core.http.QueryParams
 import java.util.Objects
 
 /**
- * Poll after Stripe payment. Use usable to decide whether paid reads can run. An active wallet can
- * remain usable while a top-up is pending. A new wallet becomes usable only after verified webhook
- * fulfillment. Send the guest key as Authorization: Bearer.
+ * Poll after payment. Use usable to decide whether paid reads can run. An active wallet can remain
+ * usable while a top-up is pending. A new wallet becomes usable only after payment is verified.
+ * Send the guest key as Authorization: Bearer.
  */
 class GuestWalletRetrieveStatusParams
 private constructor(

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

@@ -23,9 +23,9 @@ import java.util.Collections
 import java.util.Objects
 
 /**
- * Create a one-use Stripe-hosted checkout for an existing paid-read guest key after the user
- * explicitly confirms a $10-$250 USD amount. The key remains the same. This request creates no
- * charge by itself and never redirects through an Xquik web page.
+ * Create a one-use hosted checkout after the user confirms a $10-$250 USD amount for an existing
+ * paid-read guest key. The key remains the same. This request creates no charge and never redirects
+ * through Xquik.
  */
 class GuestWalletTopupParams
 private constructor(