x-twitter-scraper 0.8.3 → 0.10.0

package/src/resources/extractions.ts

@@ -101,8 +101,9 @@ export class Extractions extends APIResource {
    * });
    * ```
    */
-  run(body: ExtractionRunParams, options?: RequestOptions): APIPromise<ExtractionRunResponse> {
-    return this._client.post('/extractions', { body, ...options });
+  run(params: ExtractionRunParams, options?: RequestOptions): APIPromise<ExtractionRunResponse> {
+    const { dry_run, ...body } = params;
+    return this._client.post('/extractions', { query: { dry_run }, body, ...options });
   }
 }
 
@@ -182,6 +183,7 @@ export interface ExtractionEstimateCostResponse {
   source:
     | 'followers'
     | 'following'
+    | 'collection'
     | 'paginationCap'
     | 'posts'
     | 'quoteCount'
@@ -194,54 +196,54 @@ export interface ExtractionEstimateCostResponse {
 }
 
 export interface ExtractionRunResponse {
-  id: string;
+  allowed: boolean;
 
-  status: 'running';
+  creditsAvailable: string;
 
-  /**
-   * Identifier for the extraction tool used to run a job.
-   */
-  toolType:
-    | 'article_extractor'
-    | 'community_extractor'
-    | 'community_moderator_explorer'
-    | 'community_post_extractor'
-    | 'community_search'
-    | 'favoriters'
-    | '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'
-    | 'user_likes'
-    | 'user_media'
-    | 'verified_follower_explorer';
+  creditsRequired: string;
+
+  estimatedResults: number;
+
+  source: string;
+
+  resolvedXUserId?: string;
 }
 
 export interface ExtractionRetrieveParams {
   /**
-   * Cursor for keyset pagination from prior response next_cursor
+   * Previous nextCursor.
    */
   cursor?: string;
 
+  /**
+   * Preserve source keys or convert result field names.
+   */
+  fieldStyle?: 'source' | 'camelCase' | 'snake_case';
+
+  /**
+   * Use outputMode=raw instead.
+   */
+  includeRaw?: boolean;
+
   /**
    * Maximum number of results to return (1-1000, default 100)
    */
   limit?: number;
+
+  /**
+   * Select compact, full, or raw-compatible result fields.
+   */
+  outputMode?: 'compact' | 'full' | 'raw';
+
+  /**
+   * Keep enrichment nested or merge it into each result.
+   */
+  outputPreset?: 'nested' | 'flat';
 }
 
 export interface ExtractionListParams {
   /**
-   * Cursor for keyset pagination from prior response next_cursor
+   * Previous nextCursor.
    */
   cursor?: string;
 
@@ -317,323 +319,281 @@ export interface ExtractionEstimateCostParams {
     | 'verified_follower_explorer';
 
   /**
-   * Raw advanced query string appended to the estimate (tweet_search_extractor)
+   * Raw advanced search query appended as-is (tweet_search_extractor)
    */
   advancedQuery?: string;
 
   /**
-   * Alternative words or quoted phrases for estimated results. Separate with spaces,
-   * commas, or lines.
+   * Words or quoted phrases where any one can match. Separate with spaces, commas,
+   * or lines. (tweet_search_extractor)
    */
   anyWords?: string;
 
   /**
-   * Geo bounding box used for estimation, e.g. -74.1 40.6 -73.9 40.8
-   * (tweet_search_extractor)
-   */
-  boundingBox?: string;
-
-  /**
-   * Cashtags applied to the estimate, separated by spaces, commas, or lines.
+   * Bio terms separated by commas or lines.
    */
-  cashtags?: string;
+  bioContains?: string;
 
   /**
-   * Conversation ID filter used for estimation (tweet_search_extractor)
+   * Return only Blue-verified Tweet authors.
    */
-  conversationId?: string;
+  blueVerifiedOnly?: boolean;
 
   /**
-   * Exact phrase filter for search estimation
+   * Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
    */
-  exactPhrase?: string;
+  boundingBox?: string;
 
   /**
-   * Words or quoted phrases excluded from estimated results. Separate with spaces,
-   * commas, or lines.
+   * Match the Tweet card name.
    */
-  excludeWords?: string;
+  cardName?: string;
 
   /**
-   * Estimate only tweets from this author username (tweet_search_extractor)
+   * Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
    */
-  fromUser?: string;
+  cashtags?: string;
 
   /**
-   * Hashtags applied to the estimate, separated by spaces, commas, or lines.
+   * Reply collection strategy.
    */
-  hashtags?: string;
+  collectionStrategy?: 'auto' | 'complete' | 'direct' | 'search' | 'thread';
 
   /**
-   * Estimate only replies to this tweet ID (tweet_search_extractor)
+   * Conversation ID filter (tweet_search_extractor)
    */
-  inReplyToTweetId?: string;
+  conversationId?: string;
 
   /**
-   * Language code used for estimate filtering (tweet_search_extractor)
+   * Merge duplicate results across collection targets.
    */
-  language?: string;
+  dedupeAcrossTargets?: boolean;
 
   /**
-   * Estimate search results within this list ID (tweet_search_extractor)
+   * Keep target duplicates, first rows, or merged overlap.
    */
-  listId?: string;
+  dedupeMode?: 'none' | 'first' | 'merge';
 
   /**
-   * Media type used for estimate filtering (tweet_search_extractor)
+   * Exact phrase to match (tweet_search_extractor)
    */
-  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+  exactPhrase?: string;
 
   /**
-   * Estimate tweets mentioning this username (tweet_search_extractor)
+   * Exclude replies from the source author.
    */
-  mentioning?: string;
+  excludeOriginalAuthor?: boolean;
 
   /**
-   * Minimum likes threshold for estimated results (tweet_search_extractor)
+   * Exclude a source application.
    */
-  minFaves?: number;
+  excludeSource?: string;
 
   /**
-   * Minimum quote count threshold for estimated results (tweet_search_extractor)
+   * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+   * (tweet_search_extractor)
    */
-  minQuotes?: number;
+  excludeWords?: string;
 
   /**
-   * Minimum replies threshold for estimated results (tweet_search_extractor)
+   * Filter by author username (tweet_search_extractor)
    */
-  minReplies?: number;
+  fromUser?: string;
 
   /**
-   * Minimum retweets threshold for estimated results (tweet_search_extractor)
+   * Match latitude, longitude, and radius.
    */
-  minRetweets?: number;
+  geocode?: string;
 
   /**
-   * Estimate search results within this place ID (tweet_search_extractor)
+   * Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
    */
-  place?: string;
+  hashtags?: string;
 
   /**
-   * Estimate search results within this country code (tweet_search_extractor)
+   * Require a profile location.
    */
-  placeCountry?: string;
+  hasLocation?: boolean;
 
   /**
-   * Geo point radius used for estimation, e.g. -73.99 40.73 25mi
-   * (tweet_search_extractor)
+   * Return only replies with media.
    */
-  pointRadius?: string;
+  hasMediaOnly?: boolean;
 
   /**
-   * Quote mode used for estimation (tweet_search_extractor)
+   * Require a profile website.
    */
-  quotes?: 'include' | 'exclude' | 'only';
+  hasWebsite?: boolean;
 
   /**
-   * Estimate only quotes of this tweet ID (tweet_search_extractor)
+   * Include the source post in reply results.
    */
-  quotesOfTweetId?: string;
+  includeOriginalPost?: boolean;
 
   /**
-   * Reply mode used for estimation (tweet_search_extractor)
+   * Add matching search terms to collection metadata.
    */
-  replies?: 'include' | 'exclude' | 'only';
+  includeSearchTerms?: boolean;
 
   /**
-   * Maximum number of results to estimate. When set, the estimate caps projected
-   * results to this value.
+   * Add source target metadata to each result.
    */
-  resultsLimit?: number;
+  includeTargetMetadata?: boolean;
 
   /**
-   * Retweet mode used for estimation (tweet_search_extractor)
+   * Only replies to this tweet ID (tweet_search_extractor)
    */
-  retweets?: 'include' | 'exclude' | 'only';
+  inReplyToTweetId?: string;
 
   /**
-   * Estimate only retweets of this tweet ID (tweet_search_extractor)
+   * Language code filter (tweet_search_extractor)
    */
-  retweetsOfTweetId?: string;
+  language?: string;
 
   /**
-   * Query used to price tweet_search_extractor or community_search.
+   * Search within a list ID (tweet_search_extractor)
    */
-  searchQuery?: string;
+  listId?: string;
 
   /**
-   * Estimate start date in YYYY-MM-DD format (tweet_search_extractor)
+   * Required profile location text.
    */
-  sinceDate?: string;
+  locationContains?: string;
 
   /**
-   * Community ID used to price community_post_extractor or community_search.
+   * Maximum nested reply depth.
    */
-  targetCommunityId?: string;
+  maxDepth?: number;
 
   /**
-   * List ID used to price list_follower_explorer, list_member_extractor, or
-   * list_post_extractor.
+   * Maximum follower count for profile results.
    */
-  targetListId?: string;
+  maxFollowers?: number;
 
   /**
-   * Space ID used to price space_explorer.
+   * Maximum following count for profile results.
    */
-  targetSpaceId?: string;
-
-  targetTweetId?: string;
-
-  targetUsername?: string;
+  maxFollowing?: number;
 
   /**
-   * Estimate replies sent to this username (tweet_search_extractor)
+   * Return Tweets older than this Tweet ID.
    */
-  toUser?: string;
+  maxId?: string;
 
   /**
-   * Estimate end date in YYYY-MM-DD format (tweet_search_extractor)
+   * Maximum results collected for each target.
    */
-  untilDate?: string;
+  maxItemsPerTarget?: number;
 
   /**
-   * URL substring or domain filter used for estimation (tweet_search_extractor)
+   * Maximum Tweet like count.
    */
-  url?: string;
+  maxLikes?: number;
 
   /**
-   * Estimate only verified authors (tweet_search_extractor)
+   * Reply pages collected for each target.
    */
-  verifiedOnly?: boolean;
-}
+  maxPagesPerTarget?: number;
 
-export interface ExtractionExportResultsParams {
   /**
-   * Export file format
+   * Maximum post count for profile results.
    */
-  format: 'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx';
-}
+  maxPosts?: number;
 
-export interface ExtractionRunParams {
   /**
-   * Identifier for the extraction tool used to run a job.
+   * Maximum Tweet quote count.
    */
-  toolType:
-    | 'article_extractor'
-    | 'community_extractor'
-    | 'community_moderator_explorer'
-    | 'community_post_extractor'
-    | 'community_search'
-    | 'favoriters'
-    | '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'
-    | 'user_likes'
-    | 'user_media'
-    | 'verified_follower_explorer';
+  maxQuotes?: number;
 
   /**
-   * Raw advanced search query appended as-is (tweet_search_extractor)
+   * Maximum Tweet reply count.
    */
-  advancedQuery?: string;
+  maxReplies?: number;
 
   /**
-   * Words or quoted phrases where any one can match. Separate with spaces, commas,
-   * or lines. (tweet_search_extractor)
+   * Maximum Tweet repost count.
    */
-  anyWords?: string;
+  maxRetweets?: number;
 
   /**
-   * Geo bounding box, e.g. -74.1 40.6 -73.9 40.8 (tweet_search_extractor)
+   * Media type filter (tweet_search_extractor)
    */
-  boundingBox?: string;
+  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
 
   /**
-   * Cashtags separated by spaces, commas, or lines. (tweet_search_extractor)
+   * Filter tweets mentioning a username (tweet_search_extractor)
    */
-  cashtags?: string;
+  mentioning?: string;
 
   /**
-   * Conversation ID filter (tweet_search_extractor)
+   * Minimum profile age in days.
    */
-  conversationId?: string;
+  minAccountAgeDays?: number;
 
   /**
-   * Exact phrase to match (tweet_search_extractor)
+   * Minimum Tweet bookmark count.
    */
-  exactPhrase?: string;
+  minBookmarks?: number;
 
   /**
-   * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
-   * (tweet_search_extractor)
+   * Minimum likes threshold (tweet_search_extractor)
    */
-  excludeWords?: string;
+  minFaves?: number;
 
   /**
-   * Filter by author username (tweet_search_extractor)
+   * Minimum follower count for profile results.
    */
-  fromUser?: string;
+  minFollowers?: number;
 
   /**
-   * Hashtags separated by spaces, commas, or lines. (tweet_search_extractor)
+   * Minimum following count for profile results.
    */
-  hashtags?: string;
+  minFollowing?: number;
 
   /**
-   * Only replies to this tweet ID (tweet_search_extractor)
+   * Minimum post count for profile results.
    */
-  inReplyToTweetId?: string;
+  minPosts?: number;
 
   /**
-   * Language code filter (tweet_search_extractor)
+   * Minimum quote count threshold (tweet_search_extractor)
    */
-  language?: string;
+  minQuotes?: number;
 
   /**
-   * Search within a list ID (tweet_search_extractor)
+   * Minimum replies threshold (tweet_search_extractor)
    */
-  listId?: string;
+  minReplies?: number;
 
   /**
-   * Media type filter (tweet_search_extractor)
+   * Minimum retweets threshold (tweet_search_extractor)
    */
-  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+  minRetweets?: number;
 
   /**
-   * Filter tweets mentioning a username (tweet_search_extractor)
+   * Minimum Tweet view count.
    */
-  mentioning?: string;
+  minViews?: number;
 
   /**
-   * Minimum likes threshold (tweet_search_extractor)
+   * Only return native reposts.
    */
-  minFaves?: number;
+  nativeRetweets?: boolean;
 
   /**
-   * Minimum quote count threshold (tweet_search_extractor)
+   * Match a place name.
    */
-  minQuotes?: number;
+  near?: string;
 
   /**
-   * Minimum replies threshold (tweet_search_extractor)
+   * Only return news results.
    */
-  minReplies?: number;
+  news?: boolean;
 
   /**
-   * Minimum retweets threshold (tweet_search_extractor)
+   * Shortcut for dedupeMode=merge.
    */
-  minRetweets?: number;
+  overlapMode?: boolean;
 
   /**
    * Search within a place ID (tweet_search_extractor)
@@ -650,6 +610,11 @@ export interface ExtractionRunParams {
    */
   pointRadius?: string;
 
+  /**
+   * Search ranking applied to every query.
+   */
+  queryType?: 'Latest' | 'Top' | 'Both';
+
   /**
    * Quote mode (tweet_search_extractor)
    */
@@ -660,6 +625,11 @@ export interface ExtractionRunParams {
    */
   quotesOfTweetId?: string;
 
+  /**
+   * Profile relations processed within one job.
+   */
+  relationTargets?: Array<ExtractionEstimateCostParams.RelationTarget>;
+
   /**
    * Reply mode (tweet_search_extractor)
    */
@@ -681,6 +651,21 @@ export interface ExtractionRunParams {
    */
   retweetsOfTweetId?: string;
 
+  /**
+   * Enable the safe-search filter.
+   */
+  safe?: boolean;
+
+  /**
+   * Reply depth scope.
+   */
+  scope?: 'all' | 'direct' | 'nested';
+
+  /**
+   * Search queries processed as one collection job.
+   */
+  searchQueries?: Array<string>;
+
   /**
    * Required for tweet_search_extractor & community_search.
    */
@@ -691,17 +676,57 @@ export interface ExtractionRunParams {
    */
   sinceDate?: string;
 
+  /**
+   * Return Tweets newer than this Tweet ID.
+   */
+  sinceId?: string;
+
+  /**
+   * Reply start time as ISO 8601 or Unix seconds.
+   */
+  sinceTime?: string | number;
+
+  /**
+   * Reply result order.
+   */
+  sort?: 'relevance' | 'latest' | 'oldest' | 'likes';
+
+  /**
+   * Match the source application.
+   */
+  source?: string;
+
+  /**
+   * Resume one reply target from this cursor.
+   */
+  startCursor?: string;
+
   /**
    * Required for community_post_extractor & community_search.
    */
   targetCommunityId?: string;
 
+  /**
+   * Community IDs processed as one collection job.
+   */
+  targetCommunityIds?: Array<string>;
+
   /**
    * Required for list_follower_explorer, list_member_extractor &
    * list_post_extractor.
    */
   targetListId?: string;
 
+  /**
+   * List IDs processed as one collection job.
+   */
+  targetListIds?: Array<string>;
+
+  /**
+   * Mixed targets auto-routed within one job.
+   */
+  targets?: Array<string | ExtractionEstimateCostParams.UnionMember1>;
+
   /**
    * Required for space_explorer.
    */
@@ -709,8 +734,18 @@ export interface ExtractionRunParams {
 
   targetTweetId?: string;
 
+  /**
+   * Tweet IDs processed as one collection job.
+   */
+  targetTweetIds?: Array<string>;
+
   targetUsername?: string;
 
+  /**
+   * Usernames processed as one collection job.
+   */
+  targetUsernames?: Array<string>;
+
   /**
    * Filter replies sent to a username (tweet_search_extractor)
    */
@@ -721,15 +756,724 @@ export interface ExtractionRunParams {
    */
   untilDate?: string;
 
+  /**
+   * Reply end time as ISO 8601 or Unix seconds.
+   */
+  untilTime?: string | number;
+
   /**
    * URL substring or domain filter (tweet_search_extractor)
    */
   url?: string;
 
+  /**
+   * Required username text.
+   */
+  usernameContains?: string;
+
   /**
    * Only verified authors (tweet_search_extractor)
    */
   verifiedOnly?: boolean;
+
+  /**
+   * Exact profile verification type.
+   */
+  verifiedType?: string;
+
+  /**
+   * Set the radius for the near filter.
+   */
+  within?: string;
+
+  /**
+   * Match Tweets inside a recent time window.
+   */
+  withinTime?: string;
+}
+
+export namespace ExtractionEstimateCostParams {
+  /**
+   * One target and relation in a mixed profile collection.
+   */
+  export interface RelationTarget {
+    relation:
+      | 'community_members'
+      | 'followers'
+      | 'following'
+      | 'list_followers'
+      | 'list_members'
+      | 'verified_followers';
+
+    value: string;
+  }
+
+  export interface UnionMember1 {
+    kind:
+      | 'favoriters'
+      | 'list'
+      | 'profile'
+      | 'profile_likes'
+      | 'profile_media'
+      | 'profile_replies'
+      | 'quotes'
+      | 'replies'
+      | 'retweeters'
+      | 'search'
+      | 'thread'
+      | 'tweet';
+
+    value: string;
+  }
+}
+
+export interface ExtractionExportResultsParams {
+  /**
+   * Export file format
+   */
+  format: 'csv' | 'json' | 'md' | 'md-document' | 'pdf' | 'txt' | 'xlsx';
+
+  /**
+   * Require a non-empty description.
+   */
+  hasDescription?: boolean;
+
+  /**
+   * Require a non-empty location.
+   */
+  hasLocation?: boolean;
+
+  /**
+   * Require media.
+   */
+  hasMedia?: boolean;
+
+  /**
+   * Filter by language code.
+   */
+  lang?: string;
+
+  /**
+   * Maximum follower count.
+   */
+  maxFollowers?: number;
+
+  /**
+   * Maximum following count.
+   */
+  maxFollowing?: number;
+
+  /**
+   * Maximum post count.
+   */
+  maxPosts?: number;
+
+  /**
+   * Minimum follower count.
+   */
+  minFollowers?: number;
+
+  /**
+   * Minimum following count.
+   */
+  minFollowing?: number;
+
+  /**
+   * Minimum like count.
+   */
+  minLikes?: number;
+
+  /**
+   * Minimum post count.
+   */
+  minPosts?: number;
+
+  /**
+   * Minimum reply count.
+   */
+  minReplies?: number;
+
+  /**
+   * Minimum repost count.
+   */
+  minRetweets?: number;
+
+  /**
+   * Minimum view count.
+   */
+  minViews?: number;
+
+  /**
+   * Search exported result text.
+   */
+  search?: string;
+
+  /**
+   * Include results on or after this date.
+   */
+  sinceDate?: string;
+
+  /**
+   * Include results on or before this date.
+   */
+  untilDate?: string;
+
+  /**
+   * Filter by verified status.
+   */
+  verified?: boolean;
+}
+
+export interface ExtractionRunParams {
+  /**
+   * Body param: Identifier for the extraction tool used to run a job.
+   */
+  toolType:
+    | 'article_extractor'
+    | 'community_extractor'
+    | 'community_moderator_explorer'
+    | 'community_post_extractor'
+    | 'community_search'
+    | 'favoriters'
+    | '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'
+    | 'user_likes'
+    | 'user_media'
+    | 'verified_follower_explorer';
+
+  /**
+   * Query param: Estimate cost without creating an extraction.
+   */
+  dry_run?: boolean;
+
+  /**
+   * Body param: Raw advanced search query appended as-is (tweet_search_extractor)
+   */
+  advancedQuery?: string;
+
+  /**
+   * Body param: Words or quoted phrases where any one can match. Separate with
+   * spaces, commas, or lines. (tweet_search_extractor)
+   */
+  anyWords?: string;
+
+  /**
+   * Body param: Bio terms separated by commas or lines.
+   */
+  bioContains?: string;
+
+  /**
+   * Body param: Return only Blue-verified Tweet authors.
+   */
+  blueVerifiedOnly?: boolean;
+
+  /**
+   * Body param: Geo bounding box, e.g. -74.1 40.6 -73.9 40.8
+   * (tweet_search_extractor)
+   */
+  boundingBox?: string;
+
+  /**
+   * Body param: Match the Tweet card name.
+   */
+  cardName?: string;
+
+  /**
+   * Body param: Cashtags separated by spaces, commas, or lines.
+   * (tweet_search_extractor)
+   */
+  cashtags?: string;
+
+  /**
+   * Body param: Reply collection strategy.
+   */
+  collectionStrategy?: 'auto' | 'complete' | 'direct' | 'search' | 'thread';
+
+  /**
+   * Body param: Conversation ID filter (tweet_search_extractor)
+   */
+  conversationId?: string;
+
+  /**
+   * Body param: Merge duplicate results across collection targets.
+   */
+  dedupeAcrossTargets?: boolean;
+
+  /**
+   * Body param: Keep target duplicates, first rows, or merged overlap.
+   */
+  dedupeMode?: 'none' | 'first' | 'merge';
+
+  /**
+   * Body param: Exact phrase to match (tweet_search_extractor)
+   */
+  exactPhrase?: string;
+
+  /**
+   * Body param: Exclude replies from the source author.
+   */
+  excludeOriginalAuthor?: boolean;
+
+  /**
+   * Body param: Exclude a source application.
+   */
+  excludeSource?: string;
+
+  /**
+   * Body param: Words or quoted phrases to exclude. Separate with spaces, commas, or
+   * lines. (tweet_search_extractor)
+   */
+  excludeWords?: string;
+
+  /**
+   * Body param: Filter by author username (tweet_search_extractor)
+   */
+  fromUser?: string;
+
+  /**
+   * Body param: Match latitude, longitude, and radius.
+   */
+  geocode?: string;
+
+  /**
+   * Body param: Hashtags separated by spaces, commas, or lines.
+   * (tweet_search_extractor)
+   */
+  hashtags?: string;
+
+  /**
+   * Body param: Require a profile location.
+   */
+  hasLocation?: boolean;
+
+  /**
+   * Body param: Return only replies with media.
+   */
+  hasMediaOnly?: boolean;
+
+  /**
+   * Body param: Require a profile website.
+   */
+  hasWebsite?: boolean;
+
+  /**
+   * Body param: Include the source post in reply results.
+   */
+  includeOriginalPost?: boolean;
+
+  /**
+   * Body param: Add matching search terms to collection metadata.
+   */
+  includeSearchTerms?: boolean;
+
+  /**
+   * Body param: Add source target metadata to each result.
+   */
+  includeTargetMetadata?: boolean;
+
+  /**
+   * Body param: Only replies to this tweet ID (tweet_search_extractor)
+   */
+  inReplyToTweetId?: string;
+
+  /**
+   * Body param: Language code filter (tweet_search_extractor)
+   */
+  language?: string;
+
+  /**
+   * Body param: Search within a list ID (tweet_search_extractor)
+   */
+  listId?: string;
+
+  /**
+   * Body param: Required profile location text.
+   */
+  locationContains?: string;
+
+  /**
+   * Body param: Maximum nested reply depth.
+   */
+  maxDepth?: number;
+
+  /**
+   * Body param: Maximum follower count for profile results.
+   */
+  maxFollowers?: number;
+
+  /**
+   * Body param: Maximum following count for profile results.
+   */
+  maxFollowing?: number;
+
+  /**
+   * Body param: Return Tweets older than this Tweet ID.
+   */
+  maxId?: string;
+
+  /**
+   * Body param: Maximum results collected for each target.
+   */
+  maxItemsPerTarget?: number;
+
+  /**
+   * Body param: Maximum Tweet like count.
+   */
+  maxLikes?: number;
+
+  /**
+   * Body param: Reply pages collected for each target.
+   */
+  maxPagesPerTarget?: number;
+
+  /**
+   * Body param: Maximum post count for profile results.
+   */
+  maxPosts?: number;
+
+  /**
+   * Body param: Maximum Tweet quote count.
+   */
+  maxQuotes?: number;
+
+  /**
+   * Body param: Maximum Tweet reply count.
+   */
+  maxReplies?: number;
+
+  /**
+   * Body param: Maximum Tweet repost count.
+   */
+  maxRetweets?: number;
+
+  /**
+   * Body param: Media type filter (tweet_search_extractor)
+   */
+  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+
+  /**
+   * Body param: Filter tweets mentioning a username (tweet_search_extractor)
+   */
+  mentioning?: string;
+
+  /**
+   * Body param: Minimum profile age in days.
+   */
+  minAccountAgeDays?: number;
+
+  /**
+   * Body param: Minimum Tweet bookmark count.
+   */
+  minBookmarks?: number;
+
+  /**
+   * Body param: Minimum likes threshold (tweet_search_extractor)
+   */
+  minFaves?: number;
+
+  /**
+   * Body param: Minimum follower count for profile results.
+   */
+  minFollowers?: number;
+
+  /**
+   * Body param: Minimum following count for profile results.
+   */
+  minFollowing?: number;
+
+  /**
+   * Body param: Minimum post count for profile results.
+   */
+  minPosts?: number;
+
+  /**
+   * Body param: Minimum quote count threshold (tweet_search_extractor)
+   */
+  minQuotes?: number;
+
+  /**
+   * Body param: Minimum replies threshold (tweet_search_extractor)
+   */
+  minReplies?: number;
+
+  /**
+   * Body param: Minimum retweets threshold (tweet_search_extractor)
+   */
+  minRetweets?: number;
+
+  /**
+   * Body param: Minimum Tweet view count.
+   */
+  minViews?: number;
+
+  /**
+   * Body param: Only return native reposts.
+   */
+  nativeRetweets?: boolean;
+
+  /**
+   * Body param: Match a place name.
+   */
+  near?: string;
+
+  /**
+   * Body param: Only return news results.
+   */
+  news?: boolean;
+
+  /**
+   * Body param: Shortcut for dedupeMode=merge.
+   */
+  overlapMode?: boolean;
+
+  /**
+   * Body param: Search within a place ID (tweet_search_extractor)
+   */
+  place?: string;
+
+  /**
+   * Body param: Search within a country code (tweet_search_extractor)
+   */
+  placeCountry?: string;
+
+  /**
+   * Body param: Geo point radius, e.g. -73.99 40.73 25mi (tweet_search_extractor)
+   */
+  pointRadius?: string;
+
+  /**
+   * Body param: Search ranking applied to every query.
+   */
+  queryType?: 'Latest' | 'Top' | 'Both';
+
+  /**
+   * Body param: Quote mode (tweet_search_extractor)
+   */
+  quotes?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Body param: Only quotes of this tweet ID (tweet_search_extractor)
+   */
+  quotesOfTweetId?: string;
+
+  /**
+   * Body param: Profile relations processed within one job.
+   */
+  relationTargets?: Array<ExtractionRunParams.RelationTarget>;
+
+  /**
+   * Body param: Reply mode (tweet_search_extractor)
+   */
+  replies?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Body param: Maximum number of results to extract. When set, the extraction stops
+   * after reaching this limit.
+   */
+  resultsLimit?: number;
+
+  /**
+   * Body param: Retweet mode (tweet_search_extractor)
+   */
+  retweets?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Body param: Only retweets of this tweet ID (tweet_search_extractor)
+   */
+  retweetsOfTweetId?: string;
+
+  /**
+   * Body param: Enable the safe-search filter.
+   */
+  safe?: boolean;
+
+  /**
+   * Body param: Reply depth scope.
+   */
+  scope?: 'all' | 'direct' | 'nested';
+
+  /**
+   * Body param: Search queries processed as one collection job.
+   */
+  searchQueries?: Array<string>;
+
+  /**
+   * Body param: Required for tweet_search_extractor & community_search.
+   */
+  searchQuery?: string;
+
+  /**
+   * Body param: Start date YYYY-MM-DD (tweet_search_extractor)
+   */
+  sinceDate?: string;
+
+  /**
+   * Body param: Return Tweets newer than this Tweet ID.
+   */
+  sinceId?: string;
+
+  /**
+   * Body param: Reply start time as ISO 8601 or Unix seconds.
+   */
+  sinceTime?: string | number;
+
+  /**
+   * Body param: Reply result order.
+   */
+  sort?: 'relevance' | 'latest' | 'oldest' | 'likes';
+
+  /**
+   * Body param: Match the source application.
+   */
+  source?: string;
+
+  /**
+   * Body param: Resume one reply target from this cursor.
+   */
+  startCursor?: string;
+
+  /**
+   * Body param: Required for community_post_extractor & community_search.
+   */
+  targetCommunityId?: string;
+
+  /**
+   * Body param: Community IDs processed as one collection job.
+   */
+  targetCommunityIds?: Array<string>;
+
+  /**
+   * Body param: Required for list_follower_explorer, list_member_extractor &
+   * list_post_extractor.
+   */
+  targetListId?: string;
+
+  /**
+   * Body param: List IDs processed as one collection job.
+   */
+  targetListIds?: Array<string>;
+
+  /**
+   * Body param: Mixed targets auto-routed within one job.
+   */
+  targets?: Array<string | ExtractionRunParams.UnionMember1>;
+
+  /**
+   * Body param: Required for space_explorer.
+   */
+  targetSpaceId?: string;
+
+  /**
+   * Body param
+   */
+  targetTweetId?: string;
+
+  /**
+   * Body param: Tweet IDs processed as one collection job.
+   */
+  targetTweetIds?: Array<string>;
+
+  /**
+   * Body param
+   */
+  targetUsername?: string;
+
+  /**
+   * Body param: Usernames processed as one collection job.
+   */
+  targetUsernames?: Array<string>;
+
+  /**
+   * Body param: Filter replies sent to a username (tweet_search_extractor)
+   */
+  toUser?: string;
+
+  /**
+   * Body param: End date YYYY-MM-DD (tweet_search_extractor)
+   */
+  untilDate?: string;
+
+  /**
+   * Body param: Reply end time as ISO 8601 or Unix seconds.
+   */
+  untilTime?: string | number;
+
+  /**
+   * Body param: URL substring or domain filter (tweet_search_extractor)
+   */
+  url?: string;
+
+  /**
+   * Body param: Required username text.
+   */
+  usernameContains?: string;
+
+  /**
+   * Body param: Only verified authors (tweet_search_extractor)
+   */
+  verifiedOnly?: boolean;
+
+  /**
+   * Body param: Exact profile verification type.
+   */
+  verifiedType?: string;
+
+  /**
+   * Body param: Set the radius for the near filter.
+   */
+  within?: string;
+
+  /**
+   * Body param: Match Tweets inside a recent time window.
+   */
+  withinTime?: string;
+}
+
+export namespace ExtractionRunParams {
+  /**
+   * One target and relation in a mixed profile collection.
+   */
+  export interface RelationTarget {
+    relation:
+      | 'community_members'
+      | 'followers'
+      | 'following'
+      | 'list_followers'
+      | 'list_members'
+      | 'verified_followers';
+
+    value: string;
+  }
+
+  export interface UnionMember1 {
+    kind:
+      | 'favoriters'
+      | 'list'
+      | 'profile'
+      | 'profile_likes'
+      | 'profile_media'
+      | 'profile_replies'
+      | 'quotes'
+      | 'replies'
+      | 'retweeters'
+      | 'search'
+      | 'thread'
+      | 'tweet';
+
+    value: string;
+  }
 }
 
 export declare namespace Extractions {