@censys/platform-sdk 0.10.3 → 0.10.5

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 (269) hide show
  1. package/README.md +23 -2
  2. package/docs/sdks/adversaryinvestigation/README.md +625 -0
  3. package/docs/sdks/threathunting/README.md +91 -8
  4. package/funcs/accountManagementGetMemberCreditUsage.d.ts.map +1 -1
  5. package/funcs/accountManagementGetMemberCreditUsage.js +2 -1
  6. package/funcs/accountManagementGetMemberCreditUsage.js.map +1 -1
  7. package/funcs/accountManagementGetOrganizationCreditUsage.d.ts.map +1 -1
  8. package/funcs/accountManagementGetOrganizationCreditUsage.js +2 -1
  9. package/funcs/accountManagementGetOrganizationCreditUsage.js.map +1 -1
  10. package/funcs/accountManagementGetOrganizationCredits.d.ts.map +1 -1
  11. package/funcs/accountManagementGetOrganizationCredits.js +2 -1
  12. package/funcs/accountManagementGetOrganizationCredits.js.map +1 -1
  13. package/funcs/accountManagementGetOrganizationDetails.d.ts.map +1 -1
  14. package/funcs/accountManagementGetOrganizationDetails.js +2 -1
  15. package/funcs/accountManagementGetOrganizationDetails.js.map +1 -1
  16. package/funcs/accountManagementGetUserCredits.d.ts.map +1 -1
  17. package/funcs/accountManagementGetUserCredits.js +2 -1
  18. package/funcs/accountManagementGetUserCredits.js.map +1 -1
  19. package/funcs/accountManagementGetUserCreditsUsage.d.ts.map +1 -1
  20. package/funcs/accountManagementGetUserCreditsUsage.js +2 -1
  21. package/funcs/accountManagementGetUserCreditsUsage.js.map +1 -1
  22. package/funcs/accountManagementInviteUserToOrganization.d.ts.map +1 -1
  23. package/funcs/accountManagementInviteUserToOrganization.js +2 -1
  24. package/funcs/accountManagementInviteUserToOrganization.js.map +1 -1
  25. package/funcs/accountManagementListOrganizationMembers.d.ts.map +1 -1
  26. package/funcs/accountManagementListOrganizationMembers.js +2 -1
  27. package/funcs/accountManagementListOrganizationMembers.js.map +1 -1
  28. package/funcs/accountManagementRemoveOrganizationMember.d.ts.map +1 -1
  29. package/funcs/accountManagementRemoveOrganizationMember.js +2 -1
  30. package/funcs/accountManagementRemoveOrganizationMember.js.map +1 -1
  31. package/funcs/accountManagementUpdateOrganizationMember.d.ts.map +1 -1
  32. package/funcs/accountManagementUpdateOrganizationMember.js +2 -1
  33. package/funcs/accountManagementUpdateOrganizationMember.js.map +1 -1
  34. package/funcs/collectionsAggregate.d.ts.map +1 -1
  35. package/funcs/collectionsAggregate.js +2 -1
  36. package/funcs/collectionsAggregate.js.map +1 -1
  37. package/funcs/collectionsCreate.d.ts.map +1 -1
  38. package/funcs/collectionsCreate.js +2 -1
  39. package/funcs/collectionsCreate.js.map +1 -1
  40. package/funcs/collectionsDelete.d.ts.map +1 -1
  41. package/funcs/collectionsDelete.js +2 -1
  42. package/funcs/collectionsDelete.js.map +1 -1
  43. package/funcs/collectionsGet.d.ts.map +1 -1
  44. package/funcs/collectionsGet.js +2 -1
  45. package/funcs/collectionsGet.js.map +1 -1
  46. package/funcs/collectionsList.d.ts.map +1 -1
  47. package/funcs/collectionsList.js +2 -1
  48. package/funcs/collectionsList.js.map +1 -1
  49. package/funcs/collectionsListEvents.d.ts.map +1 -1
  50. package/funcs/collectionsListEvents.js +2 -1
  51. package/funcs/collectionsListEvents.js.map +1 -1
  52. package/funcs/collectionsSearch.d.ts.map +1 -1
  53. package/funcs/collectionsSearch.js +2 -1
  54. package/funcs/collectionsSearch.js.map +1 -1
  55. package/funcs/collectionsUpdate.d.ts.map +1 -1
  56. package/funcs/collectionsUpdate.js +2 -1
  57. package/funcs/collectionsUpdate.js.map +1 -1
  58. package/funcs/globalDataAggregate.d.ts.map +1 -1
  59. package/funcs/globalDataAggregate.js +2 -1
  60. package/funcs/globalDataAggregate.js.map +1 -1
  61. package/funcs/globalDataConvertLegacySearchQueries.d.ts.map +1 -1
  62. package/funcs/globalDataConvertLegacySearchQueries.js +2 -1
  63. package/funcs/globalDataConvertLegacySearchQueries.js.map +1 -1
  64. package/funcs/globalDataCreateTrackedScan.d.ts.map +1 -1
  65. package/funcs/globalDataCreateTrackedScan.js +2 -1
  66. package/funcs/globalDataCreateTrackedScan.js.map +1 -1
  67. package/funcs/globalDataGetCertificate.d.ts.map +1 -1
  68. package/funcs/globalDataGetCertificate.js +2 -1
  69. package/funcs/globalDataGetCertificate.js.map +1 -1
  70. package/funcs/globalDataGetCertificateRaw.d.ts.map +1 -1
  71. package/funcs/globalDataGetCertificateRaw.js +2 -1
  72. package/funcs/globalDataGetCertificateRaw.js.map +1 -1
  73. package/funcs/globalDataGetCertificates.d.ts.map +1 -1
  74. package/funcs/globalDataGetCertificates.js +2 -1
  75. package/funcs/globalDataGetCertificates.js.map +1 -1
  76. package/funcs/globalDataGetCertificatesRaw.d.ts.map +1 -1
  77. package/funcs/globalDataGetCertificatesRaw.js +2 -1
  78. package/funcs/globalDataGetCertificatesRaw.js.map +1 -1
  79. package/funcs/globalDataGetHost.d.ts.map +1 -1
  80. package/funcs/globalDataGetHost.js +2 -1
  81. package/funcs/globalDataGetHost.js.map +1 -1
  82. package/funcs/globalDataGetHostTimeline.d.ts.map +1 -1
  83. package/funcs/globalDataGetHostTimeline.js +2 -1
  84. package/funcs/globalDataGetHostTimeline.js.map +1 -1
  85. package/funcs/globalDataGetHosts.d.ts.map +1 -1
  86. package/funcs/globalDataGetHosts.js +2 -1
  87. package/funcs/globalDataGetHosts.js.map +1 -1
  88. package/funcs/globalDataGetTrackedScan.d.ts.map +1 -1
  89. package/funcs/globalDataGetTrackedScan.js +2 -1
  90. package/funcs/globalDataGetTrackedScan.js.map +1 -1
  91. package/funcs/globalDataGetWebProperties.d.ts.map +1 -1
  92. package/funcs/globalDataGetWebProperties.js +2 -1
  93. package/funcs/globalDataGetWebProperties.js.map +1 -1
  94. package/funcs/globalDataGetWebProperty.d.ts.map +1 -1
  95. package/funcs/globalDataGetWebProperty.js +2 -1
  96. package/funcs/globalDataGetWebProperty.js.map +1 -1
  97. package/funcs/globalDataListServicesOnHost.d.ts.map +1 -1
  98. package/funcs/globalDataListServicesOnHost.js +2 -1
  99. package/funcs/globalDataListServicesOnHost.js.map +1 -1
  100. package/funcs/globalDataSearch.d.ts.map +1 -1
  101. package/funcs/globalDataSearch.js +2 -1
  102. package/funcs/globalDataSearch.js.map +1 -1
  103. package/funcs/threatHuntingCreateCenseyeJob.d.ts +1 -1
  104. package/funcs/threatHuntingCreateCenseyeJob.d.ts.map +1 -1
  105. package/funcs/threatHuntingCreateCenseyeJob.js +3 -2
  106. package/funcs/threatHuntingCreateCenseyeJob.js.map +1 -1
  107. package/funcs/threatHuntingCreateTrackedScan.d.ts +1 -1
  108. package/funcs/threatHuntingCreateTrackedScan.d.ts.map +1 -1
  109. package/funcs/threatHuntingCreateTrackedScan.js +3 -2
  110. package/funcs/threatHuntingCreateTrackedScan.js.map +1 -1
  111. package/funcs/threatHuntingGetCenseyeJob.d.ts +1 -1
  112. package/funcs/threatHuntingGetCenseyeJob.d.ts.map +1 -1
  113. package/funcs/threatHuntingGetCenseyeJob.js +3 -2
  114. package/funcs/threatHuntingGetCenseyeJob.js.map +1 -1
  115. package/funcs/threatHuntingGetCenseyeJobResults.d.ts +1 -1
  116. package/funcs/threatHuntingGetCenseyeJobResults.d.ts.map +1 -1
  117. package/funcs/threatHuntingGetCenseyeJobResults.js +3 -2
  118. package/funcs/threatHuntingGetCenseyeJobResults.js.map +1 -1
  119. package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts +1 -1
  120. package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts.map +1 -1
  121. package/funcs/threatHuntingGetHostObservationsWithCertificate.js +3 -2
  122. package/funcs/threatHuntingGetHostObservationsWithCertificate.js.map +1 -1
  123. package/funcs/threatHuntingGetTrackedScanThreatHunting.d.ts.map +1 -1
  124. package/funcs/threatHuntingGetTrackedScanThreatHunting.js +2 -1
  125. package/funcs/threatHuntingGetTrackedScanThreatHunting.js.map +1 -1
  126. package/funcs/threatHuntingListCenseyeJobs.d.ts +18 -0
  127. package/funcs/threatHuntingListCenseyeJobs.d.ts.map +1 -0
  128. package/funcs/threatHuntingListCenseyeJobs.js +134 -0
  129. package/funcs/threatHuntingListCenseyeJobs.js.map +1 -0
  130. package/funcs/threatHuntingListThreats.d.ts +1 -1
  131. package/funcs/threatHuntingListThreats.d.ts.map +1 -1
  132. package/funcs/threatHuntingListThreats.js +3 -2
  133. package/funcs/threatHuntingListThreats.js.map +1 -1
  134. package/funcs/threatHuntingValueCounts.d.ts +1 -1
  135. package/funcs/threatHuntingValueCounts.d.ts.map +1 -1
  136. package/funcs/threatHuntingValueCounts.js +3 -2
  137. package/funcs/threatHuntingValueCounts.js.map +1 -1
  138. package/jsr.json +1 -1
  139. package/lib/config.d.ts +4 -4
  140. package/lib/config.js +4 -4
  141. package/lib/encodings.d.ts +1 -0
  142. package/lib/encodings.d.ts.map +1 -1
  143. package/lib/encodings.js +7 -0
  144. package/lib/encodings.js.map +1 -1
  145. package/lib/sdks.d.ts +1 -1
  146. package/lib/sdks.d.ts.map +1 -1
  147. package/lib/sdks.js +2 -4
  148. package/lib/sdks.js.map +1 -1
  149. package/models/components/censeyejobslistresponse.d.ts +18 -0
  150. package/models/components/censeyejobslistresponse.d.ts.map +1 -0
  151. package/models/components/censeyejobslistresponse.js +57 -0
  152. package/models/components/censeyejobslistresponse.js.map +1 -0
  153. package/models/components/endpointscan.d.ts +2 -0
  154. package/models/components/endpointscan.d.ts.map +1 -1
  155. package/models/components/endpointscan.js +2 -0
  156. package/models/components/endpointscan.js.map +1 -1
  157. package/models/components/endpointscanstate.d.ts +2 -0
  158. package/models/components/endpointscanstate.d.ts.map +1 -1
  159. package/models/components/endpointscanstate.js +2 -0
  160. package/models/components/endpointscanstate.js.map +1 -1
  161. package/models/components/greynoise.d.ts +4 -0
  162. package/models/components/greynoise.d.ts.map +1 -1
  163. package/models/components/greynoise.js +6 -0
  164. package/models/components/greynoise.js.map +1 -1
  165. package/models/components/index.d.ts +6 -0
  166. package/models/components/index.d.ts.map +1 -1
  167. package/models/components/index.js +6 -0
  168. package/models/components/index.js.map +1 -1
  169. package/models/components/mcp.d.ts +18 -0
  170. package/models/components/mcp.d.ts.map +1 -0
  171. package/models/components/mcp.js +66 -0
  172. package/models/components/mcp.js.map +1 -0
  173. package/models/components/mcpprompt.d.ts +10 -0
  174. package/models/components/mcpprompt.d.ts.map +1 -0
  175. package/models/components/mcpprompt.js +50 -0
  176. package/models/components/mcpprompt.js.map +1 -0
  177. package/models/components/mcpresource.d.ts +14 -0
  178. package/models/components/mcpresource.d.ts.map +1 -0
  179. package/models/components/mcpresource.js +59 -0
  180. package/models/components/mcpresource.js.map +1 -0
  181. package/models/components/mcptool.d.ts +11 -0
  182. package/models/components/mcptool.d.ts.map +1 -0
  183. package/models/components/mcptool.js +51 -0
  184. package/models/components/mcptool.js.map +1 -0
  185. package/models/components/responseenvelopecenseyejobslistresponse.d.ts +11 -0
  186. package/models/components/responseenvelopecenseyejobslistresponse.d.ts.map +1 -0
  187. package/models/components/responseenvelopecenseyejobslistresponse.js +51 -0
  188. package/models/components/responseenvelopecenseyejobslistresponse.js.map +1 -0
  189. package/models/operations/index.d.ts +1 -0
  190. package/models/operations/index.d.ts.map +1 -1
  191. package/models/operations/index.js +1 -0
  192. package/models/operations/index.js.map +1 -1
  193. package/models/operations/v3threathuntingcenseyejobslist.d.ts +55 -0
  194. package/models/operations/v3threathuntingcenseyejobslist.d.ts.map +1 -0
  195. package/models/operations/v3threathuntingcenseyejobslist.js +80 -0
  196. package/models/operations/v3threathuntingcenseyejobslist.js.map +1 -0
  197. package/package.json +1 -1
  198. package/sdk/adversaryinvestigation.d.ts +54 -0
  199. package/sdk/adversaryinvestigation.d.ts.map +1 -0
  200. package/sdk/adversaryinvestigation.js +82 -0
  201. package/sdk/adversaryinvestigation.js.map +1 -0
  202. package/sdk/sdk.d.ts +3 -0
  203. package/sdk/sdk.d.ts.map +1 -1
  204. package/sdk/sdk.js +4 -0
  205. package/sdk/sdk.js.map +1 -1
  206. package/sdk/threathunting.d.ts +14 -7
  207. package/sdk/threathunting.d.ts.map +1 -1
  208. package/sdk/threathunting.js +17 -7
  209. package/sdk/threathunting.js.map +1 -1
  210. package/src/funcs/accountManagementGetMemberCreditUsage.ts +3 -1
  211. package/src/funcs/accountManagementGetOrganizationCreditUsage.ts +3 -1
  212. package/src/funcs/accountManagementGetOrganizationCredits.ts +3 -1
  213. package/src/funcs/accountManagementGetOrganizationDetails.ts +3 -1
  214. package/src/funcs/accountManagementGetUserCredits.ts +3 -1
  215. package/src/funcs/accountManagementGetUserCreditsUsage.ts +3 -1
  216. package/src/funcs/accountManagementInviteUserToOrganization.ts +3 -1
  217. package/src/funcs/accountManagementListOrganizationMembers.ts +3 -1
  218. package/src/funcs/accountManagementRemoveOrganizationMember.ts +3 -1
  219. package/src/funcs/accountManagementUpdateOrganizationMember.ts +3 -1
  220. package/src/funcs/collectionsAggregate.ts +3 -1
  221. package/src/funcs/collectionsCreate.ts +3 -1
  222. package/src/funcs/collectionsDelete.ts +3 -1
  223. package/src/funcs/collectionsGet.ts +3 -1
  224. package/src/funcs/collectionsList.ts +3 -1
  225. package/src/funcs/collectionsListEvents.ts +3 -1
  226. package/src/funcs/collectionsSearch.ts +3 -1
  227. package/src/funcs/collectionsUpdate.ts +3 -1
  228. package/src/funcs/globalDataAggregate.ts +3 -1
  229. package/src/funcs/globalDataConvertLegacySearchQueries.ts +3 -1
  230. package/src/funcs/globalDataCreateTrackedScan.ts +3 -1
  231. package/src/funcs/globalDataGetCertificate.ts +3 -1
  232. package/src/funcs/globalDataGetCertificateRaw.ts +3 -1
  233. package/src/funcs/globalDataGetCertificates.ts +3 -1
  234. package/src/funcs/globalDataGetCertificatesRaw.ts +3 -1
  235. package/src/funcs/globalDataGetHost.ts +3 -1
  236. package/src/funcs/globalDataGetHostTimeline.ts +3 -1
  237. package/src/funcs/globalDataGetHosts.ts +3 -1
  238. package/src/funcs/globalDataGetTrackedScan.ts +3 -1
  239. package/src/funcs/globalDataGetWebProperties.ts +3 -1
  240. package/src/funcs/globalDataGetWebProperty.ts +3 -1
  241. package/src/funcs/globalDataListServicesOnHost.ts +3 -1
  242. package/src/funcs/globalDataSearch.ts +3 -1
  243. package/src/funcs/threatHuntingCreateCenseyeJob.ts +4 -2
  244. package/src/funcs/threatHuntingCreateTrackedScan.ts +4 -2
  245. package/src/funcs/threatHuntingGetCenseyeJob.ts +4 -2
  246. package/src/funcs/threatHuntingGetCenseyeJobResults.ts +4 -2
  247. package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +4 -2
  248. package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +3 -1
  249. package/src/funcs/threatHuntingListCenseyeJobs.ts +199 -0
  250. package/src/funcs/threatHuntingListThreats.ts +4 -2
  251. package/src/funcs/threatHuntingValueCounts.ts +4 -2
  252. package/src/lib/config.ts +4 -4
  253. package/src/lib/encodings.ts +9 -0
  254. package/src/lib/sdks.ts +3 -6
  255. package/src/models/components/censeyejobslistresponse.ts +45 -0
  256. package/src/models/components/endpointscan.ts +3 -0
  257. package/src/models/components/endpointscanstate.ts +3 -0
  258. package/src/models/components/greynoise.ts +10 -0
  259. package/src/models/components/index.ts +6 -0
  260. package/src/models/components/mcp.ts +48 -0
  261. package/src/models/components/mcpprompt.ts +31 -0
  262. package/src/models/components/mcpresource.ts +44 -0
  263. package/src/models/components/mcptool.ts +30 -0
  264. package/src/models/components/responseenvelopecenseyejobslistresponse.ts +41 -0
  265. package/src/models/operations/index.ts +1 -0
  266. package/src/models/operations/v3threathuntingcenseyejobslist.ts +115 -0
  267. package/src/sdk/adversaryinvestigation.ts +138 -0
  268. package/src/sdk/sdk.ts +8 -0
  269. package/src/sdk/threathunting.ts +25 -7
