x-twitter-scraper 0.1.0 → 0.2.0

package/resources/x/users/follow.d.mts

@@ -7,12 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.mjs";
 export declare class Follow extends APIResource {
     /**
      * Follow user
+     *
+     * @example
+     * ```ts
+     * const follow = await client.x.users.follow.create('id', {
+     *   account: '@elonmusk',
+     * });
+     * ```
      */
-    create(userID: string, body: FollowCreateParams, options?: RequestOptions): APIPromise<FollowCreateResponse>;
+    create(id: string, body: FollowCreateParams, options?: RequestOptions): APIPromise<FollowCreateResponse>;
     /**
      * Unfollow user
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.follow.deleteAll(
+     *   'id',
+     *   { account: '@elonmusk' },
+     * );
+     * ```
      */
-    deleteAll(userID: string, body: FollowDeleteAllParams, options?: RequestOptions): APIPromise<FollowDeleteAllResponse>;
+    deleteAll(id: string, body: FollowDeleteAllParams, options?: RequestOptions): APIPromise<FollowDeleteAllResponse>;
 }
 export interface FollowCreateResponse {
     success: true;
@@ -22,13 +37,13 @@ export interface FollowDeleteAllResponse {
 }
 export interface FollowCreateParams {
     /**
-     * X account (@username or account ID)
+     * X account identifier (@username or account ID)
      */
     account: string;
 }
 export interface FollowDeleteAllParams {
     /**
-     * X account (@username or account ID)
+     * X account identifier (@username or account ID)
      */
     account: string;
 }

package/resources/x/users/follow.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"follow.d.mts","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;OAEG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"follow.d.mts","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/x/users/follow.d.ts

@@ -7,12 +7,27 @@ import { RequestOptions } from "../../../internal/request-options.js";
 export declare class Follow extends APIResource {
     /**
      * Follow user
+     *
+     * @example
+     * ```ts
+     * const follow = await client.x.users.follow.create('id', {
+     *   account: '@elonmusk',
+     * });
+     * ```
      */
-    create(userID: string, body: FollowCreateParams, options?: RequestOptions): APIPromise<FollowCreateResponse>;
+    create(id: string, body: FollowCreateParams, options?: RequestOptions): APIPromise<FollowCreateResponse>;
     /**
      * Unfollow user
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.follow.deleteAll(
+     *   'id',
+     *   { account: '@elonmusk' },
+     * );
+     * ```
      */
-    deleteAll(userID: string, body: FollowDeleteAllParams, options?: RequestOptions): APIPromise<FollowDeleteAllResponse>;
+    deleteAll(id: string, body: FollowDeleteAllParams, options?: RequestOptions): APIPromise<FollowDeleteAllResponse>;
 }
 export interface FollowCreateResponse {
     success: true;
@@ -22,13 +37,13 @@ export interface FollowDeleteAllResponse {
 }
 export interface FollowCreateParams {
     /**
-     * X account (@username or account ID)
+     * X account identifier (@username or account ID)
      */
     account: string;
 }
 export interface FollowDeleteAllParams {
     /**
-     * X account (@username or account ID)
+     * X account identifier (@username or account ID)
      */
     account: string;
 }

package/resources/x/users/follow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"follow.d.ts","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CACJ,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;OAEG;IACH,SAAS,CACP,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"follow.d.ts","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAIxG;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,uBAAuB,CAAC;CAGvC;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,MAAM,CAAC;IAC9B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/x/users/follow.js

@@ -10,15 +10,30 @@ const path_1 = require("../../../internal/utils/path.js");
 class Follow extends resource_1.APIResource {
     /**
      * Follow user
+     *
+     * @example
+     * ```ts
+     * const follow = await client.x.users.follow.create('id', {
+     *   account: '@elonmusk',
+     * });
+     * ```
      */
-    create(userID, body, options) {
-        return this._client.post((0, path_1.path) `/x/users/${userID}/follow`, { body, ...options });
+    create(id, body, options) {
+        return this._client.post((0, path_1.path) `/x/users/${id}/follow`, { body, ...options });
     }
     /**
      * Unfollow user
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.follow.deleteAll(
+     *   'id',
+     *   { account: '@elonmusk' },
+     * );
+     * ```
      */
-    deleteAll(userID, body, options) {
-        return this._client.delete((0, path_1.path) `/x/users/${userID}/follow`, { body, ...options });
+    deleteAll(id, body, options) {
+        return this._client.delete((0, path_1.path) `/x/users/${id}/follow`, { body, ...options });
     }
 }
 exports.Follow = Follow;

package/resources/x/users/follow.js.map

@@ -1 +1 @@
-{"version":3,"file":"follow.js","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,SAAS,CACP,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF;AAtBD,wBAsBC"}
+{"version":3,"file":"follow.js","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAGrD,0DAAoD;AAEpD;;GAEG;AACH,MAAa,MAAO,SAAQ,sBAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF;AAjCD,wBAiCC"}

package/resources/x/users/follow.mjs

@@ -7,15 +7,30 @@ import { path } from "../../../internal/utils/path.mjs";
 export class Follow extends APIResource {
     /**
      * Follow user
+     *
+     * @example
+     * ```ts
+     * const follow = await client.x.users.follow.create('id', {
+     *   account: '@elonmusk',
+     * });
+     * ```
      */
-    create(userID, body, options) {
-        return this._client.post(path `/x/users/${userID}/follow`, { body, ...options });
+    create(id, body, options) {
+        return this._client.post(path `/x/users/${id}/follow`, { body, ...options });
     }
     /**
      * Unfollow user
+     *
+     * @example
+     * ```ts
+     * const response = await client.x.users.follow.deleteAll(
+     *   'id',
+     *   { account: '@elonmusk' },
+     * );
+     * ```
      */
-    deleteAll(userID, body, options) {
-        return this._client.delete(path `/x/users/${userID}/follow`, { body, ...options });
+    deleteAll(id, body, options) {
+        return this._client.delete(path `/x/users/${id}/follow`, { body, ...options });
     }
 }
 //# sourceMappingURL=follow.mjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"follow.mjs","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;OAEG;IACH,MAAM,CACJ,MAAc,EACd,IAAwB,EACxB,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,SAAS,CACP,MAAc,EACd,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,MAAM,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpF,CAAC;CACF"}
+{"version":3,"file":"follow.mjs","sourceRoot":"","sources":["../../../src/resources/x/users/follow.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACnE,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;;;;;OAUG;IACH,SAAS,CACP,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;CACF"}

package/resources/x/users/users.d.mts

@@ -11,49 +11,122 @@ export declare class Users extends APIResource {
     follow: FollowAPI.Follow;
     /**
      * Look up X user
+     *
+     * @example
+     * ```ts
+     * const userProfile = await client.x.users.retrieve('id');
+     * ```
      */
-    retrieve(username: string, options?: RequestOptions): APIPromise<UserProfile>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<UserProfile>;
     /**
      * Get multiple users by IDs
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers = await client.x.users.retrieveBatch({
+     *   ids: 'ids',
+     * });
+     * ```
      */
-    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<void>;
+    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get user followers
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowers('id');
+     * ```
      */
-    retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get followers you know for a user
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowersYouKnow('id');
+     * ```
      */
     retrieveFollowersYouKnow(id: string, query?: UserRetrieveFollowersYouKnowParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get users this user follows
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowing('id');
+     * ```
      */
-    retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get tweets liked by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveLikes(
+     *   'id',
+     * );
+     * ```
      */
     retrieveLikes(id: string, query?: UserRetrieveLikesParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get media tweets by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveMedia(
+     *   'id',
+     * );
+     * ```
      */
     retrieveMedia(id: string, query?: UserRetrieveMediaParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get tweets mentioning a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets =
+     *   await client.x.users.retrieveMentions('id');
+     * ```
      */
-    retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Search users by name or username
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers = await client.x.users.retrieveSearch({
+     *   q: 'q',
+     * });
+     * ```
      */
-    retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<void>;
+    retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get recent tweets by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveTweets(
+     *   'id',
+     * );
+     * ```
      */
     retrieveTweets(id: string, query?: UserRetrieveTweetsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get verified followers
-     */
-    retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveVerifiedFollowers('id');
+     * ```
+     */
+    retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
 }
+/**
+ * X user profile with bio, follower counts, and verification status.
+ */
 export interface UserProfile {
     id: string;
     name: string;
@@ -75,7 +148,7 @@ export interface UserRetrieveBatchParams {
 }
 export interface UserRetrieveFollowersParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for followers list
      */
     cursor?: string;
     /**
@@ -85,59 +158,59 @@ export interface UserRetrieveFollowersParams {
 }
 export interface UserRetrieveFollowersYouKnowParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for followers-you-know
      */
     cursor?: string;
 }
 export interface UserRetrieveFollowingParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for following list
      */
     cursor?: string;
     /**
-     * Items per page (20-200, default 200)
+     * Results per page (20-200, default 200)
      */
     pageSize?: number;
 }
 export interface UserRetrieveLikesParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for liked tweets
      */
     cursor?: string;
 }
 export interface UserRetrieveMediaParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for media tweets
      */
     cursor?: string;
 }
 export interface UserRetrieveMentionsParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for mentions
      */
     cursor?: string;
     /**
-     * Unix timestamp - filter after
+     * Unix timestamp - return mentions after this time
      */
     sinceTime?: string;
     /**
-     * Unix timestamp - filter before
+     * Unix timestamp - return mentions before this time
      */
     untilTime?: string;
 }
 export interface UserRetrieveSearchParams {
     /**
-     * Search query
+     * User search query
      */
     q: string;
     /**
-     * Pagination cursor
+     * Pagination cursor for user search
      */
     cursor?: string;
 }
 export interface UserRetrieveTweetsParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for user tweets
      */
     cursor?: string;
     /**
@@ -151,7 +224,7 @@ export interface UserRetrieveTweetsParams {
 }
 export interface UserRetrieveVerifiedFollowersParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for verified followers
      */
     cursor?: string;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../../../src/resources/x/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,SAAS;OACd,EACL,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACxB;OACM,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAI7E;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQzF;;OAEG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;OAEG;IACH,wBAAwB,CACtB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIpC;;OAEG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;OAEG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;OAEG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;OAEG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;IAQnB;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAQ3F;;OAEG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;OAEG;IACH,yBAAyB,CACvB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,IAAI,CAAC;CAOpB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}
+{"version":3,"file":"users.d.mts","sourceRoot":"","sources":["../../../src/resources/x/users/users.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,MAAM;OACX,KAAK,SAAS;OACd,EACL,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACxB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAsC;IAE9D;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvE;;;;;;;;;OASG;IACH,aAAa,CAAC,KAAK,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAI1G;;;;;;;;OAQG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIpC;;;;;;;;OAQG;IACH,wBAAwB,CACtB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIpC;;;;;;;;OAQG;IACH,iBAAiB,CACf,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,2BAA2B,GAAG,IAAI,GAAG,SAAc,EAC1D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIpC;;;;;;;;;OASG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;;;;;;;;OASG;IACH,aAAa,CACX,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;;;;;;;OAQG;IACH,gBAAgB,CACd,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,0BAA0B,GAAG,IAAI,GAAG,SAAc,EACzD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;;;;;;;;OASG;IACH,cAAc,CACZ,KAAK,EAAE,wBAAwB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;IAIpC;;;;;;;;;OASG;IACH,cAAc,CACZ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC;IAIrC;;;;;;;;OAQG;IACH,yBAAyB,CACvB,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,cAAc,CAAC;CAGrC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC;IAEjB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,CAAC,EAAE,MAAM,CAAC;IAEV;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,mCAAmC;IAClD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;IAEF,OAAO,EACL,MAAM,IAAI,MAAM,EAChB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,qBAAqB,IAAI,qBAAqB,GACpD,CAAC;CACH"}

package/resources/x/users/users.d.ts

@@ -11,49 +11,122 @@ export declare class Users extends APIResource {
     follow: FollowAPI.Follow;
     /**
      * Look up X user
+     *
+     * @example
+     * ```ts
+     * const userProfile = await client.x.users.retrieve('id');
+     * ```
      */
-    retrieve(username: string, options?: RequestOptions): APIPromise<UserProfile>;
+    retrieve(id: string, options?: RequestOptions): APIPromise<UserProfile>;
     /**
      * Get multiple users by IDs
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers = await client.x.users.retrieveBatch({
+     *   ids: 'ids',
+     * });
+     * ```
      */
-    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<void>;
+    retrieveBatch(query: UserRetrieveBatchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get user followers
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowers('id');
+     * ```
      */
-    retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveFollowers(id: string, query?: UserRetrieveFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get followers you know for a user
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowersYouKnow('id');
+     * ```
      */
     retrieveFollowersYouKnow(id: string, query?: UserRetrieveFollowersYouKnowParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get users this user follows
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveFollowing('id');
+     * ```
      */
-    retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveFollowing(id: string, query?: UserRetrieveFollowingParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get tweets liked by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveLikes(
+     *   'id',
+     * );
+     * ```
      */
     retrieveLikes(id: string, query?: UserRetrieveLikesParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get media tweets by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveMedia(
+     *   'id',
+     * );
+     * ```
      */
     retrieveMedia(id: string, query?: UserRetrieveMediaParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get tweets mentioning a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets =
+     *   await client.x.users.retrieveMentions('id');
+     * ```
      */
-    retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+    retrieveMentions(id: string, query?: UserRetrieveMentionsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Search users by name or username
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers = await client.x.users.retrieveSearch({
+     *   q: 'q',
+     * });
+     * ```
      */
-    retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<void>;
+    retrieveSearch(query: UserRetrieveSearchParams, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
     /**
      * Get recent tweets by a user
+     *
+     * @example
+     * ```ts
+     * const paginatedTweets = await client.x.users.retrieveTweets(
+     *   'id',
+     * );
+     * ```
      */
     retrieveTweets(id: string, query?: UserRetrieveTweetsParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
     /**
      * Get verified followers
-     */
-    retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<void>;
+     *
+     * @example
+     * ```ts
+     * const paginatedUsers =
+     *   await client.x.users.retrieveVerifiedFollowers('id');
+     * ```
+     */
+    retrieveVerifiedFollowers(id: string, query?: UserRetrieveVerifiedFollowersParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedUsers>;
 }
+/**
+ * X user profile with bio, follower counts, and verification status.
+ */
 export interface UserProfile {
     id: string;
     name: string;
@@ -75,7 +148,7 @@ export interface UserRetrieveBatchParams {
 }
 export interface UserRetrieveFollowersParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for followers list
      */
     cursor?: string;
     /**
@@ -85,59 +158,59 @@ export interface UserRetrieveFollowersParams {
 }
 export interface UserRetrieveFollowersYouKnowParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for followers-you-know
      */
     cursor?: string;
 }
 export interface UserRetrieveFollowingParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for following list
      */
     cursor?: string;
     /**
-     * Items per page (20-200, default 200)
+     * Results per page (20-200, default 200)
      */
     pageSize?: number;
 }
 export interface UserRetrieveLikesParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for liked tweets
      */
     cursor?: string;
 }
 export interface UserRetrieveMediaParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for media tweets
      */
     cursor?: string;
 }
 export interface UserRetrieveMentionsParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for mentions
      */
     cursor?: string;
     /**
-     * Unix timestamp - filter after
+     * Unix timestamp - return mentions after this time
      */
     sinceTime?: string;
     /**
-     * Unix timestamp - filter before
+     * Unix timestamp - return mentions before this time
      */
     untilTime?: string;
 }
 export interface UserRetrieveSearchParams {
     /**
-     * Search query
+     * User search query
      */
     q: string;
     /**
-     * Pagination cursor
+     * Pagination cursor for user search
      */
     cursor?: string;
 }
 export interface UserRetrieveTweetsParams {
     /**
-     * Pagination cursor from previous response
+     * Pagination cursor for user tweets
      */
     cursor?: string;
     /**
@@ -151,7 +224,7 @@ export interface UserRetrieveTweetsParams {
 }
 export interface UserRetrieveVerifiedFollowersParams {
     /**
-     * Pagination cursor
+     * Pagination cursor for verified followers
      */
     cursor?: string;
 }