UsersClient

Cliente para operaciones de users This client provides methods for interacting with the users endpoints of the X API. It handles authentication, request formatting, and response parsing for all users related operations.

Constructores

constructor

• new UsersClient(client): UsersClient Creates a new users client instance

Parámetros

Nombre	Tipo	Descripción
`client`	`Client`	The main X API client instance

Devuelve

UsersClient

Definido en

users/client.ts:1234

Métodos

getByUsernames

▸ getByUsernames(usernames, options): Promise<Response> Get Users by usernames Retrieves details of multiple Users by their usernames.

Parámetros

Nombre	Tipo	Descripción
`usernames`	`any`[]	A list of usernames, comma-separated.
`options`	`GetByUsernamesOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:1279 ▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>

Parámetros

Nombre	Tipo
`usernames`	`any`[]
`options?`	`GetByUsernamesOptions`

Devuelve

Promise<Get2UsersByResponse>

Definido en

users/client.ts:1292

getRepostsOfMe

▸ getRepostsOfMe(options): Promise<Response> Get Reposts of me Retrieves a list of Posts that repost content from the authenticated user.

Parámetros

Nombre	Tipo
`options`	`GetRepostsOfMeOptions` & { `requestOptions`: { `raw`: `true` } }

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:1471 ▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>

Parámetros

Nombre	Tipo
`options?`	`GetRepostsOfMeOptions`

Devuelve

Promise<Get2UsersRepostsOfMeResponse>

Definido en

users/client.ts:1480

unlikePost

▸ unlikePost(id, tweetId, options): Promise<Response> Unlike Post Causes the authenticated user to Unlike a specific Post by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to unlike the Post.
`tweetId`	`string`	The ID of the Post that the User is requesting to unlike.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:1741 ▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`tweetId`	`string`

Devuelve

Promise<UsersLikesDeleteResponse>

Definido en

users/client.ts:1758

getBookmarks

▸ getBookmarks(id, options): Promise<Response> Get Bookmarks Retrieves a list of Posts bookmarked by the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetBookmarksOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:1861 ▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetBookmarksOptions`

Devuelve

Promise<Get2UsersIdBookmarksResponse>

Definido en

users/client.ts:1874

createBookmark

▸ createBookmark(id, body, options): Promise<Response> Create Bookmark Adds a post to the authenticated user’s bookmarks.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to add bookmarks.
`body`	`BookmarkAddRequest`	Request body
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:2139 ▸ createBookmark(id, body): Promise<BookmarkMutationResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`body`	`BookmarkAddRequest`

Devuelve

Promise<BookmarkMutationResponse>

Definido en

users/client.ts:2154

getFollowers

▸ getFollowers(id, options): Promise<Response> Get followers Retrieves a list of Users who follow a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetFollowersOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:2245 ▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetFollowersOptions`

Devuelve

Promise<Get2UsersIdFollowersResponse>

Definido en

users/client.ts:2258

unpinList

▸ unpinList(id, listId, options): Promise<Response> Unpin List Causes the authenticated user to unpin a specific List by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`listId`	`string`	The ID of the List to unpin.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:2474 ▸ unpinList(id, listId): Promise<ListUnpinResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`listId`	`string`

Devuelve

Promise<ListUnpinResponse>

Definido en

users/client.ts:2491

getById

▸ getById(id, options): Promise<Response> Get User by ID Retrieves details of a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetByIdOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:2594 ▸ getById(id, options?): Promise<Get2UsersIdResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetByIdOptions`

Devuelve

Promise<Get2UsersIdResponse>

Definido en

users/client.ts:2607

getMentions

