x-twitter-scraper 0.4.1 → 0.5.0

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

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
 
@@ -16,11 +17,17 @@ export class Join extends APIResource {
    * ```ts
    * const join = await client.x.communities.join.create('id', {
    *   account: '@elonmusk',
+   *   'Idempotency-Key': 'Idempotency-Key',
    * });
    * ```
    */
-  create(id: string, body: JoinCreateParams, options?: RequestOptions): APIPromise<JoinCreateResponse> {
-    return this._client.post(path`/x/communities/${id}/join`, { body, ...options });
+  create(id: string, params: JoinCreateParams, options?: RequestOptions): APIPromise<JoinCreateResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post(path`/x/communities/${id}/join`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'Idempotency-Key': idempotencyKey }, options?.headers]),
+    });
   }
 
   /**
@@ -30,39 +37,541 @@ export class Join extends APIResource {
    * ```ts
    * const response = await client.x.communities.join.deleteAll(
    *   'id',
-   *   { account: '@elonmusk' },
+   *   {
+   *     account: '@elonmusk',
+   *     'Idempotency-Key': 'Idempotency-Key',
+   *   },
    * );
    * ```
    */
   deleteAll(
     id: string,
-    body: JoinDeleteAllParams,
+    params: JoinDeleteAllParams,
     options?: RequestOptions,
   ): APIPromise<JoinDeleteAllResponse> {
-    return this._client.delete(path`/x/communities/${id}/join`, { body, ...options });
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.delete(path`/x/communities/${id}/join`, {
+      body,
+      ...options,
+      headers: buildHeaders([{ 'Idempotency-Key': idempotencyKey }, options?.headers]),
+    });
   }
 }
 
+/**
+ * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
+ * the original Idempotency-Key returns this same record. Submit a new write only
+ * when safeToRetry is true, using a new key.
+ */
 export interface JoinCreateResponse {
-  success: true;
+  id: string;
+
+  /**
+   * Connected account selected for the write.
+   */
+  account: JoinCreateResponse.Account | null;
+
+  action:
+    | 'create_tweet'
+    | 'delete_tweet'
+    | 'like'
+    | 'unlike'
+    | 'retweet'
+    | 'unretweet'
+    | 'follow'
+    | 'unfollow'
+    | 'remove_follower'
+    | 'send_dm'
+    | 'upload_media'
+    | 'update_profile'
+    | 'update_avatar'
+    | 'update_banner'
+    | 'create_community'
+    | 'delete_community'
+    | 'join_community'
+    | 'leave_community';
+
+  /**
+   * plannedCredits is the approved maximum. chargedCredits comes from the settled
+   * credit ledger. Pending or failed writes are not charged.
+   */
+  billing: JoinCreateResponse.Billing;
+
+  charged: boolean;
+
+  chargedCredits: string;
+
+  /**
+   * Exact follow-up an API client or agent should perform.
+   */
+  nextAction: JoinCreateResponse.NextAction | null;
+
+  object: 'x_write_action';
+
+  pollAfterMs: number | null;
+
+  /**
+   * Stable fingerprint and sanitized payload for replay checks.
+   */
+  request: JoinCreateResponse.Request;
+
+  /**
+   * Confirmed result produced by the write, when available.
+   */
+  result: JoinCreateResponse.Result | null;
+
+  /**
+   * True only when a new attempt can reasonably succeed.
+   */
+  retryable: boolean;
+
+  /**
+   * True only when no write was dispatched and a new idempotency key may be used.
+   */
+  safeToRetry: boolean;
+
+  sendDispatched: boolean;
+
+  status: 'accepted' | 'dispatching' | 'pending_confirmation' | 'success' | 'failed' | 'expired';
+
+  statusUrl: string;
+
+  success: boolean;
+
+  /**
+   * Existing X resource targeted by the write, when applicable.
+   */
+  target: JoinCreateResponse.Target | null;
+
+  targetId: string | null;
+
+  terminal: boolean;
+
+  writeActionId: string;
+
+  /**
+   * Compatibility field for a confirmed community ID.
+   */
+  communityId?: string;
+
+  /**
+   * Confirmed community name when available.
+   */
+  communityName?: string;
+
+  completedAt?: string;
+
+  confirmationAttempts?: number;
+
+  confirmationCheckedAt?: string;
+
+  confirmedAt?: string;
+
+  createdAt?: string;
+
+  /**
+   * Structured recovery context for a failed write.
+   */
+  details?: { [key: string]: unknown };
+
+  error?: string;
+
+  /**
+   * Deadline for resolving a non-terminal write. This is not the Idempotency-Key
+   * retention deadline.
+   */
+  expiresAt?: string;
+
+  idempotent?: boolean;
+
+  /**
+   * Media count, kind, size, and billing details when used.
+   */
+  media?: { [key: string]: unknown };
+
+  /**
+   * Compatibility field for a confirmed media upload ID.
+   */
+  mediaId?: string;
+
+  /**
+   * Public media URL when the upload creates one.
+   */
+  mediaUrl?: string;
+
+  message?: string;
+
+  /**
+   * Compatibility field for a confirmed direct message ID.
+   */
+  messageId?: string;
+
+  requestHash?: string;
+
+  requestId?: string;
+
+  /**
+   * Compatibility result ID for other write actions.
+   */
+  resultId?: string;
+
+  /**
+   * Dispatch timestamp when the write reached execution.
+   */
+  sendDispatchedAt?: string;
+
+  /**
+   * Compatibility field for a confirmed tweet result ID.
+   */
+  tweetId?: string;
+
+  updatedAt?: string;
+}
+
+export namespace JoinCreateResponse {
+  /**
+   * Connected account selected for the write.
+   */
+  export interface Account {
+    id: string;
+
+    username: string;
+  }
+
+  /**
+   * plannedCredits is the approved maximum. chargedCredits comes from the settled
+   * credit ledger. Pending or failed writes are not charged.
+   */
+  export interface Billing {
+    charged: boolean;
+
+    chargedCredits: string;
+
+    plannedCredits: string;
+
+    status: 'not_charged' | 'pending' | 'charged' | 'charge_failed' | 'refunded';
+  }
+
+  /**
+   * Exact follow-up an API client or agent should perform.
+   */
+  export interface NextAction {
+    type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+
+    afterMs?: number;
+
+    requiresNewIdempotencyKey?: boolean;
+
+    url?: string;
+  }
+
+  /**
+   * Stable fingerprint and sanitized payload for replay checks.
+   */
+  export interface Request {
+    /**
+     * Stable hash of account, action, target, and payload.
+     */
+    hash: string | null;
+
+    /**
+     * Exact sanitized payload dispatched for this action.
+     */
+    payload: { [key: string]: unknown } | null;
+  }
+
+  /**
+   * Confirmed result produced by the write, when available.
+   */
+  export interface Result {
+    id?: string;
+
+    state?: string;
+
+    type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
+  }
+
+  /**
+   * Existing X resource targeted by the write, when applicable.
+   */
+  export interface Target {
+    id: string;
+
+    type: 'tweet' | 'user' | 'community';
+  }
 }
 
