@censys/platform-sdk 0.8.0 → 0.9.1

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 (383) hide show
  1. package/README.md +14 -8
  2. package/docs/sdks/accountmanagement/README.md +169 -5
  3. package/docs/sdks/collections/README.md +6 -7
  4. package/docs/sdks/globaldata/README.md +0 -1
  5. package/docs/sdks/threathunting/README.md +78 -1
  6. package/examples/package-lock.json +1 -1
  7. package/funcs/accountManagementGetMemberCreditUsage.d.ts +2 -2
  8. package/funcs/accountManagementGetMemberCreditUsage.js +5 -2
  9. package/funcs/accountManagementGetMemberCreditUsage.js.map +1 -1
  10. package/funcs/accountManagementGetOrganizationCreditUsage.d.ts +1 -1
  11. package/funcs/accountManagementGetOrganizationCreditUsage.js +5 -1
  12. package/funcs/accountManagementGetOrganizationCreditUsage.js.map +1 -1
  13. package/funcs/accountManagementGetOrganizationCredits.d.ts +1 -1
  14. package/funcs/accountManagementGetOrganizationCredits.js +1 -1
  15. package/funcs/accountManagementGetUserCredits.d.ts +18 -0
  16. package/funcs/accountManagementGetUserCredits.d.ts.map +1 -0
  17. package/funcs/accountManagementGetUserCredits.js +112 -0
  18. package/funcs/accountManagementGetUserCredits.js.map +1 -0
  19. package/funcs/accountManagementGetUserCreditsUsage.d.ts +18 -0
  20. package/funcs/accountManagementGetUserCreditsUsage.d.ts.map +1 -0
  21. package/funcs/accountManagementGetUserCreditsUsage.js +129 -0
  22. package/funcs/accountManagementGetUserCreditsUsage.js.map +1 -0
  23. package/funcs/collectionsCreate.d.ts +1 -1
  24. package/funcs/collectionsCreate.js +1 -1
  25. package/funcs/collectionsDelete.d.ts +1 -1
  26. package/funcs/collectionsDelete.js +1 -1
  27. package/funcs/collectionsGet.d.ts +1 -1
  28. package/funcs/collectionsGet.js +1 -1
  29. package/funcs/collectionsList.d.ts +1 -1
  30. package/funcs/collectionsList.js +1 -1
  31. package/funcs/collectionsListEvents.d.ts +1 -1
  32. package/funcs/collectionsListEvents.js +1 -1
  33. package/funcs/collectionsUpdate.d.ts +1 -1
  34. package/funcs/collectionsUpdate.js +1 -1
  35. package/funcs/threatHuntingListThreats.d.ts +18 -0
  36. package/funcs/threatHuntingListThreats.d.ts.map +1 -0
  37. package/funcs/threatHuntingListThreats.js +130 -0
  38. package/funcs/threatHuntingListThreats.js.map +1 -0
  39. package/jsr.json +1 -1
  40. package/lib/config.d.ts +4 -4
  41. package/lib/config.js +4 -4
  42. package/lib/encodings.d.ts +1 -0
  43. package/lib/encodings.d.ts.map +1 -1
  44. package/lib/encodings.js +12 -1
  45. package/lib/encodings.js.map +1 -1
  46. package/lib/sdks.js +2 -2
  47. package/lib/sdks.js.map +1 -1
  48. package/models/components/alternativequery.d.ts +3 -3
  49. package/models/components/alternativequery.d.ts.map +1 -1
  50. package/models/components/alternativequery.js +2 -2
  51. package/models/components/alternativequery.js.map +1 -1
  52. package/models/components/attribute.d.ts +4 -3
  53. package/models/components/attribute.d.ts.map +1 -1
  54. package/models/components/attribute.js +3 -2
  55. package/models/components/attribute.js.map +1 -1
  56. package/models/components/certificate.d.ts +5 -5
  57. package/models/components/certificate.d.ts.map +1 -1
  58. package/models/components/certificate.js +3 -3
  59. package/models/components/certificate.js.map +1 -1
  60. package/models/components/certificaterevocationrevocationinfo.d.ts +3 -3
  61. package/models/components/certificaterevocationrevocationinfo.d.ts.map +1 -1
  62. package/models/components/certificaterevocationrevocationinfo.js +2 -2
  63. package/models/components/certificaterevocationrevocationinfo.js.map +1 -1
  64. package/models/components/cobaltstrikeconfig.d.ts +1 -0
  65. package/models/components/cobaltstrikeconfig.d.ts.map +1 -1
  66. package/models/components/cobaltstrikeconfig.js +2 -0
  67. package/models/components/cobaltstrikeconfig.js.map +1 -1
  68. package/models/components/collection.d.ts +9 -5
  69. package/models/components/collection.d.ts.map +1 -1
  70. package/models/components/collection.js +5 -2
  71. package/models/components/collection.js.map +1 -1
  72. package/models/components/creditexpiration.d.ts +4 -0
  73. package/models/components/creditexpiration.d.ts.map +1 -1
  74. package/models/components/creditexpiration.js +2 -0
  75. package/models/components/creditexpiration.js.map +1 -1
  76. package/models/components/creditusagereport.d.ts +44 -5
  77. package/models/components/creditusagereport.d.ts.map +1 -1
  78. package/models/components/creditusagereport.js +28 -7
  79. package/models/components/creditusagereport.js.map +1 -1
  80. package/models/components/creditusagereportperiod.d.ts +33 -0
  81. package/models/components/creditusagereportperiod.d.ts.map +1 -0
  82. package/models/components/creditusagereportperiod.js +65 -0
  83. package/models/components/creditusagereportperiod.js.map +1 -0
  84. package/models/components/cvsscomponents.d.ts +17 -17
  85. package/models/components/cvsscomponents.d.ts.map +1 -1
  86. package/models/components/cvsscomponents.js +9 -9
  87. package/models/components/cvsscomponents.js.map +1 -1
  88. package/models/components/cvssv4components.d.ts +29 -29
  89. package/models/components/cvssv4components.d.ts.map +1 -1
  90. package/models/components/cvssv4components.js +15 -17
  91. package/models/components/cvssv4components.js.map +1 -1
  92. package/models/components/dns.d.ts +5 -5
  93. package/models/components/dns.d.ts.map +1 -1
  94. package/models/components/dns.js +3 -3
  95. package/models/components/dns.js.map +1 -1
  96. package/models/components/dnsresourcerecord.d.ts +3 -3
  97. package/models/components/dnsresourcerecord.d.ts.map +1 -1
  98. package/models/components/dnsresourcerecord.js +2 -1
  99. package/models/components/dnsresourcerecord.js.map +1 -1
  100. package/models/components/endpointscan.d.ts +3 -3
  101. package/models/components/endpointscan.d.ts.map +1 -1
  102. package/models/components/endpointscan.js +2 -1
  103. package/models/components/endpointscan.js.map +1 -1
  104. package/models/components/endpointscanstate.d.ts +5 -3
  105. package/models/components/endpointscanstate.d.ts.map +1 -1
  106. package/models/components/endpointscanstate.js +4 -1
  107. package/models/components/endpointscanstate.js.map +1 -1
  108. package/models/components/eventassetchange.d.ts +3 -3
  109. package/models/components/eventassetchange.d.ts.map +1 -1
  110. package/models/components/eventassetchange.js +2 -2
  111. package/models/components/eventassetchange.js.map +1 -1
  112. package/models/components/eventstatuschange.d.ts +5 -5
  113. package/models/components/eventstatuschange.d.ts.map +1 -1
  114. package/models/components/eventstatuschange.js +3 -4
  115. package/models/components/eventstatuschange.js.map +1 -1
  116. package/models/components/extractedendpointdata.d.ts +17 -0
  117. package/models/components/extractedendpointdata.d.ts.map +1 -0
  118. package/models/components/extractedendpointdata.js +65 -0
  119. package/models/components/extractedendpointdata.js.map +1 -0
  120. package/models/components/extractedendpointdataanalyticsservice.d.ts +11 -0
  121. package/models/components/extractedendpointdataanalyticsservice.d.ts.map +1 -0
  122. package/models/components/extractedendpointdataanalyticsservice.js +51 -0
  123. package/models/components/extractedendpointdataanalyticsservice.js.map +1 -0
  124. package/models/components/extractedendpointdatacopyright.d.ts +13 -0
  125. package/models/components/extractedendpointdatacopyright.d.ts.map +1 -0
  126. package/models/components/extractedendpointdatacopyright.js +59 -0
  127. package/models/components/extractedendpointdatacopyright.js.map +1 -0
  128. package/models/components/hajime.d.ts +10 -0
  129. package/models/components/hajime.d.ts.map +1 -0
  130. package/models/components/hajime.js +56 -0
  131. package/models/components/hajime.js.map +1 -0
  132. package/models/components/hostdnsforwardresolution.d.ts +3 -3
  133. package/models/components/hostdnsforwardresolution.d.ts.map +1 -1
  134. package/models/components/hostdnsforwardresolution.js +2 -2
  135. package/models/components/hostdnsforwardresolution.js.map +1 -1
  136. package/models/components/http.d.ts +7 -0
  137. package/models/components/http.d.ts.map +1 -1
  138. package/models/components/http.js +7 -0
  139. package/models/components/http.js.map +1 -1
  140. package/models/components/httpredirectchainlink.d.ts +25 -0
  141. package/models/components/httpredirectchainlink.d.ts.map +1 -0
  142. package/models/components/httpredirectchainlink.js +70 -0
  143. package/models/components/httpredirectchainlink.js.map +1 -0
  144. package/models/components/index.d.ts +14 -0
  145. package/models/components/index.d.ts.map +1 -1
  146. package/models/components/index.js +14 -0
  147. package/models/components/index.js.map +1 -1
  148. package/models/components/jarmscan.d.ts +3 -3
  149. package/models/components/jarmscan.d.ts.map +1 -1
  150. package/models/components/jarmscan.js +2 -1
  151. package/models/components/jarmscan.js.map +1 -1
  152. package/models/components/kev.d.ts +3 -3
  153. package/models/components/kev.d.ts.map +1 -1
  154. package/models/components/kev.js +2 -2
  155. package/models/components/kev.js.map +1 -1
  156. package/models/components/label.d.ts +4 -3
  157. package/models/components/label.d.ts.map +1 -1
  158. package/models/components/label.js +3 -2
  159. package/models/components/label.js.map +1 -1
  160. package/models/components/matchedservice.d.ts +3 -3
  161. package/models/components/matchedservice.d.ts.map +1 -1
  162. package/models/components/matchedservice.js +2 -1
  163. package/models/components/matchedservice.js.map +1 -1
  164. package/models/components/networklog.d.ts +18 -0
  165. package/models/components/networklog.d.ts.map +1 -0
  166. package/models/components/networklog.js +58 -0
  167. package/models/components/networklog.js.map +1 -0
  168. package/models/components/networklogresourceinfo.d.ts +49 -0
  169. package/models/components/networklogresourceinfo.d.ts.map +1 -0
  170. package/models/components/networklogresourceinfo.js +64 -0
  171. package/models/components/networklogresourceinfo.js.map +1 -0
  172. package/models/components/paginationinfo.d.ts +1 -1
  173. package/models/components/reject.d.ts +3 -3
  174. package/models/components/reject.d.ts.map +1 -1
  175. package/models/components/reject.js +2 -2
  176. package/models/components/reject.js.map +1 -1
  177. package/models/components/representativeinfo.d.ts +3 -3
  178. package/models/components/representativeinfo.d.ts.map +1 -1
  179. package/models/components/representativeinfo.js +2 -1
  180. package/models/components/representativeinfo.js.map +1 -1
  181. package/models/components/responseenvelopethreatslistresponse.d.ts +11 -0
  182. package/models/components/responseenvelopethreatslistresponse.d.ts.map +1 -0
  183. package/models/components/responseenvelopethreatslistresponse.js +51 -0
  184. package/models/components/responseenvelopethreatslistresponse.js.map +1 -0
  185. package/models/components/responseenvelopeusercredits.d.ts +11 -0
  186. package/models/components/responseenvelopeusercredits.d.ts.map +1 -0
  187. package/models/components/responseenvelopeusercredits.js +51 -0
  188. package/models/components/responseenvelopeusercredits.js.map +1 -0
  189. package/models/components/risk.d.ts +8 -7
  190. package/models/components/risk.d.ts.map +1 -1
  191. package/models/components/risk.js +5 -6
  192. package/models/components/risk.js.map +1 -1
  193. package/models/components/rootstore.d.ts +3 -3
  194. package/models/components/rootstore.d.ts.map +1 -1
  195. package/models/components/rootstore.js +2 -1
  196. package/models/components/rootstore.js.map +1 -1
  197. package/models/components/searchconvertqueryresponse.d.ts +3 -3
  198. package/models/components/searchconvertqueryresponse.d.ts.map +1 -1
  199. package/models/components/searchconvertqueryresponse.js +2 -1
  200. package/models/components/searchconvertqueryresponse.js.map +1 -1
  201. package/models/components/service.d.ts +5 -3
  202. package/models/components/service.d.ts.map +1 -1
  203. package/models/components/service.js +4 -1
  204. package/models/components/service.js.map +1 -1
  205. package/models/components/serviceid.d.ts +3 -3
  206. package/models/components/serviceid.d.ts.map +1 -1
  207. package/models/components/serviceid.js +2 -1
  208. package/models/components/serviceid.js.map +1 -1
  209. package/models/components/servicescan.d.ts +5 -3
  210. package/models/components/servicescan.d.ts.map +1 -1
  211. package/models/components/servicescan.js +4 -1
  212. package/models/components/servicescan.js.map +1 -1
  213. package/models/components/sourceusagebreakdown.d.ts +9 -1
  214. package/models/components/sourceusagebreakdown.d.ts.map +1 -1
  215. package/models/components/sourceusagebreakdown.js +7 -0
  216. package/models/components/sourceusagebreakdown.js.map +1 -1
  217. package/models/components/threat.d.ts +4 -3
  218. package/models/components/threat.d.ts.map +1 -1
  219. package/models/components/threat.js +3 -1
  220. package/models/components/threat.js.map +1 -1
  221. package/models/components/threatlistitem.d.ts +42 -0
  222. package/models/components/threatlistitem.d.ts.map +1 -0
  223. package/models/components/threatlistitem.js +66 -0
  224. package/models/components/threatlistitem.js.map +1 -0
  225. package/models/components/threatreference.d.ts +13 -0
  226. package/models/components/threatreference.d.ts.map +1 -0
  227. package/models/components/threatreference.js +50 -0
  228. package/models/components/threatreference.js.map +1 -0
  229. package/models/components/threatslistresponse.d.ts +14 -0
  230. package/models/components/threatslistresponse.d.ts.map +1 -0
  231. package/models/components/threatslistresponse.js +51 -0
  232. package/models/components/threatslistresponse.js.map +1 -0
  233. package/models/components/tls.d.ts +3 -3
  234. package/models/components/tls.d.ts.map +1 -1
  235. package/models/components/tls.js +2 -1
  236. package/models/components/tls.js.map +1 -1
  237. package/models/components/tlsversiondata.d.ts +3 -3
  238. package/models/components/tlsversiondata.d.ts.map +1 -1
  239. package/models/components/tlsversiondata.js +2 -2
  240. package/models/components/tlsversiondata.js.map +1 -1
  241. package/models/components/trackedscantask.d.ts +3 -3
  242. package/models/components/trackedscantask.d.ts.map +1 -1
  243. package/models/components/trackedscantask.js +2 -1
  244. package/models/components/trackedscantask.js.map +1 -1
  245. package/models/components/usercredits.d.ts +17 -0
  246. package/models/components/usercredits.d.ts.map +1 -0
  247. package/models/components/usercredits.js +57 -0
  248. package/models/components/usercredits.js.map +1 -0
  249. package/models/components/vuln.d.ts +8 -7
  250. package/models/components/vuln.d.ts.map +1 -1
  251. package/models/components/vuln.js +5 -4
  252. package/models/components/vuln.js.map +1 -1
  253. package/models/operations/index.d.ts +3 -0
  254. package/models/operations/index.d.ts.map +1 -1
  255. package/models/operations/index.js +3 -0
  256. package/models/operations/index.js.map +1 -1
  257. package/models/operations/v3accountmanagementmembercreditsusage.d.ts +33 -3
  258. package/models/operations/v3accountmanagementmembercreditsusage.d.ts.map +1 -1
  259. package/models/operations/v3accountmanagementmembercreditsusage.js +17 -2
  260. package/models/operations/v3accountmanagementmembercreditsusage.js.map +1 -1
  261. package/models/operations/v3accountmanagementorgcreditsusage.d.ts +38 -3
  262. package/models/operations/v3accountmanagementorgcreditsusage.d.ts.map +1 -1
  263. package/models/operations/v3accountmanagementorgcreditsusage.js +20 -2
  264. package/models/operations/v3accountmanagementorgcreditsusage.js.map +1 -1
  265. package/models/operations/v3accountmanagementusercredits.d.ts +14 -0
  266. package/models/operations/v3accountmanagementusercredits.d.ts.map +1 -0
  267. package/models/operations/v3accountmanagementusercredits.js +58 -0
  268. package/models/operations/v3accountmanagementusercredits.js.map +1 -0
  269. package/models/operations/v3accountmanagementusercreditsusage.d.ts +57 -0
  270. package/models/operations/v3accountmanagementusercreditsusage.d.ts.map +1 -0
  271. package/models/operations/v3accountmanagementusercreditsusage.js +85 -0
  272. package/models/operations/v3accountmanagementusercreditsusage.js.map +1 -0
  273. package/models/operations/v3globaldatasearchaggregate.d.ts +1 -1
  274. package/models/operations/v3globaldatasearchquery.d.ts +1 -1
  275. package/models/operations/v3threathuntingthreatslist.d.ts +35 -0
  276. package/models/operations/v3threathuntingthreatslist.d.ts.map +1 -0
  277. package/models/operations/v3threathuntingthreatslist.js +71 -0
  278. package/models/operations/v3threathuntingthreatslist.js.map +1 -0
  279. package/package.json +1 -1
  280. package/sdk/accountmanagement.d.ts +18 -4
  281. package/sdk/accountmanagement.d.ts.map +1 -1
  282. package/sdk/accountmanagement.js +24 -4
  283. package/sdk/accountmanagement.js.map +1 -1
  284. package/sdk/collections.d.ts +6 -6
  285. package/sdk/collections.js +6 -6
  286. package/sdk/threathunting.d.ts +7 -0
  287. package/sdk/threathunting.d.ts.map +1 -1
  288. package/sdk/threathunting.js +10 -0
  289. package/sdk/threathunting.js.map +1 -1
  290. package/src/funcs/accountManagementGetMemberCreditUsage.ts +5 -2
  291. package/src/funcs/accountManagementGetOrganizationCreditUsage.ts +5 -1
  292. package/src/funcs/accountManagementGetOrganizationCredits.ts +1 -1
  293. package/src/funcs/accountManagementGetUserCredits.ts +163 -0
  294. package/src/funcs/accountManagementGetUserCreditsUsage.ts +190 -0
  295. package/src/funcs/collectionsCreate.ts +1 -1
  296. package/src/funcs/collectionsDelete.ts +1 -1
  297. package/src/funcs/collectionsGet.ts +1 -1
  298. package/src/funcs/collectionsList.ts +1 -1
  299. package/src/funcs/collectionsListEvents.ts +1 -1
  300. package/src/funcs/collectionsUpdate.ts +1 -1
  301. package/src/funcs/threatHuntingListThreats.ts +187 -0
  302. package/src/lib/config.ts +4 -4
  303. package/src/lib/encodings.ts +17 -3
  304. package/src/lib/sdks.ts +2 -2
  305. package/src/models/components/alternativequery.ts +5 -4
  306. package/src/models/components/attribute.ts +6 -4
  307. package/src/models/components/certificate.ts +14 -8
  308. package/src/models/components/certificaterevocationrevocationinfo.ts +5 -4
  309. package/src/models/components/cobaltstrikeconfig.ts +3 -0
  310. package/src/models/components/collection.ts +20 -8
  311. package/src/models/components/creditexpiration.ts +6 -0
  312. package/src/models/components/creditusagereport.ts +70 -11
  313. package/src/models/components/creditusagereportperiod.ts +69 -0
  314. package/src/models/components/cvsscomponents.ts +47 -30
  315. package/src/models/components/cvssv4components.ts +83 -53
  316. package/src/models/components/dns.ts +11 -8
  317. package/src/models/components/dnsresourcerecord.ts +8 -5
  318. package/src/models/components/endpointscan.ts +8 -5
  319. package/src/models/components/endpointscanstate.ts +14 -5
  320. package/src/models/components/eventassetchange.ts +8 -4
  321. package/src/models/components/eventstatuschange.ts +14 -7
  322. package/src/models/components/extractedendpointdata.ts +62 -0
  323. package/src/models/components/extractedendpointdataanalyticsservice.ts +34 -0
  324. package/src/models/components/extractedendpointdatacopyright.ts +43 -0
  325. package/src/models/components/hajime.ts +33 -0
  326. package/src/models/components/hostdnsforwardresolution.ts +8 -4
  327. package/src/models/components/http.ts +15 -0
  328. package/src/models/components/httpredirectchainlink.ts +65 -0
  329. package/src/models/components/index.ts +14 -0
  330. package/src/models/components/jarmscan.ts +8 -5
  331. package/src/models/components/kev.ts +8 -4
  332. package/src/models/components/label.ts +9 -4
  333. package/src/models/components/matchedservice.ts +8 -5
  334. package/src/models/components/networklog.ts +49 -0
  335. package/src/models/components/networklogresourceinfo.ts +84 -0
  336. package/src/models/components/paginationinfo.ts +1 -1
  337. package/src/models/components/reject.ts +8 -4
  338. package/src/models/components/representativeinfo.ts +8 -5
  339. package/src/models/components/responseenvelopethreatslistresponse.ts +36 -0
  340. package/src/models/components/responseenvelopeusercredits.ts +32 -0
  341. package/src/models/components/risk.ts +21 -10
  342. package/src/models/components/rootstore.ts +5 -5
  343. package/src/models/components/searchconvertqueryresponse.ts +8 -5
  344. package/src/models/components/service.ts +11 -5
  345. package/src/models/components/serviceid.ts +8 -5
  346. package/src/models/components/servicescan.ts +11 -5
  347. package/src/models/components/sourceusagebreakdown.ts +16 -1
  348. package/src/models/components/threat.ts +9 -4
  349. package/src/models/components/threatlistitem.ts +81 -0
  350. package/src/models/components/threatreference.ts +34 -0
  351. package/src/models/components/threatslistresponse.ts +38 -0
  352. package/src/models/components/tls.ts +8 -5
  353. package/src/models/components/tlsversiondata.ts +5 -4
  354. package/src/models/components/trackedscantask.ts +8 -5
  355. package/src/models/components/usercredits.ts +45 -0
  356. package/src/models/components/vuln.ts +21 -11
  357. package/src/models/operations/index.ts +3 -0
  358. package/src/models/operations/v3accountmanagementmembercreditsusage.ts +43 -4
  359. package/src/models/operations/v3accountmanagementorgcreditsusage.ts +49 -4
  360. package/src/models/operations/v3accountmanagementusercredits.ts +41 -0
  361. package/src/models/operations/v3accountmanagementusercreditsusage.ts +128 -0
  362. package/src/models/operations/v3globaldatasearchaggregate.ts +1 -1
  363. package/src/models/operations/v3globaldatasearchquery.ts +1 -1
  364. package/src/models/operations/v3threathuntingthreatslist.ts +86 -0
  365. package/src/sdk/accountmanagement.ts +38 -4
  366. package/src/sdk/collections.ts +6 -6
  367. package/src/sdk/threathunting.ts +18 -0
  368. package/src/types/enums.ts +38 -9
  369. package/src/types/index.ts +2 -2
  370. package/src/types/unrecognized.ts +35 -0
  371. package/tsconfig.json +1 -2
  372. package/types/enums.d.ts +8 -11
  373. package/types/enums.d.ts.map +1 -1
  374. package/types/enums.js +59 -3
  375. package/types/enums.js.map +1 -1
  376. package/types/index.d.ts +2 -2
  377. package/types/index.d.ts.map +1 -1
  378. package/types/index.js +16 -3
  379. package/types/index.js.map +1 -1
  380. package/types/unrecognized.d.ts +16 -0
  381. package/types/unrecognized.d.ts.map +1 -0
  382. package/types/unrecognized.js +34 -0
  383. package/types/unrecognized.js.map +1 -0
