x-twitter-scraper 0.2.1 → 0.3.1

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

@@ -36,7 +36,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Look up tweet
+   * Get tweet with full text, author, metrics and media
    *
    * @example
    * ```ts
@@ -76,7 +76,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Get users who liked a tweet
+   * List users who liked a tweet
    *
    * @example
    * ```ts
@@ -94,7 +94,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Get quote tweets of a tweet
+   * List quote tweets of a tweet
    *
    * @example
    * ```ts
@@ -112,7 +112,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Get replies to a tweet
+   * List replies to a tweet
    *
    * @example
    * ```ts
@@ -130,7 +130,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Get users who retweeted a tweet
+   * List users who retweeted a tweet
    *
    * @example
    * ```ts
@@ -148,7 +148,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Get thread context for a tweet
+   * Get full conversation thread for a tweet
    *
    * @example
    * ```ts
@@ -166,7 +166,7 @@ export class Tweets extends APIResource {
   }
 
   /**
-   * Search tweets
+   * Search tweets with X query operators and pagination
    *
    * @example
    * ```ts
@@ -180,48 +180,6 @@ export class Tweets extends APIResource {
   }
 }
 
-/**
- * Tweet returned from search results with inline author info.
- */
-export interface SearchTweet {
-  id: string;
-
-  text: string;
-
-  author?: SearchTweet.Author;
-
-  bookmarkCount?: number;
-
-  createdAt?: string;
-
-  /**
-   * True for Note Tweets (long-form content, up to 25,000 characters)
-   */
-  isNoteTweet?: boolean;
-
-  likeCount?: number;
-
-  quoteCount?: number;
-
-  replyCount?: number;
-
-  retweetCount?: number;
-
-  viewCount?: number;
-}
-
-export namespace SearchTweet {
-  export interface Author {
-    id: string;
-
-    name: string;
-
-    username: string;
-
-    verified?: boolean;
-  }
-}
-
 /**
  * Author of a tweet with follower count and verification status.
  */
