x-twitter-scraper 0.1.0 → 0.2.1

package/src/resources/styles.ts

@@ -12,20 +12,42 @@ import { path } from '../internal/utils/path';
 export class Styles extends APIResource {
   /**
    * Get cached style profile
+   *
+   * @example
+   * ```ts
+   * const styleProfile = await client.styles.retrieve('id');
+   * ```
    */
-  retrieve(username: string, options?: RequestOptions): APIPromise<StyleProfile> {
-    return this._client.get(path`/styles/${username}`, options);
+  retrieve(id: string, options?: RequestOptions): APIPromise<StyleProfile> {
+    return this._client.get(path`/styles/${id}`, options);
   }
 
   /**
    * Save style profile with custom tweets
+   *
+   * @example
+   * ```ts
+   * const styleProfile = await client.styles.update('id', {
+   *   label: 'Professional Voice',
+   *   tweets: [
+   *     {
+   *       text: 'Excited to share our latest research findings.',
+   *     },
+   *   ],
+   * });
+   * ```
    */
-  update(username: string, body: StyleUpdateParams, options?: RequestOptions): APIPromise<StyleProfile> {
-    return this._client.put(path`/styles/${username}`, { body, ...options });
+  update(id: string, body: StyleUpdateParams, options?: RequestOptions): APIPromise<StyleProfile> {
+    return this._client.put(path`/styles/${id}`, { body, ...options });
   }
 
   /**
    * List cached style profiles
+   *
+   * @example
+   * ```ts
+   * const styles = await client.styles.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<StyleListResponse> {
     return this._client.get('/styles', options);
@@ -33,9 +55,14 @@ export class Styles extends APIResource {
 
   /**
    * Delete a style profile
+   *
+   * @example
+   * ```ts
+   * await client.styles.delete('id');
+   * ```
    */
-  delete(username: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/styles/${username}`, {
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/styles/${id}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -43,6 +70,13 @@ export class Styles extends APIResource {
 
   /**
    * Analyze writing style from recent tweets
+   *
+   * @example
+   * ```ts
+   * const styleProfile = await client.styles.analyze({
+   *   username: 'elonmusk',
+   * });
+   * ```
    */
   analyze(body: StyleAnalyzeParams, options?: RequestOptions): APIPromise<StyleProfile> {
     return this._client.post('/styles', { body, ...options });
@@ -50,6 +84,14 @@ export class Styles extends APIResource {
 
   /**
    * Compare two style profiles
+   *
+   * @example
+   * ```ts
+   * const response = await client.styles.compare({
+   *   username1: 'username1',
+   *   username2: 'username2',
+   * });
+   * ```
    */
   compare(query: StyleCompareParams, options?: RequestOptions): APIPromise<StyleCompareResponse> {
     return this._client.get('/styles/compare', { query, ...options });
@@ -57,12 +99,20 @@ export class Styles extends APIResource {
 
   /**
    * Get engagement metrics for style tweets
+   *
+   * @example
+   * ```ts
+   * const response = await client.styles.getPerformance('id');
+   * ```
    */
-  getPerformance(username: string, options?: RequestOptions): APIPromise<StyleGetPerformanceResponse> {
-    return this._client.get(path`/styles/${username}/performance`, options);
+  getPerformance(id: string, options?: RequestOptions): APIPromise<StyleGetPerformanceResponse> {
+    return this._client.get(path`/styles/${id}/performance`, options);
   }
 }
 
+/**
+ * Full style profile with sampled tweets used for tone analysis.
+ */
 export interface StyleProfile {
   fetchedAt: string;
 
@@ -87,6 +137,9 @@ export namespace StyleProfile {
   }
 }
 
+/**
+ * Style profile summary with tweet count and ownership flag.
+ */
 export interface StyleProfileSummary {
   fetchedAt: string;
 
@@ -102,8 +155,14 @@ export interface StyleListResponse {
 }
 
 export interface StyleCompareResponse {
+  /**
+   * Full style profile with sampled tweets used for tone analysis.
+   */
   style1: StyleProfile;
 
+  /**
+   * Full style profile with sampled tweets used for tone analysis.
+   */
   style2: StyleProfile;
 }
 

package/src/resources/support/tickets.ts

@@ -11,6 +11,14 @@ import { path } from '../../internal/utils/path';
 export class Tickets extends APIResource {
   /**
    * Create a support ticket
+   *
+   * @example
+   * ```ts
+   * const ticket = await client.support.tickets.create({
+   *   body: 'I am unable to connect my X account. Please help.',
+   *   subject: 'Cannot connect X account',
+   * });
+   * ```
    */
   create(body: TicketCreateParams, options?: RequestOptions): APIPromise<TicketCreateResponse> {
     return this._client.post('/support/tickets', { body, ...options });
@@ -18,6 +26,13 @@ export class Tickets extends APIResource {
 
   /**
    * Get ticket with all messages
+   *
+   * @example
+   * ```ts
+   * const ticket = await client.support.tickets.retrieve(
+   *   'messages_value',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<TicketRetrieveResponse> {
     return this._client.get(path`/support/tickets/${id}`, options);
@@ -25,6 +40,13 @@ export class Tickets extends APIResource {
 
   /**
    * Update ticket status
+   *
+   * @example
+   * ```ts
+   * const ticket = await client.support.tickets.update('id', {
+   *   status: 'resolved',
+   * });
+   * ```
    */
   update(id: string, body: TicketUpdateParams, options?: RequestOptions): APIPromise<TicketUpdateResponse> {
     return this._client.patch(path`/support/tickets/${id}`, { body, ...options });
@@ -32,6 +54,11 @@ export class Tickets extends APIResource {
 
   /**
    * List user's support tickets
+   *
+   * @example
+   * ```ts
+   * const tickets = await client.support.tickets.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<TicketListResponse> {
     return this._client.get('/support/tickets', options);
@@ -39,6 +66,13 @@ export class Tickets extends APIResource {
 
   /**
    * Reply to a support ticket
+   *
+   * @example
+   * ```ts
+   * const response = await client.support.tickets.reply('id', {
+   *   body: 'Thank you for the update.',
+   * });
+   * ```
    */
   reply(id: string, body: TicketReplyParams, options?: RequestOptions): APIPromise<TicketReplyResponse> {
     return this._client.post(path`/support/tickets/${id}/messages`, { body, ...options });

package/src/resources/trends.ts

@@ -9,7 +9,7 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Trends extends APIResource {
   /**
-   * Get trending topics
+   * Get regional trending topics
    */
   list(
     query: TrendListParams | null | undefined = {},
@@ -40,6 +40,9 @@ export namespace TrendListResponse {
 }
 
 export interface TrendListParams {
+  /**
+   * Number of trending topics to return (1-50, default 30)
+   */
   count?: number;
 
   /**

package/src/resources/webhooks.ts

@@ -12,6 +12,14 @@ import { path } from '../internal/utils/path';
 export class Webhooks extends APIResource {
   /**
    * Create webhook
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.create({
+   *   eventTypes: ['tweet.new', 'follower.gained'],
+   *   url: 'https://example.com/webhook',
+   * });
+   * ```
    */
   create(body: WebhookCreateParams, options?: RequestOptions): APIPromise<WebhookCreateResponse> {
     return this._client.post('/webhooks', { body, ...options });
@@ -19,6 +27,14 @@ export class Webhooks extends APIResource {
 
   /**
    * Update webhook
+   *
+   * @example
+   * ```ts
+   * const webhook = await client.webhooks.update('id', {
+   *   isActive: true,
+   *   url: 'https://example.com/webhook',
+   * });
+   * ```
    */
   update(id: string, body: WebhookUpdateParams, options?: RequestOptions): APIPromise<Webhook> {
     return this._client.patch(path`/webhooks/${id}`, { body, ...options });
@@ -26,6 +42,11 @@ export class Webhooks extends APIResource {
 
   /**
    * List webhooks
+   *
+   * @example
+   * ```ts
+   * const webhooks = await client.webhooks.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<WebhookListResponse> {
     return this._client.get('/webhooks', options);
@@ -33,6 +54,11 @@ export class Webhooks extends APIResource {
 
   /**
    * Deactivate webhook
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.deactivate('id');
+   * ```
    */
   deactivate(id: string, options?: RequestOptions): APIPromise<WebhookDeactivateResponse> {
     return this._client.delete(path`/webhooks/${id}`, options);
@@ -40,6 +66,11 @@ export class Webhooks extends APIResource {
 
   /**
    * List webhook deliveries
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.listDeliveries('id');
+   * ```
    */
   listDeliveries(id: string, options?: RequestOptions): APIPromise<WebhookListDeliveriesResponse> {
     return this._client.get(path`/webhooks/${id}/deliveries`, options);
@@ -47,12 +78,20 @@ export class Webhooks extends APIResource {
 
   /**
    * Test webhook endpoint
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.test('id');
+   * ```
    */
   test(id: string, options?: RequestOptions): APIPromise<WebhookTestResponse> {
     return this._client.post(path`/webhooks/${id}/test`, options);
   }
 }
 
+/**
+ * Webhook delivery attempt record with status and retry count.
+ */
 export interface Delivery {
   id: string;
 
@@ -71,11 +110,17 @@ export interface Delivery {
   lastStatusCode?: number;
 }
 
+/**
+ * Webhook endpoint registered to receive event deliveries.
+ */
 export interface Webhook {
   id: string;
 
   createdAt: string;
 
+  /**
+   * Array of event types to subscribe to.
+   */
   eventTypes: Array<Shared.EventType>;
 
   isActive: boolean;
@@ -88,6 +133,9 @@ export interface WebhookCreateResponse {
 
   createdAt: string;
 
+  /**
+   * Array of event types to subscribe to.
+   */
   eventTypes: Array<Shared.EventType>;
 
   secret: string;
@@ -116,6 +164,9 @@ export interface WebhookTestResponse {
 }
 
 export interface WebhookCreateParams {
+  /**
+   * Array of event types to subscribe to.
+   */
   eventTypes: Array<Shared.EventType>;
 
   /**
@@ -125,6 +176,9 @@ export interface WebhookCreateParams {
 }
 
 export interface WebhookUpdateParams {
+  /**
+   * Array of event types to subscribe to.
+   */
   eventTypes?: Array<Shared.EventType>;
 
   isActive?: boolean;

package/src/resources/x/accounts.ts

@@ -11,40 +11,94 @@ import { path } from '../../internal/utils/path';
 export class Accounts extends APIResource {
   /**
    * Connect X account
+   *
+   * @example
+   * ```ts
+   * const account = await client.x.accounts.create({
+   *   email: 'user@example.com',
+   *   password: 's3cur3Pa$$w0rd',
+   *   username: 'elonmusk',
+   * });
+   * ```
    */
   create(body: AccountCreateParams, options?: RequestOptions): APIPromise<AccountCreateResponse> {
-    return this._client.post('/x/accounts', { body, ...options, __security: {} });
+    return this._client.post('/x/accounts', { body, ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * Get X account details
+   *
+   * @example
+   * ```ts
+   * const xAccountDetail = await client.x.accounts.retrieve(
+   *   'id',
+   * );
+   * ```
    */
   retrieve(id: string, options?: RequestOptions): APIPromise<XAccountDetail> {
-    return this._client.get(path`/x/accounts/${id}`, { ...options, __security: {} });
+    return this._client.get(path`/x/accounts/${id}`, { ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * List connected X accounts
+   *
+   * @example
+   * ```ts
+   * const accounts = await client.x.accounts.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<AccountListResponse> {
-    return this._client.get('/x/accounts', { ...options, __security: {} });
+    return this._client.get('/x/accounts', { ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * Disconnect X account
+   *
+   * @example
+   * ```ts
+   * const account = await client.x.accounts.delete('id');
+   * ```
    */
   delete(id: string, options?: RequestOptions): APIPromise<AccountDeleteResponse> {
-    return this._client.delete(path`/x/accounts/${id}`, { ...options, __security: {} });
+    return this._client.delete(path`/x/accounts/${id}`, { ...options, __security: { apiKeyAuth: true } });
+  }
+
+  /**
+   * Clears loginFailedAt and loginFailureReason for all accounts with transient or
+   * automated failure reasons, making them eligible for retry on next use.
+   *
+   * @example
+   * ```ts
+   * const response = await client.x.accounts.bulkRetry();
+   * ```
+   */
+  bulkRetry(options?: RequestOptions): APIPromise<AccountBulkRetryResponse> {
+    return this._client.post('/x/accounts/bulk-retry', { ...options, __security: { apiKeyAuth: true } });
   }
 
   /**
    * Re-authenticate X account
+   *
+   * @example
+   * ```ts
+   * const response = await client.x.accounts.reauth('id', {
+   *   password: 'password_value',
+   *   totp_secret: 'totp_secret_value',
+   * });
+   * ```
    */
   reauth(id: string, body: AccountReauthParams, options?: RequestOptions): APIPromise<AccountReauthResponse> {
-    return this._client.post(path`/x/accounts/${id}/reauth`, { body, ...options, __security: {} });
+    return this._client.post(path`/x/accounts/${id}/reauth`, {
+      body,
+      ...options,
+      __security: { apiKeyAuth: true },
+    });
   }
 }
 
+/**
+ * Linked X account summary with username and connection status.
+ */
 export interface XAccount {
   id: string;
 
@@ -57,6 +111,9 @@ export interface XAccount {
   xUsername: string;
 }
 
+/**
+ * Full X account details including proxy, cookies, and update timestamp.
+ */
 export interface XAccountDetail {
   id: string;
 
@@ -93,6 +150,13 @@ export interface AccountDeleteResponse {
   success: true;
 }
 
+export interface AccountBulkRetryResponse {
+  /**
+   * Number of accounts cleared
+   */
+  cleared: number;
+}
+
 export interface AccountReauthResponse {
   id: string;
 
@@ -130,12 +194,12 @@ export interface AccountCreateParams {
 
 export interface AccountReauthParams {
   /**
-   * Account password
+   * Updated account password
    */
   password: string;
 
   /**
-   * TOTP secret for 2FA
+   * TOTP secret for 2FA re-authentication
    */
   totp_secret?: string;
 }
@@ -147,6 +211,7 @@ export declare namespace Accounts {
     type AccountCreateResponse as AccountCreateResponse,
     type AccountListResponse as AccountListResponse,
     type AccountDeleteResponse as AccountDeleteResponse,
+    type AccountBulkRetryResponse as AccountBulkRetryResponse,
     type AccountReauthResponse as AccountReauthResponse,
     type AccountCreateParams as AccountCreateParams,
     type AccountReauthParams as AccountReauthParams,

package/src/resources/x/bookmarks.ts

@@ -11,6 +11,11 @@ import { RequestOptions } from '../../internal/request-options';
 export class Bookmarks extends APIResource {
   /**
    * Get bookmarked tweets
+   *
+   * @example
+   * ```ts
+   * const paginatedTweets = await client.x.bookmarks.list();
+   * ```
    */
   list(
     query: BookmarkListParams | null | undefined = {},
@@ -21,6 +26,11 @@ export class Bookmarks extends APIResource {
 
   /**
    * Get bookmark folders
+   *
+   * @example
+   * ```ts
+   * const response = await client.x.bookmarks.retrieveFolders();
+   * ```
    */
   retrieveFolders(options?: RequestOptions): APIPromise<BookmarkRetrieveFoldersResponse> {
     return this._client.get('/x/bookmarks/folders', options);
@@ -45,7 +55,7 @@ export namespace BookmarkRetrieveFoldersResponse {
 
 export interface BookmarkListParams {
   /**
-   * Pagination cursor from previous response
+   * Pagination cursor for bookmarks
    */
   cursor?: string;