x-twitter-scraper 0.1.0

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

@@ -0,0 +1,311 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as Shared from '../../shared';
+import * as FollowAPI from './follow';
+import {
+  Follow,
+  FollowCreateParams,
+  FollowCreateResponse,
+  FollowDeleteAllParams,
+  FollowDeleteAllResponse,
+} from './follow';
+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 Users extends APIResource {
+  follow: FollowAPI.Follow = new FollowAPI.Follow(this._client);
+
+  /**
+   * Look up X user
+   */
+  retrieve(username: string, options?: RequestOptions): APIPromise<UserProfile> {
+    return this._client.get(path`/x/users/${username}`, options);
+  }
+
+  /**
+   * Get multiple users by IDs
+   */
+  retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/users/batch', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get user followers
+   */
+  retrieveFollowers(
+    id: string,
+    query: UserRetrieveFollowersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/users/${id}/followers`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get followers you know for a user
+   */
+  retrieveFollowersYouKnow(
+    id: string,
+    query: UserRetrieveFollowersYouKnowParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedUsers> {
+    return this._client.get(path`/x/users/${id}/followers-you-know`, { query, ...options });
+  }
+
+  /**
+   * Get users this user follows
+   */
+  retrieveFollowing(
+    id: string,
+    query: UserRetrieveFollowingParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/users/${id}/following`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get tweets liked by a user
+   */
+  retrieveLikes(
+    id: string,
+    query: UserRetrieveLikesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/users/${id}/likes`, { query, ...options });
+  }
+
+  /**
+   * Get media tweets by a user
+   */
+  retrieveMedia(
+    id: string,
+    query: UserRetrieveMediaParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/users/${id}/media`, { query, ...options });
+  }
+
+  /**
+   * Get tweets mentioning a user
+   */
+  retrieveMentions(
+    id: string,
+    query: UserRetrieveMentionsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/users/${id}/mentions`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Search users by name or username
+   */
+  retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/users/search', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get recent tweets by a user
+   */
+  retrieveTweets(
+    id: string,
+    query: UserRetrieveTweetsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/users/${id}/tweets`, { query, ...options });
+  }
+
+  /**
+   * Get verified followers
+   */
+  retrieveVerifiedFollowers(
+    id: string,
+    query: UserRetrieveVerifiedFollowersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/users/${id}/verified-followers`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+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)
+   */
+  ids: string;
+}
+
+export interface UserRetrieveFollowersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Items per page (20-200, default 200)
+   */
+  pageSize?: number;
+}
+
+export interface UserRetrieveFollowersYouKnowParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+}
+
+export interface UserRetrieveFollowingParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Items per page (20-200, default 200)
+   */
+  pageSize?: number;
+}
+
+export interface UserRetrieveLikesParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+}
+
+export interface UserRetrieveMediaParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+}
+
+export interface UserRetrieveMentionsParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Unix timestamp - filter after
+   */
+  sinceTime?: string;
+
+  /**
+   * Unix timestamp - filter before
+   */
+  untilTime?: string;
+}
+
+export interface UserRetrieveSearchParams {
+  /**
+   * Search query
+   */
+  q: string;
+
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface UserRetrieveTweetsParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Include parent tweet for replies
+   */
+  includeParentTweet?: boolean;
+
+  /**
+   * Include reply tweets
+   */
+  includeReplies?: boolean;
+}
+
+export interface UserRetrieveVerifiedFollowersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+Users.Follow = Follow;
+
+export declare namespace Users {
+  export {
+    type UserProfile as UserProfile,
+    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 {
+    Follow as Follow,
+    type FollowCreateResponse as FollowCreateResponse,
+    type FollowDeleteAllResponse as FollowDeleteAllResponse,
+    type FollowCreateParams as FollowCreateParams,
+    type FollowDeleteAllParams as FollowDeleteAllParams,
+  };
+}

package/src/resources/x/users.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './users/index';

package/src/resources/x/x.ts

@@ -0,0 +1,368 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import * as AccountsAPI from './accounts';
+import {
+  AccountCreateParams,
+  AccountCreateResponse,
+  AccountDeleteResponse,
+  AccountListResponse,
+  AccountReauthParams,
+  AccountReauthResponse,
+  Accounts,
+  XAccount,
+  XAccountDetail,
+} from './accounts';
+import * as BookmarksAPI from './bookmarks';
+import { BookmarkListParams, BookmarkRetrieveFoldersResponse, Bookmarks } from './bookmarks';
+import * as DmAPI from './dm';
+import { Dm, DmRetrieveHistoryParams, DmRetrieveHistoryResponse, DmSendParams, DmSendResponse } from './dm';
+import * as FollowersAPI from './followers';
+import { FollowerCheckParams, FollowerCheckResponse, Followers } from './followers';
+import * as ListsAPI from './lists';
+import {
+  ListRetrieveFollowersParams,
+  ListRetrieveMembersParams,
+  ListRetrieveTweetsParams,
+  Lists,
+} from './lists';
+import * as MediaAPI from './media';
+import {
+  Media,
+  MediaDownloadParams,
+  MediaDownloadResponse,
+  MediaUploadParams,
+  MediaUploadResponse,
+} from './media';
+import * as ProfileAPI from './profile';
+import {
+  Profile,
+  ProfileUpdateAvatarParams,
+  ProfileUpdateAvatarResponse,
+  ProfileUpdateBannerParams,
+  ProfileUpdateBannerResponse,
+  ProfileUpdateParams,
+  ProfileUpdateResponse,
+} from './profile';
+import * as CommunitiesAPI from './communities/communities';
+import {
+  Communities,
+  CommunityActionResult,
+  CommunityCreateParams,
+  CommunityCreateResponse,
+  CommunityDeleteParams,
+  CommunityDeleteResponse,
+  CommunityRetrieveInfoResponse,
+  CommunityRetrieveMembersParams,
+  CommunityRetrieveModeratorsParams,
+  CommunityRetrieveSearchParams,
+} from './communities/communities';
+import * as TweetsAPI from './tweets/tweets';
+import {
+  SearchTweet,
+  TweetAuthor,
+  TweetCreateParams,
+  TweetCreateResponse,
+  TweetDeleteParams,
+  TweetDeleteResponse,
+  TweetDetail,
+  TweetGetFavoritersParams,
+  TweetGetQuotesParams,
+  TweetGetRepliesParams,
+  TweetGetRetweetersParams,
+  TweetGetThreadParams,
+  TweetListParams,
+  TweetRetrieveResponse,
+  TweetSearchParams,
+  Tweets,
+} from './tweets/tweets';
+import * as UsersAPI from './users/users';
+import {
+  UserProfile,
+  UserRetrieveBatchParams,
+  UserRetrieveFollowersParams,
+  UserRetrieveFollowersYouKnowParams,
+  UserRetrieveFollowingParams,
+  UserRetrieveLikesParams,
+  UserRetrieveMediaParams,
+  UserRetrieveMentionsParams,
+  UserRetrieveSearchParams,
+  UserRetrieveTweetsParams,
+  UserRetrieveVerifiedFollowersParams,
+  Users,
+} from './users/users';
+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 X extends APIResource {
+  tweets: TweetsAPI.Tweets = new TweetsAPI.Tweets(this._client);
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+  followers: FollowersAPI.Followers = new FollowersAPI.Followers(this._client);
+  dm: DmAPI.Dm = new DmAPI.Dm(this._client);
+  media: MediaAPI.Media = new MediaAPI.Media(this._client);
+  profile: ProfileAPI.Profile = new ProfileAPI.Profile(this._client);
+  communities: CommunitiesAPI.Communities = new CommunitiesAPI.Communities(this._client);
+  accounts: AccountsAPI.Accounts = new AccountsAPI.Accounts(this._client);
+  bookmarks: BookmarksAPI.Bookmarks = new BookmarksAPI.Bookmarks(this._client);
+  lists: ListsAPI.Lists = new ListsAPI.Lists(this._client);
+
+  /**
+   * Retrieve the full content of an X Article (long-form post) by tweet ID.
+   */
+  getArticle(tweetID: string, options?: RequestOptions): APIPromise<XGetArticleResponse> {
+    return this._client.get(path`/x/articles/${tweetID}`, options);
+  }
+
+  /**
+   * Get home timeline
+   */
+  getHomeTimeline(
+    query: XGetHomeTimelineParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get('/x/timeline', { query, ...options });
+  }
+
+  /**
+   * Get notifications
+   */
+  getNotifications(
+    query: XGetNotificationsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<XGetNotificationsResponse> {
+    return this._client.get('/x/notifications', { query, ...options });
+  }
+
+  /**
+   * Get trending topics
+   */
+  getTrends(options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/trends', {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface XGetArticleResponse {
+  article: XGetArticleResponse.Article;
+
+  author?: TweetsAPI.TweetAuthor;
+}
+
+export namespace XGetArticleResponse {
+  export interface Article {
+    contents?: Array<Article.Content>;
+
+    coverImageUrl?: string;
+
+    createdAt?: string;
+
+    likeCount?: number;
+
+    previewText?: string;
+
+    quoteCount?: number;
+
+    replyCount?: number;
+
+    title?: string;
+
+    viewCount?: number;
+  }
+
+  export namespace Article {
+    export interface Content {
+      height?: number;
+
+      text?: string;
+
+      /**
+       * Block type: unstyled, header-one, header-two, header-three, unordered-list-item,
+       * ordered-list-item, image, gif, divider
+       */
+      type?: string;
+
+      /**
+       * Media URL for image/gif blocks
+       */
+      url?: string;
+
+      width?: number;
+    }
+  }
+}
+
+export interface XGetNotificationsResponse {
+  has_next_page: boolean;
+
+  next_cursor: string;
+
+  notifications: Array<XGetNotificationsResponse.Notification>;
+}
+
+export namespace XGetNotificationsResponse {
+  export interface Notification {
+    id: string;
+
+    message?: string;
+
+    timestamp?: string;
+
+    type?: string;
+  }
+}
+
+export interface XGetHomeTimelineParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Comma-separated tweet IDs to exclude from results
+   */
+  seenTweetIds?: string;
+}
+
+export interface XGetNotificationsParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Notification type filter
+   */
+  type?: 'All' | 'Verified' | 'Mentions';
+}
+
+X.Tweets = Tweets;
+X.Users = Users;
+X.Followers = Followers;
+X.Dm = Dm;
+X.Media = Media;
+X.Profile = Profile;
+X.Communities = Communities;
+X.Accounts = Accounts;
+X.Bookmarks = Bookmarks;
+X.Lists = Lists;
+
+export declare namespace X {
+  export {
+    type XGetArticleResponse as XGetArticleResponse,
+    type XGetNotificationsResponse as XGetNotificationsResponse,
+    type XGetHomeTimelineParams as XGetHomeTimelineParams,
+    type XGetNotificationsParams as XGetNotificationsParams,
+  };
+
+  export {
+    Tweets as Tweets,
+    type SearchTweet as SearchTweet,
+    type TweetAuthor as TweetAuthor,
+    type TweetDetail as TweetDetail,
+    type TweetCreateResponse as TweetCreateResponse,
+    type TweetRetrieveResponse as TweetRetrieveResponse,
+    type TweetDeleteResponse as TweetDeleteResponse,
+    type TweetCreateParams as TweetCreateParams,
+    type TweetListParams as TweetListParams,
+    type TweetDeleteParams as TweetDeleteParams,
+    type TweetGetFavoritersParams as TweetGetFavoritersParams,
+    type TweetGetQuotesParams as TweetGetQuotesParams,
+    type TweetGetRepliesParams as TweetGetRepliesParams,
+    type TweetGetRetweetersParams as TweetGetRetweetersParams,
+    type TweetGetThreadParams as TweetGetThreadParams,
+    type TweetSearchParams as TweetSearchParams,
+  };
+
+  export {
+    Users as Users,
+    type UserProfile as UserProfile,
+    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 {
+    Followers as Followers,
+    type FollowerCheckResponse as FollowerCheckResponse,
+    type FollowerCheckParams as FollowerCheckParams,
+  };
+
+  export {
+    Dm as Dm,
+    type DmRetrieveHistoryResponse as DmRetrieveHistoryResponse,
+    type DmSendResponse as DmSendResponse,
+    type DmRetrieveHistoryParams as DmRetrieveHistoryParams,
+    type DmSendParams as DmSendParams,
+  };
+
+  export {
+    Media as Media,
+    type MediaDownloadResponse as MediaDownloadResponse,
+    type MediaUploadResponse as MediaUploadResponse,
+    type MediaDownloadParams as MediaDownloadParams,
+    type MediaUploadParams as MediaUploadParams,
+  };
+
+  export {
+    Profile as Profile,
+    type ProfileUpdateResponse as ProfileUpdateResponse,
+    type ProfileUpdateAvatarResponse as ProfileUpdateAvatarResponse,
+    type ProfileUpdateBannerResponse as ProfileUpdateBannerResponse,
+    type ProfileUpdateParams as ProfileUpdateParams,
+    type ProfileUpdateAvatarParams as ProfileUpdateAvatarParams,
+    type ProfileUpdateBannerParams as ProfileUpdateBannerParams,
+  };
+
+  export {
+    Communities as Communities,
+    type CommunityActionResult as CommunityActionResult,
+    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 {
+    Accounts as Accounts,
+    type XAccount as XAccount,
+    type XAccountDetail as XAccountDetail,
+    type AccountCreateResponse as AccountCreateResponse,
+    type AccountListResponse as AccountListResponse,
+    type AccountDeleteResponse as AccountDeleteResponse,
+    type AccountReauthResponse as AccountReauthResponse,
+    type AccountCreateParams as AccountCreateParams,
+    type AccountReauthParams as AccountReauthParams,
+  };
+
+  export {
+    Bookmarks as Bookmarks,
+    type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse,
+    type BookmarkListParams as BookmarkListParams,
+  };
+
+  export {
+    Lists as Lists,
+    type ListRetrieveFollowersParams as ListRetrieveFollowersParams,
+    type ListRetrieveMembersParams as ListRetrieveMembersParams,
+    type ListRetrieveTweetsParams as ListRetrieveTweetsParams,
+  };
+}

package/src/resources/x.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './x/index';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map