Constructors
constructor
• new UsersClient(client): UsersClient
Creates a new users client instance
Parameters
| Name | Type | Description |
|---|---|---|
client | Client | The main X API client instance |
Returns
UsersClient
Defined in
users/client.ts:1234Methods
getByUsernames
▸ getByUsernames(usernames, options): Promise<Response>
Get Users by usernames
Retrieves details of multiple Users by their usernames.
Parameters
| Name | Type | Description |
|---|---|---|
usernames | any[] | A list of usernames, comma-separated. |
options | GetByUsernamesOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:1279 ▸ getByUsernames(usernames, options?): Promise<Get2UsersByResponse>
Parameters
| Name | Type |
|---|---|
usernames | any[] |
options? | GetByUsernamesOptions |
Returns
Promise<Get2UsersByResponse>
Defined in
users/client.ts:1292getRepostsOfMe
▸ getRepostsOfMe(options): Promise<Response>
Get Reposts of me
Retrieves a list of Posts that repost content from the authenticated user.
Parameters
| Name | Type |
|---|---|
options | GetRepostsOfMeOptions & { requestOptions: { raw: true } } |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:1471 ▸ getRepostsOfMe(options?): Promise<Get2UsersRepostsOfMeResponse>
Parameters
| Name | Type |
|---|---|
options? | GetRepostsOfMeOptions |
Returns
Promise<Get2UsersRepostsOfMeResponse>
Defined in
users/client.ts:1480unlikePost
▸ unlikePost(id, tweetId, options): Promise<Response>
Unlike Post
Causes the authenticated user to Unlike a specific Post by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:1741 ▸ unlikePost(id, tweetId): Promise<UsersLikesDeleteResponse>
Parameters
| Name | Type |
|---|---|
id | string |
tweetId | string |
Returns
Promise<UsersLikesDeleteResponse>
Defined in
users/client.ts:1758getBookmarks
▸ getBookmarks(id, options): Promise<Response>
Get Bookmarks
Retrieves a list of Posts bookmarked by the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User for whom to return results. |
options | GetBookmarksOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:1861 ▸ getBookmarks(id, options?): Promise<Get2UsersIdBookmarksResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetBookmarksOptions |
Returns
Promise<Get2UsersIdBookmarksResponse>
Defined in
users/client.ts:1874createBookmark
▸ createBookmark(id, body, options): Promise<Response>
Create Bookmark
Adds a post to the authenticated user’s bookmarks.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:2139 ▸ createBookmark(id, body): Promise<BookmarkMutationResponse>
Parameters
| Name | Type |
|---|---|
id | string |
body | BookmarkAddRequest |
Returns
Promise<BookmarkMutationResponse>
Defined in
users/client.ts:2154getFollowers
▸ getFollowers(id, options): Promise<Response>
Get followers
Retrieves a list of Users who follow a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetFollowersOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:2245 ▸ getFollowers(id, options?): Promise<Get2UsersIdFollowersResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetFollowersOptions |
Returns
Promise<Get2UsersIdFollowersResponse>
Defined in
users/client.ts:2258unpinList
▸ unpinList(id, listId, options): Promise<Response>
Unpin List
Causes the authenticated user to unpin a specific List by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:2474 ▸ unpinList(id, listId): Promise<ListUnpinResponse>
Parameters
| Name | Type |
|---|---|
id | string |
listId | string |
Returns
Promise<ListUnpinResponse>
Defined in
users/client.ts:2491getById
▸ getById(id, options): Promise<Response>
Get User by ID
Retrieves details of a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetByIdOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:2594 ▸ getById(id, options?): Promise<Get2UsersIdResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetByIdOptions |
Returns
Promise<Get2UsersIdResponse>
Defined in
users/client.ts:2607getMentions
▸ getMentions(id, options): Promise<Response>
Get mentions
Retrieves a list of Posts that mention a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetMentionsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:2781 ▸ getMentions(id, options?): Promise<Get2UsersIdMentionsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetMentionsOptions |
Returns
Promise<Get2UsersIdMentionsResponse>
Defined in
users/client.ts:2794unrepostPost
▸ unrepostPost(id, sourceTweetId, options): Promise<Response>
Unrepost Post
Causes the authenticated user to unrepost a specific Post by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3149 ▸ unrepostPost(id, sourceTweetId): Promise<UsersRetweetsDeleteResponse>
Parameters
| Name | Type |
|---|---|
id | string |
sourceTweetId | string |
Returns
Promise<UsersRetweetsDeleteResponse>
Defined in
users/client.ts:3166deleteBookmark
▸ deleteBookmark(id, tweetId, options): Promise<Response>
Delete Bookmark
Removes a Post from the authenticated user’s Bookmarks by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3273 ▸ deleteBookmark(id, tweetId): Promise<BookmarkMutationResponse>
Parameters
| Name | Type |
|---|---|
id | string |
tweetId | string |
Returns
Promise<BookmarkMutationResponse>
Defined in
users/client.ts:3290unfollowList
▸ unfollowList(id, listId, options): Promise<Response>
Unfollow List
Causes the authenticated user to unfollow a specific List by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3391 ▸ unfollowList(id, listId): Promise<ListFollowedResponse>
Parameters
| Name | Type |
|---|---|
id | string |
listId | string |
Returns
Promise<ListFollowedResponse>
Defined in
users/client.ts:3408unmuteUser
▸ unmuteUser(sourceUserId, targetUserId, options): Promise<Response>
Unmute User
Causes the authenticated user to unmute a specific user by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3515 ▸ unmuteUser(sourceUserId, targetUserId): Promise<MuteUserMutationResponse>
Parameters
| Name | Type |
|---|---|
sourceUserId | string |
targetUserId | string |
Returns
Promise<MuteUserMutationResponse>
Defined in
users/client.ts:3532getMe
▸ getMe(options): Promise<Response>
Get my User
Retrieves details of the authenticated user.
Parameters
| Name | Type |
|---|---|
options | GetMeOptions & { requestOptions: { raw: true } } |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3631 ▸ getMe(options?): Promise<Get2UsersMeResponse>
Parameters
| Name | Type |
|---|---|
options? | GetMeOptions |
Returns
Promise<Get2UsersMeResponse>
Defined in
users/client.ts:3640getMuting
▸ getMuting(id, options): Promise<Response>
Get muting
Retrieves a list of Users muted by the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User for whom to return results. |
options | GetMutingOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:3796 ▸ getMuting(id, options?): Promise<Get2UsersIdMutingResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetMutingOptions |
Returns
Promise<Get2UsersIdMutingResponse>
Defined in
users/client.ts:3809muteUser
▸ muteUser(id, options): Promise<Response>
Mute User
Causes the authenticated user to mute a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User that is requesting to mute the target User. |
options | MuteUserOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:4015 ▸ muteUser(id, options?): Promise<MuteUserMutationResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | MuteUserOptions |
Returns
Promise<MuteUserMutationResponse>
Defined in
users/client.ts:4028search
▸ search(query, options): Promise<Response>
Search Users
Retrieves a list of Users matching a search query.
Parameters
| Name | Type | Description |
|---|---|---|
query | string | TThe the query string by which to query for users. |
options | SearchOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:4136 ▸ search(query, options?): Promise<Get2UsersSearchResponse>
Parameters
| Name | Type |
|---|---|
query | string |
options? | SearchOptions |
Returns
Promise<Get2UsersSearchResponse>
Defined in
users/client.ts:4149getBlocking
▸ getBlocking(id, options): Promise<Response>
Get blocking
Retrieves a list of Users blocked by the specified User ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User for whom to return results. |
options | GetBlockingOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:4362 ▸ getBlocking(id, options?): Promise<Get2UsersIdBlockingResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetBlockingOptions |
Returns
Promise<Get2UsersIdBlockingResponse>
Defined in
users/client.ts:4375getByIds
▸ getByIds(ids, options): Promise<Response>
Get Users by IDs
Retrieves details of multiple Users by their IDs.
Parameters
| Name | Type | Description |
|---|---|---|
ids | any[] | A list of User IDs, comma-separated. You can specify up to 100 IDs. |
options | GetByIdsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:4581 ▸ getByIds(ids, options?): Promise<Get2UsersResponse>
Parameters
| Name | Type |
|---|---|
ids | any[] |
options? | GetByIdsOptions |
Returns
Promise<Get2UsersResponse>
Defined in
users/client.ts:4594getFollowing
▸ getFollowing(id, options): Promise<Response>
Get following
Retrieves a list of Users followed by a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetFollowingOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:4777 ▸ getFollowing(id, options?): Promise<Get2UsersIdFollowingResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetFollowingOptions |
Returns
Promise<Get2UsersIdFollowingResponse>
Defined in
users/client.ts:4790followUser
▸ followUser(id, options): Promise<Response>
Follow User
Causes the authenticated user to follow a specific user by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User that is requesting to follow the target User. |
options | FollowUserOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:5002 ▸ followUser(id, options?): Promise<UsersFollowingCreateResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | FollowUserOptions |
Returns
Promise<UsersFollowingCreateResponse>
Defined in
users/client.ts:5015likePost
▸ likePost(id, options): Promise<Response>
Like Post
Causes the authenticated user to Like a specific Post by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User that is requesting to like the Post. |
options | LikePostOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:5123 ▸ likePost(id, options?): Promise<UsersLikesCreateResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | LikePostOptions |
Returns
Promise<UsersLikesCreateResponse>
Defined in
users/client.ts:5136getLikedPosts
▸ getLikedPosts(id, options): Promise<Response>
Get liked Posts
Retrieves a list of Posts liked by a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetLikedPostsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:5244 ▸ getLikedPosts(id, options?): Promise<Get2UsersIdLikedTweetsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetLikedPostsOptions |
Returns
Promise<Get2UsersIdLikedTweetsResponse>
Defined in
users/client.ts:5257getPosts
▸ getPosts(id, options): Promise<Response>
Get Posts
Retrieves a list of posts authored by a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetPostsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:5526 ▸ getPosts(id, options?): Promise<Get2UsersIdTweetsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetPostsOptions |
Returns
Promise<Get2UsersIdTweetsResponse>
Defined in
users/client.ts:5539blockDms
▸ blockDms(id, options): Promise<Response>
Block DMs
Blocks direct messages to or from a specific User by their ID for the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:5909 ▸ blockDms(id): Promise<UsersDMBlockCreateResponse>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<UsersDMBlockCreateResponse>
Defined in
users/client.ts:5922getListMemberships
▸ getListMemberships(id, options): Promise<Response>
Get List memberships
Retrieves a list of Lists that a specific User is a member of by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetListMembershipsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6013 ▸ getListMemberships(id, options?): Promise<Get2UsersIdListMembershipsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetListMembershipsOptions |
Returns
Promise<Get2UsersIdListMembershipsResponse>
Defined in
users/client.ts:6026getPinnedLists
▸ getPinnedLists(id, options): Promise<Response>
Get pinned Lists
Retrieves a list of Lists pinned by the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User for whom to return results. |
options | GetPinnedListsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6238 ▸ getPinnedLists(id, options?): Promise<Get2UsersIdPinnedListsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetPinnedListsOptions |
Returns
Promise<Get2UsersIdPinnedListsResponse>
Defined in
users/client.ts:6251pinList
▸ pinList(id, body, options): Promise<Response>
Pin List
Causes the authenticated user to pin a specific List by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6421 ▸ pinList(id, body): Promise<ListPinnedResponse>
Parameters
| Name | Type |
|---|---|
id | string |
body | ListPinnedRequest |
Returns
Promise<ListPinnedResponse>
Defined in
users/client.ts:6436getByUsername
▸ getByUsername(username, options): Promise<Response>
Get User by username
Retrieves details of a specific User by their username.
Parameters
| Name | Type | Description |
|---|---|---|
username | string | A username. |
options | GetByUsernameOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6533 ▸ getByUsername(username, options?): Promise<Get2UsersByUsernameUsernameResponse>
Parameters
| Name | Type |
|---|---|
username | string |
options? | GetByUsernameOptions |
Returns
Promise<Get2UsersByUsernameUsernameResponse>
Defined in
users/client.ts:6546unfollowUser
▸ unfollowUser(sourceUserId, targetUserId, options): Promise<Response>
Unfollow User
Causes the authenticated user to unfollow a specific user by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6724 ▸ unfollowUser(sourceUserId, targetUserId): Promise<UsersFollowingDeleteResponse>
Parameters
| Name | Type |
|---|---|
sourceUserId | string |
targetUserId | string |
Returns
Promise<UsersFollowingDeleteResponse>
Defined in
users/client.ts:6741getTimeline
▸ getTimeline(id, options): Promise<Response>
Get Timeline
Retrieves a reverse chronological list of Posts in the authenticated User’s Timeline.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User to list Reverse Chronological Timeline Posts of. |
options | GetTimelineOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:6844 ▸ getTimeline(id, options?): Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetTimelineOptions |
Returns
Promise<Get2UsersIdTimelinesReverseChronologicalResponse>
Defined in
users/client.ts:6857getFollowedLists
▸ getFollowedLists(id, options): Promise<Response>
Get followed Lists
Retrieves a list of Lists followed by a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetFollowedListsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7221 ▸ getFollowedLists(id, options?): Promise<Get2UsersIdFollowedListsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetFollowedListsOptions |
Returns
Promise<Get2UsersIdFollowedListsResponse>
Defined in
users/client.ts:7234followList
▸ followList(id, options): Promise<Response>
Follow List
Causes the authenticated user to follow a specific List by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User that will follow the List. |
options | FollowListOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7446 ▸ followList(id, options?): Promise<ListFollowedResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | FollowListOptions |
Returns
Promise<ListFollowedResponse>
Defined in
users/client.ts:7459unblockDms
▸ unblockDms(id, options): Promise<Response>
Unblock DMs
Unblocks direct messages to or from a specific User by their ID for the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7567 ▸ unblockDms(id): Promise<UsersDMUnBlockCreateResponse>
Parameters
| Name | Type |
|---|---|
id | string |
Returns
Promise<UsersDMUnBlockCreateResponse>
Defined in
users/client.ts:7580repostPost
▸ repostPost(id, options): Promise<Response>
Repost Post
Causes the authenticated user to repost a specific Post by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User that is requesting to repost the Post. |
options | RepostPostOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7671 ▸ repostPost(id, options?): Promise<UsersRetweetsCreateResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | RepostPostOptions |
Returns
Promise<UsersRetweetsCreateResponse>
Defined in
users/client.ts:7684getBookmarkFolders
▸ getBookmarkFolders(id, options): Promise<Response>
Get Bookmark folders
Retrieves a list of Bookmark folders created by the authenticated user.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the authenticated source User for whom to return results. |
options | GetBookmarkFoldersOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7792 ▸ getBookmarkFolders(id, options?): Promise<BookmarkFoldersResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetBookmarkFoldersOptions |
Returns
Promise<BookmarkFoldersResponse>
Defined in
users/client.ts:7805getOwnedLists
▸ getOwnedLists(id, options): Promise<Response>
Get owned Lists
Retrieves a list of Lists owned by a specific User by their ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the User to lookup. |
options | GetOwnedListsOptions & { requestOptions: { raw: true } } | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:7944 ▸ getOwnedLists(id, options?): Promise<Get2UsersIdOwnedListsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
options? | GetOwnedListsOptions |
Returns
Promise<Get2UsersIdOwnedListsResponse>
Defined in
users/client.ts:7957getBookmarksByFolderId
▸ 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.
Parameters
| Name | Type | Description |
|---|---|---|
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 | - |
Returns
Promise<Response>
Promise resolving to the API response, or raw Response if requestOptions.raw is true
Defined in
users/client.ts:8173 ▸ getBookmarksByFolderId(id, folderId): Promise<BookmarkFolderPostsResponse>
Parameters
| Name | Type |
|---|---|
id | string |
folderId | string |
Returns
Promise<BookmarkFolderPostsResponse>