@@ -338,17 +296,28 @@ export interface TweetCreateParams {
    */
   account: string;
 
-  text: string;
-
   attachment_url?: string;
 
   community_id?: string;
 
   is_note_tweet?: boolean;
 
+  /**
+   * Array of media URLs to attach (mutually exclusive with media_ids)
+   */
+  media?: Array<string>;
+
+  /**
+   * Array of media IDs to attach (mutually exclusive with media)
+   */
   media_ids?: Array<string>;
 
   reply_to_tweet_id?: string;
+
+  /**
+   * Tweet text (optional when media is provided)
+   */
+  text?: string;
 }
 
 export interface TweetListParams {
@@ -462,7 +431,6 @@ Tweets.Retweet = Retweet;
 
 export declare namespace Tweets {
   export {
-    type SearchTweet as SearchTweet,
     type TweetAuthor as TweetAuthor,
     type TweetDetail as TweetDetail,
     type TweetCreateResponse as TweetCreateResponse,

package/src/resources/x/users/index.ts

@@ -9,7 +9,6 @@ export {
 } from './follow';
 export {
   Users,
-  type UserProfile,
   type UserRetrieveBatchParams,
   type UserRetrieveFollowersParams,
   type UserRetrieveFollowersYouKnowParams,

package/src/resources/x/users/users.ts

@@ -15,25 +15,25 @@ import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
 /**
- * X data lookups (subscription required)
+ * Look up, search, and explore user profiles and relationships
  */
 export class Users extends APIResource {
   follow: FollowAPI.Follow = new FollowAPI.Follow(this._client);
 
   /**
-   * Look up X user
+   * Get user profile with follower counts and verification
    *
    * @example
    * ```ts
    * const userProfile = await client.x.users.retrieve('id');
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<UserProfile> {
+  retrieve(id: string, options?: RequestOptions): APIPromise<Shared.UserProfile> {
     return this._client.get(path`/x/users/${id}`, options);
   }
 
   /**
-   * Get multiple users by IDs
+   * Look up multiple users by IDs in one call
    *
    * @example
    * ```ts
@@ -47,7 +47,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get user followers
+   * List followers of a user
    *
    * @example
    * ```ts
@@ -64,7 +64,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get followers you know for a user
+   * List mutual followers between you and a user
    *
    * @example
    * ```ts
@@ -81,7 +81,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get users this user follows
+   * List accounts a user follows
    *
    * @example
    * ```ts
@@ -98,7 +98,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get tweets liked by a user
+   * List tweets liked by a user
    *
    * @example
    * ```ts
@@ -116,7 +116,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get media tweets by a user
+   * List media tweets posted by a user
    *
    * @example
    * ```ts
@@ -134,7 +134,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get tweets mentioning a user
+   * List tweets mentioning a user
    *
    * @example
    * ```ts
@@ -168,7 +168,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get recent tweets by a user
+   * List recent tweets posted by a user
    *
    * @example
    * ```ts
@@ -186,7 +186,7 @@ export class Users extends APIResource {
   }
 
   /**
-   * Get verified followers
+   * List verified followers of a user
    *
    * @example
    * ```ts
@@ -203,33 +203,6 @@ export class Users extends APIResource {
   }
 }
 
-/**
- * X user profile with bio, follower counts, and verification status.
- */
-export interface UserProfile {
-  id: string;
-
-  name: string;
-
-  username: string;
-
-  createdAt?: string;
-
-  description?: string;
-
-  followers?: number;
-
-  following?: number;
-
-  location?: string;
-
-  profilePicture?: string;
-
-  statusesCount?: number;
-
-  verified?: boolean;
-}
-
 export interface UserRetrieveBatchParams {
   /**
    * Comma-separated user IDs (max 100)
@@ -339,7 +312,6 @@ Users.Follow = Follow;
 
 export declare namespace Users {
   export {
-    type UserProfile as UserProfile,
     type UserRetrieveBatchParams as UserRetrieveBatchParams,
     type UserRetrieveFollowersParams as UserRetrieveFollowersParams,
     type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams,

package/src/resources/x/x.ts

@@ -61,7 +61,6 @@ import {
 } from './communities/communities';
 import * as TweetsAPI from './tweets/tweets';
 import {
-  SearchTweet,
   TweetAuthor,
   TweetCreateParams,
   TweetCreateResponse,
@@ -80,7 +79,6 @@ import {
 } from './tweets/tweets';
 import * as UsersAPI from './users/users';
 import {
-  UserProfile,
   UserRetrieveBatchParams,
   UserRetrieveFollowersParams,
   UserRetrieveFollowersYouKnowParams,
@@ -97,9 +95,6 @@ import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
-/**
- * X data lookups (subscription required)
- */
 export class X extends APIResource {
   tweets: TweetsAPI.Tweets = new TweetsAPI.Tweets(this._client);
   users: UsersAPI.Users = new UsersAPI.Users(this._client);
@@ -155,15 +150,18 @@ export class X extends APIResource {
   }
 
   /**
-   * Get trending topics
+   * Get trending hashtags and topics from X by region
    *
    * @example
    * ```ts
    * const response = await client.x.getTrends();
    * ```
    */
-  getTrends(options?: RequestOptions): APIPromise<XGetTrendsResponse> {
-    return this._client.get('/x/trends', options);
+  getTrends(
+    query: XGetTrendsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<XGetTrendsResponse> {
+    return this._client.get('/x/trends', { query, ...options });
   }
 }
 
@@ -283,6 +281,18 @@ export interface XGetNotificationsParams {
   type?: 'All' | 'Verified' | 'Mentions';
 }
 
+export interface XGetTrendsParams {
+  /**
+   * Number of trending topics to return (1-50, default 30)
+   */
+  count?: number;
+
+  /**
+   * Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+   */
+  woeid?: number;
+}
+
 X.Tweets = Tweets;
 X.Users = Users;
 X.Followers = Followers;
@@ -301,11 +311,11 @@ export declare namespace X {
     type XGetTrendsResponse as XGetTrendsResponse,
     type XGetHomeTimelineParams as XGetHomeTimelineParams,
     type XGetNotificationsParams as XGetNotificationsParams,
+    type XGetTrendsParams as XGetTrendsParams,
   };
 
   export {
     Tweets as Tweets,
-    type SearchTweet as SearchTweet,
     type TweetAuthor as TweetAuthor,
     type TweetDetail as TweetDetail,
     type TweetCreateResponse as TweetCreateResponse,
@@ -324,7 +334,6 @@ export declare namespace X {
 
   export {
     Users as Users,
-    type UserProfile as UserProfile,
     type UserRetrieveBatchParams as UserRetrieveBatchParams,
     type UserRetrieveFollowersParams as UserRetrieveFollowersParams,
     type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.1'; // x-release-please-version
+export const VERSION = '0.3.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.3.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.1";
+export declare const VERSION = "0.3.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.1'; // x-release-please-version
+exports.VERSION = '0.3.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.1'; // x-release-please-version
+export const VERSION = '0.3.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map