@xcrop/sdk 1.0.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +139 -10
- package/dist/cjs/client.d.ts +10 -4
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +9 -1
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/errors.d.ts +17 -4
- package/dist/cjs/errors.d.ts.map +1 -1
- package/dist/cjs/errors.js +21 -7
- package/dist/cjs/errors.js.map +1 -1
- package/dist/cjs/http.d.ts +1 -1
- package/dist/cjs/http.js +14 -10
- package/dist/cjs/http.js.map +1 -1
- package/dist/cjs/index.d.ts +3 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +5 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/resources/account.d.ts +11 -1
- package/dist/cjs/resources/account.d.ts.map +1 -1
- package/dist/cjs/resources/account.js +29 -0
- package/dist/cjs/resources/account.js.map +1 -1
- package/dist/cjs/resources/communities.d.ts +9 -6
- package/dist/cjs/resources/communities.d.ts.map +1 -1
- package/dist/cjs/resources/communities.js +15 -6
- package/dist/cjs/resources/communities.js.map +1 -1
- package/dist/cjs/resources/dm.d.ts +15 -0
- package/dist/cjs/resources/dm.d.ts.map +1 -0
- package/dist/cjs/resources/dm.js +33 -0
- package/dist/cjs/resources/dm.js.map +1 -0
- package/dist/cjs/resources/lists.d.ts +4 -4
- package/dist/cjs/resources/lists.d.ts.map +1 -1
- package/dist/cjs/resources/lists.js +8 -2
- package/dist/cjs/resources/lists.js.map +1 -1
- package/dist/cjs/resources/media.d.ts +13 -0
- package/dist/cjs/resources/media.d.ts.map +1 -0
- package/dist/cjs/resources/media.js +26 -0
- package/dist/cjs/resources/media.js.map +1 -0
- package/dist/cjs/resources/tweets.d.ts +35 -7
- package/dist/cjs/resources/tweets.d.ts.map +1 -1
- package/dist/cjs/resources/tweets.js +79 -4
- package/dist/cjs/resources/tweets.js.map +1 -1
- package/dist/cjs/resources/users.d.ts +44 -11
- package/dist/cjs/resources/users.d.ts.map +1 -1
- package/dist/cjs/resources/users.js +114 -20
- package/dist/cjs/resources/users.js.map +1 -1
- package/dist/cjs/types.d.ts +320 -3
- package/dist/cjs/types.d.ts.map +1 -1
- package/dist/esm/client.d.ts +10 -4
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +9 -1
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/errors.d.ts +17 -4
- package/dist/esm/errors.d.ts.map +1 -1
- package/dist/esm/errors.js +21 -7
- package/dist/esm/errors.js.map +1 -1
- package/dist/esm/http.d.ts +1 -1
- package/dist/esm/http.js +14 -10
- package/dist/esm/http.js.map +1 -1
- package/dist/esm/index.d.ts +3 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +2 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/resources/account.d.ts +11 -1
- package/dist/esm/resources/account.d.ts.map +1 -1
- package/dist/esm/resources/account.js +29 -0
- package/dist/esm/resources/account.js.map +1 -1
- package/dist/esm/resources/communities.d.ts +9 -6
- package/dist/esm/resources/communities.d.ts.map +1 -1
- package/dist/esm/resources/communities.js +15 -6
- package/dist/esm/resources/communities.js.map +1 -1
- package/dist/esm/resources/dm.d.ts +15 -0
- package/dist/esm/resources/dm.d.ts.map +1 -0
- package/dist/esm/resources/dm.js +29 -0
- package/dist/esm/resources/dm.js.map +1 -0
- package/dist/esm/resources/lists.d.ts +4 -4
- package/dist/esm/resources/lists.d.ts.map +1 -1
- package/dist/esm/resources/lists.js +8 -2
- package/dist/esm/resources/lists.js.map +1 -1
- package/dist/esm/resources/media.d.ts +13 -0
- package/dist/esm/resources/media.d.ts.map +1 -0
- package/dist/esm/resources/media.js +22 -0
- package/dist/esm/resources/media.js.map +1 -0
- package/dist/esm/resources/tweets.d.ts +35 -7
- package/dist/esm/resources/tweets.d.ts.map +1 -1
- package/dist/esm/resources/tweets.js +79 -4
- package/dist/esm/resources/tweets.js.map +1 -1
- package/dist/esm/resources/users.d.ts +44 -11
- package/dist/esm/resources/users.d.ts.map +1 -1
- package/dist/esm/resources/users.js +114 -20
- package/dist/esm/resources/users.js.map +1 -1
- package/dist/esm/types.d.ts +320 -3
- package/dist/esm/types.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -1,49 +1,64 @@
|
|
|
1
1
|
import type { HttpClient } from '../http.js';
|
|
2
|
-
import type { User, Tweet, PaginationParams, PaginatedResponse, ApiResponse, CheckFollowResult, QualifiedAccountParams, QualifiedAccountResult, QualifiedNameParams, QualifiedNameResult, FollowersIdsParams, FollowersIdsResponse } from '../types.js';
|
|
2
|
+
import type { User, Tweet, PaginationParams, PaginatedResponse, ApiResponse, CheckFollowResult, QualifiedAccountParams, QualifiedAccountResult, QualifiedNameParams, QualifiedNameResult, FollowersIdsParams, FollowersIdsResponse, UserLookupParams, UserPaginationParams, UserListParams, UserMentionsParams, MuteResult, BlockResult } from '../types.js';
|
|
3
3
|
export declare class UsersResource {
|
|
4
4
|
private readonly http;
|
|
5
5
|
constructor(http: HttpClient);
|
|
6
6
|
/**
|
|
7
|
-
* Get a user profile by username.
|
|
7
|
+
* Get a user profile by username. Pass `id:<digits>` as the username (or
|
|
8
|
+
* `{ user_id }`) to look a user up by numeric id.
|
|
8
9
|
*/
|
|
9
|
-
get(username: string): Promise<ApiResponse<User>>;
|
|
10
|
+
get(username: string, params?: UserLookupParams): Promise<ApiResponse<User>>;
|
|
10
11
|
/**
|
|
11
12
|
* Get a user's tweets.
|
|
12
13
|
*/
|
|
13
|
-
tweets(username: string, params?:
|
|
14
|
+
tweets(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
|
|
14
15
|
/**
|
|
15
16
|
* Get a user's mentions.
|
|
16
17
|
*/
|
|
17
|
-
mentions(username: string, params?:
|
|
18
|
+
mentions(username: string, params?: UserMentionsParams): Promise<PaginatedResponse<Tweet>>;
|
|
18
19
|
/**
|
|
19
|
-
* Get a user's followers.
|
|
20
|
+
* Get a user's followers. With `include_unavailable: true`, suspended or
|
|
21
|
+
* deactivated accounts also come back as rows `{ id, unavailable: true,
|
|
22
|
+
* unavailable_reason, ...every other field null }` (not billed). Same
|
|
23
|
+
* option on `following()` and `verifiedFollowers()`.
|
|
20
24
|
*/
|
|
21
|
-
followers(username: string, params?:
|
|
25
|
+
followers(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
|
|
22
26
|
/**
|
|
23
27
|
* Get users that a user is following.
|
|
24
28
|
*/
|
|
25
|
-
following(username: string, params?:
|
|
29
|
+
following(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
|
|
26
30
|
/**
|
|
27
31
|
* Get a user's replies.
|
|
28
32
|
*/
|
|
29
|
-
replies(username: string, params?:
|
|
33
|
+
replies(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
|
|
30
34
|
/**
|
|
31
35
|
* Get a user's media tweets.
|
|
32
36
|
*/
|
|
33
|
-
media(username: string, params?:
|
|
37
|
+
media(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
|
|
34
38
|
/**
|
|
35
39
|
* Get a user's verified (blue) followers.
|
|
36
40
|
*/
|
|
37
|
-
verifiedFollowers(username: string, params?:
|
|
41
|
+
verifiedFollowers(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
|
|
38
42
|
/**
|
|
39
43
|
* Get up to 5000 raw follower IDs (no profile metadata). Cheaper and
|
|
40
44
|
* faster than `followers()` for large-scale ID harvesting.
|
|
41
45
|
*/
|
|
42
46
|
followersIds(username: string, params?: FollowersIdsParams): Promise<FollowersIdsResponse>;
|
|
47
|
+
/**
|
|
48
|
+
* Get up to 5000 raw IDs of the accounts a user follows (no profile
|
|
49
|
+
* metadata). Mirror of `followersIds()`.
|
|
50
|
+
*/
|
|
51
|
+
followingIds(username: string, params?: FollowersIdsParams): Promise<FollowersIdsResponse>;
|
|
43
52
|
/**
|
|
44
53
|
* Batch lookup multiple users by username (max 100).
|
|
45
54
|
*/
|
|
46
55
|
batch(usernames: string[]): Promise<ApiResponse<User[]>>;
|
|
56
|
+
/**
|
|
57
|
+
* Batch lookup multiple users by numeric id (max 100). Ids are sent as
|
|
58
|
+
* strings; numbers above 2^53 lose precision in JavaScript, so pass those as
|
|
59
|
+
* strings. Ids X does not return are listed in `meta.not_found`.
|
|
60
|
+
*/
|
|
61
|
+
batchByIds(ids: Array<string | number>): Promise<ApiResponse<User[]>>;
|
|
47
62
|
/**
|
|
48
63
|
* Check whether `source` follows `target` (and vice versa).
|
|
49
64
|
*/
|
|
@@ -70,6 +85,24 @@ export declare class UsersResource {
|
|
|
70
85
|
unfollow(username: string): Promise<ApiResponse<{
|
|
71
86
|
success: boolean;
|
|
72
87
|
}>>;
|
|
88
|
+
/**
|
|
89
|
+
* Mute a user with the connected X account (100 credits). Pass a username or
|
|
90
|
+
* `id:<digits>` (or `{ user_id }`). `already` is true when already muted.
|
|
91
|
+
*/
|
|
92
|
+
mute(username: string, params?: UserLookupParams): Promise<ApiResponse<MuteResult>>;
|
|
93
|
+
/**
|
|
94
|
+
* Unmute a user. Requires a connected X account.
|
|
95
|
+
*/
|
|
96
|
+
unmute(username: string, params?: UserLookupParams): Promise<ApiResponse<MuteResult>>;
|
|
97
|
+
/**
|
|
98
|
+
* Block a user with the connected X account (100 credits). Pass a username or
|
|
99
|
+
* `id:<digits>` (or `{ user_id }`).
|
|
100
|
+
*/
|
|
101
|
+
block(username: string, params?: UserLookupParams): Promise<ApiResponse<BlockResult>>;
|
|
102
|
+
/**
|
|
103
|
+
* Unblock a user. Requires a connected X account.
|
|
104
|
+
*/
|
|
105
|
+
unblock(username: string, params?: UserLookupParams): Promise<ApiResponse<BlockResult>>;
|
|
73
106
|
}
|
|
74
107
|
type PaginatedMethod<T> = (username: string, params: PaginationParams) => Promise<PaginatedResponse<T>>;
|
|
75
108
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,IAAI,EACJ,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,IAAI,EACJ,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EAClB,UAAU,EACV,WAAW,EACZ,MAAM,aAAa,CAAC;AAYrB,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;OAGG;IACG,GAAG,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAQ7B;;OAEG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAcpC;;;;;OAKG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,KAAK,CACT,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;;OAGG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;OAGG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;OAEG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAQ9D;;;;OAIG;IACG,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAQ3E;;OAEG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAQ1C;;;OAGG;IACG,qBAAqB,CACzB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,sBAA2B,GAClC,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAQ/C;;;OAGG;IACG,kBAAkB,CACtB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAQ5C;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAO1E;;OAEG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAO5E;;;OAGG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAO7F;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IAO/F;;;OAGG;IACG,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAO/F;;OAEG;IACG,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;CAMlG;AAID,KAAK,eAAe,CAAC,CAAC,IAAI,CACxB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,gBAAgB,KACrB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnC;;;GAGG;AACH,wBAAuB,YAAY,CAAC,CAAC,EACnC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAC1B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,EAC7B,QAAQ,GAAE,MAA0B,GACnC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAiBpC"}
|
|
@@ -3,18 +3,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.UsersResource = void 0;
|
|
4
4
|
exports.paginateUser = paginateUser;
|
|
5
5
|
const DEFAULT_MAX_PAGES = 100;
|
|
6
|
+
/**
|
|
7
|
+
* Path segment for a user route: the username, or `id:<user_id>` when only a numeric id was given (an empty segment
|
|
8
|
+
* would hit `/users/` and never reach the user route).
|
|
9
|
+
*/
|
|
10
|
+
function userSeg(username, userId) {
|
|
11
|
+
return username ? username : userId != null && String(userId) !== '' ? `id:${userId}` : username;
|
|
12
|
+
}
|
|
6
13
|
class UsersResource {
|
|
7
14
|
http;
|
|
8
15
|
constructor(http) {
|
|
9
16
|
this.http = http;
|
|
10
17
|
}
|
|
11
18
|
/**
|
|
12
|
-
* Get a user profile by username.
|
|
19
|
+
* Get a user profile by username. Pass `id:<digits>` as the username (or
|
|
20
|
+
* `{ user_id }`) to look a user up by numeric id.
|
|
13
21
|
*/
|
|
14
|
-
async get(username) {
|
|
22
|
+
async get(username, params = {}) {
|
|
15
23
|
return this.http.request({
|
|
16
24
|
method: 'GET',
|
|
17
|
-
path: `/users/${encodeURIComponent(username)}`,
|
|
25
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}`,
|
|
26
|
+
query: { user_id: params.user_id },
|
|
18
27
|
});
|
|
19
28
|
}
|
|
20
29
|
/**
|
|
@@ -23,8 +32,8 @@ class UsersResource {
|
|
|
23
32
|
async tweets(username, params = {}) {
|
|
24
33
|
return this.http.request({
|
|
25
34
|
method: 'GET',
|
|
26
|
-
path: `/users/${encodeURIComponent(username)}/tweets`,
|
|
27
|
-
query: { count: params.count, cursor: params.cursor },
|
|
35
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/tweets`,
|
|
36
|
+
query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
|
|
28
37
|
});
|
|
29
38
|
}
|
|
30
39
|
/**
|
|
@@ -33,18 +42,32 @@ class UsersResource {
|
|
|
33
42
|
async mentions(username, params = {}) {
|
|
34
43
|
return this.http.request({
|
|
35
44
|
method: 'GET',
|
|
36
|
-
path: `/users/${encodeURIComponent(username)}/mentions`,
|
|
37
|
-
query: {
|
|
45
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/mentions`,
|
|
46
|
+
query: {
|
|
47
|
+
count: params.count,
|
|
48
|
+
cursor: params.cursor,
|
|
49
|
+
user_id: params.user_id,
|
|
50
|
+
since: params.since,
|
|
51
|
+
until: params.until,
|
|
52
|
+
},
|
|
38
53
|
});
|
|
39
54
|
}
|
|
40
55
|
/**
|
|
41
|
-
* Get a user's followers.
|
|
56
|
+
* Get a user's followers. With `include_unavailable: true`, suspended or
|
|
57
|
+
* deactivated accounts also come back as rows `{ id, unavailable: true,
|
|
58
|
+
* unavailable_reason, ...every other field null }` (not billed). Same
|
|
59
|
+
* option on `following()` and `verifiedFollowers()`.
|
|
42
60
|
*/
|
|
43
61
|
async followers(username, params = {}) {
|
|
44
62
|
return this.http.request({
|
|
45
63
|
method: 'GET',
|
|
46
|
-
path: `/users/${encodeURIComponent(username)}/followers`,
|
|
47
|
-
query: {
|
|
64
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/followers`,
|
|
65
|
+
query: {
|
|
66
|
+
count: params.count,
|
|
67
|
+
cursor: params.cursor,
|
|
68
|
+
user_id: params.user_id,
|
|
69
|
+
include_unavailable: params.include_unavailable,
|
|
70
|
+
},
|
|
48
71
|
});
|
|
49
72
|
}
|
|
50
73
|
/**
|
|
@@ -53,8 +76,13 @@ class UsersResource {
|
|
|
53
76
|
async following(username, params = {}) {
|
|
54
77
|
return this.http.request({
|
|
55
78
|
method: 'GET',
|
|
56
|
-
path: `/users/${encodeURIComponent(username)}/following`,
|
|
57
|
-
query: {
|
|
79
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/following`,
|
|
80
|
+
query: {
|
|
81
|
+
count: params.count,
|
|
82
|
+
cursor: params.cursor,
|
|
83
|
+
user_id: params.user_id,
|
|
84
|
+
include_unavailable: params.include_unavailable,
|
|
85
|
+
},
|
|
58
86
|
});
|
|
59
87
|
}
|
|
60
88
|
/**
|
|
@@ -63,8 +91,8 @@ class UsersResource {
|
|
|
63
91
|
async replies(username, params = {}) {
|
|
64
92
|
return this.http.request({
|
|
65
93
|
method: 'GET',
|
|
66
|
-
path: `/users/${encodeURIComponent(username)}/replies`,
|
|
67
|
-
query: { count: params.count, cursor: params.cursor },
|
|
94
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/replies`,
|
|
95
|
+
query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
|
|
68
96
|
});
|
|
69
97
|
}
|
|
70
98
|
/**
|
|
@@ -73,8 +101,8 @@ class UsersResource {
|
|
|
73
101
|
async media(username, params = {}) {
|
|
74
102
|
return this.http.request({
|
|
75
103
|
method: 'GET',
|
|
76
|
-
path: `/users/${encodeURIComponent(username)}/media`,
|
|
77
|
-
query: { count: params.count, cursor: params.cursor },
|
|
104
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/media`,
|
|
105
|
+
query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
|
|
78
106
|
});
|
|
79
107
|
}
|
|
80
108
|
/**
|
|
@@ -83,8 +111,13 @@ class UsersResource {
|
|
|
83
111
|
async verifiedFollowers(username, params = {}) {
|
|
84
112
|
return this.http.request({
|
|
85
113
|
method: 'GET',
|
|
86
|
-
path: `/users/${encodeURIComponent(username)}/verified-followers`,
|
|
87
|
-
query: {
|
|
114
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/verified-followers`,
|
|
115
|
+
query: {
|
|
116
|
+
count: params.count,
|
|
117
|
+
cursor: params.cursor,
|
|
118
|
+
user_id: params.user_id,
|
|
119
|
+
include_unavailable: params.include_unavailable,
|
|
120
|
+
},
|
|
88
121
|
});
|
|
89
122
|
}
|
|
90
123
|
/**
|
|
@@ -94,8 +127,19 @@ class UsersResource {
|
|
|
94
127
|
async followersIds(username, params = {}) {
|
|
95
128
|
return this.http.request({
|
|
96
129
|
method: 'GET',
|
|
97
|
-
path: `/users/${encodeURIComponent(username)}/followers-ids`,
|
|
98
|
-
query: { count: params.count, cursor: params.cursor },
|
|
130
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/followers-ids`,
|
|
131
|
+
query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* Get up to 5000 raw IDs of the accounts a user follows (no profile
|
|
136
|
+
* metadata). Mirror of `followersIds()`.
|
|
137
|
+
*/
|
|
138
|
+
async followingIds(username, params = {}) {
|
|
139
|
+
return this.http.request({
|
|
140
|
+
method: 'GET',
|
|
141
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/following-ids`,
|
|
142
|
+
query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
|
|
99
143
|
});
|
|
100
144
|
}
|
|
101
145
|
/**
|
|
@@ -108,6 +152,18 @@ class UsersResource {
|
|
|
108
152
|
body: { usernames },
|
|
109
153
|
});
|
|
110
154
|
}
|
|
155
|
+
/**
|
|
156
|
+
* Batch lookup multiple users by numeric id (max 100). Ids are sent as
|
|
157
|
+
* strings; numbers above 2^53 lose precision in JavaScript, so pass those as
|
|
158
|
+
* strings. Ids X does not return are listed in `meta.not_found`.
|
|
159
|
+
*/
|
|
160
|
+
async batchByIds(ids) {
|
|
161
|
+
return this.http.request({
|
|
162
|
+
method: 'POST',
|
|
163
|
+
path: '/users/batch',
|
|
164
|
+
body: { ids: ids.map((id) => String(id)) },
|
|
165
|
+
});
|
|
166
|
+
}
|
|
111
167
|
/**
|
|
112
168
|
* Check whether `source` follows `target` (and vice versa).
|
|
113
169
|
*/
|
|
@@ -158,6 +214,44 @@ class UsersResource {
|
|
|
158
214
|
path: `/users/${encodeURIComponent(username)}/follow`,
|
|
159
215
|
});
|
|
160
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* Mute a user with the connected X account (100 credits). Pass a username or
|
|
219
|
+
* `id:<digits>` (or `{ user_id }`). `already` is true when already muted.
|
|
220
|
+
*/
|
|
221
|
+
async mute(username, params = {}) {
|
|
222
|
+
return this.http.request({
|
|
223
|
+
method: 'POST',
|
|
224
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/mute`,
|
|
225
|
+
});
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Unmute a user. Requires a connected X account.
|
|
229
|
+
*/
|
|
230
|
+
async unmute(username, params = {}) {
|
|
231
|
+
return this.http.request({
|
|
232
|
+
method: 'DELETE',
|
|
233
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/mute`,
|
|
234
|
+
});
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Block a user with the connected X account (100 credits). Pass a username or
|
|
238
|
+
* `id:<digits>` (or `{ user_id }`).
|
|
239
|
+
*/
|
|
240
|
+
async block(username, params = {}) {
|
|
241
|
+
return this.http.request({
|
|
242
|
+
method: 'POST',
|
|
243
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/block`,
|
|
244
|
+
});
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Unblock a user. Requires a connected X account.
|
|
248
|
+
*/
|
|
249
|
+
async unblock(username, params = {}) {
|
|
250
|
+
return this.http.request({
|
|
251
|
+
method: 'DELETE',
|
|
252
|
+
path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/block`,
|
|
253
|
+
});
|
|
254
|
+
}
|
|
161
255
|
}
|
|
162
256
|
exports.UsersResource = UsersResource;
|
|
163
257
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":";;;AAwVA,oCAsBC;AAxVD,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B;;;GAGG;AACH,SAAS,OAAO,CAAC,QAAgB,EAAE,MAAwB;IACzD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AACnG,CAAC;AAED,MAAa,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;OAGG;IACH,KAAK,CAAC,GAAG,CACP,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO;YAC7B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE;YACvE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS;YAC9E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW;YAChF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY;YACjF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY;YACjF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CACX,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU;YAC/E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CACT,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ;YAC7E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB;YAC1F,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB;YACrF,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAA6C,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB;YACrF,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAA6C,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,EAAE,SAAS,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,GAA2B;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB;YAC1C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,QAAgB,EAChB,SAAiC,EAAE;QAEnC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB;YAC/C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,0BAA0B;YACtE,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE;SAClF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CACtB,QAAgB,EAChB,MAA2B;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsB;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,uBAAuB;YACnE,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,SAAS;SACtD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,SAAS;SACtD,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,SAA2B,EAAE;QACxD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa;YACnC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO;SAC7E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,SAA2B,EAAE;QAC1D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa;YACnC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO;SAC7E,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,SAA2B,EAAE;QACzD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,SAA2B,EAAE;QAC3D,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc;YACpC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ;SAC9E,CAAC,CAAC;IACL,CAAC;CACF;AA3SD,sCA2SC;AASD;;;GAGG;AACI,KAAK,SAAS,CAAC,CAAC,YAAY,CACjC,MAA0B,EAC1B,QAAgB,EAChB,SAA2B,EAAE,EAC7B,WAAmB,iBAAiB;IAEpC,IAAI,MAAM,GAAuB,MAAM,CAAC,MAAM,CAAC;IAC/C,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,OAAO,OAAO,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAE5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC;QACb,CAAC;QAED,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC;QAC/C,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC"}
|