@@ -0,0 +1,31 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type McpPrompt = {
11
+ name?: string | undefined;
12
+ };
13
+
14
+ /** @internal */
15
+ export const McpPrompt$inboundSchema: z.ZodType<
16
+ McpPrompt,
17
+ z.ZodTypeDef,
18
+ unknown
19
+ > = z.object({
20
+ name: z.string().optional(),
21
+ });
22
+
23
+ export function mcpPromptFromJSON(
24
+ jsonString: string,
25
+ ): SafeParseResult<McpPrompt, SDKValidationError> {
26
+ return safeParse(
27
+ jsonString,
28
+ (x) => McpPrompt$inboundSchema.parse(JSON.parse(x)),
29
+ `Failed to parse 'McpPrompt' from JSON`,
30
+ );
31
+ }
@@ -0,0 +1,44 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ export type McpResource = {
12
+ content?: string | undefined;
13
+ description?: string | undefined;
14
+ mimeType?: string | undefined;
15
+ name?: string | undefined;
16
+ uri?: string | undefined;
17
+ };
18
+
19
+ /** @internal */
20
+ export const McpResource$inboundSchema: z.ZodType<
21
+ McpResource,
22
+ z.ZodTypeDef,
23
+ unknown
24
+ > = z.object({
25
+ content: z.string().optional(),
26
+ description: z.string().optional(),
27
+ mime_type: z.string().optional(),
28
+ name: z.string().optional(),
29
+ uri: z.string().optional(),
30
+ }).transform((v) => {
31
+ return remap$(v, {
32
+ "mime_type": "mimeType",
33
+ });
34
+ });
35
+
36
+ export function mcpResourceFromJSON(
37
+ jsonString: string,
38
+ ): SafeParseResult<McpResource, SDKValidationError> {
39
+ return safeParse(
40
+ jsonString,
41
+ (x) => McpResource$inboundSchema.parse(JSON.parse(x)),
42
+ `Failed to parse 'McpResource' from JSON`,
43
+ );
44
+ }
@@ -0,0 +1,30 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+
10
+ export type McpTool = {
11
+ description?: string | undefined;
12
+ name?: string | undefined;
13
+ };
14
+
15
+ /** @internal */
16
+ export const McpTool$inboundSchema: z.ZodType<McpTool, z.ZodTypeDef, unknown> =
17
+ z.object({
18
+ description: z.string().optional(),
19
+ name: z.string().optional(),
20
+ });
21
+
22
+ export function mcpToolFromJSON(
23
+ jsonString: string,
24
+ ): SafeParseResult<McpTool, SDKValidationError> {
25
+ return safeParse(
26
+ jsonString,
27
+ (x) => McpTool$inboundSchema.parse(JSON.parse(x)),
28
+ `Failed to parse 'McpTool' from JSON`,
29
+ );
30
+ }
@@ -0,0 +1,41 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ CenseyeJobsListResponse,
11
+ CenseyeJobsListResponse$inboundSchema,
12
+ } from "./censeyejobslistresponse.js";
13
+
14
+ export type ResponseEnvelopeCenseyeJobsListResponse = {
15
+ result?: CenseyeJobsListResponse | undefined;
16
+ };
17
+
18
+ /** @internal */
19
+ export const ResponseEnvelopeCenseyeJobsListResponse$inboundSchema: z.ZodType<
20
+ ResponseEnvelopeCenseyeJobsListResponse,
21
+ z.ZodTypeDef,
22
+ unknown
23
+ > = z.object({
24
+ result: CenseyeJobsListResponse$inboundSchema.optional(),
25
+ });
26
+
27
+ export function responseEnvelopeCenseyeJobsListResponseFromJSON(
28
+ jsonString: string,
29
+ ): SafeParseResult<
30
+ ResponseEnvelopeCenseyeJobsListResponse,
31
+ SDKValidationError
32
+ > {
33
+ return safeParse(
34
+ jsonString,
35
+ (x) =>
36
+ ResponseEnvelopeCenseyeJobsListResponse$inboundSchema.parse(
37
+ JSON.parse(x),
38
+ ),
39
+ `Failed to parse 'ResponseEnvelopeCenseyeJobsListResponse' from JSON`,
40
+ );
41
+ }
@@ -38,6 +38,7 @@ export * from "./v3globaldataserviceonhost.js";
38
38
  export * from "./v3threathuntingcenseyejobresults.js";
