x-twitter-scraper 0.12.4 → 0.13.0

package/resources/x/users/users.mjs

@@ -13,18 +13,18 @@ export class Users extends APIResource {
         this.follow = new FollowAPI.Follow(this._client);
     }
     /**
-     * Get user profile with follower counts and verification
+     * Returns one public profile with counts and verification details.
      *
      * @example
      * ```ts
      * const userProfile = await client.x.users.retrieve('id');
      * ```
      */
-    retrieve(id, options) {
-        return this._client.get(path `/x/users/${id}`, options);
+    retrieve(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}`, { query, ...options });
     }
     /**
-     * Remove follower
+     * Removes a follower from a connected X account.
      *
      * @example
      * ```ts
@@ -43,20 +43,74 @@ export class Users extends APIResource {
         });
     }
     /**
-     * Look up multiple users by IDs in one call
+     * Returns the accounts an organization lists as its affiliates, in X's order. An
+     * account without affiliates returns an empty list.
      *
      * @example
      * ```ts
-     * const response = await client.x.users.retrieveBatch({
-     *   ids: 'ids',
-     * });
+     * const paginatedUsers =
+     *   await client.x.users.retrieveAffiliates('id');
+     * ```
+     */
+    retrieveAffiliates(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/affiliates`, { query, ...options });
+    }
+    /**
+     * Returns the posts on the user's Articles tab, newest first. Each post's
+     * `article` holds the Article's ID, title, preview, cover & dates. Read the full
+     * text with GET /x/articles/{tweetId}.
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets =
+     *   await client.x.users.retrieveArticles('id');
      * ```
      */
-    retrieveBatch(query, options) {
+    retrieveArticles(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/articles`, { query, ...options });
+    }
+    /**
+     * Returns public profiles for up to 100 user IDs, usernames or profile links. Send
+     * ids or usernames, not both. Each returned profile costs 1 credit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveBatch();
+     * ```
+     */
+    retrieveBatch(query = {}, options) {
         return this._client.get('/x/users/batch', { query, ...options });
     }
     /**
-     * List followers of a user
+     * Returns the newest posts of up to 20 users, named by user ID, username or
+     * profile link, in the order named. Send ids or usernames, not both. Each post
+     * costs 1 credit. A user in unavailable_ids or unprocessed_ids costs nothing.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveBatchTweets();
+     * ```
+     */
+    retrieveBatchTweets(query = {}, options) {
+        return this._client.get('/x/users/batch/tweets', { query, ...options });
+    }
+    /**
+     * Returns the user IDs of the selected user's followers, newest first, up to 5,000
+     * a page. Use it when you need IDs only. Each ID costs 1 credit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveFollowerIds(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveFollowerIds(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/follower-ids`, { query, ...options });
+    }
+    /**
+     * Returns public follower profiles for the selected user, newest first. x.com puts
+     * some promoted followers first; Xquik doesn't.
      *
      * @example
      * ```ts
@@ -69,7 +123,7 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/followers`, { query, ...options });
     }
     /**
-     * List mutual followers between you and a user
+     * Mutuals your X account sees, else 424 `account_required`.
      *
      * @example
      * ```ts
@@ -81,7 +135,7 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/followers-you-know`, { query, ...options });
     }
     /**
-     * List accounts a user follows
+     * Returns public profiles followed by the selected user.
      *
      * @example
      * ```ts
@@ -94,7 +148,50 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/following`, { query, ...options });
     }
     /**
-     * List tweets liked by a user
+     * Returns the user IDs of the accounts the selected user follows, newest first, up
+     * to 5,000 a page. Use it when you need IDs only. Each ID costs 1 credit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveFollowingIds(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveFollowingIds(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/following-ids`, { query, ...options });
+    }
+    /**
+     * Returns the posts on the user's Highlights tab, in X's order. An account without
+     * highlights returns an empty list.
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets =
+     *   await client.x.users.retrieveHighlights('id');
+     * ```
+     */
+    retrieveHighlights(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/highlights`, { query, ...options });
+    }
+    /**
+     * Returns engagement insights for one profile: engagement rate, averages per post
+     * and posting rate, from its counts and its last 20 posts. Reposts and the pinned
+     * post stay out of the averages. Each report costs 1 credit, whatever it reads.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveInsights(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveInsights(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/insights`, { query, ...options });
+    }
+    /**
+     * Your X account's likes, else 424 `account_required`. Others' likes get 424
+     * `likes_unavailable`.
      *
      * @example
      * ```ts
@@ -107,7 +204,46 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/likes`, { query, ...options });
     }
     /**
-     * List media tweets posted by a user
+     * Returns the public X Lists that include the selected user, as the profile's List
+     * memberships page shows them. Each List costs 1 credit. A protected account
+     * answers 403.
+     *
+     * @example
+     * ```ts
+     * const response =
+     *   await client.x.users.retrieveListMemberships('id');
+     * ```
+     */
+    retrieveListMemberships(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/list-memberships`, { query, ...options });
+    }
+    /**
+     * Returns the public X Lists the selected user created, in X's order, as the
+     * profile's Lists tab shows them. Each List costs 1 credit. A protected account
+     * answers 403.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveLists('id');
+     * ```
+     */
+    retrieveLists(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/lists`, { query, ...options });
+    }
+    /**
+     * Says whether one user is broadcasting live video on X right now, with their
+     * latest broadcast, live or ended. Each check costs 1 credit.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.retrieveLive('id');
+     * ```
+     */
+    retrieveLive(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/live`, { query, ...options });
+    }
+    /**
+     * Returns public media posts from the selected user.
      *
      * @example
      * ```ts
@@ -120,7 +256,7 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/media`, { query, ...options });
     }
     /**
-     * List tweets mentioning a user
+     * Returns public posts mentioning the selected user.
      *
      * @example
      * ```ts
@@ -132,9 +268,9 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/mentions`, { query, ...options });
     }
     /**
-     * Returns target-authored posts and replies. Omit mode for automatic maximum
-     * coverage. Pass next_cursor unchanged. Unprefixed cursors stay legacy. Excludes
-     * other-author context.
+     * Returns target-authored posts & replies, without other authors' context. Omit
+     * mode for automatic maximum coverage. Pass next_cursor unchanged; unprefixed
+     * cursors are legacy. It never opens with the pinned tweet.
      *
      * @example
      * ```ts
@@ -146,7 +282,7 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/replies`, { query, ...options });
     }
     /**
-     * Search users by name or username
+     * Returns public profiles matching a name or username.
      *
      * @example
      * ```ts
@@ -159,8 +295,40 @@ export class Users extends APIResource {
         return this._client.get('/x/users/search', { query, ...options });
     }
     /**
-     * Omit mode for automatic maximum coverage. Pass next_cursor unchanged. Unprefixed
-     * cursors use legacy pagination. Shape and billing stay the same.
+     * Returns the public accounts X lists as similar to the selected user, in X's
+     * order. X can list slightly different accounts on each call. Each account costs 1
+     * credit.
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers = await client.x.users.retrieveSimilar(
+     *   'id',
+     * );
+     * ```
+     */
+    retrieveSimilar(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/similar`, { query, ...options });
+    }
+    /**
+     * Returns the creators the selected user subscribes to, in X's order. An account
+     * that hides its subscriptions returns an empty list.
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveSubscriptions('id');
+     * ```
+     */
+    retrieveSubscriptions(id, query = {}, options) {
+        return this._client.get(path `/x/users/${id}/subscriptions`, { query, ...options });
+    }
+    /**
+     * For the newest posts of 2 to 20 users, use getBatchUserTweets. For more, use
+     * createExtraction with tweet_search_extractor & targetUsernames. Omit mode for
+     * automatic maximum coverage. Pass next_cursor unchanged; unprefixed cursors are
+     * legacy. The first page opens with the pinned tweet, flagged isPinned, unless
+     * replies are included. Rows stay newest first. x.com's Posts tab groups
+     * self-threads & hides reposts; retweets=exclude drops reposts.
      *
      * @example
      * ```ts
@@ -173,7 +341,7 @@ export class Users extends APIResource {
         return this._client.get(path `/x/users/${id}/tweets`, { query, ...options });
     }
     /**
-     * List verified followers of a user
+     * Returns verified public profiles following the selected user.
      *
      * @example
      * ```ts
@@ -184,6 +352,21 @@ export class Users extends APIResource {
     retrieveVerifiedFollowers(id, query = {}, options) {
         return this._client.get(path `/x/users/${id}/verified-followers`, { query, ...options });
     }
+    /**
+     * Returns X's own translation of one profile's bio into the language you pick,
+     * with the links, mentions, and tags X places in the translated text. A profile
+     * without a bio returns translation null & a message, free of charge.
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.translateBio('id', {
+     *   language: 'es',
+     * });
+     * ```
+     */
+    translateBio(id, query, options) {
+        return this._client.get(path `/x/users/${id}/translation`, { query, ...options });
+    }
 }
 Users.Follow = Follow;
 //# sourceMappingURL=users.mjs.map

package/resources/x/users/users.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../../src/resources/x/users/users.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,MAAM,GAKP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAwOhE,CAAC;IAtOC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,kBAAkB,EAAE;YAC7D,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;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,KAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CACtB,EAAU,EACV,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,cAAc,CACZ,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,yBAAyB,CACvB,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;CACF;AA0sED,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC"}
+{"version":3,"file":"users.mjs","sourceRoot":"","sources":["../../../src/resources/x/users/users.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAErD,OAAO,KAAK,SAAS,qBAAiB;AACtC,OAAO,EACL,MAAM,GAKP,qBAAiB;AAElB,OAAO,EAAE,YAAY,EAAE,sCAAkC;AAEzD,OAAO,EAAE,IAAI,EAAE,yCAAqC;AAEpD,MAAM,OAAO,KAAM,SAAQ,WAAW;IAAtC;;QACE,WAAM,GAAqB,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmehE,CAAC;IAjeC;;;;;;;OAOG;IACH,QAAQ,CACN,EAAU,EACV,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,cAAc,CACZ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,MAAM,EAAE,iBAAiB,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,kBAAkB,EAAE;YAC7D,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;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAChB,EAAU,EACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;OAUG;IACH,gBAAgB,CACd,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa,CACX,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;OASG;IACH,mBAAmB,CACjB,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;OAUG;IACH,mBAAmB,CACjB,EAAU,EACV,QAA0D,EAAE,EAC5D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,eAAe,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;;;OAUG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;OAQG;IACH,wBAAwB,CACtB,EAAU,EACV,QAA+D,EAAE,EACjE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;OASG;IACH,iBAAiB,CACf,EAAU,EACV,QAAwD,EAAE,EAC1D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,oBAAoB,CAClB,EAAU,EACV,QAA2D,EAAE,EAC7D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;OASG;IACH,kBAAkB,CAChB,EAAU,EACV,QAAyD,EAAE,EAC3D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,aAAa,CACX,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;OAUG;IACH,uBAAuB,CACrB,EAAU,EACV,QAA8D,EAAE,EAChE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,mBAAmB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,YAAY,CACV,EAAU,EACV,QAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;;;;;OASG;IACH,aAAa,CACX,EAAU,EACV,QAAoD,EAAE,EACtD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAU,EACV,QAAuD,EAAE,EACzD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;;;;OAUG;IACH,eAAe,CACb,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,cAAc,CACZ,KAA+B,EAC/B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;OAWG;IACH,eAAe,CACb,EAAU,EACV,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,UAAU,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;OASG;IACH,qBAAqB,CACnB,EAAU,EACV,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,gBAAgB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,cAAc,CACZ,EAAU,EACV,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;OAQG;IACH,yBAAyB,CACvB,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CACV,EAAU,EACV,KAA6B,EAC7B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;CACF;AA+kKD,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC"}

package/resources/x/write-actions.d.mts

@@ -6,7 +6,7 @@ import { RequestOptions } from "../../internal/request-options.mjs";
  */
 export declare class WriteActions extends APIResource {
     /**
-     * Get write action status
+     * Returns the current state of an asynchronous write action.
      *
      * @example
      * ```ts
@@ -18,9 +18,9 @@ export declare class WriteActions extends APIResource {
     retrieve(id: string, options?: RequestOptions): APIPromise<WriteActionRetrieveResponse>;
 }
 /**
- * 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.
+ * Durable write record. Poll statusUrl until terminal is true. Reusing its
+ * Idempotency-Key returns this record. Create another action only when safeToRetry
+ * is true.
  */
 export interface WriteActionRetrieveResponse {
     id: string;
@@ -28,7 +28,7 @@ export interface WriteActionRetrieveResponse {
      * Connected account selected for the write.
      */
     account: WriteActionRetrieveResponse.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';
+    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'delete_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.
@@ -55,7 +55,7 @@ export interface WriteActionRetrieveResponse {
      */
     retryable: boolean;
     /**
-     * True only when no write was dispatched and a new idempotency key may be used.
+     * True only when X did not get the write and a new idempotency key may be used.
      */
     safeToRetry: boolean;
     sendDispatched: boolean;
@@ -94,6 +94,10 @@ export interface WriteActionRetrieveResponse {
      * retention deadline.
      */
     expiresAt?: string;
+    /**
+     * True when this answers a retry of an earlier request with the same
+     * Idempotency-Key.
+     */
     idempotent?: boolean;
     /**
      * Media count, kind, size, and billing details when used.
@@ -153,6 +157,9 @@ export declare namespace WriteActionRetrieveResponse {
      */
     interface NextAction {
         type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        /**
+         * Milliseconds to wait before you poll or retry.
+         */
         afterMs?: number;
         requiresNewIdempotencyKey?: boolean;
         url?: string;

package/resources/x/write-actions.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"write-actions.d.mts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,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,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;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,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,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,2BAA2B,CAAC;IAC3C;;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,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"write-actions.d.mts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;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,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,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;;;OAGG;IACH,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,2BAA2B,CAAC;IAC3C;;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;;WAEG;QACH,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,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/x/write-actions.d.ts

@@ -6,7 +6,7 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class WriteActions extends APIResource {
     /**
-     * Get write action status
+     * Returns the current state of an asynchronous write action.
      *
      * @example
      * ```ts
@@ -18,9 +18,9 @@ export declare class WriteActions extends APIResource {
     retrieve(id: string, options?: RequestOptions): APIPromise<WriteActionRetrieveResponse>;
 }
 /**
- * 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.
+ * Durable write record. Poll statusUrl until terminal is true. Reusing its
+ * Idempotency-Key returns this record. Create another action only when safeToRetry
+ * is true.
  */
 export interface WriteActionRetrieveResponse {
     id: string;
@@ -28,7 +28,7 @@ export interface WriteActionRetrieveResponse {
      * Connected account selected for the write.
      */
     account: WriteActionRetrieveResponse.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';
+    action: 'create_tweet' | 'delete_tweet' | 'like' | 'unlike' | 'retweet' | 'unretweet' | 'follow' | 'unfollow' | 'remove_follower' | 'send_dm' | 'delete_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.
@@ -55,7 +55,7 @@ export interface WriteActionRetrieveResponse {
      */
     retryable: boolean;
     /**
-     * True only when no write was dispatched and a new idempotency key may be used.
+     * True only when X did not get the write and a new idempotency key may be used.
      */
     safeToRetry: boolean;
     sendDispatched: boolean;
@@ -94,6 +94,10 @@ export interface WriteActionRetrieveResponse {
      * retention deadline.
      */
     expiresAt?: string;
+    /**
+     * True when this answers a retry of an earlier request with the same
+     * Idempotency-Key.
+     */
     idempotent?: boolean;
     /**
      * Media count, kind, size, and billing details when used.
@@ -153,6 +157,9 @@ export declare namespace WriteActionRetrieveResponse {
      */
     interface NextAction {
         type: 'poll' | 'retry' | 'verify_result' | 'fix_request';
+        /**
+         * Milliseconds to wait before you poll or retry.
+         */
         afterMs?: number;
         requiresNewIdempotencyKey?: boolean;
         url?: string;

package/resources/x/write-actions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"write-actions.d.ts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,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,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;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,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,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,2BAA2B,CAAC;IAC3C;;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,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}
+{"version":3,"file":"write-actions.d.ts","sourceRoot":"","sources":["../../src/resources/x/write-actions.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,2BAA2B,CAAC;CAGxF;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,GAAG,IAAI,CAAC;IAEpD,MAAM,EACF,cAAc,GACd,cAAc,GACd,MAAM,GACN,QAAQ,GACR,SAAS,GACT,WAAW,GACX,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,SAAS,GACT,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,eAAe,GACf,eAAe,GACf,kBAAkB,GAClB,kBAAkB,GAClB,gBAAgB,GAChB,iBAAiB,CAAC;IAEtB;;;OAGG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C,OAAO,EAAE,OAAO,CAAC;IAEjB,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,2BAA2B,CAAC,UAAU,GAAG,IAAI,CAAC;IAE1D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,2BAA2B,CAAC,OAAO,CAAC;IAE7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD;;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,2BAA2B,CAAC,MAAM,GAAG,IAAI,CAAC;IAElD,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;;;OAGG;IACH,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,2BAA2B,CAAC;IAC3C;;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;;WAEG;QACH,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,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EAAE,KAAK,2BAA2B,IAAI,2BAA2B,EAAE,CAAC;CAC5E"}

package/resources/x/write-actions.js

@@ -12,7 +12,7 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class WriteActions extends resource_1.APIResource {
     /**
-     * Get write action status
+     * Returns the current state of an asynchronous write action.
      *
      * @example
      * ```ts

package/resources/x/write-actions.mjs

@@ -9,7 +9,7 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class WriteActions extends APIResource {
     /**
-     * Get write action status
+     * Returns the current state of an asynchronous write action.
      *
      * @example
      * ```ts