@censys/platform-sdk 0.10.2 → 0.10.4

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 (53) hide show
  1. package/README.md +21 -2
  2. package/docs/sdks/adversaryinvestigation/README.md +625 -0
  3. package/docs/sdks/threathunting/README.md +8 -8
  4. package/funcs/threatHuntingCreateCenseyeJob.d.ts +1 -1
  5. package/funcs/threatHuntingCreateCenseyeJob.js +1 -1
  6. package/funcs/threatHuntingCreateTrackedScan.d.ts +1 -1
  7. package/funcs/threatHuntingCreateTrackedScan.js +1 -1
  8. package/funcs/threatHuntingGetCenseyeJob.d.ts +1 -1
  9. package/funcs/threatHuntingGetCenseyeJob.js +1 -1
  10. package/funcs/threatHuntingGetCenseyeJobResults.d.ts +1 -1
  11. package/funcs/threatHuntingGetCenseyeJobResults.js +1 -1
  12. package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts +1 -1
  13. package/funcs/threatHuntingGetHostObservationsWithCertificate.js +1 -1
  14. package/funcs/threatHuntingListThreats.d.ts +1 -1
  15. package/funcs/threatHuntingListThreats.js +1 -1
  16. package/funcs/threatHuntingValueCounts.d.ts +1 -1
  17. package/funcs/threatHuntingValueCounts.js +1 -1
  18. package/jsr.json +1 -1
  19. package/lib/config.d.ts +4 -4
  20. package/lib/config.js +4 -4
  21. package/lib/config.js.map +1 -1
  22. package/lib/security.d.ts +1 -1
  23. package/lib/security.d.ts.map +1 -1
  24. package/lib/security.js +19 -8
  25. package/lib/security.js.map +1 -1
  26. package/models/components/socks.d.ts +1 -0
  27. package/models/components/socks.d.ts.map +1 -1
  28. package/models/components/socks.js +2 -0
  29. package/models/components/socks.js.map +1 -1
  30. package/package.json +1 -1
  31. package/sdk/adversaryinvestigation.d.ts +54 -0
  32. package/sdk/adversaryinvestigation.d.ts.map +1 -0
  33. package/sdk/adversaryinvestigation.js +82 -0
  34. package/sdk/adversaryinvestigation.js.map +1 -0
  35. package/sdk/sdk.d.ts +3 -0
  36. package/sdk/sdk.d.ts.map +1 -1
  37. package/sdk/sdk.js +4 -0
  38. package/sdk/sdk.js.map +1 -1
  39. package/sdk/threathunting.d.ts +7 -7
  40. package/sdk/threathunting.js +7 -7
  41. package/src/funcs/threatHuntingCreateCenseyeJob.ts +1 -1
  42. package/src/funcs/threatHuntingCreateTrackedScan.ts +1 -1
  43. package/src/funcs/threatHuntingGetCenseyeJob.ts +1 -1
  44. package/src/funcs/threatHuntingGetCenseyeJobResults.ts +1 -1
  45. package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +1 -1
  46. package/src/funcs/threatHuntingListThreats.ts +1 -1
  47. package/src/funcs/threatHuntingValueCounts.ts +1 -1
  48. package/src/lib/config.ts +4 -4
  49. package/src/lib/security.ts +14 -2
  50. package/src/models/components/socks.ts +3 -0
  51. package/src/sdk/adversaryinvestigation.ts +138 -0
  52. package/src/sdk/sdk.ts +8 -0
  53. package/src/sdk/threathunting.ts +7 -7