39
39
  export * from "./v3threathuntingcenseyejobscreate.js";
40
40
  export * from "./v3threathuntingcenseyejobsget.js";
41
+ export * from "./v3threathuntingcenseyejobslist.js";
41
42
  export * from "./v3threathuntinggethostobservationswithcertificate.js";
42
43
  export * from "./v3threathuntingscansdiscovery.js";
43
44
  export * from "./v3threathuntingscansget.js";
@@ -0,0 +1,115 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { remap as remap$ } from "../../lib/primitives.js";
7
+ import { safeParse } from "../../lib/schemas.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import * as components from "../components/index.js";
10
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+
12
+ export type V3ThreathuntingCenseyeJobsListGlobals = {
13
+ organizationId?: string | undefined;
14
+ };
15
+
16
+ export type V3ThreathuntingCenseyeJobsListRequest = {
17
+ /**
18
+ * The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-find-and-use-your-organization-id-optional) for more information.
19
+ */
20
+ organizationId?: string | undefined;
21
+ /**
22
+ * Number of results per page (max 100)
23
+ */
24
+ pageSize?: number | undefined;
25
+ /**
26
+ * Pagination token from previous response
27
+ */
28
+ pageToken?: string | undefined;
29
+ /**
30
+ * Filter by host IP address.
31
+ */
32
+ hostId?: string | undefined;
33
+ /**
34
+ * Filter by web property (hostname:port).
35
+ */
36
+ webpropertyId?: string | undefined;
37
+ /**
38
+ * Filter by certificate SHA-256 fingerprint.
39
+ */
40
+ certificateId?: string | undefined;
41
+ };
42
+
43
+ export type V3ThreathuntingCenseyeJobsListResponse = {
44
+ headers: { [k: string]: Array<string> };
45
+ result: components.ResponseEnvelopeCenseyeJobsListResponse;
46
+ };
47
+
48
+ /** @internal */
49
+ export type V3ThreathuntingCenseyeJobsListRequest$Outbound = {
50
+ organization_id?: string | undefined;
51
+ page_size: number;
52
+ page_token?: string | undefined;
53
+ host_id?: string | undefined;
54
+ webproperty_id?: string | undefined;
55
+ certificate_id?: string | undefined;
56
+ };
57
+
58
+ /** @internal */
59
+ export const V3ThreathuntingCenseyeJobsListRequest$outboundSchema: z.ZodType<
60
+ V3ThreathuntingCenseyeJobsListRequest$Outbound,
61
+ z.ZodTypeDef,
62
+ V3ThreathuntingCenseyeJobsListRequest
63
+ > = z.object({
64
+ organizationId: z.string().optional(),
65
+ pageSize: z.number().int().default(100),
66
+ pageToken: z.string().optional(),
67
+ hostId: z.string().optional(),
68
+ webpropertyId: z.string().optional(),
69
+ certificateId: z.string().optional(),
70
+ }).transform((v) => {
71
+ return remap$(v, {
72
+ organizationId: "organization_id",
73
+ pageSize: "page_size",
74
+ pageToken: "page_token",
75
+ hostId: "host_id",
76
+ webpropertyId: "webproperty_id",
77
+ certificateId: "certificate_id",
78
+ });
79
+ });
80
+
81
+ export function v3ThreathuntingCenseyeJobsListRequestToJSON(
82
+ v3ThreathuntingCenseyeJobsListRequest: V3ThreathuntingCenseyeJobsListRequest,
83
+ ): string {
84
+ return JSON.stringify(
85
+ V3ThreathuntingCenseyeJobsListRequest$outboundSchema.parse(
86
+ v3ThreathuntingCenseyeJobsListRequest,
87
+ ),
88
+ );
89
+ }
90
+
91
+ /** @internal */
92
+ export const V3ThreathuntingCenseyeJobsListResponse$inboundSchema: z.ZodType<
93
+ V3ThreathuntingCenseyeJobsListResponse,
94
+ z.ZodTypeDef,
95
+ unknown
96
+ > = z.object({
97
+ Headers: z.record(z.array(z.string())).default({}),
98
+ Result: components.ResponseEnvelopeCenseyeJobsListResponse$inboundSchema,
99
+ }).transform((v) => {
100
+ return remap$(v, {
101
+ "Headers": "headers",
102
+ "Result": "result",
103
+ });
104
+ });
105
+
106
+ export function v3ThreathuntingCenseyeJobsListResponseFromJSON(
107
+ jsonString: string,
108
+ ): SafeParseResult<V3ThreathuntingCenseyeJobsListResponse, SDKValidationError> {
109
+ return safeParse(
110
+ jsonString,
111
+ (x) =>
112
+ V3ThreathuntingCenseyeJobsListResponse$inboundSchema.parse(JSON.parse(x)),
113
+ `Failed to parse 'V3ThreathuntingCenseyeJobsListResponse' from JSON`,
114
+ );
115
+ }
@@ -0,0 +1,138 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { threatHuntingCreateCenseyeJob } from "../funcs/threatHuntingCreateCenseyeJob.js";
6
+ import { threatHuntingCreateTrackedScan } from "../funcs/threatHuntingCreateTrackedScan.js";
7
+ import { threatHuntingGetCenseyeJob } from "../funcs/threatHuntingGetCenseyeJob.js";
8
+ import { threatHuntingGetCenseyeJobResults } from "../funcs/threatHuntingGetCenseyeJobResults.js";
9
+ import { threatHuntingGetHostObservationsWithCertificate } from "../funcs/threatHuntingGetHostObservationsWithCertificate.js";
10
+ import { threatHuntingListThreats } from "../funcs/threatHuntingListThreats.js";
11
+ import { threatHuntingValueCounts } from "../funcs/threatHuntingValueCounts.js";
12
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
13
+ import * as operations from "../models/operations/index.js";
14
+ import { unwrapAsync } from "../types/fp.js";
15
+
16
+ export class AdversaryInvestigation extends ClientSDK {
17
+ /**
18
+ * CensEye: Create a pivot analysis job
19
+ *
20
+ * @remarks
21
+ * Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts default pivot fields from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
22
+ */
23
+ async createCenseyeJob(
24
+ request: operations.V3ThreathuntingCenseyeJobsCreateRequest,
25
+ options?: RequestOptions,
26
+ ): Promise<operations.V3ThreathuntingCenseyeJobsCreateResponse> {
27
+ return unwrapAsync(threatHuntingCreateCenseyeJob(
28
+ this,
29
+ request,
30
+ options,
31
+ ));
32
+ }
33
+
34
+ /**
35
+ * CensEye: Get job status
36
+ *
37
+ * @remarks
38
+ * Retrieve the current status of a CensEye pivot analysis job. Use this to poll for completion before fetching results.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
39
+ */
40
+ async getCenseyeJob(
41
+ request: operations.V3ThreathuntingCenseyeJobsGetRequest,
42
+ options?: RequestOptions,
43
+ ): Promise<operations.V3ThreathuntingCenseyeJobsGetResponse> {
44
+ return unwrapAsync(threatHuntingGetCenseyeJob(
45
+ this,
46
+ request,
47
+ options,
48
+ ));
49
+ }
50
+
51
+ /**
52
+ * CensEye: Get job results
53
+ *
54
+ * @remarks
55
+ * Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
56
+ */
57
+ async getCenseyeJobResults(
58
+ request: operations.V3ThreathuntingCenseyeJobResultsRequest,
59
+ options?: RequestOptions,
60
+ ): Promise<operations.V3ThreathuntingCenseyeJobResultsResponse> {
61
+ return unwrapAsync(threatHuntingGetCenseyeJobResults(
62
+ this,
63
+ request,
64
+ options,
65
+ ));
66
+ }
67
+
68
+ /**
69
+ * Get host history for a certificate
70
+ *
71
+ * @remarks
72
+ * Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Adversary Investigation users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 5 credits per page of results.
73
+ */
74
+ async getHostObservationsWithCertificate(
75
+ request:
76
+ operations.V3ThreathuntingGetHostObservationsWithCertificateRequest,
77
+ options?: RequestOptions,
78
+ ): Promise<
79
+ operations.V3ThreathuntingGetHostObservationsWithCertificateResponse
80
+ > {
81
+ return unwrapAsync(threatHuntingGetHostObservationsWithCertificate(
82
+ this,
83
+ request,
84
+ options,
85
+ ));
86
+ }
87
+
88
+ /**
89
+ * Live Discovery: Initiate a new scan
90
+ *
91
+ * @remarks
92
+ * Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
93
+ */
94
+ async createTrackedScan(
95
+ request: operations.V3ThreathuntingScansDiscoveryRequest,
96
+ options?: RequestOptions,
97
+ ): Promise<operations.V3ThreathuntingScansDiscoveryResponse> {
98
+ return unwrapAsync(threatHuntingCreateTrackedScan(
99
+ this,
100
+ request,
101
+ options,
102
+ ));
103
+ }
104
+
105
+ /**
106
+ * List active threats
107
+ *
108
+ * @remarks
109
+ * 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 Adversary Investigation module.
110
+ */
111
+ async listThreats(
112
+ request: operations.V3ThreathuntingThreatsListRequest,
113
+ options?: RequestOptions,
114
+ ): Promise<operations.V3ThreathuntingThreatsListResponse> {
115
+ return unwrapAsync(threatHuntingListThreats(
116
+ this,
117
+ request,
118
+ options,
119
+ ));
120
+ }
121
+
122
+ /**
123
+ * CensEye: Retrieve value counts to discover pivots
124
+ *
125
+ * @remarks
126
+ * 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 and may contain at most 5 field-value pairs. 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 Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
127
+ */
128
+ async valueCounts(
129
+ request: operations.V3ThreathuntingValueCountsRequest,
130
+ options?: RequestOptions,
131
+ ): Promise<operations.V3ThreathuntingValueCountsResponse> {
132
+ return unwrapAsync(threatHuntingValueCounts(
133
+ this,
134
+ request,
135
+ options,
136
+ ));
137
+ }
138
+ }
package/src/sdk/sdk.ts CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  import { ClientSDK } from "../lib/sdks.js";
6
6
  import { AccountManagement } from "./accountmanagement.js";
