x-twitter-scraper 0.12.3 → 0.13.0

package/resources/monitors/monitors.d.mts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../core/resource.mjs";
 import * as Shared from "../shared.mjs";
 import * as KeywordsAPI from "./keywords.mjs";
-import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse, KeywordListResponse, KeywordRetrieveResponse, KeywordUpdateParams, KeywordUpdateResponse, Keywords } from "./keywords.mjs";
+import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse, KeywordListParams, KeywordListResponse, KeywordRetrieveResponse, KeywordUpdateParams, KeywordUpdateResponse, Keywords } from "./keywords.mjs";
 import { APIPromise } from "../../core/api-promise.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
@@ -10,22 +10,22 @@ import { RequestOptions } from "../../internal/request-options.mjs";
 export declare class Monitors extends APIResource {
     keywords: KeywordsAPI.Keywords;
     /**
-     * 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.
+     * Creates an account monitor, with no count limit. Active monitors check every
+     * second for 30 credits an hour, events & webhook deliveries included. That hourly
+     * price is a monitor's only charge. Creation needs the credits of the first hour.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.create({
      *   eventTypes: ['tweet.new', 'tweet.reply'],
      *   username: 'elonmusk',
+     *   name: 'Launch watch',
      * });
      * ```
      */
     create(body: MonitorCreateParams, options?: RequestOptions): APIPromise<MonitorCreateResponse>;
     /**
-     * Get monitor
+     * Returns configuration and status for one account monitor.
      *
      * @example
      * ```ts
@@ -34,28 +34,30 @@ export declare class Monitors extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Monitor>;
     /**
-     * Update monitor
+     * Updates mutable settings for an existing account monitor.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.update('id', {
      *   eventTypes: ['tweet.new'],
      *   isActive: true,
+     *   name: 'Launch watch',
      * });
      * ```
      */
     update(id: string, body: MonitorUpdateParams, options?: RequestOptions): APIPromise<Monitor>;
     /**
-     * List monitors
+     * Returns account monitors with their current operating states.
      *
      * @example
      * ```ts
      * const monitors = await client.monitors.list();
      * ```
      */
-    list(options?: RequestOptions): APIPromise<MonitorListResponse>;
+    list(query?: MonitorListParams | null | undefined, options?: RequestOptions): APIPromise<MonitorListResponse>;
     /**
-     * Delete monitor
+     * Stops one account monitor, then removes its stored events in bounded batches.
+     * Poll statusUrl until the monitor returns 404.
      *
      * @example
      * ```ts
@@ -76,11 +78,15 @@ export interface Monitor {
     eventTypes: Array<Shared.EventType>;
     isActive: boolean;
     /**
-     * Next hourly usage charge time for this account monitor.
+     * Next hourly credit charge time for this account monitor.
      */
     nextBillingAt: string;
     username: string;
     xUserId: string;
+    /**
+     * Customer-set label of the account monitor, when set.
+     */
+    name?: string;
     /**
      * When Xquik automatically paused this monitor.
      */
@@ -88,7 +94,7 @@ export interface Monitor {
     /**
      * Why Xquik automatically paused this monitor.
      */
-    pausedReason?: 'x_user_not_found';
+    pausedReason?: 'x_account_protected' | 'x_user_not_found';
 }
 export interface MonitorCreateResponse {
     id: string;
@@ -99,17 +105,27 @@ export interface MonitorCreateResponse {
     eventTypes: Array<Shared.EventType>;
     isActive: boolean;
     /**
-     * Next hourly usage charge time. New active monitors are due immediately.
+     * Next hourly credit charge time. New active monitors are due immediately.
      */
     nextBillingAt: string;
     username: string;
     xUserId: string;
 }
 export interface MonitorListResponse {
+    hasMore: boolean;
     monitors: Array<Monitor>;
+    /**
+     * Account monitors on this page.
+     */
     total: number;
+    nextCursor?: string;
 }
 export interface MonitorDeactivateResponse {
+    deletionStatus: 'deleting';
+    /**
+     * Poll this monitor URL until it returns 404.
+     */
+    statusUrl: string;
     success: true;
 }
 export interface MonitorCreateParams {
@@ -118,9 +134,14 @@ export interface MonitorCreateParams {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * X username (without @)
+     * X username to monitor, with or without @
      */
     username: string;
+    /**
+     * Your label for the monitor. Its events carry it as monitorName. Whitespace is
+     * normalized.
+     */
+    name?: string;
 }
 export interface MonitorUpdateParams {
     /**
@@ -128,9 +149,25 @@ export interface MonitorUpdateParams {
      */
     eventTypes?: Array<Shared.EventType>;
     isActive?: boolean;
+    /**
+     * New label for the account monitor. Send null to remove the label.
+     */
+    name?: string | null;
+}
+export interface MonitorListParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+     * next page.
+     */
+    limit?: number;
 }
 export declare namespace Monitors {
-    export { type Monitor as Monitor, type MonitorCreateResponse as MonitorCreateResponse, type MonitorListResponse as MonitorListResponse, type MonitorDeactivateResponse as MonitorDeactivateResponse, type MonitorCreateParams as MonitorCreateParams, type MonitorUpdateParams as MonitorUpdateParams, };
-    export { Keywords as Keywords, type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, };
+    export { type Monitor as Monitor, type MonitorCreateResponse as MonitorCreateResponse, type MonitorListResponse as MonitorListResponse, type MonitorDeactivateResponse as MonitorDeactivateResponse, type MonitorCreateParams as MonitorCreateParams, type MonitorUpdateParams as MonitorUpdateParams, type MonitorListParams as MonitorListParams, };
+    export { Keywords as Keywords, type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, type KeywordListParams as KeywordListParams, };
 }
 //# sourceMappingURL=monitors.d.mts.map

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

@@ -1 +1 @@
-{"version":3,"file":"monitors.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAMA,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;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;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":"AAMA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,iBAAiB,EACjB,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;OAQG;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;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,CAAC;CAC3D;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,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,UAAU,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,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;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;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,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,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,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/monitors/monitors.d.ts

@@ -1,7 +1,7 @@
 import { APIResource } from "../../core/resource.js";
 import * as Shared from "../shared.js";
 import * as KeywordsAPI from "./keywords.js";
-import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse, KeywordListResponse, KeywordRetrieveResponse, KeywordUpdateParams, KeywordUpdateResponse, Keywords } from "./keywords.js";
+import { KeywordCreateParams, KeywordCreateResponse, KeywordDeactivateResponse, KeywordListParams, KeywordListResponse, KeywordRetrieveResponse, KeywordUpdateParams, KeywordUpdateResponse, Keywords } from "./keywords.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
@@ -10,22 +10,22 @@ import { RequestOptions } from "../../internal/request-options.js";
 export declare class Monitors extends APIResource {
     keywords: KeywordsAPI.Keywords;
     /**
-     * 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.
+     * Creates an account monitor, with no count limit. Active monitors check every
+     * second for 30 credits an hour, events & webhook deliveries included. That hourly
+     * price is a monitor's only charge. Creation needs the credits of the first hour.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.create({
      *   eventTypes: ['tweet.new', 'tweet.reply'],
      *   username: 'elonmusk',
+     *   name: 'Launch watch',
      * });
      * ```
      */
     create(body: MonitorCreateParams, options?: RequestOptions): APIPromise<MonitorCreateResponse>;
     /**
-     * Get monitor
+     * Returns configuration and status for one account monitor.
      *
      * @example
      * ```ts
@@ -34,28 +34,30 @@ export declare class Monitors extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Monitor>;
     /**
-     * Update monitor
+     * Updates mutable settings for an existing account monitor.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.update('id', {
      *   eventTypes: ['tweet.new'],
      *   isActive: true,
+     *   name: 'Launch watch',
      * });
      * ```
      */
     update(id: string, body: MonitorUpdateParams, options?: RequestOptions): APIPromise<Monitor>;
     /**
-     * List monitors
+     * Returns account monitors with their current operating states.
      *
      * @example
      * ```ts
      * const monitors = await client.monitors.list();
      * ```
      */
-    list(options?: RequestOptions): APIPromise<MonitorListResponse>;
+    list(query?: MonitorListParams | null | undefined, options?: RequestOptions): APIPromise<MonitorListResponse>;
     /**
-     * Delete monitor
+     * Stops one account monitor, then removes its stored events in bounded batches.
+     * Poll statusUrl until the monitor returns 404.
      *
      * @example
      * ```ts
@@ -76,11 +78,15 @@ export interface Monitor {
     eventTypes: Array<Shared.EventType>;
     isActive: boolean;
     /**
-     * Next hourly usage charge time for this account monitor.
+     * Next hourly credit charge time for this account monitor.
      */
     nextBillingAt: string;
     username: string;
     xUserId: string;
+    /**
+     * Customer-set label of the account monitor, when set.
+     */
+    name?: string;
     /**
      * When Xquik automatically paused this monitor.
      */
@@ -88,7 +94,7 @@ export interface Monitor {
     /**
      * Why Xquik automatically paused this monitor.
      */
-    pausedReason?: 'x_user_not_found';
+    pausedReason?: 'x_account_protected' | 'x_user_not_found';
 }
 export interface MonitorCreateResponse {
     id: string;
@@ -99,17 +105,27 @@ export interface MonitorCreateResponse {
     eventTypes: Array<Shared.EventType>;
     isActive: boolean;
     /**
-     * Next hourly usage charge time. New active monitors are due immediately.
+     * Next hourly credit charge time. New active monitors are due immediately.
      */
     nextBillingAt: string;
     username: string;
     xUserId: string;
 }
 export interface MonitorListResponse {
+    hasMore: boolean;
     monitors: Array<Monitor>;
+    /**
+     * Account monitors on this page.
+     */
     total: number;
+    nextCursor?: string;
 }
 export interface MonitorDeactivateResponse {
+    deletionStatus: 'deleting';
+    /**
+     * Poll this monitor URL until it returns 404.
+     */
+    statusUrl: string;
     success: true;
 }
 export interface MonitorCreateParams {
@@ -118,9 +134,14 @@ export interface MonitorCreateParams {
      */
     eventTypes: Array<Shared.EventType>;
     /**
-     * X username (without @)
+     * X username to monitor, with or without @
      */
     username: string;
+    /**
+     * Your label for the monitor. Its events carry it as monitorName. Whitespace is
+     * normalized.
+     */
+    name?: string;
 }
 export interface MonitorUpdateParams {
     /**
@@ -128,9 +149,25 @@ export interface MonitorUpdateParams {
      */
     eventTypes?: Array<Shared.EventType>;
     isActive?: boolean;
+    /**
+     * New label for the account monitor. Send null to remove the label.
+     */
+    name?: string | null;
+}
+export interface MonitorListParams {
+    /**
+     * Previous nextCursor. The after alias also works. Offset pagination is not
+     * supported.
+     */
+    cursor?: string;
+    /**
+     * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+     * next page.
+     */
+    limit?: number;
 }
 export declare namespace Monitors {
-    export { type Monitor as Monitor, type MonitorCreateResponse as MonitorCreateResponse, type MonitorListResponse as MonitorListResponse, type MonitorDeactivateResponse as MonitorDeactivateResponse, type MonitorCreateParams as MonitorCreateParams, type MonitorUpdateParams as MonitorUpdateParams, };
-    export { Keywords as Keywords, type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, };
+    export { type Monitor as Monitor, type MonitorCreateResponse as MonitorCreateResponse, type MonitorListResponse as MonitorListResponse, type MonitorDeactivateResponse as MonitorDeactivateResponse, type MonitorCreateParams as MonitorCreateParams, type MonitorUpdateParams as MonitorUpdateParams, type MonitorListParams as MonitorListParams, };
+    export { Keywords as Keywords, type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, type KeywordListParams as KeywordListParams, };
 }
 //# sourceMappingURL=monitors.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"monitors.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAMA,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;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC;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":"AAMA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EACL,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,iBAAiB,EACjB,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI5F;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;OAQG;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;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,qBAAqB,GAAG,kBAAkB,CAAC;CAC3D;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,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,UAAU,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,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;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;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,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,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,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}

package/resources/monitors/monitors.js

@@ -19,16 +19,16 @@ class Monitors extends resource_1.APIResource {
         this.keywords = new KeywordsAPI.Keywords(this._client);
     }
     /**
-     * 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.
+     * Creates an account monitor, with no count limit. Active monitors check every
+     * second for 30 credits an hour, events & webhook deliveries included. That hourly
+     * price is a monitor's only charge. Creation needs the credits of the first hour.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.create({
      *   eventTypes: ['tweet.new', 'tweet.reply'],
      *   username: 'elonmusk',
+     *   name: 'Launch watch',
      * });
      * ```
      */
@@ -36,7 +36,7 @@ class Monitors extends resource_1.APIResource {
         return this._client.post('/monitors', { body, ...options });
     }
     /**
-     * Get monitor
+     * Returns configuration and status for one account monitor.
      *
      * @example
      * ```ts
@@ -47,13 +47,14 @@ class Monitors extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/monitors/${id}`, options);
     }
     /**
-     * Update monitor
+     * Updates mutable settings for an existing account monitor.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.update('id', {
      *   eventTypes: ['tweet.new'],
      *   isActive: true,
+     *   name: 'Launch watch',
      * });
      * ```
      */
@@ -61,18 +62,19 @@ class Monitors extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/monitors/${id}`, { body, ...options });
     }
     /**
-     * List monitors
+     * Returns account monitors with their current operating states.
      *
      * @example
      * ```ts
      * const monitors = await client.monitors.list();
      * ```
      */
-    list(options) {
-        return this._client.get('/monitors', options);
+    list(query = {}, options) {
+        return this._client.get('/monitors', { query, ...options });
     }
     /**
-     * Delete monitor
+     * Stops one account monitor, then removes its stored events in bounded batches.
+     * Poll statusUrl until the monitor returns 404.
      *
      * @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,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;;AAEtC,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;AA0FD,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}
+{"version":3,"file":"monitors.js","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;;AAEtC,sFAAsF;AAEtF,qDAAkD;AAElD,mEAA0C;AAC1C,4CAUoB;AAGpB,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA2E1E,CAAC;IAzEC;;;;;;;;;;;;;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;;;;;;;;;;;OAWG;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,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;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;AA5ED,4BA4EC;AAsID,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}

package/resources/monitors/monitors.mjs

@@ -15,16 +15,16 @@ export class Monitors extends APIResource {
         this.keywords = new KeywordsAPI.Keywords(this._client);
     }
     /**
-     * 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.
+     * Creates an account monitor, with no count limit. Active monitors check every
+     * second for 30 credits an hour, events & webhook deliveries included. That hourly
+     * price is a monitor's only charge. Creation needs the credits of the first hour.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.create({
      *   eventTypes: ['tweet.new', 'tweet.reply'],
      *   username: 'elonmusk',
+     *   name: 'Launch watch',
      * });
      * ```
      */
@@ -32,7 +32,7 @@ export class Monitors extends APIResource {
         return this._client.post('/monitors', { body, ...options });
     }
     /**
-     * Get monitor
+     * Returns configuration and status for one account monitor.
      *
      * @example
      * ```ts
@@ -43,13 +43,14 @@ export class Monitors extends APIResource {
         return this._client.get(path `/monitors/${id}`, options);
     }
     /**
-     * Update monitor
+     * Updates mutable settings for an existing account monitor.
      *
      * @example
      * ```ts
      * const monitor = await client.monitors.update('id', {
      *   eventTypes: ['tweet.new'],
      *   isActive: true,
+     *   name: 'Launch watch',
      * });
      * ```
      */
@@ -57,18 +58,19 @@ export class Monitors extends APIResource {
         return this._client.patch(path `/monitors/${id}`, { body, ...options });
     }
     /**
-     * List monitors
+     * Returns account monitors with their current operating states.
      *
      * @example
      * ```ts
      * const monitors = await client.monitors.list();
      * ```
      */
-    list(options) {
-        return this._client.get('/monitors', options);
+    list(query = {}, options) {
+        return this._client.get('/monitors', { query, ...options });
     }
     /**
-     * Delete monitor
+     * Stops one account monitor, then removes its stored events in bounded batches.
+     * Poll statusUrl until the monitor returns 404.
      *
      * @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,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,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;AA0FD,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"monitors.mjs","sourceRoot":"","sources":["../../src/resources/monitors/monitors.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EASL,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;IA2E1E,CAAC;IAzEC;;;;;;;;;;;;;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;;;;;;;;;;;OAWG;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,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;OAQG;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;AAsID,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/radar.d.mts

@@ -6,7 +6,7 @@ import { RequestOptions } from "../internal/request-options.mjs";
  */
 export declare class Radar extends APIResource {
     /**
-     * Get trending topics from curated sources
+     * Returns current topics and sources for writing research.
      */
     retrieveTrendingTopics(query?: RadarRetrieveTrendingTopicsParams | null | undefined, options?: RequestOptions): APIPromise<RadarRetrieveTrendingTopicsResponse>;
 }
@@ -26,33 +26,26 @@ export interface RadarItem {
      */
     language: string;
     /**
-     * Source-specific fields. Shape varies per source:
-     *
+     * Source fields vary:
      * - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
      *   sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
      *   numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
      *   postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
      *   editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
      *   isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
-     *   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
-     *   public net score. Exact public upvote and downvote counts are not available.
-     *   Estimated counts derive from the public score and upvote ratio, which Reddit
-     *   may fuzz. Comment bodies are not included. Current items combine public
-     *   listing discovery with server-rendered post data and use `sourceFormat: html`;
-     *   `json` and `rss` remain for legacy rows.
-     * - github: { starsToday: number }
-     * - hacker_news: { points: number, numberComments: number }
-     * - google_trends: { approxTraffic: number }
-     * - polymarket: { volume24hr: number }
-     * - wikipedia: { views: number }
+     *   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }.
+     * - github: { starsToday }
+     * - hacker_news: { points, numberComments }
+     * - google_trends: { approxTraffic }
+     * - polymarket: { volume24hr }
+     * - wikipedia: { views }
      * - trustmrr: { mrr, growthPercent, last30Days, total, customers,
      *   activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
      *   foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
      *   multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
-     *   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
-     *   growth source, xHandle is the founder's X username without @. The rank field
-     *   is the source's revenue rank. Result order represents reported 30-day
-     *   revenue-growth rank.
+     *   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } Reddit score is
+     *   public net. Vote estimates use its fuzzed ratio. Comments are omitted. Startup
+     *   xHandle omits @. rank is its growth rank.
      */
     metadata: RadarItem.Metadata;
     publishedAt: string;
@@ -73,39 +66,41 @@ export interface RadarItem {
 }
 export declare namespace RadarItem {
     /**
-     * Source-specific fields. Shape varies per source:
-     *
+     * Source fields vary:
      * - reddit: { author, authorId?, subreddit, subredditId?, subredditSubscribers?,
      *   sourceFormat, score?, upvoteRatio?, estimatedUpvotes?, estimatedDownvotes?,
      *   numberComments?, numberCrossposts?, selftext?, contentUrl?, domain?,
      *   postHint?, linkFlairText?, distinguished?, totalAwardsReceived?, viewCount?,
      *   editedAt?, galleryImageUrls?, redditVideo?, archived?, contestMode?,
      *   isCrosspostable?, isMeta?, isNsfw?, isOriginalContent?, isRobotIndexable?,
-     *   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }. `score` is Reddit's
-     *   public net score. Exact public upvote and downvote counts are not available.
-     *   Estimated counts derive from the public score and upvote ratio, which Reddit
-     *   may fuzz. Comment bodies are not included. Current items combine public
-     *   listing discovery with server-rendered post data and use `sourceFormat: html`;
-     *   `json` and `rss` remain for legacy rows.
-     * - github: { starsToday: number }
-     * - hacker_news: { points: number, numberComments: number }
-     * - google_trends: { approxTraffic: number }
-     * - polymarket: { volume24hr: number }
-     * - wikipedia: { views: number }
+     *   isSelf?, isSpoiler?, isVideo?, locked?, stickied? }.
+     * - github: { starsToday }
+     * - hacker_news: { points, numberComments }
+     * - google_trends: { approxTraffic }
+     * - polymarket: { volume24hr }
+     * - wikipedia: { views }
      * - trustmrr: { mrr, growthPercent, last30Days, total, customers,
      *   activeSubscriptions, onSale, xHandle?, category?, askingPrice?, country?,
      *   foundedDate?, googleSearchImpressionsLast30Days?, growthMrrPercent?,
      *   multiple?, paymentProvider?, profitMarginLast30Days?, rank?,
-     *   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } For the startup
-     *   growth source, xHandle is the founder's X username without @. The rank field
-     *   is the source's revenue rank. Result order represents reported 30-day
-     *   revenue-growth rank.
+     *   revenuePerVisitor?, targetAudience?, visitorsLast30Days? } Reddit score is
+     *   public net. Vote estimates use its fuzzed ratio. Comments are omitted. Startup
+     *   xHandle omits @. rank is its growth rank.
      */
     interface Metadata {
         author?: string;
         contentUrl?: string;
+        /**
+         * Whole number from 0.
+         */
         estimatedDownvotes?: number;
+        /**
+         * Whole number from 0.
+         */
         estimatedUpvotes?: number;
+        /**
+         * Whole number from 0.
+         */
         numberComments?: number;
         score?: number;
         selftext?: string;
@@ -128,7 +123,8 @@ export interface RadarRetrieveTrendingTopicsResponse {
 }
 export interface RadarRetrieveTrendingTopicsParams {
     /**
-     * Cursor for pagination (from prior response nextCursor).
+     * Cursor for pagination, from the prior response's nextCursor. A cursor the radar
+     * can't read gets 400 `invalid_input`.
      */
     after?: string;
     /**