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.
Files changed (466) hide show
  1. package/CHANGELOG.md +65 -0
  2. package/README.md +30 -9
  3. package/client.d.mts +18 -15
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +18 -15
  6. package/client.d.ts.map +1 -1
  7. package/client.js +3 -3
  8. package/client.js.map +1 -1
  9. package/client.mjs +4 -4
  10. package/client.mjs.map +1 -1
  11. package/core/streaming.d.mts +33 -0
  12. package/core/streaming.d.mts.map +1 -0
  13. package/core/streaming.d.ts +33 -0
  14. package/core/streaming.d.ts.map +1 -0
  15. package/core/streaming.js +270 -0
  16. package/core/streaming.js.map +1 -0
  17. package/core/streaming.mjs +265 -0
  18. package/core/streaming.mjs.map +1 -0
  19. package/internal/decoders/line.d.mts +17 -0
  20. package/internal/decoders/line.d.mts.map +1 -0
  21. package/internal/decoders/line.d.ts +17 -0
  22. package/internal/decoders/line.d.ts.map +1 -0
  23. package/internal/decoders/line.js +116 -0
  24. package/internal/decoders/line.js.map +1 -0
  25. package/internal/decoders/line.mjs +111 -0
  26. package/internal/decoders/line.mjs.map +1 -0
  27. package/internal/parse.d.mts.map +1 -1
  28. package/internal/parse.d.ts.map +1 -1
  29. package/internal/parse.js +7 -0
  30. package/internal/parse.js.map +1 -1
  31. package/internal/parse.mjs +7 -0
  32. package/internal/parse.mjs.map +1 -1
  33. package/internal/tslib.js +18 -18
  34. package/package.json +23 -5
  35. package/resources/account.d.mts +35 -12
  36. package/resources/account.d.mts.map +1 -1
  37. package/resources/account.d.ts +35 -12
  38. package/resources/account.d.ts.map +1 -1
  39. package/resources/account.js +4 -3
  40. package/resources/account.js.map +1 -1
  41. package/resources/account.mjs +4 -3
  42. package/resources/account.mjs.map +1 -1
  43. package/resources/compose.d.mts +77 -21
  44. package/resources/compose.d.mts.map +1 -1
  45. package/resources/compose.d.ts +77 -21
  46. package/resources/compose.d.ts.map +1 -1
  47. package/resources/compose.js +3 -4
  48. package/resources/compose.js.map +1 -1
  49. package/resources/compose.mjs +3 -4
  50. package/resources/compose.mjs.map +1 -1
  51. package/resources/credits.d.mts +18 -10
  52. package/resources/credits.d.mts.map +1 -1
  53. package/resources/credits.d.ts +18 -10
  54. package/resources/credits.d.ts.map +1 -1
  55. package/resources/credits.js +5 -4
  56. package/resources/credits.js.map +1 -1
  57. package/resources/credits.mjs +5 -4
  58. package/resources/credits.mjs.map +1 -1
  59. package/resources/drafts.d.mts +13 -17
  60. package/resources/drafts.d.mts.map +1 -1
  61. package/resources/drafts.d.ts +13 -17
  62. package/resources/drafts.d.ts.map +1 -1
  63. package/resources/drafts.js +4 -4
  64. package/resources/drafts.mjs +4 -4
  65. package/resources/draws.d.mts +84 -28
  66. package/resources/draws.d.mts.map +1 -1
  67. package/resources/draws.d.ts +84 -28
  68. package/resources/draws.d.ts.map +1 -1
  69. package/resources/draws.js +24 -9
  70. package/resources/draws.js.map +1 -1
  71. package/resources/draws.mjs +24 -9
  72. package/resources/draws.mjs.map +1 -1
  73. package/resources/events.d.mts +2564 -21
  74. package/resources/events.d.mts.map +1 -1
  75. package/resources/events.d.ts +2564 -21
  76. package/resources/events.d.ts.map +1 -1
  77. package/resources/events.js +34 -2
  78. package/resources/events.js.map +1 -1
  79. package/resources/events.mjs +34 -2
  80. package/resources/events.mjs.map +1 -1
  81. package/resources/extractions.d.mts +410 -128
  82. package/resources/extractions.d.mts.map +1 -1
  83. package/resources/extractions.d.ts +410 -128
  84. package/resources/extractions.d.ts.map +1 -1
  85. package/resources/extractions.js +74 -12
  86. package/resources/extractions.js.map +1 -1
  87. package/resources/extractions.mjs +74 -12
  88. package/resources/extractions.mjs.map +1 -1
  89. package/resources/guest-wallets.d.mts +6 -5
  90. package/resources/guest-wallets.d.mts.map +1 -1
  91. package/resources/guest-wallets.d.ts +6 -5
  92. package/resources/guest-wallets.d.ts.map +1 -1
  93. package/resources/guest-wallets.js +2 -1
  94. package/resources/guest-wallets.js.map +1 -1
  95. package/resources/guest-wallets.mjs +2 -1
  96. package/resources/guest-wallets.mjs.map +1 -1
  97. package/resources/index.d.mts +6 -6
  98. package/resources/index.d.mts.map +1 -1
  99. package/resources/index.d.ts +6 -6
  100. package/resources/index.d.ts.map +1 -1
  101. package/resources/index.js.map +1 -1
  102. package/resources/index.mjs +1 -1
  103. package/resources/index.mjs.map +1 -1
  104. package/resources/monitors/index.d.mts +2 -2
  105. package/resources/monitors/index.d.mts.map +1 -1
  106. package/resources/monitors/index.d.ts +2 -2
  107. package/resources/monitors/index.d.ts.map +1 -1
  108. package/resources/monitors/index.js.map +1 -1
  109. package/resources/monitors/index.mjs.map +1 -1
  110. package/resources/monitors/keywords.d.mts +66 -14
  111. package/resources/monitors/keywords.d.mts.map +1 -1
  112. package/resources/monitors/keywords.d.ts +66 -14
  113. package/resources/monitors/keywords.d.ts.map +1 -1
  114. package/resources/monitors/keywords.js +16 -10
  115. package/resources/monitors/keywords.js.map +1 -1
  116. package/resources/monitors/keywords.mjs +16 -10
  117. package/resources/monitors/keywords.mjs.map +1 -1
  118. package/resources/monitors/monitors.d.mts +53 -16
  119. package/resources/monitors/monitors.d.mts.map +1 -1
  120. package/resources/monitors/monitors.d.ts +53 -16
  121. package/resources/monitors/monitors.d.ts.map +1 -1
  122. package/resources/monitors/monitors.js +12 -10
  123. package/resources/monitors/monitors.js.map +1 -1
  124. package/resources/monitors/monitors.mjs +12 -10
  125. package/resources/monitors/monitors.mjs.map +1 -1
  126. package/resources/radar.d.mts +32 -36
  127. package/resources/radar.d.mts.map +1 -1
  128. package/resources/radar.d.ts +32 -36
  129. package/resources/radar.d.ts.map +1 -1
  130. package/resources/radar.js +1 -1
  131. package/resources/radar.mjs +1 -1
  132. package/resources/shared.d.mts +1726 -233
  133. package/resources/shared.d.mts.map +1 -1
  134. package/resources/shared.d.ts +1726 -233
  135. package/resources/shared.d.ts.map +1 -1
  136. package/resources/styles.d.mts +34 -23
  137. package/resources/styles.d.mts.map +1 -1
  138. package/resources/styles.d.ts +34 -23
  139. package/resources/styles.d.ts.map +1 -1
  140. package/resources/styles.js +11 -13
  141. package/resources/styles.js.map +1 -1
  142. package/resources/styles.mjs +11 -13
  143. package/resources/styles.mjs.map +1 -1
  144. package/resources/subscribe.d.mts +1 -1
  145. package/resources/subscribe.d.ts +1 -1
  146. package/resources/subscribe.js +1 -1
  147. package/resources/subscribe.mjs +1 -1
  148. package/resources/support/index.d.mts +1 -1
  149. package/resources/support/index.d.mts.map +1 -1
  150. package/resources/support/index.d.ts +1 -1
  151. package/resources/support/index.d.ts.map +1 -1
  152. package/resources/support/index.js.map +1 -1
  153. package/resources/support/index.mjs.map +1 -1
  154. package/resources/support/support.d.mts +2 -2
  155. package/resources/support/support.d.mts.map +1 -1
  156. package/resources/support/support.d.ts +2 -2
  157. package/resources/support/support.d.ts.map +1 -1
  158. package/resources/support/support.js.map +1 -1
  159. package/resources/support/support.mjs.map +1 -1
  160. package/resources/support/tickets.d.mts +30 -10
  161. package/resources/support/tickets.d.mts.map +1 -1
  162. package/resources/support/tickets.d.ts +30 -10
  163. package/resources/support/tickets.d.ts.map +1 -1
  164. package/resources/support/tickets.js +7 -7
  165. package/resources/support/tickets.js.map +1 -1
  166. package/resources/support/tickets.mjs +7 -7
  167. package/resources/support/tickets.mjs.map +1 -1
  168. package/resources/trends.d.mts +21 -5
  169. package/resources/trends.d.mts.map +1 -1
  170. package/resources/trends.d.ts +21 -5
  171. package/resources/trends.d.ts.map +1 -1
  172. package/resources/trends.js +2 -1
  173. package/resources/trends.js.map +1 -1
  174. package/resources/trends.mjs +2 -1
  175. package/resources/trends.mjs.map +1 -1
  176. package/resources/webhooks.d.mts +80 -14
  177. package/resources/webhooks.d.mts.map +1 -1
  178. package/resources/webhooks.d.ts +80 -14
  179. package/resources/webhooks.d.ts.map +1 -1
  180. package/resources/webhooks.js +30 -11
  181. package/resources/webhooks.js.map +1 -1
  182. package/resources/webhooks.mjs +30 -11
  183. package/resources/webhooks.mjs.map +1 -1
  184. package/resources/x/account-connection-attempts.d.mts +1 -1
  185. package/resources/x/account-connection-attempts.d.ts +1 -1
  186. package/resources/x/account-connection-attempts.js +1 -1
  187. package/resources/x/account-connection-attempts.mjs +1 -1
  188. package/resources/x/account-connection-challenges.d.mts +30 -11
  189. package/resources/x/account-connection-challenges.d.mts.map +1 -1
  190. package/resources/x/account-connection-challenges.d.ts +30 -11
  191. package/resources/x/account-connection-challenges.d.ts.map +1 -1
  192. package/resources/x/account-connection-challenges.js +5 -4
  193. package/resources/x/account-connection-challenges.js.map +1 -1
  194. package/resources/x/account-connection-challenges.mjs +5 -4
  195. package/resources/x/account-connection-challenges.mjs.map +1 -1
  196. package/resources/x/accounts.d.mts +38 -10
  197. package/resources/x/accounts.d.mts.map +1 -1
  198. package/resources/x/accounts.d.ts +38 -10
  199. package/resources/x/accounts.d.ts.map +1 -1
  200. package/resources/x/accounts.js +8 -7
  201. package/resources/x/accounts.js.map +1 -1
  202. package/resources/x/accounts.mjs +8 -7
  203. package/resources/x/accounts.mjs.map +1 -1
  204. package/resources/x/analysis.d.mts +3274 -0
  205. package/resources/x/analysis.d.mts.map +1 -0
  206. package/resources/x/analysis.d.ts +3274 -0
  207. package/resources/x/analysis.d.ts.map +1 -0
  208. package/resources/x/analysis.js +132 -0
  209. package/resources/x/analysis.js.map +1 -0
  210. package/resources/x/analysis.mjs +128 -0
  211. package/resources/x/analysis.mjs.map +1 -0
  212. package/resources/x/bookmarks.d.mts +84 -9
  213. package/resources/x/bookmarks.d.mts.map +1 -1
  214. package/resources/x/bookmarks.d.ts +84 -9
  215. package/resources/x/bookmarks.d.ts.map +1 -1
  216. package/resources/x/bookmarks.js +6 -4
  217. package/resources/x/bookmarks.js.map +1 -1
  218. package/resources/x/bookmarks.mjs +6 -4
  219. package/resources/x/bookmarks.mjs.map +1 -1
  220. package/resources/x/broadcasts.d.mts +176 -0
  221. package/resources/x/broadcasts.d.mts.map +1 -0
  222. package/resources/x/broadcasts.d.ts +176 -0
  223. package/resources/x/broadcasts.d.ts.map +1 -0
  224. package/resources/x/broadcasts.js +29 -0
  225. package/resources/x/broadcasts.js.map +1 -0
  226. package/resources/x/broadcasts.mjs +25 -0
  227. package/resources/x/broadcasts.mjs.map +1 -0
  228. package/resources/x/communities/communities.d.mts +612 -128
  229. package/resources/x/communities/communities.d.mts.map +1 -1
  230. package/resources/x/communities/communities.d.ts +612 -128
  231. package/resources/x/communities/communities.d.ts.map +1 -1
  232. package/resources/x/communities/communities.js +96 -17
  233. package/resources/x/communities/communities.js.map +1 -1
  234. package/resources/x/communities/communities.mjs +96 -17
  235. package/resources/x/communities/communities.mjs.map +1 -1
  236. package/resources/x/communities/index.d.mts +2 -1
  237. package/resources/x/communities/index.d.mts.map +1 -1
  238. package/resources/x/communities/index.d.ts +2 -1
  239. package/resources/x/communities/index.d.ts.map +1 -1
  240. package/resources/x/communities/index.js +3 -1
  241. package/resources/x/communities/index.js.map +1 -1
  242. package/resources/x/communities/index.mjs +1 -0
  243. package/resources/x/communities/index.mjs.map +1 -1
  244. package/resources/x/communities/join.d.mts +46 -25
  245. package/resources/x/communities/join.d.mts.map +1 -1
  246. package/resources/x/communities/join.d.ts +46 -25
  247. package/resources/x/communities/join.d.ts.map +1 -1
  248. package/resources/x/communities/join.js +10 -7
  249. package/resources/x/communities/join.js.map +1 -1
  250. package/resources/x/communities/join.mjs +10 -7
  251. package/resources/x/communities/join.mjs.map +1 -1
  252. package/resources/x/communities/media.d.mts +197 -0
  253. package/resources/x/communities/media.d.mts.map +1 -0
  254. package/resources/x/communities/media.d.ts +197 -0
  255. package/resources/x/communities/media.d.ts.map +1 -0
  256. package/resources/x/communities/media.js +29 -0
  257. package/resources/x/communities/media.js.map +1 -0
  258. package/resources/x/communities/media.mjs +25 -0
  259. package/resources/x/communities/media.mjs.map +1 -0
  260. package/resources/x/communities/tweets.d.mts +350 -20
  261. package/resources/x/communities/tweets.d.mts.map +1 -1
  262. package/resources/x/communities/tweets.d.ts +350 -20
  263. package/resources/x/communities/tweets.d.ts.map +1 -1
  264. package/resources/x/communities/tweets.js +8 -7
  265. package/resources/x/communities/tweets.js.map +1 -1
  266. package/resources/x/communities/tweets.mjs +8 -7
  267. package/resources/x/communities/tweets.mjs.map +1 -1
  268. package/resources/x/dm.d.mts +245 -13
  269. package/resources/x/dm.d.mts.map +1 -1
  270. package/resources/x/dm.d.ts +245 -13
  271. package/resources/x/dm.d.ts.map +1 -1
  272. package/resources/x/dm.js +29 -2
  273. package/resources/x/dm.js.map +1 -1
  274. package/resources/x/dm.mjs +29 -2
  275. package/resources/x/dm.mjs.map +1 -1
  276. package/resources/x/followers.d.mts +31 -3
  277. package/resources/x/followers.d.mts.map +1 -1
  278. package/resources/x/followers.d.ts +31 -3
  279. package/resources/x/followers.d.ts.map +1 -1
  280. package/resources/x/followers.js +2 -1
  281. package/resources/x/followers.js.map +1 -1
  282. package/resources/x/followers.mjs +2 -1
  283. package/resources/x/followers.mjs.map +1 -1
  284. package/resources/x/index.d.mts +12 -8
  285. package/resources/x/index.d.mts.map +1 -1
  286. package/resources/x/index.d.ts +12 -8
  287. package/resources/x/index.d.ts.map +1 -1
  288. package/resources/x/index.js +9 -1
  289. package/resources/x/index.js.map +1 -1
  290. package/resources/x/index.mjs +5 -1
  291. package/resources/x/index.mjs.map +1 -1
  292. package/resources/x/jobs.d.mts +506 -0
  293. package/resources/x/jobs.d.mts.map +1 -0
  294. package/resources/x/jobs.d.ts +506 -0
  295. package/resources/x/jobs.d.ts.map +1 -0
  296. package/resources/x/jobs.js +60 -0
  297. package/resources/x/jobs.js.map +1 -0
  298. package/resources/x/jobs.mjs +56 -0
  299. package/resources/x/jobs.mjs.map +1 -0
  300. package/resources/x/lists.d.mts +1058 -27
  301. package/resources/x/lists.d.mts.map +1 -1
  302. package/resources/x/lists.d.ts +1058 -27
  303. package/resources/x/lists.d.ts.map +1 -1
  304. package/resources/x/lists.js +39 -9
  305. package/resources/x/lists.js.map +1 -1
  306. package/resources/x/lists.mjs +39 -9
  307. package/resources/x/lists.mjs.map +1 -1
  308. package/resources/x/media.d.mts +24 -13
  309. package/resources/x/media.d.mts.map +1 -1
  310. package/resources/x/media.d.ts +24 -13
  311. package/resources/x/media.d.ts.map +1 -1
  312. package/resources/x/media.js +2 -2
  313. package/resources/x/media.mjs +2 -2
  314. package/resources/x/profile.d.mts +60 -33
  315. package/resources/x/profile.d.mts.map +1 -1
  316. package/resources/x/profile.d.ts +60 -33
  317. package/resources/x/profile.d.ts.map +1 -1
  318. package/resources/x/profile.js +3 -3
  319. package/resources/x/profile.mjs +3 -3
  320. package/resources/x/spaces.d.mts +857 -0
  321. package/resources/x/spaces.d.mts.map +1 -0
  322. package/resources/x/spaces.d.ts +857 -0
  323. package/resources/x/spaces.d.ts.map +1 -0
  324. package/resources/x/spaces.js +58 -0
  325. package/resources/x/spaces.js.map +1 -0
  326. package/resources/x/spaces.mjs +54 -0
  327. package/resources/x/spaces.mjs.map +1 -0
  328. package/resources/x/tweets/index.d.mts +1 -1
  329. package/resources/x/tweets/index.d.mts.map +1 -1
  330. package/resources/x/tweets/index.d.ts +1 -1
  331. package/resources/x/tweets/index.d.ts.map +1 -1
  332. package/resources/x/tweets/index.js.map +1 -1
  333. package/resources/x/tweets/index.mjs.map +1 -1
  334. package/resources/x/tweets/like.d.mts +38 -20
  335. package/resources/x/tweets/like.d.mts.map +1 -1
  336. package/resources/x/tweets/like.d.ts +38 -20
  337. package/resources/x/tweets/like.d.ts.map +1 -1
  338. package/resources/x/tweets/like.js +2 -2
  339. package/resources/x/tweets/like.mjs +2 -2
  340. package/resources/x/tweets/retweet.d.mts +38 -20
  341. package/resources/x/tweets/retweet.d.mts.map +1 -1
  342. package/resources/x/tweets/retweet.d.ts +38 -20
  343. package/resources/x/tweets/retweet.d.ts.map +1 -1
  344. package/resources/x/tweets/retweet.js +2 -2
  345. package/resources/x/tweets/retweet.mjs +2 -2
  346. package/resources/x/tweets/tweets.d.mts +2639 -326
  347. package/resources/x/tweets/tweets.d.mts.map +1 -1
  348. package/resources/x/tweets/tweets.d.ts +2639 -326
  349. package/resources/x/tweets/tweets.d.ts.map +1 -1
  350. package/resources/x/tweets/tweets.js +147 -21
  351. package/resources/x/tweets/tweets.js.map +1 -1
  352. package/resources/x/tweets/tweets.mjs +147 -21
  353. package/resources/x/tweets/tweets.mjs.map +1 -1
  354. package/resources/x/users/follow.d.mts +38 -20
  355. package/resources/x/users/follow.d.mts.map +1 -1
  356. package/resources/x/users/follow.d.ts +38 -20
  357. package/resources/x/users/follow.d.ts.map +1 -1
  358. package/resources/x/users/follow.js +2 -2
  359. package/resources/x/users/follow.mjs +2 -2
  360. package/resources/x/users/index.d.mts +1 -1
  361. package/resources/x/users/index.d.mts.map +1 -1
  362. package/resources/x/users/index.d.ts +1 -1
  363. package/resources/x/users/index.d.ts.map +1 -1
  364. package/resources/x/users/index.js.map +1 -1
  365. package/resources/x/users/index.mjs.map +1 -1
  366. package/resources/x/users/users.d.mts +3068 -457
  367. package/resources/x/users/users.d.mts.map +1 -1
  368. package/resources/x/users/users.d.ts +3068 -457
  369. package/resources/x/users/users.d.ts.map +1 -1
  370. package/resources/x/users/users.js +205 -22
  371. package/resources/x/users/users.js.map +1 -1
  372. package/resources/x/users/users.mjs +205 -22
  373. package/resources/x/users/users.mjs.map +1 -1
  374. package/resources/x/write-actions.d.mts +13 -6
  375. package/resources/x/write-actions.d.mts.map +1 -1
  376. package/resources/x/write-actions.d.ts +13 -6
  377. package/resources/x/write-actions.d.ts.map +1 -1
  378. package/resources/x/write-actions.js +1 -1
  379. package/resources/x/write-actions.mjs +1 -1
  380. package/resources/x/x.d.mts +864 -27
  381. package/resources/x/x.d.mts.map +1 -1
  382. package/resources/x/x.d.ts +864 -27
  383. package/resources/x/x.d.ts.map +1 -1
  384. package/resources/x/x.js +78 -5
  385. package/resources/x/x.js.map +1 -1
  386. package/resources/x/x.mjs +80 -7
  387. package/resources/x/x.mjs.map +1 -1
  388. package/skills/x-twitter-scraper/SKILL.md +99 -344
  389. package/skills/x-twitter-scraper/metadata.json +2 -2
  390. package/skills/x-twitter-scraper/references/mcp-setup.md +12 -15
  391. package/skills/x-twitter-scraper/references/mcp-tools.md +105 -166
  392. package/skills/x-twitter-scraper/references/types-mcp-output-schemas.md +4 -4
  393. package/skills/x-twitter-scraper/references/types.md +0 -1
  394. package/skills/x-twitter-scraper/skill-card.md +5 -6
  395. package/skills/x-twitter-scraper/skillspector-report.md +6 -3
  396. package/skills/xquik-account-automation/LICENSE +21 -0
  397. package/skills/xquik-account-automation/SKILL.md +91 -0
  398. package/skills/xquik-social-research/SKILL.md +48 -55
  399. package/src/client.ts +47 -4
  400. package/src/core/streaming.ts +328 -0
  401. package/src/internal/decoders/line.ts +140 -0
  402. package/src/internal/parse.ts +9 -0
  403. package/src/resources/account.ts +41 -12
  404. package/src/resources/compose.ts +77 -21
  405. package/src/resources/credits.ts +19 -10
  406. package/src/resources/drafts.ts +13 -22
  407. package/src/resources/draws.ts +94 -36
  408. package/src/resources/events.ts +3225 -68
  409. package/src/resources/extractions.ts +512 -125
  410. package/src/resources/guest-wallets.ts +6 -5
  411. package/src/resources/index.ts +24 -1
  412. package/src/resources/monitors/index.ts +2 -0
  413. package/src/resources/monitors/keywords.ts +82 -14
  414. package/src/resources/monitors/monitors.ts +66 -14
  415. package/src/resources/radar.ts +32 -36
  416. package/src/resources/shared.ts +2227 -351
  417. package/src/resources/styles.ts +43 -27
  418. package/src/resources/subscribe.ts +1 -1
  419. package/src/resources/support/index.ts +1 -0
  420. package/src/resources/support/support.ts +2 -0
  421. package/src/resources/support/tickets.ts +38 -10
  422. package/src/resources/trends.ts +23 -5
  423. package/src/resources/webhooks.ts +109 -15
  424. package/src/resources/x/account-connection-attempts.ts +1 -1
  425. package/src/resources/x/account-connection-challenges.ts +39 -11
  426. package/src/resources/x/accounts.ts +46 -10
  427. package/src/resources/x/analysis.ts +3947 -0
  428. package/src/resources/x/bookmarks.ts +103 -9
  429. package/src/resources/x/broadcasts.ts +225 -0
  430. package/src/resources/x/communities/communities.ts +743 -141
  431. package/src/resources/x/communities/index.ts +9 -0
  432. package/src/resources/x/communities/join.ts +46 -23
  433. package/src/resources/x/communities/media.ts +251 -0
  434. package/src/resources/x/communities/tweets.ts +427 -20
  435. package/src/resources/x/dm.ts +334 -11
  436. package/src/resources/x/followers.ts +35 -3
  437. package/src/resources/x/index.ts +106 -1
  438. package/src/resources/x/jobs.ts +627 -0
  439. package/src/resources/x/lists.ts +1307 -28
  440. package/src/resources/x/media.ts +24 -12
  441. package/src/resources/x/profile.ts +60 -30
  442. package/src/resources/x/spaces.ts +1076 -0
  443. package/src/resources/x/tweets/index.ts +18 -0
  444. package/src/resources/x/tweets/like.ts +38 -18
  445. package/src/resources/x/tweets/retweet.ts +38 -18
  446. package/src/resources/x/tweets/tweets.ts +3695 -843
  447. package/src/resources/x/users/follow.ts +38 -18
  448. package/src/resources/x/users/index.ts +22 -0
  449. package/src/resources/x/users/users.ts +3687 -465
  450. package/src/resources/x/write-actions.ts +13 -5
  451. package/src/resources/x/x.ts +1227 -15
  452. package/src/streaming.ts +6 -0
  453. package/src/version.ts +1 -1
  454. package/streaming.d.mts +3 -0
  455. package/streaming.d.mts.map +1 -0
  456. package/streaming.d.ts +3 -0
  457. package/streaming.d.ts.map +1 -0
  458. package/streaming.js +9 -0
  459. package/streaming.js.map +1 -0
  460. package/streaming.mjs +6 -0
  461. package/streaming.mjs.map +1 -0
  462. package/version.d.mts +1 -1
  463. package/version.d.ts +1 -1
  464. package/version.js +1 -1
  465. package/version.mjs +1 -1
  466. package/skills/x-twitter-scraper/references/types-rest-api-vs-mcp-field-naming.md +0 -15