▸ getMentions(id, options): Promise<Response> Get mentions Retrieves a list of Posts that mention a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetMentionsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:2781 ▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetMentionsOptions`

Devuelve

Promise<Get2UsersIdMentionsResponse>

Definido en

users/client.ts:2794

unrepostPost

▸ unrepostPost(id, sourceTweetId, options): Promise<Response> Unrepost Post Causes the authenticated user to unrepost a specific Post by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to repost the Post.
`sourceTweetId`	`string`	The ID of the Post that the User is requesting to unretweet.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3149 ▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`sourceTweetId`	`string`

Devuelve

Promise<UsersRetweetsDeleteResponse>

Definido en

users/client.ts:3166

deleteBookmark

▸ deleteBookmark(id, tweetId, options): Promise<Response> Delete Bookmark Removes a Post from the authenticated user’s Bookmarks by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User whose bookmark is to be removed.
`tweetId`	`string`	The ID of the Post that the source User is removing from bookmarks.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3273 ▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`tweetId`	`string`

Devuelve

Promise<BookmarkMutationResponse>

Definido en

users/client.ts:3290

unfollowList

▸ unfollowList(id, listId, options): Promise<Response> Unfollow List Causes the authenticated user to unfollow a specific List by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that will unfollow the List.
`listId`	`string`	The ID of the List to unfollow.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3391 ▸ unfollowList(id, listId): Promise<ListFollowedResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`listId`	`string`

Devuelve

Promise<ListFollowedResponse>

Definido en

users/client.ts:3408

unmuteUser

▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response> Unmute User Causes the authenticated user to unmute a specific user by their ID.

Parámetros

Nombre	Tipo	Descripción
`sourceUserId`	`string`	The ID of the authenticated source User that is requesting to unmute the target User.
`targetUserId`	`string`	The ID of the User that the source User is requesting to unmute.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3515 ▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>

Parámetros

Nombre	Tipo
`sourceUserId`	`string`
`targetUserId`	`string`

Devuelve

Promise<MuteUserMutationResponse>

Definido en

users/client.ts:3532

getMe

▸ getMe(options): Promise<Response> Get my User Retrieves details of the authenticated user.

Parámetros

Nombre	Tipo
`options`	`GetMeOptions` & { `requestOptions`: { `raw`: `true` } }

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3631 ▸ getMe(options?): Promise<Get2UsersMeResponse>

Parámetros

Nombre	Tipo
`options?`	`GetMeOptions`

Devuelve

Promise<Get2UsersMeResponse>

Definido en

users/client.ts:3640

getMuting

▸ getMuting(id, options): Promise<Response> Get muting Retrieves a list of Users muted by the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetMutingOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:3796 ▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetMutingOptions`

Devuelve

Promise<Get2UsersIdMutingResponse>

Definido en

users/client.ts:3809

muteUser

▸ muteUser(id, options): Promise<Response> Mute User Causes the authenticated user to mute a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to mute the target User.
`options`	`MuteUserOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:4015 ▸ muteUser(id, options?): Promise<MuteUserMutationResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`MuteUserOptions`

Devuelve

Promise<MuteUserMutationResponse>

Definido en

users/client.ts:4028

search

▸ search(query, options): Promise<Response> Search Users Retrieves a list of Users matching a search query.

Parámetros

Nombre	Tipo	Descripción
`query`	`string`	TThe the query string by which to query for users.
`options`	`SearchOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:4136 ▸ search(query, options?): Promise<Get2UsersSearchResponse>

Parámetros

Nombre	Tipo
`query`	`string`
`options?`	`SearchOptions`

Devuelve

Promise<Get2UsersSearchResponse>

Definido en

users/client.ts:4149

getBlocking

▸ getBlocking(id, options): Promise<Response> Get blocking Retrieves a list of Users blocked by the specified User ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetBlockingOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:4362 ▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetBlockingOptions`

Devuelve

Promise<Get2UsersIdBlockingResponse>

Definido en

users/client.ts:4375

getByIds

▸ getByIds(ids, options): Promise<Response> Get Users by IDs Retrieves details of multiple Users by their IDs.

Parámetros

Nombre	Tipo	Descripción
`ids`	`any`[]	A list of User IDs, comma-separated. You can specify up to 100 IDs.
`options`	`GetByIdsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:4581 ▸ getByIds(ids, options?): Promise<Get2UsersResponse>

Parámetros

Nombre	Tipo
`ids`	`any`[]
`options?`	`GetByIdsOptions`

Devuelve

Promise<Get2UsersResponse>

Definido en

users/client.ts:4594

getFollowing

