x-twitter-scraper 0.12.4 → 0.13.1

package/src/resources/x/communities/tweets.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';
@@ -11,19 +9,17 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 /**
- * X Community info, members, and tweets
+ * Find X Communities & read their info, members, posts & media
  */
 export class Tweets extends APIResource {
   /**
-   * Requires a Community ID and keyword query.
+   * One resumable page. Add communityId to search 1 Community, or leave it out to
+   * search every Community.
    *
    * @example
    * ```ts
    * const paginatedTweets =
-   *   await client.x.communities.tweets.list({
-   *     communityId: '321669910225',
-   *     q: 'q',
-   *   });
+   *   await client.x.communities.tweets.list({ q: 'q' });
    * ```
    */
   list(query: TweetListParams, options?: RequestOptions): APIPromise<Shared.PaginatedTweets> {
@@ -31,7 +27,10 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * List tweets posted in a community
+   * Returns public tweets posted within one community, newest first by default. Send
+   * queryType=Top for the posts X ranks highest. The first page opens with the tweet
+   * the community pinned, flagged isPinned, as x.com shows it. Each tweet costs 1
+   * credit.
    *
    * @example
    * ```ts
@@ -50,45 +49,451 @@ export class Tweets extends APIResource {
 
 export interface TweetListParams {
   /**
-   * Numeric ID of the community to search
+   * Search query
    */
-  communityId: string;
+  q: string;
 
   /**
-   * Keyword query within the selected community
+   * Words or quoted phrases where any one can match. Separate with spaces, commas,
+   * or lines.
    */
-  q: string;
+  anyWords?: string;
+
+  /**
+   * Only return tweets from Blue-verified authors.
+   */
+  blueVerifiedOnly?: boolean;
+
+  /**
+   * Cashtags separated by spaces, commas, or lines.
+   */
+  cashtags?: string;
+
+  /**
+   * Numeric ID of the Community whose posts to search. Leave it out to search posts
+   * across every Community.
+   */
+  communityId?: string;
+
+  /**
+   * Conversation ID filter.
+   */
+  conversationId?: string;
 
   /**
-   * Pagination cursor for community results
+   * Pagination cursor for community search. Also read as next_cursor, next_token,
+   * pagination_token or continuation_token.
    */
   cursor?: string;
 
   /**
-   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
-   * results. Continue while has_next_page is true. Deprecated limit and count
-   * aliases remain accepted.
+   * Match this literal phrase, including any hyphens.
+   */
+  exactPhrase?: string;
+
+  /**
+   * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+   */
+  excludeWords?: string;
+
+  /**
+   * Fields to keep in each row, comma-separated. Use dots for nested fields, such as
+   * author.username. A list keeps the field in each item. Case & underscores do not
+   * matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
+   * always stay. An unknown name answers 400 unknown_field with the valid names,
+   * before any read. The price stays the same. SDK row types then hold only the
+   * named fields.
+   */
+  fields?: string;
+
+  /**
+   * Filter by author username.
+   */
+  fromUser?: string;
+
+  /**
+   * Hashtags separated by spaces, commas, or lines.
+   */
+  hashtags?: string;
+
+  /**
+   * Only replies to this tweet ID.
+   */
+  inReplyToTweetId?: string;
+
+  /**
+   * Filter by language. Alias `lang` is accepted.
+   */
+  language?: string;
+
+  /**
+   * Maximum likes threshold. maxLikes & max_likes also work.
+   */
+  maxFaves?: number;
+
+  /**
+   * Return Tweets at or below this ID.
+   */
+  maxId?: string;
+
+  /**
+   * Maximum quotes threshold.
+   */
+  maxQuotes?: number;
+
+  /**
+   * Maximum replies threshold.
+   */
+  maxReplies?: number;
+
+  /**
+   * Maximum retweets threshold.
+   */
+  maxRetweets?: number;
+
+  /**
+   * Filter media. Aliases: has_video, has_media.
+   */
+  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+
+  /**
+   * Filter tweets mentioning a username.
+   */
+  mentioning?: string;
+
+  /**
+   * Minimum bookmark count threshold.
+   */
+  minBookmarks?: number;
+
+  /**
+   * Minimum likes. Aliases: minFaves, min_likes, min_faves.
+   */
+  minLikes?: number;
+
+  /**
+   * Minimum quote count threshold.
+   */
+  minQuotes?: number;
+
+  /**
+   * Minimum replies threshold.
+   */
+  minReplies?: number;
+
+  /**
+   * Minimum retweets threshold.
+   */
+  minRetweets?: number;
+
+  /**
+   * Minimum view count threshold.
+   */
+  minViews?: number;
+
+  /**
+   * Only return native reposts.
+   */
+  nativeRetweets?: boolean;
+
+  /**
+   * Fields to drop from each row, comma-separated. It takes the same names as
+   * fields. With fields, it drops from the kept fields.
+   */
+  omit?: string;
+
+  /**
+   * Items per page (1-100, default 20). Source, filters or credits can return fewer.
+   * Follow next_cursor for more pages. Aliases: limit, count, max_results, maxItems,
+   * max_items & per_page.
    */
   pageSize?: number;
 
   /**
-   * Sort order for community results (Latest or Top)
+   * Sort order (Latest or Top)
    */
   queryType?: 'Latest' | 'Top';
+
+  /**
+   * Only when the caller requests a quote mode.
+   */
+  quotes?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only quotes of this tweet ID.
+   */
+  quotesOfTweetId?: string;
+
+  /**
+   * Reply mode. Exclude keeps own-thread replies.
+   */
+  replies?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only when the caller requests a repost mode.
+   */
+  retweets?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only retweets of this tweet ID.
+   */
+  retweetsOfTweetId?: string;
+
+  /**
+   * Start date in YYYY-MM-DD format, as a UTC day.
+   */
+  sinceDate?: string;
+
+  /**
+   * Return Tweets whose IDs exceed this ID.
+   */
+  sinceId?: string;
+
+  /**
+   * Filter replies sent to a username.
+   */
+  toUser?: string;
+
+  /**
+   * End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
+   */
+  untilDate?: string;
+
+  /**
+   * URL substring or domain filter.
+   */
+  url?: string;
+
+  /**
+   * Only return tweets from verified authors.
+   */
+  verifiedOnly?: boolean;
+
+  /**
+   * Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m,
+   * h or d.
+   */
+  withinTime?: string;
 }
 
 export interface TweetListByCommunityParams {
   /**
-   * Pagination cursor for community tweets
+   * Words or quoted phrases where any one can match. Separate with spaces, commas,
+   * or lines.
+   */
+  anyWords?: string;
+
+  /**
+   * Only return tweets from Blue-verified authors.
+   */
+  blueVerifiedOnly?: boolean;
+
+  /**
+   * Cashtags separated by spaces, commas, or lines.
+   */
+  cashtags?: string;
+
+  /**
+   * Conversation ID filter.
+   */
+  conversationId?: string;
+
+  /**
+   * Pagination cursor for collection results. Also read as next_cursor, next_token,
+   * pagination_token or continuation_token.
    */
   cursor?: string;
 
   /**
-   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
-   * results. Continue while has_next_page is true. Deprecated limit and count
-   * aliases remain accepted.
+   * Match this literal phrase, including any hyphens.
+   */
+  exactPhrase?: string;
+
+  /**
+   * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+   */
+  excludeWords?: string;
+
+  /**
+   * Fields to keep in each row, comma-separated. Use dots for nested fields, such as
+   * author.username. A list keeps the field in each item. Case & underscores do not
+   * matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
+   * always stay. An unknown name answers 400 unknown_field with the valid names,
+   * before any read. The price stays the same. SDK row types then hold only the
+   * named fields.
+   */
+  fields?: string;
+
+  /**
+   * Filter by author username.
+   */
+  fromUser?: string;
+
+  /**
+   * Hashtags separated by spaces, commas, or lines.
+   */
+  hashtags?: string;
+
+  /**
+   * Only replies to this tweet ID.
+   */
+  inReplyToTweetId?: string;
+
+  /**
+   * Filter by language. Alias `lang` is accepted.
+   */
+  language?: string;
+
+  /**
+   * Maximum likes threshold. maxLikes & max_likes also work.
+   */
+  maxFaves?: number;
+
+  /**
+   * Return Tweets at or below this ID.
+   */
+  maxId?: string;
+
+  /**
+   * Maximum quotes threshold.
+   */
+  maxQuotes?: number;
+
+  /**
+   * Maximum replies threshold.
+   */
+  maxReplies?: number;
+
+  /**
+   * Maximum retweets threshold.
+   */
+  maxRetweets?: number;
+
+  /**
+   * Filter media. Aliases: has_video, has_media.
+   */
+  mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+
+  /**
+   * Filter tweets mentioning a username.
+   */
+  mentioning?: string;
+
+  /**
+   * Minimum bookmark count threshold.
+   */
+  minBookmarks?: number;
+
+  /**
+   * Minimum likes. Aliases: minFaves, min_likes, min_faves.
+   */
+  minLikes?: number;
+
+  /**
+   * Minimum quote count threshold.
+   */
+  minQuotes?: number;
+
+  /**
+   * Minimum replies threshold.
+   */
+  minReplies?: number;
+
+  /**
+   * Minimum retweets threshold.
+   */
+  minRetweets?: number;
+
+  /**
+   * Minimum view count threshold.
+   */
+  minViews?: number;
+
+  /**
+   * Only return native reposts.
+   */
+  nativeRetweets?: boolean;
+
+  /**
+   * Fields to drop from each row, comma-separated. It takes the same names as
+   * fields. With fields, it drops from the kept fields.
+   */
+  omit?: string;
+
+  /**
+   * Items per page (1-100, default 20). Source, filters or credits can return fewer.
+   * Follow next_cursor for more pages. Aliases: limit, count, max_results, maxItems,
+   * max_items & per_page.
    */
   pageSize?: number;
+
+  /**
+   * Latest for newest first, or Top for the posts X ranks highest. Any case. Aliases
+   * ranking & sort, which also take Recency & Relevance. Send the same value with
+   * each cursor.
+   */
+  queryType?: 'Latest' | 'Top';
+
+  /**
+   * Only when the caller requests a quote mode.
+   */
+  quotes?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only quotes of this tweet ID.
+   */
+  quotesOfTweetId?: string;
+
+  /**
+   * Reply mode. Exclude keeps own-thread replies.
+   */
+  replies?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only when the caller requests a repost mode.
+   */
+  retweets?: 'include' | 'exclude' | 'only';
+
+  /**
+   * Only retweets of this tweet ID.
+   */
+  retweetsOfTweetId?: string;
+
+  /**
+   * Start date in YYYY-MM-DD format, as a UTC day.
+   */
+  sinceDate?: string;
+
+  /**
+   * Return Tweets whose IDs exceed this ID.
+   */
+  sinceId?: string;
+
+  /**
+   * Filter replies sent to a username.
+   */
+  toUser?: string;
+
+  /**
+   * End date in YYYY-MM-DD format, as a UTC day, inclusive, so its own posts count.
+   */
+  untilDate?: string;
+
+  /**
+   * URL substring or domain filter.
+   */
+  url?: string;
+
+  /**
+   * Only return tweets from verified authors.
+   */
+  verifiedOnly?: boolean;
+
+  /**
+   * Keeps Tweets from a recent window, such as 90m or 7d. Use a whole number & s, m,
+   * h or d.
+   */
+  withinTime?: string;
 }
 
 export declare namespace Tweets {

package/src/resources/x/communities.ts

@@ -2,6 +2,4 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export * from './communities/index';