@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
@@ -15,7 +15,7 @@ export declare class AccountManagement extends ClientSDK {
15
15
  */
16
16
  getOrganizationDetails(request: operations.V3AccountmanagementOrgDetailsRequest, options?: RequestOptions): Promise<operations.V3AccountmanagementOrgDetailsResponse>;
17
17
  /**
18
- * Get organization credit details
18
+ * Get organization credit balance
19
19
  *
20
20
  * @remarks
21
21
  * Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
@@ -25,7 +25,7 @@ export declare class AccountManagement extends ClientSDK {
25
25
  * Get organization credit usage
26
26
  *
27
27
  * @remarks
28
- * 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.
28
+ * 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.
29
29
  */
30
30
  getOrganizationCreditUsage(request: operations.V3AccountmanagementOrgCreditsUsageRequest, options?: RequestOptions): Promise<operations.V3AccountmanagementOrgCreditsUsageResponse>;
31
31
  /**
@@ -63,18 +63,25 @@ export declare class AccountManagement extends ClientSDK {
63
63
  acceptHeaderOverride?: UpdateOrganizationMemberAcceptEnum;
64
64
  }): Promise<operations.V3AccountmanagementUpdateOrgMemberResponse | undefined>;
65
65
  /**
66
- * Get member credit usage
66
+ * Get organization member credit usage
67
67
  *
68
68
  * @remarks
69
- * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
69
+ * 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.
70
70
  */
71
71
  getMemberCreditUsage(request: operations.V3AccountmanagementMemberCreditsUsageRequest, options?: RequestOptions): Promise<operations.V3AccountmanagementMemberCreditsUsageResponse>;
72
72
  /**
73
- * Get Free user credit details
73
+ * Get Free user credit balance
74
74
  *
75
75
  * @remarks
76
- * 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.
76
+ * 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.
77
77
  */
78
78
  getUserCredits(options?: RequestOptions): Promise<operations.V3AccountmanagementUserCreditsResponse>;
79
+ /**
80
+ * Get Free user credit usage
81
+ *
82
+ * @remarks
83
+ * 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.
84
+ */
85
+ getUserCreditsUsage(request: operations.V3AccountmanagementUserCreditsUsageRequest, options?: RequestOptions): Promise<operations.V3AccountmanagementUserCreditsUsageResponse>;
79
86
  }
80
87
  //# sourceMappingURL=accountmanagement.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"accountmanagement.d.ts","sourceRoot":"","sources":["../src/sdk/accountmanagement.ts"],"names":[],"mappings":"AASA,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAE/D,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;OAKG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;IAQjE;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IAQpE;;;;;OAKG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;CAM9D"}
