x-twitter-scraper 0.5.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,14 +8,17 @@ const resource_1 = require("../core/resource.js");
8
8
  */
9
9
  class Compose extends resource_1.APIResource {
10
10
  /**
11
- * Compose, refine, or score a tweet
11
+ * Run one step of Xquik's three-step writing workflow. Compose returns questions
12
+ * and editorial rules. Refine returns goal-specific guidance. Score applies
13
+ * deterministic text checks. It does not predict reach or expose X ranking
14
+ * weights.
12
15
  *
13
16
  * @example
14
17
  * ```ts
15
18
  * const compose = await client.compose.create({
16
19
  * step: 'compose',
20
+ * topic: 'PostgreSQL query planning',
17
21
  * goal: 'engagement',
18
- * topic: 'AI trends in 2025',
19
22
  * });
20
23
  * ```
21
24
  */
@@ -1 +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"}
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;;;;;;;;;;;;;;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"}
@@ -5,14 +5,17 @@ import { APIResource } from "../core/resource.mjs";
5
5
  */
6
6
  export class Compose extends APIResource {
7
7
  /**
8
- * Compose, refine, or score a tweet
8
+ * Run one step of Xquik's three-step writing workflow. Compose returns questions
9
+ * and editorial rules. Refine returns goal-specific guidance. Score applies
10
+ * deterministic text checks. It does not predict reach or expose X ranking
11
+ * weights.
9
12
  *
10
13
  * @example
11
14
  * ```ts
12
15
  * const compose = await client.compose.create({
13
16
  * step: 'compose',
17
+ * topic: 'PostgreSQL query planning',
14
18
  * goal: 'engagement',
15
- * topic: 'AI trends in 2025',
16
19
  * });
17
20
  * ```
18
21
  */
@@ -1 +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"}
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;;;;;;;;;;;;;;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"}
@@ -3,13 +3,13 @@ import * as Shared from "../shared.mjs";
3
3
  import { APIPromise } from "../../core/api-promise.mjs";
4
4
  import { RequestOptions } from "../../internal/request-options.mjs";
5
5
  /**
6
- * Real-time X account monitoring
6
+ * X account monitoring with 1-second checks
7
7
  */
8
8
  export declare class Keywords extends APIResource {
9
9
  /**
10
- * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
11
- * monitors check every 1 second. Events and webhook deliveries are included.
12
- * Creation requires an available usage balance.
10
+ * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
11
+ * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
12
+ * included. Creation requires available credits for the first hourly charge.
13
13
  *
14
14
  * @example
15
15
  * ```ts
@@ -3,13 +3,13 @@ import * as Shared from "../shared.js";
3
3
  import { APIPromise } from "../../core/api-promise.js";
4
4
  import { RequestOptions } from "../../internal/request-options.js";
5
5
  /**
6
- * Real-time X account monitoring
6
+ * X account monitoring with 1-second checks
7
7
  */
8
8
  export declare class Keywords extends APIResource {
9
9
  /**
10
- * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
11
- * monitors check every 1 second. Events and webhook deliveries are included.
12
- * Creation requires an available usage balance.
10
+ * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
11
+ * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
12
+ * included. Creation requires available credits for the first hourly charge.
13
13
  *
14
14
  * @example
15
15
  * ```ts
@@ -5,13 +5,13 @@ exports.Keywords = void 0;
5
5
  const resource_1 = require("../../core/resource.js");
6
6
  const path_1 = require("../../internal/utils/path.js");
7
7
  /**
8
- * Real-time X account monitoring
8
+ * X account monitoring with 1-second checks
9
9
  */
10
10
  class Keywords extends resource_1.APIResource {
11
11
  /**
12
- * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
13
- * monitors check every 1 second. Events and webhook deliveries are included.
14
- * Creation requires an available usage balance.
12
+ * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
13
+ * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
14
+ * included. Creation requires available credits for the first hourly charge.
15
15
  *
16
16
  * @example
17
17
  * ```ts
@@ -2,13 +2,13 @@
2
2
  import { APIResource } from "../../core/resource.mjs";
3
3
  import { path } from "../../internal/utils/path.mjs";
4
4
  /**
5
- * Real-time X account monitoring
5
+ * X account monitoring with 1-second checks
6
6
  */
7
7
  export class Keywords extends APIResource {
8
8
  /**
9
- * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
10
- * monitors check every 1 second. Events and webhook deliveries are included.
11
- * Creation requires an available usage balance.
9
+ * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
10
+ * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
11
+ * included. Creation requires available credits for the first hourly charge.
12
12
  *
13
13
  * @example
14
14
  * ```ts
@@ -5,14 +5,15 @@ import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse,
5
5
  import { APIPromise } from "../../core/api-promise.mjs";
6
6
  import { RequestOptions } from "../../internal/request-options.mjs";
7
7
  /**
8
- * Real-time X account monitoring
8
+ * X account monitoring with 1-second checks
9
9
  */
10
10
  export declare class Monitors extends APIResource {
11
11
  keywords: KeywordsAPI.Keywords;
12
12
  /**
13
- * Creates an instant monitor. Monitors are unlimited. Active monitors check every
14
- * 1 second. Events and webhook deliveries are included. Creation requires an
15
- * available usage balance.
13
+ * Creates an account monitor. Monitors are unlimited. Active monitors check every
14
+ * 1 second and cost 21 credits per hour. Events and webhook deliveries are
15
+ * included. Creation requires available credits for the first hourly charge and
16
+ * username lookup.
16
17
  *
17
18
  * @example
18
19
  * ```ts
@@ -1 +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"}
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;;;;;;;;;;;;;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"}
@@ -5,14 +5,15 @@ import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse,
5
5
  import { APIPromise } from "../../core/api-promise.js";
6
6
  import { RequestOptions } from "../../internal/request-options.js";
7
7
  /**
8
- * Real-time X account monitoring
8
+ * X account monitoring with 1-second checks
9
9
  */
10
10
  export declare class Monitors extends APIResource {
11
11
  keywords: KeywordsAPI.Keywords;
12
12
  /**
13
- * Creates an instant monitor. Monitors are unlimited. Active monitors check every
14
- * 1 second. Events and webhook deliveries are included. Creation requires an
15
- * available usage balance.
13
+ * Creates an account monitor. Monitors are unlimited. Active monitors check every
14
+ * 1 second and cost 21 credits per hour. Events and webhook deliveries are
15
+ * included. Creation requires available credits for the first hourly charge and
16
+ * username lookup.
16
17
  *
17
18
  * @example
18
19
  * ```ts
@@ -1 +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"}
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;;;;;;;;;;;;;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"}
@@ -8,7 +8,7 @@ const KeywordsAPI = tslib_1.__importStar(require("./keywords.js"));
8
8
  const keywords_1 = require("./keywords.js");
9
9
  const path_1 = require("../../internal/utils/path.js");
10
10
  /**
11
- * Real-time X account monitoring
11
+ * X account monitoring with 1-second checks
12
12
  */
13
13
  class Monitors extends resource_1.APIResource {
14
14
  constructor() {
@@ -16,9 +16,10 @@ class Monitors extends resource_1.APIResource {
16
16
  this.keywords = new KeywordsAPI.Keywords(this._client);
17
17
  }
18
18
  /**
19
- * Creates an instant monitor. Monitors are unlimited. Active monitors check every
20
- * 1 second. Events and webhook deliveries are included. Creation requires an
21
- * available usage balance.
19
+ * Creates an account monitor. Monitors are unlimited. Active monitors check every
20
+ * 1 second and cost 21 credits per hour. Events and webhook deliveries are
21
+ * included. Creation requires available credits for the first hourly charge and
22
+ * username lookup.
22
23
  *
23
24
  * @example
24
25
  * ```ts
@@ -1 +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"}
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;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"}
@@ -4,7 +4,7 @@ import * as KeywordsAPI from "./keywords.mjs";
4
4
  import { Keywords, } from "./keywords.mjs";
5
5
  import { path } from "../../internal/utils/path.mjs";
6
6
  /**
7
- * Real-time X account monitoring
7
+ * X account monitoring with 1-second checks
8
8
  */
9
9
  export class Monitors extends APIResource {
10
10
  constructor() {
@@ -12,9 +12,10 @@ export class Monitors extends APIResource {
12
12
  this.keywords = new KeywordsAPI.Keywords(this._client);
13
13
  }
14
14
  /**
15
- * Creates an instant monitor. Monitors are unlimited. Active monitors check every
16
- * 1 second. Events and webhook deliveries are included. Creation requires an
17
- * available usage balance.
15
+ * Creates an account monitor. Monitors are unlimited. Active monitors check every
16
+ * 1 second and cost 21 credits per hour. Events and webhook deliveries are
17
+ * included. Creation requires available credits for the first hourly charge and
18
+ * username lookup.
18
19
  *
19
20
  * @example
20
21
  * ```ts
@@ -1 +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"}
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;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 CHANGED
@@ -918,7 +918,7 @@ export class XTwitterScraper {
918
918
  */
919
919
  radar: API.Radar = new API.Radar(this);
920
920
  /**
921
- * Real-time X account monitoring
921
+ * X account monitoring with 1-second checks
922
922
  */
923
923
  monitors: API.Monitors = new API.Monitors(this);
924
924
  /**
@@ -89,12 +89,12 @@ export namespace AccountRetrieveResponse {
89
89
  activeHourlyBurn: string;
90
90
 
91
91
  /**
92
- * Estimated daily usage for 1 active instant monitor.
92
+ * Rounded daily estimate for 1 active monitor.
93
93
  */
94
94
  creditsPerActiveMonitorDay: string;
95
95
 
96
96
  /**
97
- * Hourly usage charged for 1 active instant monitor.
97
+ * Hourly credits charged for 1 active monitor.
98
98
  */
99
99
  creditsPerActiveMonitorHour: string;
100
100
 
@@ -9,14 +9,17 @@ import { RequestOptions } from '../internal/request-options';
9
9
  */
10
10
  export class Compose extends APIResource {
11
11
  /**
12
- * Compose, refine, or score a tweet
12
+ * Run one step of Xquik's three-step writing workflow. Compose returns questions
13
+ * and editorial rules. Refine returns goal-specific guidance. Score applies
14
+ * deterministic text checks. It does not predict reach or expose X ranking
15
+ * weights.
13
16
  *
14
17
  * @example
15
18
  * ```ts
16
19
  * const compose = await client.compose.create({
17
20
  * step: 'compose',
21
+ * topic: 'PostgreSQL query planning',
18
22
  * goal: 'engagement',
19
- * topic: 'AI trends in 2025',
20
23
  * });
21
24
  * ```
22
25
  */
@@ -25,85 +28,249 @@ export class Compose extends APIResource {
25
28
  }
26
29
  }
27
30
 
28
- export interface ComposeCreateResponse {
29
- /**
30
- * AI feedback on the draft
31
- */
32
- feedback?: string;
31
+ export type ComposeCreateResponse =
32
+ | ComposeCreateResponse.ComposePrepareResult
33
+ | ComposeCreateResponse.ComposeRefineResult
34
+ | ComposeCreateResponse.ComposeScoreResult;
33
35
 
34
- /**
35
- * Engagement score (0-100)
36
- */
37
- score?: number;
36
+ export namespace ComposeCreateResponse {
37
+ export interface ComposePrepareResult {
38
+ /**
39
+ * Xquik editorial heuristics, ordered for the goal.
40
+ */
41
+ contentRules: Array<ComposePrepareResult.ContentRule>;
38
42
 
39
- /**
40
- * Improvement suggestions
41
- */
42
- suggestions?: Array<string>;
43
+ /**
44
+ * Published engagement signal names. Production multipliers are not published.
45
+ */
46
+ engagementMultipliers: Array<ComposePrepareResult.EngagementMultiplier>;
43
47
 
44
- /**
45
- * Generated or refined tweet text
46
- */
47
- text?: string;
48
+ /**
49
+ * Publication limit for timing and decay claims.
50
+ */
51
+ engagementVelocity: string;
52
+
53
+ followUpQuestions: Array<string>;
54
+
55
+ /**
56
+ * X post intent seeded with the topic.
57
+ */
58
+ intentUrl: string;
59
+
60
+ nextStep: string;
61
+
62
+ /**
63
+ * Published signal names with unpublished weights as null.
64
+ */
65
+ scorerWeights: Array<ComposePrepareResult.ScorerWeight>;
66
+
67
+ /**
68
+ * Signal source and evidence limits.
69
+ */
70
+ source: string;
71
+
72
+ /**
73
+ * Negative engagement predictions in the public model.
74
+ */
75
+ topPenalties: Array<string>;
76
+
77
+ /**
78
+ * Style analyses saved to the account.
79
+ */
80
+ savedStyles?: Array<ComposePrepareResult.SavedStyle>;
81
+
82
+ /**
83
+ * Next action when no cached style is available.
84
+ */
85
+ styleNote?: string;
86
+
87
+ /**
88
+ * Cached examples for the requested style username.
89
+ */
90
+ styleTweets?: Array<string>;
91
+ }
92
+
93
+ export namespace ComposePrepareResult {
94
+ export interface ContentRule {
95
+ rule: string;
96
+ }
97
+
98
+ export interface EngagementMultiplier {
99
+ /**
100
+ * Human-readable published signal name.
101
+ */
102
+ action: string;
103
+
104
+ multiplier: 'Production weight not published by X';
105
+ }
106
+
107
+ export interface ScorerWeight {
108
+ /**
109
+ * Signal direction and publication limit.
110
+ */
111
+ context: string;
112
+
113
+ /**
114
+ * Signal name from X's public ranking repository.
115
+ */
116
+ signal: string;
117
+
118
+ /**
119
+ * X does not publish the production weight.
120
+ */
121
+ weight: null;
122
+ }
123
+
124
+ export interface SavedStyle {
125
+ tweetCount: number;
126
+
127
+ username: string;
128
+ }
129
+ }
130
+
131
+ export interface ComposeRefineResult {
132
+ /**
133
+ * Goal, tone, media, and editorial guidance.
134
+ */
135
+ compositionGuidance: Array<string>;
136
+
137
+ examplePatterns: Array<ComposeRefineResult.ExamplePattern>;
138
+
139
+ /**
140
+ * X post intent seeded with the topic.
141
+ */
142
+ intentUrl: string;
143
+
144
+ nextStep: string;
145
+ }
146
+
147
+ export namespace ComposeRefineResult {
148
+ export interface ExamplePattern {
149
+ description: string;
150
+
151
+ pattern: string;
152
+ }
153
+ }
154
+
155
+ export interface ComposeScoreResult {
156
+ /**
157
+ * Deterministic editorial checks. Not a reach prediction.
158
+ */
159
+ checklist: Array<ComposeScoreResult.Checklist>;
160
+
161
+ nextStep: string;
162
+
163
+ passed: boolean;
164
+
165
+ passedCount: number;
166
+
167
+ topSuggestion: string;
48
168
 
49
- [k: string]: unknown;
169
+ totalChecks: 9;
170
+
171
+ /**
172
+ * Present only when every check passes.
173
+ */
174
+ intentUrl?: string;
175
+ }
176
+
177
+ export namespace ComposeScoreResult {
178
+ export interface Checklist {
179
+ factor: string;
180
+
181
+ passed: boolean;
182
+
183
+ /**
184
+ * Present only when the check fails.
185
+ */
186
+ suggestion?: string;
187
+ }
188
+ }
50
189
  }
51
190
 
52
- export interface ComposeCreateParams {
53
- /**
54
- * Workflow step
55
- */
56
- step: 'compose' | 'refine' | 'score';
191
+ export type ComposeCreateParams =
192
+ | ComposeCreateParams.ComposePrepareRequest
193
+ | ComposeCreateParams.ComposeRefineRequest
194
+ | ComposeCreateParams.ComposeScoreRequest;
57
195
 
58
- /**
59
- * Extra context or URLs (refine)
60
- */
61
- additionalContext?: string;
196
+ export declare namespace ComposeCreateParams {
197
+ export interface ComposePrepareRequest {
198
+ step: 'compose';
62
199
 
63
- /**
64
- * Desired call to action (refine)
65
- */
66
- callToAction?: string;
200
+ /**
201
+ * Subject for the post.
202
+ */
203
+ topic: string;
67
204
 
68
- /**
69
- * Tweet draft text to evaluate (score)
70
- */
71
- draft?: string;
205
+ /**
206
+ * Editorial goal used to order the rules and questions.
207
+ */
208
+ goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
72
209
 
73
- /**
74
- * Optimization goal
75
- */
76
- goal?: 'engagement' | 'followers' | 'authority' | 'conversation';
210
+ /**
211
+ * Username from a style analysis saved to this account.
212
+ */
213
+ styleUsername?: string;
77
214
 
78
- /**
79
- * Whether a link is attached (score)
80
- */
81
- hasLink?: boolean;
215
+ [k: string]: unknown;
216
+ }
82
217
 
83
- /**
84
- * Whether media is attached (score)
85
- */
86
- hasMedia?: boolean;
218
+ export interface ComposeRefineRequest {
219
+ /**
220
+ * Editorial goal for the guidance.
221
+ */
222
+ goal: 'engagement' | 'followers' | 'authority' | 'conversation';
87
223
 
88
- /**
89
- * Media type (refine)
90
- */
91
- mediaType?: 'photo' | 'video' | 'none';
224
+ step: 'refine';
92
225
 
93
- /**
94
- * Cached style username for voice matching (compose)
95
- */
96
- styleUsername?: string;
226
+ /**
227
+ * Requested writing tone.
228
+ */
229
+ tone: string;
97
230
 
98
- /**
99
- * Desired tone (refine)
100
- */
101
- tone?: string;
231
+ /**
232
+ * Subject for the post.
233
+ */
234
+ topic: string;
102
235
 
103
- /**
104
- * Tweet topic (compose, refine)
105
- */
106
- topic?: string;
236
+ /**
237
+ * Audience, constraints, sources, or other writing context.
238
+ */
239
+ additionalContext?: string;
240
+
241
+ /**
242
+ * Specific action the draft should request.
243
+ */
244
+ callToAction?: string;
245
+
246
+ /**
247
+ * Planned media type.
248
+ */
249
+ mediaType?: 'photo' | 'video' | 'none';
250
+
251
+ [k: string]: unknown;
252
+ }
253
+
254
+ export interface ComposeScoreRequest {
255
+ /**
256
+ * Full post text for deterministic editorial checks.
257
+ */
258
+ draft: string;
259
+
260
+ step: 'score';
261
+
262
+ /**
263
+ * True when a separate link card is attached.
264
+ */
265
+ hasLink?: boolean;
266
+
267
+ /**
268
+ * @deprecated Ignored. Remove this field. Use hasLink for a separate link card.
269
+ */
270
+ hasMedia?: boolean;
271
+
272
+ [k: string]: unknown;
273
+ }
107
274
  }
108
275
 
109
276
  export declare namespace Compose {
@@ -7,13 +7,13 @@ import { RequestOptions } from '../../internal/request-options';
7
7
  import { path } from '../../internal/utils/path';
8
8
 
9
9
  /**
10
- * Real-time X account monitoring
10
+ * X account monitoring with 1-second checks
11
11
  */
12
12
  export class Keywords extends APIResource {
13
13
  /**
14
- * Creates an instant keyword monitor. Keyword monitors are unlimited. Active
15
- * monitors check every 1 second. Events and webhook deliveries are included.
16
- * Creation requires an available usage balance.
14
+ * Creates a keyword monitor. Keyword monitors are unlimited. Active monitors check
15
+ * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
16
+ * included. Creation requires available credits for the first hourly charge.
17
17
  *
18
18
  * @example
19
19
  * ```ts