x-twitter-scraper 0.12.4 → 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 +65 -0
- package/README.md +30 -9
- 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 +99 -344
- package/skills/x-twitter-scraper/metadata.json +2 -2
- package/skills/x-twitter-scraper/references/mcp-setup.md +12 -15
- package/skills/x-twitter-scraper/references/mcp-tools.md +105 -166
- 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/skill-card.md +5 -6
- package/skills/x-twitter-scraper/skillspector-report.md +6 -3
- package/skills/xquik-account-automation/LICENSE +21 -0
- package/skills/xquik-account-automation/SKILL.md +91 -0
- package/skills/xquik-social-research/SKILL.md +48 -55
- 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/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAMA,4BAAyB;AACzB,OAAO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B,qBAAkB;AACnB,OAAO,EAAE,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,mBAAmB,EAAE,qBAAkB;AAC1F,OAAO,EACL,OAAO,EACP,KAAK,6BAA6B,EAClC,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAC/B,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,GAC9B,qBAAkB;AACnB,OAAO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,oBAAiB;AAClB,OAAO,EACL,KAAK,EACL,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,aAAa,GACnB,mBAAgB;AACjB,OAAO,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAMA,4BAAyB;AACzB,OAAO,EACL,OAAO,EACP,KAAK,uBAAuB,EAC5B,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EAChC,KAAK,yBAAyB,EAC9B,KAAK,yBAAyB,GAC/B,qBAAkB;AACnB,OAAO,EAAE,OAAO,EAAE,KAAK,qBAAqB,EAAE,KAAK,mBAAmB,EAAE,qBAAkB;AAC1F,OAAO,EACL,OAAO,EACP,KAAK,6BAA6B,EAClC,KAAK,iCAAiC,EACtC,KAAK,0BAA0B,EAC/B,KAAK,iCAAiC,EACtC,KAAK,+BAA+B,EACpC,KAAK,wBAAwB,GAC9B,qBAAkB;AACnB,OAAO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,iBAAiB,EACtB,KAAK,eAAe,GACrB,oBAAiB;AAClB,OAAO,EACL,KAAK,EACL,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,aAAa,GACnB,mBAAgB;AACjB,OAAO,EACL,MAAM,EACN,KAAK,KAAK,EACV,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,iBAAiB,GACvB,oBAAiB;AAClB,OAAO,EACL,WAAW,EACX,KAAK,aAAa,EAClB,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,KAAK,wBAAwB,EAC7B,KAAK,8BAA8B,EACnC,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,4BAA4B,EACjC,KAAK,6BAA6B,EAClC,KAAK,mBAAmB,GACzB,yBAAsB;AACvB,OAAO,EACL,YAAY,EACZ,KAAK,iBAAiB,EACtB,KAAK,yBAAyB,EAC9B,KAAK,iCAAiC,EACtC,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,GAC5B,2BAAwB;AACzB,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,+BAA4B;AAC7B,OAAO,EACL,KAAK,EACL,KAAK,SAAS,EACd,KAAK,mCAAmC,EACxC,KAAK,iCAAiC,GACvC,mBAAgB;AACjB,OAAO,EACL,MAAM,EACN,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,oBAAoB,EACzB,KAAK,2BAA2B,EAChC,KAAK,iBAAiB,EACtB,KAAK,eAAe,EACpB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,GACxB,oBAAiB;AAClB,OAAO,EAAE,SAAS,EAAE,KAAK,uBAAuB,EAAE,KAAK,qBAAqB,EAAE,uBAAoB;AAClG,OAAO,EAAE,OAAO,EAAE,6BAA0B;AAC5C,OAAO,EAAE,MAAM,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,oBAAiB;AAChF,OAAO,EACL,QAAQ,EACR,KAAK,QAAQ,EACb,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,iCAAiC,EACtC,KAAK,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,+BAA+B,EACpC,KAAK,2BAA2B,GACjC,sBAAmB;AACpB,OAAO,EACL,CAAC,EACD,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,0BAA0B,EAC/B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC1B,KAAK,yBAAyB,EAC9B,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,GACzB,iBAAc"}
|
package/resources/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;;AAEtC,sFAAsF;AAEtF,sDAAyB;AACzB,wCAOmB;AANjB,kGAAA,OAAO,OAAA;AAOT,wCAA0F;AAAjF,kGAAA,OAAO,OAAA;AAChB,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,oCAWiB;AAVf,8FAAA,KAAK,OAAA;AAWP,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;;AAEtC,sFAAsF;AAEtF,sDAAyB;AACzB,wCAOmB;AANjB,kGAAA,OAAO,OAAA;AAOT,wCAA0F;AAAjF,kGAAA,OAAO,OAAA;AAChB,wCAQmB;AAPjB,kGAAA,OAAO,OAAA;AAQT,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,oCAWiB;AAVf,8FAAA,KAAK,OAAA;AAWP,sCAOkB;AANhB,gGAAA,MAAM,OAAA;AAOR,gDAauB;AAZrB,0GAAA,WAAW,OAAA;AAab,oDAQyB;AAPvB,6GAAA,YAAY,OAAA;AAQd,mDAS6B;AAR3B,oGAAA,QAAQ,OAAA;AASV,oCAKiB;AAJf,8FAAA,KAAK,OAAA;AAKP,sCAWkB;AAVhB,gGAAA,MAAM,OAAA;AAWR,4CAAkG;AAAzF,sGAAA,SAAS,OAAA;AAClB,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,sCAAgF;AAAvE,gGAAA,MAAM,OAAA;AACf,0CAgBoB;AAflB,oGAAA,QAAQ,OAAA;AAgBV,8BAiBe;AAhBb,sFAAA,CAAC,OAAA"}
|
package/resources/index.mjs
CHANGED
|
@@ -8,7 +8,7 @@ export { Compose } from "./compose.mjs";
|
|
|
8
8
|
export { Credits, } from "./credits.mjs";
|
|
9
9
|
export { Drafts, } from "./drafts.mjs";
|
|
10
10
|
export { Draws, } from "./draws.mjs";
|
|
11
|
-
export { Events } from "./events.mjs";
|
|
11
|
+
export { Events, } from "./events.mjs";
|
|
12
12
|
export { Extractions, } from "./extractions.mjs";
|
|
13
13
|
export { GuestWallets, } from "./guest-wallets.mjs";
|
|
14
14
|
export { Monitors, } from "./monitors/monitors.mjs";
|
package/resources/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,6BAAyB;AACzB,OAAO,EACL,OAAO,GAMR,sBAAkB;AACnB,OAAO,EAAE,OAAO,EAAwD,sBAAkB;AAC1F,OAAO,EACL,OAAO,GAOR,sBAAkB;AACnB,OAAO,EACL,MAAM,GAMP,qBAAiB;AAClB,OAAO,EACL,KAAK,GAUN,oBAAgB;AACjB,OAAO,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,6BAAyB;AACzB,OAAO,EACL,OAAO,GAMR,sBAAkB;AACnB,OAAO,EAAE,OAAO,EAAwD,sBAAkB;AAC1F,OAAO,EACL,OAAO,GAOR,sBAAkB;AACnB,OAAO,EACL,MAAM,GAMP,qBAAiB;AAClB,OAAO,EACL,KAAK,GAUN,oBAAgB;AACjB,OAAO,EACL,MAAM,GAMP,qBAAiB;AAClB,OAAO,EACL,WAAW,GAYZ,0BAAsB;AACvB,OAAO,EACL,YAAY,GAOb,4BAAwB;AACzB,OAAO,EACL,QAAQ,GAQT,gCAA4B;AAC7B,OAAO,EACL,KAAK,GAIN,oBAAgB;AACjB,OAAO,EACL,MAAM,GAUP,qBAAiB;AAClB,OAAO,EAAE,SAAS,EAA4D,wBAAoB;AAClG,OAAO,EAAE,OAAO,EAAE,8BAA0B;AAC5C,OAAO,EAAE,MAAM,EAAgD,qBAAiB;AAChF,OAAO,EACL,QAAQ,GAeT,uBAAmB;AACpB,OAAO,EACL,CAAC,GAgBF,kBAAc"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Keywords, type KeywordCreateResponse, type KeywordRetrieveResponse, type KeywordUpdateResponse, type KeywordListResponse, type KeywordDeactivateResponse, type KeywordCreateParams, type KeywordUpdateParams, } from "./keywords.mjs";
|
|
2
|
-
export { Monitors, type Monitor, type MonitorCreateResponse, type MonitorListResponse, type MonitorDeactivateResponse, type MonitorCreateParams, type MonitorUpdateParams, } from "./monitors.mjs";
|
|
1
|
+
export { Keywords, type KeywordCreateResponse, type KeywordRetrieveResponse, type KeywordUpdateResponse, type KeywordListResponse, type KeywordDeactivateResponse, type KeywordCreateParams, type KeywordUpdateParams, type KeywordListParams, } from "./keywords.mjs";
|
|
2
|
+
export { Monitors, type Monitor, type MonitorCreateResponse, type MonitorListResponse, type MonitorDeactivateResponse, type MonitorCreateParams, type MonitorUpdateParams, type MonitorListParams, } from "./monitors.mjs";
|
|
3
3
|
//# sourceMappingURL=index.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,
|
|
1
|
+
{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,uBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,uBAAmB"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Keywords, type KeywordCreateResponse, type KeywordRetrieveResponse, type KeywordUpdateResponse, type KeywordListResponse, type KeywordDeactivateResponse, type KeywordCreateParams, type KeywordUpdateParams, } from "./keywords.js";
|
|
2
|
-
export { Monitors, type Monitor, type MonitorCreateResponse, type MonitorListResponse, type MonitorDeactivateResponse, type MonitorCreateParams, type MonitorUpdateParams, } from "./monitors.js";
|
|
1
|
+
export { Keywords, type KeywordCreateResponse, type KeywordRetrieveResponse, type KeywordUpdateResponse, type KeywordListResponse, type KeywordDeactivateResponse, type KeywordCreateParams, type KeywordUpdateParams, type KeywordListParams, } from "./keywords.js";
|
|
2
|
+
export { Monitors, type Monitor, type MonitorCreateResponse, type MonitorListResponse, type MonitorDeactivateResponse, type MonitorCreateParams, type MonitorUpdateParams, type MonitorListParams, } from "./monitors.js";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAMA,OAAO,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,sBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,GACvB,sBAAmB"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,0CAUoB;AATlB,oGAAA,QAAQ,OAAA;AAUV,0CASoB;AARlB,oGAAA,QAAQ,OAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EACL,QAAQ,
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../src/resources/monitors/index.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EACL,QAAQ,GAST,uBAAmB;AACpB,OAAO,EACL,QAAQ,GAQT,uBAAmB"}
|
|
@@ -7,21 +7,22 @@ import { RequestOptions } from "../../internal/request-options.mjs";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class Keywords extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Creates a keyword monitor
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* Creates a keyword monitor, with no count limit. Active monitors check every
|
|
11
|
+
* second for 30 credits an hour, events & webhook deliveries included. That hourly
|
|
12
|
+
* price is a monitor's only charge. Creation needs the credits of the first hour.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
16
|
* const keyword = await client.monitors.keywords.create({
|
|
17
17
|
* eventTypes: ['tweet.new'],
|
|
18
18
|
* query: 'xquik OR "x api"',
|
|
19
|
+
* name: 'Launch mentions',
|
|
19
20
|
* });
|
|
20
21
|
* ```
|
|
21
22
|
*/
|
|
22
23
|
create(body: KeywordCreateParams, options?: RequestOptions): APIPromise<KeywordCreateResponse>;
|
|
23
24
|
/**
|
|
24
|
-
*
|
|
25
|
+
* Returns configuration and status for one keyword monitor.
|
|
25
26
|
*
|
|
26
27
|
* @example
|
|
27
28
|
* ```ts
|
|
@@ -32,28 +33,33 @@ export declare class Keywords extends APIResource {
|
|
|
32
33
|
*/
|
|
33
34
|
retrieve(id: string, options?: RequestOptions): APIPromise<KeywordRetrieveResponse>;
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* Updates mutable settings for an existing keyword monitor.
|
|
36
37
|
*
|
|
37
38
|
* @example
|
|
38
39
|
* ```ts
|
|
39
40
|
* const keyword = await client.monitors.keywords.update(
|
|
40
41
|
* 'id',
|
|
41
|
-
* {
|
|
42
|
+
* {
|
|
43
|
+
* eventTypes: ['tweet.new'],
|
|
44
|
+
* isActive: true,
|
|
45
|
+
* name: 'Launch mentions',
|
|
46
|
+
* },
|
|
42
47
|
* );
|
|
43
48
|
* ```
|
|
44
49
|
*/
|
|
45
50
|
update(id: string, body: KeywordUpdateParams, options?: RequestOptions): APIPromise<KeywordUpdateResponse>;
|
|
46
51
|
/**
|
|
47
|
-
*
|
|
52
|
+
* Returns keyword monitors with their current operating states.
|
|
48
53
|
*
|
|
49
54
|
* @example
|
|
50
55
|
* ```ts
|
|
51
56
|
* const keywords = await client.monitors.keywords.list();
|
|
52
57
|
* ```
|
|
53
58
|
*/
|
|
54
|
-
list(options?: RequestOptions): APIPromise<KeywordListResponse>;
|
|
59
|
+
list(query?: KeywordListParams | null | undefined, options?: RequestOptions): APIPromise<KeywordListResponse>;
|
|
55
60
|
/**
|
|
56
|
-
*
|
|
61
|
+
* Stops one keyword monitor, then removes its stored events in bounded batches.
|
|
62
|
+
* Poll statusUrl until the monitor returns 404.
|
|
57
63
|
*
|
|
58
64
|
* @example
|
|
59
65
|
* ```ts
|
|
@@ -76,10 +82,14 @@ export interface KeywordCreateResponse {
|
|
|
76
82
|
eventTypes: Array<Shared.EventType>;
|
|
77
83
|
isActive: boolean;
|
|
78
84
|
/**
|
|
79
|
-
* Next hourly
|
|
85
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
80
86
|
*/
|
|
81
87
|
nextBillingAt: string;
|
|
82
88
|
query: string;
|
|
89
|
+
/**
|
|
90
|
+
* Customer-set label of the keyword monitor, when set.
|
|
91
|
+
*/
|
|
92
|
+
name?: string;
|
|
83
93
|
}
|
|
84
94
|
/**
|
|
85
95
|
* Keyword monitor that tracks matching public X activity.
|
|
@@ -93,10 +103,14 @@ export interface KeywordRetrieveResponse {
|
|
|
93
103
|
eventTypes: Array<Shared.EventType>;
|
|
94
104
|
isActive: boolean;
|
|
95
105
|
/**
|
|
96
|
-
* Next hourly
|
|
106
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
97
107
|
*/
|
|
98
108
|
nextBillingAt: string;
|
|
99
109
|
query: string;
|
|
110
|
+
/**
|
|
111
|
+
* Customer-set label of the keyword monitor, when set.
|
|
112
|
+
*/
|
|
113
|
+
name?: string;
|
|
100
114
|
}
|
|
101
115
|
/**
|
|
102
116
|
* Keyword monitor that tracks matching public X activity.
|
|
@@ -110,14 +124,23 @@ export interface KeywordUpdateResponse {
|
|
|
110
124
|
eventTypes: Array<Shared.EventType>;
|
|
111
125
|
isActive: boolean;
|
|
112
126
|
/**
|
|
113
|
-
* Next hourly
|
|
127
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
114
128
|
*/
|
|
115
129
|
nextBillingAt: string;
|
|
116
130
|
query: string;
|
|
131
|
+
/**
|
|
132
|
+
* Customer-set label of the keyword monitor, when set.
|
|
133
|
+
*/
|
|
134
|
+
name?: string;
|
|
117
135
|
}
|
|
118
136
|
export interface KeywordListResponse {
|
|
137
|
+
hasMore: boolean;
|
|
119
138
|
monitors: Array<KeywordListResponse.Monitor>;
|
|
139
|
+
/**
|
|
140
|
+
* Keyword monitors on this page.
|
|
141
|
+
*/
|
|
120
142
|
total: number;
|
|
143
|
+
nextCursor?: string;
|
|
121
144
|
}
|
|
122
145
|
export declare namespace KeywordListResponse {
|
|
123
146
|
/**
|
|
@@ -132,13 +155,22 @@ export declare namespace KeywordListResponse {
|
|
|
132
155
|
eventTypes: Array<Shared.EventType>;
|
|
133
156
|
isActive: boolean;
|
|
134
157
|
/**
|
|
135
|
-
* Next hourly
|
|
158
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
136
159
|
*/
|
|
137
160
|
nextBillingAt: string;
|
|
138
161
|
query: string;
|
|
162
|
+
/**
|
|
163
|
+
* Customer-set label of the keyword monitor, when set.
|
|
164
|
+
*/
|
|
165
|
+
name?: string;
|
|
139
166
|
}
|
|
140
167
|
}
|
|
141
168
|
export interface KeywordDeactivateResponse {
|
|
169
|
+
deletionStatus: 'deleting';
|
|
170
|
+
/**
|
|
171
|
+
* Poll this monitor URL until it returns 404.
|
|
172
|
+
*/
|
|
173
|
+
statusUrl: string;
|
|
142
174
|
success: true;
|
|
143
175
|
}
|
|
144
176
|
export interface KeywordCreateParams {
|
|
@@ -150,6 +182,10 @@ export interface KeywordCreateParams {
|
|
|
150
182
|
* X search query to monitor. Whitespace is normalized.
|
|
151
183
|
*/
|
|
152
184
|
query: string;
|
|
185
|
+
/**
|
|
186
|
+
* Your own label for the keyword monitor. Its events carry it as monitorName.
|
|
187
|
+
*/
|
|
188
|
+
name?: string;
|
|
153
189
|
}
|
|
154
190
|
export interface KeywordUpdateParams {
|
|
155
191
|
/**
|
|
@@ -157,8 +193,24 @@ export interface KeywordUpdateParams {
|
|
|
157
193
|
*/
|
|
158
194
|
eventTypes?: Array<Shared.EventType>;
|
|
159
195
|
isActive?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* New label for the keyword monitor. Send null to remove it.
|
|
198
|
+
*/
|
|
199
|
+
name?: string | null;
|
|
200
|
+
}
|
|
201
|
+
export interface KeywordListParams {
|
|
202
|
+
/**
|
|
203
|
+
* Previous nextCursor. The after alias also works. Offset pagination is not
|
|
204
|
+
* supported.
|
|
205
|
+
*/
|
|
206
|
+
cursor?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
|
|
209
|
+
* next page.
|
|
210
|
+
*/
|
|
211
|
+
limit?: number;
|
|
160
212
|
}
|
|
161
213
|
export declare namespace Keywords {
|
|
162
|
-
export { type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, };
|
|
214
|
+
export { type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, type KeywordListParams as KeywordListParams, };
|
|
163
215
|
}
|
|
164
216
|
//# sourceMappingURL=keywords.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keywords.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"keywords.d.mts","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAClD,OAAO,KAAK,MAAM,sBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,mCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,2CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpC,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,UAAU,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -7,21 +7,22 @@ import { RequestOptions } from "../../internal/request-options.js";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class Keywords extends APIResource {
|
|
9
9
|
/**
|
|
10
|
-
* Creates a keyword monitor
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* Creates a keyword monitor, with no count limit. Active monitors check every
|
|
11
|
+
* second for 30 credits an hour, events & webhook deliveries included. That hourly
|
|
12
|
+
* price is a monitor's only charge. Creation needs the credits of the first hour.
|
|
13
13
|
*
|
|
14
14
|
* @example
|
|
15
15
|
* ```ts
|
|
16
16
|
* const keyword = await client.monitors.keywords.create({
|
|
17
17
|
* eventTypes: ['tweet.new'],
|
|
18
18
|
* query: 'xquik OR "x api"',
|
|
19
|
+
* name: 'Launch mentions',
|
|
19
20
|
* });
|
|
20
21
|
* ```
|
|
21
22
|
*/
|
|
22
23
|
create(body: KeywordCreateParams, options?: RequestOptions): APIPromise<KeywordCreateResponse>;
|
|
23
24
|
/**
|
|
24
|
-
*
|
|
25
|
+
* Returns configuration and status for one keyword monitor.
|
|
25
26
|
*
|
|
26
27
|
* @example
|
|
27
28
|
* ```ts
|
|
@@ -32,28 +33,33 @@ export declare class Keywords extends APIResource {
|
|
|
32
33
|
*/
|
|
33
34
|
retrieve(id: string, options?: RequestOptions): APIPromise<KeywordRetrieveResponse>;
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* Updates mutable settings for an existing keyword monitor.
|
|
36
37
|
*
|
|
37
38
|
* @example
|
|
38
39
|
* ```ts
|
|
39
40
|
* const keyword = await client.monitors.keywords.update(
|
|
40
41
|
* 'id',
|
|
41
|
-
* {
|
|
42
|
+
* {
|
|
43
|
+
* eventTypes: ['tweet.new'],
|
|
44
|
+
* isActive: true,
|
|
45
|
+
* name: 'Launch mentions',
|
|
46
|
+
* },
|
|
42
47
|
* );
|
|
43
48
|
* ```
|
|
44
49
|
*/
|
|
45
50
|
update(id: string, body: KeywordUpdateParams, options?: RequestOptions): APIPromise<KeywordUpdateResponse>;
|
|
46
51
|
/**
|
|
47
|
-
*
|
|
52
|
+
* Returns keyword monitors with their current operating states.
|
|
48
53
|
*
|
|
49
54
|
* @example
|
|
50
55
|
* ```ts
|
|
51
56
|
* const keywords = await client.monitors.keywords.list();
|
|
52
57
|
* ```
|
|
53
58
|
*/
|
|
54
|
-
list(options?: RequestOptions): APIPromise<KeywordListResponse>;
|
|
59
|
+
list(query?: KeywordListParams | null | undefined, options?: RequestOptions): APIPromise<KeywordListResponse>;
|
|
55
60
|
/**
|
|
56
|
-
*
|
|
61
|
+
* Stops one keyword monitor, then removes its stored events in bounded batches.
|
|
62
|
+
* Poll statusUrl until the monitor returns 404.
|
|
57
63
|
*
|
|
58
64
|
* @example
|
|
59
65
|
* ```ts
|
|
@@ -76,10 +82,14 @@ export interface KeywordCreateResponse {
|
|
|
76
82
|
eventTypes: Array<Shared.EventType>;
|
|
77
83
|
isActive: boolean;
|
|
78
84
|
/**
|
|
79
|
-
* Next hourly
|
|
85
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
80
86
|
*/
|
|
81
87
|
nextBillingAt: string;
|
|
82
88
|
query: string;
|
|
89
|
+
/**
|
|
90
|
+
* Customer-set label of the keyword monitor, when set.
|
|
91
|
+
*/
|
|
92
|
+
name?: string;
|
|
83
93
|
}
|
|
84
94
|
/**
|
|
85
95
|
* Keyword monitor that tracks matching public X activity.
|
|
@@ -93,10 +103,14 @@ export interface KeywordRetrieveResponse {
|
|
|
93
103
|
eventTypes: Array<Shared.EventType>;
|
|
94
104
|
isActive: boolean;
|
|
95
105
|
/**
|
|
96
|
-
* Next hourly
|
|
106
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
97
107
|
*/
|
|
98
108
|
nextBillingAt: string;
|
|
99
109
|
query: string;
|
|
110
|
+
/**
|
|
111
|
+
* Customer-set label of the keyword monitor, when set.
|
|
112
|
+
*/
|
|
113
|
+
name?: string;
|
|
100
114
|
}
|
|
101
115
|
/**
|
|
102
116
|
* Keyword monitor that tracks matching public X activity.
|
|
@@ -110,14 +124,23 @@ export interface KeywordUpdateResponse {
|
|
|
110
124
|
eventTypes: Array<Shared.EventType>;
|
|
111
125
|
isActive: boolean;
|
|
112
126
|
/**
|
|
113
|
-
* Next hourly
|
|
127
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
114
128
|
*/
|
|
115
129
|
nextBillingAt: string;
|
|
116
130
|
query: string;
|
|
131
|
+
/**
|
|
132
|
+
* Customer-set label of the keyword monitor, when set.
|
|
133
|
+
*/
|
|
134
|
+
name?: string;
|
|
117
135
|
}
|
|
118
136
|
export interface KeywordListResponse {
|
|
137
|
+
hasMore: boolean;
|
|
119
138
|
monitors: Array<KeywordListResponse.Monitor>;
|
|
139
|
+
/**
|
|
140
|
+
* Keyword monitors on this page.
|
|
141
|
+
*/
|
|
120
142
|
total: number;
|
|
143
|
+
nextCursor?: string;
|
|
121
144
|
}
|
|
122
145
|
export declare namespace KeywordListResponse {
|
|
123
146
|
/**
|
|
@@ -132,13 +155,22 @@ export declare namespace KeywordListResponse {
|
|
|
132
155
|
eventTypes: Array<Shared.EventType>;
|
|
133
156
|
isActive: boolean;
|
|
134
157
|
/**
|
|
135
|
-
* Next hourly
|
|
158
|
+
* Next hourly credit charge time for this keyword query monitor.
|
|
136
159
|
*/
|
|
137
160
|
nextBillingAt: string;
|
|
138
161
|
query: string;
|
|
162
|
+
/**
|
|
163
|
+
* Customer-set label of the keyword monitor, when set.
|
|
164
|
+
*/
|
|
165
|
+
name?: string;
|
|
139
166
|
}
|
|
140
167
|
}
|
|
141
168
|
export interface KeywordDeactivateResponse {
|
|
169
|
+
deletionStatus: 'deleting';
|
|
170
|
+
/**
|
|
171
|
+
* Poll this monitor URL until it returns 404.
|
|
172
|
+
*/
|
|
173
|
+
statusUrl: string;
|
|
142
174
|
success: true;
|
|
143
175
|
}
|
|
144
176
|
export interface KeywordCreateParams {
|
|
@@ -150,6 +182,10 @@ export interface KeywordCreateParams {
|
|
|
150
182
|
* X search query to monitor. Whitespace is normalized.
|
|
151
183
|
*/
|
|
152
184
|
query: string;
|
|
185
|
+
/**
|
|
186
|
+
* Your own label for the keyword monitor. Its events carry it as monitorName.
|
|
187
|
+
*/
|
|
188
|
+
name?: string;
|
|
153
189
|
}
|
|
154
190
|
export interface KeywordUpdateParams {
|
|
155
191
|
/**
|
|
@@ -157,8 +193,24 @@ export interface KeywordUpdateParams {
|
|
|
157
193
|
*/
|
|
158
194
|
eventTypes?: Array<Shared.EventType>;
|
|
159
195
|
isActive?: boolean;
|
|
196
|
+
/**
|
|
197
|
+
* New label for the keyword monitor. Send null to remove it.
|
|
198
|
+
*/
|
|
199
|
+
name?: string | null;
|
|
200
|
+
}
|
|
201
|
+
export interface KeywordListParams {
|
|
202
|
+
/**
|
|
203
|
+
* Previous nextCursor. The after alias also works. Offset pagination is not
|
|
204
|
+
* supported.
|
|
205
|
+
*/
|
|
206
|
+
cursor?: string;
|
|
207
|
+
/**
|
|
208
|
+
* Maximum items per page: 1 to 200, default 200. Pass nextCursor as cursor for the
|
|
209
|
+
* next page.
|
|
210
|
+
*/
|
|
211
|
+
limit?: number;
|
|
160
212
|
}
|
|
161
213
|
export declare namespace Keywords {
|
|
162
|
-
export { type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, };
|
|
214
|
+
export { type KeywordCreateResponse as KeywordCreateResponse, type KeywordRetrieveResponse as KeywordRetrieveResponse, type KeywordUpdateResponse as KeywordUpdateResponse, type KeywordListResponse as KeywordListResponse, type KeywordDeactivateResponse as KeywordDeactivateResponse, type KeywordCreateParams as KeywordCreateParams, type KeywordUpdateParams as KeywordUpdateParams, type KeywordListParams as KeywordListParams, };
|
|
163
215
|
}
|
|
164
216
|
//# sourceMappingURL=keywords.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"keywords.d.ts","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,MAAM,qBAAkB;AACpC,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI9F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,uBAAuB,CAAC;IAInF;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;IAIlC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,yBAAyB,CAAC;CAGxF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IAEjB,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,OAAO;QACtB,EAAE,EAAE,MAAM,CAAC;QAEX,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpC,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,UAAU,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,IAAI,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAEpC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -12,15 +12,16 @@ const path_1 = require("../../internal/utils/path.js");
|
|
|
12
12
|
*/
|
|
13
13
|
class Keywords extends resource_1.APIResource {
|
|
14
14
|
/**
|
|
15
|
-
* Creates a keyword monitor
|
|
16
|
-
*
|
|
17
|
-
*
|
|
15
|
+
* Creates a keyword monitor, with no count limit. Active monitors check every
|
|
16
|
+
* second for 30 credits an hour, events & webhook deliveries included. That hourly
|
|
17
|
+
* price is a monitor's only charge. Creation needs the credits of the first hour.
|
|
18
18
|
*
|
|
19
19
|
* @example
|
|
20
20
|
* ```ts
|
|
21
21
|
* const keyword = await client.monitors.keywords.create({
|
|
22
22
|
* eventTypes: ['tweet.new'],
|
|
23
23
|
* query: 'xquik OR "x api"',
|
|
24
|
+
* name: 'Launch mentions',
|
|
24
25
|
* });
|
|
25
26
|
* ```
|
|
26
27
|
*/
|
|
@@ -28,7 +29,7 @@ class Keywords extends resource_1.APIResource {
|
|
|
28
29
|
return this._client.post('/monitors/keywords', { body, ...options });
|
|
29
30
|
}
|
|
30
31
|
/**
|
|
31
|
-
*
|
|
32
|
+
* Returns configuration and status for one keyword monitor.
|
|
32
33
|
*
|
|
33
34
|
* @example
|
|
34
35
|
* ```ts
|
|
@@ -41,13 +42,17 @@ class Keywords extends resource_1.APIResource {
|
|
|
41
42
|
return this._client.get((0, path_1.path) `/monitors/keywords/${id}`, options);
|
|
42
43
|
}
|
|
43
44
|
/**
|
|
44
|
-
*
|
|
45
|
+
* Updates mutable settings for an existing keyword monitor.
|
|
45
46
|
*
|
|
46
47
|
* @example
|
|
47
48
|
* ```ts
|
|
48
49
|
* const keyword = await client.monitors.keywords.update(
|
|
49
50
|
* 'id',
|
|
50
|
-
* {
|
|
51
|
+
* {
|
|
52
|
+
* eventTypes: ['tweet.new'],
|
|
53
|
+
* isActive: true,
|
|
54
|
+
* name: 'Launch mentions',
|
|
55
|
+
* },
|
|
51
56
|
* );
|
|
52
57
|
* ```
|
|
53
58
|
*/
|
|
@@ -55,18 +60,19 @@ class Keywords extends resource_1.APIResource {
|
|
|
55
60
|
return this._client.patch((0, path_1.path) `/monitors/keywords/${id}`, { body, ...options });
|
|
56
61
|
}
|
|
57
62
|
/**
|
|
58
|
-
*
|
|
63
|
+
* Returns keyword monitors with their current operating states.
|
|
59
64
|
*
|
|
60
65
|
* @example
|
|
61
66
|
* ```ts
|
|
62
67
|
* const keywords = await client.monitors.keywords.list();
|
|
63
68
|
* ```
|
|
64
69
|
*/
|
|
65
|
-
list(options) {
|
|
66
|
-
return this._client.get('/monitors/keywords', options);
|
|
70
|
+
list(query = {}, options) {
|
|
71
|
+
return this._client.get('/monitors/keywords', { query, ...options });
|
|
67
72
|
}
|
|
68
73
|
/**
|
|
69
|
-
*
|
|
74
|
+
* Stops one keyword monitor, then removes its stored events in bounded batches.
|
|
75
|
+
* Poll statusUrl until the monitor returns 404.
|
|
70
76
|
*
|
|
71
77
|
* @example
|
|
72
78
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keywords.js","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC
|
|
1
|
+
{"version":3,"file":"keywords.js","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;;;AAEtC,sFAAsF;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAjFD,4BAiFC"}
|
|
@@ -9,15 +9,16 @@ import { path } from "../../internal/utils/path.mjs";
|
|
|
9
9
|
*/
|
|
10
10
|
export class Keywords extends APIResource {
|
|
11
11
|
/**
|
|
12
|
-
* Creates a keyword monitor
|
|
13
|
-
*
|
|
14
|
-
*
|
|
12
|
+
* Creates a keyword monitor, with no count limit. Active monitors check every
|
|
13
|
+
* second for 30 credits an hour, events & webhook deliveries included. That hourly
|
|
14
|
+
* price is a monitor's only charge. Creation needs the credits of the first hour.
|
|
15
15
|
*
|
|
16
16
|
* @example
|
|
17
17
|
* ```ts
|
|
18
18
|
* const keyword = await client.monitors.keywords.create({
|
|
19
19
|
* eventTypes: ['tweet.new'],
|
|
20
20
|
* query: 'xquik OR "x api"',
|
|
21
|
+
* name: 'Launch mentions',
|
|
21
22
|
* });
|
|
22
23
|
* ```
|
|
23
24
|
*/
|
|
@@ -25,7 +26,7 @@ export class Keywords extends APIResource {
|
|
|
25
26
|
return this._client.post('/monitors/keywords', { body, ...options });
|
|
26
27
|
}
|
|
27
28
|
/**
|
|
28
|
-
*
|
|
29
|
+
* Returns configuration and status for one keyword monitor.
|
|
29
30
|
*
|
|
30
31
|
* @example
|
|
31
32
|
* ```ts
|
|
@@ -38,13 +39,17 @@ export class Keywords extends APIResource {
|
|
|
38
39
|
return this._client.get(path `/monitors/keywords/${id}`, options);
|
|
39
40
|
}
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
+
* Updates mutable settings for an existing keyword monitor.
|
|
42
43
|
*
|
|
43
44
|
* @example
|
|
44
45
|
* ```ts
|
|
45
46
|
* const keyword = await client.monitors.keywords.update(
|
|
46
47
|
* 'id',
|
|
47
|
-
* {
|
|
48
|
+
* {
|
|
49
|
+
* eventTypes: ['tweet.new'],
|
|
50
|
+
* isActive: true,
|
|
51
|
+
* name: 'Launch mentions',
|
|
52
|
+
* },
|
|
48
53
|
* );
|
|
49
54
|
* ```
|
|
50
55
|
*/
|
|
@@ -52,18 +57,19 @@ export class Keywords extends APIResource {
|
|
|
52
57
|
return this._client.patch(path `/monitors/keywords/${id}`, { body, ...options });
|
|
53
58
|
}
|
|
54
59
|
/**
|
|
55
|
-
*
|
|
60
|
+
* Returns keyword monitors with their current operating states.
|
|
56
61
|
*
|
|
57
62
|
* @example
|
|
58
63
|
* ```ts
|
|
59
64
|
* const keywords = await client.monitors.keywords.list();
|
|
60
65
|
* ```
|
|
61
66
|
*/
|
|
62
|
-
list(options) {
|
|
63
|
-
return this._client.get('/monitors/keywords', options);
|
|
67
|
+
list(query = {}, options) {
|
|
68
|
+
return this._client.get('/monitors/keywords', { query, ...options });
|
|
64
69
|
}
|
|
65
70
|
/**
|
|
66
|
-
*
|
|
71
|
+
* Stops one keyword monitor, then removes its stored events in bounded batches.
|
|
72
|
+
* Poll statusUrl until the monitor returns 404.
|
|
67
73
|
*
|
|
68
74
|
* @example
|
|
69
75
|
* ```ts
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"keywords.mjs","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC
|
|
1
|
+
{"version":3,"file":"keywords.mjs","sourceRoot":"","sources":["../../src/resources/monitors/keywords.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,EAAE;AACF,sCAAsC;AAEtC,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAU,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,sBAAsB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}
|