7
+ import { AdversaryInvestigation } from "./adversaryinvestigation.js";
7
8
  import { Collections } from "./collections.js";
8
9
  import { GlobalData } from "./globaldata.js";
9
10
  import { ThreatHunting } from "./threathunting.js";
@@ -28,4 +29,11 @@ export class SDK extends ClientSDK {
28
29
  get threatHunting(): ThreatHunting {
29
30
  return (this._threatHunting ??= new ThreatHunting(this._options));
30
31
  }
32
+
33
+ private _adversaryInvestigation?: AdversaryInvestigation;
34
+ get adversaryInvestigation(): AdversaryInvestigation {
35
+ return (this._adversaryInvestigation ??= new AdversaryInvestigation(
36
+ this._options,
37
+ ));
38
+ }
31
39
  }
@@ -8,6 +8,7 @@ import { threatHuntingGetCenseyeJob } from "../funcs/threatHuntingGetCenseyeJob.
8
8
  import { threatHuntingGetCenseyeJobResults } from "../funcs/threatHuntingGetCenseyeJobResults.js";
9
9
  import { threatHuntingGetHostObservationsWithCertificate } from "../funcs/threatHuntingGetHostObservationsWithCertificate.js";
10
10
  import { threatHuntingGetTrackedScanThreatHunting } from "../funcs/threatHuntingGetTrackedScanThreatHunting.js";
