rettiwt-api 6.0.8 → 6.1.1
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/.github/ISSUE_TEMPLATE/bug-report.yml +57 -0
- package/.github/ISSUE_TEMPLATE/feature-request.yml +20 -0
- package/.github/ISSUE_TEMPLATE/question.yml +15 -0
- package/.github/PULL_REQUEST_TEMPLATE.md +32 -0
- package/.github/workflows/ci.yml +33 -0
- package/.nvmrc +1 -0
- package/README.md +30 -6
- package/dist/Rettiwt.d.ts +3 -0
- package/dist/Rettiwt.js +4 -0
- package/dist/Rettiwt.js.map +1 -1
- package/dist/cli.js +2 -0
- package/dist/cli.js.map +1 -1
- package/dist/collections/Extractors.d.ts +24 -0
- package/dist/collections/Extractors.js +14 -0
- package/dist/collections/Extractors.js.map +1 -1
- package/dist/collections/Groups.js +11 -0
- package/dist/collections/Groups.js.map +1 -1
- package/dist/collections/Requests.js +12 -0
- package/dist/collections/Requests.js.map +1 -1
- package/dist/commands/DirectMessage.d.ts +10 -0
- package/dist/commands/DirectMessage.js +57 -0
- package/dist/commands/DirectMessage.js.map +1 -0
- package/dist/commands/List.js +44 -3
- package/dist/commands/List.js.map +1 -1
- package/dist/commands/Tweet.js +29 -1
- package/dist/commands/Tweet.js.map +1 -1
- package/dist/commands/User.js +39 -1
- package/dist/commands/User.js.map +1 -1
- package/dist/enums/Data.d.ts +3 -1
- package/dist/enums/Data.js +2 -0
- package/dist/enums/Data.js.map +1 -1
- package/dist/enums/Resource.d.ts +11 -0
- package/dist/enums/Resource.js +12 -0
- package/dist/enums/Resource.js.map +1 -1
- package/dist/enums/raw/Analytics.d.ts +6 -3
- package/dist/enums/raw/Analytics.js +5 -2
- package/dist/enums/raw/Analytics.js.map +1 -1
- package/dist/index.d.ts +15 -0
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -1
- package/dist/models/args/FetchArgs.d.ts +9 -0
- package/dist/models/args/FetchArgs.js +16 -0
- package/dist/models/args/FetchArgs.js.map +1 -1
- package/dist/models/args/PostArgs.d.ts +1 -0
- package/dist/models/args/PostArgs.js +2 -0
- package/dist/models/args/PostArgs.js.map +1 -1
- package/dist/models/data/Analytics.d.ts +43 -0
- package/dist/models/data/Analytics.js +92 -0
- package/dist/models/data/Analytics.js.map +1 -0
- package/dist/models/data/Conversation.d.ts +93 -0
- package/dist/models/data/Conversation.js +293 -0
- package/dist/models/data/Conversation.js.map +1 -0
- package/dist/models/data/CursoredData.d.ts +2 -1
- package/dist/models/data/CursoredData.js +6 -1
- package/dist/models/data/CursoredData.js.map +1 -1
- package/dist/models/data/DirectMessage.d.ts +105 -0
- package/dist/models/data/DirectMessage.js +284 -0
- package/dist/models/data/DirectMessage.js.map +1 -0
- package/dist/models/data/Inbox.d.ts +44 -0
- package/dist/models/data/Inbox.js +106 -0
- package/dist/models/data/Inbox.js.map +1 -0
- package/dist/models/data/List.d.ts +20 -0
- package/dist/models/data/List.js +50 -1
- package/dist/models/data/List.js.map +1 -1
- package/dist/models/data/Tweet.d.ts +6 -6
- package/dist/models/data/Tweet.js +4 -2
- package/dist/models/data/Tweet.js.map +1 -1
- package/dist/models/data/User.d.ts +2 -0
- package/dist/models/data/User.js +6 -0
- package/dist/models/data/User.js.map +1 -1
- package/dist/requests/DirectMessage.d.ts +28 -0
- package/dist/requests/DirectMessage.js +149 -0
- package/dist/requests/DirectMessage.js.map +1 -0
- package/dist/requests/List.d.ts +10 -0
- package/dist/requests/List.js +52 -0
- package/dist/requests/List.js.map +1 -1
- package/dist/requests/Tweet.d.ts +8 -0
- package/dist/requests/Tweet.js +30 -0
- package/dist/requests/Tweet.js.map +1 -1
- package/dist/requests/User.d.ts +8 -1
- package/dist/requests/User.js +67 -8
- package/dist/requests/User.js.map +1 -1
- package/dist/services/public/DirectMessageService.d.ts +100 -0
- package/dist/services/public/DirectMessageService.js +143 -0
- package/dist/services/public/DirectMessageService.js.map +1 -0
- package/dist/services/public/FetcherService.d.ts +2 -2
- package/dist/services/public/FetcherService.js +4 -4
- package/dist/services/public/FetcherService.js.map +1 -1
- package/dist/services/public/ListService.d.ts +85 -0
- package/dist/services/public/ListService.js +111 -0
- package/dist/services/public/ListService.js.map +1 -1
- package/dist/services/public/TweetService.d.ts +56 -0
- package/dist/services/public/TweetService.js +72 -0
- package/dist/services/public/TweetService.js.map +1 -1
- package/dist/services/public/UserService.d.ts +61 -2
- package/dist/services/public/UserService.js +89 -0
- package/dist/services/public/UserService.js.map +1 -1
- package/dist/types/args/FetchArgs.d.ts +69 -12
- package/dist/types/args/PostArgs.d.ts +29 -11
- package/dist/types/data/Analytics.d.ts +42 -0
- package/dist/types/data/Analytics.js +3 -0
- package/dist/types/data/Analytics.js.map +1 -0
- package/dist/types/data/Conversation.d.ts +32 -0
- package/dist/types/data/Conversation.js +3 -0
- package/dist/types/data/Conversation.js.map +1 -0
- package/dist/types/data/CursoredData.d.ts +4 -1
- package/dist/types/data/DirectMessage.d.ts +25 -0
- package/dist/types/data/DirectMessage.js +3 -0
- package/dist/types/data/DirectMessage.js.map +1 -0
- package/dist/types/data/Inbox.d.ts +18 -0
- package/dist/types/data/Inbox.js +3 -0
- package/dist/types/data/Inbox.js.map +1 -0
- package/dist/types/data/List.d.ts +5 -1
- package/dist/types/data/Tweet.d.ts +6 -6
- package/dist/types/data/User.d.ts +4 -0
- package/dist/types/raw/base/Analytic.d.ts +6 -1
- package/dist/types/raw/base/Message.d.ts +16 -0
- package/dist/types/raw/base/Message.js +4 -0
- package/dist/types/raw/base/Message.js.map +1 -0
- package/dist/types/raw/base/Tweet.d.ts +6 -6
- package/dist/types/raw/base/User.d.ts +2 -1
- package/dist/types/raw/composite/TimelineList.d.ts +9 -0
- package/dist/types/raw/composite/TimelineList.js +3 -0
- package/dist/types/raw/composite/TimelineList.js.map +1 -0
- package/dist/types/raw/dm/Conversation.d.ts +55 -0
- package/dist/types/raw/dm/Conversation.js +4 -0
- package/dist/types/raw/dm/Conversation.js.map +1 -0
- package/dist/types/raw/dm/InboxInitial.d.ts +137 -0
- package/dist/types/raw/dm/InboxInitial.js +4 -0
- package/dist/types/raw/dm/InboxInitial.js.map +1 -0
- package/dist/types/raw/dm/InboxTimeline.d.ts +287 -0
- package/dist/types/raw/dm/InboxTimeline.js +4 -0
- package/dist/types/raw/dm/InboxTimeline.js.map +1 -0
- package/dist/types/raw/dm/UserUpdates.d.ts +41 -0
- package/dist/types/raw/dm/UserUpdates.js +4 -0
- package/dist/types/raw/dm/UserUpdates.js.map +1 -0
- package/dist/types/raw/list/AddMember.d.ts +151 -0
- package/dist/types/raw/list/AddMember.js +4 -0
- package/dist/types/raw/list/AddMember.js.map +1 -0
- package/dist/types/raw/list/Details.d.ts +44 -13
- package/dist/types/raw/list/RemoveMember.d.ts +150 -0
- package/dist/types/raw/list/RemoveMember.js +4 -0
- package/dist/types/raw/list/RemoveMember.js.map +1 -0
- package/dist/types/raw/tweet/Bookmark.d.ts +12 -0
- package/dist/types/raw/tweet/Bookmark.js +4 -0
- package/dist/types/raw/tweet/Bookmark.js.map +1 -0
- package/dist/types/raw/tweet/Unbookmark.d.ts +11 -0
- package/dist/types/raw/tweet/Unbookmark.js +4 -0
- package/dist/types/raw/tweet/Unbookmark.js.map +1 -0
- package/dist/types/raw/user/Analytics.d.ts +6 -18
- package/dist/types/raw/user/Analytics.js +0 -1
- package/dist/types/raw/user/Analytics.js.map +1 -1
- package/dist/types/raw/user/Lists.d.ts +319 -0
- package/dist/types/raw/user/Lists.js +4 -0
- package/dist/types/raw/user/Lists.js.map +1 -0
- package/eslint.config.mjs +1 -1
- package/package.json +11 -6
- package/playground/.env.example +1 -0
- package/playground/README.md +53 -0
- package/playground/index.js +15 -0
- package/playground/package.json +15 -0
- package/src/Rettiwt.ts +5 -0
- package/src/cli.ts +2 -0
- package/src/collections/Extractors.ts +29 -0
- package/src/collections/Groups.ts +11 -0
- package/src/collections/Requests.ts +20 -0
- package/src/commands/DirectMessage.ts +62 -0
- package/src/commands/List.ts +44 -3
- package/src/commands/Tweet.ts +29 -1
- package/src/commands/User.ts +65 -1
- package/src/enums/Data.ts +2 -0
- package/src/enums/Resource.ts +13 -0
- package/src/enums/raw/Analytics.ts +5 -2
- package/src/index.ts +15 -0
- package/src/models/args/FetchArgs.ts +17 -0
- package/src/models/args/PostArgs.ts +2 -0
- package/src/models/data/Analytics.ts +97 -0
- package/src/models/data/Conversation.ts +344 -0
- package/src/models/data/CursoredData.ts +7 -2
- package/src/models/data/DirectMessage.ts +335 -0
- package/src/models/data/Inbox.ts +124 -0
- package/src/models/data/List.ts +60 -1
- package/src/models/data/Tweet.ts +10 -8
- package/src/models/data/User.ts +6 -0
- package/src/requests/DirectMessage.ts +233 -0
- package/src/requests/List.ts +58 -0
- package/src/requests/Tweet.ts +32 -0
- package/src/requests/User.ts +70 -7
- package/src/services/public/DirectMessageService.ts +159 -0
- package/src/services/public/FetcherService.ts +3 -3
- package/src/services/public/ListService.ts +127 -0
- package/src/services/public/TweetService.ts +82 -0
- package/src/services/public/UserService.ts +110 -2
- package/src/types/args/FetchArgs.ts +77 -12
- package/src/types/args/PostArgs.ts +31 -11
- package/src/types/data/Analytics.ts +58 -0
- package/src/types/data/Conversation.ts +44 -0
- package/src/types/data/CursoredData.ts +4 -1
- package/src/types/data/DirectMessage.ts +33 -0
- package/src/types/data/Inbox.ts +23 -0
- package/src/types/data/List.ts +7 -1
- package/src/types/data/Tweet.ts +6 -6
- package/src/types/data/User.ts +6 -0
- package/src/types/raw/base/Analytic.ts +7 -1
- package/src/types/raw/base/Message.ts +22 -0
- package/src/types/raw/base/Tweet.ts +6 -6
- package/src/types/raw/base/User.ts +2 -1
- package/src/types/raw/composite/TimelineList.ts +10 -0
- package/src/types/raw/dm/Conversation.ts +59 -0
- package/src/types/raw/dm/InboxInitial.ts +155 -0
- package/src/types/raw/dm/InboxTimeline.ts +301 -0
- package/src/types/raw/dm/UserUpdates.ts +46 -0
- package/src/types/raw/list/AddMember.ts +175 -0
- package/src/types/raw/list/Details.ts +52 -13
- package/src/types/raw/list/RemoveMember.ts +174 -0
- package/src/types/raw/tweet/Bookmark.ts +14 -0
- package/src/types/raw/tweet/Unbookmark.ts +14 -0
- package/src/types/raw/user/Analytics.ts +6 -22
- package/src/types/raw/user/Lists.ts +378 -0
- package/tsconfig.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAoD;
|
|
1
|
+
{"version":3,"file":"ListService.js","sourceRoot":"","sources":["../../../src/services/public/ListService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAoD;AAYpD,qDAAkD;AAElD,MAAa,WAAY,SAAQ,+BAAc;IAC9C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,SAAS,CAAC,MAAc,EAAE,MAAc;QACpD,MAAM,QAAQ,GAAiB,uBAAY,CAAC,eAAe,CAAC;QAE5D,8BAA8B;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC9B,MAAM,QAAQ,GAAiB,uBAAY,CAAC,YAAY,CAAC;QAEzD,kCAAkC;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEhF,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEhD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,MAAM,QAAQ,GAAiB,uBAAY,CAAC,YAAY,CAAC;QAEzD,mCAAmC;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,YAAY,CAAC,MAAc,EAAE,MAAc;QACvD,MAAM,QAAQ,GAAiB,uBAAY,CAAC,kBAAkB,CAAC;QAE/D,sBAAsB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA4B,QAAQ,EAAE;YACxE,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,uBAAY,CAAC,WAAW,CAAC;QAE1C,2BAA2B;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAjOD,kCAiOC"}
|
|
@@ -18,6 +18,32 @@ export declare class TweetService extends FetcherService {
|
|
|
18
18
|
* @internal
|
|
19
19
|
*/
|
|
20
20
|
constructor(config: RettiwtConfig);
|
|
21
|
+
/**
|
|
22
|
+
* Bookmark a tweet.
|
|
23
|
+
*
|
|
24
|
+
* @param id - The ID of the tweet to be bookmarked.
|
|
25
|
+
*
|
|
26
|
+
* @returns Whether bookmarking was successful or not.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
*
|
|
30
|
+
* ```ts
|
|
31
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
32
|
+
*
|
|
33
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
34
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
35
|
+
*
|
|
36
|
+
* // Bookmarking the Tweet with id '1234567890'
|
|
37
|
+
* rettiwt.tweet.bookmark('1234567890')
|
|
38
|
+
* .then(res => {
|
|
39
|
+
* console.log(res);
|
|
40
|
+
* })
|
|
41
|
+
* .catch(err => {
|
|
42
|
+
* console.log(err);
|
|
43
|
+
* });
|
|
44
|
+
* ```
|
|
45
|
+
*/
|
|
46
|
+
bookmark(id: string): Promise<boolean>;
|
|
21
47
|
/**
|
|
22
48
|
* Get the details of one or more tweets.
|
|
23
49
|
*
|
|
@@ -210,6 +236,10 @@ export declare class TweetService extends FetcherService {
|
|
|
210
236
|
/**
|
|
211
237
|
* Get the list of replies to a tweet.
|
|
212
238
|
*
|
|
239
|
+
* If the target tweet is a thread,
|
|
240
|
+
* the first batch always contains all the tweets in the thread,
|
|
241
|
+
* if `sortBy` is set to {@link TweetRepliesSortType.RELEVANCE}.
|
|
242
|
+
*
|
|
213
243
|
* @param id - The ID of the target tweet.
|
|
214
244
|
* @param cursor - The cursor to the batch of replies to fetch.
|
|
215
245
|
* @param sortBy - The sorting order of the replies to fetch. Default is {@link TweetRepliesSortType.RECENT}.
|
|
@@ -391,6 +421,32 @@ export declare class TweetService extends FetcherService {
|
|
|
391
421
|
* ```
|
|
392
422
|
*/
|
|
393
423
|
stream(filter: ITweetFilter, pollingInterval?: number): AsyncGenerator<Tweet>;
|
|
424
|
+
/**
|
|
425
|
+
* Unbookmark a tweet.
|
|
426
|
+
*
|
|
427
|
+
* @param id - The ID of the target tweet.
|
|
428
|
+
*
|
|
429
|
+
* @returns Whether unbookmarking was successful or not.
|
|
430
|
+
*
|
|
431
|
+
* @example
|
|
432
|
+
*
|
|
433
|
+
* ```ts
|
|
434
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
435
|
+
*
|
|
436
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
437
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
438
|
+
*
|
|
439
|
+
* // Unbookmarking the tweet with id '1234567890'
|
|
440
|
+
* rettiwt.tweet.unbookmark('1234567890')
|
|
441
|
+
* .then(res => {
|
|
442
|
+
* console.log(res);
|
|
443
|
+
* })
|
|
444
|
+
* .catch(err => {
|
|
445
|
+
* console.log(err);
|
|
446
|
+
* });
|
|
447
|
+
* ```
|
|
448
|
+
*/
|
|
449
|
+
unbookmark(id: string): Promise<boolean>;
|
|
394
450
|
/**
|
|
395
451
|
* Unlike a tweet.
|
|
396
452
|
*
|
|
@@ -20,6 +20,41 @@ class TweetService extends FetcherService_1.FetcherService {
|
|
|
20
20
|
constructor(config) {
|
|
21
21
|
super(config);
|
|
22
22
|
}
|
|
23
|
+
/**
|
|
24
|
+
* Bookmark a tweet.
|
|
25
|
+
*
|
|
26
|
+
* @param id - The ID of the tweet to be bookmarked.
|
|
27
|
+
*
|
|
28
|
+
* @returns Whether bookmarking was successful or not.
|
|
29
|
+
*
|
|
30
|
+
* @example
|
|
31
|
+
*
|
|
32
|
+
* ```ts
|
|
33
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
34
|
+
*
|
|
35
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
36
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
37
|
+
*
|
|
38
|
+
* // Bookmarking the Tweet with id '1234567890'
|
|
39
|
+
* rettiwt.tweet.bookmark('1234567890')
|
|
40
|
+
* .then(res => {
|
|
41
|
+
* console.log(res);
|
|
42
|
+
* })
|
|
43
|
+
* .catch(err => {
|
|
44
|
+
* console.log(err);
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
async bookmark(id) {
|
|
49
|
+
const resource = Resource_1.ResourceType.TWEET_BOOKMARK;
|
|
50
|
+
// Favoriting the tweet
|
|
51
|
+
const response = await this.request(resource, {
|
|
52
|
+
id: id,
|
|
53
|
+
});
|
|
54
|
+
// Deserializing response
|
|
55
|
+
const data = Extractors_1.Extractors[resource](response) ?? false;
|
|
56
|
+
return data;
|
|
57
|
+
}
|
|
23
58
|
/**
|
|
24
59
|
* Get the details of one or more tweets.
|
|
25
60
|
*
|
|
@@ -268,6 +303,10 @@ class TweetService extends FetcherService_1.FetcherService {
|
|
|
268
303
|
/**
|
|
269
304
|
* Get the list of replies to a tweet.
|
|
270
305
|
*
|
|
306
|
+
* If the target tweet is a thread,
|
|
307
|
+
* the first batch always contains all the tweets in the thread,
|
|
308
|
+
* if `sortBy` is set to {@link TweetRepliesSortType.RELEVANCE}.
|
|
309
|
+
*
|
|
271
310
|
* @param id - The ID of the target tweet.
|
|
272
311
|
* @param cursor - The cursor to the batch of replies to fetch.
|
|
273
312
|
* @param sortBy - The sorting order of the replies to fetch. Default is {@link TweetRepliesSortType.RECENT}.
|
|
@@ -526,6 +565,39 @@ class TweetService extends FetcherService_1.FetcherService {
|
|
|
526
565
|
}
|
|
527
566
|
}
|
|
528
567
|
}
|
|
568
|
+
/**
|
|
569
|
+
* Unbookmark a tweet.
|
|
570
|
+
*
|
|
571
|
+
* @param id - The ID of the target tweet.
|
|
572
|
+
*
|
|
573
|
+
* @returns Whether unbookmarking was successful or not.
|
|
574
|
+
*
|
|
575
|
+
* @example
|
|
576
|
+
*
|
|
577
|
+
* ```ts
|
|
578
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
579
|
+
*
|
|
580
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
581
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
582
|
+
*
|
|
583
|
+
* // Unbookmarking the tweet with id '1234567890'
|
|
584
|
+
* rettiwt.tweet.unbookmark('1234567890')
|
|
585
|
+
* .then(res => {
|
|
586
|
+
* console.log(res);
|
|
587
|
+
* })
|
|
588
|
+
* .catch(err => {
|
|
589
|
+
* console.log(err);
|
|
590
|
+
* });
|
|
591
|
+
* ```
|
|
592
|
+
*/
|
|
593
|
+
async unbookmark(id) {
|
|
594
|
+
const resource = Resource_1.ResourceType.TWEET_UNBOOKMARK;
|
|
595
|
+
// Unliking the tweet
|
|
596
|
+
const response = await this.request(resource, { id: id });
|
|
597
|
+
// Deserializing the response
|
|
598
|
+
const data = Extractors_1.Extractors[resource](response) ?? false;
|
|
599
|
+
return data;
|
|
600
|
+
}
|
|
529
601
|
/**
|
|
530
602
|
* Unlike a tweet.
|
|
531
603
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../../src/services/public/TweetService.ts"],"names":[],"mappings":";;;AAAA,2BAA8B;AAE9B,6DAA0D;AAC1D,mDAAoD;AACpD,6CAAyD;
|
|
1
|
+
{"version":3,"file":"TweetService.js","sourceRoot":"","sources":["../../../src/services/public/TweetService.ts"],"names":[],"mappings":";;;AAAA,2BAA8B;AAE9B,6DAA0D;AAC1D,mDAAoD;AACpD,6CAAyD;AA2BzD,qDAAkD;AAElD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,+BAAc;IAC/C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,uBAAuB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiDG;IACI,KAAK,CAAC,OAAO,CAA8B,EAAK;QACtD,IAAI,QAAsB,CAAC;QAE3B,gEAAgE;QAChE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,OAAO,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC9D,QAAQ,GAAG,uBAAY,CAAC,iBAAiB,CAAC;YAE1C,6BAA6B;YAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAEjF,yBAAyB;YACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAEhD,OAAO,IAAsD,CAAC;QAC/D,CAAC;QACD,mEAAmE;aAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,SAAS,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YAC/D,QAAQ,GAAG,uBAAY,CAAC,kBAAkB,CAAC;YAE3C,6BAA6B;YAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA4B,QAAQ,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;YAEtF,yBAAyB;YACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAEhD,OAAO,IAAsD,CAAC;QAC/D,CAAC;QACD,+BAA+B;aAC1B,CAAC;YACL,QAAQ,GAAG,uBAAY,CAAC,aAAa,CAAC;YAEtC,6BAA6B;YAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAEzF,yBAAyB;YACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YAExD,OAAO,IAAsD,CAAC;QAC/D,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,IAAI,CAAC,EAAU;QAC3B,MAAM,QAAQ,GAAG,uBAAY,CAAC,UAAU,CAAC;QAEzC,uBAAuB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,EAAE;SACN,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,uBAAY,CAAC,YAAY,CAAC;QAE3C,sBAAsB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkFG;IACI,KAAK,CAAC,IAAI,CAAC,OAAkB;QACnC,MAAM,QAAQ,GAAG,uBAAY,CAAC,UAAU,CAAC;QAEzC,oBAAoB;QACpB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAEtF,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACI,KAAK,CAAC,OAAO,CACnB,EAAU,EACV,MAAe,EACf,SAA+B,4BAAoB,CAAC,MAAM;QAE1D,MAAM,QAAQ,GAAG,uBAAY,CAAC,aAAa,CAAC;QAE5C,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;YACpE,EAAE,EAAE,EAAE;YACN,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,OAAO,CAAC,EAAU;QAC9B,MAAM,QAAQ,GAAG,uBAAY,CAAC,aAAa,CAAC;QAE5C,uBAAuB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEjF,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAClE,MAAM,QAAQ,GAAG,uBAAY,CAAC,gBAAgB,CAAC;QAE/C,kCAAkC;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE;YACvE,EAAE,EAAE,EAAE;YACN,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACI,KAAK,CAAC,QAAQ,CAAC,OAAkB;QACvC,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,uBAAuB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAE1F,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACI,KAAK,CAAC,MAAM,CAAC,MAAoB,EAAE,KAAc,EAAE,MAAe;QACxE,MAAM,QAAQ,GAAG,uBAAY,CAAC,YAAY,CAAC;QAE3C,uCAAuC;QACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE;YACnE,MAAM,EAAE,MAAM;YACd,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAE5F,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACI,KAAK,CAAC,CAAC,MAAM,CAAC,MAAoB,EAAE,eAAe,GAAG,KAAK;QACjE,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAE7B,IAAI,MAAM,GAAuB,SAAS,CAAC;QAC3C,IAAI,OAAO,GAAuB,SAAS,CAAC;QAC5C,IAAI,WAAW,GAAuB,SAAS,CAAC;QAEhD,OAAO,IAAI,EAAE,CAAC;YACb,6FAA6F;YAC7F,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;YAErE,oBAAoB;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YAE3G,4BAA4B;YAC5B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBACjC,MAAM,KAAK,CAAC;YACb,CAAC;YAED,iDAAiD;YACjD,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACpD,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjC,CAAC;YAED,6DAA6D;YAC7D,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC3C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC;YACtB,CAAC;YACD,qEAAqE;iBAChE,CAAC;gBACL,OAAO,GAAG,WAAW,CAAC;gBACtB,MAAM,GAAG,SAAS,CAAC;YACpB,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,UAAU,CAAC,EAAU;QACjC,MAAM,QAAQ,GAAG,uBAAY,CAAC,gBAAgB,CAAC;QAE/C,qBAAqB;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEpF,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,uBAAY,CAAC,YAAY,CAAC;QAE3C,qBAAqB;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEhF,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,uBAAY,CAAC,YAAY,CAAC;QAE3C,sBAAsB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEhF,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,SAAS,CAAC,EAAU;QAChC,MAAM,QAAQ,GAAG,uBAAY,CAAC,eAAe,CAAC;QAE9C,yBAAyB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnF,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,UAAU,CAAC,EAAU;QACjC,MAAM,QAAQ,GAAG,uBAAY,CAAC,gBAAgB,CAAC;QAE/C,yBAAyB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEpF,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACI,KAAK,CAAC,MAAM,CAAC,KAA2B;QAC9C,aAAa;QACb,MAAM,IAAI,GAAG,OAAO,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAA,aAAQ,EAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;QAChF,MAAM,EAAE,GAAW,CAClB,MAAM,IAAI,CAAC,OAAO,CAAiC,uBAAY,CAAC,uBAAuB,EAAE;YACxF,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;SACtB,CAAC,CACF,CAAC,eAAe,CAAC;QAElB,SAAS;QACT,MAAM,IAAI,CAAC,OAAO,CAAU,uBAAY,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpG,WAAW;QACX,MAAM,IAAI,CAAC,OAAO,CAAU,uBAAY,CAAC,qBAAqB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAExF,OAAO,EAAE,CAAC;IACX,CAAC;CACD;AA/0BD,oCA+0BC"}
|
|
@@ -1,4 +1,7 @@
|
|
|
1
|
+
import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
|
|
2
|
+
import { Analytics } from '../../models/data/Analytics';
|
|
1
3
|
import { CursoredData } from '../../models/data/CursoredData';
|
|
4
|
+
import { List } from '../../models/data/List';
|
|
2
5
|
import { Notification } from '../../models/data/Notification';
|
|
3
6
|
import { Tweet } from '../../models/data/Tweet';
|
|
4
7
|
import { User } from '../../models/data/User';
|
|
@@ -44,6 +47,35 @@ export declare class UserService extends FetcherService {
|
|
|
44
47
|
* ```
|
|
45
48
|
*/
|
|
46
49
|
affiliates(id?: string, count?: number, cursor?: string): Promise<CursoredData<User>>;
|
|
50
|
+
/**
|
|
51
|
+
* Get the analytics overview of the logged in user.
|
|
52
|
+
*
|
|
53
|
+
* @param fromTime - The start time of the analytics period. Defaults to 7 days ago.
|
|
54
|
+
* @param toTime - The end time of the analytics period. Defaults to now.
|
|
55
|
+
* @param granularity - The granularity of the analytics data. Defaults to daily.
|
|
56
|
+
* @param metrics - The metrics to include in the analytics data. Defaults to all available metrics available.
|
|
57
|
+
* @param showVerifiedFollowers - Whether to include verified follower count and relationship counts in the response. Defaults to true.
|
|
58
|
+
*
|
|
59
|
+
* @returns The raw analytics data of the user.
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
*
|
|
63
|
+
* ```ts
|
|
64
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
65
|
+
*
|
|
66
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
67
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
68
|
+
*
|
|
69
|
+
* // Fetching the analytics overview of the logged in user
|
|
70
|
+
* rettiwt.user.analytics().then(res => {
|
|
71
|
+
* console.log(res);
|
|
72
|
+
* })
|
|
73
|
+
* .catch(err => {
|
|
74
|
+
* console.log(err);
|
|
75
|
+
* });
|
|
76
|
+
* ```
|
|
77
|
+
*/
|
|
78
|
+
analytics(fromTime?: Date, toTime?: Date, granularity?: RawAnalyticsGranularity, metrics?: RawAnalyticsMetric[], showVerifiedFollowers?: boolean): Promise<Analytics>;
|
|
47
79
|
/**
|
|
48
80
|
* Get the list of bookmarks of the logged in user.
|
|
49
81
|
*
|
|
@@ -111,8 +143,8 @@ export declare class UserService extends FetcherService {
|
|
|
111
143
|
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
112
144
|
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
113
145
|
*
|
|
114
|
-
* // Fetching the details of the User with username 'user1'
|
|
115
|
-
* rettiwt.user.details('user1')
|
|
146
|
+
* // Fetching the details of the User with username 'user1' or '@user1'
|
|
147
|
+
* rettiwt.user.details('user1') // or @user1
|
|
116
148
|
* .then(res => {
|
|
117
149
|
* console.log(res);
|
|
118
150
|
* })
|
|
@@ -334,6 +366,33 @@ export declare class UserService extends FetcherService {
|
|
|
334
366
|
* ```
|
|
335
367
|
*/
|
|
336
368
|
likes(count?: number, cursor?: string): Promise<CursoredData<Tweet>>;
|
|
369
|
+
/**
|
|
370
|
+
* Get the list of of the the logged in user. Includes both followed and owned.
|
|
371
|
+
*
|
|
372
|
+
* @param count - The number of lists to fetch, must be \<= 100.
|
|
373
|
+
* @param cursor - The cursor to the batch of likes to fetch.
|
|
374
|
+
*
|
|
375
|
+
* @returns The list of tweets liked by the target user.
|
|
376
|
+
*
|
|
377
|
+
* @example
|
|
378
|
+
*
|
|
379
|
+
* ```ts
|
|
380
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
381
|
+
*
|
|
382
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
383
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
384
|
+
*
|
|
385
|
+
* // Fetching the first 100 Lists of the logged in User
|
|
386
|
+
* rettiwt.user.lists()
|
|
387
|
+
* .then(res => {
|
|
388
|
+
* console.log(res);
|
|
389
|
+
* })
|
|
390
|
+
* .catch(err => {
|
|
391
|
+
* console.log(err);
|
|
392
|
+
* });
|
|
393
|
+
* ```
|
|
394
|
+
*/
|
|
395
|
+
lists(count?: number, cursor?: string): Promise<CursoredData<List>>;
|
|
337
396
|
/**
|
|
338
397
|
* Get the media timeline of a user.
|
|
339
398
|
*
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.UserService = void 0;
|
|
4
4
|
const Extractors_1 = require("../../collections/Extractors");
|
|
5
|
+
const Analytics_1 = require("../../enums/raw/Analytics");
|
|
5
6
|
const Resource_1 = require("../../enums/Resource");
|
|
6
7
|
const FetcherService_1 = require("./FetcherService");
|
|
7
8
|
/**
|
|
@@ -57,6 +58,53 @@ class UserService extends FetcherService_1.FetcherService {
|
|
|
57
58
|
const data = Extractors_1.Extractors[resource](response);
|
|
58
59
|
return data;
|
|
59
60
|
}
|
|
61
|
+
/**
|
|
62
|
+
* Get the analytics overview of the logged in user.
|
|
63
|
+
*
|
|
64
|
+
* @param fromTime - The start time of the analytics period. Defaults to 7 days ago.
|
|
65
|
+
* @param toTime - The end time of the analytics period. Defaults to now.
|
|
66
|
+
* @param granularity - The granularity of the analytics data. Defaults to daily.
|
|
67
|
+
* @param metrics - The metrics to include in the analytics data. Defaults to all available metrics available.
|
|
68
|
+
* @param showVerifiedFollowers - Whether to include verified follower count and relationship counts in the response. Defaults to true.
|
|
69
|
+
*
|
|
70
|
+
* @returns The raw analytics data of the user.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
*
|
|
74
|
+
* ```ts
|
|
75
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
76
|
+
*
|
|
77
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
78
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
79
|
+
*
|
|
80
|
+
* // Fetching the analytics overview of the logged in user
|
|
81
|
+
* rettiwt.user.analytics().then(res => {
|
|
82
|
+
* console.log(res);
|
|
83
|
+
* })
|
|
84
|
+
* .catch(err => {
|
|
85
|
+
* console.log(err);
|
|
86
|
+
* });
|
|
87
|
+
* ```
|
|
88
|
+
*/
|
|
89
|
+
async analytics(fromTime, toTime, granularity, metrics, showVerifiedFollowers) {
|
|
90
|
+
const resource = Resource_1.ResourceType.USER_ANALYTICS;
|
|
91
|
+
// Define default values if not provided
|
|
92
|
+
fromTime = fromTime ?? new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
93
|
+
toTime = toTime ?? new Date();
|
|
94
|
+
granularity = granularity ?? Analytics_1.RawAnalyticsGranularity.DAILY;
|
|
95
|
+
metrics = metrics ?? Object.values(Analytics_1.RawAnalyticsMetric);
|
|
96
|
+
showVerifiedFollowers = showVerifiedFollowers ?? true;
|
|
97
|
+
// Fetching raw analytics
|
|
98
|
+
const response = await this.request(resource, {
|
|
99
|
+
fromTime,
|
|
100
|
+
toTime,
|
|
101
|
+
granularity,
|
|
102
|
+
metrics,
|
|
103
|
+
showVerifiedFollowers,
|
|
104
|
+
});
|
|
105
|
+
const data = Extractors_1.Extractors[resource](response);
|
|
106
|
+
return data;
|
|
107
|
+
}
|
|
60
108
|
/**
|
|
61
109
|
* Get the list of bookmarks of the logged in user.
|
|
62
110
|
*
|
|
@@ -110,6 +158,9 @@ class UserService extends FetcherService_1.FetcherService {
|
|
|
110
158
|
// If username is given
|
|
111
159
|
if (id && isNaN(Number(id))) {
|
|
112
160
|
resource = Resource_1.ResourceType.USER_DETAILS_BY_USERNAME;
|
|
161
|
+
if (id?.startsWith('@')) {
|
|
162
|
+
id = id.slice(1);
|
|
163
|
+
}
|
|
113
164
|
}
|
|
114
165
|
// If id is given (or not, for self details)
|
|
115
166
|
else {
|
|
@@ -353,6 +404,44 @@ class UserService extends FetcherService_1.FetcherService {
|
|
|
353
404
|
const data = Extractors_1.Extractors[resource](response);
|
|
354
405
|
return data;
|
|
355
406
|
}
|
|
407
|
+
/**
|
|
408
|
+
* Get the list of of the the logged in user. Includes both followed and owned.
|
|
409
|
+
*
|
|
410
|
+
* @param count - The number of lists to fetch, must be \<= 100.
|
|
411
|
+
* @param cursor - The cursor to the batch of likes to fetch.
|
|
412
|
+
*
|
|
413
|
+
* @returns The list of tweets liked by the target user.
|
|
414
|
+
*
|
|
415
|
+
* @example
|
|
416
|
+
*
|
|
417
|
+
* ```ts
|
|
418
|
+
* import { Rettiwt } from 'rettiwt-api';
|
|
419
|
+
*
|
|
420
|
+
* // Creating a new Rettiwt instance using the given 'API_KEY'
|
|
421
|
+
* const rettiwt = new Rettiwt({ apiKey: API_KEY });
|
|
422
|
+
*
|
|
423
|
+
* // Fetching the first 100 Lists of the logged in User
|
|
424
|
+
* rettiwt.user.lists()
|
|
425
|
+
* .then(res => {
|
|
426
|
+
* console.log(res);
|
|
427
|
+
* })
|
|
428
|
+
* .catch(err => {
|
|
429
|
+
* console.log(err);
|
|
430
|
+
* });
|
|
431
|
+
* ```
|
|
432
|
+
*/
|
|
433
|
+
async lists(count, cursor) {
|
|
434
|
+
const resource = Resource_1.ResourceType.USER_LISTS;
|
|
435
|
+
// Fetching raw list of lists
|
|
436
|
+
const response = await this.request(resource, {
|
|
437
|
+
id: this.config.userId,
|
|
438
|
+
count: count,
|
|
439
|
+
cursor: cursor,
|
|
440
|
+
});
|
|
441
|
+
// Deserializing response
|
|
442
|
+
const data = Extractors_1.Extractors[resource](response);
|
|
443
|
+
return data;
|
|
444
|
+
}
|
|
356
445
|
/**
|
|
357
446
|
* Get the media timeline of a user.
|
|
358
447
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../src/services/public/UserService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,mDAAoD;
|
|
1
|
+
{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../src/services/public/UserService.ts"],"names":[],"mappings":";;;AAAA,6DAA0D;AAC1D,yDAAwF;AACxF,mDAAoD;AA4BpD,qDAAkD;AAElD;;;;GAIG;AACH,MAAa,WAAY,SAAQ,+BAAc;IAC9C;;;;OAIG;IACH,YAAmB,MAAqB;QACvC,KAAK,CAAC,MAAM,CAAC,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,UAAU,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QACnE,MAAM,QAAQ,GAAG,uBAAY,CAAC,eAAe,CAAC;QAE9C,kCAAkC;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,QAAQ,EAAE;YACtE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,KAAK,CAAC,SAAS,CACrB,QAAe,EACf,MAAa,EACb,WAAqC,EACrC,OAA8B,EAC9B,qBAA+B;QAE/B,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,wCAAwC;QACxC,QAAQ,GAAG,QAAQ,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QACtE,MAAM,GAAG,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QAC9B,WAAW,GAAG,WAAW,IAAI,mCAAuB,CAAC,KAAK,CAAC;QAC3D,OAAO,GAAG,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,8BAAkB,CAAC,CAAC;QACvD,qBAAqB,GAAG,qBAAqB,IAAI,IAAI,CAAC;QAEtD,yBAAyB;QACzB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,QAAQ;YACR,MAAM;YACN,WAAW;YACX,OAAO;YACP,qBAAqB;SACrB,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,SAAS,CAAC,KAAc,EAAE,MAAe;QACrD,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAqGM,KAAK,CAAC,OAAO,CAAC,EAAsB;QAC1C,IAAI,QAAsB,CAAC;QAE3B,wCAAwC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YACvB,QAAQ,GAAG,uBAAY,CAAC,wBAAwB,CAAC;YAEjD,uBAAuB;YACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;YAErF,yBAAyB;YACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;YAEhD,OAAO,IAAI,CAAC;QACb,CAAC;QACD,qCAAqC;aAChC,CAAC;YACL,uBAAuB;YACvB,IAAI,EAAE,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAC7B,QAAQ,GAAG,uBAAY,CAAC,wBAAwB,CAAC;gBACjD,IAAI,EAAE,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACzB,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAClB,CAAC;YACF,CAAC;YACD,4CAA4C;iBACvC,CAAC;gBACL,QAAQ,GAAG,uBAAY,CAAC,kBAAkB,CAAC;YAC5C,CAAC;YAED,iDAAiD;YACjD,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBAChC,OAAO,SAAS,CAAC;YAClB,CAAC;YAED,uBAAuB;YACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;YAEtG,yBAAyB;YACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;YAE5C,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,QAAQ,GAAG,uBAAY,CAAC,WAAW,CAAC;QAE1C,qBAAqB;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,uBAAY,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAE/F,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,QAAQ,CAAC,MAAe;QACpC,MAAM,QAAQ,GAAG,uBAAY,CAAC,kBAAkB,CAAC;QAEjD,8BAA8B;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,QAAQ,EAAE;YACpE,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,SAAS,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QAClE,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,iCAAiC;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,SAAS,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QAClE,MAAM,QAAQ,GAAG,uBAAY,CAAC,cAAc,CAAC;QAE7C,iCAAiC;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAyB,QAAQ,EAAE;YACrE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,UAAU,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QACnE,MAAM,QAAQ,GAAG,uBAAY,CAAC,eAAe,CAAC;QAE9C,kCAAkC;QAClC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,QAAQ,EAAE;YACtE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc,EAAE,MAAe;QACjD,MAAM,QAAQ,GAAG,uBAAY,CAAC,UAAU,CAAC;QAEzC,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,KAAK,CAAC,KAAK,CAAC,KAAc,EAAE,MAAe;QACjD,MAAM,QAAQ,GAAG,uBAAY,CAAC,UAAU,CAAC;QAEzC,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,KAAK,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QAC9D,MAAM,QAAQ,GAAG,uBAAY,CAAC,UAAU,CAAC;QAEzC,6BAA6B;QAC7B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAqB,QAAQ,EAAE;YACjE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACI,KAAK,CAAC,CAAC,aAAa,CAAC,eAAe,GAAG,KAAK;QAClD,MAAM,QAAQ,GAAG,uBAAY,CAAC,kBAAkB,CAAC;QAEjD,4DAA4D;QAC5D,IAAI,KAAK,GAAG,IAAI,CAAC;QAEjB,oDAAoD;QACpD,IAAI,MAAM,GAAuB,SAAS,CAAC;QAE3C,OAAO,IAAI,EAAE,CAAC;YACb,6FAA6F;YAC7F,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;YAErE,wDAAwD;YACxD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA6B,QAAQ,EAAE;gBACzE,KAAK,EAAE,EAAE;gBACT,MAAM,EAAE,MAAM;aACd,CAAC,CAAC;YAEH,yBAAyB;YACzB,MAAM,aAAa,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;YAErD,2DAA2D;YAC3D,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;YAEvG,+CAA+C;YAC/C,IAAI,CAAC,KAAK,EAAE,CAAC;gBACZ,0BAA0B;gBAC1B,KAAK,MAAM,YAAY,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;oBAC/C,MAAM,YAAY,CAAC;gBACpB,CAAC;YACF,CAAC;YACD,iGAAiG;iBAC5F,CAAC;gBACL,KAAK,GAAG,KAAK,CAAC;YACf,CAAC;YAED,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC;QAC7B,CAAC;IACF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,KAAK,CAAC,WAAW,CAAC,MAAe;QACvC,MAAM,QAAQ,GAAG,uBAAY,CAAC,qBAAqB,CAAC;QAEpD,8BAA8B;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,QAAQ,EAAE;YACvE,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACI,KAAK,CAAC,OAAO,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QAChE,MAAM,QAAQ,GAAG,uBAAY,CAAC,yBAAyB,CAAC;QAExD,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAgC,QAAQ,EAAE;YAC5E,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,KAAK,CAAC,aAAa,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QACtE,MAAM,QAAQ,GAAG,uBAAY,CAAC,kBAAkB,CAAC;QAEjD,qCAAqC;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAA6B,QAAQ,EAAE;YACzE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAW,EAAE,KAAc,EAAE,MAAe;QACjE,MAAM,QAAQ,GAAG,uBAAY,CAAC,aAAa,CAAC;QAE5C,8BAA8B;QAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAsB,QAAQ,EAAE;YAClE,EAAE,EAAE,EAAE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5B,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;SACd,CAAC,CAAC;QAEH,yBAAyB;QACzB,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC;QAE5C,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACI,KAAK,CAAC,QAAQ,CAAC,EAAU;QAC/B,MAAM,QAAQ,GAAG,uBAAY,CAAC,aAAa,CAAC;QAE5C,uBAAuB;QACvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAwB,uBAAY,CAAC,aAAa,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAEnG,6BAA6B;QAC7B,MAAM,IAAI,GAAG,uBAAU,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;QAErD,OAAO,IAAI,CAAC;IACb,CAAC;CACD;AAz5BD,kCAy5BC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
|
|
1
2
|
import { TweetRepliesSortType } from '../../enums/Tweet';
|
|
2
3
|
/**
|
|
3
4
|
* Options specifying the data that is to be fetched.
|
|
@@ -5,21 +6,42 @@ import { TweetRepliesSortType } from '../../enums/Tweet';
|
|
|
5
6
|
* @public
|
|
6
7
|
*/
|
|
7
8
|
export interface IFetchArgs {
|
|
9
|
+
/**
|
|
10
|
+
* The id of the active conversation.
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
* - Required only for {@link ResourceType.DM_USER_UPDATES}.
|
|
14
|
+
*/
|
|
15
|
+
activeConversationId?: string;
|
|
16
|
+
/**
|
|
17
|
+
* The maximum id of the data to fetch.
|
|
18
|
+
*
|
|
19
|
+
* @remarks
|
|
20
|
+
* - May be used for {@link ResourceType.DM_INBOX_TIMELINE} and {@link ResourceType.DM_CONVERSATION}.
|
|
21
|
+
*/
|
|
22
|
+
maxId?: string;
|
|
23
|
+
/**
|
|
24
|
+
* The id of the conversation to fetch.
|
|
25
|
+
*
|
|
26
|
+
* @remarks
|
|
27
|
+
* - Required only for {@link ResourceType.DM_CONVERSATION} and {@link ResourceType.DM_DELETE_CONVERSATION}.
|
|
28
|
+
*/
|
|
29
|
+
conversationId?: string;
|
|
8
30
|
/**
|
|
9
31
|
* The number of data items to fetch.
|
|
10
32
|
*
|
|
11
33
|
* @remarks
|
|
12
34
|
* - Works only for cursored resources.
|
|
13
|
-
* - Does not work for {@link
|
|
35
|
+
* - Does not work for {@link ResourceType.TWEET_REPLIES}.
|
|
14
36
|
* - Must be \<= 20 for:
|
|
15
|
-
* - {@link
|
|
16
|
-
* - {@link
|
|
17
|
-
* - {@link
|
|
37
|
+
* - {@link ResourceType.USER_TIMELINE}
|
|
38
|
+
* - {@link ResourceType.USER_TIMELINE}
|
|
39
|
+
* - {@link ResourceType.USER_TIMELINE_AND_REPLIES}
|
|
18
40
|
* - Must be \<= 100 for all other cursored resources.
|
|
19
|
-
* - Due a bug on Twitter's end, count does not work for {@link
|
|
41
|
+
* - Due a bug on Twitter's end, count does not work for {@link ResourceType.USER_FOLLOWERS} and {@link ResourceType.USER_FOLLOWING}.
|
|
20
42
|
* - Has not effect for:
|
|
21
|
-
* - {@link
|
|
22
|
-
* - {@link
|
|
43
|
+
* - {@link ResourceType.USER_FEED_FOLLOWED}
|
|
44
|
+
* - {@link ResourceType.USER_FEED_RECOMMENDED}
|
|
23
45
|
*/
|
|
24
46
|
count?: number;
|
|
25
47
|
/**
|
|
@@ -34,31 +56,66 @@ export interface IFetchArgs {
|
|
|
34
56
|
* The filter for searching tweets.
|
|
35
57
|
*
|
|
36
58
|
* @remarks
|
|
37
|
-
* Required when searching for tweets using {@link
|
|
59
|
+
* Required when searching for tweets using {@link ResourceType.TWEET_SEARCH}.
|
|
38
60
|
*/
|
|
39
61
|
filter?: ITweetFilter;
|
|
40
62
|
/**
|
|
41
63
|
* The id of the target resource.
|
|
42
64
|
*
|
|
43
65
|
* @remarks
|
|
44
|
-
* - Required for all resources except {@link
|
|
45
|
-
* - For {@link
|
|
66
|
+
* - Required for all resources except {@link ResourceType.TWEET_SEARCH} and {@link ResourceType.USER_TIMELINE_RECOMMENDED}.
|
|
67
|
+
* - For {@link ResourceType.USER_DETAILS_BY_USERNAME}, can be alphanumeric, while for others, is strictly numeric.
|
|
46
68
|
*/
|
|
47
69
|
id?: string;
|
|
48
70
|
/**
|
|
49
71
|
* The IDs of the target resources.
|
|
50
72
|
*
|
|
51
73
|
* @remarks
|
|
52
|
-
* - Required only for {@link
|
|
74
|
+
* - Required only for {@link ResourceType.TWEET_DETAILS_BULK} and {@link ResourceType.USER_DETAILS_BY_IDS_BULK}.
|
|
53
75
|
*/
|
|
54
76
|
ids?: string[];
|
|
55
77
|
/**
|
|
56
78
|
* The sorting to use for tweet results.
|
|
57
79
|
*
|
|
58
80
|
* @remarks
|
|
59
|
-
* - Only works for {@link
|
|
81
|
+
* - Only works for {@link ResourceType.TWEET_REPLIES}.
|
|
60
82
|
*/
|
|
61
83
|
sortBy?: TweetRepliesSortType;
|
|
84
|
+
/**
|
|
85
|
+
* The date to start fetching data from.
|
|
86
|
+
*
|
|
87
|
+
* @remarks
|
|
88
|
+
* - Only works for {@link EResourceType.USER_ANALYTICS}.
|
|
89
|
+
*/
|
|
90
|
+
fromTime?: Date;
|
|
91
|
+
/**
|
|
92
|
+
* The date to end fetching data at.
|
|
93
|
+
*
|
|
94
|
+
* @remarks
|
|
95
|
+
* - Only works for {@link EResourceType.USER_ANALYTICS}.
|
|
96
|
+
*/
|
|
97
|
+
toTime?: Date;
|
|
98
|
+
/**
|
|
99
|
+
* The granularity of the data to fetch.
|
|
100
|
+
*
|
|
101
|
+
* @remarks
|
|
102
|
+
* - Only works for {@link EResourceType.USER_ANALYTICS}.
|
|
103
|
+
*/
|
|
104
|
+
granularity?: RawAnalyticsGranularity;
|
|
105
|
+
/**
|
|
106
|
+
* The metrics to fetch.
|
|
107
|
+
*
|
|
108
|
+
* @remarks
|
|
109
|
+
* - Only works for {@link EResourceType.USER_ANALYTICS}.
|
|
110
|
+
*/
|
|
111
|
+
metrics?: RawAnalyticsMetric[];
|
|
112
|
+
/**
|
|
113
|
+
* Show the verified follower count and relationship counts in the response.
|
|
114
|
+
*
|
|
115
|
+
* @remarks
|
|
116
|
+
* - Only works for {@link EResourceType.USER_ANALYTICS}.
|
|
117
|
+
*/
|
|
118
|
+
showVerifiedFollowers?: boolean;
|
|
62
119
|
}
|
|
63
120
|
/**
|
|
64
121
|
* The filter to be used for searching tweets.
|
|
@@ -9,20 +9,22 @@ export interface IPostArgs {
|
|
|
9
9
|
*
|
|
10
10
|
* @remarks
|
|
11
11
|
* Required only when posting using the following resources:
|
|
12
|
-
* - {@link
|
|
13
|
-
* - {@link
|
|
14
|
-
* - {@link
|
|
15
|
-
* - {@link
|
|
16
|
-
* - {@link
|
|
17
|
-
* - {@link
|
|
18
|
-
* - {@link
|
|
12
|
+
* - {@link ResourceType.TWEET_BOOKMARK}
|
|
13
|
+
* - {@link ResourceType.TWEET_LIKE}
|
|
14
|
+
* - {@link ResourceType.TWEET_RETWEET}
|
|
15
|
+
* - {@link ResourceType.TWEET_UNBOOKMARK}
|
|
16
|
+
* - {@link ResourceType.TWEET_UNLIKE}
|
|
17
|
+
* - {@link ResourceType.TWEET_UNPOST}
|
|
18
|
+
* - {@link ResourceType.TWEET_UNRETWEET}
|
|
19
|
+
* - {@link ResourceType.USER_FOLLOW}
|
|
20
|
+
* - {@link ResourceType.USER_UNFOLLOW}
|
|
19
21
|
*/
|
|
20
22
|
id?: string;
|
|
21
23
|
/**
|
|
22
24
|
* The tweet that is to be posted.
|
|
23
25
|
*
|
|
24
26
|
* @remarks
|
|
25
|
-
* Required only when posting a tweet using {@link
|
|
27
|
+
* Required only when posting a tweet using {@link ResourceType.TWEET_POST}
|
|
26
28
|
*/
|
|
27
29
|
tweet?: INewTweet;
|
|
28
30
|
/**
|
|
@@ -30,11 +32,27 @@ export interface IPostArgs {
|
|
|
30
32
|
*
|
|
31
33
|
* @remarks
|
|
32
34
|
* Required only when uploading a media using the following resources:
|
|
33
|
-
* - {@link
|
|
34
|
-
* - {@link
|
|
35
|
-
* - {@link
|
|
35
|
+
* - {@link ResourceType.MEDIA_UPLOAD_APPEND}
|
|
36
|
+
* - {@link ResourceType.MEDIA_UPLOAD_FINALIZE}
|
|
37
|
+
* - {@link ResourceType.MEDIA_UPLOAD_INITIALIZE}
|
|
36
38
|
*/
|
|
37
39
|
upload?: IUploadArgs;
|
|
40
|
+
/**
|
|
41
|
+
* The id of the target user.
|
|
42
|
+
*
|
|
43
|
+
* @remarks
|
|
44
|
+
* Required only for the following resources:
|
|
45
|
+
* - {@link ResourceType.LIST_MEMBER_ADD}
|
|
46
|
+
* - {@link ResourceType.LIST_MEMBER_REMOVE}
|
|
47
|
+
*/
|
|
48
|
+
userId?: string;
|
|
49
|
+
/**
|
|
50
|
+
* The id of the conversation to delete.
|
|
51
|
+
*
|
|
52
|
+
* @remarks
|
|
53
|
+
* Required only when deleting a conversation using {@link ResourceType.DM_DELETE_CONVERSATION}
|
|
54
|
+
*/
|
|
55
|
+
conversationId?: string;
|
|
38
56
|
}
|
|
39
57
|
/**
|
|
40
58
|
* Configuration for the new tweet to be posted.
|