x-twitter-scraper 0.1.0

package/src/resources/webhooks.ts

@@ -0,0 +1,147 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Webhook endpoint management & delivery
+ */
+export class Webhooks extends APIResource {
+  /**
+   * Create webhook
+   */
+  create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
+    return this._client.post('/webhooks', { body, ...options });
+  }
+
+  /**
+   * Update webhook
+   */
+  update(id: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook> {
+    return this._client.patch(path`/webhooks/${id}`, { body, ...options });
+  }
+
+  /**
+   * List webhooks
+   */
+  list(options?: RequestOptions): APIPromise<WebhookListResponse> {
+    return this._client.get('/webhooks', options);
+  }
+
+  /**
+   * Deactivate webhook
+   */
+  deactivate(id: string, options?: RequestOptions): APIPromise<WebhookDeactivateResponse> {
+    return this._client.delete(path`/webhooks/${id}`, options);
+  }
+
+  /**
+   * List webhook deliveries
+   */
+  listDeliveries(id: string, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse> {
+    return this._client.get(path`/webhooks/${id}/deliveries`, options);
+  }
+
+  /**
+   * Test webhook endpoint
+   */
+  test(id: string, options?: RequestOptions): APIPromise<WebhookTestResponse> {
+    return this._client.post(path`/webhooks/${id}/test`, options);
+  }
+}
+
+export interface Delivery {
+  id: string;
+
+  attempts: number;
+
+  createdAt: string;
+
+  status: string;
+
+  streamEventId: string;
+
+  deliveredAt?: string;
+
+  lastError?: string;
+
+  lastStatusCode?: number;
+}
+
+export interface Webhook {
+  id: string;
+
+  createdAt: string;
+
+  eventTypes: Array<Shared.EventType>;
+
+  isActive: boolean;
+
+  url: string;
+}
+
+export interface WebhookCreateResponse {
+  id: string;
+
+  createdAt: string;
+
+  eventTypes: Array<Shared.EventType>;
+
+  secret: string;
+
+  url: string;
+}
+
+export interface WebhookListResponse {
+  webhooks: Array<Webhook>;
+}
+
+export interface WebhookDeactivateResponse {
+  success: true;
+}
+
+export interface WebhookListDeliveriesResponse {
+  deliveries: Array<Delivery>;
+}
+
+export interface WebhookTestResponse {
+  statusCode: number;
+
+  success: boolean;
+
+  error?: string;
+}
+
+export interface WebhookCreateParams {
+  eventTypes: Array<Shared.EventType>;
+
+  /**
+   * HTTPS URL
+   */
+  url: string;
+}
+
+export interface WebhookUpdateParams {
+  eventTypes?: Array<Shared.EventType>;
+
+  isActive?: boolean;
+
+  url?: string;
+}
+
+export declare namespace Webhooks {
+  export {
+    type Delivery as Delivery,
+    type Webhook as Webhook,
+    type WebhookCreateResponse as WebhookCreateResponse,
+    type WebhookListResponse as WebhookListResponse,
+    type WebhookDeactivateResponse as WebhookDeactivateResponse,
+    type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse,
+    type WebhookTestResponse as WebhookTestResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookUpdateParams as WebhookUpdateParams,
+  };
+}

package/src/resources/x/accounts.ts

@@ -0,0 +1,154 @@
+// 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';
+
+/**
+ * Connected X account management
+ */
+export class Accounts extends APIResource {
+  /**
+   * Connect X account
+   */
+  create(body: AccountCreateParams, options?: RequestOptions): APIPromise<AccountCreateResponse> {
+    return this._client.post('/x/accounts', { body, ...options, __security: {} });
+  }
+
+  /**
+   * Get X account details
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<XAccountDetail> {
+    return this._client.get(path`/x/accounts/${id}`, { ...options, __security: {} });
+  }
+
+  /**
+   * List connected X accounts
+   */
+  list(options?: RequestOptions): APIPromise<AccountListResponse> {
+    return this._client.get('/x/accounts', { ...options, __security: {} });
+  }
+
+  /**
+   * Disconnect X account
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<AccountDeleteResponse> {
+    return this._client.delete(path`/x/accounts/${id}`, { ...options, __security: {} });
+  }
+
+  /**
+   * Re-authenticate X account
+   */
+  reauth(id: string, body: AccountReauthParams, options?: RequestOptions): APIPromise<AccountReauthResponse> {
+    return this._client.post(path`/x/accounts/${id}/reauth`, { body, ...options, __security: {} });
+  }
+}
+
+export interface XAccount {
+  id: string;
+
+  createdAt: string;
+
+  status: string;
+
+  xUserId: string;
+
+  xUsername: string;
+}
+
+export interface XAccountDetail {
+  id: string;
+
+  createdAt: string;
+
+  status: string;
+
+  xUserId: string;
+
+  xUsername: string;
+
+  cookiesObtainedAt?: string;
+
+  proxyCountry?: string;
+
+  updatedAt?: string;
+}
+
+export interface AccountCreateResponse {
+  id: string;
+
+  status: string;
+
+  xUserId: string;
+
+  xUsername: string;
+}
+
+export interface AccountListResponse {
+  accounts: Array<XAccount>;
+}
+
+export interface AccountDeleteResponse {
+  success: true;
+}
+
+export interface AccountReauthResponse {
+  id: string;
+
+  status: string;
+
+  xUsername: string;
+}
+
+export interface AccountCreateParams {
+  /**
+   * Account email
+   */
+  email: string;
+
+  /**
+   * Account password
+   */
+  password: string;
+
+  /**
+   * X username
+   */
+  username: string;
+
+  /**
+   * Proxy country code
+   */
+  proxy_country?: string;
+
+  /**
+   * TOTP secret for 2FA
+   */
+  totp_secret?: string;
+}
+
+export interface AccountReauthParams {
+  /**
+   * Account password
+   */
+  password: string;
+
+  /**
+   * TOTP secret for 2FA
+   */
+  totp_secret?: string;
+}
+
+export declare namespace Accounts {
+  export {
+    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,
+  };
+}

package/src/resources/x/bookmarks.ts

@@ -0,0 +1,63 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as Shared from '../shared';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+/**
+ * X data lookups (subscription required)
+ */
+export class Bookmarks extends APIResource {
+  /**
+   * Get bookmarked tweets
+   */
+  list(
+    query: BookmarkListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Shared.PaginatedTweets> {
+    return this._client.get('/x/bookmarks', { query, ...options });
+  }
+
+  /**
+   * Get bookmark folders
+   */
+  retrieveFolders(options?: RequestOptions): APIPromise<BookmarkRetrieveFoldersResponse> {
+    return this._client.get('/x/bookmarks/folders', options);
+  }
+}
+
+export interface BookmarkRetrieveFoldersResponse {
+  folders: Array<BookmarkRetrieveFoldersResponse.Folder>;
+
+  has_next_page: boolean;
+
+  next_cursor: string;
+}
+
+export namespace BookmarkRetrieveFoldersResponse {
+  export interface Folder {
+    id: string;
+
+    name: string;
+  }
+}
+
+export interface BookmarkListParams {
+  /**
+   * Pagination cursor from previous response
+   */
+  cursor?: string;
+
+  /**
+   * Optional bookmark folder ID
+   */
+  folderId?: string;
+}
+
+export declare namespace Bookmarks {
+  export {
+    type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse,
+    type BookmarkListParams as BookmarkListParams,
+  };
+}

package/src/resources/x/communities/communities.ts

@@ -0,0 +1,194 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as JoinAPI from './join';
+import { Join, JoinCreateParams, JoinDeleteAllParams } from './join';
+import * as TweetsAPI from './tweets';
+import { TweetListParams, Tweets } from './tweets';
+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 Communities extends APIResource {
+  join: JoinAPI.Join = new JoinAPI.Join(this._client);
+  tweets: TweetsAPI.Tweets = new TweetsAPI.Tweets(this._client);
+
+  /**
+   * Create community
+   */
+  create(body: CommunityCreateParams, options?: RequestOptions): APIPromise<CommunityCreateResponse> {
+    return this._client.post('/x/communities', { body, ...options });
+  }
+
+  /**
+   * Delete community
+   */
+  delete(
+    id: string,
+    body: CommunityDeleteParams,
+    options?: RequestOptions,
+  ): APIPromise<CommunityDeleteResponse> {
+    return this._client.delete(path`/x/communities/${id}`, { body, ...options });
+  }
+
+  /**
+   * Get community details
+   */
+  retrieveInfo(id: string, options?: RequestOptions): APIPromise<CommunityRetrieveInfoResponse> {
+    return this._client.get(path`/x/communities/${id}/info`, options);
+  }
+
+  /**
+   * Get community members
+   */
+  retrieveMembers(
+    id: string,
+    query: CommunityRetrieveMembersParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/communities/${id}/members`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get community moderators
+   */
+  retrieveModerators(
+    id: string,
+    query: CommunityRetrieveModeratorsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    return this._client.get(path`/x/communities/${id}/moderators`, {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Search tweets across communities
+   */
+  retrieveSearch(query: CommunityRetrieveSearchParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/communities/search', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface CommunityActionResult {
+  communityId: string;
+
+  communityName: string;
+
+  success: true;
+}
+
+export interface CommunityCreateResponse {
+  communityId: string;
+
+  success: true;
+
+  communityName?: string;
+}
+
+export interface CommunityDeleteResponse {
+  success: true;
+}
+
+export interface CommunityRetrieveInfoResponse {
+  /**
+   * Community info object
+   */
+  community: unknown;
+}
+
+export interface CommunityCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Community name
+   */
+  name: string;
+
+  /**
+   * Community description
+   */
+  description?: string;
+}
+
+export interface CommunityDeleteParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+
+  /**
+   * Community name for confirmation
+   */
+  community_name: string;
+}
+
+export interface CommunityRetrieveMembersParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface CommunityRetrieveModeratorsParams {
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+}
+
+export interface CommunityRetrieveSearchParams {
+  /**
+   * Search query
+   */
+  q: string;
+
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Sort order (Latest or Top)
+   */
+  queryType?: string;
+}
+
+Communities.Join = Join;
+Communities.Tweets = Tweets;
+
+export declare namespace Communities {
+  export {
+    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 {
+    Join as Join,
+    type JoinCreateParams as JoinCreateParams,
+    type JoinDeleteAllParams as JoinDeleteAllParams,
+  };
+
+  export { Tweets as Tweets, type TweetListParams as TweetListParams };
+}

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

@@ -0,0 +1,16 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Communities,
+  type CommunityActionResult,
+  type CommunityCreateResponse,
+  type CommunityDeleteResponse,
+  type CommunityRetrieveInfoResponse,
+  type CommunityCreateParams,
+  type CommunityDeleteParams,
+  type CommunityRetrieveMembersParams,
+  type CommunityRetrieveModeratorsParams,
+  type CommunityRetrieveSearchParams,
+} from './communities';
+export { Join, type JoinCreateParams, type JoinDeleteAllParams } from './join';
+export { Tweets, type TweetListParams } from './tweets';

package/src/resources/x/communities/join.ts

@@ -0,0 +1,52 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as CommunitiesAPI from './communities';
+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 Join extends APIResource {
+  /**
+   * Join community
+   */
+  create(
+    id: string,
+    body: JoinCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<CommunitiesAPI.CommunityActionResult> {
+    return this._client.post(path`/x/communities/${id}/join`, { body, ...options });
+  }
+
+  /**
+   * Leave community
+   */
+  deleteAll(
+    id: string,
+    body: JoinDeleteAllParams,
+    options?: RequestOptions,
+  ): APIPromise<CommunitiesAPI.CommunityActionResult> {
+    return this._client.delete(path`/x/communities/${id}/join`, { body, ...options });
+  }
+}
+
+export interface JoinCreateParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export interface JoinDeleteAllParams {
+  /**
+   * X account (@username or account ID)
+   */
+  account: string;
+}
+
+export declare namespace Join {
+  export { type JoinCreateParams as JoinCreateParams, type JoinDeleteAllParams as JoinDeleteAllParams };
+}

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

@@ -0,0 +1,43 @@
+// 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';
+
+/**
+ * X data lookups (subscription required)
+ */
+export class Tweets extends APIResource {
+  /**
+   * Search tweets across all communities
+   */
+  list(query: TweetListParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.get('/x/communities/tweets', {
+      query,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface TweetListParams {
+  /**
+   * Search query
+   */
+  q: string;
+
+  /**
+   * Pagination cursor
+   */
+  cursor?: string;
+
+  /**
+   * Sort order (Latest or Top)
+   */
+  queryType?: string;
+}
+
+export declare namespace Tweets {
+  export { type TweetListParams as TweetListParams };
+}

package/src/resources/x/communities.ts

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