11
+ import { threatHuntingListCenseyeJobs } from "../funcs/threatHuntingListCenseyeJobs.js";
11
12
  import { threatHuntingListThreats } from "../funcs/threatHuntingListThreats.js";
12
13
  import { threatHuntingValueCounts } from "../funcs/threatHuntingValueCounts.js";
13
14
  import { ClientSDK, RequestOptions } from "../lib/sdks.js";
@@ -15,11 +16,28 @@ import * as operations from "../models/operations/index.js";
15
16
  import { unwrapAsync } from "../types/fp.js";
16
17
 
17
18
  export class ThreatHunting extends ClientSDK {
19
+ /**
20
+ * CensEye: List jobs
21
+ *
22
+ * @remarks
23
+ * List CensEye pivot analysis jobs for the current organization. Results are paginated. Optionally filter by asset (host, web property, or certificate).
24
+ */
25
+ async listCenseyeJobs(
26
+ request: operations.V3ThreathuntingCenseyeJobsListRequest,
27
+ options?: RequestOptions,
28
+ ): Promise<operations.V3ThreathuntingCenseyeJobsListResponse> {
29
+ return unwrapAsync(threatHuntingListCenseyeJobs(
30
+ this,
31
+ request,
32
+ options,
33
+ ));
34
+ }
35
+
18
36
  /**
19
37
  * CensEye: Create a pivot analysis job
20
38
  *
21
39
  * @remarks
22
- * Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
40
+ * Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts default pivot fields from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
23
41
  */
24
42
  async createCenseyeJob(
25
43
  request: operations.V3ThreathuntingCenseyeJobsCreateRequest,
@@ -36,7 +54,7 @@ export class ThreatHunting extends ClientSDK {
36
54
  * CensEye: Get job status
37
55
  *
38
56
  * @remarks
39
- * Retrieve the current status of a CensEye pivot analysis job. Use this to poll for completion before fetching results.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.
57
+ * Retrieve the current status of a CensEye pivot analysis job. Use this to poll for completion before fetching results.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
40
58
  */
41
59
  async getCenseyeJob(
42
60
  request: operations.V3ThreathuntingCenseyeJobsGetRequest,
@@ -53,7 +71,7 @@ export class ThreatHunting extends ClientSDK {
53
71
  * CensEye: Get job results
54
72
  *
55
73
  * @remarks
56
- * Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.
74
+ * Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
57
75
  */
58
76
  async getCenseyeJobResults(
59
77
  request: operations.V3ThreathuntingCenseyeJobResultsRequest,
@@ -70,7 +88,7 @@ export class ThreatHunting extends ClientSDK {
70
88
  * Get host history for a certificate
71
89
  *
72
90
  * @remarks
73
- * Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Threat Hunting users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 5 credits per page of results.
91
+ * Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Adversary Investigation users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 5 credits per page of results.
74
92
  */
75
93
  async getHostObservationsWithCertificate(
76
94
  request:
@@ -90,7 +108,7 @@ export class ThreatHunting extends ClientSDK {
90
108
  * Live Discovery: Initiate a new scan
91
109
  *
92
110
  * @remarks
93
- * Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 15 credits to execute this endpoint.
111
+ * Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
94
112
  */
95
113
  async createTrackedScan(
96
114
  request: operations.V3ThreathuntingScansDiscoveryRequest,
@@ -124,7 +142,7 @@ export class ThreatHunting extends ClientSDK {
124
142
  * List active threats
125
143
  *
126
144
  * @remarks
127
- * 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.
145
+ * 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 Adversary Investigation module.
128
146
  */
129
147
  async listThreats(
130
148
  request: operations.V3ThreathuntingThreatsListRequest,
@@ -141,7 +159,7 @@ export class ThreatHunting extends ClientSDK {
141
159
  * CensEye: Retrieve value counts to discover pivots
142
160
  *
143
161
  * @remarks
144
- * 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 and may contain at most 5 field-value pairs. 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.
162
+ * 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 and may contain at most 5 field-value pairs. 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 Adversary Investigation module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
145
163
  */
146
164
  async valueCounts(
147
165
  request: operations.V3ThreathuntingValueCountsRequest,