x-twitter-scraper 0.4.1 → 0.5.0

package/resources/x/dm.d.mts

@@ -22,11 +22,12 @@ export declare class Dm extends APIResource {
      * const response = await client.x.dm.send('userId', {
      *   account: '@elonmusk',
      *   text: 'Example text content',
+     *   'Idempotency-Key': 'Idempotency-Key',
      *   media_ids: ['1234567890123456789'],
      * });
      * ```
      */
-    send(userID: string, body: DmSendParams, options?: RequestOptions): APIPromise<DmSendResponse>;
+    send(userID: string, params: DmSendParams, options?: RequestOptions): APIPromise<DmSendResponse>;
 }
 export interface DmRetrieveHistoryResponse {
     has_next_page: boolean;
@@ -47,9 +48,176 @@ export declare namespace DmRetrieveHistoryResponse {
         text?: string;
     }
 }
+/**
+ * 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 DmSendResponse {
-    messageId: string;
-    success: true;
+    id: string;
+    /**
+     * Connected account selected for the write.
+     */
+    account: DmSendResponse.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: DmSendResponse.Billing;
+    charged: boolean;
+    chargedCredits: string;
+    /**
+     * Exact follow-up an API client or agent should perform.
+     */
+    nextAction: DmSendResponse.NextAction | null;
+    object: 'x_write_action';
+    pollAfterMs: number | null;
+    /**
+     * Stable fingerprint and sanitized payload for replay checks.
+     */
+    request: DmSendResponse.Request;
+    /**
+     * Confirmed result produced by the write, when available.
+     */
+    result: DmSendResponse.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: DmSendResponse.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 declare namespace DmSendResponse {
+    /**
+     * Connected account selected for the write.
+     */
+    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.
+     */
+    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.
+     */
+    interface NextAction {
+        type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        afterMs?: number;
+        requiresNewIdempotencyKey?: boolean;
+        url?: string;
+    }
+    /**
+     * Stable fingerprint and sanitized payload for replay checks.
+     */
+    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.
+     */
+    interface Result {
+        id?: string;
+        state?: string;
+        type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
+    }
+    /**
+     * Existing X resource targeted by the write, when applicable.
+     */
+    interface Target {
+        id: string;
+        type: 'tweet' | 'user' | 'community';
+    }
 }
 export interface DmRetrieveHistoryParams {
     /**
@@ -68,12 +236,22 @@ export interface DmRetrieveHistoryParams {
 }
 export interface DmSendParams {
     /**
-     * X account (@username or ID) sending the DM
+     * Body param: X account (@username or ID) sending the DM
      */
     account: string;
+    /**
+     * Body param
+     */
     text: string;
     /**
-     * Optional array containing exactly 1 uploaded media ID.
+     * 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;
+    /**
+     * Body param: Optional array containing exactly 1 uploaded media ID.
      */
     media_ids?: Array<string>;
 }

package/resources/x/dm.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"dm.d.mts","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAG/F;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,QAAQ,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}
+{"version":3,"file":"dm.d.mts","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAQjG;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,QAAQ,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAEvC,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;IAEhC,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE7C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,sBAAsB,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE/F,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IAErC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB,OAAO,EAAE,OAAO,CAAC;QAEjB,cAAc,EAAE,MAAM,CAAC;QAEvB,cAAc,EAAE,MAAM,CAAC;QAEvB,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,GAAG,UAAU,CAAC;KAC9E;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC;QAEzD,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC5C;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAC;KAC5E;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;KACtC;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}

package/resources/x/dm.d.ts

@@ -22,11 +22,12 @@ export declare class Dm extends APIResource {
      * const response = await client.x.dm.send('userId', {
      *   account: '@elonmusk',
      *   text: 'Example text content',
+     *   'Idempotency-Key': 'Idempotency-Key',
      *   media_ids: ['1234567890123456789'],
      * });
      * ```
      */
-    send(userID: string, body: DmSendParams, options?: RequestOptions): APIPromise<DmSendResponse>;
+    send(userID: string, params: DmSendParams, options?: RequestOptions): APIPromise<DmSendResponse>;
 }
 export interface DmRetrieveHistoryResponse {
     has_next_page: boolean;
@@ -47,9 +48,176 @@ export declare namespace DmRetrieveHistoryResponse {
         text?: string;
     }
 }
