x-twitter-scraper 0.8.4 → 0.10.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/CHANGELOG.md +16 -0
- package/README.md +1 -3
- package/package.json +1 -1
- package/resources/credits.d.mts +5 -5
- package/resources/credits.d.ts +5 -5
- package/resources/credits.js +2 -2
- package/resources/credits.mjs +2 -2
- package/resources/draws.d.mts +3 -2
- package/resources/draws.d.mts.map +1 -1
- package/resources/draws.d.ts +3 -2
- package/resources/draws.d.ts.map +1 -1
- package/resources/events.d.mts +6 -2
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +6 -2
- package/resources/events.d.ts.map +1 -1
- package/resources/extractions.d.mts +672 -91
- package/resources/extractions.d.mts.map +1 -1
- package/resources/extractions.d.ts +672 -91
- package/resources/extractions.d.ts.map +1 -1
- package/resources/extractions.js +3 -2
- package/resources/extractions.js.map +1 -1
- package/resources/extractions.mjs +3 -2
- package/resources/extractions.mjs.map +1 -1
- package/resources/guest-wallets.d.mts +20 -18
- package/resources/guest-wallets.d.mts.map +1 -1
- package/resources/guest-wallets.d.ts +20 -18
- package/resources/guest-wallets.d.ts.map +1 -1
- package/resources/guest-wallets.js +9 -13
- package/resources/guest-wallets.js.map +1 -1
- package/resources/guest-wallets.mjs +9 -13
- package/resources/guest-wallets.mjs.map +1 -1
- package/resources/monitors/monitors.d.mts +8 -0
- package/resources/monitors/monitors.d.mts.map +1 -1
- package/resources/monitors/monitors.d.ts +8 -0
- package/resources/monitors/monitors.d.ts.map +1 -1
- package/resources/monitors/monitors.js.map +1 -1
- package/resources/monitors/monitors.mjs.map +1 -1
- package/resources/shared.d.mts +11 -11
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +11 -11
- package/resources/shared.d.ts.map +1 -1
- package/resources/support/attachments.d.mts +33 -0
- package/resources/support/attachments.d.mts.map +1 -0
- package/resources/support/attachments.d.ts +33 -0
- package/resources/support/attachments.d.ts.map +1 -0
- package/resources/support/attachments.js +42 -0
- package/resources/support/attachments.js.map +1 -0
- package/resources/support/attachments.mjs +38 -0
- package/resources/support/attachments.mjs.map +1 -0
- package/resources/support/index.d.mts +1 -0
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +1 -0
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/index.js +3 -1
- package/resources/support/index.js.map +1 -1
- package/resources/support/index.mjs +1 -0
- package/resources/support/index.mjs.map +1 -1
- package/resources/support/support.d.mts +4 -0
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +4 -0
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/support.js +4 -0
- package/resources/support/support.js.map +1 -1
- package/resources/support/support.mjs +4 -0
- package/resources/support/support.mjs.map +1 -1
- package/resources/x/accounts.d.mts +3 -5
- package/resources/x/accounts.d.mts.map +1 -1
- package/resources/x/accounts.d.ts +3 -5
- package/resources/x/accounts.d.ts.map +1 -1
- package/resources/x/communities/communities.d.mts +112 -0
- package/resources/x/communities/communities.d.mts.map +1 -1
- package/resources/x/communities/communities.d.ts +112 -0
- package/resources/x/communities/communities.d.ts.map +1 -1
- package/resources/x/communities/communities.js.map +1 -1
- package/resources/x/communities/communities.mjs.map +1 -1
- package/resources/x/index.d.mts +2 -2
- package/resources/x/index.d.mts.map +1 -1
- package/resources/x/index.d.ts +2 -2
- package/resources/x/index.d.ts.map +1 -1
- package/resources/x/index.js.map +1 -1
- package/resources/x/index.mjs.map +1 -1
- package/resources/x/lists.d.mts +115 -4
- package/resources/x/lists.d.mts.map +1 -1
- package/resources/x/lists.d.ts +115 -4
- package/resources/x/lists.d.ts.map +1 -1
- package/resources/x/tweets/index.d.mts +1 -1
- package/resources/x/tweets/index.d.mts.map +1 -1
- package/resources/x/tweets/index.d.ts +1 -1
- package/resources/x/tweets/index.d.ts.map +1 -1
- package/resources/x/tweets/index.js.map +1 -1
- package/resources/x/tweets/index.mjs.map +1 -1
- package/resources/x/tweets/tweets.d.mts +482 -38
- package/resources/x/tweets/tweets.d.mts.map +1 -1
- package/resources/x/tweets/tweets.d.ts +482 -38
- package/resources/x/tweets/tweets.d.ts.map +1 -1
- package/resources/x/tweets/tweets.js +5 -8
- package/resources/x/tweets/tweets.js.map +1 -1
- package/resources/x/tweets/tweets.mjs +5 -8
- package/resources/x/tweets/tweets.mjs.map +1 -1
- package/resources/x/users/index.d.mts +1 -1
- package/resources/x/users/index.d.mts.map +1 -1
- package/resources/x/users/index.d.ts +1 -1
- package/resources/x/users/index.d.ts.map +1 -1
- package/resources/x/users/index.js.map +1 -1
- package/resources/x/users/index.mjs.map +1 -1
- package/resources/x/users/users.d.mts +910 -40
- package/resources/x/users/users.d.mts.map +1 -1
- package/resources/x/users/users.d.ts +910 -40
- package/resources/x/users/users.d.ts.map +1 -1
- package/resources/x/users/users.js +12 -7
- package/resources/x/users/users.js.map +1 -1
- package/resources/x/users/users.mjs +12 -7
- package/resources/x/users/users.mjs.map +1 -1
- package/resources/x/x.d.mts +4 -4
- package/resources/x/x.d.mts.map +1 -1
- package/resources/x/x.d.ts +4 -4
- package/resources/x/x.d.ts.map +1 -1
- package/resources/x/x.js.map +1 -1
- package/resources/x/x.mjs.map +1 -1
- package/src/resources/credits.ts +5 -5
- package/src/resources/draws.ts +3 -2
- package/src/resources/events.ts +7 -2
- package/src/resources/extractions.ts +929 -185
- package/src/resources/guest-wallets.ts +20 -18
- package/src/resources/monitors/monitors.ts +10 -0
- package/src/resources/shared.ts +17 -9
- package/src/resources/support/attachments.ts +57 -0
- package/src/resources/support/index.ts +1 -0
- package/src/resources/support/support.ts +6 -0
- package/src/resources/x/accounts.ts +3 -5
- package/src/resources/x/communities/communities.ts +140 -0
- package/src/resources/x/index.ts +4 -0
- package/src/resources/x/lists.ts +143 -4
- package/src/resources/x/tweets/index.ts +1 -0
- package/src/resources/x/tweets/tweets.ts +610 -37
- package/src/resources/x/users/index.ts +3 -0
- package/src/resources/x/users/users.ts +1363 -221
- package/src/resources/x/x.ts +8 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.mts.map +1 -1
- package/version.d.ts +1 -1
- package/version.d.ts.map +1 -1
- package/version.js +1 -1
- package/version.js.map +1 -1
- package/version.mjs +1 -1
- package/version.mjs.map +1 -1
|
@@ -80,15 +80,16 @@ export class Users extends APIResource {
|
|
|
80
80
|
*
|
|
81
81
|
* @example
|
|
82
82
|
* ```ts
|
|
83
|
-
* const
|
|
84
|
-
*
|
|
83
|
+
* const response = await client.x.users.retrieveFollowers(
|
|
84
|
+
* 'id',
|
|
85
|
+
* );
|
|
85
86
|
* ```
|
|
86
87
|
*/
|
|
87
88
|
retrieveFollowers(
|
|
88
89
|
id: string,
|
|
89
90
|
query: UserRetrieveFollowersParams | null | undefined = {},
|
|
90
91
|
options?: RequestOptions,
|
|
91
|
-
): APIPromise<
|
|
92
|
+
): APIPromise<UserRetrieveFollowersResponse> {
|
|
92
93
|
return this._client.get(path`/x/users/${id}/followers`, { query, ...options });
|
|
93
94
|
}
|
|
94
95
|
|
|
@@ -114,15 +115,16 @@ export class Users extends APIResource {
|
|
|
114
115
|
*
|
|
115
116
|
* @example
|
|
116
117
|
* ```ts
|
|
117
|
-
* const
|
|
118
|
-
*
|
|
118
|
+
* const response = await client.x.users.retrieveFollowing(
|
|
119
|
+
* 'id',
|
|
120
|
+
* );
|
|
119
121
|
* ```
|
|
120
122
|
*/
|
|
121
123
|
retrieveFollowing(
|
|
122
124
|
id: string,
|
|
123
125
|
query: UserRetrieveFollowingParams | null | undefined = {},
|
|
124
126
|
options?: RequestOptions,
|
|
125
|
-
): APIPromise<
|
|
127
|
+
): APIPromise<UserRetrieveFollowingResponse> {
|
|
126
128
|
return this._client.get(path`/x/users/${id}/following`, { query, ...options });
|
|
127
129
|
}
|
|
128
130
|
|
|
@@ -180,7 +182,9 @@ export class Users extends APIResource {
|
|
|
180
182
|
}
|
|
181
183
|
|
|
182
184
|
/**
|
|
183
|
-
* Returns
|
|
185
|
+
* Returns target-authored posts and replies. Omit mode for automatic maximum
|
|
186
|
+
* coverage. Pass next_cursor unchanged. Unprefixed cursors stay legacy. Excludes
|
|
187
|
+
* other-author context.
|
|
184
188
|
*
|
|
185
189
|
* @example
|
|
186
190
|
* ```ts
|
|
@@ -214,7 +218,8 @@ export class Users extends APIResource {
|
|
|
214
218
|
}
|
|
215
219
|
|
|
216
220
|
/**
|
|
217
|
-
*
|
|
221
|
+
* Omit mode for automatic maximum coverage. Pass next_cursor unchanged. Unprefixed
|
|
222
|
+
* cursors use legacy pagination. Shape and billing stay the same.
|
|
218
223
|
*
|
|
219
224
|
* @example
|
|
220
225
|
* ```ts
|
|
@@ -236,7 +241,7 @@ export class Users extends APIResource {
|
|
|
236
241
|
*
|
|
237
242
|
* @example
|
|
238
243
|
* ```ts
|
|
239
|
-
* const
|
|
244
|
+
* const response =
|
|
240
245
|
* await client.x.users.retrieveVerifiedFollowers('id');
|
|
241
246
|
* ```
|
|
242
247
|
*/
|
|
@@ -244,7 +249,7 @@ export class Users extends APIResource {
|
|
|
244
249
|
id: string,
|
|
245
250
|
query: UserRetrieveVerifiedFollowersParams | null | undefined = {},
|
|
246
251
|
options?: RequestOptions,
|
|
247
|
-
): APIPromise<
|
|
252
|
+
): APIPromise<UserRetrieveVerifiedFollowersResponse> {
|
|
248
253
|
return this._client.get(path`/x/users/${id}/verified-followers`, { query, ...options });
|
|
249
254
|
}
|
|
250
255
|
}
|
|
@@ -538,6 +543,288 @@ export interface UserRetrieveBatchResponse {
|
|
|
538
543
|
users: Array<Shared.UserProfile>;
|
|
539
544
|
}
|
|
540
545
|
|
|
546
|
+
/**
|
|
547
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
548
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
549
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
550
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
551
|
+
* has_next_page is true.
|
|
552
|
+
*/
|
|
553
|
+
export type UserRetrieveFollowersResponse =
|
|
554
|
+
| Shared.PaginatedUsers
|
|
555
|
+
| UserRetrieveFollowersResponse.UserListCoverageResponse;
|
|
556
|
+
|
|
557
|
+
export namespace UserRetrieveFollowersResponse {
|
|
558
|
+
/**
|
|
559
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
560
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
561
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
562
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
563
|
+
* has_next_page is true.
|
|
564
|
+
*/
|
|
565
|
+
export interface UserListCoverageResponse
|
|
566
|
+
extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
|
|
567
|
+
/**
|
|
568
|
+
* Coverage evidence across parallel relationship strategies.
|
|
569
|
+
*/
|
|
570
|
+
diagnostic: UserListCoverageResponse.Diagnostic;
|
|
571
|
+
|
|
572
|
+
has_next_page?: false;
|
|
573
|
+
|
|
574
|
+
next_cursor?: '';
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
export namespace UserListCoverageResponse {
|
|
578
|
+
/**
|
|
579
|
+
* Coverage evidence across parallel relationship strategies.
|
|
580
|
+
*/
|
|
581
|
+
export interface Diagnostic {
|
|
582
|
+
/**
|
|
583
|
+
* True when every strategy exhausted its source.
|
|
584
|
+
*/
|
|
585
|
+
complete: boolean;
|
|
586
|
+
|
|
587
|
+
cursorFailureCount: number;
|
|
588
|
+
|
|
589
|
+
deadlineReached: boolean;
|
|
590
|
+
|
|
591
|
+
duplicateCount: number;
|
|
592
|
+
|
|
593
|
+
failedStrategyCount: number;
|
|
594
|
+
|
|
595
|
+
malformedCount: number;
|
|
596
|
+
|
|
597
|
+
pagesFetched: number;
|
|
598
|
+
|
|
599
|
+
/**
|
|
600
|
+
* Whether credits or the requested limit reduced output.
|
|
601
|
+
*/
|
|
602
|
+
responseTruncated: boolean;
|
|
603
|
+
|
|
604
|
+
resultLimitReached: boolean;
|
|
605
|
+
|
|
606
|
+
returnedUsers: number;
|
|
607
|
+
|
|
608
|
+
stalledStrategyCount: number;
|
|
609
|
+
|
|
610
|
+
strategies: Array<Diagnostic.Strategy>;
|
|
611
|
+
|
|
612
|
+
strategyCount: number;
|
|
613
|
+
|
|
614
|
+
uniqueUsers: number;
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
export namespace Diagnostic {
|
|
618
|
+
export interface Strategy {
|
|
619
|
+
duplicateCount: number;
|
|
620
|
+
|
|
621
|
+
pagesFetched: number;
|
|
622
|
+
|
|
623
|
+
stopReason:
|
|
624
|
+
| 'cursor_failure'
|
|
625
|
+
| 'deadline'
|
|
626
|
+
| 'exhausted'
|
|
627
|
+
| 'failed'
|
|
628
|
+
| 'page_limit'
|
|
629
|
+
| 'result_limit'
|
|
630
|
+
| 'stalled';
|
|
631
|
+
|
|
632
|
+
strategy: number;
|
|
633
|
+
|
|
634
|
+
uniqueAdded: number;
|
|
635
|
+
}
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
/**
|
|
641
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
642
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
643
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
644
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
645
|
+
* has_next_page is true.
|
|
646
|
+
*/
|
|
647
|
+
export type UserRetrieveFollowingResponse =
|
|
648
|
+
| Shared.PaginatedUsers
|
|
649
|
+
| UserRetrieveFollowingResponse.UserListCoverageResponse;
|
|
650
|
+
|
|
651
|
+
export namespace UserRetrieveFollowingResponse {
|
|
652
|
+
/**
|
|
653
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
654
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
655
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
656
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
657
|
+
* has_next_page is true.
|
|
658
|
+
*/
|
|
659
|
+
export interface UserListCoverageResponse
|
|
660
|
+
extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
|
|
661
|
+
/**
|
|
662
|
+
* Coverage evidence across parallel relationship strategies.
|
|
663
|
+
*/
|
|
664
|
+
diagnostic: UserListCoverageResponse.Diagnostic;
|
|
665
|
+
|
|
666
|
+
has_next_page?: false;
|
|
667
|
+
|
|
668
|
+
next_cursor?: '';
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
export namespace UserListCoverageResponse {
|
|
672
|
+
/**
|
|
673
|
+
* Coverage evidence across parallel relationship strategies.
|
|
674
|
+
*/
|
|
675
|
+
export interface Diagnostic {
|
|
676
|
+
/**
|
|
677
|
+
* True when every strategy exhausted its source.
|
|
678
|
+
*/
|
|
679
|
+
complete: boolean;
|
|
680
|
+
|
|
681
|
+
cursorFailureCount: number;
|
|
682
|
+
|
|
683
|
+
deadlineReached: boolean;
|
|
684
|
+
|
|
685
|
+
duplicateCount: number;
|
|
686
|
+
|
|
687
|
+
failedStrategyCount: number;
|
|
688
|
+
|
|
689
|
+
malformedCount: number;
|
|
690
|
+
|
|
691
|
+
pagesFetched: number;
|
|
692
|
+
|
|
693
|
+
/**
|
|
694
|
+
* Whether credits or the requested limit reduced output.
|
|
695
|
+
*/
|
|
696
|
+
responseTruncated: boolean;
|
|
697
|
+
|
|
698
|
+
resultLimitReached: boolean;
|
|
699
|
+
|
|
700
|
+
returnedUsers: number;
|
|
701
|
+
|
|
702
|
+
stalledStrategyCount: number;
|
|
703
|
+
|
|
704
|
+
strategies: Array<Diagnostic.Strategy>;
|
|
705
|
+
|
|
706
|
+
strategyCount: number;
|
|
707
|
+
|
|
708
|
+
uniqueUsers: number;
|
|
709
|
+
}
|
|
710
|
+
|
|
711
|
+
export namespace Diagnostic {
|
|
712
|
+
export interface Strategy {
|
|
713
|
+
duplicateCount: number;
|
|
714
|
+
|
|
715
|
+
pagesFetched: number;
|
|
716
|
+
|
|
717
|
+
stopReason:
|
|
718
|
+
| 'cursor_failure'
|
|
719
|
+
| 'deadline'
|
|
720
|
+
| 'exhausted'
|
|
721
|
+
| 'failed'
|
|
722
|
+
| 'page_limit'
|
|
723
|
+
| 'result_limit'
|
|
724
|
+
| 'stalled';
|
|
725
|
+
|
|
726
|
+
strategy: number;
|
|
727
|
+
|
|
728
|
+
uniqueAdded: number;
|
|
729
|
+
}
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
}
|
|
733
|
+
|
|
734
|
+
/**
|
|
735
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
736
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
737
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
738
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
739
|
+
* has_next_page is true.
|
|
740
|
+
*/
|
|
741
|
+
export type UserRetrieveVerifiedFollowersResponse =
|
|
742
|
+
| Shared.PaginatedUsers
|
|
743
|
+
| UserRetrieveVerifiedFollowersResponse.UserListCoverageResponse;
|
|
744
|
+
|
|
745
|
+
export namespace UserRetrieveVerifiedFollowersResponse {
|
|
746
|
+
/**
|
|
747
|
+
* Paginated user profiles. No-mode follower, following, and verified follower
|
|
748
|
+
* requests merge independent views automatically. Response fields, page size,
|
|
749
|
+
* aliases, filters, and per-returned-profile billing stay unchanged. Existing
|
|
750
|
+
* unprefixed cursors retain legacy behavior. Follow next_cursor while
|
|
751
|
+
* has_next_page is true.
|
|
752
|
+
*/
|
|
753
|
+
export interface UserListCoverageResponse
|
|
754
|
+
extends Omit<Shared.PaginatedUsers, 'has_next_page' | 'next_cursor'> {
|
|
755
|
+
/**
|
|
756
|
+
* Coverage evidence across parallel relationship strategies.
|
|
757
|
+
*/
|
|
758
|
+
diagnostic: UserListCoverageResponse.Diagnostic;
|
|
759
|
+
|
|
760
|
+
has_next_page?: false;
|
|
761
|
+
|
|
762
|
+
next_cursor?: '';
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
export namespace UserListCoverageResponse {
|
|
766
|
+
/**
|
|
767
|
+
* Coverage evidence across parallel relationship strategies.
|
|
768
|
+
*/
|
|
769
|
+
export interface Diagnostic {
|
|
770
|
+
/**
|
|
771
|
+
* True when every strategy exhausted its source.
|
|
772
|
+
*/
|
|
773
|
+
complete: boolean;
|
|
774
|
+
|
|
775
|
+
cursorFailureCount: number;
|
|
776
|
+
|
|
777
|
+
deadlineReached: boolean;
|
|
778
|
+
|
|
779
|
+
duplicateCount: number;
|
|
780
|
+
|
|
781
|
+
failedStrategyCount: number;
|
|
782
|
+
|
|
783
|
+
malformedCount: number;
|
|
784
|
+
|
|
785
|
+
pagesFetched: number;
|
|
786
|
+
|
|
787
|
+
/**
|
|
788
|
+
* Whether credits or the requested limit reduced output.
|
|
789
|
+
*/
|
|
790
|
+
responseTruncated: boolean;
|
|
791
|
+
|
|
792
|
+
resultLimitReached: boolean;
|
|
793
|
+
|
|
794
|
+
returnedUsers: number;
|
|
795
|
+
|
|
796
|
+
stalledStrategyCount: number;
|
|
797
|
+
|
|
798
|
+
strategies: Array<Diagnostic.Strategy>;
|
|
799
|
+
|
|
800
|
+
strategyCount: number;
|
|
801
|
+
|
|
802
|
+
uniqueUsers: number;
|
|
803
|
+
}
|
|
804
|
+
|
|
805
|
+
export namespace Diagnostic {
|
|
806
|
+
export interface Strategy {
|
|
807
|
+
duplicateCount: number;
|
|
808
|
+
|
|
809
|
+
pagesFetched: number;
|
|
810
|
+
|
|
811
|
+
stopReason:
|
|
812
|
+
| 'cursor_failure'
|
|
813
|
+
| 'deadline'
|
|
814
|
+
| 'exhausted'
|
|
815
|
+
| 'failed'
|
|
816
|
+
| 'page_limit'
|
|
817
|
+
| 'result_limit'
|
|
818
|
+
| 'stalled';
|
|
819
|
+
|
|
820
|
+
strategy: number;
|
|
821
|
+
|
|
822
|
+
uniqueAdded: number;
|
|
823
|
+
}
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
|
|
541
828
|
export interface UserRemoveFollowerParams {
|
|
542
829
|
/**
|
|
543
830
|
* Body param: X account identifier (@username or account ID)
|
|
@@ -568,395 +855,381 @@ export interface UserRetrieveFollowersParams {
|
|
|
568
855
|
after?: string;
|
|
569
856
|
|
|
570
857
|
/**
|
|
571
|
-
*
|
|
858
|
+
* Match any comma-separated or line-separated bio term, ignoring case.
|
|
572
859
|
*/
|
|
573
|
-
|
|
860
|
+
bioContains?: string;
|
|
574
861
|
|
|
575
862
|
/**
|
|
576
|
-
*
|
|
863
|
+
* Cursor from the previous response. Xquik cursors resume automatic coverage.
|
|
864
|
+
* Existing unprefixed cursors keep legacy standard behavior.
|
|
577
865
|
*/
|
|
578
|
-
|
|
866
|
+
cursor?: string;
|
|
579
867
|
|
|
580
868
|
/**
|
|
581
|
-
*
|
|
582
|
-
* response can contain fewer profiles because the source returned fewer or
|
|
583
|
-
* the available usage balance covers fewer results. Keep requesting next_cursor while
|
|
584
|
-
* has_next_page is true. The deprecated limit and count aliases remain accepted.
|
|
869
|
+
* Only return profiles with a location.
|
|
585
870
|
*/
|
|
586
|
-
|
|
587
|
-
}
|
|
871
|
+
hasLocation?: boolean;
|
|
588
872
|
|
|
589
|
-
export interface UserRetrieveFollowersYouKnowParams {
|
|
590
873
|
/**
|
|
591
|
-
*
|
|
874
|
+
* Only return profiles with a website.
|
|
592
875
|
*/
|
|
593
|
-
|
|
876
|
+
hasWebsite?: boolean;
|
|
594
877
|
|
|
595
878
|
/**
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
* the available usage balance covers fewer results. Keep requesting next_cursor while
|
|
599
|
-
* has_next_page is true. The deprecated limit and count aliases remain accepted.
|
|
879
|
+
* Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
|
|
880
|
+
* Prefer pageSize.
|
|
600
881
|
*/
|
|
601
|
-
|
|
602
|
-
}
|
|
882
|
+
limit?: number;
|
|
603
883
|
|
|
604
|
-
export interface UserRetrieveFollowingParams {
|
|
605
884
|
/**
|
|
606
|
-
*
|
|
885
|
+
* Match a location substring, ignoring case.
|
|
607
886
|
*/
|
|
608
|
-
|
|
887
|
+
locationContains?: string;
|
|
609
888
|
|
|
610
889
|
/**
|
|
611
|
-
*
|
|
890
|
+
* Maximum follower count. Missing counts pass this maximum.
|
|
612
891
|
*/
|
|
613
|
-
|
|
892
|
+
maxFollowers?: number;
|
|
614
893
|
|
|
615
894
|
/**
|
|
616
|
-
*
|
|
895
|
+
* Maximum following count.
|
|
617
896
|
*/
|
|
618
|
-
|
|
897
|
+
maxFollowing?: number;
|
|
619
898
|
|
|
620
899
|
/**
|
|
621
|
-
* Maximum
|
|
622
|
-
* response can contain fewer profiles because the source returned fewer or
|
|
623
|
-
* the available usage balance covers fewer results. Keep requesting next_cursor while
|
|
624
|
-
* has_next_page is true. The deprecated limit and count aliases remain accepted.
|
|
900
|
+
* Maximum post count. maxPosts is also accepted.
|
|
625
901
|
*/
|
|
626
|
-
|
|
627
|
-
}
|
|
902
|
+
maxStatuses?: number;
|
|
628
903
|
|
|
629
|
-
export interface UserRetrieveLikesParams {
|
|
630
904
|
/**
|
|
631
|
-
*
|
|
632
|
-
* or lines.
|
|
905
|
+
* Minimum account age in whole days.
|
|
633
906
|
*/
|
|
634
|
-
|
|
907
|
+
minAccountAgeDays?: number;
|
|
635
908
|
|
|
636
909
|
/**
|
|
637
|
-
*
|
|
910
|
+
* Minimum follower count. Filtering happens before billing.
|
|
638
911
|
*/
|
|
639
|
-
|
|
912
|
+
minFollowers?: number;
|
|
640
913
|
|
|
641
914
|
/**
|
|
642
|
-
*
|
|
915
|
+
* Minimum following count.
|
|
643
916
|
*/
|
|
644
|
-
|
|
917
|
+
minFollowing?: number;
|
|
645
918
|
|
|
646
919
|
/**
|
|
647
|
-
*
|
|
920
|
+
* Minimum post count. minPosts is also accepted.
|
|
648
921
|
*/
|
|
649
|
-
|
|
922
|
+
minStatuses?: number;
|
|
650
923
|
|
|
651
924
|
/**
|
|
652
|
-
*
|
|
925
|
+
* Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
|
|
926
|
+
* Coverage returns diagnostics once and rejects cursors.
|
|
653
927
|
*/
|
|
654
|
-
|
|
928
|
+
mode?: 'standard' | 'coverage';
|
|
655
929
|
|
|
656
930
|
/**
|
|
657
|
-
*
|
|
931
|
+
* Maximum user profiles: automatic 300; standard 200. Sources return fewer
|
|
932
|
+
* profiles. Continue with has_next_page.
|
|
658
933
|
*/
|
|
659
|
-
|
|
934
|
+
pageSize?: number;
|
|
660
935
|
|
|
661
936
|
/**
|
|
662
|
-
*
|
|
937
|
+
* Match a username substring, ignoring case.
|
|
663
938
|
*/
|
|
664
|
-
|
|
939
|
+
usernameContains?: string;
|
|
665
940
|
|
|
666
941
|
/**
|
|
667
|
-
*
|
|
942
|
+
* Only return verified profiles.
|
|
668
943
|
*/
|
|
669
|
-
|
|
944
|
+
verifiedOnly?: boolean;
|
|
670
945
|
|
|
671
946
|
/**
|
|
672
|
-
*
|
|
947
|
+
* Match the verification type exactly, ignoring case.
|
|
673
948
|
*/
|
|
674
|
-
|
|
949
|
+
verifiedType?: string;
|
|
950
|
+
}
|
|
675
951
|
|
|
952
|
+
export interface UserRetrieveFollowersYouKnowParams {
|
|
676
953
|
/**
|
|
677
|
-
*
|
|
954
|
+
* Match any comma-separated or line-separated bio term, ignoring case.
|
|
678
955
|
*/
|
|
679
|
-
|
|
956
|
+
bioContains?: string;
|
|
680
957
|
|
|
681
958
|
/**
|
|
682
|
-
*
|
|
959
|
+
* Pagination cursor for followers-you-know
|
|
683
960
|
*/
|
|
684
|
-
|
|
961
|
+
cursor?: string;
|
|
685
962
|
|
|
686
963
|
/**
|
|
687
|
-
*
|
|
964
|
+
* Only return profiles with a location.
|
|
688
965
|
*/
|
|
689
|
-
|
|
966
|
+
hasLocation?: boolean;
|
|
690
967
|
|
|
691
968
|
/**
|
|
692
|
-
*
|
|
969
|
+
* Only return profiles with a website.
|
|
693
970
|
*/
|
|
694
|
-
|
|
971
|
+
hasWebsite?: boolean;
|
|
695
972
|
|
|
696
973
|
/**
|
|
697
|
-
*
|
|
974
|
+
* Match a location substring, ignoring case.
|
|
698
975
|
*/
|
|
699
|
-
|
|
976
|
+
locationContains?: string;
|
|
700
977
|
|
|
701
978
|
/**
|
|
702
|
-
*
|
|
979
|
+
* Maximum follower count. Missing counts pass this maximum.
|
|
703
980
|
*/
|
|
704
|
-
|
|
981
|
+
maxFollowers?: number;
|
|
705
982
|
|
|
706
983
|
/**
|
|
707
|
-
*
|
|
984
|
+
* Maximum following count.
|
|
708
985
|
*/
|
|
709
|
-
|
|
986
|
+
maxFollowing?: number;
|
|
710
987
|
|
|
711
988
|
/**
|
|
712
|
-
* Maximum
|
|
713
|
-
* results. Continue while has_next_page is true. Deprecated limit and count
|
|
714
|
-
* aliases remain accepted.
|
|
989
|
+
* Maximum post count. maxPosts is also accepted.
|
|
715
990
|
*/
|
|
716
|
-
|
|
991
|
+
maxStatuses?: number;
|
|
717
992
|
|
|
718
993
|
/**
|
|
719
|
-
*
|
|
994
|
+
* Minimum account age in whole days.
|
|
720
995
|
*/
|
|
721
|
-
|
|
996
|
+
minAccountAgeDays?: number;
|
|
722
997
|
|
|
723
998
|
/**
|
|
724
|
-
*
|
|
999
|
+
* Minimum follower count. Filtering happens before billing.
|
|
725
1000
|
*/
|
|
726
|
-
|
|
1001
|
+
minFollowers?: number;
|
|
727
1002
|
|
|
728
1003
|
/**
|
|
729
|
-
*
|
|
1004
|
+
* Minimum following count.
|
|
730
1005
|
*/
|
|
731
|
-
|
|
1006
|
+
minFollowing?: number;
|
|
732
1007
|
|
|
733
1008
|
/**
|
|
734
|
-
*
|
|
1009
|
+
* Minimum post count. minPosts is also accepted.
|
|
735
1010
|
*/
|
|
736
|
-
|
|
1011
|
+
minStatuses?: number;
|
|
737
1012
|
|
|
738
1013
|
/**
|
|
739
|
-
*
|
|
1014
|
+
* Maximum user profiles requested from this page (20-200, default 200). Source,
|
|
1015
|
+
* filters, or credits can return fewer profiles. Keep requesting next_cursor while
|
|
1016
|
+
* has_next_page is true. Deprecated aliases remain accepted.
|
|
740
1017
|
*/
|
|
741
|
-
|
|
1018
|
+
pageSize?: number;
|
|
742
1019
|
|
|
743
1020
|
/**
|
|
744
|
-
*
|
|
1021
|
+
* Match a username substring, ignoring case.
|
|
745
1022
|
*/
|
|
746
|
-
|
|
1023
|
+
usernameContains?: string;
|
|
747
1024
|
|
|
748
1025
|
/**
|
|
749
|
-
*
|
|
1026
|
+
* Only return verified profiles.
|
|
750
1027
|
*/
|
|
751
|
-
|
|
1028
|
+
verifiedOnly?: boolean;
|
|
752
1029
|
|
|
753
1030
|
/**
|
|
754
|
-
*
|
|
1031
|
+
* Match the verification type exactly, ignoring case.
|
|
755
1032
|
*/
|
|
756
|
-
|
|
1033
|
+
verifiedType?: string;
|
|
1034
|
+
}
|
|
757
1035
|
|
|
1036
|
+
export interface UserRetrieveFollowingParams {
|
|
758
1037
|
/**
|
|
759
|
-
*
|
|
1038
|
+
* Deprecated following cursor alias. Prefer cursor.
|
|
760
1039
|
*/
|
|
761
|
-
|
|
1040
|
+
after?: string;
|
|
762
1041
|
|
|
763
1042
|
/**
|
|
764
|
-
*
|
|
1043
|
+
* Match any comma-separated or line-separated bio term, ignoring case.
|
|
765
1044
|
*/
|
|
766
|
-
|
|
767
|
-
}
|
|
1045
|
+
bioContains?: string;
|
|
768
1046
|
|
|
769
|
-
export interface UserRetrieveMediaParams {
|
|
770
1047
|
/**
|
|
771
|
-
*
|
|
772
|
-
*
|
|
1048
|
+
* Cursor from the previous response. Xquik cursors resume automatic coverage.
|
|
1049
|
+
* Existing unprefixed cursors keep legacy standard behavior.
|
|
773
1050
|
*/
|
|
774
|
-
|
|
1051
|
+
cursor?: string;
|
|
775
1052
|
|
|
776
1053
|
/**
|
|
777
|
-
*
|
|
1054
|
+
* Only return profiles with a location.
|
|
778
1055
|
*/
|
|
779
|
-
|
|
1056
|
+
hasLocation?: boolean;
|
|
780
1057
|
|
|
781
1058
|
/**
|
|
782
|
-
*
|
|
1059
|
+
* Only return profiles with a website.
|
|
783
1060
|
*/
|
|
784
|
-
|
|
1061
|
+
hasWebsite?: boolean;
|
|
785
1062
|
|
|
786
1063
|
/**
|
|
787
|
-
*
|
|
1064
|
+
* Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
|
|
1065
|
+
* Prefer pageSize.
|
|
788
1066
|
*/
|
|
789
|
-
|
|
1067
|
+
limit?: number;
|
|
790
1068
|
|
|
791
1069
|
/**
|
|
792
|
-
*
|
|
1070
|
+
* Match a location substring, ignoring case.
|
|
793
1071
|
*/
|
|
794
|
-
|
|
1072
|
+
locationContains?: string;
|
|
795
1073
|
|
|
796
1074
|
/**
|
|
797
|
-
*
|
|
1075
|
+
* Maximum follower count. Missing counts pass this maximum.
|
|
798
1076
|
*/
|
|
799
|
-
|
|
1077
|
+
maxFollowers?: number;
|
|
800
1078
|
|
|
801
1079
|
/**
|
|
802
|
-
*
|
|
1080
|
+
* Maximum following count.
|
|
803
1081
|
*/
|
|
804
|
-
|
|
1082
|
+
maxFollowing?: number;
|
|
805
1083
|
|
|
806
1084
|
/**
|
|
807
|
-
*
|
|
1085
|
+
* Maximum post count. maxPosts is also accepted.
|
|
808
1086
|
*/
|
|
809
|
-
|
|
1087
|
+
maxStatuses?: number;
|
|
810
1088
|
|
|
811
1089
|
/**
|
|
812
|
-
*
|
|
1090
|
+
* Minimum account age in whole days.
|
|
813
1091
|
*/
|
|
814
|
-
|
|
1092
|
+
minAccountAgeDays?: number;
|
|
815
1093
|
|
|
816
1094
|
/**
|
|
817
|
-
*
|
|
1095
|
+
* Minimum follower count. Filtering happens before billing.
|
|
818
1096
|
*/
|
|
819
|
-
|
|
1097
|
+
minFollowers?: number;
|
|
820
1098
|
|
|
821
1099
|
/**
|
|
822
|
-
*
|
|
1100
|
+
* Minimum following count.
|
|
823
1101
|
*/
|
|
824
|
-
|
|
1102
|
+
minFollowing?: number;
|
|
825
1103
|
|
|
826
1104
|
/**
|
|
827
|
-
*
|
|
1105
|
+
* Minimum post count. minPosts is also accepted.
|
|
828
1106
|
*/
|
|
829
|
-
|
|
1107
|
+
minStatuses?: number;
|
|
830
1108
|
|
|
831
1109
|
/**
|
|
832
|
-
*
|
|
1110
|
+
* Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
|
|
1111
|
+
* Coverage returns diagnostics once and rejects cursors.
|
|
833
1112
|
*/
|
|
834
|
-
|
|
1113
|
+
mode?: 'standard' | 'coverage';
|
|
835
1114
|
|
|
836
1115
|
/**
|
|
837
|
-
*
|
|
1116
|
+
* Maximum user profiles: automatic 300; standard 200. Sources return fewer
|
|
1117
|
+
* profiles. Continue with has_next_page.
|
|
838
1118
|
*/
|
|
839
|
-
|
|
1119
|
+
pageSize?: number;
|
|
840
1120
|
|
|
841
1121
|
/**
|
|
842
|
-
*
|
|
1122
|
+
* Match a username substring, ignoring case.
|
|
843
1123
|
*/
|
|
844
|
-
|
|
1124
|
+
usernameContains?: string;
|
|
845
1125
|
|
|
846
1126
|
/**
|
|
847
|
-
*
|
|
1127
|
+
* Only return verified profiles.
|
|
848
1128
|
*/
|
|
849
|
-
|
|
1129
|
+
verifiedOnly?: boolean;
|
|
850
1130
|
|
|
851
1131
|
/**
|
|
852
|
-
*
|
|
853
|
-
* results. Continue while has_next_page is true. Deprecated limit and count
|
|
854
|
-
* aliases remain accepted.
|
|
1132
|
+
* Match the verification type exactly, ignoring case.
|
|
855
1133
|
*/
|
|
856
|
-
|
|
1134
|
+
verifiedType?: string;
|
|
1135
|
+
}
|
|
857
1136
|
|
|
1137
|
+
export interface UserRetrieveLikesParams {
|
|
858
1138
|
/**
|
|
859
|
-
*
|
|
1139
|
+
* Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
1140
|
+
* or lines.
|
|
860
1141
|
*/
|
|
861
|
-
|
|
1142
|
+
anyWords?: string;
|
|
862
1143
|
|
|
863
1144
|
/**
|
|
864
|
-
* Only
|
|
1145
|
+
* Only return tweets from Blue-verified authors.
|
|
865
1146
|
*/
|
|
866
|
-
|
|
1147
|
+
blueVerifiedOnly?: boolean;
|
|
867
1148
|
|
|
868
1149
|
/**
|
|
869
|
-
*
|
|
1150
|
+
* Match the Tweet card name.
|
|
870
1151
|
*/
|
|
871
|
-
|
|
1152
|
+
cardName?: string;
|
|
872
1153
|
|
|
873
1154
|
/**
|
|
874
|
-
*
|
|
1155
|
+
* Cashtags separated by spaces, commas, or lines.
|
|
875
1156
|
*/
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
/**
|
|
879
|
-
* Only retweets of this tweet ID.
|
|
880
|
-
*/
|
|
881
|
-
retweetsOfTweetId?: string;
|
|
1157
|
+
cashtags?: string;
|
|
882
1158
|
|
|
883
1159
|
/**
|
|
884
|
-
*
|
|
1160
|
+
* Conversation ID filter.
|
|
885
1161
|
*/
|
|
886
|
-
|
|
1162
|
+
conversationId?: string;
|
|
887
1163
|
|
|
888
1164
|
/**
|
|
889
|
-
*
|
|
1165
|
+
* Pagination cursor for liked tweets
|
|
890
1166
|
*/
|
|
891
|
-
|
|
1167
|
+
cursor?: string;
|
|
892
1168
|
|
|
893
1169
|
/**
|
|
894
|
-
*
|
|
1170
|
+
* Exact phrase to match.
|
|
895
1171
|
*/
|
|
896
|
-
|
|
1172
|
+
exactPhrase?: string;
|
|
897
1173
|
|
|
898
1174
|
/**
|
|
899
|
-
*
|
|
1175
|
+
* Exclude a source application.
|
|
900
1176
|
*/
|
|
901
|
-
|
|
1177
|
+
excludeSource?: string;
|
|
902
1178
|
|
|
903
1179
|
/**
|
|
904
|
-
*
|
|
1180
|
+
* Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
905
1181
|
*/
|
|
906
|
-
|
|
907
|
-
}
|
|
1182
|
+
excludeWords?: string;
|
|
908
1183
|
|
|
909
|
-
export interface UserRetrieveMentionsParams {
|
|
910
1184
|
/**
|
|
911
|
-
*
|
|
912
|
-
* or lines.
|
|
1185
|
+
* Filter by author username.
|
|
913
1186
|
*/
|
|
914
|
-
|
|
1187
|
+
fromUser?: string;
|
|
915
1188
|
|
|
916
1189
|
/**
|
|
917
|
-
*
|
|
1190
|
+
* Match latitude, longitude, and radius.
|
|
918
1191
|
*/
|
|
919
|
-
|
|
1192
|
+
geocode?: string;
|
|
920
1193
|
|
|
921
1194
|
/**
|
|
922
|
-
*
|
|
1195
|
+
* Hashtags separated by spaces, commas, or lines.
|
|
923
1196
|
*/
|
|
924
|
-
|
|
1197
|
+
hashtags?: string;
|
|
925
1198
|
|
|
926
1199
|
/**
|
|
927
|
-
*
|
|
1200
|
+
* Only replies to this tweet ID.
|
|
928
1201
|
*/
|
|
929
|
-
|
|
1202
|
+
inReplyToTweetId?: string;
|
|
930
1203
|
|
|
931
1204
|
/**
|
|
932
|
-
*
|
|
1205
|
+
* Language code filter, e.g. en or tr.
|
|
933
1206
|
*/
|
|
934
|
-
|
|
1207
|
+
language?: string;
|
|
935
1208
|
|
|
936
1209
|
/**
|
|
937
|
-
*
|
|
1210
|
+
* Maximum likes threshold. maxLikes is also accepted.
|
|
938
1211
|
*/
|
|
939
|
-
|
|
1212
|
+
maxFaves?: number;
|
|
940
1213
|
|
|
941
1214
|
/**
|
|
942
|
-
*
|
|
1215
|
+
* Return Tweets older than this Tweet ID.
|
|
943
1216
|
*/
|
|
944
|
-
|
|
1217
|
+
maxId?: string;
|
|
945
1218
|
|
|
946
1219
|
/**
|
|
947
|
-
*
|
|
1220
|
+
* Maximum quotes threshold.
|
|
948
1221
|
*/
|
|
949
|
-
|
|
1222
|
+
maxQuotes?: number;
|
|
950
1223
|
|
|
951
1224
|
/**
|
|
952
|
-
*
|
|
1225
|
+
* Maximum replies threshold.
|
|
953
1226
|
*/
|
|
954
|
-
|
|
1227
|
+
maxReplies?: number;
|
|
955
1228
|
|
|
956
1229
|
/**
|
|
957
|
-
*
|
|
1230
|
+
* Maximum retweets threshold.
|
|
958
1231
|
*/
|
|
959
|
-
|
|
1232
|
+
maxRetweets?: number;
|
|
960
1233
|
|
|
961
1234
|
/**
|
|
962
1235
|
* Filter by media type.
|
|
@@ -968,6 +1241,11 @@ export interface UserRetrieveMentionsParams {
|
|
|
968
1241
|
*/
|
|
969
1242
|
mentioning?: string;
|
|
970
1243
|
|
|
1244
|
+
/**
|
|
1245
|
+
* Minimum bookmark count threshold.
|
|
1246
|
+
*/
|
|
1247
|
+
minBookmarks?: number;
|
|
1248
|
+
|
|
971
1249
|
/**
|
|
972
1250
|
* Minimum likes threshold.
|
|
973
1251
|
*/
|
|
@@ -988,6 +1266,26 @@ export interface UserRetrieveMentionsParams {
|
|
|
988
1266
|
*/
|
|
989
1267
|
minRetweets?: number;
|
|
990
1268
|
|
|
1269
|
+
/**
|
|
1270
|
+
* Minimum view count threshold.
|
|
1271
|
+
*/
|
|
1272
|
+
minViews?: number;
|
|
1273
|
+
|
|
1274
|
+
/**
|
|
1275
|
+
* Only return native reposts.
|
|
1276
|
+
*/
|
|
1277
|
+
nativeRetweets?: boolean;
|
|
1278
|
+
|
|
1279
|
+
/**
|
|
1280
|
+
* Match a place name.
|
|
1281
|
+
*/
|
|
1282
|
+
near?: string;
|
|
1283
|
+
|
|
1284
|
+
/**
|
|
1285
|
+
* Only return news results.
|
|
1286
|
+
*/
|
|
1287
|
+
news?: boolean;
|
|
1288
|
+
|
|
991
1289
|
/**
|
|
992
1290
|
* Maximum page items (1-100, default 20). Source, filters, or credits can reduce
|
|
993
1291
|
* results. Continue while has_next_page is true. Deprecated limit and count
|
|
@@ -1020,15 +1318,25 @@ export interface UserRetrieveMentionsParams {
|
|
|
1020
1318
|
*/
|
|
1021
1319
|
retweetsOfTweetId?: string;
|
|
1022
1320
|
|
|
1321
|
+
/**
|
|
1322
|
+
* Enable the safe-search filter.
|
|
1323
|
+
*/
|
|
1324
|
+
safe?: boolean;
|
|
1325
|
+
|
|
1023
1326
|
/**
|
|
1024
1327
|
* Start date in YYYY-MM-DD format.
|
|
1025
1328
|
*/
|
|
1026
1329
|
sinceDate?: string;
|
|
1027
1330
|
|
|
1028
1331
|
/**
|
|
1029
|
-
*
|
|
1332
|
+
* Return Tweets newer than this Tweet ID.
|
|
1030
1333
|
*/
|
|
1031
|
-
|
|
1334
|
+
sinceId?: string;
|
|
1335
|
+
|
|
1336
|
+
/**
|
|
1337
|
+
* Match the source application.
|
|
1338
|
+
*/
|
|
1339
|
+
source?: string;
|
|
1032
1340
|
|
|
1033
1341
|
/**
|
|
1034
1342
|
* Filter replies sent to a username.
|
|
@@ -1040,11 +1348,6 @@ export interface UserRetrieveMentionsParams {
|
|
|
1040
1348
|
*/
|
|
1041
1349
|
untilDate?: string;
|
|
1042
1350
|
|
|
1043
|
-
/**
|
|
1044
|
-
* Unix timestamp - return mentions before this time
|
|
1045
|
-
*/
|
|
1046
|
-
untilTime?: string;
|
|
1047
|
-
|
|
1048
1351
|
/**
|
|
1049
1352
|
* URL substring or domain filter.
|
|
1050
1353
|
*/
|
|
@@ -1054,15 +1357,35 @@ export interface UserRetrieveMentionsParams {
|
|
|
1054
1357
|
* Only return tweets from verified authors.
|
|
1055
1358
|
*/
|
|
1056
1359
|
verifiedOnly?: boolean;
|
|
1360
|
+
|
|
1361
|
+
/**
|
|
1362
|
+
* Set the radius for the near filter.
|
|
1363
|
+
*/
|
|
1364
|
+
within?: string;
|
|
1365
|
+
|
|
1366
|
+
/**
|
|
1367
|
+
* Match Tweets inside a recent time window.
|
|
1368
|
+
*/
|
|
1369
|
+
withinTime?: string;
|
|
1057
1370
|
}
|
|
1058
1371
|
|
|
1059
|
-
export interface
|
|
1372
|
+
export interface UserRetrieveMediaParams {
|
|
1060
1373
|
/**
|
|
1061
1374
|
* Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
1062
1375
|
* or lines.
|
|
1063
1376
|
*/
|
|
1064
1377
|
anyWords?: string;
|
|
1065
1378
|
|
|
1379
|
+
/**
|
|
1380
|
+
* Only return tweets from Blue-verified authors.
|
|
1381
|
+
*/
|
|
1382
|
+
blueVerifiedOnly?: boolean;
|
|
1383
|
+
|
|
1384
|
+
/**
|
|
1385
|
+
* Match the Tweet card name.
|
|
1386
|
+
*/
|
|
1387
|
+
cardName?: string;
|
|
1388
|
+
|
|
1066
1389
|
/**
|
|
1067
1390
|
* Cashtags separated by spaces, commas, or lines.
|
|
1068
1391
|
*/
|
|
@@ -1074,7 +1397,7 @@ export interface UserRetrieveRepliesParams {
|
|
|
1074
1397
|
conversationId?: string;
|
|
1075
1398
|
|
|
1076
1399
|
/**
|
|
1077
|
-
* Pagination cursor for
|
|
1400
|
+
* Pagination cursor for media tweets
|
|
1078
1401
|
*/
|
|
1079
1402
|
cursor?: string;
|
|
1080
1403
|
|
|
@@ -1083,6 +1406,11 @@ export interface UserRetrieveRepliesParams {
|
|
|
1083
1406
|
*/
|
|
1084
1407
|
exactPhrase?: string;
|
|
1085
1408
|
|
|
1409
|
+
/**
|
|
1410
|
+
* Exclude a source application.
|
|
1411
|
+
*/
|
|
1412
|
+
excludeSource?: string;
|
|
1413
|
+
|
|
1086
1414
|
/**
|
|
1087
1415
|
* Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
1088
1416
|
*/
|
|
@@ -1094,14 +1422,14 @@ export interface UserRetrieveRepliesParams {
|
|
|
1094
1422
|
fromUser?: string;
|
|
1095
1423
|
|
|
1096
1424
|
/**
|
|
1097
|
-
*
|
|
1425
|
+
* Match latitude, longitude, and radius.
|
|
1098
1426
|
*/
|
|
1099
|
-
|
|
1427
|
+
geocode?: string;
|
|
1100
1428
|
|
|
1101
1429
|
/**
|
|
1102
|
-
*
|
|
1430
|
+
* Hashtags separated by spaces, commas, or lines.
|
|
1103
1431
|
*/
|
|
1104
|
-
|
|
1432
|
+
hashtags?: string;
|
|
1105
1433
|
|
|
1106
1434
|
/**
|
|
1107
1435
|
* Only replies to this tweet ID.
|
|
@@ -1113,6 +1441,31 @@ export interface UserRetrieveRepliesParams {
|
|
|
1113
1441
|
*/
|
|
1114
1442
|
language?: string;
|
|
1115
1443
|
|
|
1444
|
+
/**
|
|
1445
|
+
* Maximum likes threshold. maxLikes is also accepted.
|
|
1446
|
+
*/
|
|
1447
|
+
maxFaves?: number;
|
|
1448
|
+
|
|
1449
|
+
/**
|
|
1450
|
+
* Return Tweets older than this Tweet ID.
|
|
1451
|
+
*/
|
|
1452
|
+
maxId?: string;
|
|
1453
|
+
|
|
1454
|
+
/**
|
|
1455
|
+
* Maximum quotes threshold.
|
|
1456
|
+
*/
|
|
1457
|
+
maxQuotes?: number;
|
|
1458
|
+
|
|
1459
|
+
/**
|
|
1460
|
+
* Maximum replies threshold.
|
|
1461
|
+
*/
|
|
1462
|
+
maxReplies?: number;
|
|
1463
|
+
|
|
1464
|
+
/**
|
|
1465
|
+
* Maximum retweets threshold.
|
|
1466
|
+
*/
|
|
1467
|
+
maxRetweets?: number;
|
|
1468
|
+
|
|
1116
1469
|
/**
|
|
1117
1470
|
* Filter by media type.
|
|
1118
1471
|
*/
|
|
@@ -1123,6 +1476,11 @@ export interface UserRetrieveRepliesParams {
|
|
|
1123
1476
|
*/
|
|
1124
1477
|
mentioning?: string;
|
|
1125
1478
|
|
|
1479
|
+
/**
|
|
1480
|
+
* Minimum bookmark count threshold.
|
|
1481
|
+
*/
|
|
1482
|
+
minBookmarks?: number;
|
|
1483
|
+
|
|
1126
1484
|
/**
|
|
1127
1485
|
* Minimum likes threshold.
|
|
1128
1486
|
*/
|
|
@@ -1143,6 +1501,26 @@ export interface UserRetrieveRepliesParams {
|
|
|
1143
1501
|
*/
|
|
1144
1502
|
minRetweets?: number;
|
|
1145
1503
|
|
|
1504
|
+
/**
|
|
1505
|
+
* Minimum view count threshold.
|
|
1506
|
+
*/
|
|
1507
|
+
minViews?: number;
|
|
1508
|
+
|
|
1509
|
+
/**
|
|
1510
|
+
* Only return native reposts.
|
|
1511
|
+
*/
|
|
1512
|
+
nativeRetweets?: boolean;
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* Match a place name.
|
|
1516
|
+
*/
|
|
1517
|
+
near?: string;
|
|
1518
|
+
|
|
1519
|
+
/**
|
|
1520
|
+
* Only return news results.
|
|
1521
|
+
*/
|
|
1522
|
+
news?: boolean;
|
|
1523
|
+
|
|
1146
1524
|
/**
|
|
1147
1525
|
* Maximum page items (1-100, default 20). Source, filters, or credits can reduce
|
|
1148
1526
|
* results. Continue while has_next_page is true. Deprecated limit and count
|
|
@@ -1175,11 +1553,26 @@ export interface UserRetrieveRepliesParams {
|
|
|
1175
1553
|
*/
|
|
1176
1554
|
retweetsOfTweetId?: string;
|
|
1177
1555
|
|
|
1556
|
+
/**
|
|
1557
|
+
* Enable the safe-search filter.
|
|
1558
|
+
*/
|
|
1559
|
+
safe?: boolean;
|
|
1560
|
+
|
|
1178
1561
|
/**
|
|
1179
1562
|
* Start date in YYYY-MM-DD format.
|
|
1180
1563
|
*/
|
|
1181
1564
|
sinceDate?: string;
|
|
1182
1565
|
|
|
1566
|
+
/**
|
|
1567
|
+
* Return Tweets newer than this Tweet ID.
|
|
1568
|
+
*/
|
|
1569
|
+
sinceId?: string;
|
|
1570
|
+
|
|
1571
|
+
/**
|
|
1572
|
+
* Match the source application.
|
|
1573
|
+
*/
|
|
1574
|
+
source?: string;
|
|
1575
|
+
|
|
1183
1576
|
/**
|
|
1184
1577
|
* Filter replies sent to a username.
|
|
1185
1578
|
*/
|
|
@@ -1199,27 +1592,35 @@ export interface UserRetrieveRepliesParams {
|
|
|
1199
1592
|
* Only return tweets from verified authors.
|
|
1200
1593
|
*/
|
|
1201
1594
|
verifiedOnly?: boolean;
|
|
1202
|
-
}
|
|
1203
1595
|
|
|
1204
|
-
export interface UserRetrieveSearchParams {
|
|
1205
1596
|
/**
|
|
1206
|
-
*
|
|
1597
|
+
* Set the radius for the near filter.
|
|
1207
1598
|
*/
|
|
1208
|
-
|
|
1599
|
+
within?: string;
|
|
1209
1600
|
|
|
1210
1601
|
/**
|
|
1211
|
-
*
|
|
1602
|
+
* Match Tweets inside a recent time window.
|
|
1212
1603
|
*/
|
|
1213
|
-
|
|
1604
|
+
withinTime?: string;
|
|
1214
1605
|
}
|
|
1215
1606
|
|
|
1216
|
-
export interface
|
|
1607
|
+
export interface UserRetrieveMentionsParams {
|
|
1217
1608
|
/**
|
|
1218
1609
|
* Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
1219
1610
|
* or lines.
|
|
1220
1611
|
*/
|
|
1221
1612
|
anyWords?: string;
|
|
1222
1613
|
|
|
1614
|
+
/**
|
|
1615
|
+
* Only return tweets from Blue-verified authors.
|
|
1616
|
+
*/
|
|
1617
|
+
blueVerifiedOnly?: boolean;
|
|
1618
|
+
|
|
1619
|
+
/**
|
|
1620
|
+
* Match the Tweet card name.
|
|
1621
|
+
*/
|
|
1622
|
+
cardName?: string;
|
|
1623
|
+
|
|
1223
1624
|
/**
|
|
1224
1625
|
* Cashtags separated by spaces, commas, or lines.
|
|
1225
1626
|
*/
|
|
@@ -1231,7 +1632,7 @@ export interface UserRetrieveTweetsParams {
|
|
|
1231
1632
|
conversationId?: string;
|
|
1232
1633
|
|
|
1233
1634
|
/**
|
|
1234
|
-
* Pagination cursor for
|
|
1635
|
+
* Pagination cursor for mentions
|
|
1235
1636
|
*/
|
|
1236
1637
|
cursor?: string;
|
|
1237
1638
|
|
|
@@ -1240,6 +1641,11 @@ export interface UserRetrieveTweetsParams {
|
|
|
1240
1641
|
*/
|
|
1241
1642
|
exactPhrase?: string;
|
|
1242
1643
|
|
|
1644
|
+
/**
|
|
1645
|
+
* Exclude a source application.
|
|
1646
|
+
*/
|
|
1647
|
+
excludeSource?: string;
|
|
1648
|
+
|
|
1243
1649
|
/**
|
|
1244
1650
|
* Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
1245
1651
|
*/
|
|
@@ -1250,30 +1656,50 @@ export interface UserRetrieveTweetsParams {
|
|
|
1250
1656
|
*/
|
|
1251
1657
|
fromUser?: string;
|
|
1252
1658
|
|
|
1659
|
+
/**
|
|
1660
|
+
* Match latitude, longitude, and radius.
|
|
1661
|
+
*/
|
|
1662
|
+
geocode?: string;
|
|
1663
|
+
|
|
1253
1664
|
/**
|
|
1254
1665
|
* Hashtags separated by spaces, commas, or lines.
|
|
1255
1666
|
*/
|
|
1256
1667
|
hashtags?: string;
|
|
1257
1668
|
|
|
1258
1669
|
/**
|
|
1259
|
-
*
|
|
1670
|
+
* Only replies to this tweet ID.
|
|
1260
1671
|
*/
|
|
1261
|
-
|
|
1672
|
+
inReplyToTweetId?: string;
|
|
1262
1673
|
|
|
1263
1674
|
/**
|
|
1264
|
-
*
|
|
1675
|
+
* Language code filter, e.g. en or tr.
|
|
1265
1676
|
*/
|
|
1266
|
-
|
|
1677
|
+
language?: string;
|
|
1267
1678
|
|
|
1268
1679
|
/**
|
|
1269
|
-
*
|
|
1680
|
+
* Maximum likes threshold. maxLikes is also accepted.
|
|
1270
1681
|
*/
|
|
1271
|
-
|
|
1682
|
+
maxFaves?: number;
|
|
1272
1683
|
|
|
1273
1684
|
/**
|
|
1274
|
-
*
|
|
1685
|
+
* Return Tweets older than this Tweet ID.
|
|
1275
1686
|
*/
|
|
1276
|
-
|
|
1687
|
+
maxId?: string;
|
|
1688
|
+
|
|
1689
|
+
/**
|
|
1690
|
+
* Maximum quotes threshold.
|
|
1691
|
+
*/
|
|
1692
|
+
maxQuotes?: number;
|
|
1693
|
+
|
|
1694
|
+
/**
|
|
1695
|
+
* Maximum replies threshold.
|
|
1696
|
+
*/
|
|
1697
|
+
maxReplies?: number;
|
|
1698
|
+
|
|
1699
|
+
/**
|
|
1700
|
+
* Maximum retweets threshold.
|
|
1701
|
+
*/
|
|
1702
|
+
maxRetweets?: number;
|
|
1277
1703
|
|
|
1278
1704
|
/**
|
|
1279
1705
|
* Filter by media type.
|
|
@@ -1285,6 +1711,11 @@ export interface UserRetrieveTweetsParams {
|
|
|
1285
1711
|
*/
|
|
1286
1712
|
mentioning?: string;
|
|
1287
1713
|
|
|
1714
|
+
/**
|
|
1715
|
+
* Minimum bookmark count threshold.
|
|
1716
|
+
*/
|
|
1717
|
+
minBookmarks?: number;
|
|
1718
|
+
|
|
1288
1719
|
/**
|
|
1289
1720
|
* Minimum likes threshold.
|
|
1290
1721
|
*/
|
|
@@ -1305,6 +1736,26 @@ export interface UserRetrieveTweetsParams {
|
|
|
1305
1736
|
*/
|
|
1306
1737
|
minRetweets?: number;
|
|
1307
1738
|
|
|
1739
|
+
/**
|
|
1740
|
+
* Minimum view count threshold.
|
|
1741
|
+
*/
|
|
1742
|
+
minViews?: number;
|
|
1743
|
+
|
|
1744
|
+
/**
|
|
1745
|
+
* Only return native reposts.
|
|
1746
|
+
*/
|
|
1747
|
+
nativeRetweets?: boolean;
|
|
1748
|
+
|
|
1749
|
+
/**
|
|
1750
|
+
* Match a place name.
|
|
1751
|
+
*/
|
|
1752
|
+
near?: string;
|
|
1753
|
+
|
|
1754
|
+
/**
|
|
1755
|
+
* Only return news results.
|
|
1756
|
+
*/
|
|
1757
|
+
news?: boolean;
|
|
1758
|
+
|
|
1308
1759
|
/**
|
|
1309
1760
|
* Maximum page items (1-100, default 20). Source, filters, or credits can reduce
|
|
1310
1761
|
* results. Continue while has_next_page is true. Deprecated limit and count
|
|
@@ -1337,11 +1788,31 @@ export interface UserRetrieveTweetsParams {
|
|
|
1337
1788
|
*/
|
|
1338
1789
|
retweetsOfTweetId?: string;
|
|
1339
1790
|
|
|
1791
|
+
/**
|
|
1792
|
+
* Enable the safe-search filter.
|
|
1793
|
+
*/
|
|
1794
|
+
safe?: boolean;
|
|
1795
|
+
|
|
1340
1796
|
/**
|
|
1341
1797
|
* Start date in YYYY-MM-DD format.
|
|
1342
1798
|
*/
|
|
1343
1799
|
sinceDate?: string;
|
|
1344
1800
|
|
|
1801
|
+
/**
|
|
1802
|
+
* Return Tweets newer than this Tweet ID.
|
|
1803
|
+
*/
|
|
1804
|
+
sinceId?: string;
|
|
1805
|
+
|
|
1806
|
+
/**
|
|
1807
|
+
* Unix timestamp - return mentions after this time
|
|
1808
|
+
*/
|
|
1809
|
+
sinceTime?: string;
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
* Match the source application.
|
|
1813
|
+
*/
|
|
1814
|
+
source?: string;
|
|
1815
|
+
|
|
1345
1816
|
/**
|
|
1346
1817
|
* Filter replies sent to a username.
|
|
1347
1818
|
*/
|
|
@@ -1352,6 +1823,11 @@ export interface UserRetrieveTweetsParams {
|
|
|
1352
1823
|
*/
|
|
1353
1824
|
untilDate?: string;
|
|
1354
1825
|
|
|
1826
|
+
/**
|
|
1827
|
+
* Unix timestamp - return mentions before this time
|
|
1828
|
+
*/
|
|
1829
|
+
untilTime?: string;
|
|
1830
|
+
|
|
1355
1831
|
/**
|
|
1356
1832
|
* URL substring or domain filter.
|
|
1357
1833
|
*/
|
|
@@ -1361,21 +1837,684 @@ export interface UserRetrieveTweetsParams {
|
|
|
1361
1837
|
* Only return tweets from verified authors.
|
|
1362
1838
|
*/
|
|
1363
1839
|
verifiedOnly?: boolean;
|
|
1840
|
+
|
|
1841
|
+
/**
|
|
1842
|
+
* Set the radius for the near filter.
|
|
1843
|
+
*/
|
|
1844
|
+
within?: string;
|
|
1845
|
+
|
|
1846
|
+
/**
|
|
1847
|
+
* Match Tweets inside a recent time window.
|
|
1848
|
+
*/
|
|
1849
|
+
withinTime?: string;
|
|
1364
1850
|
}
|
|
1365
1851
|
|
|
1366
|
-
export interface
|
|
1852
|
+
export interface UserRetrieveRepliesParams {
|
|
1853
|
+
/**
|
|
1854
|
+
* Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
1855
|
+
* or lines.
|
|
1856
|
+
*/
|
|
1857
|
+
anyWords?: string;
|
|
1858
|
+
|
|
1859
|
+
/**
|
|
1860
|
+
* Only return tweets from Blue-verified authors.
|
|
1861
|
+
*/
|
|
1862
|
+
blueVerifiedOnly?: boolean;
|
|
1863
|
+
|
|
1367
1864
|
/**
|
|
1368
|
-
*
|
|
1865
|
+
* Match the Tweet card name.
|
|
1866
|
+
*/
|
|
1867
|
+
cardName?: string;
|
|
1868
|
+
|
|
1869
|
+
/**
|
|
1870
|
+
* Cashtags separated by spaces, commas, or lines.
|
|
1871
|
+
*/
|
|
1872
|
+
cashtags?: string;
|
|
1873
|
+
|
|
1874
|
+
/**
|
|
1875
|
+
* Conversation ID filter.
|
|
1876
|
+
*/
|
|
1877
|
+
conversationId?: string;
|
|
1878
|
+
|
|
1879
|
+
/**
|
|
1880
|
+
* Cursor from the previous response. Xquik cursors resume automatic coverage.
|
|
1881
|
+
* Existing unprefixed cursors keep legacy standard behavior.
|
|
1369
1882
|
*/
|
|
1370
1883
|
cursor?: string;
|
|
1371
1884
|
|
|
1372
1885
|
/**
|
|
1373
|
-
*
|
|
1374
|
-
* response can contain fewer profiles because the source returned fewer or
|
|
1375
|
-
* the available usage balance covers fewer results. Keep requesting next_cursor while
|
|
1376
|
-
* has_next_page is true. The deprecated limit and count aliases remain accepted.
|
|
1886
|
+
* Exact phrase to match.
|
|
1377
1887
|
*/
|
|
1378
|
-
|
|
1888
|
+
exactPhrase?: string;
|
|
1889
|
+
|
|
1890
|
+
/**
|
|
1891
|
+
* Exclude a source application.
|
|
1892
|
+
*/
|
|
1893
|
+
excludeSource?: string;
|
|
1894
|
+
|
|
1895
|
+
/**
|
|
1896
|
+
* Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
1897
|
+
*/
|
|
1898
|
+
excludeWords?: string;
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* Filter by author username.
|
|
1902
|
+
*/
|
|
1903
|
+
fromUser?: string;
|
|
1904
|
+
|
|
1905
|
+
/**
|
|
1906
|
+
* Match latitude, longitude, and radius.
|
|
1907
|
+
*/
|
|
1908
|
+
geocode?: string;
|
|
1909
|
+
|
|
1910
|
+
/**
|
|
1911
|
+
* Hashtags separated by spaces, commas, or lines.
|
|
1912
|
+
*/
|
|
1913
|
+
hashtags?: string;
|
|
1914
|
+
|
|
1915
|
+
/**
|
|
1916
|
+
* Include each reply's parent tweet.
|
|
1917
|
+
*/
|
|
1918
|
+
includeParentTweet?: boolean;
|
|
1919
|
+
|
|
1920
|
+
/**
|
|
1921
|
+
* Only replies to this tweet ID.
|
|
1922
|
+
*/
|
|
1923
|
+
inReplyToTweetId?: string;
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* Language code filter, e.g. en or tr.
|
|
1927
|
+
*/
|
|
1928
|
+
language?: string;
|
|
1929
|
+
|
|
1930
|
+
/**
|
|
1931
|
+
* Maximum likes threshold. maxLikes is also accepted.
|
|
1932
|
+
*/
|
|
1933
|
+
maxFaves?: number;
|
|
1934
|
+
|
|
1935
|
+
/**
|
|
1936
|
+
* Return Tweets older than this Tweet ID.
|
|
1937
|
+
*/
|
|
1938
|
+
maxId?: string;
|
|
1939
|
+
|
|
1940
|
+
/**
|
|
1941
|
+
* Maximum quotes threshold.
|
|
1942
|
+
*/
|
|
1943
|
+
maxQuotes?: number;
|
|
1944
|
+
|
|
1945
|
+
/**
|
|
1946
|
+
* Maximum replies threshold.
|
|
1947
|
+
*/
|
|
1948
|
+
maxReplies?: number;
|
|
1949
|
+
|
|
1950
|
+
/**
|
|
1951
|
+
* Maximum retweets threshold.
|
|
1952
|
+
*/
|
|
1953
|
+
maxRetweets?: number;
|
|
1954
|
+
|
|
1955
|
+
/**
|
|
1956
|
+
* Filter by media type.
|
|
1957
|
+
*/
|
|
1958
|
+
mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
|
|
1959
|
+
|
|
1960
|
+
/**
|
|
1961
|
+
* Filter tweets mentioning a username.
|
|
1962
|
+
*/
|
|
1963
|
+
mentioning?: string;
|
|
1964
|
+
|
|
1965
|
+
/**
|
|
1966
|
+
* Minimum bookmark count threshold.
|
|
1967
|
+
*/
|
|
1968
|
+
minBookmarks?: number;
|
|
1969
|
+
|
|
1970
|
+
/**
|
|
1971
|
+
* Minimum likes threshold.
|
|
1972
|
+
*/
|
|
1973
|
+
minFaves?: number;
|
|
1974
|
+
|
|
1975
|
+
/**
|
|
1976
|
+
* Minimum quote count threshold.
|
|
1977
|
+
*/
|
|
1978
|
+
minQuotes?: number;
|
|
1979
|
+
|
|
1980
|
+
/**
|
|
1981
|
+
* Minimum replies threshold.
|
|
1982
|
+
*/
|
|
1983
|
+
minReplies?: number;
|
|
1984
|
+
|
|
1985
|
+
/**
|
|
1986
|
+
* Minimum retweets threshold.
|
|
1987
|
+
*/
|
|
1988
|
+
minRetweets?: number;
|
|
1989
|
+
|
|
1990
|
+
/**
|
|
1991
|
+
* Minimum view count threshold.
|
|
1992
|
+
*/
|
|
1993
|
+
minViews?: number;
|
|
1994
|
+
|
|
1995
|
+
/**
|
|
1996
|
+
* Only return native reposts.
|
|
1997
|
+
*/
|
|
1998
|
+
nativeRetweets?: boolean;
|
|
1999
|
+
|
|
2000
|
+
/**
|
|
2001
|
+
* Match a place name.
|
|
2002
|
+
*/
|
|
2003
|
+
near?: string;
|
|
2004
|
+
|
|
2005
|
+
/**
|
|
2006
|
+
* Only return news results.
|
|
2007
|
+
*/
|
|
2008
|
+
news?: boolean;
|
|
2009
|
+
|
|
2010
|
+
/**
|
|
2011
|
+
* Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
|
|
2012
|
+
* Continue while has_next_page is true. Deprecated aliases remain accepted.
|
|
2013
|
+
*/
|
|
2014
|
+
pageSize?: number;
|
|
2015
|
+
|
|
2016
|
+
/**
|
|
2017
|
+
* Quote mode.
|
|
2018
|
+
*/
|
|
2019
|
+
quotes?: 'include' | 'exclude' | 'only';
|
|
2020
|
+
|
|
2021
|
+
/**
|
|
2022
|
+
* Only quotes of this tweet ID.
|
|
2023
|
+
*/
|
|
2024
|
+
quotesOfTweetId?: string;
|
|
2025
|
+
|
|
2026
|
+
/**
|
|
2027
|
+
* Reply mode.
|
|
2028
|
+
*/
|
|
2029
|
+
replies?: 'include' | 'exclude' | 'only';
|
|
2030
|
+
|
|
2031
|
+
/**
|
|
2032
|
+
* Retweet mode.
|
|
2033
|
+
*/
|
|
2034
|
+
retweets?: 'include' | 'exclude' | 'only';
|
|
2035
|
+
|
|
2036
|
+
/**
|
|
2037
|
+
* Only retweets of this tweet ID.
|
|
2038
|
+
*/
|
|
2039
|
+
retweetsOfTweetId?: string;
|
|
2040
|
+
|
|
2041
|
+
/**
|
|
2042
|
+
* Enable the safe-search filter.
|
|
2043
|
+
*/
|
|
2044
|
+
safe?: boolean;
|
|
2045
|
+
|
|
2046
|
+
/**
|
|
2047
|
+
* Start date in YYYY-MM-DD format.
|
|
2048
|
+
*/
|
|
2049
|
+
sinceDate?: string;
|
|
2050
|
+
|
|
2051
|
+
/**
|
|
2052
|
+
* Return Tweets newer than this Tweet ID.
|
|
2053
|
+
*/
|
|
2054
|
+
sinceId?: string;
|
|
2055
|
+
|
|
2056
|
+
/**
|
|
2057
|
+
* Match the source application.
|
|
2058
|
+
*/
|
|
2059
|
+
source?: string;
|
|
2060
|
+
|
|
2061
|
+
/**
|
|
2062
|
+
* Filter replies sent to a username.
|
|
2063
|
+
*/
|
|
2064
|
+
toUser?: string;
|
|
2065
|
+
|
|
2066
|
+
/**
|
|
2067
|
+
* End date in YYYY-MM-DD format.
|
|
2068
|
+
*/
|
|
2069
|
+
untilDate?: string;
|
|
2070
|
+
|
|
2071
|
+
/**
|
|
2072
|
+
* URL substring or domain filter.
|
|
2073
|
+
*/
|
|
2074
|
+
url?: string;
|
|
2075
|
+
|
|
2076
|
+
/**
|
|
2077
|
+
* Only return tweets from verified authors.
|
|
2078
|
+
*/
|
|
2079
|
+
verifiedOnly?: boolean;
|
|
2080
|
+
|
|
2081
|
+
/**
|
|
2082
|
+
* Set the radius for the near filter.
|
|
2083
|
+
*/
|
|
2084
|
+
within?: string;
|
|
2085
|
+
|
|
2086
|
+
/**
|
|
2087
|
+
* Match Tweets inside a recent time window.
|
|
2088
|
+
*/
|
|
2089
|
+
withinTime?: string;
|
|
2090
|
+
}
|
|
2091
|
+
|
|
2092
|
+
export interface UserRetrieveSearchParams {
|
|
2093
|
+
/**
|
|
2094
|
+
* User search query
|
|
2095
|
+
*/
|
|
2096
|
+
q: string;
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
* Match any comma-separated or line-separated bio term, ignoring case.
|
|
2100
|
+
*/
|
|
2101
|
+
bioContains?: string;
|
|
2102
|
+
|
|
2103
|
+
/**
|
|
2104
|
+
* Pagination cursor for user search
|
|
2105
|
+
*/
|
|
2106
|
+
cursor?: string;
|
|
2107
|
+
|
|
2108
|
+
/**
|
|
2109
|
+
* Only return profiles with a location.
|
|
2110
|
+
*/
|
|
2111
|
+
hasLocation?: boolean;
|
|
2112
|
+
|
|
2113
|
+
/**
|
|
2114
|
+
* Only return profiles with a website.
|
|
2115
|
+
*/
|
|
2116
|
+
hasWebsite?: boolean;
|
|
2117
|
+
|
|
2118
|
+
/**
|
|
2119
|
+
* Match a location substring, ignoring case.
|
|
2120
|
+
*/
|
|
2121
|
+
locationContains?: string;
|
|
2122
|
+
|
|
2123
|
+
/**
|
|
2124
|
+
* Maximum follower count. Missing counts pass this maximum.
|
|
2125
|
+
*/
|
|
2126
|
+
maxFollowers?: number;
|
|
2127
|
+
|
|
2128
|
+
/**
|
|
2129
|
+
* Maximum following count.
|
|
2130
|
+
*/
|
|
2131
|
+
maxFollowing?: number;
|
|
2132
|
+
|
|
2133
|
+
/**
|
|
2134
|
+
* Maximum post count. maxPosts is also accepted.
|
|
2135
|
+
*/
|
|
2136
|
+
maxStatuses?: number;
|
|
2137
|
+
|
|
2138
|
+
/**
|
|
2139
|
+
* Minimum account age in whole days.
|
|
2140
|
+
*/
|
|
2141
|
+
minAccountAgeDays?: number;
|
|
2142
|
+
|
|
2143
|
+
/**
|
|
2144
|
+
* Minimum follower count. Filtering happens before billing.
|
|
2145
|
+
*/
|
|
2146
|
+
minFollowers?: number;
|
|
2147
|
+
|
|
2148
|
+
/**
|
|
2149
|
+
* Minimum following count.
|
|
2150
|
+
*/
|
|
2151
|
+
minFollowing?: number;
|
|
2152
|
+
|
|
2153
|
+
/**
|
|
2154
|
+
* Minimum post count. minPosts is also accepted.
|
|
2155
|
+
*/
|
|
2156
|
+
minStatuses?: number;
|
|
2157
|
+
|
|
2158
|
+
/**
|
|
2159
|
+
* Match a username substring, ignoring case.
|
|
2160
|
+
*/
|
|
2161
|
+
usernameContains?: string;
|
|
2162
|
+
|
|
2163
|
+
/**
|
|
2164
|
+
* Only return verified profiles.
|
|
2165
|
+
*/
|
|
2166
|
+
verifiedOnly?: boolean;
|
|
2167
|
+
|
|
2168
|
+
/**
|
|
2169
|
+
* Match the verification type exactly, ignoring case.
|
|
2170
|
+
*/
|
|
2171
|
+
verifiedType?: string;
|
|
2172
|
+
}
|
|
2173
|
+
|
|
2174
|
+
export interface UserRetrieveTweetsParams {
|
|
2175
|
+
/**
|
|
2176
|
+
* Words or quoted phrases where any one can match. Separate with spaces, commas,
|
|
2177
|
+
* or lines.
|
|
2178
|
+
*/
|
|
2179
|
+
anyWords?: string;
|
|
2180
|
+
|
|
2181
|
+
/**
|
|
2182
|
+
* Only return tweets from Blue-verified authors.
|
|
2183
|
+
*/
|
|
2184
|
+
blueVerifiedOnly?: boolean;
|
|
2185
|
+
|
|
2186
|
+
/**
|
|
2187
|
+
* Match the Tweet card name.
|
|
2188
|
+
*/
|
|
2189
|
+
cardName?: string;
|
|
2190
|
+
|
|
2191
|
+
/**
|
|
2192
|
+
* Cashtags separated by spaces, commas, or lines.
|
|
2193
|
+
*/
|
|
2194
|
+
cashtags?: string;
|
|
2195
|
+
|
|
2196
|
+
/**
|
|
2197
|
+
* Conversation ID filter.
|
|
2198
|
+
*/
|
|
2199
|
+
conversationId?: string;
|
|
2200
|
+
|
|
2201
|
+
/**
|
|
2202
|
+
* Cursor from the previous response. Xquik cursors resume automatic coverage.
|
|
2203
|
+
* Existing unprefixed cursors keep legacy standard behavior.
|
|
2204
|
+
*/
|
|
2205
|
+
cursor?: string;
|
|
2206
|
+
|
|
2207
|
+
/**
|
|
2208
|
+
* Exact phrase to match.
|
|
2209
|
+
*/
|
|
2210
|
+
exactPhrase?: string;
|
|
2211
|
+
|
|
2212
|
+
/**
|
|
2213
|
+
* Exclude a source application.
|
|
2214
|
+
*/
|
|
2215
|
+
excludeSource?: string;
|
|
2216
|
+
|
|
2217
|
+
/**
|
|
2218
|
+
* Words or quoted phrases to exclude. Separate with spaces, commas, or lines.
|
|
2219
|
+
*/
|
|
2220
|
+
excludeWords?: string;
|
|
2221
|
+
|
|
2222
|
+
/**
|
|
2223
|
+
* Filter by author username.
|
|
2224
|
+
*/
|
|
2225
|
+
fromUser?: string;
|
|
2226
|
+
|
|
2227
|
+
/**
|
|
2228
|
+
* Match latitude, longitude, and radius.
|
|
2229
|
+
*/
|
|
2230
|
+
geocode?: string;
|
|
2231
|
+
|
|
2232
|
+
/**
|
|
2233
|
+
* Hashtags separated by spaces, commas, or lines.
|
|
2234
|
+
*/
|
|
2235
|
+
hashtags?: string;
|
|
2236
|
+
|
|
2237
|
+
/**
|
|
2238
|
+
* Include parent tweet for replies
|
|
2239
|
+
*/
|
|
2240
|
+
includeParentTweet?: boolean;
|
|
2241
|
+
|
|
2242
|
+
/**
|
|
2243
|
+
* Include reply tweets
|
|
2244
|
+
*/
|
|
2245
|
+
includeReplies?: boolean;
|
|
2246
|
+
|
|
2247
|
+
/**
|
|
2248
|
+
* Only replies to this tweet ID.
|
|
2249
|
+
*/
|
|
2250
|
+
inReplyToTweetId?: string;
|
|
2251
|
+
|
|
2252
|
+
/**
|
|
2253
|
+
* Language code filter, e.g. en or tr.
|
|
2254
|
+
*/
|
|
2255
|
+
language?: string;
|
|
2256
|
+
|
|
2257
|
+
/**
|
|
2258
|
+
* Maximum likes threshold. maxLikes is also accepted.
|
|
2259
|
+
*/
|
|
2260
|
+
maxFaves?: number;
|
|
2261
|
+
|
|
2262
|
+
/**
|
|
2263
|
+
* Return Tweets older than this Tweet ID.
|
|
2264
|
+
*/
|
|
2265
|
+
maxId?: string;
|
|
2266
|
+
|
|
2267
|
+
/**
|
|
2268
|
+
* Maximum quotes threshold.
|
|
2269
|
+
*/
|
|
2270
|
+
maxQuotes?: number;
|
|
2271
|
+
|
|
2272
|
+
/**
|
|
2273
|
+
* Maximum replies threshold.
|
|
2274
|
+
*/
|
|
2275
|
+
maxReplies?: number;
|
|
2276
|
+
|
|
2277
|
+
/**
|
|
2278
|
+
* Maximum retweets threshold.
|
|
2279
|
+
*/
|
|
2280
|
+
maxRetweets?: number;
|
|
2281
|
+
|
|
2282
|
+
/**
|
|
2283
|
+
* Filter by media type.
|
|
2284
|
+
*/
|
|
2285
|
+
mediaType?: 'images' | 'videos' | 'gifs' | 'media' | 'links' | 'none';
|
|
2286
|
+
|
|
2287
|
+
/**
|
|
2288
|
+
* Filter tweets mentioning a username.
|
|
2289
|
+
*/
|
|
2290
|
+
mentioning?: string;
|
|
2291
|
+
|
|
2292
|
+
/**
|
|
2293
|
+
* Minimum bookmark count threshold.
|
|
2294
|
+
*/
|
|
2295
|
+
minBookmarks?: number;
|
|
2296
|
+
|
|
2297
|
+
/**
|
|
2298
|
+
* Minimum likes threshold.
|
|
2299
|
+
*/
|
|
2300
|
+
minFaves?: number;
|
|
2301
|
+
|
|
2302
|
+
/**
|
|
2303
|
+
* Minimum quote count threshold.
|
|
2304
|
+
*/
|
|
2305
|
+
minQuotes?: number;
|
|
2306
|
+
|
|
2307
|
+
/**
|
|
2308
|
+
* Minimum replies threshold.
|
|
2309
|
+
*/
|
|
2310
|
+
minReplies?: number;
|
|
2311
|
+
|
|
2312
|
+
/**
|
|
2313
|
+
* Minimum retweets threshold.
|
|
2314
|
+
*/
|
|
2315
|
+
minRetweets?: number;
|
|
2316
|
+
|
|
2317
|
+
/**
|
|
2318
|
+
* Minimum view count threshold.
|
|
2319
|
+
*/
|
|
2320
|
+
minViews?: number;
|
|
2321
|
+
|
|
2322
|
+
/**
|
|
2323
|
+
* Only return native reposts.
|
|
2324
|
+
*/
|
|
2325
|
+
nativeRetweets?: boolean;
|
|
2326
|
+
|
|
2327
|
+
/**
|
|
2328
|
+
* Match a place name.
|
|
2329
|
+
*/
|
|
2330
|
+
near?: string;
|
|
2331
|
+
|
|
2332
|
+
/**
|
|
2333
|
+
* Only return news results.
|
|
2334
|
+
*/
|
|
2335
|
+
news?: boolean;
|
|
2336
|
+
|
|
2337
|
+
/**
|
|
2338
|
+
* Automatic pages accept 1-300 Tweets. Standard pages keep 1-100. Default 20.
|
|
2339
|
+
* Continue while has_next_page is true. Deprecated aliases remain accepted.
|
|
2340
|
+
*/
|
|
2341
|
+
pageSize?: number;
|
|
2342
|
+
|
|
2343
|
+
/**
|
|
2344
|
+
* Quote mode.
|
|
2345
|
+
*/
|
|
2346
|
+
quotes?: 'include' | 'exclude' | 'only';
|
|
2347
|
+
|
|
2348
|
+
/**
|
|
2349
|
+
* Only quotes of this tweet ID.
|
|
2350
|
+
*/
|
|
2351
|
+
quotesOfTweetId?: string;
|
|
2352
|
+
|
|
2353
|
+
/**
|
|
2354
|
+
* Reply mode.
|
|
2355
|
+
*/
|
|
2356
|
+
replies?: 'include' | 'exclude' | 'only';
|
|
2357
|
+
|
|
2358
|
+
/**
|
|
2359
|
+
* Retweet mode.
|
|
2360
|
+
*/
|
|
2361
|
+
retweets?: 'include' | 'exclude' | 'only';
|
|
2362
|
+
|
|
2363
|
+
/**
|
|
2364
|
+
* Only retweets of this tweet ID.
|
|
2365
|
+
*/
|
|
2366
|
+
retweetsOfTweetId?: string;
|
|
2367
|
+
|
|
2368
|
+
/**
|
|
2369
|
+
* Enable the safe-search filter.
|
|
2370
|
+
*/
|
|
2371
|
+
safe?: boolean;
|
|
2372
|
+
|
|
2373
|
+
/**
|
|
2374
|
+
* Start date in YYYY-MM-DD format.
|
|
2375
|
+
*/
|
|
2376
|
+
sinceDate?: string;
|
|
2377
|
+
|
|
2378
|
+
/**
|
|
2379
|
+
* Return Tweets newer than this Tweet ID.
|
|
2380
|
+
*/
|
|
2381
|
+
sinceId?: string;
|
|
2382
|
+
|
|
2383
|
+
/**
|
|
2384
|
+
* Match the source application.
|
|
2385
|
+
*/
|
|
2386
|
+
source?: string;
|
|
2387
|
+
|
|
2388
|
+
/**
|
|
2389
|
+
* Filter replies sent to a username.
|
|
2390
|
+
*/
|
|
2391
|
+
toUser?: string;
|
|
2392
|
+
|
|
2393
|
+
/**
|
|
2394
|
+
* End date in YYYY-MM-DD format.
|
|
2395
|
+
*/
|
|
2396
|
+
untilDate?: string;
|
|
2397
|
+
|
|
2398
|
+
/**
|
|
2399
|
+
* URL substring or domain filter.
|
|
2400
|
+
*/
|
|
2401
|
+
url?: string;
|
|
2402
|
+
|
|
2403
|
+
/**
|
|
2404
|
+
* Only return tweets from verified authors.
|
|
2405
|
+
*/
|
|
2406
|
+
verifiedOnly?: boolean;
|
|
2407
|
+
|
|
2408
|
+
/**
|
|
2409
|
+
* Set the radius for the near filter.
|
|
2410
|
+
*/
|
|
2411
|
+
within?: string;
|
|
2412
|
+
|
|
2413
|
+
/**
|
|
2414
|
+
* Match Tweets inside a recent time window.
|
|
2415
|
+
*/
|
|
2416
|
+
withinTime?: string;
|
|
2417
|
+
}
|
|
2418
|
+
|
|
2419
|
+
export interface UserRetrieveVerifiedFollowersParams {
|
|
2420
|
+
/**
|
|
2421
|
+
* Legacy cursor alias. Prefer cursor.
|
|
2422
|
+
*/
|
|
2423
|
+
after?: string;
|
|
2424
|
+
|
|
2425
|
+
/**
|
|
2426
|
+
* Match any comma-separated or line-separated bio term, ignoring case.
|
|
2427
|
+
*/
|
|
2428
|
+
bioContains?: string;
|
|
2429
|
+
|
|
2430
|
+
/**
|
|
2431
|
+
* Cursor from the previous response. Xquik cursors resume automatic coverage.
|
|
2432
|
+
* Existing unprefixed cursors keep legacy standard behavior.
|
|
2433
|
+
*/
|
|
2434
|
+
cursor?: string;
|
|
2435
|
+
|
|
2436
|
+
/**
|
|
2437
|
+
* Only return profiles with a location.
|
|
2438
|
+
*/
|
|
2439
|
+
hasLocation?: boolean;
|
|
2440
|
+
|
|
2441
|
+
/**
|
|
2442
|
+
* Only return profiles with a website.
|
|
2443
|
+
*/
|
|
2444
|
+
hasWebsite?: boolean;
|
|
2445
|
+
|
|
2446
|
+
/**
|
|
2447
|
+
* Legacy page-size alias outside explicit coverage mode. Coverage accepts 1-10000.
|
|
2448
|
+
* Prefer pageSize.
|
|
2449
|
+
*/
|
|
2450
|
+
limit?: number;
|
|
2451
|
+
|
|
2452
|
+
/**
|
|
2453
|
+
* Match a location substring, ignoring case.
|
|
2454
|
+
*/
|
|
2455
|
+
locationContains?: string;
|
|
2456
|
+
|
|
2457
|
+
/**
|
|
2458
|
+
* Maximum follower count. Missing counts pass this maximum.
|
|
2459
|
+
*/
|
|
2460
|
+
maxFollowers?: number;
|
|
2461
|
+
|
|
2462
|
+
/**
|
|
2463
|
+
* Maximum following count.
|
|
2464
|
+
*/
|
|
2465
|
+
maxFollowing?: number;
|
|
2466
|
+
|
|
2467
|
+
/**
|
|
2468
|
+
* Maximum post count. maxPosts is also accepted.
|
|
2469
|
+
*/
|
|
2470
|
+
maxStatuses?: number;
|
|
2471
|
+
|
|
2472
|
+
/**
|
|
2473
|
+
* Minimum account age in whole days.
|
|
2474
|
+
*/
|
|
2475
|
+
minAccountAgeDays?: number;
|
|
2476
|
+
|
|
2477
|
+
/**
|
|
2478
|
+
* Minimum follower count. Filtering happens before billing.
|
|
2479
|
+
*/
|
|
2480
|
+
minFollowers?: number;
|
|
2481
|
+
|
|
2482
|
+
/**
|
|
2483
|
+
* Minimum following count.
|
|
2484
|
+
*/
|
|
2485
|
+
minFollowing?: number;
|
|
2486
|
+
|
|
2487
|
+
/**
|
|
2488
|
+
* Minimum post count. minPosts is also accepted.
|
|
2489
|
+
*/
|
|
2490
|
+
minStatuses?: number;
|
|
2491
|
+
|
|
2492
|
+
/**
|
|
2493
|
+
* Omit mode for resumable maximum coverage. Standard keeps legacy pagination.
|
|
2494
|
+
* Coverage returns diagnostics once and rejects cursors.
|
|
2495
|
+
*/
|
|
2496
|
+
mode?: 'standard' | 'coverage';
|
|
2497
|
+
|
|
2498
|
+
/**
|
|
2499
|
+
* Maximum user profiles: automatic 300; standard 200. Sources return fewer
|
|
2500
|
+
* profiles. Continue with has_next_page.
|
|
2501
|
+
*/
|
|
2502
|
+
pageSize?: number;
|
|
2503
|
+
|
|
2504
|
+
/**
|
|
2505
|
+
* Match a username substring, ignoring case.
|
|
2506
|
+
*/
|
|
2507
|
+
usernameContains?: string;
|
|
2508
|
+
|
|
2509
|
+
/**
|
|
2510
|
+
* Only return verified profiles.
|
|
2511
|
+
*/
|
|
2512
|
+
verifiedOnly?: boolean;
|
|
2513
|
+
|
|
2514
|
+
/**
|
|
2515
|
+
* Match the verification type exactly, ignoring case.
|
|
2516
|
+
*/
|
|
2517
|
+
verifiedType?: string;
|
|
1379
2518
|
}
|
|
1380
2519
|
|
|
1381
2520
|
Users.Follow = Follow;
|
|
@@ -1384,6 +2523,9 @@ export declare namespace Users {
|
|
|
1384
2523
|
export {
|
|
1385
2524
|
type UserRemoveFollowerResponse as UserRemoveFollowerResponse,
|
|
1386
2525
|
type UserRetrieveBatchResponse as UserRetrieveBatchResponse,
|
|
2526
|
+
type UserRetrieveFollowersResponse as UserRetrieveFollowersResponse,
|
|
2527
|
+
type UserRetrieveFollowingResponse as UserRetrieveFollowingResponse,
|
|
2528
|
+
type UserRetrieveVerifiedFollowersResponse as UserRetrieveVerifiedFollowersResponse,
|
|
1387
2529
|
type UserRemoveFollowerParams as UserRemoveFollowerParams,
|
|
1388
2530
|
type UserRetrieveBatchParams as UserRetrieveBatchParams,
|
|
1389
2531
|
type UserRetrieveFollowersParams as UserRetrieveFollowersParams,
|