x-twitter-scraper 0.3.2 → 0.4.0

package/src/resources/x/dm.ts

@@ -13,12 +13,13 @@ export class Dm extends APIResource {
    * ```ts
    * const response = await client.x.dm.retrieveHistory(
    *   'userId',
+   *   { account: 'account' },
    * );
    * ```
    */
   retrieveHistory(
     userID: string,
-    query: DmRetrieveHistoryParams | null | undefined = {},
+    query: DmRetrieveHistoryParams,
     options?: RequestOptions,
   ): APIPromise<DmRetrieveHistoryResponse> {
     return this._client.get(path`/x/dm/${userID}/history`, { query, ...options });
@@ -33,7 +34,6 @@ export class Dm extends APIResource {
    *   account: '@elonmusk',
    *   text: 'Example text content',
    *   media_ids: ['1234567890123456789'],
-   *   reply_to_message_id: '1234567890123456789',
    * });
    * ```
    */
@@ -54,11 +54,17 @@ export namespace DmRetrieveHistoryResponse {
   export interface Message {
     id: string;
 
-    createdAt?: string;
+    receiverId: string;
+
+    senderId: string;
 
-    receiverId?: string;
+    createdAt?: string;
 
-    senderId?: string;
+    /**
+     * URL of attached media (image, GIF, or video). Omitted when the message has no
+     * media attachment.
+     */
+    mediaUrl?: string;
 
     text?: string;
   }
@@ -71,6 +77,12 @@ export interface DmSendResponse {
 }
 
 export interface DmRetrieveHistoryParams {
+  /**
+   * X handle (without the `@` prefix) of the connected X account used to read the
+   * conversation. The account must be a participant in the conversation.
+   */
+  account: string;
+
   /**
    * Pagination cursor for DM history
    */
@@ -90,9 +102,10 @@ export interface DmSendParams {
 
   text: string;
 
+  /**
+   * Optional array containing exactly 1 uploaded media ID.
+   */
   media_ids?: Array<string>;
-
-  reply_to_message_id?: string;
 }
 
 export declare namespace Dm {

package/src/resources/x/followers.ts

@@ -36,12 +36,12 @@ export interface FollowerCheckResponse {
 
 export interface FollowerCheckParams {
   /**
-   * Username to check (without @)
+   * Source username, @username, or X or Twitter profile URL
    */
   source: string;
 
   /**
-   * Target username (without @)
+   * Target username, @username, or X or Twitter profile URL
    */
   target: string;
 }

package/src/resources/x/index.ts

@@ -1,5 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  AccountConnectionChallenges,
+  type AccountConnectionChallengeSubmitResponse,
+  type AccountConnectionChallengeSubmitParams,
+} from './account-connection-challenges';
 export {
   Accounts,
   type XAccount,
@@ -15,7 +20,6 @@ export {
 export { Bookmarks, type BookmarkRetrieveFoldersResponse, type BookmarkListParams } from './bookmarks';
 export {
   Communities,
-  type CommunityActionResult,
   type CommunityCreateResponse,
   type CommunityDeleteResponse,
   type CommunityRetrieveInfoResponse,
@@ -74,6 +78,9 @@ export {
 } from './tweets/index';
 export {
   Users,
+  type UserRemoveFollowerResponse,
+  type UserRetrieveBatchResponse,
+  type UserRemoveFollowerParams,
   type UserRetrieveBatchParams,
   type UserRetrieveFollowersParams,
   type UserRetrieveFollowersYouKnowParams,
@@ -81,10 +88,12 @@ export {
   type UserRetrieveLikesParams,
   type UserRetrieveMediaParams,
   type UserRetrieveMentionsParams,
+  type UserRetrieveRepliesParams,
   type UserRetrieveSearchParams,
   type UserRetrieveTweetsParams,
   type UserRetrieveVerifiedFollowersParams,
 } from './users/index';
+export { WriteActions, type WriteActionRetrieveResponse } from './write-actions';
 export {
   X,
   type XGetArticleResponse,

package/src/resources/x/lists.ts

@@ -69,6 +69,14 @@ export interface ListRetrieveFollowersParams {
    * Pagination cursor for list 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 interface ListRetrieveMembersParams {
@@ -76,6 +84,11 @@ export interface ListRetrieveMembersParams {
    * Pagination cursor for list members
    */
   cursor?: string;
+
+  /**
+   * Members per page (20-200, default 20)
+   */
+  pageSize?: number;
 }
 
 export interface ListRetrieveTweetsParams {
@@ -89,6 +102,15 @@ export interface ListRetrieveTweetsParams {
    */
   includeReplies?: boolean;
 
+  /**
+   * 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;
+
   /**
    * Unix timestamp - filter after
    */

package/src/resources/x/media.ts

@@ -2,9 +2,8 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
-import { type Uploadable } from '../../core/uploads';
 import { RequestOptions } from '../../internal/request-options';
-import { multipartFormRequestOptions } from '../../internal/uploads';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 
 /**
  * Media upload and download
@@ -31,13 +30,15 @@ export class Media extends APIResource {
    * ```ts
    * const response = await client.x.media.upload({
    *   account: '@elonmusk',
-   *   file: fs.createReadStream('path/to/file'),
-   *   is_long_video: true,
+   *   url: 'https://example.com/image.png',
    * });
    * ```
    */
   upload(body: MediaUploadParams, options?: RequestOptions): APIPromise<MediaUploadResponse> {
-    return this._client.post('/x/media', multipartFormRequestOptions({ body, ...options }, this._client));
+    return this._client.post(
+      '/x/media',
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+    );
   }
 }
 
@@ -56,12 +57,22 @@ export interface MediaDownloadResponse {
 export interface MediaUploadResponse {
   mediaId: string;
 
+  /**
+   * Public media URL for tweet `media` arrays.
+   */
+  mediaUrl: string;
+
   success: true;
 }
 
 export interface MediaDownloadParams {
   /**
-   * Array of tweet URLs or IDs (bulk, max 50)
+   * Numeric tweet ID alias for tweetInput
+   */
+  tweetId?: string;
+
+  /**
+   * Array of tweet URLs or IDs (bulk, max 50 string items)
    */
   tweetIds?: Array<string>;
 
@@ -69,20 +80,23 @@ export interface MediaDownloadParams {
    * Tweet URL or ID (single tweet)
    */
   tweetInput?: string;
+
+  /**
+   * Tweet URL alias for tweetInput
+   */
+  tweetUrl?: string;
 }
 
 export interface MediaUploadParams {
   /**
-   * X account (@username or ID) uploading media
+   * X account (@username or ID) uploading media from URL
    */
   account: string;
 
   /**
-   * Media file to upload
+   * HTTPS URL to download and upload as media
    */
-  file: Uploadable;
-
-  is_long_video?: boolean;
+  url: string;
 }
 
 export declare namespace Media {

package/src/resources/x/profile.ts

@@ -2,9 +2,8 @@
 
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
-import { type Uploadable } from '../../core/uploads';
 import { RequestOptions } from '../../internal/request-options';
-import { multipartFormRequestOptions } from '../../internal/uploads';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 
 /**
  * X write actions (tweets, likes, follows, DMs)
@@ -35,7 +34,7 @@ export class Profile extends APIResource {
    * ```ts
    * const response = await client.x.profile.updateAvatar({
    *   account: '@elonmusk',
-   *   file: fs.createReadStream('path/to/file'),
+   *   url: 'https://example.com/avatar.png',
    * });
    * ```
    */
@@ -45,7 +44,7 @@ export class Profile extends APIResource {
   ): APIPromise<ProfileUpdateAvatarResponse> {
     return this._client.patch(
       '/x/profile/avatar',
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
     );
   }
 
@@ -56,7 +55,7 @@ export class Profile extends APIResource {
    * ```ts
    * const response = await client.x.profile.updateBanner({
    *   account: '@elonmusk',
-   *   file: fs.createReadStream('path/to/file'),
+   *   url: 'https://example.com/banner.png',
    * });
    * ```
    */
@@ -66,7 +65,7 @@ export class Profile extends APIResource {
   ): APIPromise<ProfileUpdateBannerResponse> {
     return this._client.patch(
       '/x/profile/banner',
-      multipartFormRequestOptions({ body, ...options }, this._client),
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
     );
   }
 }
@@ -109,26 +108,26 @@ export interface ProfileUpdateParams {
 
 export interface ProfileUpdateAvatarParams {
   /**
-   * X account (@username or ID) for avatar update
+   * X account (@username or ID) receiving avatar from URL
    */
   account: string;
 
   /**
-   * Avatar image (max 716KB)
+   * HTTPS URL to the avatar image to download
    */
-  file: Uploadable;
+  url: string;
 }
 
 export interface ProfileUpdateBannerParams {
   /**
-   * X account (@username or ID) for banner update
+   * X account (@username or ID) receiving banner from URL
    */
   account: string;
 
   /**
-   * Banner image (max 2MB)
+   * HTTPS URL to the banner image to download
    */
-  file: Uploadable;
+  url: string;
 }
 
 export declare namespace Profile {