x-twitter-scraper 0.12.4 → 0.13.1

package/src/resources/styles.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';
@@ -15,7 +13,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 +25,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 +42,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 +72,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 +86,7 @@ export class Styles extends APIResource {
   }
 
   /**
-   * Compare two style profiles
+   * Compares language and engagement signals across two style profiles.
    *
    * @example
    * ```ts
@@ -102,7 +101,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 +116,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 +146,11 @@ export interface StyleProfileSummary {
 }
 
 export interface StyleListResponse {
+  hasMore: boolean;
+
   styles: Array<StyleProfileSummary>;
+
+  nextCursor?: string;
 }
 
 export interface StyleCompareResponse {
@@ -184,10 +179,12 @@ export namespace StyleGetPerformanceResponse {
 
     text: string;
 
-    createdAt?: string;
+    bookmarkCount?: number;
 
     likeCount?: number;
 
+    quoteCount?: number;
+
     replyCount?: number;
 
     retweetCount?: number;
@@ -198,14 +195,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 +213,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 +254,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

@@ -2,14 +2,12 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';
 
 /**
- * Subscription, billing, and usage balance
+ * Subscription, billing, and credits
  */
 export class Subscribe extends APIResource {
   /**

package/src/resources/support/attachments.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';

package/src/resources/support/index.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export { Attachments, type AttachmentDownloadParams } from './attachments';
 export { Support } from './support';
 export {
@@ -15,5 +13,6 @@ export {
   type TicketReplyResponse,
   type TicketCreateParams,
   type TicketUpdateParams,
+  type TicketListParams,
   type TicketReplyParams,
 } from './tickets';

package/src/resources/support/support.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 import { APIResource } from '../../core/resource';
 import * as AttachmentsAPI from './attachments';
 import { AttachmentDownloadParams, Attachments } from './attachments';
@@ -11,6 +9,7 @@ import * as TicketsAPI from './tickets';
 import {
   TicketCreateParams,
   TicketCreateResponse,
+  TicketListParams,
   TicketListResponse,
   TicketReplyParams,
   TicketReplyResponse,
@@ -40,6 +39,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

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';
@@ -16,7 +14,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 +43,7 @@ export class Tickets extends APIResource {
   }
 
   /**
-   * Get ticket with all messages
+   * Returns one support ticket with its message history.
    *
    * @example
    * ```ts
@@ -59,7 +57,7 @@ export class Tickets extends APIResource {
   }
 
   /**
-   * Update ticket status
+   * Changes the open or closed state of a support ticket.
    *
    * @example
    * ```ts
@@ -74,19 +72,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 +116,9 @@ export class Tickets extends APIResource {
   }
 }
 
+/**
+ * Support submission receipt.
+ */
 export interface TicketCreateResponse {
   attachments: Array<TicketCreateResponse.Attachment>;
 
@@ -202,7 +206,11 @@ export interface TicketUpdateResponse {
 }
 
 export interface TicketListResponse {
+  hasMore: boolean;
+
   tickets: Array<TicketListResponse.Ticket>;
+
+  nextCursor?: string;
 }
 
 export namespace TicketListResponse {
@@ -221,6 +229,9 @@ export namespace TicketListResponse {
   }
 }
 
+/**
+ * Support submission receipt.
+ */
 export interface TicketReplyResponse {
   attachments: Array<TicketReplyResponse.Attachment>;
 
@@ -240,12 +251,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 +271,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 +307,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/support.ts

@@ -2,6 +2,4 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
 export * from './support/index';

package/src/resources/trends.ts

@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-// 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';
@@ -13,7 +11,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 +37,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 +46,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 +64,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;
 }