@@ -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,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE,KAAK,eAAe,EAAE,oBAAiB;AAC9G,OAAO,EACL,WAAW,EACX,KAAK,aAAa,EAClB,KAAK,0BAA0B,EAC/B,KAAK,sBAAsB,EAC3B,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,GACzB,+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,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,yBAAyB,EAC9B,KAAK,6BAA6B,EAClC,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,sBAAmB;AACpB,OAAO,EACL,CAAC,EACD,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,kBAAkB,EACvB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,GACtB,iBAAc"}
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"}
@@ -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,sCAA8G;AAArG,gGAAA,MAAM,OAAA;AACf,gDAYuB;AAXrB,0GAAA,WAAW,OAAA;AAYb,oDAQyB;AAPvB,6GAAA,YAAY,OAAA;AAQd,mDAQ6B;AAP3B,oGAAA,QAAQ,OAAA;AAQV,oCAKiB;AAJf,8FAAA,KAAK,OAAA;AAKP,sCAUkB;AAThB,gGAAA,MAAM,OAAA;AAUR,4CAAkG;AAAzF,sGAAA,SAAS,OAAA;AAClB,gDAA4C;AAAnC,kGAAA,OAAO,OAAA;AAChB,sCAAgF;AAAvE,gGAAA,MAAM,OAAA;AACf,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA;AAYV,8BAQe;AAPb,sFAAA,CAAC,OAAA"}
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"}
@@ -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";
@@ -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,EAAE,MAAM,EAA8E,qBAAiB;AAC9G,OAAO,EACL,WAAW,GAWZ,0BAAsB;AACvB,OAAO,EACL,YAAY,GAOb,4BAAwB;AACzB,OAAO,EACL,QAAQ,GAOT,gCAA4B;AAC7B,OAAO,EACL,KAAK,GAIN,oBAAgB;AACjB,OAAO,EACL,MAAM,GASP,qBAAiB;AAClB,OAAO,EAAE,SAAS,EAA4D,wBAAoB;AAClG,OAAO,EAAE,OAAO,EAAE,8BAA0B;AAC5C,OAAO,EAAE,MAAM,EAAgD,qBAAiB;AAChF,OAAO,EACL,QAAQ,GAWT,uBAAmB;AACpB,OAAO,EACL,CAAC,GAOF,kBAAc"}
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,GACzB,uBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,uBAAmB"}
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,GACzB,sBAAmB;AACpB,OAAO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,GACzB,sBAAmB"}
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,0CASoB;AARlB,oGAAA,QAAQ,OAAA;AASV,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA"}
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,GAQT,uBAAmB;AACpB,OAAO,EACL,QAAQ,GAOT,uBAAmB"}
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. Keyword monitors are unlimited. Active monitors check
11
- * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
12
- * included. Creation requires available credits for the first hourly charge.
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
- * Get keyword monitor
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
- * Update keyword monitor
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
- * { eventTypes: ['tweet.new'], isActive: true },
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
- * List keyword monitors
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
- * Delete keyword monitor
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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;;;;;;;;;;;;OAYG;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;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;;;OASG;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;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;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;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE7C,KAAK,EAAE,MAAM,CAAC;CACf;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;KACf;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,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;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;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,GAChD,CAAC;CACH"}
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. Keyword monitors are unlimited. Active monitors check
11
- * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
12
- * included. Creation requires available credits for the first hourly charge.
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
- * Get keyword monitor
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
- * Update keyword monitor
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
- * { eventTypes: ['tweet.new'], isActive: true },
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
- * List keyword monitors
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
- * Delete keyword monitor
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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 usage charge time for this keyword query monitor.
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;;;;;;;;;;;;OAYG;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;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAI1G;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI/D;;;;;;;;;OASG;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;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;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;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,KAAK,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE7C,KAAK,EAAE,MAAM,CAAC;CACf;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;KACf;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,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;CACf;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAErC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;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,GAChD,CAAC;CACH"}
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. Keyword monitors are unlimited. Active monitors check
16
- * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
17
- * included. Creation requires available credits for the first hourly charge.
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
- * Get keyword monitor
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
- * Update keyword monitor
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
- * { eventTypes: ['tweet.new'], isActive: true },
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
- * List keyword monitors
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
- * Delete keyword monitor
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;;;;;;;;;;;;OAYG;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;;;;;;;;;;OAUG;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,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;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;AAxED,4BAwEC"}
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. Keyword monitors are unlimited. Active monitors check
13
- * every 1 second and cost 21 credits per hour. Events and webhook deliveries are
14
- * included. Creation requires available credits for the first hourly charge.
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
- * Get keyword monitor
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
- * Update keyword monitor
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
- * { eventTypes: ['tweet.new'], isActive: true },
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
- * List keyword monitors
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
- * Delete keyword monitor
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;;;;;;;;;;;;OAYG;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;;;;;;;;;;OAUG;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,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;OASG;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"}
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"}