x-twitter-scraper 0.5.0 → 0.5.2

package/resources/compose.d.ts

@@ -6,83 +6,204 @@ import { RequestOptions } from "../internal/request-options.js";
  */
 export declare class Compose extends APIResource {
     /**
-     * Compose, refine, or score a tweet
+     * Run one step of Xquik's three-step writing workflow. Compose returns questions
+     * and editorial rules. Refine returns goal-specific guidance. Score applies
+     * deterministic text checks. It does not predict reach or expose X ranking
+     * weights.
      *
      * @example
      * ```ts
      * const compose = await client.compose.create({
      *   step: 'compose',
+     *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
-     *   topic: 'AI trends in 2025',
      * });
      * ```
      */
     create(body: ComposeCreateParams, options?: RequestOptions): APIPromise<ComposeCreateResponse>;
 }
-export interface ComposeCreateResponse {
-    /**
-     * AI feedback on the draft
-     */
-    feedback?: string;
-    /**
-     * Engagement score (0-100)
-     */
-    score?: number;
-    /**
-     * Improvement suggestions
-     */
-    suggestions?: Array<string>;
-    /**
-     * Generated or refined tweet text
-     */
-    text?: string;
-    [k: string]: unknown;
+export type ComposeCreateResponse = ComposeCreateResponse.ComposePrepareResult | ComposeCreateResponse.ComposeRefineResult | ComposeCreateResponse.ComposeScoreResult;
+export declare namespace ComposeCreateResponse {
+    interface ComposePrepareResult {
+        /**
+         * Xquik editorial heuristics, ordered for the goal.
+         */
+        contentRules: Array<ComposePrepareResult.ContentRule>;
+        /**
+         * Published engagement signal names. Production multipliers are not published.
+         */
+        engagementMultipliers: Array<ComposePrepareResult.EngagementMultiplier>;
+        /**
+         * Publication limit for timing and decay claims.
+         */
+        engagementVelocity: string;
+        followUpQuestions: Array<string>;
+        /**
+         * X post intent seeded with the topic.
+         */
+        intentUrl: string;
+        nextStep: string;
+        /**
+         * Published signal names with unpublished weights as null.
+         */
+        scorerWeights: Array<ComposePrepareResult.ScorerWeight>;
+        /**
+         * Signal source and evidence limits.
+         */
+        source: string;
+        /**
+         * Negative engagement predictions in the public model.
+         */
+        topPenalties: Array<string>;
+        /**
+         * Style analyses saved to the account.
+         */
+        savedStyles?: Array<ComposePrepareResult.SavedStyle>;
+        /**
+         * Next action when no cached style is available.
+         */
+        styleNote?: string;
+        /**
+         * Cached examples for the requested style username.
+         */
+        styleTweets?: Array<string>;
+    }
+    namespace ComposePrepareResult {
+        interface ContentRule {
+            rule: string;
+        }
+        interface EngagementMultiplier {
+            /**
+             * Human-readable published signal name.
+             */
+            action: string;
+            multiplier: 'Production weight not published by X';
+        }
+        interface ScorerWeight {
+            /**
+             * Signal direction and publication limit.
+             */
+            context: string;
+            /**
+             * Signal name from X's public ranking repository.
+             */
+            signal: string;
+            /**
+             * X does not publish the production weight.
+             */
+            weight: null;
+        }
+        interface SavedStyle {
+            tweetCount: number;
+            username: string;
+        }
+    }
+    interface ComposeRefineResult {
+        /**
+         * Goal, tone, media, and editorial guidance.
+         */
+        compositionGuidance: Array<string>;
+        examplePatterns: Array<ComposeRefineResult.ExamplePattern>;
+        /**
+         * X post intent seeded with the topic.
+         */
+        intentUrl: string;
+        nextStep: string;
+    }
+    namespace ComposeRefineResult {
+        interface ExamplePattern {
+            description: string;
+            pattern: string;
+        }
+    }
+    interface ComposeScoreResult {
+        /**
+         * Deterministic editorial checks. Not a reach prediction.
+         */
+        checklist: Array<ComposeScoreResult.Checklist>;
+        nextStep: string;
+        passed: boolean;
+        passedCount: number;
+        topSuggestion: string;
+        totalChecks: 9;
+        /**
+         * Present only when every check passes.
+         */
+        intentUrl?: string;
+    }
+    namespace ComposeScoreResult {
+        interface Checklist {
+            factor: string;
+            passed: boolean;
+            /**
+             * Present only when the check fails.
+             */
+            suggestion?: string;
+        }
+    }
 }
-export interface ComposeCreateParams {
-    /**
-     * Workflow step
-     */
-    step: 'compose' | 'refine' | 'score';
-    /**
-     * Extra context or URLs (refine)
-     */
-    additionalContext?: string;
-    /**
-     * Desired call to action (refine)
-     */
-    callToAction?: string;
-    /**
-     * Tweet draft text to evaluate (score)
-     */
-    draft?: string;
-    /**
-     * Optimization goal
-     */
-    goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
-    /**
-     * Whether a link is attached (score)
-     */
-    hasLink?: boolean;
-    /**
-     * Whether media is attached (score)
-     */
-    hasMedia?: boolean;
-    /**
-     * Media type (refine)
-     */
-    mediaType?: 'photo' | 'video' | 'none';
-    /**
-     * Cached style username for voice matching (compose)
-     */
-    styleUsername?: string;
-    /**
-     * Desired tone (refine)
-     */
-    tone?: string;
-    /**
-     * Tweet topic (compose, refine)
-     */
-    topic?: string;
+export type ComposeCreateParams = ComposeCreateParams.ComposePrepareRequest | ComposeCreateParams.ComposeRefineRequest | ComposeCreateParams.ComposeScoreRequest;
+export declare namespace ComposeCreateParams {
+    interface ComposePrepareRequest {
+        step: 'compose';
+        /**
+         * Subject for the post.
+         */
+        topic: string;
+        /**
+         * Editorial goal used to order the rules and questions.
+         */
+        goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
+        /**
+         * Username from a style analysis saved to this account.
+         */
+        styleUsername?: string;
+        [k: string]: unknown;
+    }
+    interface ComposeRefineRequest {
+        /**
+         * Editorial goal for the guidance.
+         */
+        goal: 'engagement' | 'followers' | 'authority' | 'conversation';
+        step: 'refine';
+        /**
+         * Requested writing tone.
+         */
+        tone: string;
+        /**
+         * Subject for the post.
+         */
+        topic: string;
+        /**
+         * Audience, constraints, sources, or other writing context.
+         */
+        additionalContext?: string;
+        /**
+         * Specific action the draft should request.
+         */
+        callToAction?: string;
+        /**
+         * Planned media type.
+         */
+        mediaType?: 'photo' | 'video' | 'none';
+        [k: string]: unknown;
+    }
+    interface ComposeScoreRequest {
+        /**
+         * Full post text for deterministic editorial checks.
+         */
+        draft: string;
+        step: 'score';
+        /**
+         * True when a separate link card is attached.
+         */
+        hasLink?: boolean;
+        /**
+         * @deprecated Ignored. Remove this field. Use hasLink for a separate link card.
+         */
+        hasMedia?: boolean;
+        [k: string]: unknown;
+    }
 }
 export declare namespace Compose {
     export { type ComposeCreateResponse as ComposeCreateResponse, type ComposeCreateParams as ComposeCreateParams, };

package/resources/compose.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compose.d.ts","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":"AAEA,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG/F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;IAEjE;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;IAEvC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;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":"AAEA,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,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,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"}

package/resources/compose.js

@@ -8,14 +8,17 @@ const resource_1 = require("../core/resource.js");
  */
 class Compose extends resource_1.APIResource {
     /**
-     * Compose, refine, or score a tweet
+     * Run one step of Xquik's three-step writing workflow. Compose returns questions
+     * and editorial rules. Refine returns goal-specific guidance. Score applies
+     * deterministic text checks. It does not predict reach or expose X ranking
+     * weights.
      *
      * @example
      * ```ts
      * const compose = await client.compose.create({
      *   step: 'compose',
+     *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
-     *   topic: 'AI trends in 2025',
      * });
      * ```
      */

package/resources/compose.js.map

@@ -1 +1 @@
-{"version":3,"file":"compose.js","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;OAWG;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;AAhBD,0BAgBC"}
+{"version":3,"file":"compose.js","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":";AAAA,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"}

package/resources/compose.mjs

@@ -5,14 +5,17 @@ import { APIResource } from "../core/resource.mjs";
  */
 export class Compose extends APIResource {
     /**
-     * Compose, refine, or score a tweet
+     * Run one step of Xquik's three-step writing workflow. Compose returns questions
+     * and editorial rules. Refine returns goal-specific guidance. Score applies
+     * deterministic text checks. It does not predict reach or expose X ranking
+     * weights.
      *
      * @example
      * ```ts
      * const compose = await client.compose.create({
      *   step: 'compose',
+     *   topic: 'PostgreSQL query planning',
      *   goal: 'engagement',
-     *   topic: 'AI trends in 2025',
      * });
      * ```
      */

package/resources/compose.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"compose.mjs","sourceRoot":"","sources":["../src/resources/compose.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;OAWG;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,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"}

package/resources/monitors/keywords.d.mts

@@ -3,13 +3,13 @@ import * as Shared from "../shared.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export declare class Keywords extends APIResource {
     /**
-     * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
-     * monitors check every 1 second. Events and webhook deliveries are included.
-     * Creation requires an available usage balance.
+     * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
+     * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge.
      *
      * @example
      * ```ts

package/resources/monitors/keywords.d.ts

@@ -3,13 +3,13 @@ import * as Shared from "../shared.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export declare class Keywords extends APIResource {
     /**
-     * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
-     * monitors check every 1 second. Events and webhook deliveries are included.
-     * Creation requires an available usage balance.
+     * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
+     * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge.
      *
      * @example
      * ```ts

package/resources/monitors/keywords.js

@@ -5,13 +5,13 @@ exports.Keywords = void 0;
 const resource_1 = require("../../core/resource.js");
 const path_1 = require("../../internal/utils/path.js");
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 class Keywords extends resource_1.APIResource {
     /**
-     * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
-     * monitors check every 1 second. Events and webhook deliveries are included.
-     * Creation requires an available usage balance.
+     * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
+     * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge.
      *
      * @example
      * ```ts

package/resources/monitors/keywords.mjs

@@ -2,13 +2,13 @@
 import { APIResource } from "../../core/resource.mjs";
 import { path } from "../../internal/utils/path.mjs";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export class Keywords extends APIResource {
     /**
-     * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
-     * monitors check every 1 second. Events and webhook deliveries are included.
-     * Creation requires an available usage balance.
+     * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
+     * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge.
      *
      * @example
      * ```ts

package/resources/monitors/monitors.d.mts

@@ -5,14 +5,15 @@ import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse,
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export declare class Monitors extends APIResource {
     keywords: KeywordsAPI.Keywords;
     /**
-     * Creates an instant monitor. Monitors are unlimited. Active monitors check every
-     * 1 second. Events and webhook deliveries are included. Creation requires an
-     * available usage balance.
+     * Creates an account monitor. Monitors are unlimited. Active monitors check every
+     * 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge and
+     * username lookup.
      *
      * @example
      * ```ts

package/resources/monitors/monitors.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"monitors.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT,uBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"monitors.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT,uBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/monitors/monitors.d.ts

@@ -5,14 +5,15 @@ import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse,
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export declare class Monitors extends APIResource {
     keywords: KeywordsAPI.Keywords;
     /**
-     * Creates an instant monitor. Monitors are unlimited. Active monitors check every
-     * 1 second. Events and webhook deliveries are included. Creation requires an
-     * available usage balance.
+     * Creates an account monitor. Monitors are unlimited. Active monitors check every
+     * 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge and
+     * username lookup.
      *
      * @example
      * ```ts

package/resources/monitors/monitors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"monitors.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT,sBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
+{"version":3,"file":"monitors.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,QAAQ,EACT,sBAAmB;AACpB,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInE;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,QAAQ,EAAE,MAAM,CAAC;IAEjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/monitors/monitors.js

@@ -8,7 +8,7 @@ const KeywordsAPI = tslib_1.__importStar(require("./keywords.js"));
 const keywords_1 = require("./keywords.js");
 const path_1 = require("../../internal/utils/path.js");
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 class Monitors extends resource_1.APIResource {
     constructor() {
@@ -16,9 +16,10 @@ class Monitors extends resource_1.APIResource {
         this.keywords = new KeywordsAPI.Keywords(this._client);
     }
     /**
-     * Creates an instant monitor. Monitors are unlimited. Active monitors check every
-     * 1 second. Events and webhook deliveries are included. Creation requires an
-     * available usage balance.
+     * Creates an account monitor. Monitors are unlimited. Active monitors check every
+     * 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge and
+     * username lookup.
      *
      * @example
      * ```ts

package/resources/monitors/monitors.js.map

@@ -1 +1 @@
-{"version":3,"file":"monitors.js","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CASoB;AAGpB,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAqE1E,CAAC;IAnEC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAtED,4BAsEC;AAgFD,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
+{"version":3,"file":"monitors.js","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CASoB;AAGpB,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsE1E,CAAC;IApEC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAvED,4BAuEC;AAgFD,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}

package/resources/monitors/monitors.mjs

@@ -4,7 +4,7 @@ import * as KeywordsAPI from "./keywords.mjs";
 import { Keywords, } from "./keywords.mjs";
 import { path } from "../../internal/utils/path.mjs";
 /**
- * Real-time X account monitoring
+ * X account monitoring with 1-second checks
  */
 export class Monitors extends APIResource {
     constructor() {
@@ -12,9 +12,10 @@ export class Monitors extends APIResource {
         this.keywords = new KeywordsAPI.Keywords(this._client);
     }
     /**
-     * Creates an instant monitor. Monitors are unlimited. Active monitors check every
-     * 1 second. Events and webhook deliveries are included. Creation requires an
-     * available usage balance.
+     * Creates an account monitor. Monitors are unlimited. Active monitors check every
+     * 1 second and cost 21 credits per hour. Events and webhook deliveries are
+     * included. Creation requires available credits for the first hourly charge and
+     * username lookup.
      *
      * @example
      * ```ts

package/resources/monitors/monitors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"monitors.mjs","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAQL,QAAQ,GACT,uBAAmB;AAGpB,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAqE1E,CAAC;IAnEC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAgFD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"monitors.mjs","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAQL,QAAQ,GACT,uBAAmB;AAGpB,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAsE1E,CAAC;IApEC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;CACF;AAgFD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/src/client.ts

@@ -918,7 +918,7 @@ export class XTwitterScraper {
    */
   radar: API.Radar = new API.Radar(this);
   /**
-   * Real-time X account monitoring
+   * X account monitoring with 1-second checks
    */
   monitors: API.Monitors = new API.Monitors(this);
   /**

package/src/resources/account.ts

@@ -89,12 +89,12 @@ export namespace AccountRetrieveResponse {
     activeHourlyBurn: string;
 
     /**
-     * Estimated daily usage for 1 active instant monitor.
+     * Rounded daily estimate for 1 active monitor.
      */
     creditsPerActiveMonitorDay: string;
 
     /**
-     * Hourly usage charged for 1 active instant monitor.
+     * Hourly credits charged for 1 active monitor.
      */
     creditsPerActiveMonitorHour: string;