▸ getFollowing(id, options): Promise<Response> Get following Retrieves a list of Users followed by a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetFollowingOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:4777 ▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetFollowingOptions`

Devuelve

Promise<Get2UsersIdFollowingResponse>

Definido en

users/client.ts:4790

followUser

▸ followUser(id, options): Promise<Response> Follow User Causes the authenticated user to follow a specific user by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to follow the target User.
`options`	`FollowUserOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:5002 ▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`FollowUserOptions`

Devuelve

Promise<UsersFollowingCreateResponse>

Definido en

users/client.ts:5015

likePost

▸ likePost(id, options): Promise<Response> Like Post Causes the authenticated user to Like a specific Post by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to like the Post.
`options`	`LikePostOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:5123 ▸ likePost(id, options?): Promise<UsersLikesCreateResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`LikePostOptions`

Devuelve

Promise<UsersLikesCreateResponse>

Definido en

users/client.ts:5136

getLikedPosts

▸ getLikedPosts(id, options): Promise<Response> Get liked Posts Retrieves a list of Posts liked by a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetLikedPostsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:5244 ▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetLikedPostsOptions`

Devuelve

Promise<Get2UsersIdLikedTweetsResponse>

Definido en

users/client.ts:5257

getPosts

▸ getPosts(id, options): Promise<Response> Get Posts Retrieves a list of posts authored by a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetPostsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:5526 ▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetPostsOptions`

Devuelve

Promise<Get2UsersIdTweetsResponse>

Definido en

users/client.ts:5539

blockDms

▸ blockDms(id, options): Promise<Response> Block DMs Blocks direct messages to or from a specific User by their ID for the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the target User that the authenticated user requesting to block dms for.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:5909 ▸ blockDms(id): Promise<UsersDMBlockCreateResponse>

Parámetros

Nombre	Tipo
`id`	`string`

Devuelve

Promise<UsersDMBlockCreateResponse>

Definido en

users/client.ts:5922

getListMemberships

▸ getListMemberships(id, options): Promise<Response> Get List memberships Retrieves a list of Lists that a specific User is a member of by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetListMembershipsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6013 ▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetListMembershipsOptions`

Devuelve

Promise<Get2UsersIdListMembershipsResponse>

Definido en

users/client.ts:6026

getPinnedLists

▸ getPinnedLists(id, options): Promise<Response> Get pinned Lists Retrieves a list of Lists pinned by the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetPinnedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6238 ▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetPinnedListsOptions`

Devuelve

Promise<Get2UsersIdPinnedListsResponse>

Definido en

users/client.ts:6251

pinList

▸ pinList(id, body, options): Promise<Response> Pin List Causes the authenticated user to pin a specific List by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that will pin the List.
`body`	`ListPinnedRequest`	Request body
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6421 ▸ pinList(id, body): Promise<ListPinnedResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`body`	`ListPinnedRequest`

Devuelve

Promise<ListPinnedResponse>

Definido en

users/client.ts:6436

getByUsername

▸ getByUsername(username, options): Promise<Response> Get User by username Retrieves details of a specific User by their username.

Parámetros

Nombre	Tipo	Descripción
`username`	`string`	A username.
`options`	`GetByUsernameOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6533 ▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>

Parámetros

Nombre	Tipo
`username`	`string`
`options?`	`GetByUsernameOptions`

Devuelve

Promise<Get2UsersByUsernameUsernameResponse>

Definido en

users/client.ts:6546

unfollowUser

▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response> Unfollow User Causes the authenticated user to unfollow a specific user by their ID.

Parámetros

Nombre	Tipo	Descripción
`sourceUserId`	`string`	The ID of the authenticated source User that is requesting to unfollow the target User.
`targetUserId`	`string`	The ID of the User that the source User is requesting to unfollow.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6724 ▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>

Parámetros

Nombre	Tipo
`sourceUserId`	`string`
`targetUserId`	`string`

Devuelve

Promise<UsersFollowingDeleteResponse>

Definido en

users/client.ts:6741

getTimeline

▸ getTimeline(id, options): Promise<Response> Get Timeline Retrieves a reverse chronological list of Posts in the authenticated User’s Timeline.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User to list Reverse Chronological Timeline Posts of.
`options`	`GetTimelineOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:6844 ▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetTimelineOptions`

