@censys/platform-sdk 0.9.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (494) hide show
  1. package/README.md +19 -13
  2. package/docs/sdks/accountmanagement/README.md +113 -9
  3. package/docs/sdks/collections/README.md +22 -14
  4. package/docs/sdks/globaldata/README.md +27 -14
  5. package/docs/sdks/threathunting/README.md +11 -6
  6. package/examples/package-lock.json +3 -3
  7. package/funcs/accountManagementGetMemberCreditUsage.d.ts +2 -2
  8. package/funcs/accountManagementGetMemberCreditUsage.js +8 -3
  9. package/funcs/accountManagementGetMemberCreditUsage.js.map +1 -1
  10. package/funcs/accountManagementGetOrganizationCreditUsage.d.ts +1 -1
  11. package/funcs/accountManagementGetOrganizationCreditUsage.js +8 -2
  12. package/funcs/accountManagementGetOrganizationCreditUsage.js.map +1 -1
  13. package/funcs/accountManagementGetOrganizationCredits.d.ts +1 -1
  14. package/funcs/accountManagementGetOrganizationCredits.js +4 -2
  15. package/funcs/accountManagementGetOrganizationCredits.js.map +1 -1
  16. package/funcs/accountManagementGetOrganizationDetails.js +3 -1
  17. package/funcs/accountManagementGetOrganizationDetails.js.map +1 -1
  18. package/funcs/accountManagementGetUserCredits.d.ts +2 -2
  19. package/funcs/accountManagementGetUserCredits.js +5 -3
  20. package/funcs/accountManagementGetUserCredits.js.map +1 -1
  21. package/funcs/accountManagementGetUserCreditsUsage.d.ts +18 -0
  22. package/funcs/accountManagementGetUserCreditsUsage.d.ts.map +1 -0
  23. package/funcs/accountManagementGetUserCreditsUsage.js +131 -0
  24. package/funcs/accountManagementGetUserCreditsUsage.js.map +1 -0
  25. package/funcs/accountManagementInviteUserToOrganization.js +4 -2
  26. package/funcs/accountManagementInviteUserToOrganization.js.map +1 -1
  27. package/funcs/accountManagementListOrganizationMembers.js +4 -2
  28. package/funcs/accountManagementListOrganizationMembers.js.map +1 -1
  29. package/funcs/accountManagementRemoveOrganizationMember.js +3 -1
  30. package/funcs/accountManagementRemoveOrganizationMember.js.map +1 -1
  31. package/funcs/accountManagementUpdateOrganizationMember.js +4 -2
  32. package/funcs/accountManagementUpdateOrganizationMember.js.map +1 -1
  33. package/funcs/collectionsAggregate.js +4 -2
  34. package/funcs/collectionsAggregate.js.map +1 -1
  35. package/funcs/collectionsCreate.d.ts +1 -1
  36. package/funcs/collectionsCreate.js +5 -3
  37. package/funcs/collectionsCreate.js.map +1 -1
  38. package/funcs/collectionsDelete.d.ts +1 -1
  39. package/funcs/collectionsDelete.js +5 -3
  40. package/funcs/collectionsDelete.js.map +1 -1
  41. package/funcs/collectionsGet.d.ts +1 -1
  42. package/funcs/collectionsGet.js +5 -3
  43. package/funcs/collectionsGet.js.map +1 -1
  44. package/funcs/collectionsList.d.ts +1 -1
  45. package/funcs/collectionsList.js +5 -3
  46. package/funcs/collectionsList.js.map +1 -1
  47. package/funcs/collectionsListEvents.d.ts +1 -1
  48. package/funcs/collectionsListEvents.js +5 -3
  49. package/funcs/collectionsListEvents.js.map +1 -1
  50. package/funcs/collectionsSearch.js +4 -2
  51. package/funcs/collectionsSearch.js.map +1 -1
  52. package/funcs/collectionsUpdate.d.ts +1 -1
  53. package/funcs/collectionsUpdate.js +5 -3
  54. package/funcs/collectionsUpdate.js.map +1 -1
  55. package/funcs/globalDataAggregate.js +4 -2
  56. package/funcs/globalDataAggregate.js.map +1 -1
  57. package/funcs/globalDataConvertLegacySearchQueries.js +2 -2
  58. package/funcs/globalDataConvertLegacySearchQueries.js.map +1 -1
  59. package/funcs/globalDataCreateTrackedScan.js +4 -2
  60. package/funcs/globalDataCreateTrackedScan.js.map +1 -1
  61. package/funcs/globalDataGetCertificate.js +4 -2
  62. package/funcs/globalDataGetCertificate.js.map +1 -1
  63. package/funcs/globalDataGetCertificateRaw.js +4 -2
  64. package/funcs/globalDataGetCertificateRaw.js.map +1 -1
  65. package/funcs/globalDataGetCertificates.js +4 -2
  66. package/funcs/globalDataGetCertificates.js.map +1 -1
  67. package/funcs/globalDataGetCertificatesRaw.js +4 -2
  68. package/funcs/globalDataGetCertificatesRaw.js.map +1 -1
  69. package/funcs/globalDataGetHost.js +4 -2
  70. package/funcs/globalDataGetHost.js.map +1 -1
  71. package/funcs/globalDataGetHostTimeline.js +4 -2
  72. package/funcs/globalDataGetHostTimeline.js.map +1 -1
  73. package/funcs/globalDataGetHosts.js +4 -2
  74. package/funcs/globalDataGetHosts.js.map +1 -1
  75. package/funcs/globalDataGetTrackedScan.js +4 -2
  76. package/funcs/globalDataGetTrackedScan.js.map +1 -1
  77. package/funcs/globalDataGetWebProperties.js +4 -2
  78. package/funcs/globalDataGetWebProperties.js.map +1 -1
  79. package/funcs/globalDataGetWebProperty.js +4 -2
  80. package/funcs/globalDataGetWebProperty.js.map +1 -1
  81. package/funcs/globalDataSearch.js +4 -2
  82. package/funcs/globalDataSearch.js.map +1 -1
  83. package/funcs/threatHuntingCreateTrackedScan.js +4 -2
  84. package/funcs/threatHuntingCreateTrackedScan.js.map +1 -1
  85. package/funcs/threatHuntingGetHostObservationsWithCertificate.js +4 -2
  86. package/funcs/threatHuntingGetHostObservationsWithCertificate.js.map +1 -1
  87. package/funcs/threatHuntingGetTrackedScanThreatHunting.js +4 -2
  88. package/funcs/threatHuntingGetTrackedScanThreatHunting.js.map +1 -1
  89. package/funcs/threatHuntingListThreats.d.ts +1 -1
  90. package/funcs/threatHuntingListThreats.js +5 -3
  91. package/funcs/threatHuntingListThreats.js.map +1 -1
  92. package/funcs/threatHuntingValueCounts.js +4 -2
  93. package/funcs/threatHuntingValueCounts.js.map +1 -1
  94. package/jsr.json +1 -1
  95. package/lib/config.d.ts +4 -4
  96. package/lib/config.js +4 -4
  97. package/lib/config.js.map +1 -1
  98. package/lib/sdks.js +2 -2
  99. package/lib/sdks.js.map +1 -1
  100. package/models/components/alternativequery.d.ts +3 -3
  101. package/models/components/alternativequery.d.ts.map +1 -1
  102. package/models/components/alternativequery.js +2 -2
  103. package/models/components/alternativequery.js.map +1 -1
  104. package/models/components/attribute.d.ts +4 -3
  105. package/models/components/attribute.d.ts.map +1 -1
  106. package/models/components/attribute.js +3 -2
  107. package/models/components/attribute.js.map +1 -1
  108. package/models/components/certificate.d.ts +5 -5
  109. package/models/components/certificate.d.ts.map +1 -1
  110. package/models/components/certificate.js +3 -3
  111. package/models/components/certificate.js.map +1 -1
  112. package/models/components/certificaterevocationrevocationinfo.d.ts +3 -3
  113. package/models/components/certificaterevocationrevocationinfo.d.ts.map +1 -1
  114. package/models/components/certificaterevocationrevocationinfo.js +2 -2
  115. package/models/components/certificaterevocationrevocationinfo.js.map +1 -1
  116. package/models/components/collection.d.ts +9 -5
  117. package/models/components/collection.d.ts.map +1 -1
  118. package/models/components/collection.js +5 -2
  119. package/models/components/collection.js.map +1 -1
  120. package/models/components/creditexpiration.d.ts +4 -0
  121. package/models/components/creditexpiration.d.ts.map +1 -1
  122. package/models/components/creditexpiration.js +2 -0
  123. package/models/components/creditexpiration.js.map +1 -1
  124. package/models/components/creditusagereport.d.ts +44 -5
  125. package/models/components/creditusagereport.d.ts.map +1 -1
  126. package/models/components/creditusagereport.js +28 -7
  127. package/models/components/creditusagereport.js.map +1 -1
  128. package/models/components/creditusagereportperiod.d.ts +33 -0
  129. package/models/components/creditusagereportperiod.d.ts.map +1 -0
  130. package/models/components/creditusagereportperiod.js +65 -0
  131. package/models/components/creditusagereportperiod.js.map +1 -0
  132. package/models/components/cvsscomponents.d.ts +17 -17
  133. package/models/components/cvsscomponents.d.ts.map +1 -1
  134. package/models/components/cvsscomponents.js +9 -9
  135. package/models/components/cvsscomponents.js.map +1 -1
  136. package/models/components/cvssv4components.d.ts +29 -29
  137. package/models/components/cvssv4components.d.ts.map +1 -1
  138. package/models/components/cvssv4components.js +15 -17
  139. package/models/components/cvssv4components.js.map +1 -1
  140. package/models/components/dns.d.ts +5 -5
  141. package/models/components/dns.d.ts.map +1 -1
  142. package/models/components/dns.js +3 -3
  143. package/models/components/dns.js.map +1 -1
  144. package/models/components/dnsresourcerecord.d.ts +3 -3
  145. package/models/components/dnsresourcerecord.d.ts.map +1 -1
  146. package/models/components/dnsresourcerecord.js +2 -1
  147. package/models/components/dnsresourcerecord.js.map +1 -1
  148. package/models/components/endpointscan.d.ts +3 -3
  149. package/models/components/endpointscan.d.ts.map +1 -1
  150. package/models/components/endpointscan.js +2 -1
  151. package/models/components/endpointscan.js.map +1 -1
  152. package/models/components/endpointscanstate.d.ts +5 -3
  153. package/models/components/endpointscanstate.d.ts.map +1 -1
  154. package/models/components/endpointscanstate.js +4 -1
  155. package/models/components/endpointscanstate.js.map +1 -1
  156. package/models/components/eventassetchange.d.ts +3 -3
  157. package/models/components/eventassetchange.d.ts.map +1 -1
  158. package/models/components/eventassetchange.js +2 -2
  159. package/models/components/eventassetchange.js.map +1 -1
  160. package/models/components/eventstatuschange.d.ts +5 -5
  161. package/models/components/eventstatuschange.d.ts.map +1 -1
  162. package/models/components/eventstatuschange.js +3 -4
  163. package/models/components/eventstatuschange.js.map +1 -1
  164. package/models/components/extractedendpointdata.d.ts +17 -0
  165. package/models/components/extractedendpointdata.d.ts.map +1 -0
  166. package/models/components/extractedendpointdata.js +65 -0
  167. package/models/components/extractedendpointdata.js.map +1 -0
  168. package/models/components/extractedendpointdataanalyticsservice.d.ts +11 -0
  169. package/models/components/extractedendpointdataanalyticsservice.d.ts.map +1 -0
  170. package/models/components/extractedendpointdataanalyticsservice.js +51 -0
  171. package/models/components/extractedendpointdataanalyticsservice.js.map +1 -0
  172. package/models/components/extractedendpointdatacopyright.d.ts +13 -0
  173. package/models/components/extractedendpointdatacopyright.d.ts.map +1 -0
  174. package/models/components/extractedendpointdatacopyright.js +59 -0
  175. package/models/components/extractedendpointdatacopyright.js.map +1 -0
  176. package/models/components/flashsocketpolicy.d.ts +13 -0
  177. package/models/components/flashsocketpolicy.d.ts.map +1 -0
  178. package/models/components/flashsocketpolicy.js +59 -0
  179. package/models/components/flashsocketpolicy.js.map +1 -0
  180. package/models/components/flashsocketpolicyallowaccessfrom.d.ts +12 -0
  181. package/models/components/flashsocketpolicyallowaccessfrom.d.ts.map +1 -0
  182. package/models/components/flashsocketpolicyallowaccessfrom.js +57 -0
  183. package/models/components/flashsocketpolicyallowaccessfrom.js.map +1 -0
  184. package/models/components/gemini.d.ts +13 -0
  185. package/models/components/gemini.d.ts.map +1 -0
  186. package/models/components/gemini.js +60 -0
  187. package/models/components/gemini.js.map +1 -0
  188. package/models/components/greynoise.d.ts +22 -0
  189. package/models/components/greynoise.d.ts.map +1 -0
  190. package/models/components/greynoise.js +53 -0
  191. package/models/components/greynoise.js.map +1 -0
  192. package/models/components/greynoisetag.d.ts +13 -0
  193. package/models/components/greynoisetag.d.ts.map +1 -0
  194. package/models/components/greynoisetag.js +50 -0
  195. package/models/components/greynoisetag.js.map +1 -0
  196. package/models/components/hajime.d.ts +10 -0
  197. package/models/components/hajime.d.ts.map +1 -0
  198. package/models/components/hajime.js +56 -0
  199. package/models/components/hajime.js.map +1 -0
  200. package/models/components/host.d.ts +2 -0
  201. package/models/components/host.d.ts.map +1 -1
  202. package/models/components/host.js +2 -0
  203. package/models/components/host.js.map +1 -1
  204. package/models/components/hostdnsforwardresolution.d.ts +3 -3
  205. package/models/components/hostdnsforwardresolution.d.ts.map +1 -1
  206. package/models/components/hostdnsforwardresolution.js +2 -2
  207. package/models/components/hostdnsforwardresolution.js.map +1 -1
  208. package/models/components/http.d.ts +7 -0
  209. package/models/components/http.d.ts.map +1 -1
  210. package/models/components/http.js +7 -0
  211. package/models/components/http.js.map +1 -1
  212. package/models/components/httpredirectchainlink.d.ts +26 -0
  213. package/models/components/httpredirectchainlink.d.ts.map +1 -0
  214. package/models/components/httpredirectchainlink.js +71 -0
  215. package/models/components/httpredirectchainlink.js.map +1 -0
  216. package/models/components/index.d.ts +26 -0
  217. package/models/components/index.d.ts.map +1 -1
  218. package/models/components/index.js +26 -0
  219. package/models/components/index.js.map +1 -1
  220. package/models/components/jarmscan.d.ts +3 -3
  221. package/models/components/jarmscan.d.ts.map +1 -1
  222. package/models/components/jarmscan.js +2 -1
  223. package/models/components/jarmscan.js.map +1 -1
  224. package/models/components/kev.d.ts +3 -3
  225. package/models/components/kev.d.ts.map +1 -1
  226. package/models/components/kev.js +2 -2
  227. package/models/components/kev.js.map +1 -1
  228. package/models/components/label.d.ts +4 -3
  229. package/models/components/label.d.ts.map +1 -1
  230. package/models/components/label.js +3 -2
  231. package/models/components/label.js.map +1 -1
  232. package/models/components/matchedservice.d.ts +3 -3
  233. package/models/components/matchedservice.d.ts.map +1 -1
  234. package/models/components/matchedservice.js +2 -1
  235. package/models/components/matchedservice.js.map +1 -1
  236. package/models/components/mavlink.d.ts +12 -0
  237. package/models/components/mavlink.d.ts.map +1 -0
  238. package/models/components/mavlink.js +57 -0
  239. package/models/components/mavlink.js.map +1 -0
  240. package/models/components/mavlinkframe.d.ts +15 -0
  241. package/models/components/mavlinkframe.d.ts.map +1 -0
  242. package/models/components/mavlinkframe.js +63 -0
  243. package/models/components/mavlinkframe.js.map +1 -0
  244. package/models/components/melsec.d.ts +10 -0
  245. package/models/components/melsec.d.ts.map +1 -0
  246. package/models/components/melsec.js +56 -0
  247. package/models/components/melsec.js.map +1 -0
  248. package/models/components/memberlist.d.ts +15 -0
  249. package/models/components/memberlist.d.ts.map +1 -0
  250. package/models/components/memberlist.js +62 -0
  251. package/models/components/memberlist.js.map +1 -0
  252. package/models/components/memberlistnodeinfo.d.ts +16 -0
  253. package/models/components/memberlistnodeinfo.d.ts.map +1 -0
  254. package/models/components/memberlistnodeinfo.js +62 -0
  255. package/models/components/memberlistnodeinfo.js.map +1 -0
  256. package/models/components/networklog.d.ts +18 -0
  257. package/models/components/networklog.d.ts.map +1 -0
  258. package/models/components/networklog.js +58 -0
  259. package/models/components/networklog.js.map +1 -0
  260. package/models/components/networklogresourceinfo.d.ts +49 -0
  261. package/models/components/networklogresourceinfo.d.ts.map +1 -0
  262. package/models/components/networklogresourceinfo.js +64 -0
  263. package/models/components/networklogresourceinfo.js.map +1 -0
  264. package/models/components/paginationinfo.d.ts +1 -1
  265. package/models/components/reject.d.ts +3 -3
  266. package/models/components/reject.d.ts.map +1 -1
  267. package/models/components/reject.js +2 -2
  268. package/models/components/reject.js.map +1 -1
  269. package/models/components/representativeinfo.d.ts +3 -3
  270. package/models/components/representativeinfo.d.ts.map +1 -1
  271. package/models/components/representativeinfo.js +2 -1
  272. package/models/components/representativeinfo.js.map +1 -1
  273. package/models/components/risk.d.ts +8 -7
  274. package/models/components/risk.d.ts.map +1 -1
  275. package/models/components/risk.js +5 -6
  276. package/models/components/risk.js.map +1 -1
  277. package/models/components/rootstore.d.ts +3 -3
  278. package/models/components/rootstore.d.ts.map +1 -1
  279. package/models/components/rootstore.js +2 -1
  280. package/models/components/rootstore.js.map +1 -1
  281. package/models/components/routerosapi.d.ts +12 -0
  282. package/models/components/routerosapi.d.ts.map +1 -0
  283. package/models/components/routerosapi.js +58 -0
  284. package/models/components/routerosapi.js.map +1 -0
  285. package/models/components/rustdeskheartbeat.d.ts +12 -0
  286. package/models/components/rustdeskheartbeat.d.ts.map +1 -0
  287. package/models/components/rustdeskheartbeat.js +59 -0
  288. package/models/components/rustdeskheartbeat.js.map +1 -0
  289. package/models/components/rustdeskheartbeatregisterpeerresponse.d.ts +10 -0
  290. package/models/components/rustdeskheartbeatregisterpeerresponse.d.ts.map +1 -0
  291. package/models/components/rustdeskheartbeatregisterpeerresponse.js +55 -0
  292. package/models/components/rustdeskheartbeatregisterpeerresponse.js.map +1 -0
  293. package/models/components/rustdeskrelay.d.ts +10 -0
  294. package/models/components/rustdeskrelay.d.ts.map +1 -0
  295. package/models/components/rustdeskrelay.js +55 -0
  296. package/models/components/rustdeskrelay.js.map +1 -0
  297. package/models/components/rustdeskrendezvous.d.ts +14 -0
  298. package/models/components/rustdeskrendezvous.d.ts.map +1 -0
  299. package/models/components/rustdeskrendezvous.js +61 -0
  300. package/models/components/rustdeskrendezvous.js.map +1 -0
  301. package/models/components/rustdeskrendezvousconfigupdate.d.ts +11 -0
  302. package/models/components/rustdeskrendezvousconfigupdate.d.ts.map +1 -0
  303. package/models/components/rustdeskrendezvousconfigupdate.js +56 -0
  304. package/models/components/rustdeskrendezvousconfigupdate.js.map +1 -0
  305. package/models/components/rustdeskrendezvouskeyexchange.d.ts +10 -0
  306. package/models/components/rustdeskrendezvouskeyexchange.d.ts.map +1 -0
  307. package/models/components/rustdeskrendezvouskeyexchange.js +50 -0
  308. package/models/components/rustdeskrendezvouskeyexchange.js.map +1 -0
  309. package/models/components/rustdeskrendezvoustestnatresponse.d.ts +12 -0
  310. package/models/components/rustdeskrendezvoustestnatresponse.d.ts.map +1 -0
  311. package/models/components/rustdeskrendezvoustestnatresponse.js +57 -0
  312. package/models/components/rustdeskrendezvoustestnatresponse.js.map +1 -0
  313. package/models/components/screenshot.d.ts +1 -0
  314. package/models/components/screenshot.d.ts.map +1 -1
  315. package/models/components/screenshot.js +1 -0
  316. package/models/components/screenshot.js.map +1 -1
  317. package/models/components/searchconvertqueryresponse.d.ts +3 -3
  318. package/models/components/searchconvertqueryresponse.d.ts.map +1 -1
  319. package/models/components/searchconvertqueryresponse.js +2 -1
  320. package/models/components/searchconvertqueryresponse.js.map +1 -1
  321. package/models/components/searchqueryinputbody.d.ts +1 -1
  322. package/models/components/service.d.ts +23 -3
  323. package/models/components/service.d.ts.map +1 -1
  324. package/models/components/service.js +27 -1
  325. package/models/components/service.js.map +1 -1
  326. package/models/components/serviceid.d.ts +3 -3
  327. package/models/components/serviceid.d.ts.map +1 -1
  328. package/models/components/serviceid.js +2 -1
  329. package/models/components/serviceid.js.map +1 -1
  330. package/models/components/servicescan.d.ts +23 -3
  331. package/models/components/servicescan.d.ts.map +1 -1
  332. package/models/components/servicescan.js +27 -1
  333. package/models/components/servicescan.js.map +1 -1
  334. package/models/components/sourceusagebreakdown.d.ts +9 -1
  335. package/models/components/sourceusagebreakdown.d.ts.map +1 -1
  336. package/models/components/sourceusagebreakdown.js +7 -0
  337. package/models/components/sourceusagebreakdown.js.map +1 -1
  338. package/models/components/threat.d.ts +4 -3
  339. package/models/components/threat.d.ts.map +1 -1
  340. package/models/components/threat.js +3 -1
  341. package/models/components/threat.js.map +1 -1
  342. package/models/components/tls.d.ts +3 -3
  343. package/models/components/tls.d.ts.map +1 -1
  344. package/models/components/tls.js +2 -1
  345. package/models/components/tls.js.map +1 -1
  346. package/models/components/tlsversiondata.d.ts +3 -3
  347. package/models/components/tlsversiondata.d.ts.map +1 -1
  348. package/models/components/tlsversiondata.js +2 -2
  349. package/models/components/tlsversiondata.js.map +1 -1
  350. package/models/components/trackedscantask.d.ts +3 -3
  351. package/models/components/trackedscantask.d.ts.map +1 -1
  352. package/models/components/trackedscantask.js +2 -1
  353. package/models/components/trackedscantask.js.map +1 -1
  354. package/models/components/vuln.d.ts +8 -7
  355. package/models/components/vuln.d.ts.map +1 -1
  356. package/models/components/vuln.js +5 -4
  357. package/models/components/vuln.js.map +1 -1
  358. package/models/operations/index.d.ts +1 -0
  359. package/models/operations/index.d.ts.map +1 -1
  360. package/models/operations/index.js +1 -0
  361. package/models/operations/index.js.map +1 -1
  362. package/models/operations/v3accountmanagementmembercreditsusage.d.ts +33 -3
  363. package/models/operations/v3accountmanagementmembercreditsusage.d.ts.map +1 -1
  364. package/models/operations/v3accountmanagementmembercreditsusage.js +17 -2
  365. package/models/operations/v3accountmanagementmembercreditsusage.js.map +1 -1
  366. package/models/operations/v3accountmanagementorgcreditsusage.d.ts +38 -3
  367. package/models/operations/v3accountmanagementorgcreditsusage.d.ts.map +1 -1
  368. package/models/operations/v3accountmanagementorgcreditsusage.js +20 -2
  369. package/models/operations/v3accountmanagementorgcreditsusage.js.map +1 -1
  370. package/models/operations/v3accountmanagementusercreditsusage.d.ts +57 -0
  371. package/models/operations/v3accountmanagementusercreditsusage.d.ts.map +1 -0
  372. package/models/operations/v3accountmanagementusercreditsusage.js +85 -0
  373. package/models/operations/v3accountmanagementusercreditsusage.js.map +1 -0
  374. package/package.json +3 -3
  375. package/sdk/accountmanagement.d.ts +13 -6
  376. package/sdk/accountmanagement.d.ts.map +1 -1
  377. package/sdk/accountmanagement.js +16 -6
  378. package/sdk/accountmanagement.js.map +1 -1
  379. package/sdk/collections.d.ts +6 -6
  380. package/sdk/collections.js +6 -6
  381. package/sdk/threathunting.d.ts +1 -1
  382. package/sdk/threathunting.js +1 -1
  383. package/src/funcs/accountManagementGetMemberCreditUsage.ts +9 -3
  384. package/src/funcs/accountManagementGetOrganizationCreditUsage.ts +9 -2
  385. package/src/funcs/accountManagementGetOrganizationCredits.ts +5 -2
  386. package/src/funcs/accountManagementGetOrganizationDetails.ts +4 -1
  387. package/src/funcs/accountManagementGetUserCredits.ts +6 -3
  388. package/src/funcs/accountManagementGetUserCreditsUsage.ts +193 -0
  389. package/src/funcs/accountManagementInviteUserToOrganization.ts +5 -2
  390. package/src/funcs/accountManagementListOrganizationMembers.ts +5 -2
  391. package/src/funcs/accountManagementRemoveOrganizationMember.ts +4 -1
  392. package/src/funcs/accountManagementUpdateOrganizationMember.ts +5 -2
  393. package/src/funcs/collectionsAggregate.ts +5 -2
  394. package/src/funcs/collectionsCreate.ts +6 -3
  395. package/src/funcs/collectionsDelete.ts +6 -3
  396. package/src/funcs/collectionsGet.ts +6 -3
  397. package/src/funcs/collectionsList.ts +6 -3
  398. package/src/funcs/collectionsListEvents.ts +6 -3
  399. package/src/funcs/collectionsSearch.ts +5 -2
  400. package/src/funcs/collectionsUpdate.ts +6 -3
  401. package/src/funcs/globalDataAggregate.ts +5 -2
  402. package/src/funcs/globalDataConvertLegacySearchQueries.ts +2 -2
  403. package/src/funcs/globalDataCreateTrackedScan.ts +5 -2
  404. package/src/funcs/globalDataGetCertificate.ts +5 -2
  405. package/src/funcs/globalDataGetCertificateRaw.ts +5 -2
  406. package/src/funcs/globalDataGetCertificates.ts +5 -2
  407. package/src/funcs/globalDataGetCertificatesRaw.ts +5 -2
  408. package/src/funcs/globalDataGetHost.ts +5 -2
  409. package/src/funcs/globalDataGetHostTimeline.ts +5 -2
  410. package/src/funcs/globalDataGetHosts.ts +5 -2
  411. package/src/funcs/globalDataGetTrackedScan.ts +5 -2
  412. package/src/funcs/globalDataGetWebProperties.ts +5 -2
  413. package/src/funcs/globalDataGetWebProperty.ts +5 -2
  414. package/src/funcs/globalDataSearch.ts +5 -2
  415. package/src/funcs/threatHuntingCreateTrackedScan.ts +5 -2
  416. package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +5 -2
  417. package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +5 -2
  418. package/src/funcs/threatHuntingListThreats.ts +6 -3
  419. package/src/funcs/threatHuntingValueCounts.ts +5 -2
  420. package/src/lib/config.ts +4 -4
  421. package/src/lib/sdks.ts +2 -2
  422. package/src/models/components/alternativequery.ts +5 -4
  423. package/src/models/components/attribute.ts +6 -4
  424. package/src/models/components/certificate.ts +14 -8
  425. package/src/models/components/certificaterevocationrevocationinfo.ts +5 -4
  426. package/src/models/components/collection.ts +20 -8
  427. package/src/models/components/creditexpiration.ts +6 -0
  428. package/src/models/components/creditusagereport.ts +70 -11
  429. package/src/models/components/creditusagereportperiod.ts +69 -0
  430. package/src/models/components/cvsscomponents.ts +47 -30
  431. package/src/models/components/cvssv4components.ts +83 -53
  432. package/src/models/components/dns.ts +11 -8
  433. package/src/models/components/dnsresourcerecord.ts +8 -5
  434. package/src/models/components/endpointscan.ts +8 -5
  435. package/src/models/components/endpointscanstate.ts +14 -5
  436. package/src/models/components/eventassetchange.ts +8 -4
  437. package/src/models/components/eventstatuschange.ts +14 -7
  438. package/src/models/components/extractedendpointdata.ts +62 -0
  439. package/src/models/components/extractedendpointdataanalyticsservice.ts +34 -0
  440. package/src/models/components/extractedendpointdatacopyright.ts +43 -0
  441. package/src/models/components/flashsocketpolicy.ts +47 -0
  442. package/src/models/components/flashsocketpolicyallowaccessfrom.ts +40 -0
  443. package/src/models/components/gemini.ts +40 -0
  444. package/src/models/components/greynoise.ts +45 -0
  445. package/src/models/components/greynoisetag.ts +34 -0
  446. package/src/models/components/hajime.ts +33 -0
  447. package/src/models/components/host.ts +3 -0
  448. package/src/models/components/hostdnsforwardresolution.ts +8 -4
  449. package/src/models/components/http.ts +15 -0
  450. package/src/models/components/httpredirectchainlink.ts +67 -0
  451. package/src/models/components/index.ts +26 -0
  452. package/src/models/components/jarmscan.ts +8 -5
  453. package/src/models/components/kev.ts +8 -4
  454. package/src/models/components/label.ts +9 -4
  455. package/src/models/components/matchedservice.ts +8 -5
  456. package/src/models/components/mavlink.ts +36 -0
  457. package/src/models/components/mavlinkframe.ts +49 -0
  458. package/src/models/components/melsec.ts +33 -0
  459. package/src/models/components/memberlist.ts +50 -0
  460. package/src/models/components/memberlistnodeinfo.ts +49 -0
  461. package/src/models/components/networklog.ts +49 -0
  462. package/src/models/components/networklogresourceinfo.ts +84 -0
  463. package/src/models/components/paginationinfo.ts +1 -1
  464. package/src/models/components/reject.ts +8 -4
  465. package/src/models/components/representativeinfo.ts +8 -5
  466. package/src/models/components/risk.ts +21 -10
  467. package/src/models/components/rootstore.ts +5 -5
  468. package/src/models/components/routerosapi.ts +41 -0
  469. package/src/models/components/rustdeskheartbeat.ts +44 -0
  470. package/src/models/components/rustdeskheartbeatregisterpeerresponse.ts +37 -0
  471. package/src/models/components/rustdeskrelay.ts +36 -0
  472. package/src/models/components/rustdeskrendezvous.ts +50 -0
  473. package/src/models/components/rustdeskrendezvousconfigupdate.ts +38 -0
  474. package/src/models/components/rustdeskrendezvouskeyexchange.ts +31 -0
  475. package/src/models/components/rustdeskrendezvoustestnatresponse.ts +42 -0
  476. package/src/models/components/screenshot.ts +2 -0
  477. package/src/models/components/searchconvertqueryresponse.ts +8 -5
  478. package/src/models/components/searchqueryinputbody.ts +1 -1
  479. package/src/models/components/service.ts +52 -5
  480. package/src/models/components/serviceid.ts +8 -5
  481. package/src/models/components/servicescan.ts +52 -5
  482. package/src/models/components/sourceusagebreakdown.ts +16 -1
  483. package/src/models/components/threat.ts +9 -4
  484. package/src/models/components/tls.ts +8 -5
  485. package/src/models/components/tlsversiondata.ts +5 -4
  486. package/src/models/components/trackedscantask.ts +8 -5
  487. package/src/models/components/vuln.ts +21 -11
  488. package/src/models/operations/index.ts +1 -0
  489. package/src/models/operations/v3accountmanagementmembercreditsusage.ts +43 -4
  490. package/src/models/operations/v3accountmanagementorgcreditsusage.ts +49 -4
  491. package/src/models/operations/v3accountmanagementusercreditsusage.ts +128 -0
  492. package/src/sdk/accountmanagement.ts +24 -6
  493. package/src/sdk/collections.ts +6 -6
  494. package/src/sdk/threathunting.ts +1 -1
