x-twitter-scraper 0.1.0

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

@@ -0,0 +1,367 @@
+// 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 LikeAPI from './like';
+import { Like, LikeCreateParams, LikeCreateResponse, LikeDeleteParams, LikeDeleteResponse } from './like';
+import * as RetweetAPI from './retweet';
+import {
+  Retweet,
+  RetweetCreateParams,
+  RetweetCreateResponse,
+  RetweetDeleteParams,
+  RetweetDeleteResponse,
+} from './retweet';
+import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Tweets extends APIResource {
+  like: LikeAPI.Like = new LikeAPI.Like(this._client);
+  retweet: RetweetAPI.Retweet = new RetweetAPI.Retweet(this._client);
+
+  /**
+   * Create tweet
+   */
+  create(body: TweetCreateParams, options?: RequestOptions): APIPromise<TweetCreateResponse> {
+    return this._client.post('/x/tweets', { body, ...options });
+  }
+
+  /**
+   * Look up tweet
+   */
+  retrieve(tweetID: string, options?: RequestOptions): APIPromise<TweetRetrieveResponse> {
+    return this._client.get(path`/x/tweets/${tweetID}`, options);
+  }
+
+  /**
+   * Get multiple tweets by IDs
+   */
+  list(query: TweetListParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/tweets', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Delete tweet
+   */
+  delete(
+    tweetID: string,
+    body: TweetDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<TweetDeleteResponse> {
+    return this._client.delete(path`/x/tweets/${tweetID}`, { body, ...options });
+  }
+
+  /**
+   * Get users who liked a tweet
+   */
+  getFavoriters(
+    id: string,
+    query: TweetGetFavoritersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedUsers> {
+    return this._client.get(path`/x/tweets/${id}/favoriters`, { query, ...options });
+  }
+
+  /**
+   * Get quote tweets of a tweet
+   */
+  getQuotes(
+    id: string,
+    query: TweetGetQuotesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/tweets/${id}/quotes`, { query, ...options });
+  }
+
+  /**
+   * Get replies to a tweet
+   */
+  getReplies(
+    id: string,
+    query: TweetGetRepliesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/tweets/${id}/replies`, { query, ...options });
+  }
+
+  /**
+   * Get users who retweeted a tweet
+   */
+  getRetweeters(
+    id: string,
+    query: TweetGetRetweetersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedUsers> {
+    return this._client.get(path`/x/tweets/${id}/retweeters`, { query, ...options });
+  }
+
+  /**
+   * Get thread context for a tweet
+   */
+  getThread(
+    id: string,
+    query: TweetGetThreadParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get(path`/x/tweets/${id}/thread`, { query, ...options });
+  }
+
+  /**
+   * Search tweets
+   */
+  search(query: TweetSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get('/x/tweets/search', { query, ...options });
+  }
+}
+
+export interface SearchTweet {
+  id: string;
+
+  text: string;
+
+  author?: SearchTweet.Author;
+
+  bookmarkCount?: number;
+
+  createdAt?: string;
+
+  likeCount?: number;
+
+  quoteCount?: number;
+
+  replyCount?: number;
+
+  retweetCount?: number;
+
+  viewCount?: number;
+}
+
+export namespace SearchTweet {
+  export interface Author {
+    id: string;
+
+    name: string;
+
+    username: string;
+
+    verified?: boolean;
+  }
+}
+
+export interface TweetAuthor {
+  id: string;
+
+  followers: number;
+
+  username: string;
+
+  verified: boolean;
+
+  profilePicture?: string;
+}
+
+export interface TweetDetail {
+  id: string;
+
+  bookmarkCount: number;
+
+  likeCount: number;
+
+  quoteCount: number;
+
+  replyCount: number;
+
+  retweetCount: number;
+
+  text: string;
+
+  viewCount: number;
+
+  createdAt?: string;
+}
+
+export interface TweetCreateResponse {
+  success: true;
+
+  tweetId: string;
+}
+
+export interface TweetRetrieveResponse {
+  tweet: TweetDetail;
+
+  author?: TweetAuthor;
+}
+
+export interface TweetDeleteResponse {
+  success: true;
+}
+
+export interface TweetCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  text: string;
+
+  attachment_url?: string;
+
+  community_id?: string;
+
+  is_note_tweet?: boolean;
+
+  media_ids?: Array<string>;
+
+  reply_to_tweet_id?: string;
+}
+
+export interface TweetListParams {
+  /**
+   * Comma-separated tweet IDs (max 100)
+   */
+  ids: string;
+}
+
+export interface TweetDeleteParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export interface TweetGetFavoritersParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+}
+
+export interface TweetGetQuotesParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Include replies (default false)
+   */
+  includeReplies?: boolean;
+
+  /**
+   * Unix timestamp - filter after
+   */
+  sinceTime?: string;
+
+  /**
+   * Unix timestamp - filter before
+   */
+  untilTime?: string;
+}
+
+export interface TweetGetRepliesParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Unix timestamp - filter after
+   */
+  sinceTime?: string;
+
+  /**
+   * Unix timestamp - filter before
+   */
+  untilTime?: string;
+}
+
+export interface TweetGetRetweetersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface TweetGetThreadParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface TweetSearchParams {
+  /**
+   * Search query (keywords,
+   */
+  q: string;
+
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Deprecated — use cursor-based pagination instead
+   */
+  limit?: number;
+
+  /**
+   * Sort order — Latest (chronological) or Top (engagement-ranked)
+   */
+  queryType?: 'Latest' | 'Top';
+
+  /**
+   * ISO 8601 timestamp — only return tweets after this time
+   */
+  sinceTime?: string;
+
+  /**
+   * ISO 8601 timestamp — only return tweets before this time
+   */
+  untilTime?: string;
+}
+
+Tweets.Like = Like;
+Tweets.Retweet = Retweet;
+
+export declare namespace Tweets {
+  export {
+    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 {
+    Like as Like,
+    type LikeCreateResponse as LikeCreateResponse,
+    type LikeDeleteResponse as LikeDeleteResponse,
+    type LikeCreateParams as LikeCreateParams,
+    type LikeDeleteParams as LikeDeleteParams,
+  };
+
+  export {
+    Retweet as Retweet,
+    type RetweetCreateResponse as RetweetCreateResponse,
+    type RetweetDeleteResponse as RetweetDeleteResponse,
+    type RetweetCreateParams as RetweetCreateParams,
+    type RetweetDeleteParams as RetweetDeleteParams,
+  };
+}

package/src/resources/x/tweets.ts

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

package/src/resources/x/users/follow.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 Follow extends APIResource {
+  /**
+   * Follow user
+   */
+  create(
+    userID: string,
+    body: FollowCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<FollowCreateResponse> {
+    return this._client.post(path`/x/users/${userID}/follow`, { body, ...options });
+  }
+
+  /**
+   * Unfollow user
+   */
+  deleteAll(
+    userID: string,
+    body: FollowDeleteAllParams,
+    options?: RequestOptions,
+  ): APIPromise<FollowDeleteAllResponse> {
+    return this._client.delete(path`/x/users/${userID}/follow`, { body, ...options });
+  }
+}
+
+export interface FollowCreateResponse {
+  success: true;
+}
+
+export interface FollowDeleteAllResponse {
+  success: true;
+}
+
+export interface FollowCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export interface FollowDeleteAllParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export declare namespace Follow {
+  export {
+    type FollowCreateResponse as FollowCreateResponse,
+    type FollowDeleteAllResponse as FollowDeleteAllResponse,
+    type FollowCreateParams as FollowCreateParams,
+    type FollowDeleteAllParams as FollowDeleteAllParams,
+  };
+}

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

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Follow,
+  type FollowCreateResponse,
+  type FollowDeleteAllResponse,
+  type FollowCreateParams,
+  type FollowDeleteAllParams,
+} from './follow';
+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';