x-twitter-scraper 0.12.3 → 0.13.0

package/resources/account.d.ts

@@ -6,7 +6,8 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class Account extends APIResource {
     /**
-     * Get account info
+     * Returns plan, credit, monitoring, and account settings for the authenticated
+     * user.
      *
      * @example
      * ```ts
@@ -15,7 +16,7 @@ export declare class Account extends APIResource {
      */
     retrieve(options?: RequestOptions): APIPromise<AccountRetrieveResponse>;
     /**
-     * Set linked X username
+     * Links an X username to the authenticated Xquik account.
      *
      * @example
      * ```ts
@@ -26,7 +27,7 @@ export declare class Account extends APIResource {
      */
     setXUsername(body: AccountSetXUsernameParams, options?: RequestOptions): APIPromise<AccountSetXUsernameResponse>;
     /**
-     * Update account locale
+     * Changes the locale used for account responses and notifications.
      *
      * @example
      * ```ts
@@ -46,6 +47,10 @@ export interface AccountRetrieveResponse {
     monitorsAllowed: number;
     monitorsUsed: number;
     plan: 'active' | 'inactive';
+    /**
+     * Subscription state without billing provider identifiers.
+     */
+    subscription: AccountRetrieveResponse.Subscription;
     creditInfo?: AccountRetrieveResponse.CreditInfo;
     /**
      * Linked X username, omitted when no X account is connected.
@@ -55,21 +60,21 @@ export interface AccountRetrieveResponse {
 export declare namespace AccountRetrieveResponse {
     interface MonitorBilling {
         /**
-         * Estimated daily usage for currently active monitors.
+         * Daily credits for currently active monitors.
          */
         activeDailyEstimate: string;
         /**
-         * Usage charged each hour for currently active monitors.
+         * Credits charged each hour for currently active monitors.
          */
         activeHourlyBurn: string;
         /**
-         * Rounded daily estimate for 1 active monitor.
+         * Daily credits charged for 1 active monitor.
          */
-        creditsPerActiveMonitorDay: string;
+        creditsPerActiveMonitorDay: '720';
         /**
-         * Hourly credits charged for 1 active monitor.
+         * Hourly credits charged for 1 active monitor. It is a monitor's only charge.
          */
-        creditsPerActiveMonitorHour: string;
+        creditsPerActiveMonitorHour: '30';
         /**
          * Webhook and event deliveries are included in monitor billing.
          */
@@ -83,26 +88,44 @@ export declare namespace AccountRetrieveResponse {
          */
         unlimitedSlots: boolean;
     }
+    /**
+     * Subscription state without billing provider identifiers.
+     */
+    interface Subscription {
+        status: 'none' | 'active' | 'past_due' | 'canceling' | 'incomplete';
+        /**
+         * Renewal date, or the end date when canceling.
+         */
+        currentPeriodEnd?: string;
+        currentPeriodStart?: string;
+        tier?: 'starter' | 'pro' | 'business';
+    }
     interface CreditInfo {
         /**
          * Dollar amount charged when automatic top-up runs.
          */
         autoTopupAmountDollars: number;
         autoTopupEnabled: boolean;
+        /**
+         * True when 3 declined charges in a row on one card stopped automatic top-up while
+         * it stays enabled. A paid top-up, a paid plan renewal, or the next automatic
+         * top-up on a new card clears it.
+         */
+        autoTopupStopped: boolean;
         /**
          * Bigint string threshold that triggers automatic top-up when enabled.
          */
-        autoTopupThreshold: string;
+        autoTopupThreshold: '10000' | '50000' | '100000' | '250000';
         /**
          * Bigint string to preserve precision above Number.MAX_SAFE_INTEGER.
          */
         balance: string;
         /**
-         * Total purchased usage as a bigint string.
+         * Total purchased credits as a bigint string.
          */
         lifetimePurchased: string;
         /**
-         * Total consumed usage as a bigint string.
+         * Total consumed credits as a bigint string.
          */
         lifetimeUsed: string;
     }

package/resources/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvE;;;;;;;;;OASG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;OASG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,EAAE,uBAAuB,CAAC,cAAc,CAAC;IAEvD;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE5B,UAAU,CAAC,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,cAAc;QAC7B;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,0BAA0B,EAAE,MAAM,CAAC;QAEnC;;WAEG;QACH,2BAA2B,EAAE,MAAM,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,2BAA2B,EAAE,MAAM,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;KACzB;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,IAAI,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAIvE;;;;;;;;;OASG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;;;;;;;;OASG;IACH,YAAY,CACV,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;CAG3C;AAED,MAAM,WAAW,uBAAuB;IACtC,cAAc,EAAE,uBAAuB,CAAC,cAAc,CAAC;IAEvD;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB,YAAY,EAAE,MAAM,CAAC;IAErB,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,uBAAuB,CAAC,YAAY,CAAC;IAEnD,UAAU,CAAC,EAAE,uBAAuB,CAAC,UAAU,CAAC;IAEhD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,uBAAuB,CAAC;IACvC,UAAiB,cAAc;QAC7B;;WAEG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,0BAA0B,EAAE,KAAK,CAAC;QAElC;;WAEG;QACH,2BAA2B,EAAE,IAAI,CAAC;QAElC;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;QAExB;;WAEG;QACH,2BAA2B,EAAE,MAAM,CAAC;QAEpC;;WAEG;QACH,cAAc,EAAE,OAAO,CAAC;KACzB;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;QAEpE;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B,IAAI,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,UAAU,CAAC;KACvC;IAED,UAAiB,UAAU;QACzB;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;;;WAIG;QACH,gBAAgB,EAAE,OAAO,CAAC;QAE1B;;WAEG;QACH,kBAAkB,EAAE,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAE5D;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,IAAI,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC5B;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/account.js

@@ -11,7 +11,8 @@ const resource_1 = require("../core/resource.js");
  */
 class Account extends resource_1.APIResource {
     /**
-     * Get account info
+     * Returns plan, credit, monitoring, and account settings for the authenticated
+     * user.
      *
      * @example
      * ```ts
@@ -22,7 +23,7 @@ class Account extends resource_1.APIResource {
         return this._client.get('/account', options);
     }
     /**
-     * Set linked X username
+     * Links an X username to the authenticated Xquik account.
      *
      * @example
      * ```ts
@@ -35,7 +36,7 @@ class Account extends resource_1.APIResource {
         return this._client.put('/account/x-identity', { body, ...options });
     }
     /**
-     * Update account locale
+     * Changes the locale used for account responses and notifications.
      *
      * @example
      * ```ts

package/resources/account.js.map

@@ -1 +1 @@
-{"version":3,"file":"account.js","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA9CD,0BA8CC"}
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA/CD,0BA+CC"}

package/resources/account.mjs

@@ -8,7 +8,8 @@ import { APIResource } from "../core/resource.mjs";
  */
 export class Account extends APIResource {
     /**
-     * Get account info
+     * Returns plan, credit, monitoring, and account settings for the authenticated
+     * user.
      *
      * @example
      * ```ts
@@ -19,7 +20,7 @@ export class Account extends APIResource {
         return this._client.get('/account', options);
     }
     /**
-     * Set linked X username
+     * Links an X username to the authenticated Xquik account.
      *
      * @example
      * ```ts
@@ -32,7 +33,7 @@ export class Account extends APIResource {
         return this._client.put('/account/x-identity', { body, ...options });
     }
     /**
-     * Update account locale
+     * Changes the locale used for account responses and notifications.
      *
      * @example
      * ```ts

package/resources/account.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"account.mjs","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF"}
+{"version":3,"file":"account.mjs","sourceRoot":"","sources":["../src/resources/account.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;OAQG;IACH,QAAQ,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,CACV,IAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF"}

package/resources/compose.d.mts

@@ -6,10 +6,8 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare 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
@@ -17,20 +15,27 @@ export declare class Compose extends APIResource {
      *   step: 'compose',
      *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
+     *   styleUsername: 'example_user',
      * });
      * ```
      */
     create(body: ComposeCreateParams, options?: RequestOptions): APIPromise<ComposeCreateResponse>;
 }
+/**
+ * Rules, questions, and research guidance for drafting a post.
+ */
 export type ComposeCreateResponse = ComposeCreateResponse.ComposePrepareResult | ComposeCreateResponse.ComposeRefineResult | ComposeCreateResponse.ComposeScoreResult;
 export declare namespace ComposeCreateResponse {
+    /**
+     * Rules, questions, and research guidance for drafting a post.
+     */
     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>;
         /**
@@ -44,11 +49,13 @@ export declare namespace ComposeCreateResponse {
         intentUrl: string;
         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>;
         /**
@@ -73,16 +80,27 @@ export declare namespace ComposeCreateResponse {
         styleTweets?: Array<string>;
     }
     namespace ComposePrepareResult {
+        /**
+         * One source-backed ranking fact returned during preparation.
+         */
         interface ContentRule {
             rule: string;
         }
+        /**
+         * One ranking signal and its source-value limit.
+         */
         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
+         */
         interface RadarRecommendation {
             /**
              * Radar endpoint for this source.
@@ -98,9 +116,12 @@ export declare namespace ComposeCreateResponse {
              */
             useFor: string;
         }
+        /**
+         * One source ranking signal without a production claim.
+         */
         interface ScorerWeight {
             /**
-             * Signal direction and publication limit.
+             * Signal direction and production limit.
              */
             context: string;
             /**
@@ -108,49 +129,72 @@ export declare 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.
+         */
         interface SavedStyle {
+            /**
+             * Whole number from 0.
+             */
             tweetCount: number;
             username: string;
         }
     }
+    /**
+     * Source-backed guidance for refining a post.
+     */
     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;
         nextStep: string;
     }
     namespace ComposeRefineResult {
+        /**
+         * Deprecated example-pattern schema. The response array is empty.
+         *
+         * @deprecated
+         */
         interface ExamplePattern {
             description: string;
             pattern: string;
         }
     }
+    /**
+     * Posting validation without a fabricated ranking score.
+     */
     interface ComposeScoreResult {
         /**
-         * Deterministic editorial checks. Not a reach prediction.
+         * Deterministic input validation. Not a reach prediction.
          */
         checklist: Array<ComposeScoreResult.Checklist>;
         nextStep: string;
         passed: boolean;
         passedCount: number;
         topSuggestion: string;
-        totalChecks: 9;
+        totalChecks: 1;
         /**
          * Present only when every check passes.
          */
         intentUrl?: string;
     }
     namespace ComposeScoreResult {
+        /**
+         * One deterministic draft check.
+         */
         interface Checklist {
             factor: string;
             passed: boolean;
@@ -161,8 +205,14 @@ export declare 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.
+     */
     interface ComposePrepareRequest {
         step: 'compose';
         /**
@@ -170,7 +220,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';
         /**
@@ -179,9 +229,12 @@ export declare namespace ComposeCreateParams {
         styleUsername?: string;
         [k: string]: unknown;
     }
+    /**
+     * Inputs for refining a post plan.
+     */
     interface ComposeRefineRequest {
         /**
-         * Editorial goal for the guidance.
+         * User goal interpreted against published ranking signals.
          */
         goal: 'engagement' | 'followers' | 'authority' | 'conversation';
         step: 'refine';
@@ -190,7 +243,7 @@ export declare namespace ComposeCreateParams {
          */
         tone: string;
         /**
-         * Subject for the post.
+         * Subject to refine into a post.
          */
         topic: string;
         /**
@@ -207,18 +260,21 @@ export declare namespace ComposeCreateParams {
         mediaType?: 'photo' | 'video' | 'none';
         [k: string]: unknown;
     }
+    /**
+     * Inputs for checking a post draft.
+     */
     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;
         [k: string]: unknown;

package/resources/compose.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"compose.d.mts","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,oBAAoB,GAC1C,qBAAqB,CAAC,mBAAmB,GACzC,qBAAqB,CAAC,kBAAkB,CAAC;AAE7C,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QAExE;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QAEtE;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAExD;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAErD;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,oBAAoB,CAAC;QACpC,UAAiB,WAAW;YAC1B,IAAI,EAAE,MAAM,CAAC;SACd;QAED,UAAiB,oBAAoB;YACnC;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf,UAAU,EAAE,sCAAsC,CAAC;SACpD;QAED,UAAiB,mBAAmB;YAClC;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,eAAe,GAAG,WAAW,GAAG,YAAY,CAAC;YAExG;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;SAChB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,MAAM,EAAE,IAAI,CAAC;SACd;QAED,UAAiB,UAAU;YACzB,UAAU,EAAE,MAAM,CAAC;YAEnB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE3D;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,cAAc;YAC7B,WAAW,EAAE,MAAM,CAAC;YAEpB,OAAO,EAAE,MAAM,CAAC;SACjB;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAE/C,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,OAAO,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,WAAW,EAAE,CAAC,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,kBAAkB,CAAC;QAClC,UAAiB,SAAS;YACxB,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,OAAO,CAAC;YAEhB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,qBAAqB,GACzC,mBAAmB,CAAC,oBAAoB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,qBAAqB;QACpC,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;QAEjE;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;QAEhE,IAAI,EAAE,QAAQ,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;QAEvC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"compose.d.mts","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,qBAAqB,CAAC,oBAAoB,GAC1C,qBAAqB,CAAC,mBAAmB,GACzC,qBAAqB,CAAC,kBAAkB,CAAC;AAE7C,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAEtD;;WAEG;QACH,qBAAqB,EAAE,KAAK,CAAC,oBAAoB,CAAC,oBAAoB,CAAC,CAAC;QAExE;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B,iBAAiB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEjC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;WAIG;QACH,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;QAEtE;;WAEG;QACH,aAAa,EAAE,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;QAExD;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE5B;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAErD;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC7B;IAED,UAAiB,oBAAoB,CAAC;QACpC;;WAEG;QACH,UAAiB,WAAW;YAC1B,IAAI,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,oBAAoB;YACnC;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf,UAAU,EAAE,2CAA2C,CAAC;SACzD;QAED;;;;WAIG;QACH,UAAiB,mBAAmB;YAClC;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB,MAAM,EAAE,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,aAAa,GAAG,eAAe,GAAG,WAAW,GAAG,YAAY,CAAC;YAExG;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;SAChB;QAED;;WAEG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,MAAM,EAAE,IAAI,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB,QAAQ,EAAE,MAAM,CAAC;SAClB;KACF;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,mBAAmB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnC;;WAEG;QACH,eAAe,EAAE,KAAK,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAE3D;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC;;;;WAIG;QACH,UAAiB,cAAc;YAC7B,WAAW,EAAE,MAAM,CAAC;YAEpB,OAAO,EAAE,MAAM,CAAC;SACjB;KACF;IAED;;OAEG;IACH,UAAiB,kBAAkB;QACjC;;WAEG;QACH,SAAS,EAAE,KAAK,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAE/C,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,OAAO,CAAC;QAEhB,WAAW,EAAE,MAAM,CAAC;QAEpB,aAAa,EAAE,MAAM,CAAC;QAEtB,WAAW,EAAE,CAAC,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB;IAED,UAAiB,kBAAkB,CAAC;QAClC;;WAEG;QACH,UAAiB,SAAS;YACxB,MAAM,EAAE,MAAM,CAAC;YAEf,MAAM,EAAE,OAAO,CAAC;YAEhB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;SACrB;KACF;CACF;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,qBAAqB,GACzC,mBAAmB,CAAC,oBAAoB,GACxC,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C;;OAEG;IACH,UAAiB,qBAAqB;QACpC,IAAI,EAAE,SAAS,CAAC;QAEhB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;QAEjE;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;QAEvB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,oBAAoB;QACnC;;WAEG;QACH,IAAI,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;QAEhE,IAAI,EAAE,QAAQ,CAAC;QAEf;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;QAEvC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd,IAAI,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}