x-twitter-scraper 0.12.3 → 0.13.0

package/resources/compose.d.ts

@@ -6,10 +6,8 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 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.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../src/resources/compose.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;;;;;;;;;;;;;;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.ts","sourceRoot":"","sources":["../src/resources/compose.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;;;;;;;;;;;;;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"}

package/resources/compose.js

@@ -11,10 +11,8 @@ const resource_1 = require("../core/resource.js");
  */
 class Compose extends resource_1.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
@@ -22,6 +20,7 @@ class Compose extends resource_1.APIResource {
      *   step: 'compose',
      *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
+     *   styleUsername: 'example_user',
      * });
      * ```
      */

package/resources/compose.js.map

@@ -1 +1 @@
-{"version":3,"file":"compose.js","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAnBD,0BAmBC"}
+{"version":3,"file":"compose.js","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AAlBD,0BAkBC"}

package/resources/compose.mjs

@@ -8,10 +8,8 @@ import { APIResource } from "../core/resource.mjs";
  */
 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
@@ -19,6 +17,7 @@ export class Compose extends APIResource {
      *   step: 'compose',
      *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
+     *   styleUsername: 'example_user',
      * });
      * ```
      */

package/resources/compose.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"compose.mjs","sourceRoot":"","sources":["../src/resources/compose.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;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF"}
+{"version":3,"file":"compose.mjs","sourceRoot":"","sources":["../src/resources/compose.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;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF"}

package/resources/credits.d.mts

@@ -2,11 +2,11 @@ import { APIResource } from "../core/resource.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 export declare class Credits extends APIResource {
     /**
-     * Redirect to an active top-up payment page
+     * Redirects to the active hosted top-up checkout.
      *
      * @example
      * ```ts
@@ -17,7 +17,7 @@ export declare class Credits extends APIResource {
      */
     redirectTopupCheckout(query: CreditRedirectTopupCheckoutParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Get usage balance
+     * Returns the account credit balance and usage context.
      *
      * @example
      * ```ts
@@ -26,7 +26,7 @@ export declare class Credits extends APIResource {
      */
     retrieveBalance(options?: RequestOptions): APIPromise<CreditRetrieveBalanceResponse>;
     /**
-     * Get top-up billing status
+     * Returns verification status for a credit top-up.
      *
      * @example
      * ```ts
@@ -44,6 +44,7 @@ export declare class Credits extends APIResource {
      * ```ts
      * const response = await client.credits.topupBalance({
      *   dollars: 10,
+     *   locale: 'en',
      * });
      * ```
      */
@@ -56,21 +57,27 @@ export interface CreditRetrieveBalanceResponse {
     auto_topup_amount_dollars: number;
     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;
 }
@@ -81,7 +88,7 @@ export interface CreditRetrieveTopupStatusResponse {
      */
     amount_dollars?: number | null;
     /**
-     * Bigint string usage amount granted or pending.
+     * Bigint string credit amount granted or pending.
      */
     credits?: string;
 }
@@ -114,7 +121,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/resources/credits.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;OAOG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAIpF;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;OAOG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAIpF;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;;OAWG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/credits.d.ts

@@ -2,11 +2,11 @@ import { APIResource } from "../core/resource.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 export declare class Credits extends APIResource {
     /**
-     * Redirect to an active top-up payment page
+     * Redirects to the active hosted top-up checkout.
      *
      * @example
      * ```ts
@@ -17,7 +17,7 @@ export declare class Credits extends APIResource {
      */
     redirectTopupCheckout(query: CreditRedirectTopupCheckoutParams, options?: RequestOptions): APIPromise<void>;
     /**
-     * Get usage balance
+     * Returns the account credit balance and usage context.
      *
      * @example
      * ```ts
@@ -26,7 +26,7 @@ export declare class Credits extends APIResource {
      */
     retrieveBalance(options?: RequestOptions): APIPromise<CreditRetrieveBalanceResponse>;
     /**
-     * Get top-up billing status
+     * Returns verification status for a credit top-up.
      *
      * @example
      * ```ts
@@ -44,6 +44,7 @@ export declare class Credits extends APIResource {
      * ```ts
      * const response = await client.credits.topupBalance({
      *   dollars: 10,
+     *   locale: 'en',
      * });
      * ```
      */
@@ -56,21 +57,27 @@ export interface CreditRetrieveBalanceResponse {
     auto_topup_amount_dollars: number;
     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;
 }
@@ -81,7 +88,7 @@ export interface CreditRetrieveTopupStatusResponse {
      */
     amount_dollars?: number | null;
     /**
-     * Bigint string usage amount granted or pending.
+     * Bigint string credit amount granted or pending.
      */
     credits?: string;
 }
@@ -114,7 +121,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/resources/credits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;OAOG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAIpF;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAK,EAAE,iCAAiC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IASnB;;;;;;;OAOG;IACH,eAAe,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,6BAA6B,CAAC;IAIpF;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAK,EAAE,+BAA+B,EACtC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iCAAiC,CAAC;IAIhD;;;;;;;;;;;OAWG;IACH,YAAY,CACV,IAAI,EAAE,wBAAwB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,0BAA0B,CAAC;CAG1C;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,iCAAiC;IAChD,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}

package/resources/credits.js

@@ -8,11 +8,11 @@ exports.Credits = void 0;
 const resource_1 = require("../core/resource.js");
 const headers_1 = require("../internal/headers.js");
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 class Credits extends resource_1.APIResource {
     /**
-     * Redirect to an active top-up payment page
+     * Redirects to the active hosted top-up checkout.
      *
      * @example
      * ```ts
@@ -30,7 +30,7 @@ class Credits extends resource_1.APIResource {
         });
     }
     /**
-     * Get usage balance
+     * Returns the account credit balance and usage context.
      *
      * @example
      * ```ts
@@ -41,7 +41,7 @@ class Credits extends resource_1.APIResource {
         return this._client.get('/credits', options);
     }
     /**
-     * Get top-up billing status
+     * Returns verification status for a credit top-up.
      *
      * @example
      * ```ts
@@ -61,6 +61,7 @@ class Credits extends resource_1.APIResource {
      * ```ts
      * const response = await client.credits.topupBalance({
      *   dollars: 10,
+     *   locale: 'en',
      * });
      * ```
      */

package/resources/credits.js.map

@@ -1 +1 @@
-{"version":3,"file":"credits.js","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAE/C,oDAAmD;AAGnD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACjD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5D,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AArED,0BAqEC"}
+{"version":3,"file":"credits.js","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,kDAA+C;AAE/C,oDAAmD;AAGnD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACjD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5D,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAtED,0BAsEC"}

package/resources/credits.mjs

@@ -5,11 +5,11 @@
 import { APIResource } from "../core/resource.mjs";
 import { buildHeaders } from "../internal/headers.mjs";
 /**
- * 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
@@ -27,7 +27,7 @@ export class Credits extends APIResource {
         });
     }
     /**
-     * Get usage balance
+     * Returns the account credit balance and usage context.
      *
      * @example
      * ```ts
@@ -38,7 +38,7 @@ export class Credits extends APIResource {
         return this._client.get('/credits', options);
     }
     /**
-     * Get top-up billing status
+     * Returns verification status for a credit top-up.
      *
      * @example
      * ```ts
@@ -58,6 +58,7 @@ export class Credits extends APIResource {
      * ```ts
      * const response = await client.credits.topupBalance({
      *   dollars: 10,
+     *   locale: 'en',
      * });
      * ```
      */

package/resources/credits.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAGnD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACjD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5D,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
+{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAGnD;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;IACH,qBAAqB,CACnB,KAAwC,EACxC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE;YACjD,KAAK;YACL,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;YAC5D,UAAU,EAAE,EAAE;SACf,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;OAOG;IACH,eAAe,CAAC,OAAwB;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,KAAsC,EACtC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,IAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}