x-twitter-scraper 0.1.0

package/src/resources/x/dm.ts

@@ -0,0 +1,88 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Dm extends APIResource {
+  /**
+   * Get DM conversation history
+   */
+  retrieveHistory(
+    userID: string,
+    query: DmRetrieveHistoryParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DmRetrieveHistoryResponse> {
+    return this._client.get(path`/x/dm/${userID}/history`, { query, ...options });
+  }
+
+  /**
+   * Send direct message
+   */
+  send(userID: string, body: DmSendParams, options?: RequestOptions): APIPromise<DmSendResponse> {
+    return this._client.post(path`/x/dm/${userID}`, { body, ...options });
+  }
+}
+
+export interface DmRetrieveHistoryResponse {
+  has_next_page: boolean;
+
+  messages: Array<DmRetrieveHistoryResponse.Message>;
+
+  next_cursor: string;
+}
+
+export namespace DmRetrieveHistoryResponse {
+  export interface Message {
+    id: string;
+
+    createdAt?: string;
+
+    receiverId?: string;
+
+    senderId?: string;
+
+    text?: string;
+  }
+}
+
+export interface DmSendResponse {
+  messageId: string;
+
+  success: true;
+}
+
+export interface DmRetrieveHistoryParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Legacy pagination cursor (backward compat)
+   */
+  maxId?: string;
+}
+
+export interface DmSendParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  text: string;
+
+  media_ids?: Array<string>;
+
+  reply_to_message_id?: string;
+}
+
+export declare namespace Dm {
+  export {
+    type DmRetrieveHistoryResponse as DmRetrieveHistoryResponse,
+    type DmSendResponse as DmSendResponse,
+    type DmRetrieveHistoryParams as DmRetrieveHistoryParams,
+    type DmSendParams as DmSendParams,
+  };
+}

package/src/resources/x/followers.ts

@@ -0,0 +1,46 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * X data lookups (subscription required)
+ */
+export class Followers extends APIResource {
+  /**
+   * Check follow relationship
+   */
+  check(query: FollowerCheckParams, options?: RequestOptions): APIPromise<FollowerCheckResponse> {
+    return this._client.get('/x/followers/check', { query, ...options });
+  }
+}
+
+export interface FollowerCheckResponse {
+  isFollowedBy: boolean;
+
+  isFollowing: boolean;
+
+  sourceUsername: string;
+
+  targetUsername: string;
+}
+
+export interface FollowerCheckParams {
+  /**
+   * Username to check (without @)
+   */
+  source: string;
+
+  /**
+   * Target username (without @)
+   */
+  target: string;
+}
+
+export declare namespace Followers {
+  export {
+    type FollowerCheckResponse as FollowerCheckResponse,
+    type FollowerCheckParams as FollowerCheckParams,
+  };
+}

package/src/resources/x/index.ts

@@ -0,0 +1,95 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Accounts,
+  type XAccount,
+  type XAccountDetail,
+  type AccountCreateResponse,
+  type AccountListResponse,
+  type AccountDeleteResponse,
+  type AccountReauthResponse,
+  type AccountCreateParams,
+  type AccountReauthParams,
+} from './accounts';
+export { Bookmarks, type BookmarkRetrieveFoldersResponse, type BookmarkListParams } from './bookmarks';
+export {
+  Communities,
+  type CommunityActionResult,
+  type CommunityCreateResponse,
+  type CommunityDeleteResponse,
+  type CommunityRetrieveInfoResponse,
+  type CommunityCreateParams,
+  type CommunityDeleteParams,
+  type CommunityRetrieveMembersParams,
+  type CommunityRetrieveModeratorsParams,
+  type CommunityRetrieveSearchParams,
+} from './communities/index';
+export {
+  Dm,
+  type DmRetrieveHistoryResponse,
+  type DmSendResponse,
+  type DmRetrieveHistoryParams,
+  type DmSendParams,
+} from './dm';
+export { Followers, type FollowerCheckResponse, type FollowerCheckParams } from './followers';
+export {
+  Lists,
+  type ListRetrieveFollowersParams,
+  type ListRetrieveMembersParams,
+  type ListRetrieveTweetsParams,
+} from './lists';
+export {
+  Media,
+  type MediaDownloadResponse,
+  type MediaUploadResponse,
+  type MediaDownloadParams,
+  type MediaUploadParams,
+} from './media';
+export {
+  Profile,
+  type ProfileUpdateResponse,
+  type ProfileUpdateAvatarResponse,
+  type ProfileUpdateBannerResponse,
+  type ProfileUpdateParams,
+  type ProfileUpdateAvatarParams,
+  type ProfileUpdateBannerParams,
+} from './profile';
+export {
+  Tweets,
+  type SearchTweet,
+  type TweetAuthor,
+  type TweetDetail,
+  type TweetCreateResponse,
+  type TweetRetrieveResponse,
+  type TweetDeleteResponse,
+  type TweetCreateParams,
+  type TweetListParams,
+  type TweetDeleteParams,
+  type TweetGetFavoritersParams,
+  type TweetGetQuotesParams,
+  type TweetGetRepliesParams,
+  type TweetGetRetweetersParams,
+  type TweetGetThreadParams,
+  type TweetSearchParams,
+} from './tweets/index';
+export {
+  Users,
+  type UserProfile,
+  type UserRetrieveBatchParams,
+  type UserRetrieveFollowersParams,
+  type UserRetrieveFollowersYouKnowParams,
+  type UserRetrieveFollowingParams,
+  type UserRetrieveLikesParams,
+  type UserRetrieveMediaParams,
+  type UserRetrieveMentionsParams,
+  type UserRetrieveSearchParams,
+  type UserRetrieveTweetsParams,
+  type UserRetrieveVerifiedFollowersParams,
+} from './users/index';
+export {
+  X,
+  type XGetArticleResponse,
+  type XGetNotificationsResponse,
+  type XGetHomeTimelineParams,
+  type XGetNotificationsParams,
+} from './x';

