x-twitter-scraper 0.1.0

package/src/resources/monitors.ts

@@ -0,0 +1,109 @@
+// 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
+   */
+  create(body: MonitorCreateParams, options?: RequestOptions): APIPromise<MonitorCreateResponse> {
+    return this._client.post('/monitors', { body, ...options });
+  }
+
+  /**
+   * Get monitor
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Monitor> {
+    return this._client.get(path`/monitors/${id}`, options);
+  }
+
+  /**
+   * Update monitor
+   */
+  update(id: string, body: MonitorUpdateParams, options?: RequestOptions): APIPromise<Monitor> {
+    return this._client.patch(path`/monitors/${id}`, { body, ...options });
+  }
+
+  /**
+   * List monitors
+   */
+  list(options?: RequestOptions): APIPromise<MonitorListResponse> {
+    return this._client.get('/monitors', options);
+  }
+
+  /**
+   * Deactivate monitor
+   */
+  deactivate(id: string, options?: RequestOptions): APIPromise<MonitorDeactivateResponse> {
+    return this._client.delete(path`/monitors/${id}`, options);
+  }
+}
+
+export interface Monitor {
+  id: string;
+
+  createdAt: string;
+
+  eventTypes: Array<Shared.EventType>;
+
+  isActive: boolean;
+
+  username: string;
+
+  xUserId: string;
+}
+
+export interface MonitorCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  eventTypes: Array<Shared.EventType>;
+
+  username: string;
+
+  xUserId: string;
+}
+
+export interface MonitorListResponse {
+  monitors: Array<Monitor>;
+
+  total: number;
+}
+
+export interface MonitorDeactivateResponse {
+  success: true;
+}
+
+export interface MonitorCreateParams {
+  eventTypes: Array<Shared.EventType>;
+
+  /**
+   * X username (without @)
+   */
+  username: string;
+}
+
+export interface MonitorUpdateParams {
+  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,
+  };
+}

package/src/resources/radar.ts

