x-twitter-scraper 0.3.2 → 0.4.0

package/resources/x/users/users.d.ts

@@ -4,9 +4,6 @@ import * as FollowAPI from "./follow.js";
 import { Follow, FollowCreateParams, FollowCreateResponse, FollowDeleteAllParams, FollowDeleteAllResponse } from "./follow.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { RequestOptions } from "../../../internal/request-options.js";
-/**
- * Look up, search, and explore user profiles and relationships
- */
 export declare class Users extends APIResource {
     follow: FollowAPI.Follow;
     /**
@@ -18,17 +15,28 @@ export declare class Users extends APIResource {
      * ```
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Shared.UserProfile>;
+    /**
+     * Remove follower
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.removeFollower('id', {
+     *   account: '@elonmusk',
+     * });
+     * ```
+     */
+    removeFollower(id: string, body: UserRemoveFollowerParams, options?: RequestOptions): APIPromise<UserRemoveFollowerResponse>;
     /**
      * Look up multiple users by IDs in one call
      *
      * @example
      * ```ts
-     * const paginatedUsers = await client.x.users.retrieveBatch({
+     * const response = await client.x.users.retrieveBatch({
      *   ids: 'ids',
      * });
      * ```
      */
-    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
+    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<UserRetrieveBatchResponse>;
     /**
      * List followers of a user
      *
@@ -91,6 +99,16 @@ export declare class Users extends APIResource {
      * ```
      */
     retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
+    /**
+     * Returns the user's timeline with replies included by default.
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets =
+     *   await client.x.users.retrieveReplies('id');
+     * ```
+     */
+    retrieveReplies(id: string, query?: UserRetrieveRepliesParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Search users by name or username
      *
@@ -124,19 +142,78 @@ export declare class Users extends APIResource {
      */
     retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
 }
+export interface UserRemoveFollowerResponse {
+    success: true;
+}
+/**
+ * Batch user lookup results. Duplicate requested IDs are ignored while preserving
+ * first-seen order. unavailable_ids identifies processed IDs with no returned
+ * profile. unprocessed_ids identifies IDs skipped when the available usage balance limited
+ * processing.
+ */
+export interface UserRetrieveBatchResponse {
+    /**
+     * Batch lookups never paginate.
+     */
+    has_next_page: false;
+    /**
+     * Empty because batch lookups never paginate.
+     */
+    next_cursor: string;
+    /**
+     * Number of requested IDs included in the lookup.
+     */
+    processed_count: number;
+    /**
+     * Number of unique IDs requested.
+     */
+    requested_count: number;
+    /**
+     * Number of user profiles returned and charged.
+     */
+    returned_count: number;
+    /**
+     * Processed IDs with no returned profile, in first-seen request order.
+     */
+    unavailable_ids: Array<string>;
+    /**
+     * Requested IDs skipped because the available usage balance limited processing. Retry these
+     * IDs after adding balance.
+     */
+    unprocessed_ids: Array<string>;
+    users: Array<Shared.UserProfile>;
+}
+export interface UserRemoveFollowerParams {
+    /**
+     * X account identifier (@username or account ID)
+     */
+    account: string;
+}
 export interface UserRetrieveBatchParams {
     /**
-     * Comma-separated user IDs (max 100)
+     * Comma-separated numeric user IDs (1-100 values). Duplicate IDs are ignored while
+     * preserving first-seen order.
      */
     ids: string;
 }
 export interface UserRetrieveFollowersParams {
+    /**
+     * Legacy cursor alias. Prefer cursor.
+     */
+    after?: string;
     /**
      * Pagination cursor for followers list
      */
     cursor?: string;
     /**
-     * Items per page (20-200, default 200)
+     * Legacy integer page size alias for following lists. Prefer pageSize.
+     */
+    limit?: number;
+    /**
+     * Maximum user profiles requested from this page (20-200, default 200). The
+     * response can contain fewer profiles because the source returned fewer or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true. The deprecated limit and count aliases remain accepted.
      */
     pageSize?: number;
 }
@@ -145,42 +222,506 @@ export interface UserRetrieveFollowersYouKnowParams {
      * Pagination cursor for followers-you-know
      */
     cursor?: string;
+    /**
+     * Maximum user profiles requested from this page (20-200, default 200). The
+     * response can contain fewer profiles because the source returned fewer or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true. The deprecated limit and count aliases remain accepted.
+     */
+    pageSize?: number;
 }
 export interface UserRetrieveFollowingParams {
+    /**
+     * Legacy cursor alias. Prefer cursor.
+     */
+    after?: string;
     /**
      * Pagination cursor for following list
      */
     cursor?: string;
     /**
-     * Results per page (20-200, default 200)
+     * Legacy page size alias. Prefer pageSize.
+     */
+    limit?: number;
+    /**
+     * Maximum user profiles requested from this page (20-200, default 200). The
+     * response can contain fewer profiles because the source returned fewer or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true. The deprecated limit and count aliases remain accepted.
      */
     pageSize?: number;
 }
 export interface UserRetrieveLikesParams {
+    /**
+     * Words or quoted phrases where any one can match. Separate with spaces, commas,
+     * or lines.
+     */
+    anyWords?: string;
+    /**
+     * Cashtags separated by spaces, commas, or lines.
+     */
+    cashtags?: string;
+    /**
+     * Conversation ID filter.
+     */
+    conversationId?: string;
     /**
      * Pagination cursor for liked tweets
      */
     cursor?: string;
+    /**
+     * Exact phrase to match.
+     */
+    exactPhrase?: string;
+    /**
+     * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+     */
+    excludeWords?: string;
+    /**
+     * Filter by author username.
+     */
+    fromUser?: string;
+    /**
+     * Hashtags separated by spaces, commas, or lines.
+     */
+    hashtags?: string;
+    /**
+     * Only replies to this tweet ID.
+     */
+    inReplyToTweetId?: string;
+    /**
+     * Language code filter, e.g. en or tr.
+     */
+    language?: string;
+    /**
+     * Filter by media type.
+     */
+    mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+    /**
+     * Filter tweets mentioning a username.
+     */
+    mentioning?: string;
+    /**
+     * Minimum likes threshold.
+     */
+    minFaves?: number;
+    /**
+     * Minimum quote count threshold.
+     */
+    minQuotes?: number;
+    /**
+     * Minimum replies threshold.
+     */
+    minReplies?: number;
+    /**
+     * Minimum retweets threshold.
+     */
+    minRetweets?: number;
+    /**
+     * Maximum items requested from this page (1-100, default 20). The response can
+     * contain fewer items because the source returned fewer, filters removed items, or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true, even when a page is empty. The deprecated limit and count
+     * aliases remain accepted.
+     */
+    pageSize?: number;
+    /**
+     * Quote mode.
+     */
+    quotes?: 'include' | 'exclude' | 'only';
+    /**
+     * Only quotes of this tweet ID.
+     */
+    quotesOfTweetId?: string;
+    /**
+     * Reply mode.
+     */
+    replies?: 'include' | 'exclude' | 'only';
+    /**
+     * Retweet mode.
+     */
+    retweets?: 'include' | 'exclude' | 'only';
+    /**
+     * Only retweets of this tweet ID.
+     */
+    retweetsOfTweetId?: string;
+    /**
+     * Start date in YYYY-MM-DD format.
+     */
+    sinceDate?: string;
+    /**
+     * Filter replies sent to a username.
+     */
+    toUser?: string;
+    /**
+     * End date in YYYY-MM-DD format.
+     */
+    untilDate?: string;
+    /**
+     * URL substring or domain filter.
+     */
+    url?: string;
+    /**
+     * Only return tweets from verified authors.
+     */
+    verifiedOnly?: boolean;
 }
 export interface UserRetrieveMediaParams {
+    /**
+     * Words or quoted phrases where any one can match. Separate with spaces, commas,
+     * or lines.
+     */
+    anyWords?: string;
+    /**
+     * Cashtags separated by spaces, commas, or lines.
+     */
+    cashtags?: string;
+    /**
+     * Conversation ID filter.
+     */
+    conversationId?: string;
     /**
      * Pagination cursor for media tweets
      */
     cursor?: string;
+    /**
+     * Exact phrase to match.
+     */
+    exactPhrase?: string;
+    /**
+     * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+     */
+    excludeWords?: string;
+    /**
+     * Filter by author username.
+     */
+    fromUser?: string;
+    /**
+     * Hashtags separated by spaces, commas, or lines.
+     */
+    hashtags?: string;
+    /**
+     * Only replies to this tweet ID.
+     */
+    inReplyToTweetId?: string;
+    /**
+     * Language code filter, e.g. en or tr.
+     */
+    language?: string;
+    /**
+     * Filter by media type.
+     */
+    mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+    /**
+     * Filter tweets mentioning a username.
+     */
+    mentioning?: string;
+    /**
+     * Minimum likes threshold.
+     */
+    minFaves?: number;
+    /**
+     * Minimum quote count threshold.
+     */
+    minQuotes?: number;
+    /**
+     * Minimum replies threshold.
+     */
+    minReplies?: number;
+    /**
+     * Minimum retweets threshold.
+     */
+    minRetweets?: number;
+    /**
+     * Maximum items requested from this page (1-100, default 20). The response can
+     * contain fewer items because the source returned fewer, filters removed items, or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true, even when a page is empty. The deprecated limit and count
+     * aliases remain accepted.
+     */
+    pageSize?: number;
+    /**
+     * Quote mode.
+     */
+    quotes?: 'include' | 'exclude' | 'only';
+    /**
+     * Only quotes of this tweet ID.
+     */
+    quotesOfTweetId?: string;
+    /**
+     * Reply mode.
+     */
+    replies?: 'include' | 'exclude' | 'only';
+    /**
+     * Retweet mode.
+     */
+    retweets?: 'include' | 'exclude' | 'only';
+    /**
+     * Only retweets of this tweet ID.
+     */
+    retweetsOfTweetId?: string;
+    /**
+     * Start date in YYYY-MM-DD format.
+     */
+    sinceDate?: string;
+    /**
+     * Filter replies sent to a username.
+     */
+    toUser?: string;
+    /**
+     * End date in YYYY-MM-DD format.
+     */
+    untilDate?: string;
+    /**
+     * URL substring or domain filter.
+     */
+    url?: string;
+    /**
+     * Only return tweets from verified authors.
+     */
+    verifiedOnly?: boolean;
 }
 export interface UserRetrieveMentionsParams {
+    /**
+     * Words or quoted phrases where any one can match. Separate with spaces, commas,
+     * or lines.
+     */
+    anyWords?: string;
+    /**
+     * Cashtags separated by spaces, commas, or lines.
+     */
+    cashtags?: string;
+    /**
+     * Conversation ID filter.
+     */
+    conversationId?: string;
     /**
      * Pagination cursor for mentions
      */
     cursor?: string;
+    /**
+     * Exact phrase to match.
+     */
+    exactPhrase?: string;
+    /**
+     * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+     */
+    excludeWords?: string;
+    /**
+     * Filter by author username.
+     */
+    fromUser?: string;
+    /**
+     * Hashtags separated by spaces, commas, or lines.
+     */
+    hashtags?: string;
+    /**
+     * Only replies to this tweet ID.
+     */
+    inReplyToTweetId?: string;
+    /**
+     * Language code filter, e.g. en or tr.
+     */
+    language?: string;
+    /**
+     * Filter by media type.
+     */
+    mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+    /**
+     * Filter tweets mentioning a username.
+     */
+    mentioning?: string;
+    /**
+     * Minimum likes threshold.
+     */
+    minFaves?: number;
+    /**
+     * Minimum quote count threshold.
+     */
+    minQuotes?: number;
+    /**
+     * Minimum replies threshold.
+     */
+    minReplies?: number;
+    /**
+     * Minimum retweets threshold.
+     */
+    minRetweets?: number;
+    /**
+     * Maximum items requested from this page (1-100, default 20). The response can
+     * contain fewer items because the source returned fewer, filters removed items, or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true, even when a page is empty. The deprecated limit and count
+     * aliases remain accepted.
+     */
+    pageSize?: number;
+    /**
+     * Quote mode.
+     */
+    quotes?: 'include' | 'exclude' | 'only';
+    /**
+     * Only quotes of this tweet ID.
+     */
+    quotesOfTweetId?: string;
+    /**
+     * Reply mode.
+     */
+    replies?: 'include' | 'exclude' | 'only';
+    /**
+     * Retweet mode.
+     */
+    retweets?: 'include' | 'exclude' | 'only';
+    /**
+     * Only retweets of this tweet ID.
+     */
+    retweetsOfTweetId?: string;
+    /**
+     * Start date in YYYY-MM-DD format.
+     */
+    sinceDate?: string;
     /**
      * Unix timestamp - return mentions after this time
      */
     sinceTime?: string;
+    /**
+     * Filter replies sent to a username.
+     */
+    toUser?: string;
+    /**
+     * End date in YYYY-MM-DD format.
+     */
+    untilDate?: string;
     /**
      * Unix timestamp - return mentions before this time
      */
     untilTime?: string;
+    /**
+     * URL substring or domain filter.
+     */
+    url?: string;
+    /**
+     * Only return tweets from verified authors.
+     */
+    verifiedOnly?: boolean;
+}
+export interface UserRetrieveRepliesParams {
+    /**
+     * Words or quoted phrases where any one can match. Separate with spaces, commas,
+     * or lines.
+     */
+    anyWords?: string;
+    /**
+     * Cashtags separated by spaces, commas, or lines.
+     */
+    cashtags?: string;
+    /**
+     * Conversation ID filter.
+     */
+    conversationId?: string;
+    /**
+     * Pagination cursor for user replies
+     */
+    cursor?: string;
+    /**
+     * Exact phrase to match.
+     */
+    exactPhrase?: string;
+    /**
+     * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+     */
+    excludeWords?: string;
+    /**
+     * Filter by author username.
+     */
+    fromUser?: string;
+    /**
+     * Hashtags separated by spaces, commas, or lines.
+     */
+    hashtags?: string;
+    /**
+     * Include parent tweet for replies
+     */
+    includeParentTweet?: boolean;
+    /**
+     * Only replies to this tweet ID.
+     */
+    inReplyToTweetId?: string;
+    /**
+     * Language code filter, e.g. en or tr.
+     */
+    language?: string;
+    /**
+     * Filter by media type.
+     */
+    mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+    /**
+     * Filter tweets mentioning a username.
+     */
+    mentioning?: string;
+    /**
+     * Minimum likes threshold.
+     */
+    minFaves?: number;
+    /**
+     * Minimum quote count threshold.
+     */
+    minQuotes?: number;
+    /**
+     * Minimum replies threshold.
+     */
+    minReplies?: number;
+    /**
+     * Minimum retweets threshold.
+     */
+    minRetweets?: number;
+    /**
+     * Maximum items requested from this page (1-100, default 20). The response can
+     * contain fewer items because the source returned fewer, filters removed items, or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true, even when a page is empty. The deprecated limit and count
+     * aliases remain accepted.
+     */
+    pageSize?: number;
+    /**
+     * Quote mode.
+     */
+    quotes?: 'include' | 'exclude' | 'only';
+    /**
+     * Only quotes of this tweet ID.
+     */
+    quotesOfTweetId?: string;
+    /**
+     * Reply mode.
+     */
+    replies?: 'include' | 'exclude' | 'only';
+    /**
+     * Retweet mode.
+     */
+    retweets?: 'include' | 'exclude' | 'only';
+    /**
+     * Only retweets of this tweet ID.
+     */
+    retweetsOfTweetId?: string;
+    /**
+     * Start date in YYYY-MM-DD format.
+     */
+    sinceDate?: string;
+    /**
+     * Filter replies sent to a username.
+     */
+    toUser?: string;
+    /**
+     * End date in YYYY-MM-DD format.
+     */
+    untilDate?: string;
+    /**
+     * URL substring or domain filter.
+     */
+    url?: string;
+    /**
+     * Only return tweets from verified authors.
+     */
+    verifiedOnly?: boolean;
 }
 export interface UserRetrieveSearchParams {
     /**
@@ -193,10 +734,39 @@ export interface UserRetrieveSearchParams {
     cursor?: string;
 }
 export interface UserRetrieveTweetsParams {
+    /**
+     * Words or quoted phrases where any one can match. Separate with spaces, commas,
+     * or lines.
+     */
+    anyWords?: string;
+    /**
+     * Cashtags separated by spaces, commas, or lines.
+     */
+    cashtags?: string;
+    /**
+     * Conversation ID filter.
+     */
+    conversationId?: string;
     /**
      * Pagination cursor for user tweets
      */
     cursor?: string;
+    /**
+     * Exact phrase to match.
+     */
+    exactPhrase?: string;
+    /**
+     * Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
+     */
+    excludeWords?: string;
+    /**
+     * Filter by author username.
+     */
+    fromUser?: string;
+    /**
+     * Hashtags separated by spaces, commas, or lines.
+     */
+    hashtags?: string;
     /**
      * Include parent tweet for replies
      */
@@ -205,15 +775,102 @@ export interface UserRetrieveTweetsParams {
      * Include reply tweets
      */
     includeReplies?: boolean;
+    /**
+     * Only replies to this tweet ID.
+     */
+    inReplyToTweetId?: string;
+    /**
+     * Language code filter, e.g. en or tr.
+     */
+    language?: string;
+    /**
+     * Filter by media type.
+     */
+    mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
+    /**
+     * Filter tweets mentioning a username.
+     */
+    mentioning?: string;
+    /**
+     * Minimum likes threshold.
+     */
+    minFaves?: number;
+    /**
+     * Minimum quote count threshold.
+     */
+    minQuotes?: number;
+    /**
+     * Minimum replies threshold.
+     */
+    minReplies?: number;
+    /**
+     * Minimum retweets threshold.
+     */
+    minRetweets?: number;
+    /**
+     * Maximum items requested from this page (1-100, default 20). The response can
+     * contain fewer items because the source returned fewer, filters removed items, or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true, even when a page is empty. The deprecated limit and count
+     * aliases remain accepted.
+     */
+    pageSize?: number;
+    /**
+     * Quote mode.
+     */
+    quotes?: 'include' | 'exclude' | 'only';
+    /**
+     * Only quotes of this tweet ID.
+     */
+    quotesOfTweetId?: string;
+    /**
+     * Reply mode.
+     */
+    replies?: 'include' | 'exclude' | 'only';
+    /**
+     * Retweet mode.
+     */
+    retweets?: 'include' | 'exclude' | 'only';
+    /**
+     * Only retweets of this tweet ID.
+     */
+    retweetsOfTweetId?: string;
+    /**
+     * Start date in YYYY-MM-DD format.
+     */
+    sinceDate?: string;
+    /**
+     * Filter replies sent to a username.
+     */
+    toUser?: string;
+    /**
+     * End date in YYYY-MM-DD format.
+     */
+    untilDate?: string;
+    /**
+     * URL substring or domain filter.
+     */
+    url?: string;
+    /**
+     * Only return tweets from verified authors.
+     */
+    verifiedOnly?: boolean;
 }
 export interface UserRetrieveVerifiedFollowersParams {
     /**
      * Pagination cursor for verified followers
      */
     cursor?: string;
+    /**
+     * Maximum user profiles requested from this page (20-200, default 200). The
+     * response can contain fewer profiles because the source returned fewer or
+     * the available usage balance covers fewer results. Keep requesting next_cursor while
+     * has_next_page is true. The deprecated limit and count aliases remain accepted.
+     */
+    pageSize?: number;
 }
 export declare namespace Users {
-    export { type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, };
+    export { type UserRemoveFollowerResponse as UserRemoveFollowerResponse, type UserRetrieveBatchResponse as UserRetrieveBatchResponse, type UserRemoveFollowerParams as UserRemoveFollowerParams, type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveRepliesParams as UserRetrieveRepliesParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, };
     export { Follow as Follow, type FollowCreateResponse as FollowCreateResponse, type FollowDeleteAllResponse as FollowDeleteAllResponse, type FollowCreateParams as FollowCreateParams, type FollowDeleteAllParams as FollowDeleteAllParams, };
 }
 //# sourceMappingURL=users.d.ts.map