x-twitter-scraper 0.6.1 → 0.8.0

package/src/resources/support/tickets.ts

@@ -133,28 +133,28 @@ export namespace TicketCreateResponse {
 }
 
 export interface TicketRetrieveResponse {
-  createdAt?: string;
+  createdAt: string;
 
-  messages?: Array<TicketRetrieveResponse.Message>;
+  messages: Array<TicketRetrieveResponse.Message>;
 
-  publicId?: string;
+  publicId: string;
 
-  status?: string;
+  status: 'open' | 'in_progress' | 'resolved' | 'closed';
 
-  subject?: string;
+  subject: string;
 
-  updatedAt?: string;
+  updatedAt: string;
 }
 
 export namespace TicketRetrieveResponse {
   export interface Message {
-    attachments?: Array<Message.Attachment>;
+    attachments: Array<Message.Attachment>;
 
-    body?: string;
+    body: string;
 
-    createdAt?: string;
+    createdAt: string;
 
-    sender?: string;
+    sender: 'user' | 'support' | 'system';
   }
 
   export namespace Message {
@@ -196,28 +196,28 @@ export namespace TicketRetrieveResponse {
 }
 
 export interface TicketUpdateResponse {
-  publicId?: string;
+  publicId: string;
 
-  status?: string;
+  status: 'open' | 'resolved' | 'closed';
 }
 
 export interface TicketListResponse {
-  tickets?: Array<TicketListResponse.Ticket>;
+  tickets: Array<TicketListResponse.Ticket>;
 }
 
 export namespace TicketListResponse {
   export interface Ticket {
-    createdAt?: string;
+    createdAt: string;
 
-    messageCount?: number;
+    messageCount: number;
 
-    publicId?: string;
+    publicId: string;
 
-    status?: string;
+    status: 'open' | 'in_progress' | 'resolved' | 'closed';
 
-    subject?: string;
+    subject: string;
 
-    updatedAt?: string;
+    updatedAt: string;
   }
 }
 

package/src/resources/trends.ts

@@ -37,9 +37,24 @@ export namespace TrendListResponse {
 
     description?: string;
 
+    /**
+     * Promotion identifier from X. Null for organic trends.
+     */
+    promotedContent?: string | null;
+
     query?: string;
 
     rank?: number;
+
+    /**
+     * Approximate public post volume when X supplies it.
+     */
+    tweetVolume?: number | null;
+
+    /**
+     * X search URL for the trend.
+     */
+    url?: string;
   }
 }
 

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

@@ -0,0 +1,100 @@
+// 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 AccountConnectionAttempts extends APIResource {
+  /**
+   * Get X account connection status
+   *
+   * @example
+   * ```ts
+   * const accountConnectionAttempt =
+   *   await client.x.accountConnectionAttempts.retrieve(
+   *     'xatt_0123456789abcdef0123456789abcdef',
+   *   );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<AccountConnectionAttemptRetrieveResponse> {
+    return this._client.get(path`/x/account-connection-attempts/${id}`, options);
+  }
+}
+
+/**
+ * The connection is still in progress.
+ */
+export type AccountConnectionAttemptRetrieveResponse =
+  | AccountConnectionAttemptRetrieveResponse.XAccountConnectionAttemptPending
+  | AccountConnectionAttemptRetrieveResponse.XAccountConnectionAttemptSuccess
+  | AccountConnectionAttemptRetrieveResponse.XAccountConnectionAttemptFailed
+  | AccountConnectionAttemptRetrieveResponse.XAccountConnectionChallenge;
+
+export namespace AccountConnectionAttemptRetrieveResponse {
+  /**
+   * The connection is still in progress.
+   */
+  export interface XAccountConnectionAttemptPending {
+    id: string;
+
+    object: 'x_account_connection_attempt';
+
+    pollAfterMs: number;
+
+    status: 'pending';
+  }
+
+  /**
+   * The account connected successfully.
+   */
+  export interface XAccountConnectionAttemptSuccess {
+    id: string;
+
+    object: 'x_account_connection_attempt';
+
+    status: 'success';
+  }
+
+  /**
+   * The connection reached a final failure.
+   */
+  export interface XAccountConnectionAttemptFailed {
+    id: string;
+
+    error: string;
+
+    object: 'x_account_connection_attempt';
+
+    retryable: boolean;
+
+    status: 'failed';
+
+    reason?: string;
+  }
+
+  /**
+   * Resumable account connection challenge. Submit the email code to finish the same
+   * connection attempt.
+   */
+  export interface XAccountConnectionChallenge {
+    id: string;
+
+    expiresAt: string;
+
+    message: string;
+
+    object: 'x_account_connection_challenge';
+
+    status: 'requires_email_code';
+
+    username: string;
+  }
+}
+
+export declare namespace AccountConnectionAttempts {
+  export { type AccountConnectionAttemptRetrieveResponse as AccountConnectionAttemptRetrieveResponse };
+}

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

@@ -43,7 +43,7 @@ export interface AccountConnectionChallengeSubmitResponse {
 
   health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';
 
-  status: string;
+  status: 'active';
 
   xUserId: string;
 

package/src/resources/x/accounts.ts

@@ -21,8 +21,8 @@ export class Accounts extends APIResource {
    * const account = await client.x.accounts.create({
    *   email: 'account@example.invalid',
    *   password: '<ACCOUNT_PASSWORD>',
-   *   username: 'your_x_username',
    *   totp_secret: '<TOTP_SECRET>',
+   *   username: 'your_x_username',
    * });
    * ```
    */
@@ -107,11 +107,11 @@ export interface XAccount {
   createdAt: string;
 
   /**
-   * Derived connection health. `healthy` = session active. `needsReauth` = user must
+   * Derived connection health. `healthy` = ready to use. `needsReauth` = user must
    * submit fresh credentials. `locked` = X locked the account; unlock on x.com
-   * first. `suspended` = X banned the account. `recovering` = past cooldown, will
-   * auto-retry on next use. `temporaryIssue` = temporary connection problem; retry
-   * shortly.
+   * first. `suspended` = X banned the account. `recovering` = cooldown ended; the
+   * account can reconnect on its next use. `temporaryIssue` = temporary connection
+   * problem; wait before the next use.
    */
   health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';
 
@@ -150,18 +150,59 @@ export interface XAccountDetail {
 /**
  * Sanitized X account summary returned by connect and reauth.
  */
-export interface AccountCreateResponse {
-  id: string;
+export type AccountCreateResponse =
+  | AccountCreateResponse.SanitizedXAccount
+  | AccountCreateResponse.XAccountConnectionAttemptPending
+  | AccountCreateResponse.XAccountConnectionChallenge;
 
-  createdAt: string;
+export namespace AccountCreateResponse {
+  /**
+   * Sanitized X account summary returned by connect and reauth.
+   */
+  export interface SanitizedXAccount {
+    id: string;
 
-  health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';
+    createdAt: string;
 
-  status: string;
+    health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';
 
-  xUserId: string;
+    status: 'active';
 
-  xUsername: string;
+    xUserId: string;
+
+    xUsername: string;
+  }
+
+  /**
+   * The connection is still in progress.
+   */
+  export interface XAccountConnectionAttemptPending {
+    id: string;
+
+    object: 'x_account_connection_attempt';
+
+    pollAfterMs: number;
+
+    status: 'pending';
+  }
+
+  /**
+   * Resumable account connection challenge. Submit the email code to finish the same
+   * connection attempt.
+   */
+  export interface XAccountConnectionChallenge {
+    id: string;
+
+    expiresAt: string;
+
+    message: string;
+
+    object: 'x_account_connection_challenge';
+
+    status: 'requires_email_code';
+
+    username: string;
+  }
 }
 
 export interface AccountListResponse {
@@ -189,7 +230,7 @@ export interface AccountReauthResponse {
 
   health: 'healthy' | 'locked' | 'needsReauth' | 'recovering' | 'suspended' | 'temporaryIssue';
 
-  status: string;
+  status: 'active';
 
   xUserId: string;
 
@@ -208,14 +249,14 @@ export interface AccountCreateParams {
   password: string;
 
   /**
-   * X username
+   * Authenticator App TOTP secret required for durable login
    */
-  username: string;
+  totp_secret: string;
 
   /**
-   * TOTP secret for 2FA
+   * X username
    */
-  totp_secret?: string;
+  username: string;
 }
 
 export interface AccountReauthParams {
@@ -230,7 +271,7 @@ export interface AccountReauthParams {
   email?: string;
 
   /**
-   * TOTP secret for 2FA re-authentication
+   * Replacement Authenticator App TOTP secret. Omit it to reuse the saved secret.
    */
   totp_secret?: string;
 }

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

@@ -665,11 +665,6 @@ export namespace CommunityRetrieveInfoResponse {
      */
     invites_policy?: string;
 
-    /**
-     * Whether the authenticated viewer is a member
-     */
-    is_member?: boolean;
-
     /**
      * Whether the community is marked sensitive
      */
@@ -700,11 +695,6 @@ export namespace CommunityRetrieveInfoResponse {
      */
     primary_topic?: Community.PrimaryTopic;
 
-    /**
-     * Authenticated viewer's community role
-     */
-    role?: string;
-
     /**
      * Community rules
      */
@@ -824,10 +814,8 @@ export interface CommunityRetrieveSearchParams {
   cursor?: string;
 
   /**
-   * Maximum items requested from this page (1-100, default 20). The response can
-   * contain fewer items because the source returned fewer, filters removed items, or
-   * the available usage balance covers fewer results. Keep requesting next_cursor while
-   * has_next_page is true, even when a page is empty. The deprecated limit and count
+   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+   * results. Continue while has_next_page is true. Deprecated limit and count
    * aliases remain accepted.
    */
   pageSize?: number;

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

@@ -65,10 +65,8 @@ export interface TweetListParams {
   cursor?: string;
 
   /**
-   * Maximum items requested from this page (1-100, default 20). The response can
-   * contain fewer items because the source returned fewer, filters removed items, or
-   * the available usage balance covers fewer results. Keep requesting next_cursor while
-   * has_next_page is true, even when a page is empty. The deprecated limit and count
+   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+   * results. Continue while has_next_page is true. Deprecated limit and count
    * aliases remain accepted.
    */
   pageSize?: number;
@@ -86,10 +84,8 @@ export interface TweetListByCommunityParams {
   cursor?: string;
 
   /**
-   * Maximum items requested from this page (1-100, default 20). The response can
-   * contain fewer items because the source returned fewer, filters removed items, or
-   * the available usage balance covers fewer results. Keep requesting next_cursor while
-   * has_next_page is true, even when a page is empty. The deprecated limit and count
+   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+   * results. Continue while has_next_page is true. Deprecated limit and count
    * aliases remain accepted.
    */
   pageSize?: number;

package/src/resources/x/index.ts

@@ -4,6 +4,10 @@
 
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export {
+  AccountConnectionAttempts,
+  type AccountConnectionAttemptRetrieveResponse,
+} from './account-connection-attempts';
 export {
   AccountConnectionChallenges,
   type AccountConnectionChallengeSubmitResponse,
@@ -70,6 +74,7 @@ export {
   type TweetCreateResponse,
   type TweetRetrieveResponse,
   type TweetDeleteResponse,
+  type TweetGetRepliesResponse,
   type TweetCreateParams,
   type TweetListParams,
   type TweetDeleteParams,

package/src/resources/x/lists.ts

@@ -107,10 +107,8 @@ export interface ListRetrieveTweetsParams {
   includeReplies?: boolean;
 
   /**
-   * Maximum items requested from this page (1-100, default 20). The response can
-   * contain fewer items because the source returned fewer, filters removed items, or
-   * the available usage balance covers fewer results. Keep requesting next_cursor while
-   * has_next_page is true, even when a page is empty. The deprecated limit and count
+   * Maximum page items (1-100, default 20). Source, filters, or credits can reduce
+   * results. Continue while has_next_page is true. Deprecated limit and count
    * aliases remain accepted.
    */
   pageSize?: number;

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

@@ -25,6 +25,7 @@ export {
   type TweetCreateResponse,
   type TweetRetrieveResponse,
   type TweetDeleteResponse,
+  type TweetGetRepliesResponse,
   type TweetCreateParams,
   type TweetListParams,
   type TweetDeleteParams,