@@ -0,0 +1,82 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Tweet composition, drafts, writing styles & radar
+ */
+export class Radar extends APIResource {
+  /**
+   * Get trending topics from curated sources
+   */
+  retrieveTrendingTopics(
+    query: RadarRetrieveTrendingTopicsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RadarRetrieveTrendingTopicsResponse> {
+    return this._client.get('/radar', { query, ...options });
+  }
+}
+
+export interface RadarItem {
+  category: string;
+
+  publishedAt: string;
+
+  region: string;
+
+  score: number;
+
+  source: string;
+
+  title: string;
+
+  description?: string;
+
+  imageUrl?: string;
+
+  url?: string;
+}
+
+export interface RadarRetrieveTrendingTopicsResponse {
+  items: Array<RadarItem>;
+
+  total: number;
+}
+
+export interface RadarRetrieveTrendingTopicsParams {
+  /**
+   * Filter by category (general, tech, dev, etc.)
+   */
+  category?: string;
+
+  /**
+   * Number of items to return
+   */
+  count?: number;
+
+  /**
+   * Lookback window in hours
+   */
+  hours?: number;
+
+  /**
+   * Region filter (us, global, etc.)
+   */
+  region?: string;
+
+  /**
+   * Source filter. One of: github, google_trends, hacker_news, polymarket, reddit,
+   * trustmrr, wikipedia
+   */
+  source?: string;
+}
+
+export declare namespace Radar {
+  export {
+    type RadarItem as RadarItem,
+    type RadarRetrieveTrendingTopicsResponse as RadarRetrieveTrendingTopicsResponse,
+    type RadarRetrieveTrendingTopicsParams as RadarRetrieveTrendingTopicsParams,
+  };
+}

package/src/resources/shared.ts

@@ -0,0 +1,57 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as TweetsAPI from './x/tweets/tweets';
+import * as UsersAPI from './x/users/users';
+
+export interface Error {
+  error:
+    | 'internal_error'
+    | 'invalid_format'
+    | 'invalid_id'
+    | 'invalid_input'
+    | 'invalid_params'
+    | 'invalid_tool_type'
+    | 'invalid_tweet_id'
+    | 'invalid_tweet_url'
+    | 'invalid_username'
+    | 'missing_params'
+    | 'missing_query'
+    | 'monitor_already_exists'
+    | 'monitor_limit_reached'
+    | 'no_subscription'
+    | 'not_found'
+    | 'stream_registration_failed'
+    | 'subscription_inactive'
+    | 'tweet_not_found'
+    | 'unauthenticated'
+    | 'usage_limit_reached'
+    | 'user_not_found'
+    | 'webhook_inactive'
+    | 'x_api_rate_limited'
+    | 'x_api_unavailable'
+    | 'x_api_unauthorized';
+}
+
+export type EventType =
+  | 'tweet.new'
+  | 'tweet.reply'
+  | 'tweet.retweet'
+  | 'tweet.quote'
+  | 'follower.gained'
+  | 'follower.lost';
+
+export interface PaginatedTweets {
+  has_next_page: boolean;
+
+  next_cursor: string;
+
+  tweets: Array<TweetsAPI.SearchTweet>;
+}
+
+export interface PaginatedUsers {
+  has_next_page: boolean;
+
+  next_cursor: string;
+
+  users: Array<UsersAPI.UserProfile>;
+}

package/src/resources/styles.ts

@@ -0,0 +1,184 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Tweet composition, drafts, writing styles & radar
+ */
+export class Styles extends APIResource {
+  /**
+   * Get cached style profile
+   */
+  retrieve(username: string, options?: RequestOptions): APIPromise<StyleProfile> {
+    return this._client.get(path`/styles/${username}`, options);
+  }
+
+  /**
+   * Save style profile with custom tweets
+   */
+  update(username: string, body: StyleUpdateParams, options?: RequestOptions): APIPromise<StyleProfile> {
+    return this._client.put(path`/styles/${username}`, { body, ...options });
+  }
+
+  /**
+   * List cached style profiles
+   */
+  list(options?: RequestOptions): APIPromise<StyleListResponse> {
+    return this._client.get('/styles', options);
+  }
+
+  /**
+   * Delete a style profile
+   */
+  delete(username: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/styles/${username}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Analyze writing style from recent tweets
+   */
+  analyze(body: StyleAnalyzeParams, options?: RequestOptions): APIPromise<StyleProfile> {
+    return this._client.post('/styles', { body, ...options });
+  }
+
+  /**
+   * Compare two style profiles
+   */
+  compare(query: StyleCompareParams, options?: RequestOptions): APIPromise<StyleCompareResponse> {
+    return this._client.get('/styles/compare', { query, ...options });
+  }
+
+  /**
+   * Get engagement metrics for style tweets
+   */
+  getPerformance(username: string, options?: RequestOptions): APIPromise<StyleGetPerformanceResponse> {
+    return this._client.get(path`/styles/${username}/performance`, options);
+  }
+}
+
+export interface StyleProfile {
+  fetchedAt: string;
+
+  isOwnAccount: boolean;
+
+  tweetCount: number;
+
+  tweets: Array<StyleProfile.Tweet>;
+
+  xUsername: string;
+}
+
+export namespace StyleProfile {
+  export interface Tweet {
+    id: string;
+
+    text: string;
+
+    authorUsername?: string;
+
+    createdAt?: string;
+  }
+}
+
+export interface StyleProfileSummary {
+  fetchedAt: string;
+
+  isOwnAccount: boolean;
+
+  tweetCount: number;
+
+  xUsername: string;
+}
+
+export interface StyleListResponse {
+  styles: Array<StyleProfileSummary>;
+}
+
+export interface StyleCompareResponse {
+  style1: StyleProfile;
+
+  style2: StyleProfile;
+}
+
+export interface StyleGetPerformanceResponse {
+  tweetCount: number;
+
+  tweets: Array<StyleGetPerformanceResponse.Tweet>;
+
+  xUsername: string;
+}
+
+export namespace StyleGetPerformanceResponse {
+  export interface Tweet {
+    id: string;
+
+    text: string;
+
+    createdAt?: string;
+
+    likeCount?: number;
+
+    replyCount?: number;
+
+    retweetCount?: number;
+
+    viewCount?: number;
+  }
+}
+
+export interface StyleUpdateParams {
+  /**
+   * Display label for the style
+   */
+  label: string;
+
+  /**
+   * Array of tweet objects
+   */
+  tweets: Array<StyleUpdateParams.Tweet>;
+}
+
+export namespace StyleUpdateParams {
+  export interface Tweet {
+    text: string;
+  }
+}
+
+export interface StyleAnalyzeParams {
+  /**
+   * X username to analyze
+   */
+  username: string;
+}
+
+export interface StyleCompareParams {
+  /**
+   * First username to compare
+   */
+  username1: string;
+
+  /**
+   * Second username to compare
+   */
+  username2: string;
+}
+
+export declare namespace Styles {
+  export {
+    type StyleProfile as StyleProfile,
+    type StyleProfileSummary as StyleProfileSummary,
+    type StyleListResponse as StyleListResponse,
+    type StyleCompareResponse as StyleCompareResponse,
+    type StyleGetPerformanceResponse as StyleGetPerformanceResponse,
+    type StyleUpdateParams as StyleUpdateParams,
+    type StyleAnalyzeParams as StyleAnalyzeParams,
+    type StyleCompareParams as StyleCompareParams,
+  };
+}

package/src/resources/subscribe.ts

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Subscription & billing
+ */
+export class Subscribe extends APIResource {
+  /**
+   * Get checkout or billing URL
+   */
+  create(options?: RequestOptions): APIPromise<SubscribeCreateResponse> {
+    return this._client.post('/subscribe', options);
+  }
+}
+
+export interface SubscribeCreateResponse {
+  url: string;
+
+  message?: string;
+
+  status?: 'checkout_created' | 'already_subscribed' | 'payment_issue';
+}
+
+export declare namespace Subscribe {
+  export { type SubscribeCreateResponse as SubscribeCreateResponse };
+}

package/src/resources/support/index.ts

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Support } from './support';
+export {
+  Tickets,
+  type TicketCreateResponse,
+  type TicketRetrieveResponse,
+  type TicketUpdateResponse,
+  type TicketListResponse,
+  type TicketReplyResponse,
+  type TicketCreateParams,
+  type TicketUpdateParams,
+  type TicketReplyParams,
+} from './tickets';

package/src/resources/support/support.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as TicketsAPI from './tickets';
+import {
+  TicketCreateParams,
+  TicketCreateResponse,
+  TicketListResponse,
+  TicketReplyParams,
+  TicketReplyResponse,
+  TicketRetrieveResponse,
+  TicketUpdateParams,
+  TicketUpdateResponse,
+  Tickets,
+} from './tickets';
+
+export class Support extends APIResource {
+  tickets: TicketsAPI.Tickets = new TicketsAPI.Tickets(this._client);
+}
+
+Support.Tickets = Tickets;
+
+export declare namespace Support {
+  export {
+    Tickets as Tickets,
+    type TicketCreateResponse as TicketCreateResponse,
+    type TicketRetrieveResponse as TicketRetrieveResponse,
+    type TicketUpdateResponse as TicketUpdateResponse,
+    type TicketListResponse as TicketListResponse,
+    type TicketReplyResponse as TicketReplyResponse,
+    type TicketCreateParams as TicketCreateParams,
+    type TicketUpdateParams as TicketUpdateParams,
+    type TicketReplyParams as TicketReplyParams,
+  };
+}

package/src/resources/support/tickets.ts

@@ -0,0 +1,131 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Support ticket management
+ */
+export class Tickets extends APIResource {
+  /**
+   * Create a support ticket
+   */
+  create(body: TicketCreateParams, options?: RequestOptions): APIPromise<TicketCreateResponse> {
+    return this._client.post('/support/tickets', { body, ...options });
+  }
+
+  /**
+   * Get ticket with all messages
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TicketRetrieveResponse> {
+    return this._client.get(path`/support/tickets/${id}`, options);
+  }
+
+  /**
+   * Update ticket status
+   */
+  update(id: string, body: TicketUpdateParams, options?: RequestOptions): APIPromise<TicketUpdateResponse> {
+    return this._client.patch(path`/support/tickets/${id}`, { body, ...options });
+  }
+
+  /**
+   * List user's support tickets
+   */
+  list(options?: RequestOptions): APIPromise<TicketListResponse> {
+    return this._client.get('/support/tickets', options);
+  }
+
+  /**
+   * Reply to a support ticket
+   */
+  reply(id: string, body: TicketReplyParams, options?: RequestOptions): APIPromise<TicketReplyResponse> {
+    return this._client.post(path`/support/tickets/${id}/messages`, { body, ...options });
+  }
+}
+
+export interface TicketCreateResponse {
+  publicId?: string;
+}
+
+export interface TicketRetrieveResponse {
+  createdAt?: string;
+
+  messages?: Array<TicketRetrieveResponse.Message>;
+
+  publicId?: string;
+
+  status?: string;
+
+  subject?: string;
+
+  updatedAt?: string;
+}
+
+export namespace TicketRetrieveResponse {
+  export interface Message {
+    body?: string;
+
+    createdAt?: string;
+
+    sender?: string;
+  }
+}
+
+export interface TicketUpdateResponse {
+  publicId?: string;
+
+  status?: string;
+}
+
+export interface TicketListResponse {
+  tickets?: Array<TicketListResponse.Ticket>;
+}
+
+export namespace TicketListResponse {
+  export interface Ticket {
+    createdAt?: string;
+
+    messageCount?: number;
+
+    publicId?: string;
+
+    status?: string;
+
+    subject?: string;
+
+    updatedAt?: string;
+  }
+}
+
+export interface TicketReplyResponse {
+  publicId?: string;
+}
+
+export interface TicketCreateParams {
+  body: string;
+
+  subject: string;
+}
+
+export interface TicketUpdateParams {
+  status: 'open' | 'resolved' | 'closed';
+}
+
+export interface TicketReplyParams {
+  body: string;
+}
+
+export declare namespace Tickets {
+  export {
+    type TicketCreateResponse as TicketCreateResponse,
+    type TicketRetrieveResponse as TicketRetrieveResponse,
+    type TicketUpdateResponse as TicketUpdateResponse,
+    type TicketListResponse as TicketListResponse,
+    type TicketReplyResponse as TicketReplyResponse,
+    type TicketCreateParams as TicketCreateParams,
+    type TicketUpdateParams as TicketUpdateParams,
+    type TicketReplyParams as TicketReplyParams,
+  };
+}

package/src/resources/support.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './support/index';

package/src/resources/trends.ts

@@ -0,0 +1,53 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Trending topics by region
+ */
+export class Trends extends APIResource {
+  /**
+   * Get trending topics
+   */
+  list(
+    query: TrendListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TrendListResponse> {
+    return this._client.get('/trends', { query, ...options });
+  }
+}
+
+export interface TrendListResponse {
+  total: number;
+
+  trends: Array<TrendListResponse.Trend>;
+
+  woeid: number;
+}
+
+export namespace TrendListResponse {
+  export interface Trend {
+    name: string;
+
+    description?: string;
+
+    query?: string;
+
+    rank?: number;
+  }
+}
+
+export interface TrendListParams {
+  count?: number;
+
+  /**
+   * Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+   */
+  woeid?: number;
+}
+
+export declare namespace Trends {
+  export { type TrendListResponse as TrendListResponse, type TrendListParams as TrendListParams };
+}