x-twitter-scraper 0.1.0

package/src/resources/events.ts

@@ -0,0 +1,89 @@
+// 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';
+
+/**
+ * Activity events from monitored accounts
+ */
+export class Events extends APIResource {
+  /**
+   * Get event
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<EventDetail> {
+    return this._client.get(path`/events/${id}`, options);
+  }
+
+  /**
+   * List events
+   */
+  list(
+    query: EventListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EventListResponse> {
+    return this._client.get('/events', { query, ...options, __security: { apiKeyAuth: true } });
+  }
+}
+
+export interface Event {
+  id: string;
+
+  data: { [key: string]: unknown };
+
+  monitorId: string;
+
+  occurredAt: string;
+
+  type: Shared.EventType;
+
+  username: string;
+}
+
+export interface EventDetail {
+  id: string;
+
+  data: { [key: string]: unknown };
+
+  monitorId: string;
+
+  occurredAt: string;
+
+  type: Shared.EventType;
+
+  username: string;
+
+  xEventId?: string;
+}
+
+export interface EventListResponse {
+  events: Array<Event>;
+
+  hasMore: boolean;
+
+  nextCursor?: string;
+}
+
+export interface EventListParams {
+  /**
+   * Cursor for pagination
+   */
+  after?: string;
+
+  eventType?: Shared.EventType;
+
+  limit?: number;
+
+  monitorId?: string;
+}
+
+export declare namespace Events {
+  export {
+    type Event as Event,
+    type EventDetail as EventDetail,
+    type EventListResponse as EventListResponse,
+    type EventListParams as EventListParams,
+  };
+}

package/src/resources/extractions.ts

@@ -0,0 +1,321 @@
+// 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';
+
+/**
+ * Bulk data extraction (20 tool types)
+ */
+export class Extractions extends APIResource {
+  /**
+   * Get extraction results
+   */
+  retrieve(
+    id: string,
+    query: ExtractionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ExtractionRetrieveResponse> {
+    return this._client.get(path`/extractions/${id}`, { query, ...options });
+  }
+
+  /**
+   * List extraction jobs
+   */
+  list(
+    query: ExtractionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ExtractionListResponse> {
+    return this._client.get('/extractions', { query, ...options });
+  }
+
+  /**
+   * Estimate extraction cost
+   */
+  estimateCost(
+    body: ExtractionEstimateCostParams,
+    options?: RequestOptions,
+  ): APIPromise<ExtractionEstimateCostResponse> {
+    return this._client.post('/extractions/estimate', { body, ...options });
+  }
+
+  /**
+   * Export extraction results
+   */
+  exportResults(
+    id: string,
+    query: ExtractionExportResultsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Response> {
+    return this._client.get(path`/extractions/${id}/export`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: 'application/octet-stream' }, options?.headers]),
+      __binaryResponse: true,
+    });
+  }
+
+  /**
+   * Run extraction
+   */
+  run(body: ExtractionRunParams, options?: RequestOptions): APIPromise<ExtractionRunResponse> {
+    return this._client.post('/extractions', { body, ...options });
+  }
+}
+
+export interface ExtractionJob {
+  id: string;
+
+  createdAt: string;
+
+  status: 'running' | 'completed' | 'failed';
+
+  toolType:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'follower_explorer'
+    | 'following_explorer'
+    | 'list_follower_explorer'
+    | 'list_member_extractor'
+    | 'list_post_extractor'
+    | 'mention_extractor'
+    | 'people_search'
+    | 'post_extractor'
+    | 'quote_extractor'
+    | 'reply_extractor'
+    | 'repost_extractor'
+    | 'space_explorer'
+    | 'thread_extractor'
+    | 'tweet_search_extractor'
+    | 'verified_follower_explorer';
+
+  totalResults: number;
+
+  completedAt?: string;
+}
+
+export interface ExtractionRetrieveResponse {
+  hasMore: boolean;
+
+  job: { [key: string]: unknown };
+
+  results: Array<{ [key: string]: unknown }>;
+
+  nextCursor?: string;
+}
+
+export interface ExtractionListResponse {
+  extractions: Array<ExtractionJob>;
+
+  hasMore: boolean;
+
+  nextCursor?: string;
+}
+
+export interface ExtractionEstimateCostResponse {
+  allowed: boolean;
+
+  estimatedResults: number;
+
+  projectedPercent: number;
+
+  source: string;
+
+  usagePercent: number;
+}
+
+export interface ExtractionRunResponse {
+  id: string;
+
+  status: 'running';
+
+  toolType:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'follower_explorer'
+    | 'following_explorer'
+    | 'list_follower_explorer'
+    | 'list_member_extractor'
+    | 'list_post_extractor'
+    | 'mention_extractor'
+    | 'people_search'
+    | 'post_extractor'
+    | 'quote_extractor'
+    | 'reply_extractor'
+    | 'repost_extractor'
+    | 'space_explorer'
+    | 'thread_extractor'
+    | 'tweet_search_extractor'
+    | 'verified_follower_explorer';
+}
+
+export interface ExtractionRetrieveParams {
+  /**
+   * Cursor for pagination
+   */
+  after?: string;
+
+  limit?: number;
+}
+
+export interface ExtractionListParams {
+  /**
+   * Cursor for pagination
+   */
+  after?: string;
+
+  limit?: number;
+
+  status?: 'running' | 'completed' | 'failed';
+
+  toolType?:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'follower_explorer'
+    | 'following_explorer'
+    | 'list_follower_explorer'
+    | 'list_member_extractor'
+    | 'list_post_extractor'
+    | 'mention_extractor'
+    | 'people_search'
+    | 'post_extractor'
+    | 'quote_extractor'
+    | 'reply_extractor'
+    | 'repost_extractor'
+    | 'space_explorer'
+    | 'thread_extractor'
+    | 'tweet_search_extractor'
+    | 'verified_follower_explorer';
+}
+
+export interface ExtractionEstimateCostParams {
+  toolType:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'follower_explorer'
+    | 'following_explorer'
+    | 'list_follower_explorer'
+    | 'list_member_extractor'
+    | 'list_post_extractor'
+    | 'mention_extractor'
+    | 'people_search'
+    | 'post_extractor'
+    | 'quote_extractor'
+    | 'reply_extractor'
+    | 'repost_extractor'
+    | 'space_explorer'
+    | 'thread_extractor'
+    | 'tweet_search_extractor'
+    | 'verified_follower_explorer';
+
+  /**
+   * Raw advanced search query appended as-is (tweet_search_extractor)
+   */
+  advancedQuery?: string;
+
+  /**
+   * Exact phrase to match (tweet_search_extractor)
+   */
+  exactPhrase?: string;
+
+  /**
+   * Words to exclude from results (tweet_search_extractor)
+   */
+  excludeWords?: string;
+
+  searchQuery?: string;
+
+  targetCommunityId?: string;
+
+  targetListId?: string;
+
+  targetSpaceId?: string;
+
+  targetTweetId?: string;
+
+  targetUsername?: string;
+}
+
+export interface ExtractionExportResultsParams {
+  format?: 'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx';
+}
+
+export interface ExtractionRunParams {
+  toolType:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'follower_explorer'
+    | 'following_explorer'
+    | 'list_follower_explorer'
+    | 'list_member_extractor'
+    | 'list_post_extractor'
+    | 'mention_extractor'
+    | 'people_search'
+    | 'post_extractor'
+    | 'quote_extractor'
+    | 'reply_extractor'
+    | 'repost_extractor'
+    | 'space_explorer'
+    | 'thread_extractor'
+    | 'tweet_search_extractor'
+    | 'verified_follower_explorer';
+
+  /**
+   * Raw advanced search query appended as-is (tweet_search_extractor)
+   */
+  advancedQuery?: string;
+
+  /**
+   * Exact phrase to match (tweet_search_extractor)
+   */
+  exactPhrase?: string;
+
+  /**
+   * Words to exclude from results (tweet_search_extractor)
+   */
+  excludeWords?: string;
+
+  searchQuery?: string;
+
+  targetCommunityId?: string;
+
+  targetListId?: string;
+
+  targetSpaceId?: string;
+
+  targetTweetId?: string;
+
+  targetUsername?: string;
+}
+
+export declare namespace Extractions {
+  export {
+    type ExtractionJob as ExtractionJob,
+    type ExtractionRetrieveResponse as ExtractionRetrieveResponse,
+    type ExtractionListResponse as ExtractionListResponse,
+    type ExtractionEstimateCostResponse as ExtractionEstimateCostResponse,
+    type ExtractionRunResponse as ExtractionRunResponse,
+    type ExtractionRetrieveParams as ExtractionRetrieveParams,
+    type ExtractionListParams as ExtractionListParams,
+    type ExtractionEstimateCostParams as ExtractionEstimateCostParams,
+    type ExtractionExportResultsParams as ExtractionExportResultsParams,
+    type ExtractionRunParams as ExtractionRunParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,121 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './shared';
+export {
+  APIKeys,
+  type APIKey,
+  type APIKeyCreateResponse,
+  type APIKeyListResponse,
+  type APIKeyRevokeResponse,
+  type APIKeyCreateParams,
+} from './api-keys';
+export {
+  Account,
+  type AccountRetrieveResponse,
+  type AccountSetXUsernameResponse,
+  type AccountUpdateLocaleResponse,
+  type AccountSetXUsernameParams,
+  type AccountUpdateLocaleParams,
+} from './account';
+export { Bot } from './bot/bot';
+export { Compose, type ComposeCreateResponse, type ComposeCreateParams } from './compose';
+export {
+  Credits,
+  type CreditRetrieveBalanceResponse,
+  type CreditTopupBalanceResponse,
+  type CreditTopupBalanceParams,
+} from './credits';
+export {
+  Drafts,
+  type Draft,
+  type DraftDetail,
+  type DraftListResponse,
+  type DraftCreateParams,
+  type DraftListParams,
+} from './drafts';
+export {
+  Draws,
+  type DrawDetail,
+  type DrawListItem,
+  type Winner,
+  type DrawRetrieveResponse,
+  type DrawListResponse,
+  type DrawRunResponse,
+  type DrawListParams,
+  type DrawExportParams,
+  type DrawRunParams,
+} from './draws';
+export { Events, type Event, type EventDetail, type EventListResponse, type EventListParams } from './events';
+export {
+  Extractions,
+  type ExtractionJob,
+  type ExtractionRetrieveResponse,
+  type ExtractionListResponse,
+  type ExtractionEstimateCostResponse,
+  type ExtractionRunResponse,
+  type ExtractionRetrieveParams,
+  type ExtractionListParams,
+  type ExtractionEstimateCostParams,
+  type ExtractionExportResultsParams,
+  type ExtractionRunParams,
+} from './extractions';
+export {
+  Integrations,
+  type Integration,
+  type IntegrationDelivery,
+  type IntegrationListResponse,
+  type IntegrationDeleteResponse,
+  type IntegrationListDeliveriesResponse,
+  type IntegrationSendTestResponse,
+  type IntegrationCreateParams,
+  type IntegrationUpdateParams,
+  type IntegrationListDeliveriesParams,
+} from './integrations';
+export {
+  Monitors,
+  type Monitor,
+  type MonitorCreateResponse,
+  type MonitorListResponse,
+  type MonitorDeactivateResponse,
+  type MonitorCreateParams,
+  type MonitorUpdateParams,
+} from './monitors';
+export {
+  Radar,
+  type RadarItem,
+  type RadarRetrieveTrendingTopicsResponse,
+  type RadarRetrieveTrendingTopicsParams,
+} from './radar';
+export {
+  Styles,
+  type StyleProfile,
+  type StyleProfileSummary,
+  type StyleListResponse,
+  type StyleCompareResponse,
+  type StyleGetPerformanceResponse,
+  type StyleUpdateParams,
+  type StyleAnalyzeParams,
+  type StyleCompareParams,
+} from './styles';
+export { Subscribe, type SubscribeCreateResponse } from './subscribe';
+export { Support } from './support/support';
+export { Trends, type TrendListResponse, type TrendListParams } from './trends';
+export {
+  Webhooks,
+  type Delivery,
+  type Webhook,
+  type WebhookCreateResponse,
+  type WebhookListResponse,
+  type WebhookDeactivateResponse,
+  type WebhookListDeliveriesResponse,
+  type WebhookTestResponse,
+  type WebhookCreateParams,
+  type WebhookUpdateParams,
+} from './webhooks';
+export {
+  X,
+  type XGetArticleResponse,
+  type XGetNotificationsResponse,
+  type XGetHomeTimelineParams,
+  type XGetNotificationsParams,
+} from './x/x';

package/src/resources/integrations.ts

@@ -0,0 +1,183 @@
+// 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';
+
+/**
+ * Push notification integrations (Telegram)
+ */
+export class Integrations extends APIResource {
+  /**
+   * Create integration
+   */
+  create(body: IntegrationCreateParams, options?: RequestOptions): APIPromise<Integration> {
+    return this._client.post('/integrations', { body, ...options });
+  }
+
+  /**
+   * Get integration details
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Integration> {
+    return this._client.get(path`/integrations/${id}`, options);
+  }
+
+  /**
+   * Update integration
+   */
+  update(id: string, body: IntegrationUpdateParams, options?: RequestOptions): APIPromise<Integration> {
+    return this._client.patch(path`/integrations/${id}`, { body, ...options });
+  }
+
+  /**
+   * List integrations
+   */
+  list(options?: RequestOptions): APIPromise<IntegrationListResponse> {
+    return this._client.get('/integrations', options);
+  }
+
+  /**
+   * Delete integration
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<IntegrationDeleteResponse> {
+    return this._client.delete(path`/integrations/${id}`, options);
+  }
+
+  /**
+   * List integration delivery history
+   */
+  listDeliveries(
+    id: string,
+    query: IntegrationListDeliveriesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<IntegrationListDeliveriesResponse> {
+    return this._client.get(path`/integrations/${id}/deliveries`, { query, ...options });
+  }
+
+  /**
+   * Send test delivery
+   */
+  sendTest(id: string, options?: RequestOptions): APIPromise<IntegrationSendTestResponse> {
+    return this._client.post(path`/integrations/${id}/test`, options);
+  }
+}
+
+export interface Integration {
+  id: string;
+
+  config: { [key: string]: unknown };
+
+  createdAt: string;
+
+  eventTypes: Array<Shared.EventType>;
+
+  isActive: boolean;
+
+  name: string;
+
+  type: 'telegram';
+
+  filters?: { [key: string]: unknown };
+
+  messageTemplate?: string;
+
+  scopeAllMonitors?: boolean;
+
+  silentPush?: boolean;
+}
+
+export interface IntegrationDelivery {
+  id: string;
+
+  attempts: number;
+
+  createdAt: string;
+
+  eventType: string;
+
+  status: string;
+
+  deliveredAt?: string;
+
+  lastError?: string;
+
+  lastStatusCode?: number;
+
+  sourceId?: string;
+
+  sourceType?: string;
+}
+
+export interface IntegrationListResponse {
+  integrations: Array<Integration>;
+}
+
+export interface IntegrationDeleteResponse {
+  success: true;
+}
+
+export interface IntegrationListDeliveriesResponse {
+  deliveries: Array<IntegrationDelivery>;
+}
+
+export interface IntegrationSendTestResponse {
+  success: true;
+}
+
+export interface IntegrationCreateParams {
+  /**
+   * Integration config (e.g. Telegram chatId)
+   */
+  config: IntegrationCreateParams.Config;
+
+  eventTypes: Array<Shared.EventType>;
+
+  name: string;
+
+  type: 'telegram';
+}
+
+export namespace IntegrationCreateParams {
+  /**
+   * Integration config (e.g. Telegram chatId)
+   */
+  export interface Config {
+    chatId: string;
+  }
+}
+
+export interface IntegrationUpdateParams {
+  eventTypes?: Array<Shared.EventType>;
+
+  filters?: { [key: string]: unknown };
+
+  isActive?: boolean;
+
+  messageTemplate?: { [key: string]: unknown };
+
+  name?: string;
+
+  scopeAllMonitors?: boolean;
+
+  silentPush?: boolean;
+}
+
+export interface IntegrationListDeliveriesParams {
+  limit?: number;
+}
+
+export declare namespace Integrations {
+  export {
+    type Integration as Integration,
+    type IntegrationDelivery as IntegrationDelivery,
+    type IntegrationListResponse as IntegrationListResponse,
+    type IntegrationDeleteResponse as IntegrationDeleteResponse,
+    type IntegrationListDeliveriesResponse as IntegrationListDeliveriesResponse,
+    type IntegrationSendTestResponse as IntegrationSendTestResponse,
+    type IntegrationCreateParams as IntegrationCreateParams,
+    type IntegrationUpdateParams as IntegrationUpdateParams,
+    type IntegrationListDeliveriesParams as IntegrationListDeliveriesParams,
+  };
+}