package/README.md CHANGED
@@ -124,6 +124,16 @@ run();
124
124
  * [getUserCredits](docs/sdks/accountmanagement/README.md#getusercredits) - Get Free user credit balance
125
125
  * [getUserCreditsUsage](docs/sdks/accountmanagement/README.md#getusercreditsusage) - Get Free user credit usage
126
126
 
127
+ ### [AdversaryInvestigation](docs/sdks/adversaryinvestigation/README.md)
128
+
129
+ * [createCenseyeJob](docs/sdks/adversaryinvestigation/README.md#createcenseyejob) - CensEye: Create a pivot analysis job
130
+ * [getCenseyeJob](docs/sdks/adversaryinvestigation/README.md#getcenseyejob) - CensEye: Get job status
131
+ * [getCenseyeJobResults](docs/sdks/adversaryinvestigation/README.md#getcenseyejobresults) - CensEye: Get job results
132
+ * [getHostObservationsWithCertificate](docs/sdks/adversaryinvestigation/README.md#gethostobservationswithcertificate) - Get host history for a certificate
133
+ * [createTrackedScan](docs/sdks/adversaryinvestigation/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
134
+ * [listThreats](docs/sdks/adversaryinvestigation/README.md#listthreats) - List active threats
135
+ * [valueCounts](docs/sdks/adversaryinvestigation/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
136
+
127
137
  ### [Collections](docs/sdks/collections/README.md)
128
138
 
129
139
  * [list](docs/sdks/collections/README.md#list) - List collections
@@ -215,13 +225,20 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
215
225
  - [`globalDataGetWebProperty`](docs/sdks/globaldata/README.md#getwebproperty) - Get a web property
216
226
  - [`globalDataListServicesOnHost`](docs/sdks/globaldata/README.md#listservicesonhost) - Get service history for a host
217
227
  - [`globalDataSearch`](docs/sdks/globaldata/README.md#search) - Run a search query
228
+ - [`threatHuntingCreateCenseyeJob`](docs/sdks/adversaryinvestigation/README.md#createcenseyejob) - CensEye: Create a pivot analysis job
218
229
  - [`threatHuntingCreateCenseyeJob`](docs/sdks/threathunting/README.md#createcenseyejob) - CensEye: Create a pivot analysis job
230
+ - [`threatHuntingCreateTrackedScan`](docs/sdks/adversaryinvestigation/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
219
231
  - [`threatHuntingCreateTrackedScan`](docs/sdks/threathunting/README.md#createtrackedscan) - Live Discovery: Initiate a new scan
232
+ - [`threatHuntingGetCenseyeJob`](docs/sdks/adversaryinvestigation/README.md#getcenseyejob) - CensEye: Get job status
220
233
  - [`threatHuntingGetCenseyeJob`](docs/sdks/threathunting/README.md#getcenseyejob) - CensEye: Get job status
234
+ - [`threatHuntingGetCenseyeJobResults`](docs/sdks/adversaryinvestigation/README.md#getcenseyejobresults) - CensEye: Get job results
221
235
  - [`threatHuntingGetCenseyeJobResults`](docs/sdks/threathunting/README.md#getcenseyejobresults) - CensEye: Get job results
236
+ - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/adversaryinvestigation/README.md#gethostobservationswithcertificate) - Get host history for a certificate
222
237
  - [`threatHuntingGetHostObservationsWithCertificate`](docs/sdks/threathunting/README.md#gethostobservationswithcertificate) - Get host history for a certificate
223
238
  - [`threatHuntingGetTrackedScanThreatHunting`](docs/sdks/threathunting/README.md#gettrackedscanthreathunting) - Get scan status
239
+ - [`threatHuntingListThreats`](docs/sdks/adversaryinvestigation/README.md#listthreats) - List active threats
224
240
  - [`threatHuntingListThreats`](docs/sdks/threathunting/README.md#listthreats) - List active threats
241
+ - [`threatHuntingValueCounts`](docs/sdks/adversaryinvestigation/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
225
242
  - [`threatHuntingValueCounts`](docs/sdks/threathunting/README.md#valuecounts) - CensEye: Retrieve value counts to discover pivots
226
243
 
227
244
  </details>
@@ -386,8 +403,8 @@ run();
386
403
  ### Error Classes
387
404
  **Primary errors:**
388
405
  * [`SDKBaseError`](./src/models/errors/sdkbaseerror.ts): The base class for HTTP error responses.
389
- * [`ErrorModel`](./src/models/errors/errormodel.ts): Generic error.
390
- * [`AuthenticationError`](./src/models/errors/authenticationerror.ts): Request does not contain a valid Authorization token. Status code `401`.
406
+ * [`ErrorModel`](./src/models/errors/errormodel.ts): *
407
+ * [`AuthenticationError`](./src/models/errors/authenticationerror.ts): Request does not contain a valid Authorization token. Status code `401`. *
391
408
 
392
409
  <details><summary>Less common errors (6)</summary>
393
410
 
@@ -405,6 +422,8 @@ run();
405
422
  * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
406
423
 
407
424
  </details>
425
+
426
+ \* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
408
427
  <!-- End Error Handling [errors] -->
409
428
 
410
429
  <!-- Start Server Selection [server] -->