x-twitter-scraper 0.3.2 → 0.4.0

package/src/resources/monitors/monitors.ts

@@ -0,0 +1,195 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as KeywordsAPI from './keywords';
+import {
+  KeywordCreateParams,
+  KeywordCreateResponse,
+  KeywordDeactivateResponse,
+  KeywordListResponse,
+  KeywordRetrieveResponse,
+  KeywordUpdateParams,
+  KeywordUpdateResponse,
+  Keywords,
+} from './keywords';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Real-time X account monitoring
+ */
+export class Monitors extends APIResource {
+  keywords: KeywordsAPI.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.
+   *
+   * @example
+   * ```ts
+   * const monitor = await client.monitors.create({
+   *   eventTypes: ['tweet.new', 'tweet.reply'],
+   *   username: 'elonmusk',
+   * });
+   * ```
+   */
+  create(body: MonitorCreateParams, options?: RequestOptions): APIPromise<MonitorCreateResponse> {
+    return this._client.post('/monitors', { body, ...options });
+  }
+
+  /**
+   * Get monitor
+   *
+   * @example
+   * ```ts
+   * const monitor = await client.monitors.retrieve('id');
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Monitor> {
+    return this._client.get(path`/monitors/${id}`, options);
+  }
+
+  /**
+   * Update monitor
+   *
+   * @example
+   * ```ts
+   * const monitor = await client.monitors.update('id', {
+   *   eventTypes: ['tweet.new'],
+   *   isActive: true,
+   * });
+   * ```
+   */
+  update(id: string, body: MonitorUpdateParams, options?: RequestOptions): APIPromise<Monitor> {
+    return this._client.patch(path`/monitors/${id}`, { body, ...options });
+  }
+
+  /**
+   * List monitors
+   *
+   * @example
+   * ```ts
+   * const monitors = await client.monitors.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<MonitorListResponse> {
+    return this._client.get('/monitors', options);
+  }
+
+  /**
+   * Delete monitor
+   *
+   * @example
+   * ```ts
+   * const response = await client.monitors.deactivate('id');
+   * ```
+   */
+  deactivate(id: string, options?: RequestOptions): APIPromise<MonitorDeactivateResponse> {
+    return this._client.delete(path`/monitors/${id}`, options);
+  }
+}
+
+/**
+ * Account monitor that tracks activity for a given X user.
+ */
+export interface Monitor {
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * Array of event types to subscribe to.
+   */
+  eventTypes: Array<Shared.EventType>;
+
+  isActive: boolean;
+
+  /**
+   * Next hourly usage charge time for this account monitor.
+   */
+  nextBillingAt: string;
+
+  username: string;
+
+  xUserId: string;
+}
+
+export interface MonitorCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  /**
+   * Array of event types to subscribe to.
+   */
+  eventTypes: Array<Shared.EventType>;
+
+  isActive: boolean;
+
+  /**
+   * Next hourly usage charge time. New active monitors are due immediately.
+   */
+  nextBillingAt: string;
+
+  username: string;
+
+  xUserId: string;
+}
+
+export interface MonitorListResponse {
+  monitors: Array<Monitor>;
+
+  total: number;
+}
+
+export interface MonitorDeactivateResponse {
+  success: true;
+}
+
+export interface MonitorCreateParams {
+  /**
+   * Array of event types to subscribe to.
+   */
+  eventTypes: Array<Shared.EventType>;
+
+  /**
+   * X username (without @)
+   */
+  username: string;
+}
+
+export interface MonitorUpdateParams {
+  /**
+   * Array of event types to subscribe to.
+   */
+  eventTypes?: Array<Shared.EventType>;
+
+  isActive?: boolean;
+}
+
+Monitors.Keywords = Keywords;
+
+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,
+  };
+}

package/src/resources/monitors.ts