package/README.md CHANGED
@@ -114,14 +114,15 @@ run();
114
114
  ### [AccountManagement](docs/sdks/accountmanagement/README.md)
115
115
 
116
116
  * [getOrganizationDetails](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
117
- * [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit details
117
+ * [getOrganizationCredits](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
118
118
  * [getOrganizationCreditUsage](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
119
119
  * [inviteUserToOrganization](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
120
120
  * [listOrganizationMembers](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
121
121
  * [removeOrganizationMember](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
122
122
  * [updateOrganizationMember](docs/sdks/accountmanagement/README.md#updateorganizationmember) - Update a member's roles in an organization
123
- * [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
124
- * [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit details
123
+ * [getMemberCreditUsage](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
124
+ * [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
125
+ * [getUserCreditsUsage](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
125
126
 
126
127
  ### [Collections](docs/sdks/collections/README.md)
127
128
 
@@ -177,11 +178,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
177
178
 
178
179
  <summary>Available standalone functions</summary>
179
180
 
180
- - [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
181
- - [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit details
181
+ - [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get organization member credit usage
182
+ - [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit balance
182
183
  - [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
183
184
  - [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization details
184
- - [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit details
185
+ - [`accountManagementGetUserCredits`](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
186
+ - [`accountManagementGetUserCreditsUsage`](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
185
187
  - [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
186
188
  - [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
187
189
  - [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
@@ -437,19 +439,23 @@ The `HTTPClient` constructor takes an optional `fetcher` argument that can be
437
439
  used to integrate a third-party HTTP client or when writing tests to mock out
438
440
  the HTTP client and feed in fixtures.
439
441
 
440
- The following example shows how to use the `"beforeRequest"` hook to to add a
441
- custom header and a timeout to requests and how to use the `"requestError"` hook
442
- to log errors:
442
+ The following example shows how to:
443
+ - route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
444
+ - use the `"beforeRequest"` hook to add a custom header and a timeout to requests
445
+ - use the `"requestError"` hook to log errors
443
446
 
444
447
  ```typescript
445
448
  import { SDK } from "@censys/platform-sdk";
449
+ import { ProxyAgent } from "undici";
446
450
  import { HTTPClient } from "@censys/platform-sdk/lib/http";
447
451
 
452
+ const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
453
+
448
454
  const httpClient = new HTTPClient({
449
- // fetcher takes a function that has the same signature as native `fetch`.
450
- fetcher: (request) => {
451
- return fetch(request);
452
- }
455
+ // 'fetcher' takes a function that has the same signature as native 'fetch'.
456
+ fetcher: (input, init) =>
457
+ // 'dispatcher' is specific to undici and not part of the standard Fetch API.
458
+ fetch(input, { ...init, dispatcher } as RequestInit),
453
459
  });
454
460
 
455
461
  httpClient.addHook("beforeRequest", (request) => {
@@ -7,14 +7,15 @@ Endpoints related to the Account Management product
7
7
  ### Available Operations
8
8
 
9
9
  * [getOrganizationDetails](#getorganizationdetails) - Get organization details
10
- * [getOrganizationCredits](#getorganizationcredits) - Get organization credit details
10
+ * [getOrganizationCredits](#getorganizationcredits) - Get organization credit balance
11
11
  * [getOrganizationCreditUsage](#getorganizationcreditusage) - Get organization credit usage
12
12
  * [inviteUserToOrganization](#inviteusertoorganization) - Invite user to organization
13
13
  * [listOrganizationMembers](#listorganizationmembers) - List organization members
14
14
  * [removeOrganizationMember](#removeorganizationmember) - Remove member from organization
15
15
  * [updateOrganizationMember](#updateorganizationmember) - Update a member's roles in an organization
16
- * [getMemberCreditUsage](#getmembercreditusage) - Get member credit usage
17
- * [getUserCredits](#getusercredits) - Get Free user credit details
16
+ * [getMemberCreditUsage](#getmembercreditusage) - Get organization member credit usage
17
+ * [getUserCredits](#getusercredits) - Get Free user credit balance
18
+ * [getUserCreditsUsage](#getusercreditsusage) - Get Free user credit usage
18
19
 
19
20
  ## getOrganizationDetails
20
21
 
@@ -89,6 +90,7 @@ run();
89
90
  | -------------------------- | -------------------------- | -------------------------- |
90
91
  | errors.AuthenticationError | 401 | application/json |
91
92
  | errors.ErrorModel | 403, 404, 422 | application/problem+json |
93
+ | errors.ErrorModel | 500 | application/problem+json |
92
94
  | errors.SDKError | 4XX, 5XX | \*/\* |
93
95
 
94
96
  ## getOrganizationCredits
@@ -164,17 +166,19 @@ run();
164
166
  | -------------------------- | -------------------------- | -------------------------- |
165
167
  | errors.AuthenticationError | 401 | application/json |
166
168
  | errors.ErrorModel | 403, 404, 422 | application/problem+json |
169
+ | errors.ErrorModel | 500 | application/problem+json |
167
170
  | errors.SDKError | 4XX, 5XX | \*/\* |
168
171
 
169
172
  ## getOrganizationCreditUsage
170
173
 
171
- Retrieve credit consumption information for an organization for a specific day.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
174
+ Retrieve credit information for an organization over a specific date range. You must include a start date in your request.<br><br>Admins can obtain credit usage information for all users in their organization. Members may only retrieve usage information for their own account.<br><br>This endpoint does not cost any credits to execute.
172
175
 
173
176
  ### Example Usage
174
177
 
175
178
  <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-org-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/credits/usage" -->
176
179
  ```typescript
177
180
  import { SDK } from "@censys/platform-sdk";
181
+ import { RFCDate } from "@censys/platform-sdk/types";
178
182
 
179
183
  const sdk = new SDK({
180
184
  personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
@@ -184,6 +188,8 @@ async function run() {
184
188
  const result = await sdk.accountManagement.getOrganizationCreditUsage({
185
189
  organizationId: "11111111-2222-3333-4444-555555555555",
186
190
  date: "2025-11-01",
191
+ startDate: new RFCDate("2025-11-01"),
192
+ endDate: new RFCDate("2025-12-01"),
187
193
  });
188
194
 
189
195
  console.log(result);
@@ -199,6 +205,7 @@ The standalone function version of this method:
199
205
  ```typescript
200
206
  import { SDKCore } from "@censys/platform-sdk/core.js";
201
207
  import { accountManagementGetOrganizationCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetOrganizationCreditUsage.js";
208
+ import { RFCDate } from "@censys/platform-sdk/types";
202
209
 
203
210
  // Use `SDKCore` for best tree-shaking performance.
204
211
  // You can create one instance of it to use across an application.
@@ -210,6 +217,8 @@ async function run() {
210
217
  const res = await accountManagementGetOrganizationCreditUsage(sdk, {
211
218
  organizationId: "11111111-2222-3333-4444-555555555555",
212
219
  date: "2025-11-01",
220
+ startDate: new RFCDate("2025-11-01"),
221
+ endDate: new RFCDate("2025-12-01"),
213
222
  });
214
223
  if (res.ok) {
215
224
  const { value: result } = res;
@@ -241,6 +250,7 @@ run();
241
250
  | -------------------------- | -------------------------- | -------------------------- |
242
251
  | errors.AuthenticationError | 401 | application/json |
243
252
  | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
253
+ | errors.ErrorModel | 500 | application/problem+json |
244
254
  | errors.SDKError | 4XX, 5XX | \*/\* |
245
255
 
246
256
  ## inviteUserToOrganization
@@ -321,7 +331,8 @@ run();
321
331
  | Error Type | Status Code | Content Type |
322
332
  | -------------------------- | -------------------------- | -------------------------- |
323
333
  | errors.AuthenticationError | 401 | application/json |
324
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
334
+ | errors.ErrorModel | 403, 404, 409, 422 | application/problem+json |
335
+ | errors.ErrorModel | 500 | application/problem+json |
325
336
  | errors.SDKError | 4XX, 5XX | \*/\* |
326
337
 
327
338
  ## listOrganizationMembers
@@ -396,7 +407,8 @@ run();
396
407
  | Error Type | Status Code | Content Type |
397
408
  | -------------------------- | -------------------------- | -------------------------- |
398
409
  | errors.AuthenticationError | 401 | application/json |
399
- | errors.ErrorModel | 403, 404 | application/problem+json |
410
+ | errors.ErrorModel | 403, 404, 422 | application/problem+json |
411
+ | errors.ErrorModel | 500 | application/problem+json |
400
412
  | errors.SDKError | 4XX, 5XX | \*/\* |
401
413
 
402
414
  ## removeOrganizationMember
@@ -474,6 +486,7 @@ run();
474
486
  | -------------------------- | -------------------------- | -------------------------- |
475
487
  | errors.AuthenticationError | 401 | application/json |
476
488
  | errors.ErrorModel | 403, 404, 409, 422 | application/problem+json |
489
+ | errors.ErrorModel | 500 | application/problem+json |
477
490
  | errors.SDKError | 4XX, 5XX | \*/\* |
478
491
 
479
492
  ## updateOrganizationMember
@@ -556,18 +569,20 @@ run();
556
569
  | Error Type | Status Code | Content Type |
557
570
  | -------------------------- | -------------------------- | -------------------------- |
558
571
  | errors.AuthenticationError | 401 | application/json |
559
- | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
572
+ | errors.ErrorModel | 400, 403, 404, 409, 422 | application/problem+json |
573
+ | errors.ErrorModel | 500 | application/problem+json |
560
574
  | errors.SDKError | 4XX, 5XX | \*/\* |
561
575
 
562
576
  ## getMemberCreditUsage
563
577
 
564
- Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
578
+ Retrieve credit consumption information for an organization member over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
565
579
 
566
580
  ### Example Usage
567
581
 
568
582
  <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-member-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage" -->
569
583
  ```typescript
570
584
  import { SDK } from "@censys/platform-sdk";
585
+ import { RFCDate } from "@censys/platform-sdk/types";
571
586
 
572
587
  const sdk = new SDK({
573
588
  personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
@@ -578,6 +593,8 @@ async function run() {
578
593
  organizationId: "11111111-2222-3333-4444-555555555555",
579
594
  userId: "11111111-2222-3333-4444-555555555555",
580
595
  date: "2025-11-01",
596
+ startDate: new RFCDate("2025-11-01"),
597
+ endDate: new RFCDate("2025-12-01"),
581
598
  });
582
599
 
583
600
  console.log(result);
@@ -593,6 +610,7 @@ The standalone function version of this method:
593
610
  ```typescript
594
611
  import { SDKCore } from "@censys/platform-sdk/core.js";
595
612
  import { accountManagementGetMemberCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetMemberCreditUsage.js";
613
+ import { RFCDate } from "@censys/platform-sdk/types";
596
614
 
597
615
  // Use `SDKCore` for best tree-shaking performance.
598
616
  // You can create one instance of it to use across an application.
@@ -605,6 +623,8 @@ async function run() {
605
623
  organizationId: "11111111-2222-3333-4444-555555555555",
606
624
  userId: "11111111-2222-3333-4444-555555555555",
607
625
  date: "2025-11-01",
626
+ startDate: new RFCDate("2025-11-01"),
627
+ endDate: new RFCDate("2025-12-01"),
608
628
  });
609
629
  if (res.ok) {
610
630
  const { value: result } = res;
@@ -636,11 +656,12 @@ run();
636
656
  | -------------------------- | -------------------------- | -------------------------- |
637
657
  | errors.AuthenticationError | 401 | application/json |
638
658
  | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
659
+ | errors.ErrorModel | 500 | application/problem+json |
639
660
  | errors.SDKError | 4XX, 5XX | \*/\* |
640
661
 
641
662
  ## getUserCredits
642
663
 
643
- Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit details endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
664
+ Retrieve your Free user account credit balance and refresh information. To retrieve the credit balance for a Starter or Enterprise account, use the [get organization credit balance endpoint](https://docs.censys.com/reference/v3-accountmanagement-org-credits).<br><br>This endpoint does not cost any credits to execute.
644
665
 
645
666
  ### Example Usage
646
667
 
@@ -706,4 +727,87 @@ run();
706
727
  | -------------------------- | -------------------------- | -------------------------- |
707
728
  | errors.AuthenticationError | 401 | application/json |
708
729
  | errors.ErrorModel | 404 | application/problem+json |
730
+ | errors.ErrorModel | 500 | application/problem+json |
731
+ | errors.SDKError | 4XX, 5XX | \*/\* |
732
+
733
+ ## getUserCreditsUsage
734
+
735
+ Retrieve your Free user account credit consumption information over a specific date range. You must include a start date in your request.<br><br>This endpoint does not cost any credits to execute.
736
+
737
+ ### Example Usage
738
+
739
+ <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-user-credits-usage" method="get" path="/v3/accounts/users/credits/usage" -->
740
+ ```typescript
741
+ import { SDK } from "@censys/platform-sdk";
742
+ import { RFCDate } from "@censys/platform-sdk/types";
743
+
744
+ const sdk = new SDK({
745
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
746
+ });
747
+
748
+ async function run() {
749
+ const result = await sdk.accountManagement.getUserCreditsUsage({
750
+ date: "2025-11-01",
751
+ startDate: new RFCDate("2025-11-01"),
752
+ endDate: new RFCDate("2025-12-01"),
753
+ });
754
+
755
+ console.log(result);
756
+ }
757
+
758
+ run();
759
+ ```
760
+
761
+ ### Standalone function
762
+
763
+ The standalone function version of this method:
764
+
765
+ ```typescript
766
+ import { SDKCore } from "@censys/platform-sdk/core.js";
767
+ import { accountManagementGetUserCreditsUsage } from "@censys/platform-sdk/funcs/accountManagementGetUserCreditsUsage.js";
768
+ import { RFCDate } from "@censys/platform-sdk/types";
769
+
770
+ // Use `SDKCore` for best tree-shaking performance.
771
+ // You can create one instance of it to use across an application.
772
+ const sdk = new SDKCore({
773
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
774
+ });
775
+
776
+ async function run() {
777
+ const res = await accountManagementGetUserCreditsUsage(sdk, {
778
+ date: "2025-11-01",
779
+ startDate: new RFCDate("2025-11-01"),
780
+ endDate: new RFCDate("2025-12-01"),
781
+ });
782
+ if (res.ok) {
783
+ const { value: result } = res;
784
+ console.log(result);
785
+ } else {
786
+ console.log("accountManagementGetUserCreditsUsage failed:", res.error);
787
+ }
788
+ }
789
+
790
+ run();
791
+ ```
792
+
793
+ ### Parameters
794
+
795
+ | Parameter | Type | Required | Description |
796
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
797
+ | `request` | [operations.V3AccountmanagementUserCreditsUsageRequest](../../models/operations/v3accountmanagementusercreditsusagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
798
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
799
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
800
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
801
+
802
+ ### Response
803
+
804
+ **Promise\<[operations.V3AccountmanagementUserCreditsUsageResponse](../../models/operations/v3accountmanagementusercreditsusageresponse.md)\>**
805
+
806
+ ### Errors
807
+
808
+ | Error Type | Status Code | Content Type |
809
+ | -------------------------- | -------------------------- | -------------------------- |
810
+ | errors.AuthenticationError | 401 | application/json |
811
+ | errors.ErrorModel | 400, 404 | application/problem+json |
812
+ | errors.ErrorModel | 500 | application/problem+json |
709
813
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -17,7 +17,7 @@ Endpoints related to the Collections product
17
17
 
18
18
  ## list
19
19
 
20
- List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
20
+ List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
21
21
 
22
22
  ### Example Usage
23
23
 
@@ -91,12 +91,13 @@ run();
91
91
  | Error Type | Status Code | Content Type |
92
92
  | -------------------------- | -------------------------- | -------------------------- |
93
93
  | errors.AuthenticationError | 401 | application/json |
94
- | errors.ErrorModel | 403 | application/problem+json |
94
+ | errors.ErrorModel | 400, 403 | application/problem+json |
95
+ | errors.ErrorModel | 500 | application/problem+json |
95
96
  | errors.SDKError | 4XX, 5XX | \*/\* |
96
97
 
97
98
  ## create
98
99
 
99
- Create a new collection.
100
+ Create a new collection.<br><br>This endpoint does not cost credits to execute.
100
101
 
101
102
  ### Example Usage
102
103
 
@@ -176,12 +177,13 @@ run();
176
177
  | Error Type | Status Code | Content Type |
177
178
  | -------------------------- | -------------------------- | -------------------------- |
178
179
  | errors.AuthenticationError | 401 | application/json |
179
- | errors.ErrorModel | 403 | application/problem+json |
180
+ | errors.ErrorModel | 400, 403, 409, 412, 422 | application/problem+json |
181
+ | errors.ErrorModel | 500 | application/problem+json |
180
182
  | errors.SDKError | 4XX, 5XX | \*/\* |
181
183
 
182
184
  ## delete
183
185
 
184
- Delete a collection.
186
+ Delete a collection.<br><br>This endpoint does not cost credits to execute.
185
187
 
186
188
  ### Example Usage
187
189
 
@@ -253,12 +255,13 @@ run();
253
255
  | Error Type | Status Code | Content Type |
254
256
  | -------------------------- | -------------------------- | -------------------------- |
255
257
  | errors.AuthenticationError | 401 | application/json |
256
- | errors.ErrorModel | 403, 404 | application/problem+json |
258
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
259
+ | errors.ErrorModel | 500 | application/problem+json |
257
260
  | errors.SDKError | 4XX, 5XX | \*/\* |
258
261
 
259
262
  ## get
260
263
 
261
- Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
264
+ Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.<br><br>This endpoint does not cost credits to execute.
262
265
 
263
266
  ### Example Usage
264
267
 
@@ -330,12 +333,13 @@ run();
330
333
  | Error Type | Status Code | Content Type |
331
334
  | -------------------------- | -------------------------- | -------------------------- |
332
335
  | errors.AuthenticationError | 401 | application/json |
333
- | errors.ErrorModel | 403, 404 | application/problem+json |
336
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
337
+ | errors.ErrorModel | 500 | application/problem+json |
334
338
  | errors.SDKError | 4XX, 5XX | \*/\* |
335
339
 
336
340
  ## update
337
341
 
338
- Update a collection's name, description, and/or query.
342
+ Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
339
343
 
340
344
  ### Example Usage
341
345
 
@@ -417,12 +421,13 @@ run();
417
421
  | Error Type | Status Code | Content Type |
418
422
  | -------------------------- | -------------------------- | -------------------------- |
419
423
  | errors.AuthenticationError | 401 | application/json |
420
- | errors.ErrorModel | 403, 404 | application/problem+json |
424
+ | errors.ErrorModel | 400, 403, 404, 412 | application/problem+json |
425
+ | errors.ErrorModel | 500 | application/problem+json |
421
426
  | errors.SDKError | 4XX, 5XX | \*/\* |
422
427
 
423
428
  ## listEvents
424
429
 
425
- Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
430
+ Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.<br><br>This endpoint does not cost credits to execute.
426
431
 
427
432
  ### Example Usage
428
433
 
@@ -502,7 +507,8 @@ run();
502
507
  | Error Type | Status Code | Content Type |
503
508
  | -------------------------- | -------------------------- | -------------------------- |
504
509
  | errors.AuthenticationError | 401 | application/json |
505
- | errors.ErrorModel | 403, 404 | application/problem+json |
510
+ | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
511
+ | errors.ErrorModel | 500 | application/problem+json |
506
512
  | errors.SDKError | 4XX, 5XX | \*/\* |
507
513
 
508
514
  ## aggregate
@@ -589,7 +595,8 @@ run();
589
595
  | Error Type | Status Code | Content Type |
590
596
  | -------------------------- | -------------------------- | -------------------------- |
591
597
  | errors.AuthenticationError | 401 | application/json |
592
- | errors.ErrorModel | 403, 404, 422 | application/problem+json |
598
+ | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
599
+ | errors.ErrorModel | 500 | application/problem+json |
593
600
  | errors.SDKError | 4XX, 5XX | \*/\* |
594
601
 
595
602
  ## search
@@ -680,5 +687,6 @@ run();
680
687
  | Error Type | Status Code | Content Type |
681
688
  | -------------------------- | -------------------------- | -------------------------- |
682
689
  | errors.AuthenticationError | 401 | application/json |
683
- | errors.ErrorModel | 403, 404 | application/problem+json |
690
+ | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
691
+ | errors.ErrorModel | 500 | application/problem+json |
684
692
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -103,7 +103,8 @@ run();
103
103
  | Error Type | Status Code | Content Type |
104
104
  | -------------------------- | -------------------------- | -------------------------- |
105
105
  | errors.AuthenticationError | 401 | application/json |
106
- | errors.ErrorModel | 403, 404 | application/problem+json |
106
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
107
+ | errors.ErrorModel | 500 | application/problem+json |
107
108
  | errors.SDKError | 4XX, 5XX | \*/\* |
108
109
 
109
110
  ## getCertificatesRaw
@@ -188,7 +189,8 @@ run();
188
189
  | Error Type | Status Code | Content Type |
189
190
  | -------------------------- | -------------------------- | -------------------------- |
190
191
  | errors.AuthenticationError | 401 | application/json |
191
- | errors.ErrorModel | 403, 404 | application/problem+json |
192
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
193
+ | errors.ErrorModel | 500 | application/problem+json |
192
194
  | errors.SDKError | 4XX, 5XX | \*/\* |
193
195
 
194
196
  ## getCertificate
@@ -265,7 +267,8 @@ run();
265
267
  | Error Type | Status Code | Content Type |
266
268
  | -------------------------- | -------------------------- | -------------------------- |
267
269
  | errors.AuthenticationError | 401 | application/json |
268
- | errors.ErrorModel | 403, 404 | application/problem+json |
270
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
271
+ | errors.ErrorModel | 500 | application/problem+json |
269
272
  | errors.SDKError | 4XX, 5XX | \*/\* |
270
273
 
271
274
  ## getCertificateRaw
@@ -342,7 +345,8 @@ run();
342
345
  | Error Type | Status Code | Content Type |
343
346
  | -------------------------- | -------------------------- | -------------------------- |
344
347
  | errors.AuthenticationError | 401 | application/json |
345
- | errors.ErrorModel | 403, 404 | application/problem+json |
348
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
349
+ | errors.ErrorModel | 500 | application/problem+json |
346
350
  | errors.SDKError | 4XX, 5XX | \*/\* |
347
351
 
348
352
  ## getHosts
@@ -429,7 +433,8 @@ run();
429
433
  | Error Type | Status Code | Content Type |
430
434
  | -------------------------- | -------------------------- | -------------------------- |
431
435
  | errors.AuthenticationError | 401 | application/json |
432
- | errors.ErrorModel | 403 | application/problem+json |
436
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
437
+ | errors.ErrorModel | 500 | application/problem+json |
433
438
  | errors.SDKError | 4XX, 5XX | \*/\* |
434
439
 
435
440
  ## getHost
@@ -508,7 +513,8 @@ run();
508
513
  | Error Type | Status Code | Content Type |
509
514
  | -------------------------- | -------------------------- | -------------------------- |
510
515
  | errors.AuthenticationError | 401 | application/json |
511
- | errors.ErrorModel | 403, 404 | application/problem+json |
516
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
517
+ | errors.ErrorModel | 500 | application/problem+json |
512
518
  | errors.SDKError | 4XX, 5XX | \*/\* |
513
519
 
514
520
  ## getHostTimeline
@@ -589,7 +595,8 @@ run();
589
595
  | Error Type | Status Code | Content Type |
590
596
  | -------------------------- | -------------------------- | -------------------------- |
591
597
  | errors.AuthenticationError | 401 | application/json |
592
- | errors.ErrorModel | 403 | application/problem+json |
598
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
599
+ | errors.ErrorModel | 500 | application/problem+json |
593
600
  | errors.SDKError | 4XX, 5XX | \*/\* |
594
601
 
595
602
  ## getWebProperties
@@ -676,7 +683,8 @@ run();
676
683
  | Error Type | Status Code | Content Type |
677
684
  | -------------------------- | -------------------------- | -------------------------- |
678
685
  | errors.AuthenticationError | 401 | application/json |
679
- | errors.ErrorModel | 403 | application/problem+json |
686
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
687
+ | errors.ErrorModel | 500 | application/problem+json |
680
688
  | errors.SDKError | 4XX, 5XX | \*/\* |
681
689
 
682
690
  ## getWebProperty
@@ -755,7 +763,8 @@ run();
755
763
  | Error Type | Status Code | Content Type |
756
764
  | -------------------------- | -------------------------- | -------------------------- |
757
765
  | errors.AuthenticationError | 401 | application/json |
758
- | errors.ErrorModel | 403, 422 | application/problem+json |
766
+ | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
767
+ | errors.ErrorModel | 500 | application/problem+json |
759
768
  | errors.SDKError | 4XX, 5XX | \*/\* |
760
769
 
761
770
  ## createTrackedScan
@@ -846,7 +855,8 @@ run();
846
855
  | Error Type | Status Code | Content Type |
847
856
  | -------------------------- | -------------------------- | -------------------------- |
848
857
  | errors.AuthenticationError | 401 | application/json |
849
- | errors.ErrorModel | 403 | application/problem+json |
858
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
859
+ | errors.ErrorModel | 500 | application/problem+json |
850
860
  | errors.SDKError | 4XX, 5XX | \*/\* |
851
861
 
852
862
  ## getTrackedScan
@@ -923,7 +933,8 @@ run();
923
933
  | Error Type | Status Code | Content Type |
924
934
  | -------------------------- | -------------------------- | -------------------------- |
925
935
  | errors.AuthenticationError | 401 | application/json |
926
- | errors.ErrorModel | 403, 404 | application/problem+json |
936
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
937
+ | errors.ErrorModel | 500 | application/problem+json |
927
938
  | errors.SDKError | 4XX, 5XX | \*/\* |
928
939
 
929
940
  ## aggregate
@@ -1008,7 +1019,8 @@ run();
1008
1019
  | Error Type | Status Code | Content Type |
1009
1020
  | -------------------------- | -------------------------- | -------------------------- |
1010
1021
  | errors.AuthenticationError | 401 | application/json |
1011
- | errors.ErrorModel | 403, 422 | application/problem+json |
1022
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
1023
+ | errors.ErrorModel | 500 | application/problem+json |
1012
1024
  | errors.SDKError | 4XX, 5XX | \*/\* |
1013
1025
 
1014
1026
  ## convertLegacySearchQueries
@@ -1097,7 +1109,7 @@ run();
1097
1109
  | Error Type | Status Code | Content Type |
1098
1110
  | -------------------------- | -------------------------- | -------------------------- |
1099
1111
  | errors.AuthenticationError | 401 | application/json |
1100
- | errors.ErrorModel | 403 | application/problem+json |
1112
+ | errors.ErrorModel | 400, 403 | application/problem+json |
1101
1113
  | errors.ErrorModel | 500 | application/problem+json |
1102
1114
  | errors.SDKError | 4XX, 5XX | \*/\* |
1103
1115
 
@@ -1187,5 +1199,6 @@ run();
1187
1199
  | Error Type | Status Code | Content Type |
1188
1200
  | -------------------------- | -------------------------- | -------------------------- |
1189
1201
  | errors.AuthenticationError | 401 | application/json |
1190
- | errors.ErrorModel | 403 | application/problem+json |
1202
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
1203
+ | errors.ErrorModel | 500 | application/problem+json |
1191
1204
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -96,7 +96,8 @@ run();
96
96
  | Error Type | Status Code | Content Type |
97
97
  | -------------------------- | -------------------------- | -------------------------- |
98
98
  | errors.AuthenticationError | 401 | application/json |
99
- | errors.ErrorModel | 403 | application/problem+json |
99
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
100
+ | errors.ErrorModel | 500 | application/problem+json |
100
101
  | errors.SDKError | 4XX, 5XX | \*/\* |
101
102
 
102
103
  ## createTrackedScan
@@ -187,7 +188,8 @@ run();
187
188
  | Error Type | Status Code | Content Type |
188
189
  | -------------------------- | -------------------------- | -------------------------- |
189
190
  | errors.AuthenticationError | 401 | application/json |
190
- | errors.ErrorModel | 403 | application/problem+json |
191
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
192
+ | errors.ErrorModel | 500 | application/problem+json |
191
193
  | errors.SDKError | 4XX, 5XX | \*/\* |
192
194
 
193
195
  ## getTrackedScanThreatHunting
@@ -264,12 +266,13 @@ run();
264
266
  | Error Type | Status Code | Content Type |
265
267
  | -------------------------- | -------------------------- | -------------------------- |
266
268
  | errors.AuthenticationError | 401 | application/json |
267
- | errors.ErrorModel | 403, 404 | application/problem+json |
269
+ | errors.ErrorModel | 400, 403, 404 | application/problem+json |
270
+ | errors.ErrorModel | 500 | application/problem+json |
268
271
  | errors.SDKError | 4XX, 5XX | \*/\* |
269
272
 
270
273
  ## listThreats
271
274
 
272
- Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).
275
+ Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
273
276
 
274
277
  ### Example Usage
275
278
 
@@ -341,7 +344,8 @@ run();
341
344
  | Error Type | Status Code | Content Type |
342
345
  | -------------------------- | -------------------------- | -------------------------- |
343
346
  | errors.AuthenticationError | 401 | application/json |
344
- | errors.ErrorModel | 403, 422 | application/problem+json |
347
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
348
+ | errors.ErrorModel | 500 | application/problem+json |
345
349
  | errors.SDKError | 4XX, 5XX | \*/\* |
346
350
 
347
351
  ## valueCounts
@@ -446,5 +450,6 @@ run();
446
450
  | Error Type | Status Code | Content Type |
447
451
  | -------------------------- | -------------------------- | -------------------------- |
448
452
  | errors.AuthenticationError | 401 | application/json |
449
- | errors.ErrorModel | 403 | application/problem+json |
453
+ | errors.ErrorModel | 400, 403, 422 | application/problem+json |
454
+ | errors.ErrorModel | 500 | application/problem+json |
450
455
  | errors.SDKError | 4XX, 5XX | \*/\* |