Devuelve

Promise<Get2UsersIdTimelinesReverseChronologicalResponse>

Definido en

users/client.ts:6857

getFollowedLists

▸ getFollowedLists(id, options): Promise<Response> Get followed Lists Retrieves a list of Lists followed by a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetFollowedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7221 ▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetFollowedListsOptions`

Devuelve

Promise<Get2UsersIdFollowedListsResponse>

Definido en

users/client.ts:7234

followList

▸ followList(id, options): Promise<Response> Follow List Causes the authenticated user to follow a specific List by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that will follow the List.
`options`	`FollowListOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7446 ▸ followList(id, options?): Promise<ListFollowedResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`FollowListOptions`

Devuelve

Promise<ListFollowedResponse>

Definido en

users/client.ts:7459

unblockDms

▸ unblockDms(id, options): Promise<Response> Unblock DMs Unblocks direct messages to or from a specific User by their ID for the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the target User that the authenticated user requesting to unblock dms for.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7567 ▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>

Parámetros

Nombre	Tipo
`id`	`string`

Devuelve

Promise<UsersDMUnBlockCreateResponse>

Definido en

users/client.ts:7580

repostPost

▸ repostPost(id, options): Promise<Response> Repost Post Causes the authenticated user to repost a specific Post by its ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User that is requesting to repost the Post.
`options`	`RepostPostOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7671 ▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`RepostPostOptions`

Devuelve

Promise<UsersRetweetsCreateResponse>

Definido en

users/client.ts:7684

getBookmarkFolders

▸ getBookmarkFolders(id, options): Promise<Response> Get Bookmark folders Retrieves a list of Bookmark folders created by the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`options`	`GetBookmarkFoldersOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7792 ▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetBookmarkFoldersOptions`

Devuelve

Promise<BookmarkFoldersResponse>

Definido en

users/client.ts:7805

getOwnedLists

▸ getOwnedLists(id, options): Promise<Response> Get owned Lists Retrieves a list of Lists owned by a specific User by their ID.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the User to lookup.
`options`	`GetOwnedListsOptions` & { `requestOptions`: { `raw`: `true` } }	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:7944 ▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`options?`	`GetOwnedListsOptions`

Devuelve

Promise<Get2UsersIdOwnedListsResponse>

Definido en

users/client.ts:7957

getBookmarksByFolderId

▸ getBookmarksByFolderId(id, folderId, options): Promise<Response> Get Bookmarks by folder ID Retrieves Posts in a specific Bookmark folder by its ID for the authenticated user.

Parámetros

Nombre	Tipo	Descripción
`id`	`string`	The ID of the authenticated source User for whom to return results.
`folderId`	`string`	The ID of the Bookmark Folder that the authenticated User is trying to fetch Posts for.
`options`	`Object`	-
`options.requestOptions`	`Object`	-
`options.requestOptions.raw`	`true`	-

Devuelve

Promise<Response> Promise resolving to the API response, or raw Response if requestOptions.raw is true

Definido en

users/client.ts:8173 ▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>

Parámetros

Nombre	Tipo
`id`	`string`
`folderId`	`string`

Devuelve

Promise<BookmarkFolderPostsResponse>

Definido en

users/client.ts:8190

​Constructores

​constructor

​Parámetros

​Devuelve

​Definido en

​Métodos

​getByUsernames

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​getRepostsOfMe

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​unlikePost

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​getBookmarks

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​createBookmark

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​getFollowers

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​unpinList

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​getById

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​getMentions

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​unrepostPost

​Parámetros

​Devuelve

​Definido en

​Parámetros

​Devuelve

​Definido en

​deleteBookmark

​Parámetros

​Devuelve

​Definido en

Constructores

constructor

Parámetros

Devuelve

Definido en

Métodos

getByUsernames

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

getRepostsOfMe

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

unlikePost

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

getBookmarks

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

createBookmark

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

getFollowers

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

unpinList

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

getById

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

getMentions

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

unrepostPost

Parámetros

Devuelve

Definido en

Parámetros

Devuelve

Definido en

deleteBookmark

Parámetros

Devuelve

Definido en