x-twitter-scraper 0.12.4 → 0.13.1

package/src/resources/compose.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -13,10 +11,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Compose extends APIResource {
   /**
-   * Run one step of Xquik's three-step writing workflow. Compose returns questions,
-   * editorial rules, and source-specific Radar recommendations. Refine returns
-   * goal-specific guidance. Score applies deterministic text checks. It does not
-   * predict reach or expose X ranking weights.
+   * Uses xai-org/x-algorithm facts to compose and refine text. Score checks text. It
+   * never predicts reach or engagement.
    *
    * @example
    * ```ts
@@ -24,6 +20,7 @@ export class Compose extends APIResource {
    *   step: 'compose',
    *   topic: 'PostgreSQL query planning',
    *   goal: 'engagement',
+   *   styleUsername: 'example_user',
    * });
    * ```
    */
@@ -32,20 +29,26 @@ export class Compose extends APIResource {
   }
 }
 
+/**
+ * Rules, questions, and research guidance for drafting a post.
+ */
 export type ComposeCreateResponse =
   | ComposeCreateResponse.ComposePrepareResult
   | ComposeCreateResponse.ComposeRefineResult
   | ComposeCreateResponse.ComposeScoreResult;
 
 export namespace ComposeCreateResponse {
+  /**
+   * Rules, questions, and research guidance for drafting a post.
+   */
   export interface ComposePrepareResult {
     /**
-     * Xquik editorial heuristics, ordered for the goal.
+     * Facts derived only from xai-org/x-algorithm.
      */
     contentRules: Array<ComposePrepareResult.ContentRule>;
 
     /**
-     * Published engagement signal names. Production multipliers are not published.
+     * Source ranking signals. Repository defaults may vary in production.
      */
     engagementMultipliers: Array<ComposePrepareResult.EngagementMultiplier>;
 
@@ -64,12 +67,14 @@ export namespace ComposeCreateResponse {
     nextStep: string;
 
     /**
-     * Sources and guidance for researching a fresh post angle.
+     * Deprecated compatibility field. Always empty.
+     *
+     * @deprecated
      */
     radarRecommendations: Array<ComposePrepareResult.RadarRecommendation>;
 
     /**
-     * Published signal names with unpublished weights as null.
+     * Source signals with production values withheld as null.
      */
     scorerWeights: Array<ComposePrepareResult.ScorerWeight>;
 
@@ -100,19 +105,30 @@ export namespace ComposeCreateResponse {
   }
 
   export namespace ComposePrepareResult {
+    /**
+     * One source-backed ranking fact returned during preparation.
+     */
     export interface ContentRule {
       rule: string;
     }
 
+    /**
+     * One ranking signal and its source-value limit.
+     */
     export interface EngagementMultiplier {
       /**
        * Human-readable published signal name.
        */
       action: string;
 
-      multiplier: 'Production weight not published by X';
+      multiplier: 'Source default; production value can vary';
     }
 
+    /**
+     * Deprecated compatibility schema. The response array is empty.
+     *
+     * @deprecated
+     */
     export interface RadarRecommendation {
       /**
        * Radar endpoint for this source.
@@ -132,9 +148,12 @@ export namespace ComposeCreateResponse {
       useFor: string;
     }
 
+    /**
+     * One source ranking signal without a production claim.
+     */
     export interface ScorerWeight {
       /**
-       * Signal direction and publication limit.
+       * Signal direction and production limit.
        */
       context: string;
 
@@ -144,28 +163,40 @@ export namespace ComposeCreateResponse {
       signal: string;
 
       /**
-       * X does not publish the production weight.
+       * Null prevents source defaults becoming production claims.
        */
       weight: null;
     }
 
+    /**
+     * A saved username style and analyzed post count.
+     */
     export interface SavedStyle {
+      /**
+       * Whole number from 0.
+       */
       tweetCount: number;
 
       username: string;
     }
   }
 
+  /**
+   * Source-backed guidance for refining a post.
+   */
   export interface ComposeRefineResult {
     /**
-     * Goal, tone, media, and editorial guidance.
+     * Request context and xai-org/x-algorithm guidance.
      */
     compositionGuidance: Array<string>;
 
+    /**
+     * @deprecated
+     */
     examplePatterns: Array<ComposeRefineResult.ExamplePattern>;
 
     /**
-     * X post intent seeded with the topic.
+     * X post intent generated for the refined topic.
      */
     intentUrl: string;
 
@@ -173,6 +204,11 @@ export namespace ComposeCreateResponse {
   }
 
   export namespace ComposeRefineResult {
+    /**
+     * Deprecated example-pattern schema. The response array is empty.
+     *
+     * @deprecated
+     */
     export interface ExamplePattern {
       description: string;
 
@@ -180,9 +216,12 @@ export namespace ComposeCreateResponse {
     }
   }
 
+  /**
+   * Posting validation without a fabricated ranking score.
+   */
   export interface ComposeScoreResult {
     /**
-     * Deterministic editorial checks. Not a reach prediction.
+     * Deterministic input validation. Not a reach prediction.
      */
     checklist: Array<ComposeScoreResult.Checklist>;
 
@@ -194,7 +233,7 @@ export namespace ComposeCreateResponse {
 
     topSuggestion: string;
 
-    totalChecks: 9;
+    totalChecks: 1;
 
     /**
      * Present only when every check passes.
@@ -203,6 +242,9 @@ export namespace ComposeCreateResponse {
   }
 
   export namespace ComposeScoreResult {
+    /**
+     * One deterministic draft check.
+     */
     export interface Checklist {
       factor: string;
 
@@ -216,12 +258,18 @@ export namespace ComposeCreateResponse {
   }
 }
 
+/**
+ * Inputs for preparing source-backed post guidance.
+ */
 export type ComposeCreateParams =
   | ComposeCreateParams.ComposePrepareRequest
   | ComposeCreateParams.ComposeRefineRequest
   | ComposeCreateParams.ComposeScoreRequest;
 
 export declare namespace ComposeCreateParams {
+  /**
+   * Inputs for preparing source-backed post guidance.
+   */
   export interface ComposePrepareRequest {
     step: 'compose';
 
@@ -231,7 +279,7 @@ export declare namespace ComposeCreateParams {
     topic: string;
 
     /**
-     * Editorial goal used to order the rules and questions.
+     * User goal used for one follow-up question.
      */
     goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
 
@@ -243,9 +291,12 @@ export declare namespace ComposeCreateParams {
     [k: string]: unknown;
   }
 
+  /**
+   * Inputs for refining a post plan.
+   */
   export interface ComposeRefineRequest {
     /**
-     * Editorial goal for the guidance.
+     * User goal interpreted against published ranking signals.
      */
     goal: 'engagement' | 'followers' | 'authority' | 'conversation';
 
@@ -257,7 +308,7 @@ export declare namespace ComposeCreateParams {
     tone: string;
 
     /**
-     * Subject for the post.
+     * Subject to refine into a post.
      */
     topic: string;
 
@@ -279,21 +330,24 @@ export declare namespace ComposeCreateParams {
     [k: string]: unknown;
   }
 
+  /**
+   * Inputs for checking a post draft.
+   */
   export interface ComposeScoreRequest {
     /**
-     * Full post text for deterministic editorial checks.
+     * Full post text. The endpoint never assigns a ranking score.
      */
     draft: string;
 
     step: 'score';
 
     /**
-     * True when a separate link card is attached.
+     * @deprecated Ignored. Remove this field.
      */
     hasLink?: boolean;
 
     /**
-     * @deprecated Ignored. Remove this field. Use hasLink for a separate link card.
+     * @deprecated Ignored. Remove this field.
      */
     hasMedia?: boolean;
 

package/src/resources/credits.ts

@@ -2,19 +2,17 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 export class Credits extends APIResource {
   /**
-   * Redirect to an active top-up payment page
+   * Redirects to the active hosted top-up checkout.
    *
    * @example
    * ```ts
@@ -36,7 +34,7 @@ export class Credits extends APIResource {
   }
 
   /**
-   * Get usage balance
+   * Returns the account credit balance and usage context.
    *
    * @example
    * ```ts
@@ -48,7 +46,7 @@ export class Credits extends APIResource {
   }
 
   /**
-   * Get top-up billing status
+   * Returns verification status for a credit top-up.
    *
    * @example
    * ```ts
@@ -72,6 +70,7 @@ export class Credits extends APIResource {
    * ```ts
    * const response = await client.credits.topupBalance({
    *   dollars: 10,
+   *   locale: 'en',
    * });
    * ```
    */
@@ -92,24 +91,31 @@ export interface CreditRetrieveBalanceResponse {
   auto_topup_enabled: boolean;
 
   /**
-   * Usage balance threshold that triggers automatic top-up when enabled,
+   * Whether declined charges stopped automatic top-up while it is enabled. It stops
+   * after 3 declines in a row on one card. A paid top-up, a paid plan renewal, or
+   * the next automatic top-up on a new card clears it.
+   */
+  auto_topup_stopped: boolean;
+
+  /**
+   * Credit balance threshold that triggers automatic top-up when enabled,
    * represented as a bigint string.
    */
   auto_topup_threshold: string;
 
   /**
-   * Current usage balance as a bigint string to preserve precision above
+   * Current credit balance as a bigint string to preserve precision above
    * Number.MAX_SAFE_INTEGER.
    */
   balance: string;
 
   /**
-   * Lifetime purchased usage as a bigint string.
+   * Lifetime purchased credits as a bigint string.
    */
   lifetime_purchased: string;
 
   /**
-   * Lifetime consumed usage as a bigint string.
+   * Lifetime consumed credits as a bigint string.
    */
   lifetime_used: string;
 }
@@ -123,7 +129,7 @@ export interface CreditRetrieveTopupStatusResponse {
   amount_dollars?: number | null;
 
   /**
-   * Bigint string usage amount granted or pending.
+   * Bigint string credit amount granted or pending.
    */
   credits?: string;
 }
@@ -162,7 +168,8 @@ export interface CreditTopupBalanceParams {
   dollars: number;
 
   /**
-   * Optional checkout locale. Defaults to en.
+   * Optional site language for Stripe's return page. An unsupported 1 uses en, the
+   * default.
    */
   locale?: string;
 }

package/src/resources/drafts.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
@@ -15,7 +13,7 @@ import { path } from '../internal/utils/path';
  */
 export class Drafts extends APIResource {
   /**
-   * Save a tweet draft
+   * Stores a private Xquik draft. It never publishes or creates native X drafts.
    *
    * @example
    * ```ts
@@ -31,7 +29,7 @@ export class Drafts extends APIResource {
   }
 
   /**
-   * Get draft by ID
+   * Returns one private Xquik draft. Native X drafts remain inaccessible.
    *
    * @example
    * ```ts
@@ -43,7 +41,7 @@ export class Drafts extends APIResource {
   }
 
   /**
-   * List saved drafts
+   * Lists private Xquik drafts. It cannot access native X drafts.
    *
    * @example
    * ```ts
@@ -58,7 +56,7 @@ export class Drafts extends APIResource {
   }
 
   /**
-   * Delete a draft
+   * Deletes one Xquik draft, not native X drafts or published posts.
    *
    * @example
    * ```ts
@@ -74,7 +72,7 @@ export class Drafts extends APIResource {
 }
 
 /**
- * Saved tweet draft with optional topic and goal.
+ * Private Xquik draft with optional topic and goal.
  */
 export interface Draft {
   id: string;
@@ -89,20 +87,10 @@ export interface Draft {
 }
 
 /**
- * Full tweet draft including update timestamp.
+ * Full private Xquik draft including update timestamp.
  */
-export interface DraftDetail {
-  id: string;
-
-  createdAt: string;
-
-  text: string;
-
+export interface DraftDetail extends Draft {
   updatedAt: string;
-
-  goal?: string;
-
-  topic?: string;
 }
 
 export interface DraftListResponse {
@@ -114,6 +102,9 @@ export interface DraftListResponse {
 }
 
 export interface DraftCreateParams {
+  /**
+   * Draft text, up to 25,000 characters. An emoji counts as 2.
+   */
   text: string;
 
   goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
@@ -123,15 +114,13 @@ export interface DraftCreateParams {
 
 export interface DraftListParams {
   /**
-   * Cursor for pagination
+   * Cursor for pagination. The after alias also works.
    */
   afterCursor?: string;
 
   /**
-   * Maximum number of items to return (1-100, default 50). For paid per-result
-   * endpoints, the returned count may be lower when available usage balance cannot cover
-   * the requested page. If zero paid results are affordable, the endpoint returns
-   * 402 insufficient_credits.
+   * Maximum items per page: 1 to 100, default 50. Credits can reduce paid results.
+   * With none affordable, it returns 402 insufficient_credits.
    */
   limit?: number;
 }