+/**
+ * Durable write lifecycle record. Poll statusUrl until terminal is true. Reusing
+ * the original Idempotency-Key returns this same record. Submit a new write only
+ * when safeToRetry is true, using a new key.
+ */
 export interface JoinDeleteAllResponse {
-  success: true;
+  id: string;
+
+  /**
+   * Connected account selected for the write.
+   */
+  account: JoinDeleteAllResponse.Account | null;
+
+  action:
+    | 'create_tweet'
+    | 'delete_tweet'
+    | 'like'
+    | 'unlike'
+    | 'retweet'
+    | 'unretweet'
+    | 'follow'
+    | 'unfollow'
+    | 'remove_follower'
+    | 'send_dm'
+    | 'upload_media'
+    | 'update_profile'
+    | 'update_avatar'
+    | 'update_banner'
+    | 'create_community'
+    | 'delete_community'
+    | 'join_community'
+    | 'leave_community';
+
+  /**
+   * plannedCredits is the approved maximum. chargedCredits comes from the settled
+   * credit ledger. Pending or failed writes are not charged.
+   */
+  billing: JoinDeleteAllResponse.Billing;
+
+  charged: boolean;
+
+  chargedCredits: string;
+
+  /**
+   * Exact follow-up an API client or agent should perform.
+   */
+  nextAction: JoinDeleteAllResponse.NextAction | null;
+
+  object: 'x_write_action';
+
+  pollAfterMs: number | null;
+
+  /**
+   * Stable fingerprint and sanitized payload for replay checks.
+   */
+  request: JoinDeleteAllResponse.Request;
+
+  /**
+   * Confirmed result produced by the write, when available.
+   */
+  result: JoinDeleteAllResponse.Result | null;
+
+  /**
+   * True only when a new attempt can reasonably succeed.
+   */
+  retryable: boolean;
+
+  /**
+   * True only when no write was dispatched and a new idempotency key may be used.
+   */
+  safeToRetry: boolean;
+
+  sendDispatched: boolean;
+
+  status: 'accepted' | 'dispatching' | 'pending_confirmation' | 'success' | 'failed' | 'expired';
+
+  statusUrl: string;
+
+  success: boolean;
+
+  /**
+   * Existing X resource targeted by the write, when applicable.
+   */
+  target: JoinDeleteAllResponse.Target | null;
+
+  targetId: string | null;
+
+  terminal: boolean;
+
+  writeActionId: string;
+
+  /**
+   * Compatibility field for a confirmed community ID.
+   */
+  communityId?: string;
+
+  /**
+   * Confirmed community name when available.
+   */
+  communityName?: string;
+
+  completedAt?: string;
+
+  confirmationAttempts?: number;
+
+  confirmationCheckedAt?: string;
+
+  confirmedAt?: string;
+
+  createdAt?: string;
+
+  /**
+   * Structured recovery context for a failed write.
+   */
+  details?: { [key: string]: unknown };
+
+  error?: string;
+
+  /**
+   * Deadline for resolving a non-terminal write. This is not the Idempotency-Key
+   * retention deadline.
+   */
+  expiresAt?: string;
+
+  idempotent?: boolean;
+
+  /**
+   * Media count, kind, size, and billing details when used.
+   */
+  media?: { [key: string]: unknown };
+
+  /**
+   * Compatibility field for a confirmed media upload ID.
+   */
+  mediaId?: string;
+
+  /**
+   * Public media URL when the upload creates one.
+   */
+  mediaUrl?: string;
+
+  message?: string;
+
+  /**
+   * Compatibility field for a confirmed direct message ID.
+   */
+  messageId?: string;
+
+  requestHash?: string;
+
+  requestId?: string;
+
+  /**
+   * Compatibility result ID for other write actions.
+   */
+  resultId?: string;
+
+  /**
+   * Dispatch timestamp when the write reached execution.
+   */
+  sendDispatchedAt?: string;
+
+  /**
+   * Compatibility field for a confirmed tweet result ID.
+   */
+  tweetId?: string;
+
+  updatedAt?: string;
+}
+
+export namespace JoinDeleteAllResponse {
+  /**
+   * Connected account selected for the write.
+   */
+  export interface Account {
+    id: string;
+
+    username: string;
+  }
+
+  /**
+   * plannedCredits is the approved maximum. chargedCredits comes from the settled
+   * credit ledger. Pending or failed writes are not charged.
+   */
+  export interface Billing {
+    charged: boolean;
+
+    chargedCredits: string;
+
+    plannedCredits: string;
+
+    status: 'not_charged' | 'pending' | 'charged' | 'charge_failed' | 'refunded';
+  }
+
+  /**
+   * Exact follow-up an API client or agent should perform.
+   */
+  export interface NextAction {
+    type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+
+    afterMs?: number;
+
+    requiresNewIdempotencyKey?: boolean;
+
+    url?: string;
+  }
+
+  /**
+   * Stable fingerprint and sanitized payload for replay checks.
+   */
+  export interface Request {
+    /**
+     * Stable hash of account, action, target, and payload.
+     */
+    hash: string | null;
+
+    /**
+     * Exact sanitized payload dispatched for this action.
+     */
+    payload: { [key: string]: unknown } | null;
+  }
+
+  /**
+   * Confirmed result produced by the write, when available.
+   */
+  export interface Result {
+    id?: string;
+
+    state?: string;
+
+    type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
+  }
+
+  /**
+   * Existing X resource targeted by the write, when applicable.
+   */
+  export interface Target {
+    id: string;
+
+    type: 'tweet' | 'user' | 'community';
+  }
 }
 
 export interface JoinCreateParams {
   /**
-   * X account identifier (@username or account ID)
+   * Body param: X account identifier (@username or account ID)
    */
   account: string;
+
+  /**
+   * Header param: Generate one unique value for each intended write. Reuse it only
+   * when retrying the exact same account, action, target, and payload. A reused key
+   * returns the original action. Reusing it with different input returns 409. Replay
+   * protection remains active for at least 90 days.
+   */
+  'Idempotency-Key': string;
 }
 
 export interface JoinDeleteAllParams {
   /**
-   * X account identifier (@username or account ID)
+   * Body param: X account identifier (@username or account ID)
    */
   account: string;
+
+  /**
+   * Header param: Generate one unique value for each intended write. Reuse it only
+   * when retrying the exact same account, action, target, and payload. A reused key
+   * returns the original action. Reusing it with different input returns 409. Replay
+   * protection remains active for at least 90 days.
+   */
+  'Idempotency-Key': string;
 }
 
 export declare namespace Join {