+/**
+ * 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 DmSendResponse {
-    messageId: string;
-    success: true;
+    id: string;
+    /**
+     * Connected account selected for the write.
+     */
+    account: DmSendResponse.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: DmSendResponse.Billing;
+    charged: boolean;
+    chargedCredits: string;
+    /**
+     * Exact follow-up an API client or agent should perform.
+     */
+    nextAction: DmSendResponse.NextAction | null;
+    object: 'x_write_action';
+    pollAfterMs: number | null;
+    /**
+     * Stable fingerprint and sanitized payload for replay checks.
+     */
+    request: DmSendResponse.Request;
+    /**
+     * Confirmed result produced by the write, when available.
+     */
+    result: DmSendResponse.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: DmSendResponse.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 declare namespace DmSendResponse {
+    /**
+     * Connected account selected for the write.
+     */
+    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.
+     */
+    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.
+     */
+    interface NextAction {
+        type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        afterMs?: number;
+        requiresNewIdempotencyKey?: boolean;
+        url?: string;
+    }
+    /**
+     * Stable fingerprint and sanitized payload for replay checks.
+     */
+    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.
+     */
+    interface Result {
+        id?: string;
+        state?: string;
+        type?: 'tweet' | 'direct_message' | 'media' | 'community' | 'state_change';
+    }
+    /**
+     * Existing X resource targeted by the write, when applicable.
+     */
+    interface Target {
+        id: string;
+        type: 'tweet' | 'user' | 'community';
+    }
 }
 export interface DmRetrieveHistoryParams {
     /**
@@ -68,12 +236,22 @@ export interface DmRetrieveHistoryParams {
 }
 export interface DmSendParams {
     /**
-     * X account (@username or ID) sending the DM
+     * Body param: X account (@username or ID) sending the DM
      */
     account: string;
+    /**
+     * Body param
+     */
     text: string;
     /**
-     * Optional array containing exactly 1 uploaded media ID.
+     * 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;
+    /**
+     * Body param: Optional array containing exactly 1 uploaded media ID.
      */
     media_ids?: Array<string>;
 }

package/resources/x/dm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dm.d.ts","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAG/F;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,QAAQ,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}
+{"version":3,"file":"dm.d.ts","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AAEpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE,qBAAa,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,uBAAuB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;CAQjG;AAED,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,OAAO,CAAC;IAEvB,QAAQ,EAAE,KAAK,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAEnD,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,UAAU,EAAE,MAAM,CAAC;QAEnB,QAAQ,EAAE,MAAM,CAAC;QAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAEvC,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;IAEhC,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,cAAc,CAAC,UAAU,GAAG,IAAI,CAAC;IAE7C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IAErB,cAAc,EAAE,OAAO,CAAC;IAExB,MAAM,EAAE,UAAU,GAAG,aAAa,GAAG,sBAAsB,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE/F,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,MAAM,GAAG,IAAI,CAAC;IAErC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,QAAQ,EAAE,OAAO,CAAC;IAElB,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAErC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB,OAAO,EAAE,OAAO,CAAC;QAEjB,cAAc,EAAE,MAAM,CAAC;QAEvB,cAAc,EAAE,MAAM,CAAC;QAEvB,MAAM,EAAE,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,eAAe,GAAG,UAAU,CAAC;KAC9E;IAED;;OAEG;IACH,UAAiB,UAAU;QACzB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,eAAe,GAAG,aAAa,CAAC;QAEzD,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;QAEpC,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;QAEpB;;WAEG;QACH,OAAO,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,GAAG,IAAI,CAAC;KAC5C;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,IAAI,CAAC,EAAE,OAAO,GAAG,gBAAgB,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAC;KAC5E;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB,EAAE,EAAE,MAAM,CAAC;QAEX,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,WAAW,CAAC;KACtC;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC3B;AAED,MAAM,CAAC,OAAO,WAAW,EAAE,CAAC;IAC1B,OAAO,EACL,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,YAAY,IAAI,YAAY,GAClC,CAAC;CACH"}

