x-twitter-scraper 0.12.3 → 0.13.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 +73 -2
- package/README.md +66 -51
- package/client.d.mts +18 -15
- package/client.d.mts.map +1 -1
- package/client.d.ts +18 -15
- package/client.d.ts.map +1 -1
- package/client.js +3 -3
- package/client.js.map +1 -1
- package/client.mjs +4 -4
- package/client.mjs.map +1 -1
- package/core/streaming.d.mts +33 -0
- package/core/streaming.d.mts.map +1 -0
- package/core/streaming.d.ts +33 -0
- package/core/streaming.d.ts.map +1 -0
- package/core/streaming.js +270 -0
- package/core/streaming.js.map +1 -0
- package/core/streaming.mjs +265 -0
- package/core/streaming.mjs.map +1 -0
- package/internal/decoders/line.d.mts +17 -0
- package/internal/decoders/line.d.mts.map +1 -0
- package/internal/decoders/line.d.ts +17 -0
- package/internal/decoders/line.d.ts.map +1 -0
- package/internal/decoders/line.js +116 -0
- package/internal/decoders/line.js.map +1 -0
- package/internal/decoders/line.mjs +111 -0
- package/internal/decoders/line.mjs.map +1 -0
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js +7 -0
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs +7 -0
- package/internal/parse.mjs.map +1 -1
- package/internal/tslib.js +18 -18
- package/package.json +23 -5
- package/resources/account.d.mts +35 -12
- package/resources/account.d.mts.map +1 -1
- package/resources/account.d.ts +35 -12
- package/resources/account.d.ts.map +1 -1
- package/resources/account.js +4 -3
- package/resources/account.js.map +1 -1
- package/resources/account.mjs +4 -3
- package/resources/account.mjs.map +1 -1
- package/resources/compose.d.mts +77 -21
- package/resources/compose.d.mts.map +1 -1
- package/resources/compose.d.ts +77 -21
- package/resources/compose.d.ts.map +1 -1
- package/resources/compose.js +3 -4
- package/resources/compose.js.map +1 -1
- package/resources/compose.mjs +3 -4
- package/resources/compose.mjs.map +1 -1
- package/resources/credits.d.mts +18 -10
- package/resources/credits.d.mts.map +1 -1
- package/resources/credits.d.ts +18 -10
- package/resources/credits.d.ts.map +1 -1
- package/resources/credits.js +5 -4
- package/resources/credits.js.map +1 -1
- package/resources/credits.mjs +5 -4
- package/resources/credits.mjs.map +1 -1
- package/resources/drafts.d.mts +13 -17
- package/resources/drafts.d.mts.map +1 -1
- package/resources/drafts.d.ts +13 -17
- package/resources/drafts.d.ts.map +1 -1
- package/resources/drafts.js +4 -4
- package/resources/drafts.mjs +4 -4
- package/resources/draws.d.mts +84 -28
- package/resources/draws.d.mts.map +1 -1
- package/resources/draws.d.ts +84 -28
- package/resources/draws.d.ts.map +1 -1
- package/resources/draws.js +24 -9
- package/resources/draws.js.map +1 -1
- package/resources/draws.mjs +24 -9
- package/resources/draws.mjs.map +1 -1
- package/resources/events.d.mts +2564 -21
- package/resources/events.d.mts.map +1 -1
- package/resources/events.d.ts +2564 -21
- package/resources/events.d.ts.map +1 -1
- package/resources/events.js +34 -2
- package/resources/events.js.map +1 -1
- package/resources/events.mjs +34 -2
- package/resources/events.mjs.map +1 -1
- package/resources/extractions.d.mts +410 -128
- package/resources/extractions.d.mts.map +1 -1
- package/resources/extractions.d.ts +410 -128
- package/resources/extractions.d.ts.map +1 -1
- package/resources/extractions.js +74 -12
- package/resources/extractions.js.map +1 -1
- package/resources/extractions.mjs +74 -12
- package/resources/extractions.mjs.map +1 -1
- package/resources/guest-wallets.d.mts +6 -5
- package/resources/guest-wallets.d.mts.map +1 -1
- package/resources/guest-wallets.d.ts +6 -5
- package/resources/guest-wallets.d.ts.map +1 -1
- package/resources/guest-wallets.js +2 -1
- package/resources/guest-wallets.js.map +1 -1
- package/resources/guest-wallets.mjs +2 -1
- package/resources/guest-wallets.mjs.map +1 -1
- package/resources/index.d.mts +6 -6
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -6
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/monitors/index.d.mts +2 -2
- package/resources/monitors/index.d.mts.map +1 -1
- package/resources/monitors/index.d.ts +2 -2
- package/resources/monitors/index.d.ts.map +1 -1
- package/resources/monitors/index.js.map +1 -1
- package/resources/monitors/index.mjs.map +1 -1
- package/resources/monitors/keywords.d.mts +66 -14
- package/resources/monitors/keywords.d.mts.map +1 -1
- package/resources/monitors/keywords.d.ts +66 -14
- package/resources/monitors/keywords.d.ts.map +1 -1
- package/resources/monitors/keywords.js +16 -10
- package/resources/monitors/keywords.js.map +1 -1
- package/resources/monitors/keywords.mjs +16 -10
- package/resources/monitors/keywords.mjs.map +1 -1
- package/resources/monitors/monitors.d.mts +53 -16
- package/resources/monitors/monitors.d.mts.map +1 -1
- package/resources/monitors/monitors.d.ts +53 -16
- package/resources/monitors/monitors.d.ts.map +1 -1
- package/resources/monitors/monitors.js +12 -10
- package/resources/monitors/monitors.js.map +1 -1
- package/resources/monitors/monitors.mjs +12 -10
- package/resources/monitors/monitors.mjs.map +1 -1
- package/resources/radar.d.mts +32 -36
- package/resources/radar.d.mts.map +1 -1
- package/resources/radar.d.ts +32 -36
- package/resources/radar.d.ts.map +1 -1
- package/resources/radar.js +1 -1
- package/resources/radar.mjs +1 -1
- package/resources/shared.d.mts +1726 -233
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +1726 -233
- package/resources/shared.d.ts.map +1 -1
- package/resources/styles.d.mts +34 -23
- package/resources/styles.d.mts.map +1 -1
- package/resources/styles.d.ts +34 -23
- package/resources/styles.d.ts.map +1 -1
- package/resources/styles.js +11 -13
- package/resources/styles.js.map +1 -1
- package/resources/styles.mjs +11 -13
- package/resources/styles.mjs.map +1 -1
- package/resources/subscribe.d.mts +1 -1
- package/resources/subscribe.d.ts +1 -1
- package/resources/subscribe.js +1 -1
- package/resources/subscribe.mjs +1 -1
- package/resources/support/index.d.mts +1 -1
- package/resources/support/index.d.mts.map +1 -1
- package/resources/support/index.d.ts +1 -1
- package/resources/support/index.d.ts.map +1 -1
- package/resources/support/index.js.map +1 -1
- package/resources/support/index.mjs.map +1 -1
- package/resources/support/support.d.mts +2 -2
- package/resources/support/support.d.mts.map +1 -1
- package/resources/support/support.d.ts +2 -2
- package/resources/support/support.d.ts.map +1 -1
- package/resources/support/support.js.map +1 -1
- package/resources/support/support.mjs.map +1 -1
- package/resources/support/tickets.d.mts +30 -10
- package/resources/support/tickets.d.mts.map +1 -1
- package/resources/support/tickets.d.ts +30 -10
- package/resources/support/tickets.d.ts.map +1 -1
- package/resources/support/tickets.js +7 -7
- package/resources/support/tickets.js.map +1 -1
- package/resources/support/tickets.mjs +7 -7
- package/resources/support/tickets.mjs.map +1 -1
- package/resources/trends.d.mts +21 -5
- package/resources/trends.d.mts.map +1 -1
- package/resources/trends.d.ts +21 -5
- package/resources/trends.d.ts.map +1 -1
- package/resources/trends.js +2 -1
- package/resources/trends.js.map +1 -1
- package/resources/trends.mjs +2 -1
- package/resources/trends.mjs.map +1 -1
- package/resources/webhooks.d.mts +80 -14
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +80 -14
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js +30 -11
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs +30 -11
- package/resources/webhooks.mjs.map +1 -1
- package/resources/x/account-connection-attempts.d.mts +1 -1
- package/resources/x/account-connection-attempts.d.ts +1 -1
- package/resources/x/account-connection-attempts.js +1 -1
- package/resources/x/account-connection-attempts.mjs +1 -1
- package/resources/x/account-connection-challenges.d.mts +30 -11
- package/resources/x/account-connection-challenges.d.mts.map +1 -1
- package/resources/x/account-connection-challenges.d.ts +30 -11
- package/resources/x/account-connection-challenges.d.ts.map +1 -1
- package/resources/x/account-connection-challenges.js +5 -4
- package/resources/x/account-connection-challenges.js.map +1 -1
- package/resources/x/account-connection-challenges.mjs +5 -4
- package/resources/x/account-connection-challenges.mjs.map +1 -1
- package/resources/x/accounts.d.mts +38 -10
- package/resources/x/accounts.d.mts.map +1 -1
- package/resources/x/accounts.d.ts +38 -10
- package/resources/x/accounts.d.ts.map +1 -1
- package/resources/x/accounts.js +8 -7
- package/resources/x/accounts.js.map +1 -1
- package/resources/x/accounts.mjs +8 -7
- package/resources/x/accounts.mjs.map +1 -1
- package/resources/x/analysis.d.mts +3274 -0
- package/resources/x/analysis.d.mts.map +1 -0
- package/resources/x/analysis.d.ts +3274 -0
- package/resources/x/analysis.d.ts.map +1 -0
- package/resources/x/analysis.js +132 -0
- package/resources/x/analysis.js.map +1 -0
- package/resources/x/analysis.mjs +128 -0
- package/resources/x/analysis.mjs.map +1 -0
- package/resources/x/bookmarks.d.mts +84 -9
- package/resources/x/bookmarks.d.mts.map +1 -1
- package/resources/x/bookmarks.d.ts +84 -9
- package/resources/x/bookmarks.d.ts.map +1 -1
- package/resources/x/bookmarks.js +6 -4
- package/resources/x/bookmarks.js.map +1 -1
- package/resources/x/bookmarks.mjs +6 -4
- package/resources/x/bookmarks.mjs.map +1 -1
- package/resources/x/broadcasts.d.mts +176 -0
- package/resources/x/broadcasts.d.mts.map +1 -0
- package/resources/x/broadcasts.d.ts +176 -0
- package/resources/x/broadcasts.d.ts.map +1 -0
- package/resources/x/broadcasts.js +29 -0
- package/resources/x/broadcasts.js.map +1 -0
- package/resources/x/broadcasts.mjs +25 -0
- package/resources/x/broadcasts.mjs.map +1 -0
- package/resources/x/communities/communities.d.mts +612 -128
- package/resources/x/communities/communities.d.mts.map +1 -1
- package/resources/x/communities/communities.d.ts +612 -128
- package/resources/x/communities/communities.d.ts.map +1 -1
- package/resources/x/communities/communities.js +96 -17
- package/resources/x/communities/communities.js.map +1 -1
- package/resources/x/communities/communities.mjs +96 -17
- package/resources/x/communities/communities.mjs.map +1 -1
- package/resources/x/communities/index.d.mts +2 -1
- package/resources/x/communities/index.d.mts.map +1 -1
- package/resources/x/communities/index.d.ts +2 -1
- package/resources/x/communities/index.d.ts.map +1 -1
- package/resources/x/communities/index.js +3 -1
- package/resources/x/communities/index.js.map +1 -1
- package/resources/x/communities/index.mjs +1 -0
- package/resources/x/communities/index.mjs.map +1 -1
- package/resources/x/communities/join.d.mts +46 -25
- package/resources/x/communities/join.d.mts.map +1 -1
- package/resources/x/communities/join.d.ts +46 -25
- package/resources/x/communities/join.d.ts.map +1 -1
- package/resources/x/communities/join.js +10 -7
- package/resources/x/communities/join.js.map +1 -1
- package/resources/x/communities/join.mjs +10 -7
- package/resources/x/communities/join.mjs.map +1 -1
- package/resources/x/communities/media.d.mts +197 -0
- package/resources/x/communities/media.d.mts.map +1 -0
- package/resources/x/communities/media.d.ts +197 -0
- package/resources/x/communities/media.d.ts.map +1 -0
- package/resources/x/communities/media.js +29 -0
- package/resources/x/communities/media.js.map +1 -0
- package/resources/x/communities/media.mjs +25 -0
- package/resources/x/communities/media.mjs.map +1 -0
- package/resources/x/communities/tweets.d.mts +350 -20
- package/resources/x/communities/tweets.d.mts.map +1 -1
- package/resources/x/communities/tweets.d.ts +350 -20
- package/resources/x/communities/tweets.d.ts.map +1 -1
- package/resources/x/communities/tweets.js +8 -7
- package/resources/x/communities/tweets.js.map +1 -1
- package/resources/x/communities/tweets.mjs +8 -7
- package/resources/x/communities/tweets.mjs.map +1 -1
- package/resources/x/dm.d.mts +245 -13
- package/resources/x/dm.d.mts.map +1 -1
- package/resources/x/dm.d.ts +245 -13
- package/resources/x/dm.d.ts.map +1 -1
- package/resources/x/dm.js +29 -2
- package/resources/x/dm.js.map +1 -1
- package/resources/x/dm.mjs +29 -2
- package/resources/x/dm.mjs.map +1 -1
- package/resources/x/followers.d.mts +31 -3
- package/resources/x/followers.d.mts.map +1 -1
- package/resources/x/followers.d.ts +31 -3
- package/resources/x/followers.d.ts.map +1 -1
- package/resources/x/followers.js +2 -1
- package/resources/x/followers.js.map +1 -1
- package/resources/x/followers.mjs +2 -1
- package/resources/x/followers.mjs.map +1 -1
- package/resources/x/index.d.mts +12 -8
- package/resources/x/index.d.mts.map +1 -1
- package/resources/x/index.d.ts +12 -8
- package/resources/x/index.d.ts.map +1 -1
- package/resources/x/index.js +9 -1
- package/resources/x/index.js.map +1 -1
- package/resources/x/index.mjs +5 -1
- package/resources/x/index.mjs.map +1 -1
- package/resources/x/jobs.d.mts +506 -0
- package/resources/x/jobs.d.mts.map +1 -0
- package/resources/x/jobs.d.ts +506 -0
- package/resources/x/jobs.d.ts.map +1 -0
- package/resources/x/jobs.js +60 -0
- package/resources/x/jobs.js.map +1 -0
- package/resources/x/jobs.mjs +56 -0
- package/resources/x/jobs.mjs.map +1 -0
- package/resources/x/lists.d.mts +1058 -27
- package/resources/x/lists.d.mts.map +1 -1
- package/resources/x/lists.d.ts +1058 -27
- package/resources/x/lists.d.ts.map +1 -1
- package/resources/x/lists.js +39 -9
- package/resources/x/lists.js.map +1 -1
- package/resources/x/lists.mjs +39 -9
- package/resources/x/lists.mjs.map +1 -1
- package/resources/x/media.d.mts +24 -13
- package/resources/x/media.d.mts.map +1 -1
- package/resources/x/media.d.ts +24 -13
- package/resources/x/media.d.ts.map +1 -1
- package/resources/x/media.js +2 -2
- package/resources/x/media.mjs +2 -2
- package/resources/x/profile.d.mts +60 -33
- package/resources/x/profile.d.mts.map +1 -1
- package/resources/x/profile.d.ts +60 -33
- package/resources/x/profile.d.ts.map +1 -1
- package/resources/x/profile.js +3 -3
- package/resources/x/profile.mjs +3 -3
- package/resources/x/spaces.d.mts +857 -0
- package/resources/x/spaces.d.mts.map +1 -0
- package/resources/x/spaces.d.ts +857 -0
- package/resources/x/spaces.d.ts.map +1 -0
- package/resources/x/spaces.js +58 -0
- package/resources/x/spaces.js.map +1 -0
- package/resources/x/spaces.mjs +54 -0
- package/resources/x/spaces.mjs.map +1 -0
- 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/like.d.mts +38 -20
- package/resources/x/tweets/like.d.mts.map +1 -1
- package/resources/x/tweets/like.d.ts +38 -20
- package/resources/x/tweets/like.d.ts.map +1 -1
- package/resources/x/tweets/like.js +2 -2
- package/resources/x/tweets/like.mjs +2 -2
- package/resources/x/tweets/retweet.d.mts +38 -20
- package/resources/x/tweets/retweet.d.mts.map +1 -1
- package/resources/x/tweets/retweet.d.ts +38 -20
- package/resources/x/tweets/retweet.d.ts.map +1 -1
- package/resources/x/tweets/retweet.js +2 -2
- package/resources/x/tweets/retweet.mjs +2 -2
- package/resources/x/tweets/tweets.d.mts +2639 -326
- package/resources/x/tweets/tweets.d.mts.map +1 -1
- package/resources/x/tweets/tweets.d.ts +2639 -326
- package/resources/x/tweets/tweets.d.ts.map +1 -1
- package/resources/x/tweets/tweets.js +147 -21
- package/resources/x/tweets/tweets.js.map +1 -1
- package/resources/x/tweets/tweets.mjs +147 -21
- package/resources/x/tweets/tweets.mjs.map +1 -1
- package/resources/x/users/follow.d.mts +38 -20
- package/resources/x/users/follow.d.mts.map +1 -1
- package/resources/x/users/follow.d.ts +38 -20
- package/resources/x/users/follow.d.ts.map +1 -1
- package/resources/x/users/follow.js +2 -2
- package/resources/x/users/follow.mjs +2 -2
- 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 +3068 -457
- package/resources/x/users/users.d.mts.map +1 -1
- package/resources/x/users/users.d.ts +3068 -457
- package/resources/x/users/users.d.ts.map +1 -1
- package/resources/x/users/users.js +205 -22
- package/resources/x/users/users.js.map +1 -1
- package/resources/x/users/users.mjs +205 -22
- package/resources/x/users/users.mjs.map +1 -1
- package/resources/x/write-actions.d.mts +13 -6
- package/resources/x/write-actions.d.mts.map +1 -1
- package/resources/x/write-actions.d.ts +13 -6
- package/resources/x/write-actions.d.ts.map +1 -1
- package/resources/x/write-actions.js +1 -1
- package/resources/x/write-actions.mjs +1 -1
- package/resources/x/x.d.mts +864 -27
- package/resources/x/x.d.mts.map +1 -1
- package/resources/x/x.d.ts +864 -27
- package/resources/x/x.d.ts.map +1 -1
- package/resources/x/x.js +78 -5
- package/resources/x/x.js.map +1 -1
- package/resources/x/x.mjs +80 -7
- package/resources/x/x.mjs.map +1 -1
- package/skills/x-twitter-scraper/SKILL.md +97 -350
- package/skills/x-twitter-scraper/metadata.json +3 -9
- package/skills/x-twitter-scraper/references/draws.md +24 -24
- package/skills/x-twitter-scraper/references/extractions.md +71 -62
- package/skills/x-twitter-scraper/references/mcp-setup.md +36 -39
- package/skills/x-twitter-scraper/references/mcp-tools.md +105 -166
- package/skills/x-twitter-scraper/references/python-examples.md +5 -5
- package/skills/x-twitter-scraper/references/security.md +8 -8
- package/skills/x-twitter-scraper/references/types-mcp-output-schemas.md +4 -4
- package/skills/x-twitter-scraper/references/types.md +0 -1
- package/skills/x-twitter-scraper/references/usage.md +5 -5
- package/skills/x-twitter-scraper/references/webhooks.md +28 -31
- package/skills/x-twitter-scraper/references/workflows.md +70 -71
- package/skills/x-twitter-scraper/skill-card.md +13 -14
- package/skills/x-twitter-scraper/skillspector-report.md +8 -5
- package/skills/xquik-account-automation/LICENSE +21 -0
- package/skills/xquik-account-automation/SKILL.md +91 -0
- package/skills/xquik-social-research/SKILL.md +49 -56
- package/src/client.ts +47 -4
- package/src/core/streaming.ts +328 -0
- package/src/internal/decoders/line.ts +140 -0
- package/src/internal/parse.ts +9 -0
- package/src/resources/account.ts +41 -12
- package/src/resources/compose.ts +77 -21
- package/src/resources/credits.ts +19 -10
- package/src/resources/drafts.ts +13 -22
- package/src/resources/draws.ts +94 -36
- package/src/resources/events.ts +3225 -68
- package/src/resources/extractions.ts +512 -125
- package/src/resources/guest-wallets.ts +6 -5
- package/src/resources/index.ts +24 -1
- package/src/resources/monitors/index.ts +2 -0
- package/src/resources/monitors/keywords.ts +82 -14
- package/src/resources/monitors/monitors.ts +66 -14
- package/src/resources/radar.ts +32 -36
- package/src/resources/shared.ts +2227 -351
- package/src/resources/styles.ts +43 -27
- package/src/resources/subscribe.ts +1 -1
- package/src/resources/support/index.ts +1 -0
- package/src/resources/support/support.ts +2 -0
- package/src/resources/support/tickets.ts +38 -10
- package/src/resources/trends.ts +23 -5
- package/src/resources/webhooks.ts +109 -15
- package/src/resources/x/account-connection-attempts.ts +1 -1
- package/src/resources/x/account-connection-challenges.ts +39 -11
- package/src/resources/x/accounts.ts +46 -10
- package/src/resources/x/analysis.ts +3947 -0
- package/src/resources/x/bookmarks.ts +103 -9
- package/src/resources/x/broadcasts.ts +225 -0
- package/src/resources/x/communities/communities.ts +743 -141
- package/src/resources/x/communities/index.ts +9 -0
- package/src/resources/x/communities/join.ts +46 -23
- package/src/resources/x/communities/media.ts +251 -0
- package/src/resources/x/communities/tweets.ts +427 -20
- package/src/resources/x/dm.ts +334 -11
- package/src/resources/x/followers.ts +35 -3
- package/src/resources/x/index.ts +106 -1
- package/src/resources/x/jobs.ts +627 -0
- package/src/resources/x/lists.ts +1307 -28
- package/src/resources/x/media.ts +24 -12
- package/src/resources/x/profile.ts +60 -30
- package/src/resources/x/spaces.ts +1076 -0
- package/src/resources/x/tweets/index.ts +18 -0
- package/src/resources/x/tweets/like.ts +38 -18
- package/src/resources/x/tweets/retweet.ts +38 -18
- package/src/resources/x/tweets/tweets.ts +3695 -843
- package/src/resources/x/users/follow.ts +38 -18
- package/src/resources/x/users/index.ts +22 -0
- package/src/resources/x/users/users.ts +3687 -465
- package/src/resources/x/write-actions.ts +13 -5
- package/src/resources/x/x.ts +1227 -15
- package/src/streaming.ts +6 -0
- package/src/version.ts +1 -1
- package/streaming.d.mts +3 -0
- package/streaming.d.mts.map +1 -0
- package/streaming.d.ts +3 -0
- package/streaming.d.ts.map +1 -0
- package/streaming.js +9 -0
- package/streaming.js.map +1 -0
- package/streaming.mjs +6 -0
- package/streaming.mjs.map +1 -0
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/skills/x-twitter-scraper/references/types-rest-api-vs-mcp-field-naming.md +0 -15
package/resources/x/x.d.ts
CHANGED
|
@@ -5,34 +5,44 @@ import { AccountConnectionAttemptRetrieveResponse, AccountConnectionAttempts } f
|
|
|
5
5
|
import * as AccountConnectionChallengesAPI from "./account-connection-challenges.js";
|
|
6
6
|
import { AccountConnectionChallengeSubmitParams, AccountConnectionChallengeSubmitResponse, AccountConnectionChallenges } from "./account-connection-challenges.js";
|
|
7
7
|
import * as AccountsAPI from "./accounts.js";
|
|
8
|
-
import { AccountBulkRetryResponse, AccountCreateParams, AccountCreateResponse, AccountDeleteResponse, AccountListResponse, AccountReauthParams, AccountReauthResponse, Accounts, XAccount, XAccountDetail } from "./accounts.js";
|
|
8
|
+
import { AccountBulkRetryResponse, AccountCreateParams, AccountCreateResponse, AccountDeleteResponse, AccountListParams, AccountListResponse, AccountReauthParams, AccountReauthResponse, Accounts, XAccount, XAccountDetail } from "./accounts.js";
|
|
9
|
+
import * as AnalysisAPI from "./analysis.js";
|
|
10
|
+
import { Analysis, AnalysisBrandParams, AnalysisBrandResponse, AnalysisClassifyParams, AnalysisClassifyResponse, AnalysisMarketSignalsParams, AnalysisMarketSignalsResponse, AnalysisNewsParams, AnalysisNewsResponse, AnalysisSentimentParams, AnalysisSentimentResponse, AnalysisViralScoreParams, AnalysisViralScoreResponse } from "./analysis.js";
|
|
9
11
|
import * as BookmarksAPI from "./bookmarks.js";
|
|
10
|
-
import { BookmarkListParams, BookmarkRetrieveFoldersResponse, Bookmarks } from "./bookmarks.js";
|
|
12
|
+
import { BookmarkListParams, BookmarkRetrieveFoldersParams, BookmarkRetrieveFoldersResponse, Bookmarks } from "./bookmarks.js";
|
|
13
|
+
import * as BroadcastsAPI from "./broadcasts.js";
|
|
14
|
+
import { BroadcastRetrieveParams, BroadcastRetrieveResponse, Broadcasts } from "./broadcasts.js";
|
|
11
15
|
import * as DmAPI from "./dm.js";
|
|
12
|
-
import { Dm, DmRetrieveHistoryParams, DmRetrieveHistoryResponse, DmSendParams, DmSendResponse } from "./dm.js";
|
|
16
|
+
import { Dm, DmDeleteMessageParams, DmDeleteMessageResponse, DmRetrieveHistoryParams, DmRetrieveHistoryResponse, DmSendParams, DmSendResponse } from "./dm.js";
|
|
13
17
|
import * as FollowersAPI from "./followers.js";
|
|
14
18
|
import { FollowerCheckParams, FollowerCheckResponse, Followers } from "./followers.js";
|
|
19
|
+
import * as JobsAPI from "./jobs.js";
|
|
20
|
+
import { JobListLocationsParams, JobListLocationsResponse, JobRetrieveParams, JobRetrieveResponse, JobSearchParams, JobSearchResponse, Jobs } from "./jobs.js";
|
|
15
21
|
import * as ListsAPI from "./lists.js";
|
|
16
|
-
import { ListRetrieveFollowersParams, ListRetrieveMembersParams, ListRetrieveTweetsParams, Lists } from "./lists.js";
|
|
22
|
+
import { ListRetrieveFollowersParams, ListRetrieveFollowersResponse, ListRetrieveMembersParams, ListRetrieveMembersResponse, ListRetrieveParams, ListRetrieveResponse, ListRetrieveSearchParams, ListRetrieveSearchResponse, ListRetrieveTweetsParams, Lists } from "./lists.js";
|
|
17
23
|
import * as MediaAPI from "./media.js";
|
|
18
24
|
import { Media, MediaDownloadParams, MediaDownloadResponse, MediaUploadParams, MediaUploadResponse } from "./media.js";
|
|
19
25
|
import * as ProfileAPI from "./profile.js";
|
|
20
26
|
import { Profile, ProfileUpdateAvatarParams, ProfileUpdateAvatarResponse, ProfileUpdateBannerParams, ProfileUpdateBannerResponse, ProfileUpdateParams, ProfileUpdateResponse } from "./profile.js";
|
|
27
|
+
import * as SpacesAPI from "./spaces.js";
|
|
28
|
+
import { SpaceRetrieveParams, SpaceRetrieveReplayParams, SpaceRetrieveReplayResponse, SpaceRetrieveResponse, SpaceSearchParams, SpaceSearchResponse, Spaces } from "./spaces.js";
|
|
21
29
|
import * as WriteActionsAPI from "./write-actions.js";
|
|
22
30
|
import { WriteActionRetrieveResponse, WriteActions } from "./write-actions.js";
|
|
23
31
|
import * as CommunitiesAPI from "./communities/communities.js";
|
|
24
|
-
import { Communities, CommunityCreateParams, CommunityCreateResponse, CommunityDeleteParams, CommunityDeleteResponse, CommunityRetrieveInfoResponse, CommunityRetrieveMembersParams, CommunityRetrieveModeratorsParams, CommunityRetrieveSearchParams } from "./communities/communities.js";
|
|
32
|
+
import { Communities, CommunityCreateParams, CommunityCreateResponse, CommunityDeleteParams, CommunityDeleteResponse, CommunityFindParams, CommunityListPopularParams, CommunityListSuggestedParams, CommunityListSuggestedResponse, CommunityListTopicsParams, CommunityListTopicsResponse, CommunityRetrieveInfoParams, CommunityRetrieveInfoResponse, CommunityRetrieveMembersParams, CommunityRetrieveModeratorsParams, CommunityRetrieveSearchParams, CommunitySearchMembersParams } from "./communities/communities.js";
|
|
25
33
|
import * as TweetsAPI from "./tweets/tweets.js";
|
|
26
|
-
import { TweetAuthor, TweetCreateParams, TweetCreateResponse, TweetDeleteParams, TweetDeleteResponse, TweetDetail, TweetGetFavoritersParams, TweetGetQuotesParams, TweetGetRepliesParams, TweetGetRepliesResponse, TweetGetRetweetersParams, TweetGetThreadParams, TweetListParams, TweetRetrieveResponse, TweetSearchParams, TweetSearchResponse, Tweets } from "./tweets/tweets.js";
|
|
34
|
+
import { TweetAuthor, TweetCheckRepostParams, TweetCheckRepostResponse, TweetCreateParams, TweetCreateResponse, TweetDeleteParams, TweetDeleteResponse, TweetDetail, TweetEmbedParams, TweetEmbedResponse, TweetGetFavoritersParams, TweetGetHiddenRepliesParams, TweetGetInsightsParams, TweetGetInsightsResponse, TweetGetQuotesParams, TweetGetRepliesParams, TweetGetRepliesResponse, TweetGetRetweeterIDsParams, TweetGetRetweeterIDsResponse, TweetGetRetweetersParams, TweetGetSubtitlesParams, TweetGetSubtitlesResponse, TweetGetThreadParams, TweetListParams, TweetListResponse, TweetListTopParams, TweetResolveLinksParams, TweetResolveLinksResponse, TweetRetrieveParams, TweetRetrieveResponse, TweetSearchParams, TweetSearchResponse, TweetTranslateParams, TweetTranslateResponse, Tweets } from "./tweets/tweets.js";
|
|
27
35
|
import * as UsersAPI from "./users/users.js";
|
|
28
|
-
import { UserRemoveFollowerParams, UserRemoveFollowerResponse, UserRetrieveBatchParams, UserRetrieveBatchResponse, UserRetrieveFollowersParams, UserRetrieveFollowersResponse, UserRetrieveFollowersYouKnowParams, UserRetrieveFollowingParams, UserRetrieveFollowingResponse, UserRetrieveLikesParams, UserRetrieveMediaParams, UserRetrieveMentionsParams, UserRetrieveRepliesParams, UserRetrieveSearchParams, UserRetrieveTweetsParams, UserRetrieveVerifiedFollowersParams, UserRetrieveVerifiedFollowersResponse, Users } from "./users/users.js";
|
|
36
|
+
import { UserRemoveFollowerParams, UserRemoveFollowerResponse, UserRetrieveAffiliatesParams, UserRetrieveArticlesParams, UserRetrieveBatchParams, UserRetrieveBatchResponse, UserRetrieveBatchTweetsParams, UserRetrieveBatchTweetsResponse, UserRetrieveFollowerIDsParams, UserRetrieveFollowerIDsResponse, UserRetrieveFollowersParams, UserRetrieveFollowersResponse, UserRetrieveFollowersYouKnowParams, UserRetrieveFollowingIDsParams, UserRetrieveFollowingIDsResponse, UserRetrieveFollowingParams, UserRetrieveFollowingResponse, UserRetrieveHighlightsParams, UserRetrieveInsightsParams, UserRetrieveInsightsResponse, UserRetrieveLikesParams, UserRetrieveListMembershipsParams, UserRetrieveListMembershipsResponse, UserRetrieveListsParams, UserRetrieveListsResponse, UserRetrieveLiveParams, UserRetrieveLiveResponse, UserRetrieveMediaParams, UserRetrieveMentionsParams, UserRetrieveParams, UserRetrieveRepliesParams, UserRetrieveSearchParams, UserRetrieveSimilarParams, UserRetrieveSubscriptionsParams, UserRetrieveTweetsParams, UserRetrieveVerifiedFollowersParams, UserRetrieveVerifiedFollowersResponse, UserTranslateBioParams, UserTranslateBioResponse, Users } from "./users/users.js";
|
|
29
37
|
import { APIPromise } from "../../core/api-promise.js";
|
|
30
38
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
31
39
|
export declare class X extends APIResource {
|
|
32
40
|
writeActions: WriteActionsAPI.WriteActions;
|
|
41
|
+
analysis: AnalysisAPI.Analysis;
|
|
33
42
|
tweets: TweetsAPI.Tweets;
|
|
34
43
|
users: UsersAPI.Users;
|
|
35
44
|
followers: FollowersAPI.Followers;
|
|
45
|
+
jobs: JobsAPI.Jobs;
|
|
36
46
|
dm: DmAPI.Dm;
|
|
37
47
|
media: MediaAPI.Media;
|
|
38
48
|
profile: ProfileAPI.Profile;
|
|
@@ -42,6 +52,21 @@ export declare class X extends APIResource {
|
|
|
42
52
|
accountConnectionAttempts: AccountConnectionAttemptsAPI.AccountConnectionAttempts;
|
|
43
53
|
bookmarks: BookmarksAPI.Bookmarks;
|
|
44
54
|
lists: ListsAPI.Lists;
|
|
55
|
+
broadcasts: BroadcastsAPI.Broadcasts;
|
|
56
|
+
spaces: SpacesAPI.Spaces;
|
|
57
|
+
/**
|
|
58
|
+
* Returns the accounts, topics, hashtags & cashtags X suggests while someone types
|
|
59
|
+
* a search. X may rank them differently per request. Costs 1 credit per
|
|
60
|
+
* suggestion.
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```ts
|
|
64
|
+
* const response = await client.x.autocompleteSearch({
|
|
65
|
+
* q: 'nasa',
|
|
66
|
+
* });
|
|
67
|
+
* ```
|
|
68
|
+
*/
|
|
69
|
+
autocompleteSearch(query: XAutocompleteSearchParams, options?: RequestOptions): APIPromise<XAutocompleteSearchResponse>;
|
|
45
70
|
/**
|
|
46
71
|
* Retrieve the full content of an X Article (long-form post) by numeric tweet ID.
|
|
47
72
|
* Returns article_not_found when the tweet is valid but is not an X Article.
|
|
@@ -51,9 +76,22 @@ export declare class X extends APIResource {
|
|
|
51
76
|
* const response = await client.x.getArticle('tweetId');
|
|
52
77
|
* ```
|
|
53
78
|
*/
|
|
54
|
-
getArticle(tweetID: string, options?: RequestOptions): APIPromise<XGetArticleResponse>;
|
|
79
|
+
getArticle(tweetID: string, query?: XGetArticleParams | null | undefined, options?: RequestOptions): APIPromise<XGetArticleResponse>;
|
|
55
80
|
/**
|
|
56
|
-
*
|
|
81
|
+
* Returns X's hashflags, the custom emoji X shows after some hashtags. Lists the
|
|
82
|
+
* ones running now unless activeOnly is false. Each returned hashflag costs 1
|
|
83
|
+
* credit.
|
|
84
|
+
*
|
|
85
|
+
* @example
|
|
86
|
+
* ```ts
|
|
87
|
+
* const response = await client.x.getHashflags();
|
|
88
|
+
* ```
|
|
89
|
+
*/
|
|
90
|
+
getHashflags(query?: XGetHashflagsParams | null | undefined, options?: RequestOptions): APIPromise<XGetHashflagsResponse>;
|
|
91
|
+
/**
|
|
92
|
+
* Returns the home timeline of 1 of your connected X accounts, else 424
|
|
93
|
+
* `account_required`. A cursor reads the next page from the same account. Results
|
|
94
|
+
* exclude X ads.
|
|
57
95
|
*
|
|
58
96
|
* @example
|
|
59
97
|
* ```ts
|
|
@@ -62,7 +100,7 @@ export declare class X extends APIResource {
|
|
|
62
100
|
*/
|
|
63
101
|
getHomeTimeline(query?: XGetHomeTimelineParams | null | undefined, options?: RequestOptions): APIPromise<Shared.PaginatedTweets>;
|
|
64
102
|
/**
|
|
65
|
-
*
|
|
103
|
+
* Returns your X account's notifications, else 424 `account_required`.
|
|
66
104
|
*
|
|
67
105
|
* @example
|
|
68
106
|
* ```ts
|
|
@@ -71,7 +109,19 @@ export declare class X extends APIResource {
|
|
|
71
109
|
*/
|
|
72
110
|
getNotifications(query?: XGetNotificationsParams | null | undefined, options?: RequestOptions): APIPromise<XGetNotificationsResponse>;
|
|
73
111
|
/**
|
|
74
|
-
*
|
|
112
|
+
* Returns the places X offers trends for. Pass a location's woeid to /x/trends.
|
|
113
|
+
* Each returned location costs 1 credit.
|
|
114
|
+
*
|
|
115
|
+
* @example
|
|
116
|
+
* ```ts
|
|
117
|
+
* const response = await client.x.getTrendLocations();
|
|
118
|
+
* ```
|
|
119
|
+
*/
|
|
120
|
+
getTrendLocations(query?: XGetTrendLocationsParams | null | undefined, options?: RequestOptions): APIPromise<XGetTrendLocationsResponse>;
|
|
121
|
+
/**
|
|
122
|
+
* Returns X's current trends for a place you choose. Pick it by woeid, country or
|
|
123
|
+
* location name. Without one, trends are worldwide. Each request costs 1 credit,
|
|
124
|
+
* however many trends it returns.
|
|
75
125
|
*
|
|
76
126
|
* @example
|
|
77
127
|
* ```ts
|
|
@@ -79,64 +129,369 @@ export declare class X extends APIResource {
|
|
|
79
129
|
* ```
|
|
80
130
|
*/
|
|
81
131
|
getTrends(query?: XGetTrendsParams | null | undefined, options?: RequestOptions): APIPromise<XGetTrendsResponse>;
|
|
132
|
+
/**
|
|
133
|
+
* Finds places on X by name. Pass a place's id as place to /x/tweets/search to
|
|
134
|
+
* read posts tagged there. X ranks the places, so their order can differ between
|
|
135
|
+
* requests. Each returned place costs 1 credit.
|
|
136
|
+
*
|
|
137
|
+
* @example
|
|
138
|
+
* ```ts
|
|
139
|
+
* const response = await client.x.searchPlaces({ q: 'q' });
|
|
140
|
+
* ```
|
|
141
|
+
*/
|
|
142
|
+
searchPlaces(query: XSearchPlacesParams, options?: RequestOptions): APIPromise<XSearchPlacesResponse>;
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* What X suggests for a partial search query. Each list keeps X's order. A list is
|
|
146
|
+
* empty when X suggests none of its type or types leaves it out.
|
|
147
|
+
*/
|
|
148
|
+
export interface XAutocompleteSearchResponse {
|
|
149
|
+
/**
|
|
150
|
+
* Suggested stocks & crypto tokens.
|
|
151
|
+
*/
|
|
152
|
+
cashtags: Array<XAutocompleteSearchResponse.Cashtag>;
|
|
153
|
+
/**
|
|
154
|
+
* Suggestions returned across all 4 lists. Each costs 1 credit.
|
|
155
|
+
*/
|
|
156
|
+
count: number;
|
|
157
|
+
/**
|
|
158
|
+
* Suggested hashtags.
|
|
159
|
+
*/
|
|
160
|
+
hashtags: Array<XAutocompleteSearchResponse.Hashtag>;
|
|
161
|
+
/**
|
|
162
|
+
* The query you sent, trimmed.
|
|
163
|
+
*/
|
|
164
|
+
query: string;
|
|
165
|
+
/**
|
|
166
|
+
* Suggested search phrases that are not hashtags.
|
|
167
|
+
*/
|
|
168
|
+
topics: Array<XAutocompleteSearchResponse.Topic>;
|
|
169
|
+
/**
|
|
170
|
+
* Suggested accounts.
|
|
171
|
+
*/
|
|
172
|
+
users: Array<XAutocompleteSearchResponse.User>;
|
|
173
|
+
}
|
|
174
|
+
export declare namespace XAutocompleteSearchResponse {
|
|
175
|
+
/**
|
|
176
|
+
* A stock or crypto token X suggests for the query.
|
|
177
|
+
*/
|
|
178
|
+
interface Cashtag {
|
|
179
|
+
/**
|
|
180
|
+
* Ticker symbol without the $.
|
|
181
|
+
*/
|
|
182
|
+
ticker: string;
|
|
183
|
+
/**
|
|
184
|
+
* Logo of the token's chain. Tokens only.
|
|
185
|
+
*/
|
|
186
|
+
chainLogoUrl?: string;
|
|
187
|
+
/**
|
|
188
|
+
* Token contract address. Tokens only.
|
|
189
|
+
*/
|
|
190
|
+
contractAddress?: string;
|
|
191
|
+
/**
|
|
192
|
+
* Currency of price & marketCap.
|
|
193
|
+
*/
|
|
194
|
+
currency?: string;
|
|
195
|
+
/**
|
|
196
|
+
* Price change over the last 24 hours, in percent.
|
|
197
|
+
*/
|
|
198
|
+
dailyChangePercent?: number;
|
|
199
|
+
/**
|
|
200
|
+
* Stock exchange. Stocks only.
|
|
201
|
+
*/
|
|
202
|
+
exchangeShortName?: string;
|
|
203
|
+
/**
|
|
204
|
+
* Logo image URL.
|
|
205
|
+
*/
|
|
206
|
+
logoUrl?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Market capitalization as decimal text.
|
|
209
|
+
*/
|
|
210
|
+
marketCap?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Company or token name.
|
|
213
|
+
*/
|
|
214
|
+
name?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Latest price as decimal text, which keeps every digit.
|
|
217
|
+
*/
|
|
218
|
+
price?: string;
|
|
219
|
+
/**
|
|
220
|
+
* X's tag for the asset. $TICKER for a stock, chain:contract for a token.
|
|
221
|
+
*/
|
|
222
|
+
smartTag?: string;
|
|
223
|
+
}
|
|
224
|
+
/**
|
|
225
|
+
* A hashtag X suggests for the query.
|
|
226
|
+
*/
|
|
227
|
+
interface Hashtag {
|
|
228
|
+
/**
|
|
229
|
+
* Suggested hashtag, with its
|
|
230
|
+
*/
|
|
231
|
+
hashtag: string;
|
|
232
|
+
/**
|
|
233
|
+
* X's inline flag for the hashtag.
|
|
234
|
+
*/
|
|
235
|
+
inline?: boolean;
|
|
236
|
+
/**
|
|
237
|
+
* X's rounded relevance score for the hashtag.
|
|
238
|
+
*/
|
|
239
|
+
score?: number;
|
|
240
|
+
/**
|
|
241
|
+
* Normalized text tokens X matches the hashtag by.
|
|
242
|
+
*/
|
|
243
|
+
tokens?: Array<string>;
|
|
244
|
+
}
|
|
245
|
+
/**
|
|
246
|
+
* A search phrase X suggests for the query.
|
|
247
|
+
*/
|
|
248
|
+
interface Topic {
|
|
249
|
+
/**
|
|
250
|
+
* Suggested search phrase.
|
|
251
|
+
*/
|
|
252
|
+
topic: string;
|
|
253
|
+
/**
|
|
254
|
+
* X's inline flag for the phrase.
|
|
255
|
+
*/
|
|
256
|
+
inline?: boolean;
|
|
257
|
+
/**
|
|
258
|
+
* X's rounded relevance score for the phrase.
|
|
259
|
+
*/
|
|
260
|
+
score?: number;
|
|
261
|
+
/**
|
|
262
|
+
* Normalized text tokens X matches the phrase by.
|
|
263
|
+
*/
|
|
264
|
+
tokens?: Array<string>;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* An account X suggests for the query.
|
|
268
|
+
*/
|
|
269
|
+
interface User {
|
|
270
|
+
/**
|
|
271
|
+
* X user ID.
|
|
272
|
+
*/
|
|
273
|
+
id: string;
|
|
274
|
+
/**
|
|
275
|
+
* Display name.
|
|
276
|
+
*/
|
|
277
|
+
name: string;
|
|
278
|
+
/**
|
|
279
|
+
* Handle without the @.
|
|
280
|
+
*/
|
|
281
|
+
username: string;
|
|
282
|
+
/**
|
|
283
|
+
* Affiliation badges X shows beside the name.
|
|
284
|
+
*/
|
|
285
|
+
badges?: Array<User.Badge>;
|
|
286
|
+
/**
|
|
287
|
+
* X's inline flag for the account.
|
|
288
|
+
*/
|
|
289
|
+
inline?: boolean;
|
|
290
|
+
/**
|
|
291
|
+
* Whether X shows a blue verification badge.
|
|
292
|
+
*/
|
|
293
|
+
isBlueVerified?: boolean;
|
|
294
|
+
/**
|
|
295
|
+
* X's flag for whether media can be generated from this account's persona.
|
|
296
|
+
*/
|
|
297
|
+
isPersonaMediaGenable?: boolean;
|
|
298
|
+
/**
|
|
299
|
+
* Whether the account holds X's legacy verification.
|
|
300
|
+
*/
|
|
301
|
+
isVerified?: boolean;
|
|
302
|
+
/**
|
|
303
|
+
* Public profile location text. Omitted when empty.
|
|
304
|
+
*/
|
|
305
|
+
location?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Avatar URL.
|
|
308
|
+
*/
|
|
309
|
+
profilePicture?: string;
|
|
310
|
+
/**
|
|
311
|
+
* Whether the account protects its posts.
|
|
312
|
+
*/
|
|
313
|
+
protected?: boolean;
|
|
314
|
+
/**
|
|
315
|
+
* X's rounded relevance score for the account.
|
|
316
|
+
*/
|
|
317
|
+
score?: number;
|
|
318
|
+
/**
|
|
319
|
+
* Normalized text tokens X matches the account by.
|
|
320
|
+
*/
|
|
321
|
+
tokens?: Array<string>;
|
|
322
|
+
/**
|
|
323
|
+
* Whether X shows any verification badge.
|
|
324
|
+
*/
|
|
325
|
+
verified?: boolean;
|
|
326
|
+
/**
|
|
327
|
+
* Verification category, such as Government or Business. Omitted when X names
|
|
328
|
+
* none.
|
|
329
|
+
*/
|
|
330
|
+
verifiedType?: string;
|
|
331
|
+
}
|
|
332
|
+
namespace User {
|
|
333
|
+
/**
|
|
334
|
+
* 1 affiliation badge.
|
|
335
|
+
*/
|
|
336
|
+
interface Badge {
|
|
337
|
+
/**
|
|
338
|
+
* Kind of badge.
|
|
339
|
+
*/
|
|
340
|
+
badgeType?: string;
|
|
341
|
+
/**
|
|
342
|
+
* Badge image URL.
|
|
343
|
+
*/
|
|
344
|
+
badgeUrl?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Name of the affiliated account.
|
|
347
|
+
*/
|
|
348
|
+
description?: string;
|
|
349
|
+
}
|
|
350
|
+
}
|
|
82
351
|
}
|
|
83
352
|
export interface XGetArticleResponse {
|
|
84
353
|
article: XGetArticleResponse.Article;
|
|
85
354
|
/**
|
|
86
|
-
* X Article author
|
|
355
|
+
* Available X Article author fields.
|
|
87
356
|
*/
|
|
88
357
|
author?: XGetArticleResponse.Author;
|
|
89
358
|
}
|
|
90
359
|
export declare namespace XGetArticleResponse {
|
|
91
360
|
interface Article {
|
|
361
|
+
/**
|
|
362
|
+
* X's ID for the Article, which differs from its post's ID
|
|
363
|
+
*/
|
|
364
|
+
articleId?: string;
|
|
365
|
+
/**
|
|
366
|
+
* Article blocks as Markdown, with headings, lists, bold, italic, links, images &
|
|
367
|
+
* embedded posts as their x.com URLs. Holds no HTML.
|
|
368
|
+
*/
|
|
369
|
+
bodyMarkdown?: string;
|
|
92
370
|
/**
|
|
93
371
|
* Plain text joined from all article blocks
|
|
94
372
|
*/
|
|
95
373
|
bodyText?: string;
|
|
374
|
+
/**
|
|
375
|
+
* Accounts that bookmarked the Article's post. 0 or more.
|
|
376
|
+
*/
|
|
377
|
+
bookmarkCount?: number;
|
|
96
378
|
contents?: Array<Article.Content>;
|
|
97
379
|
coverImageUrl?: string;
|
|
380
|
+
/**
|
|
381
|
+
* Public metadata whose fields are defined by X.
|
|
382
|
+
*/
|
|
383
|
+
coverMedia?: {
|
|
384
|
+
[key: string]: unknown;
|
|
385
|
+
};
|
|
98
386
|
createdAt?: string;
|
|
387
|
+
/**
|
|
388
|
+
* Public metadata whose fields are defined by X.
|
|
389
|
+
*/
|
|
390
|
+
lifecycleState?: {
|
|
391
|
+
[key: string]: unknown;
|
|
392
|
+
};
|
|
99
393
|
likeCount?: number;
|
|
394
|
+
/**
|
|
395
|
+
* Public metadata whose fields are defined by X.
|
|
396
|
+
*/
|
|
397
|
+
metadata?: {
|
|
398
|
+
[key: string]: unknown;
|
|
399
|
+
};
|
|
100
400
|
previewText?: string;
|
|
101
401
|
quoteCount?: number;
|
|
102
402
|
replyCount?: number;
|
|
403
|
+
/**
|
|
404
|
+
* Reposts of the Article's post. 0 or more.
|
|
405
|
+
*/
|
|
406
|
+
retweetCount?: number;
|
|
407
|
+
/**
|
|
408
|
+
* X's summary of the Article, when X has one
|
|
409
|
+
*/
|
|
410
|
+
summaryText?: string;
|
|
103
411
|
title?: string;
|
|
104
412
|
viewCount?: number;
|
|
105
413
|
}
|
|
106
414
|
namespace Article {
|
|
107
415
|
interface Content {
|
|
416
|
+
/**
|
|
417
|
+
* Alt text of the image or preview image
|
|
418
|
+
*/
|
|
419
|
+
altText?: string;
|
|
420
|
+
/**
|
|
421
|
+
* Caption the author wrote under a media block
|
|
422
|
+
*/
|
|
423
|
+
caption?: string;
|
|
424
|
+
/**
|
|
425
|
+
* Length of a video, in milliseconds
|
|
426
|
+
*/
|
|
427
|
+
durationMs?: number;
|
|
428
|
+
/**
|
|
429
|
+
* Height of the image or preview image
|
|
430
|
+
*/
|
|
108
431
|
height?: number;
|
|
109
432
|
/**
|
|
110
433
|
* Inline text formatting ranges
|
|
111
434
|
*/
|
|
112
435
|
inlineStyleRanges?: Array<Content.InlineStyleRange>;
|
|
113
436
|
/**
|
|
114
|
-
*
|
|
437
|
+
* Links in the block's text, with the text range each covers
|
|
438
|
+
*/
|
|
439
|
+
links?: Array<Content.Link>;
|
|
440
|
+
/**
|
|
441
|
+
* What a media block holds
|
|
442
|
+
*/
|
|
443
|
+
mediaType?: 'image' | 'video' | 'gif';
|
|
444
|
+
/**
|
|
445
|
+
* Image of a media block, or the preview image of a video or GIF
|
|
115
446
|
*/
|
|
116
447
|
previewUrl?: string;
|
|
117
448
|
text?: string;
|
|
449
|
+
/**
|
|
450
|
+
* ID of the post a tweet block embeds
|
|
451
|
+
*/
|
|
452
|
+
tweetId?: string;
|
|
118
453
|
/**
|
|
119
454
|
* Block type: paragraph, header-one, header-two, header-three, header-four,
|
|
120
455
|
* header-five, header-six, unordered-list-item, ordered-list-item, blockquote,
|
|
121
|
-
* code-block, media, divider
|
|
456
|
+
* code-block, markdown, media, tweet, divider
|
|
122
457
|
*/
|
|
123
458
|
type?: string;
|
|
124
459
|
/**
|
|
125
|
-
*
|
|
460
|
+
* Image URL of an image block. A video or GIF block lists its files in `variants`.
|
|
126
461
|
*/
|
|
127
462
|
url?: string;
|
|
463
|
+
/**
|
|
464
|
+
* Files of a video or GIF block, in X's order
|
|
465
|
+
*/
|
|
466
|
+
variants?: Array<Content.Variant>;
|
|
467
|
+
/**
|
|
468
|
+
* Width of the image or preview image
|
|
469
|
+
*/
|
|
128
470
|
width?: number;
|
|
129
471
|
}
|
|
130
472
|
namespace Content {
|
|
131
473
|
interface InlineStyleRange {
|
|
132
474
|
length?: number;
|
|
133
475
|
offset?: number;
|
|
476
|
+
/**
|
|
477
|
+
* X's name for the style, such as Bold or Italic
|
|
478
|
+
*/
|
|
134
479
|
style?: string;
|
|
135
480
|
}
|
|
481
|
+
interface Link {
|
|
482
|
+
length?: number;
|
|
483
|
+
offset?: number;
|
|
484
|
+
url?: string;
|
|
485
|
+
}
|
|
486
|
+
interface Variant {
|
|
487
|
+
contentType: string;
|
|
488
|
+
url: string;
|
|
489
|
+
bitrate?: number;
|
|
490
|
+
}
|
|
136
491
|
}
|
|
137
492
|
}
|
|
138
493
|
/**
|
|
139
|
-
* X Article author
|
|
494
|
+
* Available X Article author fields.
|
|
140
495
|
*/
|
|
141
496
|
interface Author {
|
|
142
497
|
id: string;
|
|
@@ -144,21 +499,98 @@ export declare namespace XGetArticleResponse {
|
|
|
144
499
|
username: string;
|
|
145
500
|
createdAt?: string;
|
|
146
501
|
description?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Whole number from 0.
|
|
504
|
+
*/
|
|
147
505
|
favouritesCount?: number;
|
|
506
|
+
/**
|
|
507
|
+
* Whole number from 0.
|
|
508
|
+
*/
|
|
148
509
|
followersCount?: number;
|
|
510
|
+
/**
|
|
511
|
+
* Whole number from 0.
|
|
512
|
+
*/
|
|
149
513
|
followingCount?: number;
|
|
150
514
|
isBlueVerified?: boolean;
|
|
151
515
|
isTranslator?: boolean;
|
|
152
516
|
isVerified?: boolean;
|
|
153
517
|
location?: string;
|
|
518
|
+
/**
|
|
519
|
+
* Whole number from 0.
|
|
520
|
+
*/
|
|
154
521
|
mediaCount?: number;
|
|
155
522
|
profileBannerUrl?: string;
|
|
156
523
|
profilePicture?: string;
|
|
157
524
|
protected?: boolean;
|
|
525
|
+
/**
|
|
526
|
+
* Whole number from 0.
|
|
527
|
+
*/
|
|
158
528
|
statusesCount?: number;
|
|
159
529
|
url?: string;
|
|
160
530
|
}
|
|
161
531
|
}
|
|
532
|
+
export interface XGetHashflagsResponse {
|
|
533
|
+
/**
|
|
534
|
+
* Hashflags returned & charged.
|
|
535
|
+
*/
|
|
536
|
+
count: number;
|
|
537
|
+
hashflags: Array<XGetHashflagsResponse.Hashflag>;
|
|
538
|
+
/**
|
|
539
|
+
* Hashflags that match the filters, before limit.
|
|
540
|
+
*/
|
|
541
|
+
total: number;
|
|
542
|
+
/**
|
|
543
|
+
* What to send instead. Present only when no hashflag matches.
|
|
544
|
+
*/
|
|
545
|
+
message?: string;
|
|
546
|
+
}
|
|
547
|
+
export declare namespace XGetHashflagsResponse {
|
|
548
|
+
/**
|
|
549
|
+
* A custom emoji X shows after a hashtag for a set time.
|
|
550
|
+
*/
|
|
551
|
+
interface Hashflag {
|
|
552
|
+
/**
|
|
553
|
+
* Animations X plays for the hashtag, such as on a like. Often empty.
|
|
554
|
+
*/
|
|
555
|
+
animations: Array<Hashflag.Animation>;
|
|
556
|
+
/**
|
|
557
|
+
* Image of the emoji.
|
|
558
|
+
*/
|
|
559
|
+
assetUrl: string;
|
|
560
|
+
/**
|
|
561
|
+
* When X stops showing the emoji, in UTC.
|
|
562
|
+
*/
|
|
563
|
+
endsAt: string;
|
|
564
|
+
/**
|
|
565
|
+
* Hashtag text without the hash sign. X also lists some plain phrases.
|
|
566
|
+
*/
|
|
567
|
+
hashtag: string;
|
|
568
|
+
/**
|
|
569
|
+
* Whether X marks the hashflag for its hashfetti effect.
|
|
570
|
+
*/
|
|
571
|
+
isHashfettiEnabled: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* When X starts showing the emoji, in UTC.
|
|
574
|
+
*/
|
|
575
|
+
startsAt: string;
|
|
576
|
+
}
|
|
577
|
+
namespace Hashflag {
|
|
578
|
+
interface Animation {
|
|
579
|
+
/**
|
|
580
|
+
* Animation file.
|
|
581
|
+
*/
|
|
582
|
+
assetUrl: string;
|
|
583
|
+
/**
|
|
584
|
+
* What plays the animation, such as Like.
|
|
585
|
+
*/
|
|
586
|
+
context: string | null;
|
|
587
|
+
/**
|
|
588
|
+
* X's order among the animations of a hashtag.
|
|
589
|
+
*/
|
|
590
|
+
priority: number | null;
|
|
591
|
+
}
|
|
592
|
+
}
|
|
593
|
+
}
|
|
162
594
|
export interface XGetNotificationsResponse {
|
|
163
595
|
has_next_page: boolean;
|
|
164
596
|
next_cursor: string;
|
|
@@ -172,10 +604,66 @@ export declare namespace XGetNotificationsResponse {
|
|
|
172
604
|
type?: string;
|
|
173
605
|
}
|
|
174
606
|
}
|
|
607
|
+
export interface XGetTrendLocationsResponse {
|
|
608
|
+
/**
|
|
609
|
+
* Locations returned & charged.
|
|
610
|
+
*/
|
|
611
|
+
count: number;
|
|
612
|
+
locations: Array<XGetTrendLocationsResponse.Location>;
|
|
613
|
+
/**
|
|
614
|
+
* Locations that match the filters, before limit.
|
|
615
|
+
*/
|
|
616
|
+
total: number;
|
|
617
|
+
/**
|
|
618
|
+
* What to send instead. Present only when no location matches.
|
|
619
|
+
*/
|
|
620
|
+
message?: string;
|
|
621
|
+
}
|
|
622
|
+
export declare namespace XGetTrendLocationsResponse {
|
|
623
|
+
/**
|
|
624
|
+
* A place X offers trends for.
|
|
625
|
+
*/
|
|
626
|
+
interface Location {
|
|
627
|
+
/**
|
|
628
|
+
* Country name. Null for Worldwide.
|
|
629
|
+
*/
|
|
630
|
+
country: string | null;
|
|
631
|
+
/**
|
|
632
|
+
* 2-letter country code. Null for Worldwide.
|
|
633
|
+
*/
|
|
634
|
+
countryCode: string | null;
|
|
635
|
+
name: string;
|
|
636
|
+
/**
|
|
637
|
+
* WOEID of the country or region above it. Null for Worldwide.
|
|
638
|
+
*/
|
|
639
|
+
parentWoeid: number | null;
|
|
640
|
+
/**
|
|
641
|
+
* X's kind of place. Town, Country, Supername for Worldwide, or Unknown.
|
|
642
|
+
*/
|
|
643
|
+
placeType: string | null;
|
|
644
|
+
/**
|
|
645
|
+
* X's numeric code for the kind of place.
|
|
646
|
+
*/
|
|
647
|
+
placeTypeCode: number | null;
|
|
648
|
+
/**
|
|
649
|
+
* X's legacy Yahoo GeoPlanet reference. It may not resolve.
|
|
650
|
+
*/
|
|
651
|
+
url: string | null;
|
|
652
|
+
/**
|
|
653
|
+
* Location ID. Pass it as woeid to /x/trends.
|
|
654
|
+
*/
|
|
655
|
+
woeid: number;
|
|
656
|
+
}
|
|
657
|
+
}
|
|
175
658
|
export interface XGetTrendsResponse {
|
|
176
659
|
count: number;
|
|
177
660
|
trends: Array<XGetTrendsResponse.Trend>;
|
|
178
661
|
woeid: number;
|
|
662
|
+
/**
|
|
663
|
+
* The place country or location named. Absent when woeid picked the place or the
|
|
664
|
+
* request named none.
|
|
665
|
+
*/
|
|
666
|
+
location?: XGetTrendsResponse.Location;
|
|
179
667
|
}
|
|
180
668
|
export declare namespace XGetTrendsResponse {
|
|
181
669
|
interface Trend {
|
|
@@ -196,10 +684,270 @@ export declare namespace XGetTrendsResponse {
|
|
|
196
684
|
*/
|
|
197
685
|
url?: string;
|
|
198
686
|
}
|
|
687
|
+
/**
|
|
688
|
+
* The place country or location named. Absent when woeid picked the place or the
|
|
689
|
+
* request named none.
|
|
690
|
+
*/
|
|
691
|
+
interface Location {
|
|
692
|
+
/**
|
|
693
|
+
* Country name. Null for Worldwide.
|
|
694
|
+
*/
|
|
695
|
+
country: string | null;
|
|
696
|
+
/**
|
|
697
|
+
* 2-letter country code. Null for Worldwide.
|
|
698
|
+
*/
|
|
699
|
+
countryCode: string | null;
|
|
700
|
+
name: string;
|
|
701
|
+
/**
|
|
702
|
+
* WOEID of the country or region above it. Null for Worldwide.
|
|
703
|
+
*/
|
|
704
|
+
parentWoeid: number | null;
|
|
705
|
+
/**
|
|
706
|
+
* X's kind of place. Town, Country, Supername for Worldwide, or Unknown.
|
|
707
|
+
*/
|
|
708
|
+
placeType: string | null;
|
|
709
|
+
/**
|
|
710
|
+
* X's numeric code for the kind of place.
|
|
711
|
+
*/
|
|
712
|
+
placeTypeCode: number | null;
|
|
713
|
+
/**
|
|
714
|
+
* X's legacy Yahoo GeoPlanet reference. It may not resolve.
|
|
715
|
+
*/
|
|
716
|
+
url: string | null;
|
|
717
|
+
/**
|
|
718
|
+
* Location ID. Pass it as woeid to /x/trends.
|
|
719
|
+
*/
|
|
720
|
+
woeid: number;
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
export interface XSearchPlacesResponse {
|
|
724
|
+
/**
|
|
725
|
+
* Places returned & charged.
|
|
726
|
+
*/
|
|
727
|
+
count: number;
|
|
728
|
+
places: Array<XSearchPlacesResponse.Place>;
|
|
729
|
+
/**
|
|
730
|
+
* Places X found, before limit.
|
|
731
|
+
*/
|
|
732
|
+
total: number;
|
|
733
|
+
/**
|
|
734
|
+
* What to send instead. Present only when X finds no place.
|
|
735
|
+
*/
|
|
736
|
+
message?: string;
|
|
737
|
+
}
|
|
738
|
+
export declare namespace XSearchPlacesResponse {
|
|
739
|
+
/**
|
|
740
|
+
* A place X found, with the larger places it lies in.
|
|
741
|
+
*/
|
|
742
|
+
interface Place {
|
|
743
|
+
/**
|
|
744
|
+
* Place ID. Pass it as place to /x/tweets/search.
|
|
745
|
+
*/
|
|
746
|
+
id: string;
|
|
747
|
+
/**
|
|
748
|
+
* Extra details X attaches to some places. Often empty.
|
|
749
|
+
*/
|
|
750
|
+
attributes: {
|
|
751
|
+
[key: string]: unknown;
|
|
752
|
+
};
|
|
753
|
+
/**
|
|
754
|
+
* Outline of the place as GeoJSON. Each point holds longitude, then latitude.
|
|
755
|
+
*/
|
|
756
|
+
boundingBox: Place.BoundingBox | null;
|
|
757
|
+
/**
|
|
758
|
+
* Center of the place. Longitude, then latitude.
|
|
759
|
+
*/
|
|
760
|
+
centroid: Array<number> | null;
|
|
761
|
+
/**
|
|
762
|
+
* Larger places this place lies in. Often 1.
|
|
763
|
+
*/
|
|
764
|
+
containedWithin: Array<Place.ContainedWithin>;
|
|
765
|
+
/**
|
|
766
|
+
* Country the place lies in.
|
|
767
|
+
*/
|
|
768
|
+
country: string | null;
|
|
769
|
+
/**
|
|
770
|
+
* 2-letter code of the country the place lies in.
|
|
771
|
+
*/
|
|
772
|
+
countryCode: string | null;
|
|
773
|
+
/**
|
|
774
|
+
* Name with the region or country around the place.
|
|
775
|
+
*/
|
|
776
|
+
fullName: string | null;
|
|
777
|
+
/**
|
|
778
|
+
* Short name of the place.
|
|
779
|
+
*/
|
|
780
|
+
name: string;
|
|
781
|
+
/**
|
|
782
|
+
* X's kind of place, such as city, admin, neighborhood, poi or country.
|
|
783
|
+
*/
|
|
784
|
+
placeType: string | null;
|
|
785
|
+
/**
|
|
786
|
+
* X's own reference URL for the place.
|
|
787
|
+
*/
|
|
788
|
+
url: string | null;
|
|
789
|
+
}
|
|
790
|
+
namespace Place {
|
|
791
|
+
/**
|
|
792
|
+
* Outline of the place as GeoJSON. Each point holds longitude, then latitude.
|
|
793
|
+
*/
|
|
794
|
+
interface BoundingBox {
|
|
795
|
+
/**
|
|
796
|
+
* Rings of points that draw the outline.
|
|
797
|
+
*/
|
|
798
|
+
coordinates: Array<Array<Array<number>>>;
|
|
799
|
+
/**
|
|
800
|
+
* GeoJSON shape of the outline.
|
|
801
|
+
*/
|
|
802
|
+
type: string;
|
|
803
|
+
}
|
|
804
|
+
/**
|
|
805
|
+
* A place on X, such as a city or a neighborhood.
|
|
806
|
+
*/
|
|
807
|
+
interface ContainedWithin {
|
|
808
|
+
/**
|
|
809
|
+
* Place ID. Pass it as place to /x/tweets/search.
|
|
810
|
+
*/
|
|
811
|
+
id: string;
|
|
812
|
+
/**
|
|
813
|
+
* Extra details X attaches to some places. Often empty.
|
|
814
|
+
*/
|
|
815
|
+
attributes: {
|
|
816
|
+
[key: string]: unknown;
|
|
817
|
+
};
|
|
818
|
+
/**
|
|
819
|
+
* Outline of the place as GeoJSON. Each point holds longitude, then latitude.
|
|
820
|
+
*/
|
|
821
|
+
boundingBox: ContainedWithin.BoundingBox | null;
|
|
822
|
+
/**
|
|
823
|
+
* Center of the place. Longitude, then latitude.
|
|
824
|
+
*/
|
|
825
|
+
centroid: Array<number> | null;
|
|
826
|
+
/**
|
|
827
|
+
* Country the place lies in.
|
|
828
|
+
*/
|
|
829
|
+
country: string | null;
|
|
830
|
+
/**
|
|
831
|
+
* 2-letter code of the country the place lies in.
|
|
832
|
+
*/
|
|
833
|
+
countryCode: string | null;
|
|
834
|
+
/**
|
|
835
|
+
* Name with the region or country around the place.
|
|
836
|
+
*/
|
|
837
|
+
fullName: string | null;
|
|
838
|
+
/**
|
|
839
|
+
* Short name of the place.
|
|
840
|
+
*/
|
|
841
|
+
name: string;
|
|
842
|
+
/**
|
|
843
|
+
* X's kind of place, such as city, admin, neighborhood, poi or country.
|
|
844
|
+
*/
|
|
845
|
+
placeType: string | null;
|
|
846
|
+
/**
|
|
847
|
+
* X's own reference URL for the place.
|
|
848
|
+
*/
|
|
849
|
+
url: string | null;
|
|
850
|
+
}
|
|
851
|
+
namespace ContainedWithin {
|
|
852
|
+
/**
|
|
853
|
+
* Outline of the place as GeoJSON. Each point holds longitude, then latitude.
|
|
854
|
+
*/
|
|
855
|
+
interface BoundingBox {
|
|
856
|
+
/**
|
|
857
|
+
* Rings of points that draw the outline.
|
|
858
|
+
*/
|
|
859
|
+
coordinates: Array<Array<Array<number>>>;
|
|
860
|
+
/**
|
|
861
|
+
* GeoJSON shape of the outline.
|
|
862
|
+
*/
|
|
863
|
+
type: string;
|
|
864
|
+
}
|
|
865
|
+
}
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
export interface XAutocompleteSearchParams {
|
|
869
|
+
/**
|
|
870
|
+
* Text typed so far. Start with # for hashtags or $ for cashtags. A # query
|
|
871
|
+
* returns hashtags & the accounts X suggests for it. Alias: query.
|
|
872
|
+
*/
|
|
873
|
+
q: string;
|
|
874
|
+
/**
|
|
875
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
876
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
877
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
878
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
879
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
880
|
+
* named fields.
|
|
881
|
+
*/
|
|
882
|
+
fields?: string;
|
|
883
|
+
/**
|
|
884
|
+
* Most suggestions to return: 1 to 100, default 20. Accounts fill it first, then
|
|
885
|
+
* topics, hashtags & cashtags. Credits can return fewer. Aliases: pageSize, count,
|
|
886
|
+
* max_results, maxItems, max_items & per_page.
|
|
887
|
+
*/
|
|
888
|
+
limit?: number;
|
|
889
|
+
/**
|
|
890
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
891
|
+
* fields. With fields, it drops from the kept fields.
|
|
892
|
+
*/
|
|
893
|
+
omit?: string;
|
|
894
|
+
/**
|
|
895
|
+
* Comma-separated suggestion types: users, topics, hashtags or cashtags. Omit for
|
|
896
|
+
* all. With only hashtags or only cashtags, the query gets its # or $ when it
|
|
897
|
+
* lacks one.
|
|
898
|
+
*/
|
|
899
|
+
types?: string;
|
|
900
|
+
}
|
|
901
|
+
export interface XGetArticleParams {
|
|
902
|
+
/**
|
|
903
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
904
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
905
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
906
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
907
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
908
|
+
* named fields.
|
|
909
|
+
*/
|
|
910
|
+
fields?: string;
|
|
911
|
+
/**
|
|
912
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
913
|
+
* fields. With fields, it drops from the kept fields.
|
|
914
|
+
*/
|
|
915
|
+
omit?: string;
|
|
916
|
+
}
|
|
917
|
+
export interface XGetHashflagsParams {
|
|
918
|
+
/**
|
|
919
|
+
* Keeps hashflags that run now. Send false to add ended & upcoming ones.
|
|
920
|
+
*/
|
|
921
|
+
activeOnly?: boolean;
|
|
922
|
+
/**
|
|
923
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
924
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
925
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
926
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
927
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
928
|
+
* named fields.
|
|
929
|
+
*/
|
|
930
|
+
fields?: string;
|
|
931
|
+
/**
|
|
932
|
+
* Maximum hashflags to return. Omit it for every match. Credits can return fewer.
|
|
933
|
+
* Aliases pageSize, count, max_results, maxItems, max_items & per_page.
|
|
934
|
+
*/
|
|
935
|
+
limit?: number;
|
|
936
|
+
/**
|
|
937
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
938
|
+
* fields. With fields, it drops from the kept fields.
|
|
939
|
+
*/
|
|
940
|
+
omit?: string;
|
|
941
|
+
/**
|
|
942
|
+
* Text the hashtag contains, such as football. Case insensitive. A leading hash
|
|
943
|
+
* sign is ignored. Alias query.
|
|
944
|
+
*/
|
|
945
|
+
q?: string;
|
|
199
946
|
}
|
|
200
947
|
export interface XGetHomeTimelineParams {
|
|
201
948
|
/**
|
|
202
|
-
* Pagination cursor for
|
|
949
|
+
* Pagination cursor for collection results. Also read as next_cursor, next_token,
|
|
950
|
+
* pagination_token or continuation_token.
|
|
203
951
|
*/
|
|
204
952
|
cursor?: string;
|
|
205
953
|
/**
|
|
@@ -209,7 +957,8 @@ export interface XGetHomeTimelineParams {
|
|
|
209
957
|
}
|
|
210
958
|
export interface XGetNotificationsParams {
|
|
211
959
|
/**
|
|
212
|
-
* Pagination cursor for
|
|
960
|
+
* Pagination cursor for collection results. Also read as next_cursor, next_token,
|
|
961
|
+
* pagination_token or continuation_token.
|
|
213
962
|
*/
|
|
214
963
|
cursor?: string;
|
|
215
964
|
/**
|
|
@@ -217,30 +966,118 @@ export interface XGetNotificationsParams {
|
|
|
217
966
|
*/
|
|
218
967
|
type?: 'All' | 'Verified' | 'Mentions';
|
|
219
968
|
}
|
|
969
|
+
export interface XGetTrendLocationsParams {
|
|
970
|
+
/**
|
|
971
|
+
* Country name or 2-letter code, such as Turkey or TR. Case insensitive. Returns
|
|
972
|
+
* the country & its towns.
|
|
973
|
+
*/
|
|
974
|
+
country?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
977
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
978
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
979
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
980
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
981
|
+
* named fields.
|
|
982
|
+
*/
|
|
983
|
+
fields?: string;
|
|
984
|
+
/**
|
|
985
|
+
* Maximum locations to return. Omit it for every match. Credits can return fewer.
|
|
986
|
+
* Aliases pageSize, count, max_results, maxItems, max_items & per_page.
|
|
987
|
+
*/
|
|
988
|
+
limit?: number;
|
|
989
|
+
/**
|
|
990
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
991
|
+
* fields. With fields, it drops from the kept fields.
|
|
992
|
+
*/
|
|
993
|
+
omit?: string;
|
|
994
|
+
/**
|
|
995
|
+
* Kind of place. Case insensitive. X labels a few towns unknown.
|
|
996
|
+
*/
|
|
997
|
+
placeType?: 'country' | 'town' | 'worldwide' | 'unknown';
|
|
998
|
+
/**
|
|
999
|
+
* Text the location name contains, such as york. Case insensitive. Alias query.
|
|
1000
|
+
*/
|
|
1001
|
+
q?: string;
|
|
1002
|
+
}
|
|
220
1003
|
export interface XGetTrendsParams {
|
|
221
1004
|
/**
|
|
222
1005
|
* Number of trending topics to return (1-50, default 30)
|
|
223
1006
|
*/
|
|
224
1007
|
count?: number;
|
|
225
1008
|
/**
|
|
226
|
-
*
|
|
1009
|
+
* Country to read trends for, by name or 2-letter code, such as Turkey or TR. Case
|
|
1010
|
+
* insensitive.
|
|
1011
|
+
*/
|
|
1012
|
+
country?: string;
|
|
1013
|
+
/**
|
|
1014
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
1015
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
1016
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
1017
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
1018
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
1019
|
+
* named fields.
|
|
1020
|
+
*/
|
|
1021
|
+
fields?: string;
|
|
1022
|
+
/**
|
|
1023
|
+
* Town or country to read trends for, by name, such as Istanbul. Case insensitive.
|
|
1024
|
+
* Add country when 2 towns share a name. /x/trends/locations lists every name.
|
|
1025
|
+
*/
|
|
1026
|
+
location?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
1029
|
+
* fields. With fields, it drops from the kept fields.
|
|
1030
|
+
*/
|
|
1031
|
+
omit?: string;
|
|
1032
|
+
/**
|
|
1033
|
+
* Region WOEID (1=Worldwide, 23424977=US, 23424975=UK, 23424969=Turkey). Wins over
|
|
1034
|
+
* country & location.
|
|
227
1035
|
*/
|
|
228
1036
|
woeid?: number;
|
|
229
1037
|
}
|
|
1038
|
+
export interface XSearchPlacesParams {
|
|
1039
|
+
/**
|
|
1040
|
+
* Place name to search for, such as istanbul. Alias query.
|
|
1041
|
+
*/
|
|
1042
|
+
q: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* Fields to keep in each row, comma-separated. Use dots for nested fields, such as
|
|
1045
|
+
* author.username. A list keeps the field in each item. Case & underscores do not
|
|
1046
|
+
* matter. A row that lacks a field leaves it out. Cursors, counts & diagnostics
|
|
1047
|
+
* always stay. An unknown name answers 400 unknown_field with the valid names,
|
|
1048
|
+
* before any read. The price stays the same. SDK row types then hold only the
|
|
1049
|
+
* named fields.
|
|
1050
|
+
*/
|
|
1051
|
+
fields?: string;
|
|
1052
|
+
/**
|
|
1053
|
+
* Maximum places to return. Omit it for every place X finds. Credits can return
|
|
1054
|
+
* fewer. Aliases pageSize, count, max_results, maxItems, max_items & per_page.
|
|
1055
|
+
*/
|
|
1056
|
+
limit?: number;
|
|
1057
|
+
/**
|
|
1058
|
+
* Fields to drop from each row, comma-separated. It takes the same names as
|
|
1059
|
+
* fields. With fields, it drops from the kept fields.
|
|
1060
|
+
*/
|
|
1061
|
+
omit?: string;
|
|
1062
|
+
}
|
|
230
1063
|
export declare namespace X {
|
|
231
|
-
export { type XGetArticleResponse as XGetArticleResponse, type XGetNotificationsResponse as XGetNotificationsResponse, type XGetTrendsResponse as XGetTrendsResponse, type XGetHomeTimelineParams as XGetHomeTimelineParams, type XGetNotificationsParams as XGetNotificationsParams, type XGetTrendsParams as XGetTrendsParams, };
|
|
1064
|
+
export { type XAutocompleteSearchResponse as XAutocompleteSearchResponse, type XGetArticleResponse as XGetArticleResponse, type XGetHashflagsResponse as XGetHashflagsResponse, type XGetNotificationsResponse as XGetNotificationsResponse, type XGetTrendLocationsResponse as XGetTrendLocationsResponse, type XGetTrendsResponse as XGetTrendsResponse, type XSearchPlacesResponse as XSearchPlacesResponse, type XAutocompleteSearchParams as XAutocompleteSearchParams, type XGetArticleParams as XGetArticleParams, type XGetHashflagsParams as XGetHashflagsParams, type XGetHomeTimelineParams as XGetHomeTimelineParams, type XGetNotificationsParams as XGetNotificationsParams, type XGetTrendLocationsParams as XGetTrendLocationsParams, type XGetTrendsParams as XGetTrendsParams, type XSearchPlacesParams as XSearchPlacesParams, };
|
|
232
1065
|
export { WriteActions as WriteActions, type WriteActionRetrieveResponse as WriteActionRetrieveResponse };
|
|
233
|
-
export {
|
|
234
|
-
export {
|
|
1066
|
+
export { Analysis as Analysis, type AnalysisBrandResponse as AnalysisBrandResponse, type AnalysisClassifyResponse as AnalysisClassifyResponse, type AnalysisMarketSignalsResponse as AnalysisMarketSignalsResponse, type AnalysisNewsResponse as AnalysisNewsResponse, type AnalysisSentimentResponse as AnalysisSentimentResponse, type AnalysisViralScoreResponse as AnalysisViralScoreResponse, type AnalysisBrandParams as AnalysisBrandParams, type AnalysisClassifyParams as AnalysisClassifyParams, type AnalysisMarketSignalsParams as AnalysisMarketSignalsParams, type AnalysisNewsParams as AnalysisNewsParams, type AnalysisSentimentParams as AnalysisSentimentParams, type AnalysisViralScoreParams as AnalysisViralScoreParams, };
|
|
1067
|
+
export { Tweets as Tweets, type TweetAuthor as TweetAuthor, type TweetDetail as TweetDetail, type TweetCreateResponse as TweetCreateResponse, type TweetRetrieveResponse as TweetRetrieveResponse, type TweetListResponse as TweetListResponse, type TweetDeleteResponse as TweetDeleteResponse, type TweetCheckRepostResponse as TweetCheckRepostResponse, type TweetEmbedResponse as TweetEmbedResponse, type TweetGetInsightsResponse as TweetGetInsightsResponse, type TweetGetRepliesResponse as TweetGetRepliesResponse, type TweetGetRetweeterIDsResponse as TweetGetRetweeterIDsResponse, type TweetGetSubtitlesResponse as TweetGetSubtitlesResponse, type TweetResolveLinksResponse as TweetResolveLinksResponse, type TweetSearchResponse as TweetSearchResponse, type TweetTranslateResponse as TweetTranslateResponse, type TweetCreateParams as TweetCreateParams, type TweetRetrieveParams as TweetRetrieveParams, type TweetListParams as TweetListParams, type TweetDeleteParams as TweetDeleteParams, type TweetCheckRepostParams as TweetCheckRepostParams, type TweetEmbedParams as TweetEmbedParams, type TweetGetFavoritersParams as TweetGetFavoritersParams, type TweetGetHiddenRepliesParams as TweetGetHiddenRepliesParams, type TweetGetInsightsParams as TweetGetInsightsParams, type TweetGetQuotesParams as TweetGetQuotesParams, type TweetGetRepliesParams as TweetGetRepliesParams, type TweetGetRetweeterIDsParams as TweetGetRetweeterIDsParams, type TweetGetRetweetersParams as TweetGetRetweetersParams, type TweetGetSubtitlesParams as TweetGetSubtitlesParams, type TweetGetThreadParams as TweetGetThreadParams, type TweetListTopParams as TweetListTopParams, type TweetResolveLinksParams as TweetResolveLinksParams, type TweetSearchParams as TweetSearchParams, type TweetTranslateParams as TweetTranslateParams, };
|
|
1068
|
+
export { Users as Users, type UserRemoveFollowerResponse as UserRemoveFollowerResponse, type UserRetrieveBatchResponse as UserRetrieveBatchResponse, type UserRetrieveBatchTweetsResponse as UserRetrieveBatchTweetsResponse, type UserRetrieveFollowerIDsResponse as UserRetrieveFollowerIDsResponse, type UserRetrieveFollowersResponse as UserRetrieveFollowersResponse, type UserRetrieveFollowingResponse as UserRetrieveFollowingResponse, type UserRetrieveFollowingIDsResponse as UserRetrieveFollowingIDsResponse, type UserRetrieveInsightsResponse as UserRetrieveInsightsResponse, type UserRetrieveListMembershipsResponse as UserRetrieveListMembershipsResponse, type UserRetrieveListsResponse as UserRetrieveListsResponse, type UserRetrieveLiveResponse as UserRetrieveLiveResponse, type UserRetrieveVerifiedFollowersResponse as UserRetrieveVerifiedFollowersResponse, type UserTranslateBioResponse as UserTranslateBioResponse, type UserRetrieveParams as UserRetrieveParams, type UserRemoveFollowerParams as UserRemoveFollowerParams, type UserRetrieveAffiliatesParams as UserRetrieveAffiliatesParams, type UserRetrieveArticlesParams as UserRetrieveArticlesParams, type UserRetrieveBatchParams as UserRetrieveBatchParams, type UserRetrieveBatchTweetsParams as UserRetrieveBatchTweetsParams, type UserRetrieveFollowerIDsParams as UserRetrieveFollowerIDsParams, type UserRetrieveFollowersParams as UserRetrieveFollowersParams, type UserRetrieveFollowersYouKnowParams as UserRetrieveFollowersYouKnowParams, type UserRetrieveFollowingParams as UserRetrieveFollowingParams, type UserRetrieveFollowingIDsParams as UserRetrieveFollowingIDsParams, type UserRetrieveHighlightsParams as UserRetrieveHighlightsParams, type UserRetrieveInsightsParams as UserRetrieveInsightsParams, type UserRetrieveLikesParams as UserRetrieveLikesParams, type UserRetrieveListMembershipsParams as UserRetrieveListMembershipsParams, type UserRetrieveListsParams as UserRetrieveListsParams, type UserRetrieveLiveParams as UserRetrieveLiveParams, type UserRetrieveMediaParams as UserRetrieveMediaParams, type UserRetrieveMentionsParams as UserRetrieveMentionsParams, type UserRetrieveRepliesParams as UserRetrieveRepliesParams, type UserRetrieveSearchParams as UserRetrieveSearchParams, type UserRetrieveSimilarParams as UserRetrieveSimilarParams, type UserRetrieveSubscriptionsParams as UserRetrieveSubscriptionsParams, type UserRetrieveTweetsParams as UserRetrieveTweetsParams, type UserRetrieveVerifiedFollowersParams as UserRetrieveVerifiedFollowersParams, type UserTranslateBioParams as UserTranslateBioParams, };
|
|
235
1069
|
export { Followers as Followers, type FollowerCheckResponse as FollowerCheckResponse, type FollowerCheckParams as FollowerCheckParams, };
|
|
236
|
-
export {
|
|
1070
|
+
export { Jobs as Jobs, type JobRetrieveResponse as JobRetrieveResponse, type JobListLocationsResponse as JobListLocationsResponse, type JobSearchResponse as JobSearchResponse, type JobRetrieveParams as JobRetrieveParams, type JobListLocationsParams as JobListLocationsParams, type JobSearchParams as JobSearchParams, };
|
|
1071
|
+
export { Dm as Dm, type DmDeleteMessageResponse as DmDeleteMessageResponse, type DmRetrieveHistoryResponse as DmRetrieveHistoryResponse, type DmSendResponse as DmSendResponse, type DmDeleteMessageParams as DmDeleteMessageParams, type DmRetrieveHistoryParams as DmRetrieveHistoryParams, type DmSendParams as DmSendParams, };
|
|
237
1072
|
export { Media as Media, type MediaDownloadResponse as MediaDownloadResponse, type MediaUploadResponse as MediaUploadResponse, type MediaDownloadParams as MediaDownloadParams, type MediaUploadParams as MediaUploadParams, };
|
|
238
1073
|
export { Profile as Profile, type ProfileUpdateResponse as ProfileUpdateResponse, type ProfileUpdateAvatarResponse as ProfileUpdateAvatarResponse, type ProfileUpdateBannerResponse as ProfileUpdateBannerResponse, type ProfileUpdateParams as ProfileUpdateParams, type ProfileUpdateAvatarParams as ProfileUpdateAvatarParams, type ProfileUpdateBannerParams as ProfileUpdateBannerParams, };
|
|
239
|
-
export { Communities as Communities, type CommunityCreateResponse as CommunityCreateResponse, type CommunityDeleteResponse as CommunityDeleteResponse, type CommunityRetrieveInfoResponse as CommunityRetrieveInfoResponse, type CommunityCreateParams as CommunityCreateParams, type CommunityDeleteParams as CommunityDeleteParams, type CommunityRetrieveMembersParams as CommunityRetrieveMembersParams, type CommunityRetrieveModeratorsParams as CommunityRetrieveModeratorsParams, type CommunityRetrieveSearchParams as CommunityRetrieveSearchParams, };
|
|
240
|
-
export { Accounts as Accounts, type XAccount as XAccount, type XAccountDetail as XAccountDetail, type AccountCreateResponse as AccountCreateResponse, type AccountListResponse as AccountListResponse, type AccountDeleteResponse as AccountDeleteResponse, type AccountBulkRetryResponse as AccountBulkRetryResponse, type AccountReauthResponse as AccountReauthResponse, type AccountCreateParams as AccountCreateParams, type AccountReauthParams as AccountReauthParams, };
|
|
1074
|
+
export { Communities as Communities, type CommunityCreateResponse as CommunityCreateResponse, type CommunityDeleteResponse as CommunityDeleteResponse, type CommunityListSuggestedResponse as CommunityListSuggestedResponse, type CommunityListTopicsResponse as CommunityListTopicsResponse, type CommunityRetrieveInfoResponse as CommunityRetrieveInfoResponse, type CommunityCreateParams as CommunityCreateParams, type CommunityDeleteParams as CommunityDeleteParams, type CommunityFindParams as CommunityFindParams, type CommunityListPopularParams as CommunityListPopularParams, type CommunityListSuggestedParams as CommunityListSuggestedParams, type CommunityListTopicsParams as CommunityListTopicsParams, type CommunityRetrieveInfoParams as CommunityRetrieveInfoParams, type CommunityRetrieveMembersParams as CommunityRetrieveMembersParams, type CommunityRetrieveModeratorsParams as CommunityRetrieveModeratorsParams, type CommunityRetrieveSearchParams as CommunityRetrieveSearchParams, type CommunitySearchMembersParams as CommunitySearchMembersParams, };
|
|
1075
|
+
export { Accounts as Accounts, type XAccount as XAccount, type XAccountDetail as XAccountDetail, type AccountCreateResponse as AccountCreateResponse, type AccountListResponse as AccountListResponse, type AccountDeleteResponse as AccountDeleteResponse, type AccountBulkRetryResponse as AccountBulkRetryResponse, type AccountReauthResponse as AccountReauthResponse, type AccountCreateParams as AccountCreateParams, type AccountListParams as AccountListParams, type AccountReauthParams as AccountReauthParams, };
|
|
241
1076
|
export { AccountConnectionChallenges as AccountConnectionChallenges, type AccountConnectionChallengeSubmitResponse as AccountConnectionChallengeSubmitResponse, type AccountConnectionChallengeSubmitParams as AccountConnectionChallengeSubmitParams, };
|
|
242
1077
|
export { AccountConnectionAttempts as AccountConnectionAttempts, type AccountConnectionAttemptRetrieveResponse as AccountConnectionAttemptRetrieveResponse, };
|
|
243
|
-
export { Bookmarks as Bookmarks, type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse, type BookmarkListParams as BookmarkListParams, };
|
|
244
|
-
export { Lists as Lists, type ListRetrieveFollowersParams as ListRetrieveFollowersParams, type ListRetrieveMembersParams as ListRetrieveMembersParams, type ListRetrieveTweetsParams as ListRetrieveTweetsParams, };
|
|
1078
|
+
export { Bookmarks as Bookmarks, type BookmarkRetrieveFoldersResponse as BookmarkRetrieveFoldersResponse, type BookmarkListParams as BookmarkListParams, type BookmarkRetrieveFoldersParams as BookmarkRetrieveFoldersParams, };
|
|
1079
|
+
export { Lists as Lists, type ListRetrieveResponse as ListRetrieveResponse, type ListRetrieveFollowersResponse as ListRetrieveFollowersResponse, type ListRetrieveMembersResponse as ListRetrieveMembersResponse, type ListRetrieveSearchResponse as ListRetrieveSearchResponse, type ListRetrieveParams as ListRetrieveParams, type ListRetrieveFollowersParams as ListRetrieveFollowersParams, type ListRetrieveMembersParams as ListRetrieveMembersParams, type ListRetrieveSearchParams as ListRetrieveSearchParams, type ListRetrieveTweetsParams as ListRetrieveTweetsParams, };
|
|
1080
|
+
export { Broadcasts as Broadcasts, type BroadcastRetrieveResponse as BroadcastRetrieveResponse, type BroadcastRetrieveParams as BroadcastRetrieveParams, };
|
|
1081
|
+
export { Spaces as Spaces, type SpaceRetrieveResponse as SpaceRetrieveResponse, type SpaceRetrieveReplayResponse as SpaceRetrieveReplayResponse, type SpaceSearchResponse as SpaceSearchResponse, type SpaceRetrieveParams as SpaceRetrieveParams, type SpaceRetrieveReplayParams as SpaceRetrieveReplayParams, type SpaceSearchParams as SpaceSearchParams, };
|
|
245
1082
|
}
|
|
246
1083
|
//# sourceMappingURL=x.d.ts.map
|