@@ -1,155 +1,3 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../core/resource';
-import * as Shared from './shared';
-import { APIPromise } from '../core/api-promise';
-import { RequestOptions } from '../internal/request-options';
-import { path } from '../internal/utils/path';
-
-/**
- * Real-time X account monitoring
- */
-export class Monitors extends APIResource {
-  /**
-   * Create monitor
-   *
-   * @example
-   * ```ts
-   * const monitor = await client.monitors.create({
-   *   eventTypes: ['tweet.new', 'tweet.reply'],
-   *   username: 'elonmusk',
-   * });
-   * ```
-   */
-  create(body: MonitorCreateParams, options?: RequestOptions): APIPromise<MonitorCreateResponse> {
-    return this._client.post('/monitors', { body, ...options });
-  }
-
-  /**
-   * Get monitor
-   *
-   * @example
-   * ```ts
-   * const monitor = await client.monitors.retrieve('id');
-   * ```
-   */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Monitor> {
-    return this._client.get(path`/monitors/${id}`, options);
-  }
-
-  /**
-   * Update monitor
-   *
-   * @example
-   * ```ts
-   * const monitor = await client.monitors.update('id', {
-   *   eventTypes: ['tweet.new'],
-   *   isActive: true,
-   * });
-   * ```
-   */
-  update(id: string, body: MonitorUpdateParams, options?: RequestOptions): APIPromise<Monitor> {
-    return this._client.patch(path`/monitors/${id}`, { body, ...options });
-  }
-
-  /**
-   * List monitors
-   *
-   * @example
-   * ```ts
-   * const monitors = await client.monitors.list();
-   * ```
-   */
-  list(options?: RequestOptions): APIPromise<MonitorListResponse> {
-    return this._client.get('/monitors', options);
-  }
-
-  /**
-   * Deactivate monitor
-   *
-   * @example
-   * ```ts
-   * const response = await client.monitors.deactivate('id');
-   * ```
-   */
-  deactivate(id: string, options?: RequestOptions): APIPromise<MonitorDeactivateResponse> {
-    return this._client.delete(path`/monitors/${id}`, options);
-  }
-}
-
-/**
- * Account monitor that tracks activity for a given X user.
- */
-export interface Monitor {
-  id: string;
-
-  createdAt: string;
-
-  /**
-   * Array of event types to subscribe to.
-   */
-  eventTypes: Array<Shared.EventType>;
-
-  isActive: boolean;
-
-  username: string;
-
-  xUserId: string;
-}
-
-export interface MonitorCreateResponse {
-  id: string;
-
-  createdAt: string;
-
-  /**
-   * Array of event types to subscribe to.
-   */
-  eventTypes: Array<Shared.EventType>;
-
-  username: string;
-
-  xUserId: string;
-}
-
-export interface MonitorListResponse {
-  monitors: Array<Monitor>;
-
-  total: number;
-}
-
-export interface MonitorDeactivateResponse {
-  success: true;
-}
-
-export interface MonitorCreateParams {
-  /**
-   * Array of event types to subscribe to.
-   */
-  eventTypes: Array<Shared.EventType>;
-
-  /**
-   * X username (without @)
-   */
-  username: string;
-}
-
-export interface MonitorUpdateParams {
-  /**
-   * Array of event types to subscribe to.
-   */
-  eventTypes?: Array<Shared.EventType>;
-
-  isActive?: boolean;
-}
-
-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 * from './monitors/index';

package/src/resources/radar.ts

@@ -25,7 +25,7 @@ export class Radar extends APIResource {
  */
 export interface RadarItem {
   /**
-   * Internal numeric identifier (stringified bigint).
+   * Radar item identifier.
    */
   id: string;
 
@@ -95,7 +95,7 @@ export interface RadarRetrieveTrendingTopicsParams {
   category?: 'general' | 'tech' | 'dev' | 'science' | 'culture' | 'politics' | 'business' | 'entertainment';
 
   /**
-   * Lookback window in hours (1-168, default 24).
+   * Lookback window in hours (1-72, default 6).
    */
   hours?: number;
 
@@ -105,7 +105,7 @@ export interface RadarRetrieveTrendingTopicsParams {
   limit?: number;
 
   /**
-   * Region filter (us, global, etc.)
+   * Region filter. Use `global` or a region code such as `US`, `GB`, `TR`, or `ES`.
    */
   region?: string;