package/resources/x/dm.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dm = void 0;
 const resource_1 = require("../../core/resource.js");
+const headers_1 = require("../../internal/headers.js");
 const path_1 = require("../../internal/utils/path.js");
 class Dm extends resource_1.APIResource {
     /**
@@ -27,12 +28,18 @@ class Dm extends resource_1.APIResource {
      * const response = await client.x.dm.send('userId', {
      *   account: '@elonmusk',
      *   text: 'Example text content',
+     *   'Idempotency-Key': 'Idempotency-Key',
      *   media_ids: ['1234567890123456789'],
      * });
      * ```
      */
-    send(userID, body, options) {
-        return this._client.post((0, path_1.path) `/x/dm/${userID}`, { body, ...options });
+    send(userID, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post((0, path_1.path) `/x/dm/${userID}`, {
+            body,
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ 'Idempotency-Key': idempotencyKey }, options?.headers]),
+        });
     }
 }
 exports.Dm = Dm;

package/resources/x/dm.js.map

@@ -1 +1 @@
-{"version":3,"file":"dm.js","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,EAAG,SAAQ,sBAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAc,EACd,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAc,EAAE,IAAkB,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF;AAnCD,gBAmCC"}
+{"version":3,"file":"dm.js","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAElD,uDAAsD;AAEtD,uDAAiD;AAEjD,MAAa,EAAG,SAAQ,sBAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAc,EACd,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,SAAS,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAc,EAAE,MAAoB,EAAE,OAAwB;QACjE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,SAAS,MAAM,EAAE,EAAE;YAC9C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjF,CAAC,CAAC;IACL,CAAC;CACF;AAzCD,gBAyCC"}

package/resources/x/dm.mjs

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 import { APIResource } from "../../core/resource.mjs";
+import { buildHeaders } from "../../internal/headers.mjs";
 import { path } from "../../internal/utils/path.mjs";
 export class Dm extends APIResource {
     /**
@@ -24,12 +25,18 @@ export class Dm extends APIResource {
      * const response = await client.x.dm.send('userId', {
      *   account: '@elonmusk',
      *   text: 'Example text content',
+     *   'Idempotency-Key': 'Idempotency-Key',
      *   media_ids: ['1234567890123456789'],
      * });
      * ```
      */
-    send(userID, body, options) {
-        return this._client.post(path `/x/dm/${userID}`, { body, ...options });
+    send(userID, params, options) {
+        const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+        return this._client.post(path `/x/dm/${userID}`, {
+            body,
+            ...options,
+            headers: buildHeaders([{ 'Idempotency-Key': idempotencyKey }, options?.headers]),
+        });
     }
 }
 //# sourceMappingURL=dm.mjs.map

package/resources/x/dm.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"dm.mjs","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAGlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAc,EACd,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,MAAc,EAAE,IAAkB,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;CACF"}
+{"version":3,"file":"dm.mjs","sourceRoot":"","sources":["../../src/resources/x/dm.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAElD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AAEtD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD,MAAM,OAAO,EAAG,SAAQ,WAAW;IACjC;;;;;;;;;;OAUG;IACH,eAAe,CACb,MAAc,EACd,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,SAAS,MAAM,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,CAAC,MAAc,EAAE,MAAoB,EAAE,OAAwB;QACjE,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,SAAS,MAAM,EAAE,EAAE;YAC9C,IAAI;YACJ,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,iBAAiB,EAAE,cAAc,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SACjF,CAAC,CAAC;IACL,CAAC;CACF"}