x-twitter-scraper 0.12.3 → 0.13.0

package/src/resources/styles.ts

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class Styles extends APIResource {
   /**
-   * Get cached style profile
+   * Returns one cached writing style profile.
    *
    * @example
    * ```ts
@@ -27,17 +27,15 @@ export class Styles extends APIResource {
   }
 
   /**
-   * Save style profile with custom tweets
+   * Creates or replaces a style profile from supplied posts.
    *
    * @example
    * ```ts
    * const styleProfile = await client.styles.update('id', {
-   *   label: 'Professional Voice',
    *   tweets: [
-   *     {
-   *       text: 'Excited to share our latest research findings.',
-   *     },
+   *     { text: 'Excited to share our latest research.' },
    *   ],
+   *   label: 'Professional Voice',
    * });
    * ```
    */
@@ -46,19 +44,22 @@ export class Styles extends APIResource {
   }
 
   /**
-   * List cached style profiles
+   * Returns cached writing style profiles for the account.
    *
    * @example
    * ```ts
    * const styles = await client.styles.list();
    * ```
    */
-  list(options?: RequestOptions): APIPromise<StyleListResponse> {
-    return this._client.get('/styles', options);
+  list(
+    query: StyleListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<StyleListResponse> {
+    return this._client.get('/styles', { query, ...options });
   }
 
   /**
-   * Delete a style profile
+   * Permanently removes one cached style profile.
    *
    * @example
    * ```ts
@@ -73,7 +74,7 @@ export class Styles extends APIResource {
   }
 
   /**
-   * Analyze writing style from recent tweets
+   * Builds a writing style profile from recent public posts.
    *
    * @example
    * ```ts
@@ -87,7 +88,7 @@ export class Styles extends APIResource {
   }
 
   /**
-   * Compare two style profiles
+   * Compares language and engagement signals across two style profiles.
    *
    * @example
    * ```ts
@@ -102,7 +103,7 @@ export class Styles extends APIResource {
   }
 
   /**
-   * Get engagement metrics for style tweets
+   * Returns engagement metrics for an analyzed public X profile.
    *
    * @example
    * ```ts
@@ -117,16 +118,8 @@ export class Styles extends APIResource {
 /**
  * Full style profile with sampled tweets used for tone analysis.
  */
-export interface StyleProfile {
-  fetchedAt: string;
-
-  isOwnAccount: boolean;
-
-  tweetCount: number;
-
+export interface StyleProfile extends StyleProfileSummary {
   tweets: Array<StyleProfile.Tweet>;
-
-  xUsername: string;
 }
 
 export namespace StyleProfile {
@@ -155,7 +148,11 @@ export interface StyleProfileSummary {
 }
 
 export interface StyleListResponse {
+  hasMore: boolean;
+
   styles: Array<StyleProfileSummary>;
+
+  nextCursor?: string;
 }
 
 export interface StyleCompareResponse {
@@ -184,10 +181,12 @@ export namespace StyleGetPerformanceResponse {
 
     text: string;
 
-    createdAt?: string;
+    bookmarkCount?: number;
 
     likeCount?: number;
 
+    quoteCount?: number;
+
     replyCount?: number;
 
     retweetCount?: number;
@@ -198,14 +197,16 @@ export namespace StyleGetPerformanceResponse {
 
 export interface StyleUpdateParams {
   /**
-   * Display label for the style
+   * Array of tweet objects
    */
-  label: string;
+  tweets: Array<StyleUpdateParams.Tweet>;
 
   /**
-   * Array of tweet objects
+   * Optional display label of up to 50 characters. When sent, it must match the path
+   * ID, ignoring case and a leading @. When it is left out, the path ID names the
+   * style and must fit the same limit.
    */
-  tweets: Array<StyleUpdateParams.Tweet>;
+  label?: string;
 }
 
 export namespace StyleUpdateParams {
@@ -214,6 +215,20 @@ export namespace StyleUpdateParams {
   }
 }
 
+export interface StyleListParams {
+  /**
+   * Previous nextCursor. The after alias also works. Offset pagination is not
+   * supported.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+   * next page.
+   */
+  limit?: number;
+}
+
 export interface StyleAnalyzeParams {
   /**
    * X username to analyze
@@ -241,6 +256,7 @@ export declare namespace Styles {
     type StyleCompareResponse as StyleCompareResponse,
     type StyleGetPerformanceResponse as StyleGetPerformanceResponse,
     type StyleUpdateParams as StyleUpdateParams,
+    type StyleListParams as StyleListParams,
     type StyleAnalyzeParams as StyleAnalyzeParams,
     type StyleCompareParams as StyleCompareParams,
   };

package/src/resources/subscribe.ts

@@ -9,7 +9,7 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 export class Subscribe extends APIResource {
   /**

package/src/resources/support/index.ts

@@ -15,5 +15,6 @@ export {
   type TicketReplyResponse,
   type TicketCreateParams,
   type TicketUpdateParams,
+  type TicketListParams,
   type TicketReplyParams,
 } from './tickets';

package/src/resources/support/support.ts

@@ -11,6 +11,7 @@ import * as TicketsAPI from './tickets';
 import {
   TicketCreateParams,
   TicketCreateResponse,
+  TicketListParams,
   TicketListResponse,
   TicketReplyParams,
   TicketReplyResponse,
@@ -40,6 +41,7 @@ export declare namespace Support {
     type TicketReplyResponse as TicketReplyResponse,
     type TicketCreateParams as TicketCreateParams,
     type TicketUpdateParams as TicketUpdateParams,
+    type TicketListParams as TicketListParams,
     type TicketReplyParams as TicketReplyParams,
   };
 }

package/src/resources/support/tickets.ts

@@ -16,7 +16,7 @@ import { path } from '../../internal/utils/path';
  */
 export class Tickets extends APIResource {
   /**
-   * Create a support ticket
+   * Creates a support ticket with an initial message.
    *
    * @example
    * ```ts
@@ -45,7 +45,7 @@ export class Tickets extends APIResource {
   }
 
   /**
-   * Get ticket with all messages
+   * Returns one support ticket with its message history.
    *
    * @example
    * ```ts
@@ -59,7 +59,7 @@ export class Tickets extends APIResource {
   }
 
   /**
-   * Update ticket status
+   * Changes the open or closed state of a support ticket.
    *
    * @example
    * ```ts
@@ -74,19 +74,22 @@ export class Tickets extends APIResource {
   }
 
   /**
-   * List user's support tickets
+   * Returns support tickets owned by the authenticated user, latest activity first.
    *
    * @example
    * ```ts
    * const tickets = await client.support.tickets.list();
    * ```
    */
-  list(options?: RequestOptions): APIPromise<TicketListResponse> {
-    return this._client.get('/support/tickets', options);
+  list(
+    query: TicketListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<TicketListResponse> {
+    return this._client.get('/support/tickets', { query, ...options });
   }
 
   /**
-   * Reply to a support ticket
+   * Adds a message to an existing support ticket.
    *
    * @example
    * ```ts
@@ -115,6 +118,9 @@ export class Tickets extends APIResource {
   }
 }
 
+/**
+ * Support submission receipt.
+ */
 export interface TicketCreateResponse {
   attachments: Array<TicketCreateResponse.Attachment>;
 
@@ -202,7 +208,11 @@ export interface TicketUpdateResponse {
 }
 
 export interface TicketListResponse {
+  hasMore: boolean;
+
   tickets: Array<TicketListResponse.Ticket>;
+
+  nextCursor?: string;
 }
 
 export namespace TicketListResponse {
@@ -221,6 +231,9 @@ export namespace TicketListResponse {
   }
 }
 
+/**
+ * Support submission receipt.
+ */
 export interface TicketReplyResponse {
   attachments: Array<TicketReplyResponse.Attachment>;
 
@@ -240,12 +253,12 @@ export namespace TicketReplyResponse {
 
 export interface TicketCreateParams {
   /**
-   * Body param
+   * Body param: Non-empty support message text.
    */
   body: string;
 
   /**
-   * Body param
+   * Body param: Non-empty support ticket subject.
    */
   subject: string;
 
@@ -260,9 +273,23 @@ export interface TicketUpdateParams {
   status: 'open' | 'resolved' | 'closed';
 }
 
+export interface TicketListParams {
+  /**
+   * Previous nextCursor. The after alias also works. Offset pagination is not
+   * supported.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+   * next page.
+   */
+  limit?: number;
+}
+
 export interface TicketReplyParams {
   /**
-   * Body param
+   * Body param: Non-empty support message text.
    */
   body: string;
 
@@ -282,6 +309,7 @@ export declare namespace Tickets {
     type TicketReplyResponse as TicketReplyResponse,
     type TicketCreateParams as TicketCreateParams,
     type TicketUpdateParams as TicketUpdateParams,
+    type TicketListParams as TicketListParams,
     type TicketReplyParams as TicketReplyParams,
   };
 }

package/src/resources/trends.ts

@@ -13,7 +13,8 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Trends extends APIResource {
   /**
-   * Get trending hashtags and topics by region (alias)
+   * Returns current regional trends through the compatibility route. Each request
+   * costs 1 credit, however many trends it returns.
    */
   list(
     query: TrendListParams | null | undefined = {},
@@ -38,7 +39,7 @@ export namespace TrendListResponse {
     description?: string;
 
     /**
-     * Promotion identifier from X. Null for organic trends.
+     * Promotion ID for this trend, or null when organic.
      */
     promotedContent?: string | null;
 
@@ -47,12 +48,12 @@ export namespace TrendListResponse {
     rank?: number;
 
     /**
-     * Approximate public post volume when X supplies it.
+     * Estimated post volume for this trend.
      */
     tweetVolume?: number | null;
 
     /**
-     * X search URL for the trend.
+     * Search URL associated with this trend.
      */
     url?: string;
   }
@@ -65,7 +66,24 @@ export interface TrendListParams {
   count?: number;
 
   /**
-   * Region Yahoo WOEID code (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey)
+   * Fields to keep in each row, comma-separated. Use dots for nested fields, such as
+   * author.username. A list keeps the field in each item. Case & underscores do not
+   * matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
+   * always stay. An unknown name answers 400 unknown_field with the valid names,
+   * before any read. The price stays the same. SDK row types then hold only the
+   * named fields.
+   */
+  fields?: string;
+
+  /**
+   * Fields to drop from each row, comma-separated. It takes the same names as
+   * fields. With fields, it drops from the kept fields.
+   */
+  omit?: string;
+
+  /**
+   * The WOEID of any place X lists trends for (1=Worldwide, 23424977=US,
+   * 23424975=UK, 23424969=Turkey). List places with GET /x/trends/locations.
    */
   woeid?: number;
 }

package/src/resources/webhooks.ts

@@ -15,7 +15,7 @@ import { path } from '../internal/utils/path';
  */
 export class Webhooks extends APIResource {
   /**
-   * Create webhook
+   * Registers an endpoint for signed event deliveries.
    *
    * @example
    * ```ts
@@ -30,11 +30,12 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Update webhook
+   * Updates an endpoint, event selection, or delivery settings.
    *
    * @example
    * ```ts
    * const webhook = await client.webhooks.update('id', {
+   *   eventTypes: ['tweet.new'],
    *   isActive: true,
    *   url: 'https://example.com/webhook',
    * });
@@ -45,19 +46,44 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * List webhooks
+   * Returns configured webhook endpoints and delivery states.
    *
    * @example
    * ```ts
    * const webhooks = await client.webhooks.list();
    * ```
    */
-  list(options?: RequestOptions): APIPromise<WebhookListResponse> {
-    return this._client.get('/webhooks', options);
+  list(
+    query: WebhookListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookListResponse> {
+    return this._client.get('/webhooks', { query, ...options });
   }
 
   /**
-   * Deactivate webhook
+   * Returns a t.me link to @XquikBot that connects a Telegram chat to the account's
+   * monitor events. Opening it & pressing Start connects the chat, which then gets
+   * each event as a message. The link works once, within 15 minutes. The chat
+   * appears in the webhook list with the URL telegram:<chat ID>, with deliveries,
+   * retries & resume as any webhook. In the chat, /stop pauses its alerts. It costs
+   * no credits.
+   *
+   * @example
+   * ```ts
+   * const response = await client.webhooks.createTelegramLink({
+   *   eventTypes: ['tweet.new', 'tweet.reply'],
+   * });
+   * ```
+   */
+  createTelegramLink(
+    body: WebhookCreateTelegramLinkParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookCreateTelegramLinkResponse> {
+    return this._client.post('/webhooks/telegram', { body, ...options });
+  }
+
+  /**
+   * Stops future deliveries to the selected webhook.
    *
    * @example
    * ```ts
@@ -69,19 +95,23 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * List webhook deliveries
+   * Returns delivery attempts and response outcomes, newest first.
    *
    * @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);
+  listDeliveries(
+    id: string,
+    query: WebhookListDeliveriesParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<WebhookListDeliveriesResponse> {
+    return this._client.get(path`/webhooks/${id}/deliveries`, { query, ...options });
   }
 
   /**
-   * Test and resume webhook endpoint
+   * Tests the endpoint before resuming a manually paused webhook.
    *
    * @example
    * ```ts
@@ -93,7 +123,7 @@ export class Webhooks extends APIResource {
   }
 
   /**
-   * Test webhook endpoint
+   * Sends a signed test event to the configured endpoint.
    *
    * @example
    * ```ts
@@ -111,6 +141,9 @@ export class Webhooks extends APIResource {
 export interface Delivery {
   id: string;
 
+  /**
+   * Whole number from 0.
+   */
   attempts: number;
 
   createdAt: string;
@@ -140,8 +173,8 @@ export interface Webhook {
   createdAt: string;
 
   /**
-   * Endpoint delivery state. needs_attention means delivery stopped after repeated
-   * failures.
+   * Endpoint delivery state. paused means the user paused delivery. needs_attention
+   * marks repeated failures. Delivery attempts continue.
    */
   deliveryStatus: 'active' | 'paused' | 'needs_attention';
 
@@ -151,7 +184,7 @@ export interface Webhook {
   eventTypes: Array<Shared.EventType>;
 
   /**
-   * Consecutive delivery failures that pause the endpoint.
+   * Maximum reported failures before needs_attention. It does not pause delivery.
    */
   failureHardCap: number;
 
@@ -179,7 +212,23 @@ export interface WebhookCreateResponse {
 }
 
 export interface WebhookListResponse {
+  hasMore: boolean;
+
   webhooks: Array<Webhook>;
+
+  nextCursor?: string;
+}
+
+export interface WebhookCreateTelegramLinkResponse {
+  /**
+   * When the link stops working, 15 minutes on.
+   */
+  expiresAt: string;
+
+  /**
+   * Opens @XquikBot with the link's code.
+   */
+  url: string;
 }
 
 export interface WebhookDeactivateResponse {
@@ -188,6 +237,10 @@ export interface WebhookDeactivateResponse {
 
 export interface WebhookListDeliveriesResponse {
   deliveries: Array<Delivery>;
+
+  hasMore: boolean;
+
+  nextCursor?: string;
 }
 
 export interface WebhookResumeResponse {
@@ -216,7 +269,9 @@ export interface WebhookCreateParams {
   eventTypes: Array<Shared.EventType>;
 
   /**
-   * HTTPS URL
+   * HTTPS URL. A Discord channel webhook URL gets each event as a Discord message, &
+   * a Slack incoming webhook URL as a Slack message. To deliver to Telegram, use
+   * POST /webhooks/telegram instead.
    */
   url: string;
 }
@@ -232,17 +287,56 @@ export interface WebhookUpdateParams {
   url?: string;
 }
 
+export interface WebhookListParams {
+  /**
+   * Previous nextCursor. The after alias also works. Offset pagination is not
+   * supported.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
+   * next page.
+   */
+  limit?: number;
+}
+
+export interface WebhookCreateTelegramLinkParams {
+  /**
+   * Array of event types to subscribe to.
+   */
+  eventTypes?: Array<Shared.EventType>;
+}
+
+export interface WebhookListDeliveriesParams {
+  /**
+   * Previous nextCursor. The after alias also works. Offset pagination is not
+   * supported.
+   */
+  cursor?: string;
+
+  /**
+   * Maximum deliveries per page: 1 to 100, default 100. Pass nextCursor as cursor
+   * for the next page.
+   */
+  limit?: number;
+}
+
 export declare namespace Webhooks {
   export {
     type Delivery as Delivery,
     type Webhook as Webhook,
     type WebhookCreateResponse as WebhookCreateResponse,
     type WebhookListResponse as WebhookListResponse,
+    type WebhookCreateTelegramLinkResponse as WebhookCreateTelegramLinkResponse,
     type WebhookDeactivateResponse as WebhookDeactivateResponse,
     type WebhookListDeliveriesResponse as WebhookListDeliveriesResponse,
     type WebhookResumeResponse as WebhookResumeResponse,
     type WebhookTestResponse as WebhookTestResponse,
     type WebhookCreateParams as WebhookCreateParams,
     type WebhookUpdateParams as WebhookUpdateParams,
+    type WebhookListParams as WebhookListParams,
+    type WebhookCreateTelegramLinkParams as WebhookCreateTelegramLinkParams,
+    type WebhookListDeliveriesParams as WebhookListDeliveriesParams,
   };
 }

package/src/resources/x/account-connection-attempts.ts

@@ -10,7 +10,7 @@ import { path } from '../../internal/utils/path';
  */
 export class AccountConnectionAttempts extends APIResource {
   /**
-   * Get X account connection status
+   * Returns progress for an X account connection attempt.
    *
    * @example
    * ```ts