package/src/resources/x/lists.ts

@@ -0,0 +1,101 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * X data lookups (subscription required)
+ */
+export class Lists extends APIResource {
+  /**
+   * Get list followers
+   */
+  retrieveFollowers(
+    id: string,
+    query: ListRetrieveFollowersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/lists/${id}/followers`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get list members
+   */
+  retrieveMembers(
+    id: string,
+    query: ListRetrieveMembersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/lists/${id}/members`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get list tweets
+   */
+  retrieveTweets(
+    id: string,
+    query: ListRetrieveTweetsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/lists/${id}/tweets`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface ListRetrieveFollowersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface ListRetrieveMembersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface ListRetrieveTweetsParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Include replies (default false)
+   */
+  includeReplies?: boolean;
+
+  /**
+   * Unix timestamp - filter after
+   */
+  sinceTime?: string;
+
+  /**
+   * Unix timestamp - filter before
+   */
+  untilTime?: string;
+}
+
+export declare namespace Lists {
+  export {
+    type ListRetrieveFollowersParams as ListRetrieveFollowersParams,
+    type ListRetrieveMembersParams as ListRetrieveMembersParams,
+    type ListRetrieveTweetsParams as ListRetrieveTweetsParams,
+  };
+}

package/src/resources/x/media.ts

@@ -0,0 +1,79 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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';
+
+/**
+ * Media upload & download
+ */
+export class Media extends APIResource {
+  /**
+   * Download tweet media
+   */
+  download(body: MediaDownloadParams, options?: RequestOptions): APIPromise<MediaDownloadResponse> {
+    return this._client.post('/x/media/download', { body, ...options });
+  }
+
+  /**
+   * Upload media
+   */
+  upload(body: MediaUploadParams, options?: RequestOptions): APIPromise<MediaUploadResponse> {
+    return this._client.post('/x/media', multipartFormRequestOptions({ body, ...options }, this._client));
+  }
+}
+
+export interface MediaDownloadResponse {
+  cacheHit?: boolean;
+
+  galleryUrl?: string;
+
+  totalMedia?: number;
+
+  totalTweets?: number;
+
+  tweetId?: string;
+}
+
+export interface MediaUploadResponse {
+  mediaId: string;
+
+  success: true;
+}
+
+export interface MediaDownloadParams {
+  /**
+   * Array of tweet URLs or IDs (bulk, max 50)
+   */
+  tweetIds?: Array<string>;
+
+  /**
+   * Tweet URL or ID (single tweet)
+   */
+  tweetInput?: string;
+}
+
+export interface MediaUploadParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Media file to upload
+   */
+  file: Uploadable;
+
+  is_long_video?: boolean;
+}
+
+export declare namespace Media {
+  export {
+    type MediaDownloadResponse as MediaDownloadResponse,
+    type MediaUploadResponse as MediaUploadResponse,
+    type MediaDownloadParams as MediaDownloadParams,
+    type MediaUploadParams as MediaUploadParams,
+  };
+}

package/src/resources/x/profile.ts

@@ -0,0 +1,116 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+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';
+
+/**
+ * X write actions (tweets, likes, follows, DMs)
+ */
+export class Profile extends APIResource {
+  /**
+   * Update X profile
+   */
+  update(body: ProfileUpdateParams, options?: RequestOptions): APIPromise<ProfileUpdateResponse> {
+    return this._client.patch('/x/profile', { body, ...options });
+  }
+
+  /**
+   * Update profile avatar
+   */
+  updateAvatar(
+    body: ProfileUpdateAvatarParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileUpdateAvatarResponse> {
+    return this._client.patch(
+      '/x/profile/avatar',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+
+  /**
+   * Update profile banner
+   */
+  updateBanner(
+    body: ProfileUpdateBannerParams,
+    options?: RequestOptions,
+  ): APIPromise<ProfileUpdateBannerResponse> {
+    return this._client.patch(
+      '/x/profile/banner',
+      multipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+export interface ProfileUpdateResponse {
+  success: true;
+}
+
+export interface ProfileUpdateAvatarResponse {
+  success: true;
+}
+
+export interface ProfileUpdateBannerResponse {
+  success: true;
+}
+
+export interface ProfileUpdateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Bio description
+   */
+  description?: string;
+
+  location?: string;
+
+  /**
+   * Display name
+   */
+  name?: string;
+
+  /**
+   * Website URL
+   */
+  url?: string;
+}
+
+export interface ProfileUpdateAvatarParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Avatar image (max 716KB)
+   */
+  file: Uploadable;
+}
+
+export interface ProfileUpdateBannerParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Banner image (max 2MB)
+   */
+  file: Uploadable;
+}
+
+export declare namespace Profile {
+  export {
+    type ProfileUpdateResponse as ProfileUpdateResponse,
+    type ProfileUpdateAvatarResponse as ProfileUpdateAvatarResponse,
+    type ProfileUpdateBannerResponse as ProfileUpdateBannerResponse,
+    type ProfileUpdateParams as ProfileUpdateParams,
+    type ProfileUpdateAvatarParams as ProfileUpdateAvatarParams,
+    type ProfileUpdateBannerParams as ProfileUpdateBannerParams,
+  };
+}

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

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Like,
+  type LikeCreateResponse,
+  type LikeDeleteResponse,
+  type LikeCreateParams,
+  type LikeDeleteParams,
+} from './like';
+export {
+  Retweet,
+  type RetweetCreateResponse,
+  type RetweetDeleteResponse,
+  type RetweetCreateParams,
+  type RetweetDeleteParams,
+} from './retweet';
+export {
+  Tweets,
+  type SearchTweet,
+  type TweetAuthor,
+  type TweetDetail,
+  type TweetCreateResponse,
+  type TweetRetrieveResponse,
+  type TweetDeleteResponse,
+  type TweetCreateParams,
+  type TweetListParams,
+  type TweetDeleteParams,
+  type TweetGetFavoritersParams,
+  type TweetGetQuotesParams,
+  type TweetGetRepliesParams,
+  type TweetGetRetweetersParams,
+  type TweetGetThreadParams,
+  type TweetSearchParams,
+} from './tweets';

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

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * X write actions (tweets, likes, follows, DMs)
+ */
+export class Like extends APIResource {
+  /**
+   * Like tweet
+   */
+  create(tweetID: string, body: LikeCreateParams, options?: RequestOptions): APIPromise<LikeCreateResponse> {
+    return this._client.post(path`/x/tweets/${tweetID}/like`, { body, ...options });
+  }
+
+  /**
+   * Unlike tweet
+   */
+  delete(tweetID: string, body: LikeDeleteParams, options?: RequestOptions): APIPromise<LikeDeleteResponse> {
+    return this._client.delete(path`/x/tweets/${tweetID}/like`, { body, ...options });
+  }
+}
+
+export interface LikeCreateResponse {
+  success: true;
+}
+
+export interface LikeDeleteResponse {
+  success: true;
+}
+
+export interface LikeCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export interface LikeDeleteParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export declare namespace Like {
+  export {
+    type LikeCreateResponse as LikeCreateResponse,
+    type LikeDeleteResponse as LikeDeleteResponse,
+    type LikeCreateParams as LikeCreateParams,
+    type LikeDeleteParams as LikeDeleteParams,
+  };
+}

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

@@ -0,0 +1,64 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+/**
+ * X write actions (tweets, likes, follows, DMs)
+ */
+export class Retweet extends APIResource {
+  /**
+   * Retweet
+   */
+  create(
+    tweetID: string,
+    body: RetweetCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RetweetCreateResponse> {
+    return this._client.post(path`/x/tweets/${tweetID}/retweet`, { body, ...options });
+  }
+
+  /**
+   * Unretweet
+   */
+  delete(
+    tweetID: string,
+    body: RetweetDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<RetweetDeleteResponse> {
+    return this._client.delete(path`/x/tweets/${tweetID}/retweet`, { body, ...options });
+  }
+}
+
+export interface RetweetCreateResponse {
+  success: true;
+}
+
+export interface RetweetDeleteResponse {
+  success: true;
+}
+
+export interface RetweetCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export interface RetweetDeleteParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export declare namespace Retweet {
+  export {
+    type RetweetCreateResponse as RetweetCreateResponse,
+    type RetweetDeleteResponse as RetweetDeleteResponse,
+    type RetweetCreateParams as RetweetCreateParams,
+    type RetweetDeleteParams as RetweetDeleteParams,
+  };
+}