x-twitter-scraper 0.12.3 → 0.13.0

package/resources/x/communities/communities.d.ts

@@ -2,6 +2,8 @@ import { APIResource } from "../../../core/resource.js";
 import * as Shared from "../../shared.js";
 import * as JoinAPI from "./join.js";
 import { Join, JoinCreateParams, JoinCreateResponse, JoinDeleteAllParams, JoinDeleteAllResponse } from "./join.js";
+import * as MediaAPI from "./media.js";
+import { Media, MediaListParams } from "./media.js";
 import * as TweetsAPI from "./tweets.js";
 import { TweetListByCommunityParams, TweetListParams, Tweets } from "./tweets.js";
 import { APIPromise } from "../../../core/api-promise.js";
@@ -9,8 +11,9 @@ import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Communities extends APIResource {
     join: JoinAPI.Join;
     tweets: TweetsAPI.Tweets;
+    media: MediaAPI.Media;
     /**
-     * Create community
+     * Creates an X Community through a connected account.
      *
      * @example
      * ```ts
@@ -24,20 +27,71 @@ export declare class Communities extends APIResource {
      */
     create(params: CommunityCreateParams, options?: RequestOptions): APIPromise<CommunityCreateResponse>;
     /**
-     * Delete community
+     * Deletes an owned X Community through a connected account.
      *
      * @example
      * ```ts
-     * const community = await client.x.communities.delete('id', {
-     *   account: '@elonmusk',
-     *   community_name: 'Tesla Fans',
-     *   'Idempotency-Key': 'Idempotency-Key',
-     * });
+     * const community = await client.x.communities.delete(
+     *   '1500000000000000000',
+     *   {
+     *     account: '@elonmusk',
+     *     community_name: 'Tesla Fans',
+     *     'Idempotency-Key': 'Idempotency-Key',
+     *   },
+     * );
      * ```
      */
     delete(id: string, params: CommunityDeleteParams, options?: RequestOptions): APIPromise<CommunityDeleteResponse>;
     /**
-     * Get community name, description and member count
+     * Returns the communities X finds for a keyword, in X's order. Each community
+     * costs 1 credit. To search the tweets in Communities, use /x/communities/search.
+     *
+     * @example
+     * ```ts
+     * const communityPage = await client.x.communities.find({
+     *   q: 'q',
+     * });
+     * ```
+     */
+    find(query: CommunityFindParams, options?: RequestOptions): APIPromise<Shared.CommunityPage>;
+    /**
+     * Returns the communities X ranks highest under a topic or subtopic. Name it by
+     * topicId or by topic name from /x/communities/topics. Each community costs 1
+     * credit. A missing or unknown topic returns invalid_community_topic & lists the
+     * topic names.
+     *
+     * @example
+     * ```ts
+     * const communityPage =
+     *   await client.x.communities.listPopular();
+     * ```
+     */
+    listPopular(query?: CommunityListPopularParams | null | undefined, options?: RequestOptions): APIPromise<Shared.CommunityPage>;
+    /**
+     * Returns the communities X suggests, with their full public fields. X picks them
+     * per request, so 2 calls can differ. If X suggests none, Xquik asks up to 2 more
+     * times. An empty list is free. Each community costs 1 credit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.communities.listSuggested();
+     * ```
+     */
+    listSuggested(query?: CommunityListSuggestedParams | null | undefined, options?: RequestOptions): APIPromise<CommunityListSuggestedResponse>;
+    /**
+     * Returns the community topics with their subtopics. Pass an ID as topicId, or a
+     * name as topic, to /x/communities/popular. Each top-level topic costs 1 credit,
+     * its subtopics included.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.communities.listTopics();
+     * ```
+     */
+    listTopics(query?: CommunityListTopicsParams | null | undefined, options?: RequestOptions): APIPromise<CommunityListTopicsResponse>;
+    /**
+     * Returns one community's public identity, rules, join question, search tags,
+     * membership counts, and the profiles of its creator, admin and previewed members.
      *
      * @example
      * ```ts
@@ -46,9 +100,9 @@ export declare class Communities extends APIResource {
      * );
      * ```
      */
-    retrieveInfo(id: string, options?: RequestOptions): APIPromise<CommunityRetrieveInfoResponse>;
+    retrieveInfo(id: string, query?: CommunityRetrieveInfoParams | null | undefined, options?: RequestOptions): APIPromise<CommunityRetrieveInfoResponse>;
     /**
-     * List members of a community
+     * Returns public member profiles for one community.
      *
      * @example
      * ```ts
@@ -58,7 +112,7 @@ export declare class Communities extends APIResource {
      */
     retrieveMembers(id: string, query?: CommunityRetrieveMembersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
-     * List moderators of a community
+     * Returns public moderator profiles for one community.
      *
      * @example
      * ```ts
@@ -68,23 +122,37 @@ export declare class Communities extends APIResource {
      */
     retrieveModerators(id: string, query?: CommunityRetrieveModeratorsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
-     * Returns tweets, not community records. Requires a Community ID.
+     * Returns one tweet page, not community records. Add communityId to search 1
+     * Community, or leave it out to search every Community. To find communities by
+     * keyword, use /x/communities/find.
      *
      * @example
      * ```ts
      * const paginatedTweets =
-     *   await client.x.communities.retrieveSearch({
-     *     communityId: '321669910225',
+     *   await client.x.communities.retrieveSearch({ q: 'q' });
+     * ```
+     */
+    retrieveSearch(query: CommunityRetrieveSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
+    /**
+     * Finds a community's members by name or username, as the search box on X's
+     * members page does. X checks up to 10 accounts that match, & the answer holds the
+     * members among them, each with its role. Each member costs 1 credit. An answer
+     * without members is free.
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.communities.searchMembers('id', {
      *     q: 'q',
      *   });
      * ```
      */
-    retrieveSearch(query: CommunityRetrieveSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
+    searchMembers(id: string, query: CommunitySearchMembersParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
 }
 /**
- * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
- * the original Idempotency-Key returns this same record. Submit a new write only
- * when safeToRetry is true, using a new key.
+ * Durable write record. Poll statusUrl until terminal is true. Reusing its
+ * Idempotency-Key returns this record. Create another action only when safeToRetry
+ * is true.
  */
 export interface CommunityCreateResponse {
     id: string;
@@ -92,7 +160,7 @@ export interface CommunityCreateResponse {
      * Connected account selected for the write.
      */
     account: CommunityCreateResponse.Account | null;
-    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
+    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'delete_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
     /**
      * plannedCredits is the approved maximum. chargedCredits comes from the settled
      * credit ledger. Pending or failed writes are not charged.
@@ -119,7 +187,7 @@ export interface CommunityCreateResponse {
      */
     retryable: boolean;
     /**
-     * True only when no write was dispatched and a new idempotency key may be used.
+     * True only when X did not get the write and a new idempotency key may be used.
      */
     safeToRetry: boolean;
     sendDispatched: boolean;
@@ -158,6 +226,10 @@ export interface CommunityCreateResponse {
      * retention deadline.
      */
     expiresAt?: string;
+    /**
+     * True when this answers a retry of an earlier request with the same
+     * Idempotency-Key.
+     */
     idempotent?: boolean;
     /**
      * Media count, kind, size, and billing details when used.
@@ -217,6 +289,9 @@ export declare namespace CommunityCreateResponse {
      */
     interface NextAction {
         type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        /**
+         * Milliseconds to wait before you poll or retry.
+         */
         afterMs?: number;
         requiresNewIdempotencyKey?: boolean;
         url?: string;
@@ -253,9 +328,9 @@ export declare namespace CommunityCreateResponse {
     }
 }
 /**
- * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
- * the original Idempotency-Key returns this same record. Submit a new write only
- * when safeToRetry is true, using a new key.
+ * Durable write record. Poll statusUrl until terminal is true. Reusing its
+ * Idempotency-Key returns this record. Create another action only when safeToRetry
+ * is true.
  */
 export interface CommunityDeleteResponse {
     id: string;
@@ -263,7 +338,7 @@ export interface CommunityDeleteResponse {
      * Connected account selected for the write.
      */
     account: CommunityDeleteResponse.Account | null;
-    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
+    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'delete_dm' | 'upload_media' | 'update_profile' | 'update_avatar' | 'update_banner' | 'create_community' | 'delete_community' | 'join_community' | 'leave_community';
     /**
      * plannedCredits is the approved maximum. chargedCredits comes from the settled
      * credit ledger. Pending or failed writes are not charged.
@@ -290,7 +365,7 @@ export interface CommunityDeleteResponse {
      */
     retryable: boolean;
     /**
-     * True only when no write was dispatched and a new idempotency key may be used.
+     * True only when X did not get the write and a new idempotency key may be used.
      */
     safeToRetry: boolean;
     sendDispatched: boolean;
@@ -329,6 +404,10 @@ export interface CommunityDeleteResponse {
      * retention deadline.
      */
     expiresAt?: string;
+    /**
+     * True when this answers a retry of an earlier request with the same
+     * Idempotency-Key.
+     */
     idempotent?: boolean;
     /**
      * Media count, kind, size, and billing details when used.
@@ -388,6 +467,9 @@ export declare namespace CommunityDeleteResponse {
      */
     interface NextAction {
         type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        /**
+         * Milliseconds to wait before you poll or retry.
+         */
         afterMs?: number;
         requiresNewIdempotencyKey?: boolean;
         url?: string;
@@ -423,87 +505,39 @@ export declare namespace CommunityDeleteResponse {
         type: 'tweet' | 'user' | 'community';
     }
 }
-export interface CommunityRetrieveInfoResponse {
+export interface CommunityListSuggestedResponse {
+    /**
+     * Suggested communities in X's order
+     */
+    communities: Array<Shared.Community>;
+    /**
+     * Communities returned & charged
+     */
+    count: number;
     /**
-     * Community info object
+     * What to do next. Present only when X suggests none.
      */
-    community: CommunityRetrieveInfoResponse.Community;
+    message?: string;
 }
-export declare namespace CommunityRetrieveInfoResponse {
+export interface CommunityListTopicsResponse {
     /**
-     * Community info object
+     * Top-level topics returned & charged
      */
-    interface Community {
-        /**
-         * Unique community identifier
-         */
-        id: string;
-        /**
-         * Community banner image URL
-         */
-        banner_url?: string;
-        /**
-         * Community creation timestamp
-         */
-        created_at?: string;
-        creator?: Community.Creator;
-        /**
-         * About text for the community
-         */
-        description?: string;
-        /**
-         * Invitation policy
-         */
-        invites_policy?: string;
-        /**
-         * Whether the community is marked sensitive
-         */
-        is_nsfw?: boolean;
-        /**
-         * Join policy (open or restricted)
-         */
-        join_policy?: string;
-        /**
-         * Total member count
-         */
-        member_count?: number;
-        /**
-         * Total moderator count
-         */
-        moderator_count?: number;
-        /**
-         * Display name of the community
-         */
-        name?: string;
-        /**
-         * Primary topic
-         */
-        primary_topic?: Community.PrimaryTopic;
-        /**
-         * Community rules
-         */
-        rules?: Array<Community.Rule>;
-    }
-    namespace Community {
-        interface Creator {
-            id: string;
-            username: string;
-            verified: boolean;
-            name?: string;
-        }
-        /**
-         * Primary topic
-         */
-        interface PrimaryTopic {
-            id?: string;
-            name?: string;
-        }
-        interface Rule {
-            id?: string;
-            description?: string;
-            name?: string;
-        }
-    }
+    count: number;
+    /**
+     * Topics in X's order
+     */
+    topics: Array<Shared.CommunityTopic>;
+    /**
+     * What to do next. Present only when X lists no topic.
+     */
+    message?: string;
+}
+export interface CommunityRetrieveInfoResponse {
+    /**
+     * Public X Community, as every Community read returns it.
+     */
+    community: Shared.Community;
 }
 export interface CommunityCreateParams {
     /**
@@ -511,14 +545,16 @@ export interface CommunityCreateParams {
      */
     account: string;
     /**
-     * Body param: Community name
+     * Body param: Community name, 1 to 100 characters, as X takes it
      */
     name: string;
     /**
-     * Header param: Generate one unique value for each intended write. Reuse it only
-     * when retrying the exact same account, action, target, and payload. A reused key
-     * returns the original action. Reusing it with different input returns 409. Replay
-     * protection remains active for at least 90 days.
+     * Header param: Use one unique value per intended write. Reuse it only for an
+     * identical retry. A matching retry returns the first answer again, with
+     * idempotent: true added. It keeps the first status, body & Retry-After. It sends
+     * nothing to X & charges nothing. While the first request runs, a retry returns
+     * 202 & the action. Different input returns 409. Protection lasts at least 90
+     * days.
      */
     'Idempotency-Key': string;
     /**
@@ -536,22 +572,176 @@ export interface CommunityDeleteParams {
      */
     community_name: string;
     /**
-     * Header param: Generate one unique value for each intended write. Reuse it only
-     * when retrying the exact same account, action, target, and payload. A reused key
-     * returns the original action. Reusing it with different input returns 409. Replay
-     * protection remains active for at least 90 days.
+     * Header param: Use one unique value per intended write. Reuse it only for an
+     * identical retry. A matching retry returns the first answer again, with
+     * idempotent: true added. It keeps the first status, body & Retry-After. It sends
+     * nothing to X & charges nothing. While the first request runs, a retry returns
+     * 202 & the action. Different input returns 409. Protection lasts at least 90
+     * days.
      */
     'Idempotency-Key': string;
 }
+export interface CommunityFindParams {
+    /**
+     * Keyword to find communities by, such as ai. Alias query.
+     */
+    q: string;
+    /**
+     * Pagination cursor for collection results. Also read as next_cursor, next_token,
+     * pagination_token or continuation_token.
+     */
+    cursor?: 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;
+    /**
+     * 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;
+}
+export interface CommunityListPopularParams {
+    /**
+     * Pagination cursor for collection results. Also read as next_cursor, next_token,
+     * pagination_token or continuation_token.
+     */
+    cursor?: 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;
+    /**
+     * 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;
+    /**
+     * Topic or subtopic name in any case, such as technology. Send this or topicId.
+     */
+    topic?: string;
+    /**
+     * Topic or subtopic ID from /x/communities/topics, such as 301. Wins over topic.
+     */
+    topicId?: string;
+}
+export interface CommunityListSuggestedParams {
+    /**
+     * 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;
+    /**
+     * Maximum communities to return. Omit it for every suggestion. Credits can return
+     * fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.
+     */
+    limit?: number;
+    /**
+     * 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;
+}
+export interface CommunityListTopicsParams {
+    /**
+     * 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;
+    /**
+     * Maximum topics to return. Omit it for every topic. Credits can return fewer.
+     * Aliases pageSize, count, max_results, maxItems, max_items & per_page.
+     */
+    limit?: number;
+    /**
+     * 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;
+}
+export interface CommunityRetrieveInfoParams {
+    /**
+     * 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;
+    /**
+     * 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;
+}
 export interface CommunityRetrieveMembersParams {
     /**
      * Match any comma-separated or line-separated bio term, ignoring case.
      */
     bioContains?: string;
     /**
-     * Pagination cursor
+     * Only return profiles X marks as blue verified. X marks many business &
+     * government accounts blue too. Use verifiedType for 1 badge type.
+     */
+    blueVerifiedOnly?: boolean;
+    /**
+     * Only return profiles that publish an email outside free webmail, such as Gmail.
+     */
+    businessEmailOnly?: boolean;
+    /**
+     * Pagination cursor for collection results. Also read as next_cursor, next_token,
+     * pagination_token or continuation_token.
      */
     cursor?: string;
+    /**
+     * Only return profiles with an email at one of these domains. Separate domains
+     * with commas. Subdomains match.
+     */
+    emailDomains?: 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;
+    /**
+     * Only return profiles that publish an email.
+     */
+    hasEmail?: boolean;
     /**
      * Only return profiles with a location.
      */
@@ -569,7 +759,7 @@ export interface CommunityRetrieveMembersParams {
      */
     maxFollowers?: number;
     /**
-     * Maximum following count.
+     * Profiles may follow at most this many accounts.
      */
     maxFollowing?: number;
     /**
@@ -585,7 +775,7 @@ export interface CommunityRetrieveMembersParams {
      */
     minFollowers?: number;
     /**
-     * Minimum following count.
+     * Profiles must follow at least this many accounts.
      */
     minFollowing?: number;
     /**
@@ -593,9 +783,12 @@ export interface CommunityRetrieveMembersParams {
      */
     minStatuses?: number;
     /**
-     * Items per page (20-200, default 20). This is an upper bound for paid
-     * authenticated calls: available usage balance can reduce the returned page size, and
-     * zero affordable results returns 402 insufficient_credits.
+     * 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;
+    /**
+     * Maximum user profiles per page (1-200, default 20).
      */
     pageSize?: number;
     /**
@@ -617,9 +810,37 @@ export interface CommunityRetrieveModeratorsParams {
      */
     bioContains?: string;
     /**
-     * Pagination cursor for community moderators
+     * Only return profiles X marks as blue verified. X marks many business &
+     * government accounts blue too. Use verifiedType for 1 badge type.
+     */
+    blueVerifiedOnly?: boolean;
+    /**
+     * Only return profiles that publish an email outside free webmail, such as Gmail.
+     */
+    businessEmailOnly?: boolean;
+    /**
+     * Pagination cursor for collection results. Also read as next_cursor, next_token,
+     * pagination_token or continuation_token.
      */
     cursor?: string;
+    /**
+     * Only return profiles with an email at one of these domains. Separate domains
+     * with commas. Subdomains match.
+     */
+    emailDomains?: 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;
+    /**
+     * Only return profiles that publish an email.
+     */
+    hasEmail?: boolean;
     /**
      * Only return profiles with a location.
      */
@@ -637,7 +858,7 @@ export interface CommunityRetrieveModeratorsParams {
      */
     maxFollowers?: number;
     /**
-     * Maximum following count.
+     * Profiles may follow at most this many accounts.
      */
     maxFollowing?: number;
     /**
@@ -653,13 +874,18 @@ export interface CommunityRetrieveModeratorsParams {
      */
     minFollowers?: number;
     /**
-     * Minimum following count.
+     * Profiles must follow at least this many accounts.
      */
     minFollowing?: number;
     /**
      * Minimum post count. minPosts is also accepted.
      */
     minStatuses?: number;
+    /**
+     * 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;
     /**
      * Match a username substring, ignoring case.
      */
@@ -674,32 +900,290 @@ export interface CommunityRetrieveModeratorsParams {
     verifiedType?: string;
 }
 export interface CommunityRetrieveSearchParams {
-    /**
-     * Numeric ID of the community whose posts to search
-     */
-    communityId: string;
     /**
      * Search query
      */
     q: string;
     /**
-     * Pagination cursor for community search
+     * 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;
+    /**
+     * 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 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 (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 CommunitySearchMembersParams {
+    /**
+     * Name or username to find members by, such as marckohlbrugge. A leading @ is
+     * dropped. Alias query.
+     */
+    q: string;
+    /**
+     * Match any comma-separated or line-separated bio term, ignoring case.
+     */
+    bioContains?: string;
+    /**
+     * Only return profiles X marks as blue verified. X marks many business &
+     * government accounts blue too. Use verifiedType for 1 badge type.
+     */
+    blueVerifiedOnly?: boolean;
+    /**
+     * Only return profiles that publish an email outside free webmail, such as Gmail.
+     */
+    businessEmailOnly?: boolean;
+    /**
+     * Only return profiles with an email at one of these domains. Separate domains
+     * with commas. Subdomains match.
+     */
+    emailDomains?: 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;
+    /**
+     * Only return profiles that publish an email.
+     */
+    hasEmail?: boolean;
+    /**
+     * Only return profiles with a location.
+     */
+    hasLocation?: boolean;
+    /**
+     * Only return profiles with a website.
+     */
+    hasWebsite?: boolean;
+    /**
+     * Match a location substring, ignoring case.
+     */
+    locationContains?: string;
+    /**
+     * Maximum follower count. Missing counts pass this maximum.
+     */
+    maxFollowers?: number;
+    /**
+     * Profiles may follow at most this many accounts.
+     */
+    maxFollowing?: number;
+    /**
+     * Maximum post count. maxPosts is also accepted.
+     */
+    maxStatuses?: number;
+    /**
+     * Minimum account age in whole days.
+     */
+    minAccountAgeDays?: number;
+    /**
+     * Minimum follower count. Filtering happens before billing.
+     */
+    minFollowers?: number;
+    /**
+     * Profiles must follow at least this many accounts.
+     */
+    minFollowing?: number;
+    /**
+     * Minimum post count. minPosts is also accepted.
+     */
+    minStatuses?: number;
+    /**
+     * 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;
+    /**
+     * Match a username substring, ignoring case.
+     */
+    usernameContains?: string;
+    /**
+     * Only return verified profiles.
+     */
+    verifiedOnly?: boolean;
+    /**
+     * Match the verification type exactly, ignoring case.
+     */
+    verifiedType?: string;
 }
 export declare namespace Communities {
-    export { type CommunityCreateResponse as CommunityCreateResponse, type CommunityDeleteResponse as CommunityDeleteResponse, type CommunityRetrieveInfoResponse as CommunityRetrieveInfoResponse, type CommunityCreateParams as CommunityCreateParams, type CommunityDeleteParams as CommunityDeleteParams, type CommunityRetrieveMembersParams as CommunityRetrieveMembersParams, type CommunityRetrieveModeratorsParams as CommunityRetrieveModeratorsParams, type CommunityRetrieveSearchParams as CommunityRetrieveSearchParams, };
+    export { type CommunityCreateResponse as CommunityCreateResponse, type CommunityDeleteResponse as CommunityDeleteResponse, type CommunityListSuggestedResponse as CommunityListSuggestedResponse, type CommunityListTopicsResponse as CommunityListTopicsResponse, type CommunityRetrieveInfoResponse as CommunityRetrieveInfoResponse, type CommunityCreateParams as CommunityCreateParams, type CommunityDeleteParams as CommunityDeleteParams, type CommunityFindParams as CommunityFindParams, type CommunityListPopularParams as CommunityListPopularParams, type CommunityListSuggestedParams as CommunityListSuggestedParams, type CommunityListTopicsParams as CommunityListTopicsParams, type CommunityRetrieveInfoParams as CommunityRetrieveInfoParams, type CommunityRetrieveMembersParams as CommunityRetrieveMembersParams, type CommunityRetrieveModeratorsParams as CommunityRetrieveModeratorsParams, type CommunityRetrieveSearchParams as CommunityRetrieveSearchParams, type CommunitySearchMembersParams as CommunitySearchMembersParams, };
     export { Join as Join, type JoinCreateResponse as JoinCreateResponse, type JoinDeleteAllResponse as JoinDeleteAllResponse, type JoinCreateParams as JoinCreateParams, type JoinDeleteAllParams as JoinDeleteAllParams, };
     export { Tweets as Tweets, type TweetListParams as TweetListParams, type TweetListByCommunityParams as TweetListByCommunityParams, };
+    export { Media as Media, type MediaListParams as MediaListParams };
 }
 //# sourceMappingURL=communities.d.ts.map