1
+ {"version":3,"file":"accountmanagement.d.ts","sourceRoot":"","sources":["../src/sdk/accountmanagement.ts"],"names":[],"mappings":"AAUA,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAE/D,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAEL,kCAAkC,EACnC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAG5D,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,uDAAuD,CAAC;AAE3G,qBAAa,iBAAkB,SAAQ,SAAS;IAC9C;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;OAKG;IACG,sBAAsB,CAC1B,OAAO,EAAE,UAAU,CAAC,oCAAoC,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,qCAAqC,CAAC;IAQ5D;;;;;OAKG;IACG,0BAA0B,CAC9B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,0CAA0C,CAAC;IAQjE;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,uBAAuB,CAC3B,OAAO,EAAE,UAAU,CAAC,wCAAwC,EAC5D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,yCAAyC,CAAC;IAQhE;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,wBAAwB,CAC5B,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GAAG;QACzB,oBAAoB,CAAC,EAAE,kCAAkC,CAAC;KAC3D,GACA,OAAO,CACR,UAAU,CAAC,0CAA0C,GAAG,SAAS,CAClE;IAQD;;;;;OAKG;IACG,oBAAoB,CACxB,OAAO,EAAE,UAAU,CAAC,4CAA4C,EAChE,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,6CAA6C,CAAC;IAQpE;;;;;OAKG;IACG,cAAc,CAClB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,sCAAsC,CAAC;IAO7D;;;;;OAKG;IACG,mBAAmB,CACvB,OAAO,EAAE,UAAU,CAAC,0CAA0C,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,UAAU,CAAC,2CAA2C,CAAC;CAOnE"}
@@ -9,6 +9,7 @@ const accountManagementGetOrganizationCredits_js_1 = require("../funcs/accountMa
9
9
  const accountManagementGetOrganizationCreditUsage_js_1 = require("../funcs/accountManagementGetOrganizationCreditUsage.js");
10
10
  const accountManagementGetOrganizationDetails_js_1 = require("../funcs/accountManagementGetOrganizationDetails.js");
11
11
  const accountManagementGetUserCredits_js_1 = require("../funcs/accountManagementGetUserCredits.js");
12
+ const accountManagementGetUserCreditsUsage_js_1 = require("../funcs/accountManagementGetUserCreditsUsage.js");
12
13
  const accountManagementInviteUserToOrganization_js_1 = require("../funcs/accountManagementInviteUserToOrganization.js");
13
14
  const accountManagementListOrganizationMembers_js_1 = require("../funcs/accountManagementListOrganizationMembers.js");
14
15
  const accountManagementRemoveOrganizationMember_js_1 = require("../funcs/accountManagementRemoveOrganizationMember.js");
@@ -32,7 +33,7 @@ class AccountManagement extends sdks_js_1.ClientSDK {
32
33
  return (0, fp_js_1.unwrapAsync)((0, accountManagementGetOrganizationDetails_js_1.accountManagementGetOrganizationDetails)(this, request, options));
33
34
  }
34
35
  /**
35
- * Get organization credit details
36
+ * Get organization credit balance
36
37
  *
37
38
  * @remarks
38
39
  * Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
@@ -44,7 +45,7 @@ class AccountManagement extends sdks_js_1.ClientSDK {
44
45
  * Get organization credit usage
45
46
  *
46
47
  * @remarks
47
- * 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.
48
+ * 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.
48
49
  */
49
50
  async getOrganizationCreditUsage(request, options) {
50
51
  return (0, fp_js_1.unwrapAsync)((0, accountManagementGetOrganizationCreditUsage_js_1.accountManagementGetOrganizationCreditUsage)(this, request, options));
@@ -86,23 +87,32 @@ class AccountManagement extends sdks_js_1.ClientSDK {
86
87
  return (0, fp_js_1.unwrapAsync)((0, accountManagementUpdateOrganizationMember_js_1.accountManagementUpdateOrganizationMember)(this, request, options));
87
88
  }
88
89
  /**
89
- * Get member credit usage
90
+ * Get organization member credit usage
90
91
  *
91
92
  * @remarks
92
- * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
93
+ * 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.
93
94
  */
94
95
  async getMemberCreditUsage(request, options) {
95
96
  return (0, fp_js_1.unwrapAsync)((0, accountManagementGetMemberCreditUsage_js_1.accountManagementGetMemberCreditUsage)(this, request, options));
96
97
  }
97
98
  /**
98
- * Get Free user credit details
99
+ * Get Free user credit balance
99
100
  *
100
101
  * @remarks
101
- * 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.
102
+ * 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.
102
103
  */
103
104
  async getUserCredits(options) {
104
105
  return (0, fp_js_1.unwrapAsync)((0, accountManagementGetUserCredits_js_1.accountManagementGetUserCredits)(this, options));
105
106
  }
107
+ /**
108
+ * Get Free user credit usage
109
+ *
110
+ * @remarks
111
+ * 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.
112
+ */
113
+ async getUserCreditsUsage(request, options) {
114
+ return (0, fp_js_1.unwrapAsync)((0, accountManagementGetUserCreditsUsage_js_1.accountManagementGetUserCreditsUsage)(this, request, options));
115
+ }
106
116
  }
107
117
  exports.AccountManagement = AccountManagement;
108
118
  //# sourceMappingURL=accountmanagement.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"accountmanagement.js","sourceRoot":"","sources":["../src/sdk/accountmanagement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gHAA0G;AAC1G,oHAA8G;AAC9G,4HAAsH;AACtH,oHAA8G;AAC9G,oGAA8F;AAC9F,wHAG+D;AAC/D,sHAAgH;AAChH,wHAG+D;AAC/D,wHAG+D;AAC/D,4CAA2D;AAE3D,0CAA6C;AAE7C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,MAAa,iBAAkB,SAAQ,mBAAS;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oFAAuC,EACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oFAAuC,EACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA6D,EAC7D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4FAA2C,EAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAgE,EAChE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gFAAqC,EACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AAnKD,8CAmKC"}
1
+ {"version":3,"file":"accountmanagement.js","sourceRoot":"","sources":["../src/sdk/accountmanagement.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,gHAA0G;AAC1G,oHAA8G;AAC9G,4HAAsH;AACtH,oHAA8G;AAC9G,oGAA8F;AAC9F,8GAAwG;AACxG,wHAG+D;AAC/D,sHAAgH;AAChH,wHAG+D;AAC/D,wHAG+D;AAC/D,4CAA2D;AAE3D,0CAA6C;AAE7C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,sHAA2G;AAAlG,kKAAA,kCAAkC,OAAA;AAE3C,MAAa,iBAAkB,SAAQ,mBAAS;IAC9C;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oFAAuC,EACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,sBAAsB,CAC1B,OAAwD,EACxD,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oFAAuC,EACxD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,0BAA0B,CAC9B,OAA6D,EAC7D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,4FAA2C,EAC5D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,uBAAuB,CAC3B,OAA4D,EAC5D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,sFAAwC,EACzD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,wBAAwB,CAC5B,OAA6D,EAC7D,OAEC;QAID,OAAO,IAAA,mBAAW,EAAC,IAAA,wFAAyC,EAC1D,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CACxB,OAAgE,EAChE,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,gFAAqC,EACtD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAClB,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,oEAA+B,EAChD,IAAI,EACJ,OAAO,CACR,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAA8D,EAC9D,OAAwB;QAExB,OAAO,IAAA,mBAAW,EAAC,IAAA,8EAAoC,EACrD,IAAI,EACJ,OAAO,EACP,OAAO,CACR,CAAC,CAAC;IACL,CAAC;CACF;AApLD,8CAoLC"}
@@ -7,21 +7,21 @@ export declare class Collections extends ClientSDK {
7
7
  * List collections
8
8
  *
9
9
  * @remarks
10
- * List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
10
+ * 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.
11
11
  */
12
12
  list(request: operations.V3CollectionsCrudListRequest, options?: RequestOptions): Promise<operations.V3CollectionsCrudListResponse>;
13
13
  /**
14
14
  * Create a collection
15
15
  *
16
16
  * @remarks
17
- * Create a new collection.
17
+ * Create a new collection.<br><br>This endpoint does not cost credits to execute.
18
18
  */
19
19
  create(request: operations.V3CollectionsCrudCreateRequest, options?: RequestOptions): Promise<operations.V3CollectionsCrudCreateResponse>;
20
20
  /**
21
21
  * Delete a collection
22
22
  *
23
23
  * @remarks
24
- * Delete a collection.
24
+ * Delete a collection.<br><br>This endpoint does not cost credits to execute.
25
25
  */
26
26
  delete(request: operations.V3CollectionsCrudDeleteRequest, options?: RequestOptions & {
27
27
  acceptHeaderOverride?: DeleteAcceptEnum;
@@ -30,21 +30,21 @@ export declare class Collections extends ClientSDK {
30
30
  * Get a collection
31
31
  *
32
32
  * @remarks
33
- * Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
33
+ * 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.
34
34
  */
35
35
  get(request: operations.V3CollectionsCrudGetRequest, options?: RequestOptions): Promise<operations.V3CollectionsCrudGetResponse>;
36
36
  /**
37
37
  * Update a collection
38
38
  *
39
39
  * @remarks
40
- * Update a collection's name, description, and/or query.
40
+ * Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
41
41
  */
42
42
  update(request: operations.V3CollectionsCrudUpdateRequest, options?: RequestOptions): Promise<operations.V3CollectionsCrudUpdateResponse>;
43
43
  /**
44
44
  * Get a collection's events
45
45
  *
46
46
  * @remarks
47
- * Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
47
+ * 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.
48
48
  */
49
49
  listEvents(request: operations.V3CollectionsListEventsRequest, options?: RequestOptions): Promise<operations.V3CollectionsListEventsResponse>;
50
50
  /**
@@ -21,7 +21,7 @@ class Collections extends sdks_js_1.ClientSDK {
21
21
  * List collections
22
22
  *
23
23
  * @remarks
24
- * List all collections for an organization. Retrieved information includes collection ID, name, query, description, status, and asset count.
24
+ * 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.
25
25
  */
26
26
  async list(request, options) {
27
27
  return (0, fp_js_1.unwrapAsync)((0, collectionsList_js_1.collectionsList)(this, request, options));
@@ -30,7 +30,7 @@ class Collections extends sdks_js_1.ClientSDK {
30
30
  * Create a collection
31
31
  *
32
32
  * @remarks
33
- * Create a new collection.
33
+ * Create a new collection.<br><br>This endpoint does not cost credits to execute.
34
34
  */
35
35
  async create(request, options) {
36
36
  return (0, fp_js_1.unwrapAsync)((0, collectionsCreate_js_1.collectionsCreate)(this, request, options));
@@ -39,7 +39,7 @@ class Collections extends sdks_js_1.ClientSDK {
39
39
  * Delete a collection
40
40
  *
41
41
  * @remarks
42
- * Delete a collection.
42
+ * Delete a collection.<br><br>This endpoint does not cost credits to execute.
43
43
  */
44
44
  async delete(request, options) {
45
45
  return (0, fp_js_1.unwrapAsync)((0, collectionsDelete_js_1.collectionsDelete)(this, request, options));
@@ -48,7 +48,7 @@ class Collections extends sdks_js_1.ClientSDK {
48
48
  * Get a collection
49
49
  *
50
50
  * @remarks
51
- * Retrieve information about a collection. Retrieved information includes its name, query, description, status, and asset count.
51
+ * 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.
52
52
  */
53
53
  async get(request, options) {
54
54
  return (0, fp_js_1.unwrapAsync)((0, collectionsGet_js_1.collectionsGet)(this, request, options));
@@ -57,7 +57,7 @@ class Collections extends sdks_js_1.ClientSDK {
57
57
  * Update a collection
58
58
  *
59
59
  * @remarks
60
- * Update a collection's name, description, and/or query.
60
+ * Update a collection's name, description, and/or query.<br><br>This endpoint does not cost credits to execute.
61
61
  */
62
62
  async update(request, options) {
63
63
  return (0, fp_js_1.unwrapAsync)((0, collectionsUpdate_js_1.collectionsUpdate)(this, request, options));
@@ -66,7 +66,7 @@ class Collections extends sdks_js_1.ClientSDK {
66
66
  * Get a collection's events
67
67
  *
68
68
  * @remarks
69
- * Retrieve the event history for a collection. This includes the addition or removal of assets as well as collection status changes.
69
+ * 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.
70
70
  */
71
71
  async listEvents(request, options) {
72
72
  return (0, fp_js_1.unwrapAsync)((0, collectionsListEvents_js_1.collectionsListEvents)(this, request, options));
@@ -26,7 +26,7 @@ export declare class ThreatHunting extends ClientSDK {
26
26
  * List active threats
27
27
  *
28
28
  * @remarks
29
- * 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).
29
+ * 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.
30
30
  */
31
31
  listThreats(request: operations.V3ThreathuntingThreatsListRequest, options?: RequestOptions): Promise<operations.V3ThreathuntingThreatsListResponse>;
32
32
  /**
@@ -43,7 +43,7 @@ class ThreatHunting extends sdks_js_1.ClientSDK {
43
43
  * List active threats
44
44
  *
45
45
  * @remarks
46
- * 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).
46
+ * 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.
47
47
  */
48
48
  async listThreats(request, options) {
49
49
  return (0, fp_js_1.unwrapAsync)((0, threatHuntingListThreats_js_1.threatHuntingListThreats)(this, request, options));
@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
26
26
  import { Result } from "../types/fp.js";
27
27
 
28
28
  /**
29
- * Get member credit usage
29
+ * Get organization member credit usage
30
30
  *
31
31
  * @remarks
32
- * Retrieve credit consumption information for an organization member for a specific day.<br><br>This endpoint does not cost any credits to execute.
32
+ * 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.
33
33
  */
34
34
  export function accountManagementGetMemberCreditUsage(
35
35
  client: SDKCore,
@@ -109,6 +109,9 @@ async function $do(
109
109
 
110
110
  const query = encodeFormQuery({
111
111
  "date": payload.date,
112
+ "end_date": payload.end_date,
113
+ "granularity": payload.granularity,
114
+ "start_date": payload.start_date,
112
115
  }, { explode: false });
113
116
 
114
117
  const headers = new Headers(compactMap({
@@ -154,7 +157,7 @@ async function $do(
154
157
 
155
158
  const doResult = await client._do(req, {
156
159
  context,
157
- errorCodes: ["400", "401", "403", "404", "422", "4XX", "5XX"],
160
+ errorCodes: ["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
158
161
  retryConfig: context.retryConfig,
159
162
  retryCodes: context.retryCodes,
160
163
  });
@@ -189,6 +192,9 @@ async function $do(
189
192
  M.jsonErr([400, 403, 404, 422], errors.ErrorModel$inboundSchema, {
190
193
  ctype: "application/problem+json",
191
194
  }),
195
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
196
+ ctype: "application/problem+json",
197
+ }),
192
198
  M.fail("4XX"),
193
199
  M.fail("5XX"),
194
200
  )(response, req, { extraFields: responseFields });
@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
29
29
  * Get organization credit usage
30
30
  *
31
31
  * @remarks
32
- * 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.
32
+ * 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.
33
33
  */
34
34
  export function accountManagementGetOrganizationCreditUsage(
35
35
  client: SDKCore,
@@ -106,6 +106,10 @@ async function $do(
106
106
 
107
107
  const query = encodeFormQuery({
108
108
  "date": payload.date,
109
+ "end_date": payload.end_date,
110
+ "granularity": payload.granularity,
111
+ "include_consumer_breakdown": payload.include_consumer_breakdown,
112
+ "start_date": payload.start_date,
109
113
  }, { explode: false });
110
114
 
111
115
  const headers = new Headers(compactMap({
@@ -151,7 +155,7 @@ async function $do(
151
155
 
152
156
  const doResult = await client._do(req, {
153
157
  context,
154
- errorCodes: ["400", "401", "403", "404", "422", "4XX", "5XX"],
158
+ errorCodes: ["400", "401", "403", "404", "422", "4XX", "500", "5XX"],
155
159
  retryConfig: context.retryConfig,
156
160
  retryCodes: context.retryCodes,
157
161
  });
@@ -186,6 +190,9 @@ async function $do(
186
190
  M.jsonErr([400, 403, 404, 422], errors.ErrorModel$inboundSchema, {
187
191
  ctype: "application/problem+json",
188
192
  }),
193
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
194
+ ctype: "application/problem+json",
195
+ }),
189
196
  M.fail("4XX"),
190
197
  M.fail("5XX"),
191
198
  )(response, req, { extraFields: responseFields });
@@ -26,7 +26,7 @@ import { APICall, APIPromise } from "../types/async.js";
26
26
  import { Result } from "../types/fp.js";
27
27
 
28
28
  /**
29
- * Get organization credit details
29
+ * Get organization credit balance
30
30
  *
31
31
  * @remarks
32
32
  * Retrieve credit balance and expiration information for an organization. <br><br>Credits expire 12 months after they are acquired.<br><br>This endpoint does not cost any credits to execute.
@@ -146,7 +146,7 @@ async function $do(
146
146
 
147
147
  const doResult = await client._do(req, {
148
148
  context,
149
- errorCodes: ["401", "403", "404", "422", "4XX", "5XX"],
149
+ errorCodes: ["401", "403", "404", "422", "4XX", "500", "5XX"],
150
150
  retryConfig: context.retryConfig,
151
151
  retryCodes: context.retryCodes,
152
152
  });
@@ -181,6 +181,9 @@ async function $do(
181
181
  M.jsonErr([403, 404, 422], errors.ErrorModel$inboundSchema, {
182
182
  ctype: "application/problem+json",
183
183
  }),
184
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
185
+ ctype: "application/problem+json",
186
+ }),
184
187
  M.fail("4XX"),
185
188
  M.fail("5XX"),
186
189
  )(response, req, { extraFields: responseFields });
@@ -151,7 +151,7 @@ async function $do(
151
151
 
152
152
  const doResult = await client._do(req, {
153
153
  context,
154
- errorCodes: ["401", "403", "404", "422", "4XX", "5XX"],
154
+ errorCodes: ["401", "403", "404", "422", "4XX", "500", "5XX"],
155
155
  retryConfig: context.retryConfig,
156
156
  retryCodes: context.retryCodes,
157
157
  });
@@ -186,6 +186,9 @@ async function $do(
186
186
  M.jsonErr([403, 404, 422], errors.ErrorModel$inboundSchema, {
187
187
  ctype: "application/problem+json",
188
188
  }),
189
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
190
+ ctype: "application/problem+json",
191
+ }),
189
192
  M.fail("4XX"),
190
193
  M.fail("5XX"),
191
194
  )(response, req, { extraFields: responseFields });
@@ -24,10 +24,10 @@ import { APICall, APIPromise } from "../types/async.js";
24
24
  import { Result } from "../types/fp.js";
25
25
 
26
26
  /**
27
- * Get Free user credit details
27
+ * Get Free user credit balance
28
28
  *
29
29
  * @remarks
30
- * 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.
30
+ * 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.
31
31
  */
32
32
  export function accountManagementGetUserCredits(
33
33
  client: SDKCore,
@@ -117,7 +117,7 @@ async function $do(
117
117
 
118
118
  const doResult = await client._do(req, {
119
119
  context,
120
- errorCodes: ["401", "404", "4XX", "5XX"],
120
+ errorCodes: ["401", "404", "4XX", "500", "5XX"],
121
121
  retryConfig: context.retryConfig,
122
122
  retryCodes: context.retryCodes,
123
123
  });
@@ -152,6 +152,9 @@ async function $do(
152
152
  M.jsonErr(404, errors.ErrorModel$inboundSchema, {
153
153
  ctype: "application/problem+json",
154
154
  }),
155
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
156
+ ctype: "application/problem+json",
157
+ }),
155
158
  M.fail("4XX"),
156
159
  M.fail("5XX"),
157
160
  )(response, req, { extraFields: responseFields });
@@ -0,0 +1,193 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { SDKCore } from "../core.js";
6
+ import { encodeFormQuery } from "../lib/encodings.js";
7
+ import * as M from "../lib/matchers.js";
8
+ import { compactMap } from "../lib/primitives.js";
9
+ import { safeParse } from "../lib/schemas.js";
10
+ import { RequestOptions } from "../lib/sdks.js";
11
+ import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
12
+ import { pathToFunc } from "../lib/url.js";
13
+ import {
14
+ ConnectionError,
15
+ InvalidRequestError,
16
+ RequestAbortedError,
17
+ RequestTimeoutError,
18
+ UnexpectedClientError,
19
+ } from "../models/errors/httpclienterrors.js";
20
+ import * as errors from "../models/errors/index.js";
21
+ import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
22
+ import { SDKBaseError } from "../models/errors/sdkbaseerror.js";
23
+ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
24
+ import * as operations from "../models/operations/index.js";
25
+ import { APICall, APIPromise } from "../types/async.js";
26
+ import { Result } from "../types/fp.js";
27
+
28
+ /**
29
+ * Get Free user credit usage
30
+ *
31
+ * @remarks
32
+ * 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.
33
+ */
34
+ export function accountManagementGetUserCreditsUsage(
35
+ client: SDKCore,
36
+ request: operations.V3AccountmanagementUserCreditsUsageRequest,
37
+ options?: RequestOptions,
38
+ ): APIPromise<
39
+ Result<
40
+ operations.V3AccountmanagementUserCreditsUsageResponse,
41
+ | errors.AuthenticationError
42
+ | errors.ErrorModel
43
+ | SDKBaseError
44
+ | ResponseValidationError
45
+ | ConnectionError
46
+ | RequestAbortedError
47
+ | RequestTimeoutError
48
+ | InvalidRequestError
49
+ | UnexpectedClientError
50
+ | SDKValidationError
51
+ >
52
+ > {
53
+ return new APIPromise($do(
54
+ client,
55
+ request,
56
+ options,
57
+ ));
58
+ }
59
+
60
+ async function $do(
61
+ client: SDKCore,
62
+ request: operations.V3AccountmanagementUserCreditsUsageRequest,
63
+ options?: RequestOptions,
64
+ ): Promise<
65
+ [
66
+ Result<
67
+ operations.V3AccountmanagementUserCreditsUsageResponse,
68
+ | errors.AuthenticationError
69
+ | errors.ErrorModel
70
+ | SDKBaseError
71
+ | ResponseValidationError
72
+ | ConnectionError
73
+ | RequestAbortedError
74
+ | RequestTimeoutError
75
+ | InvalidRequestError
76
+ | UnexpectedClientError
77
+ | SDKValidationError
78
+ >,
79
+ APICall,
80
+ ]
81
+ > {
82
+ const parsed = safeParse(
83
+ request,
84
+ (value) =>
85
+ operations.V3AccountmanagementUserCreditsUsageRequest$outboundSchema
86
+ .parse(value),
87
+ "Input validation failed",
88
+ );
89
+ if (!parsed.ok) {
90
+ return [parsed, { status: "invalid" }];
91
+ }
92
+ const payload = parsed.value;
93
+ const body = null;
94
+
95
+ const path = pathToFunc("/v3/accounts/users/credits/usage")();
96
+
97
+ const query = encodeFormQuery({
98
+ "date": payload.date,
99
+ "end_date": payload.end_date,
100
+ "granularity": payload.granularity,
101
+ "start_date": payload.start_date,
102
+ }, { explode: false });
103
+
104
+ const headers = new Headers(compactMap({
105
+ Accept: "application/json",
106
+ }));
107
+
108
+ const secConfig = await extractSecurity(client._options.personalAccessToken);
109
+ const securityInput = secConfig == null
110
+ ? {}
111
+ : { personalAccessToken: secConfig };
112
+ const requestSecurity = resolveGlobalSecurity(securityInput);
113
+
114
+ const context = {
115
+ options: client._options,
116
+ baseURL: options?.serverURL ?? client._baseURL ?? "",
117
+ operationID: "v3-accountmanagement-user-credits-usage",
118
+ oAuth2Scopes: null,
119
+
120
+ resolvedSecurity: requestSecurity,
121
+
122
+ securitySource: client._options.personalAccessToken,
123
+ retryConfig: options?.retries
124
+ || client._options.retryConfig
125
+ || { strategy: "none" },
126
+ retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
127
+ };
128
+
129
+ const requestRes = client._createRequest(context, {
130
+ security: requestSecurity,
131
+ method: "GET",
132
+ baseURL: options?.serverURL,
133
+ path: path,
134
+ headers: headers,
135
+ query: query,
136
+ body: body,
137
+ userAgent: client._options.userAgent,
138
+ timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
139
+ }, options);
140
+ if (!requestRes.ok) {
141
+ return [requestRes, { status: "invalid" }];
142
+ }
143
+ const req = requestRes.value;
144
+
145
+ const doResult = await client._do(req, {
146
+ context,
147
+ errorCodes: ["400", "401", "404", "4XX", "500", "5XX"],
148
+ retryConfig: context.retryConfig,
149
+ retryCodes: context.retryCodes,
150
+ });
151
+ if (!doResult.ok) {
152
+ return [doResult, { status: "request-error", request: req }];
153
+ }
154
+ const response = doResult.value;
155
+
156
+ const responseFields = {
157
+ HttpMeta: { Response: response, Request: req },
158
+ };
159
+
160
+ const [result] = await M.match<
161
+ operations.V3AccountmanagementUserCreditsUsageResponse,
162
+ | errors.AuthenticationError
163
+ | errors.ErrorModel
164
+ | SDKBaseError
165
+ | ResponseValidationError
166
+ | ConnectionError
167
+ | RequestAbortedError
168
+ | RequestTimeoutError
169
+ | InvalidRequestError
170
+ | UnexpectedClientError
171
+ | SDKValidationError
172
+ >(
173
+ M.json(
174
+ 200,
175
+ operations.V3AccountmanagementUserCreditsUsageResponse$inboundSchema,
176
+ { hdrs: true, key: "Result" },
177
+ ),
178
+ M.jsonErr(401, errors.AuthenticationError$inboundSchema),
179
+ M.jsonErr([400, 404], errors.ErrorModel$inboundSchema, {
180
+ ctype: "application/problem+json",
181
+ }),
182
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
183
+ ctype: "application/problem+json",
184
+ }),
185
+ M.fail("4XX"),
186
+ M.fail("5XX"),
187
+ )(response, req, { extraFields: responseFields });
188
+ if (!result.ok) {
189
+ return [result, { status: "complete", request: req, response }];
190
+ }
191
+
192
+ return [result, { status: "complete", request: req, response }];
193
+ }
@@ -159,7 +159,7 @@ async function $do(
159
159
 
160
160
  const doResult = await client._do(req, {
161
161
  context,
162
- errorCodes: ["401", "403", "404", "422", "4XX", "5XX"],
162
+ errorCodes: ["401", "403", "404", "409", "422", "4XX", "500", "5XX"],
163
163
  retryConfig: context.retryConfig,
164
164
  retryCodes: context.retryCodes,
165
165
  });
@@ -192,7 +192,10 @@ async function $do(
192
192
  { hdrs: true },
193
193
  ),
194
194
  M.jsonErr(401, errors.AuthenticationError$inboundSchema),
195
- M.jsonErr([403, 404, 422], errors.ErrorModel$inboundSchema, {
195
+ M.jsonErr([403, 404, 409, 422], errors.ErrorModel$inboundSchema, {
196
+ ctype: "application/problem+json",
197
+ }),
198
+ M.jsonErr(500, errors.ErrorModel$inboundSchema, {
196
199
  ctype: "application/problem+json",
197
200
  }),
198
201
  M.fail("4XX"),