package/README.md CHANGED
@@ -111,18 +111,20 @@ run();
111
111
  <details open>
112
112
  <summary>Available methods</summary>
113
113
 
114
- ### [accountManagement](docs/sdks/accountmanagement/README.md)
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 statistics
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
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
124
126
 
125
- ### [collections](docs/sdks/collections/README.md)
127
+ ### [Collections](docs/sdks/collections/README.md)
126
128
 
127
129
  * [list](docs/sdks/collections/README.md#list) - List collections
128
130
  * [create](docs/sdks/collections/README.md#create) - Create a collection
@@ -133,7 +135,7 @@ run();
133
135
  * [aggregate](docs/sdks/collections/README.md#aggregate) - Aggregate results for a search query within a collection
134
136
  * [search](docs/sdks/collections/README.md#search) - Run a search query within a collection
135
137
 
136
- ### [globalData](docs/sdks/globaldata/README.md)
138
+ ### [GlobalData](docs/sdks/globaldata/README.md)
137
139
 
138
140
  * [getCertificates](docs/sdks/globaldata/README.md#getcertificates) - Retrieve multiple certificates
139
141
  * [getCertificatesRaw](docs/sdks/globaldata/README.md#getcertificatesraw) - Retrieve multiple certificates in PEM format
@@ -150,11 +152,12 @@ run();
150
152
  * [convertLegacySearchQueries](docs/sdks/globaldata/README.md#convertlegacysearchqueries) - Convert Legacy Search queries to Platform queries
151
153
  * [search](docs/sdks/globaldata/README.md#search) - Run a search query
152
154
 
153
- ### [threatHunting](docs/sdks/threathunting/README.md)
155
+ ### [ThreatHunting](docs/sdks/threathunting/README.md)
154
156
 
155
157
  * [getHostObservationsWithCertificate](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
156
158
  * [createTrackedScan](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
157
159
  * [getTrackedScanThreatHunting](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status
160
+ * [listThreats](docs/sdks/threathunting/README.md#listthreats) - List active threats
158
161
  * [valueCounts](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
159
162
 
160
163
  </details>
@@ -175,10 +178,12 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
175
178
 
176
179
  <summary>Available standalone functions</summary>
177
180
 
178
- - [`accountManagementGetMemberCreditUsage`](docs/sdks/accountmanagement/README.md#getmembercreditusage) - Get member credit usage
179
- - [`accountManagementGetOrganizationCredits`](docs/sdks/accountmanagement/README.md#getorganizationcredits) - Get organization credit statistics
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
180
183
  - [`accountManagementGetOrganizationCreditUsage`](docs/sdks/accountmanagement/README.md#getorganizationcreditusage) - Get organization credit usage
181
184
  - [`accountManagementGetOrganizationDetails`](docs/sdks/accountmanagement/README.md#getorganizationdetails) - Get organization 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
182
187
  - [`accountManagementInviteUserToOrganization`](docs/sdks/accountmanagement/README.md#inviteusertoorganization) - Invite user to organization
183
188
  - [`accountManagementListOrganizationMembers`](docs/sdks/accountmanagement/README.md#listorganizationmembers) - List organization members
184
189
  - [`accountManagementRemoveOrganizationMember`](docs/sdks/accountmanagement/README.md#removeorganizationmember) - Remove member from organization
@@ -208,6 +213,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
208
213
  - [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
209
214
  - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
210
215
  - [`threatHuntingGetTrackedScanThreatHunting`](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status
216
+ - [`threatHuntingListThreats`](docs/sdks/threathunting/README.md#listthreats) - List active threats
211
217
  - [`threatHuntingValueCounts`](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
212
218
 
213
219
  </details>
@@ -1,5 +1,4 @@
1
1
  # AccountManagement
2
- (*accountManagement*)
3
2
 
4
3
  ## Overview
5
4
 
@@ -8,13 +7,15 @@ Endpoints related to the Account Management product
8
7
  ### Available Operations
9
8
 
10
9
  * [getOrganizationDetails](#getorganizationdetails) - Get organization details
11
- * [getOrganizationCredits](#getorganizationcredits) - Get organization credit statistics
10
+ * [getOrganizationCredits](#getorganizationcredits) - Get organization credit balance
12
11
  * [getOrganizationCreditUsage](#getorganizationcreditusage) - Get organization credit usage
13
12
  * [inviteUserToOrganization](#inviteusertoorganization) - Invite user to organization
14
13
  * [listOrganizationMembers](#listorganizationmembers) - List organization members
15
14
  * [removeOrganizationMember](#removeorganizationmember) - Remove member from organization
16
15
  * [updateOrganizationMember](#updateorganizationmember) - Update a member's roles in an organization
17
- * [getMemberCreditUsage](#getmembercreditusage) - Get member credit usage
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
 
@@ -168,13 +169,14 @@ run();
168
169
 
169
170
  ## getOrganizationCreditUsage
170
171
 
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.
172
+ 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
173
 
173
174
  ### Example Usage
174
175
 
175
176
  <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-org-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/credits/usage" -->
176
177
  ```typescript
177
178
  import { SDK } from "@censys/platform-sdk";
179
+ import { RFCDate } from "@censys/platform-sdk/types";
178
180
 
179
181
  const sdk = new SDK({
180
182
  personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
@@ -184,6 +186,8 @@ async function run() {
184
186
  const result = await sdk.accountManagement.getOrganizationCreditUsage({
185
187
  organizationId: "11111111-2222-3333-4444-555555555555",
186
188
  date: "2025-11-01",
189
+ startDate: new RFCDate("2025-11-01"),
190
+ endDate: new RFCDate("2025-12-01"),
187
191
  });
188
192
 
189
193
  console.log(result);
@@ -199,6 +203,7 @@ The standalone function version of this method:
199
203
  ```typescript
200
204
  import { SDKCore } from "@censys/platform-sdk/core.js";
201
205
  import { accountManagementGetOrganizationCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetOrganizationCreditUsage.js";
206
+ import { RFCDate } from "@censys/platform-sdk/types";
202
207
 
203
208
  // Use `SDKCore` for best tree-shaking performance.
204
209
  // You can create one instance of it to use across an application.
@@ -210,6 +215,8 @@ async function run() {
210
215
  const res = await accountManagementGetOrganizationCreditUsage(sdk, {
211
216
  organizationId: "11111111-2222-3333-4444-555555555555",
212
217
  date: "2025-11-01",
218
+ startDate: new RFCDate("2025-11-01"),
219
+ endDate: new RFCDate("2025-12-01"),
213
220
  });
214
221
  if (res.ok) {
215
222
  const { value: result } = res;
@@ -561,13 +568,14 @@ run();
561
568
 
562
569
  ## getMemberCreditUsage
563
570
 
564
- Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
571
+ 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
572
 
566
573
  ### Example Usage
567
574
 
568
575
  <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-member-credits-usage" method="get" path="/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage" -->
569
576
  ```typescript
570
577
  import { SDK } from "@censys/platform-sdk";
578
+ import { RFCDate } from "@censys/platform-sdk/types";
571
579
 
572
580
  const sdk = new SDK({
573
581
  personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
@@ -578,6 +586,8 @@ async function run() {
578
586
  organizationId: "11111111-2222-3333-4444-555555555555",
579
587
  userId: "11111111-2222-3333-4444-555555555555",
580
588
  date: "2025-11-01",
589
+ startDate: new RFCDate("2025-11-01"),
590
+ endDate: new RFCDate("2025-12-01"),
581
591
  });
582
592
 
583
593
  console.log(result);
@@ -593,6 +603,7 @@ The standalone function version of this method:
593
603
  ```typescript
594
604
  import { SDKCore } from "@censys/platform-sdk/core.js";
595
605
  import { accountManagementGetMemberCreditUsage } from "@censys/platform-sdk/funcs/accountManagementGetMemberCreditUsage.js";
606
+ import { RFCDate } from "@censys/platform-sdk/types";
596
607
 
597
608
  // Use `SDKCore` for best tree-shaking performance.
598
609
  // You can create one instance of it to use across an application.
@@ -605,6 +616,8 @@ async function run() {
605
616
  organizationId: "11111111-2222-3333-4444-555555555555",
606
617
  userId: "11111111-2222-3333-4444-555555555555",
607
618
  date: "2025-11-01",
619
+ startDate: new RFCDate("2025-11-01"),
620
+ endDate: new RFCDate("2025-12-01"),
608
621
  });
609
622
  if (res.ok) {
610
623
  const { value: result } = res;
@@ -636,4 +649,155 @@ run();
636
649
  | -------------------------- | -------------------------- | -------------------------- |
637
650
  | errors.AuthenticationError | 401 | application/json |
638
651
  | errors.ErrorModel | 400, 403, 404, 422 | application/problem+json |
652
+ | errors.SDKError | 4XX, 5XX | \*/\* |
653
+
654
+ ## getUserCredits
655
+
656
+ 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.
657
+
658
+ ### Example Usage
659
+
660
+ <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-user-credits" method="get" path="/v3/accounts/users/credits" -->
661
+ ```typescript
662
+ import { SDK } from "@censys/platform-sdk";
663
+
664
+ const sdk = new SDK({
665
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
666
+ });
667
+
668
+ async function run() {
669
+ const result = await sdk.accountManagement.getUserCredits();
670
+
671
+ console.log(result);
672
+ }
673
+
674
+ run();
675
+ ```
676
+
677
+ ### Standalone function
678
+
679
+ The standalone function version of this method:
680
+
681
+ ```typescript
682
+ import { SDKCore } from "@censys/platform-sdk/core.js";
683
+ import { accountManagementGetUserCredits } from "@censys/platform-sdk/funcs/accountManagementGetUserCredits.js";
684
+
685
+ // Use `SDKCore` for best tree-shaking performance.
686
+ // You can create one instance of it to use across an application.
687
+ const sdk = new SDKCore({
688
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
689
+ });
690
+
691
+ async function run() {
692
+ const res = await accountManagementGetUserCredits(sdk);
693
+ if (res.ok) {
694
+ const { value: result } = res;
695
+ console.log(result);
696
+ } else {
697
+ console.log("accountManagementGetUserCredits failed:", res.error);
698
+ }
699
+ }
700
+
701
+ run();
702
+ ```
703
+
704
+ ### Parameters
705
+
706
+ | Parameter | Type | Required | Description |
707
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
708
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
709
+ | `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. |
710
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
711
+
712
+ ### Response
713
+
714
+ **Promise\<[operations.V3AccountmanagementUserCreditsResponse](../../models/operations/v3accountmanagementusercreditsresponse.md)\>**
715
+
716
+ ### Errors
717
+
718
+ | Error Type | Status Code | Content Type |
719
+ | -------------------------- | -------------------------- | -------------------------- |
720
+ | errors.AuthenticationError | 401 | application/json |
721
+ | errors.ErrorModel | 404 | application/problem+json |
722
+ | errors.SDKError | 4XX, 5XX | \*/\* |
723
+
724
+ ## getUserCreditsUsage
725
+
726
+ 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.
727
+
728
+ ### Example Usage
729
+
730
+ <!-- UsageSnippet language="typescript" operationID="v3-accountmanagement-user-credits-usage" method="get" path="/v3/accounts/users/credits/usage" -->
731
+ ```typescript
732
+ import { SDK } from "@censys/platform-sdk";
733
+ import { RFCDate } from "@censys/platform-sdk/types";
734
+
735
+ const sdk = new SDK({
736
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
737
+ });
738
+
739
+ async function run() {
740
+ const result = await sdk.accountManagement.getUserCreditsUsage({
741
+ date: "2025-11-01",
742
+ startDate: new RFCDate("2025-11-01"),
743
+ endDate: new RFCDate("2025-12-01"),
744
+ });
745
+
746
+ console.log(result);
747
+ }
748
+
749
+ run();
750
+ ```
751
+
752
+ ### Standalone function
753
+
754
+ The standalone function version of this method:
755
+
756
+ ```typescript
757
+ import { SDKCore } from "@censys/platform-sdk/core.js";
758
+ import { accountManagementGetUserCreditsUsage } from "@censys/platform-sdk/funcs/accountManagementGetUserCreditsUsage.js";
759
+ import { RFCDate } from "@censys/platform-sdk/types";
760
+
761
+ // Use `SDKCore` for best tree-shaking performance.
762
+ // You can create one instance of it to use across an application.
763
+ const sdk = new SDKCore({
764
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
765
+ });
766
+
767
+ async function run() {
768
+ const res = await accountManagementGetUserCreditsUsage(sdk, {
769
+ date: "2025-11-01",
770
+ startDate: new RFCDate("2025-11-01"),
771
+ endDate: new RFCDate("2025-12-01"),
772
+ });
773
+ if (res.ok) {
774
+ const { value: result } = res;
775
+ console.log(result);
776
+ } else {
777
+ console.log("accountManagementGetUserCreditsUsage failed:", res.error);
778
+ }
779
+ }
780
+
781
+ run();
782
+ ```
783
+
784
+ ### Parameters
785
+
786
+ | Parameter | Type | Required | Description |
787
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
788
+ | `request` | [operations.V3AccountmanagementUserCreditsUsageRequest](../../models/operations/v3accountmanagementusercreditsusagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
789
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
790
+ | `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. |
791
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
792
+
793
+ ### Response
794
+
795
+ **Promise\<[operations.V3AccountmanagementUserCreditsUsageResponse](../../models/operations/v3accountmanagementusercreditsusageresponse.md)\>**
796
+
797
+ ### Errors
798
+
799
+ | Error Type | Status Code | Content Type |
800
+ | -------------------------- | -------------------------- | -------------------------- |
801
+ | errors.AuthenticationError | 401 | application/json |
802
+ | errors.ErrorModel | 404 | application/problem+json |
639
803
  | errors.SDKError | 4XX, 5XX | \*/\* |
@@ -1,5 +1,4 @@
1
1
  # Collections
2
- (*collections*)
3
2
 
4
3
  ## Overview
5
4
 
@@ -18,7 +17,7 @@ Endpoints related to the Collections product
18
17
 
19
18
  ## list
20
19
 
21
- 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.
22
21
 
23
22
  ### Example Usage
24
23
 
@@ -97,7 +96,7 @@ run();
97
96
 
98
97
  ## create
99
98
 
100
- Create a new collection.
99
+ Create a new collection.<br><br>This endpoint does not cost credits to execute.
101
100
 
102
101
  ### Example Usage
103
102
 
@@ -182,7 +181,7 @@ run();
182
181
 
183
182
  ## delete
184
183
 
185
- Delete a collection.
184
+ Delete a collection.<br><br>This endpoint does not cost credits to execute.
186
185
 
187
186
  ### Example Usage
188
187
 
@@ -259,7 +258,7 @@ run();
259
258
 
260
259
  ## get
261
260
 
262
- Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
261
+ 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.
263
262
 
264
263
  ### Example Usage
265
264
 
@@ -336,7 +335,7 @@ run();
336
335
 
337
336
  ## update
338
337
 
339
- Update a collection's name, description, and/or query.
338
+ Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
340
339
 
341
340
  ### Example Usage
342
341
 
@@ -423,7 +422,7 @@ run();
423
422
 
424
423
  ## listEvents
425
424
 
426
- Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
425
+ 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.
427
426
 
428
427
  ### Example Usage
429
428
 
@@ -1,5 +1,4 @@
1
1
  # GlobalData
2
- (*globalData*)
3
2
 
4
3
  ## Overview
5
4
 
@@ -1,5 +1,4 @@
1
1
  # ThreatHunting
2
- (*threatHunting*)
3
2
 
4
3
  ## Overview
5
4
 
@@ -10,6 +9,7 @@ Endpoints related to the Threat Hunting product
10
9
  * [getHostObservationsWithCertificate](#gethostobservationswithcertificate) - Get host history for a certificate
11
10
  * [createTrackedScan](#createtrackedscan) - Live Discovery: Initiate a new scan
12
11
  * [getTrackedScanThreatHunting](#gettrackedscanthreathunting) - Get scan status
12
+ * [listThreats](#listthreats) - List active threats
13
13
  * [valueCounts](#valuecounts) - CensEye: Retrieve value counts to discover pivots
14
14
 
15
15
  ## getHostObservationsWithCertificate
@@ -267,6 +267,83 @@ run();
267
267
  | errors.ErrorModel | 403, 404 | application/problem+json |
268
268
  | errors.SDKError | 4XX, 5XX | \*/\* |
269
269
 
270
+ ## listThreats
271
+
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).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
273
+
274
+ ### Example Usage
275
+
276
+ <!-- UsageSnippet language="typescript" operationID="v3-threathunting-threats-list" method="get" path="/v3/threat-hunting/threats" -->
277
+ ```typescript
278
+ import { SDK } from "@censys/platform-sdk";
279
+
280
+ const sdk = new SDK({
281
+ organizationId: "11111111-2222-3333-4444-555555555555",
282
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
283
+ });
284
+
285
+ async function run() {
286
+ const result = await sdk.threatHunting.listThreats({
287
+ query: "*",
288
+ });
289
+
290
+ console.log(result);
291
+ }
292
+
293
+ run();
294
+ ```
295
+
296
+ ### Standalone function
297
+
298
+ The standalone function version of this method:
299
+
300
+ ```typescript
301
+ import { SDKCore } from "@censys/platform-sdk/core.js";
302
+ import { threatHuntingListThreats } from "@censys/platform-sdk/funcs/threatHuntingListThreats.js";
303
+
304
+ // Use `SDKCore` for best tree-shaking performance.
305
+ // You can create one instance of it to use across an application.
306
+ const sdk = new SDKCore({
307
+ organizationId: "11111111-2222-3333-4444-555555555555",
308
+ personalAccessToken: "<YOUR_BEARER_TOKEN_HERE>",
309
+ });
310
+
311
+ async function run() {
312
+ const res = await threatHuntingListThreats(sdk, {
313
+ query: "*",
314
+ });
315
+ if (res.ok) {
316
+ const { value: result } = res;
317
+ console.log(result);
318
+ } else {
319
+ console.log("threatHuntingListThreats failed:", res.error);
320
+ }
321
+ }
322
+
323
+ run();
324
+ ```
325
+
326
+ ### Parameters
327
+
328
+ | Parameter | Type | Required | Description |
329
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
330
+ | `request` | [operations.V3ThreathuntingThreatsListRequest](../../models/operations/v3threathuntingthreatslistrequest.md) | :heavy_check_mark: | The request object to use for the request. |
331
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
332
+ | `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. |
333
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
334
+
335
+ ### Response
336
+
337
+ **Promise\<[operations.V3ThreathuntingThreatsListResponse](../../models/operations/v3threathuntingthreatslistresponse.md)\>**
338
+
339
+ ### Errors
340
+
341
+ | Error Type | Status Code | Content Type |
342
+ | -------------------------- | -------------------------- | -------------------------- |
343
+ | errors.AuthenticationError | 401 | application/json |
344
+ | errors.ErrorModel | 403, 422 | application/problem+json |
345
+ | errors.SDKError | 4XX, 5XX | \*/\* |
346
+
270
347
  ## valueCounts
271
348
 
272
349
  Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country=”United States”` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Threat Hunting Module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
@@ -18,7 +18,7 @@
18
18
  },
19
19
  "..": {
20
20
  "name": "@censys/platform-sdk",
21
- "version": "0.8.0",
21
+ "version": "0.9.1",
22
22
  "dependencies": {
23
23
  "zod": "^3.25.0 || ^4.0.0"
24
24
  },
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Get member credit usage
12
+ * Get organization member credit usage
13
13
  *
14
14
  * @remarks
15
- * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
15
+ * 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.
16
16
  */
17
17
  export declare function accountManagementGetMemberCreditUsage(client: SDKCore, request: operations.V3AccountmanagementMemberCreditsUsageRequest, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementMemberCreditsUsageResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=accountManagementGetMemberCreditUsage.d.ts.map
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Get member credit usage
50
+ * Get organization member credit usage
51
51
  *
52
52
  * @remarks
53
- * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
53
+ * 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.
54
54
  */
55
55
  function accountManagementGetMemberCreditUsage(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -76,6 +76,9 @@ async function $do(client, request, options) {
76
76
  const path = (0, url_js_1.pathToFunc)("/v3/accounts/organizations/{organization_id}/members/{user_id}/credits/usage")(pathParams);
77
77
  const query = (0, encodings_js_1.encodeFormQuery)({
78
78
  "date": payload.date,
79
+ "end_date": payload.end_date,
80
+ "granularity": payload.granularity,
81
+ "start_date": payload.start_date,
79
82
  }, { explode: false });
80
83
  const headers = new Headers((0, primitives_js_1.compactMap)({
81
84
  Accept: "application/json",
@@ -1 +1 @@
1
- {"version":3,"file":"accountManagementGetMemberCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetMemberCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,sFAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,qCAAqC,CACnD,MAAe,EACf,OAAgE,EAChE,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAgE,EAChE,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,2DAA2D;SACnE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;QACF,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,8EAA8E,CAC/E,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;KACrB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,2CAA2C;QACxD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,2DAA2D,EACtE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
1
+ {"version":3,"file":"accountManagementGetMemberCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetMemberCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,sFAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,qCAAqC,CACnD,MAAe,EACf,OAAgE,EAChE,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAAgE,EAChE,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,2DAA2D;SACnE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;QACF,OAAO,EAAE,IAAA,2BAAY,EAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE;YAChD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,8EAA8E,CAC/E,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,aAAa,EAAE,OAAO,CAAC,WAAW;QAClC,YAAY,EAAE,OAAO,CAAC,UAAU;KACjC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,2CAA2C;QACxD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,2DAA2D,EACtE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get organization credit usage
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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.
16
16
  */
17
17
  export declare function accountManagementGetOrganizationCreditUsage(client: SDKCore, request: operations.V3AccountmanagementOrgCreditsUsageRequest, options?: RequestOptions): APIPromise<Result<operations.V3AccountmanagementOrgCreditsUsageResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=accountManagementGetOrganizationCreditUsage.d.ts.map
@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
50
50
  * Get organization credit usage
51
51
  *
52
52
  * @remarks
53
- * 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.
53
+ * 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.
54
54
  */
55
55
  function accountManagementGetOrganizationCreditUsage(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -71,6 +71,10 @@ async function $do(client, request, options) {
71
71
  const path = (0, url_js_1.pathToFunc)("/v3/accounts/organizations/{organization_id}/credits/usage")(pathParams);
72
72
  const query = (0, encodings_js_1.encodeFormQuery)({
73
73
  "date": payload.date,
74
+ "end_date": payload.end_date,
75
+ "granularity": payload.granularity,
76
+ "include_consumer_breakdown": payload.include_consumer_breakdown,
77
+ "start_date": payload.start_date,
74
78
  }, { explode: false });
75
79
  const headers = new Headers((0, primitives_js_1.compactMap)({
76
80
  Accept: "application/json",
@@ -1 +1 @@
1
- {"version":3,"file":"accountManagementGetOrganizationCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetOrganizationCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,kGAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,2CAA2C,CACzD,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,wDAAwD,CAAC,KAAK,CACvE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,4DAA4D,CAC7D,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;KACrB,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,wDAAwD,EACnE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}
1
+ {"version":3,"file":"accountManagementGetOrganizationCreditUsage.js","sourceRoot":"","sources":["../src/funcs/accountManagementGetOrganizationCreditUsage.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BH,kGAwBC;AApDD,sDAAoE;AACpE,sDAAwC;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAQ3C,kEAAoD;AAIpD,0EAA4D;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,SAAgB,2CAA2C,CACzD,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAgBxB,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,MAAe,EACf,OAA6D,EAC7D,OAAwB;IAmBxB,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,wDAAwD,CAAC,KAAK,CACvE,KAAK,CACN,EACH,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,eAAe,EAAE,IAAA,2BAAY,EAAC,iBAAiB,EAAE,OAAO,CAAC,eAAe,EAAE;YACxE,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IAEF,MAAM,IAAI,GAAG,IAAA,mBAAU,EACrB,4DAA4D,CAC7D,CAAC,UAAU,CAAC,CAAC;IAEd,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,MAAM,EAAE,OAAO,CAAC,IAAI;QACpB,UAAU,EAAE,OAAO,CAAC,QAAQ;QAC5B,aAAa,EAAE,OAAO,CAAC,WAAW;QAClC,4BAA4B,EAAE,OAAO,CAAC,0BAA0B;QAChE,YAAY,EAAE,OAAO,CAAC,UAAU;KACjC,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IAC7E,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI;QACrC,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,EAAE,mBAAmB,EAAE,SAAS,EAAE,CAAC;IACvC,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,wCAAwC;QACrD,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,mBAAmB;QACnD,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;QAC7D,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAa5B,CAAC,CAAC,IAAI,CACJ,GAAG,EACH,UAAU,CAAC,wDAAwD,EACnE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,CAC9B,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,iCAAiC,CAAC,EACxD,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,wBAAwB,EAAE;QAC/D,KAAK,EAAE,0BAA0B;KAClC,CAAC,EACF,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAClE,CAAC"}