@censys/platform-sdk 0.12.12 → 0.12.14

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 (184) hide show
  1. package/docs/sdks/adversaryinvestigation/README.md +8 -8
  2. package/docs/sdks/collections/README.md +6 -6
  3. package/docs/sdks/globaldata/README.md +38 -22
  4. package/docs/sdks/tagsandcomments/README.md +1 -1
  5. package/docs/sdks/threathunting/README.md +9 -9
  6. package/funcs/collectionsAggregate.d.ts +1 -1
  7. package/funcs/collectionsAggregate.js +1 -1
  8. package/funcs/collectionsCreate.d.ts +1 -1
  9. package/funcs/collectionsCreate.js +1 -1
  10. package/funcs/collectionsGet.d.ts +1 -1
  11. package/funcs/collectionsGet.js +1 -1
  12. package/funcs/collectionsListEvents.d.ts +1 -1
  13. package/funcs/collectionsListEvents.js +1 -1
  14. package/funcs/collectionsSearch.d.ts +1 -1
  15. package/funcs/collectionsSearch.js +1 -1
  16. package/funcs/collectionsUpdate.d.ts +1 -1
  17. package/funcs/collectionsUpdate.js +1 -1
  18. package/funcs/globalDataAggregate.d.ts +1 -1
  19. package/funcs/globalDataAggregate.js +1 -1
  20. package/funcs/globalDataCreateTrackedScan.d.ts +1 -1
  21. package/funcs/globalDataCreateTrackedScan.js +1 -1
  22. package/funcs/globalDataGetCertificate.d.ts +1 -1
  23. package/funcs/globalDataGetCertificate.js +4 -2
  24. package/funcs/globalDataGetCertificate.js.map +1 -1
  25. package/funcs/globalDataGetCertificateRaw.d.ts +1 -1
  26. package/funcs/globalDataGetCertificateRaw.js +1 -1
  27. package/funcs/globalDataGetCertificates.d.ts +1 -1
  28. package/funcs/globalDataGetCertificates.js +1 -1
  29. package/funcs/globalDataGetCertificatesRaw.d.ts +1 -1
  30. package/funcs/globalDataGetCertificatesRaw.js +1 -1
  31. package/funcs/globalDataGetHost.d.ts +1 -1
  32. package/funcs/globalDataGetHost.js +4 -2
  33. package/funcs/globalDataGetHost.js.map +1 -1
  34. package/funcs/globalDataGetHostEnrichment.d.ts +1 -1
  35. package/funcs/globalDataGetHostEnrichment.js +4 -2
  36. package/funcs/globalDataGetHostEnrichment.js.map +1 -1
  37. package/funcs/globalDataGetHostTimeline.d.ts +1 -1
  38. package/funcs/globalDataGetHostTimeline.js +1 -1
  39. package/funcs/globalDataGetHosts.d.ts +1 -1
  40. package/funcs/globalDataGetHosts.js +1 -1
  41. package/funcs/globalDataGetTrackedScan.d.ts +1 -1
  42. package/funcs/globalDataGetTrackedScan.js +1 -1
  43. package/funcs/globalDataGetWebProperties.d.ts +1 -1
  44. package/funcs/globalDataGetWebProperties.js +1 -1
  45. package/funcs/globalDataGetWebProperty.d.ts +1 -1
  46. package/funcs/globalDataGetWebProperty.js +3 -1
  47. package/funcs/globalDataGetWebProperty.js.map +1 -1
  48. package/funcs/globalDataListDnsIpResolutionBounds.d.ts +1 -1
  49. package/funcs/globalDataListDnsIpResolutionBounds.js +1 -1
  50. package/funcs/globalDataListDnsIpResolutionRanges.d.ts +1 -1
  51. package/funcs/globalDataListDnsIpResolutionRanges.js +1 -1
  52. package/funcs/globalDataListDnsNameResolutionBounds.d.ts +1 -1
  53. package/funcs/globalDataListDnsNameResolutionBounds.js +1 -1
  54. package/funcs/globalDataListDnsNameResolutionRanges.d.ts +1 -1
  55. package/funcs/globalDataListDnsNameResolutionRanges.js +1 -1
  56. package/funcs/globalDataListServicesOnHost.d.ts +1 -1
  57. package/funcs/globalDataListServicesOnHost.js +1 -1
  58. package/funcs/globalDataSearch.d.ts +1 -1
  59. package/funcs/globalDataSearch.js +1 -1
  60. package/funcs/tagsAndCommentsUpdateTag.d.ts +1 -1
  61. package/funcs/tagsAndCommentsUpdateTag.js +1 -1
  62. package/funcs/threatHuntingCreateCenseyeJob.d.ts +1 -1
  63. package/funcs/threatHuntingCreateCenseyeJob.js +1 -1
  64. package/funcs/threatHuntingCreateInvestigationFileUpload.d.ts +1 -1
  65. package/funcs/threatHuntingCreateInvestigationFileUpload.js +1 -1
  66. package/funcs/threatHuntingCreateInvestigationJob.d.ts +1 -1
  67. package/funcs/threatHuntingCreateInvestigationJob.js +1 -1
  68. package/funcs/threatHuntingCreateTrackedScan.d.ts +1 -1
  69. package/funcs/threatHuntingCreateTrackedScan.js +1 -1
  70. package/funcs/threatHuntingGetCenseyeJobResults.d.ts +1 -1
  71. package/funcs/threatHuntingGetCenseyeJobResults.js +1 -1
  72. package/funcs/threatHuntingGetHostObservationsWithCertificate.d.ts +1 -1
  73. package/funcs/threatHuntingGetHostObservationsWithCertificate.js +1 -1
  74. package/funcs/threatHuntingGetTrackedScanThreatHunting.d.ts +1 -1
  75. package/funcs/threatHuntingGetTrackedScanThreatHunting.js +1 -1
  76. package/funcs/threatHuntingListThreats.d.ts +1 -1
  77. package/funcs/threatHuntingListThreats.js +1 -1
  78. package/funcs/threatHuntingValueCounts.d.ts +1 -1
  79. package/funcs/threatHuntingValueCounts.js +1 -1
  80. package/jsr.json +1 -1
  81. package/lib/config.d.ts +4 -4
  82. package/lib/config.js +4 -4
  83. package/models/components/collection.d.ts +18 -1
  84. package/models/components/collection.d.ts.map +1 -1
  85. package/models/components/collection.js +11 -1
  86. package/models/components/collection.js.map +1 -1
  87. package/models/components/crudcreateinputbody.d.ts +19 -0
  88. package/models/components/crudcreateinputbody.d.ts.map +1 -1
  89. package/models/components/crudcreateinputbody.js +11 -1
  90. package/models/components/crudcreateinputbody.js.map +1 -1
  91. package/models/components/crudupdateinputbody.d.ts +19 -0
  92. package/models/components/crudupdateinputbody.d.ts.map +1 -1
  93. package/models/components/crudupdateinputbody.js +11 -1
  94. package/models/components/crudupdateinputbody.js.map +1 -1
  95. package/models/components/http.d.ts +6 -0
  96. package/models/components/http.d.ts.map +1 -1
  97. package/models/components/http.js +4 -0
  98. package/models/components/http.js.map +1 -1
  99. package/models/components/httpcopyright.d.ts +17 -0
  100. package/models/components/httpcopyright.d.ts.map +1 -0
  101. package/models/components/httpcopyright.js +51 -0
  102. package/models/components/httpcopyright.js.map +1 -0
  103. package/models/components/index.d.ts +1 -0
  104. package/models/components/index.d.ts.map +1 -1
  105. package/models/components/index.js +1 -0
  106. package/models/components/index.js.map +1 -1
  107. package/models/operations/v3globaldataassetcertificate.d.ts +10 -0
  108. package/models/operations/v3globaldataassetcertificate.d.ts.map +1 -1
  109. package/models/operations/v3globaldataassetcertificate.js +3 -0
  110. package/models/operations/v3globaldataassetcertificate.js.map +1 -1
  111. package/models/operations/v3globaldataassethost.d.ts +10 -0
  112. package/models/operations/v3globaldataassethost.d.ts.map +1 -1
  113. package/models/operations/v3globaldataassethost.js +3 -0
  114. package/models/operations/v3globaldataassethost.js.map +1 -1
  115. package/models/operations/v3globaldataassethostenrichment.d.ts +10 -0
  116. package/models/operations/v3globaldataassethostenrichment.d.ts.map +1 -1
  117. package/models/operations/v3globaldataassethostenrichment.js +3 -0
  118. package/models/operations/v3globaldataassethostenrichment.js.map +1 -1
  119. package/models/operations/v3globaldataassetwebproperty.d.ts +10 -0
  120. package/models/operations/v3globaldataassetwebproperty.d.ts.map +1 -1
  121. package/models/operations/v3globaldataassetwebproperty.js +3 -0
  122. package/models/operations/v3globaldataassetwebproperty.js.map +1 -1
  123. package/package.json +2 -2
  124. package/sdk/adversaryinvestigation.d.ts +8 -8
  125. package/sdk/adversaryinvestigation.js +8 -8
  126. package/sdk/collections.d.ts +6 -6
  127. package/sdk/collections.js +6 -6
  128. package/sdk/globaldata.d.ts +19 -19
  129. package/sdk/globaldata.js +19 -19
  130. package/sdk/tagsandcomments.d.ts +1 -1
  131. package/sdk/tagsandcomments.js +1 -1
  132. package/sdk/threathunting.d.ts +9 -9
  133. package/sdk/threathunting.js +9 -9
  134. package/src/funcs/collectionsAggregate.ts +1 -1
  135. package/src/funcs/collectionsCreate.ts +1 -1
  136. package/src/funcs/collectionsGet.ts +1 -1
  137. package/src/funcs/collectionsListEvents.ts +1 -1
  138. package/src/funcs/collectionsSearch.ts +1 -1
  139. package/src/funcs/collectionsUpdate.ts +1 -1
  140. package/src/funcs/globalDataAggregate.ts +1 -1
  141. package/src/funcs/globalDataCreateTrackedScan.ts +1 -1
  142. package/src/funcs/globalDataGetCertificate.ts +4 -2
  143. package/src/funcs/globalDataGetCertificateRaw.ts +1 -1
  144. package/src/funcs/globalDataGetCertificates.ts +1 -1
  145. package/src/funcs/globalDataGetCertificatesRaw.ts +1 -1
  146. package/src/funcs/globalDataGetHost.ts +4 -2
  147. package/src/funcs/globalDataGetHostEnrichment.ts +4 -2
  148. package/src/funcs/globalDataGetHostTimeline.ts +1 -1
  149. package/src/funcs/globalDataGetHosts.ts +1 -1
  150. package/src/funcs/globalDataGetTrackedScan.ts +1 -1
  151. package/src/funcs/globalDataGetWebProperties.ts +1 -1
  152. package/src/funcs/globalDataGetWebProperty.ts +3 -1
  153. package/src/funcs/globalDataListDnsIpResolutionBounds.ts +1 -1
  154. package/src/funcs/globalDataListDnsIpResolutionRanges.ts +1 -1
  155. package/src/funcs/globalDataListDnsNameResolutionBounds.ts +1 -1
  156. package/src/funcs/globalDataListDnsNameResolutionRanges.ts +1 -1
  157. package/src/funcs/globalDataListServicesOnHost.ts +1 -1
  158. package/src/funcs/globalDataSearch.ts +1 -1
  159. package/src/funcs/tagsAndCommentsUpdateTag.ts +1 -1
  160. package/src/funcs/threatHuntingCreateCenseyeJob.ts +1 -1
  161. package/src/funcs/threatHuntingCreateInvestigationFileUpload.ts +1 -1
  162. package/src/funcs/threatHuntingCreateInvestigationJob.ts +1 -1
  163. package/src/funcs/threatHuntingCreateTrackedScan.ts +1 -1
  164. package/src/funcs/threatHuntingGetCenseyeJobResults.ts +1 -1
  165. package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts +1 -1
  166. package/src/funcs/threatHuntingGetTrackedScanThreatHunting.ts +1 -1
  167. package/src/funcs/threatHuntingListThreats.ts +1 -1
  168. package/src/funcs/threatHuntingValueCounts.ts +1 -1
  169. package/src/lib/config.ts +4 -4
  170. package/src/models/components/collection.ts +25 -1
  171. package/src/models/components/crudcreateinputbody.ts +26 -0
  172. package/src/models/components/crudupdateinputbody.ts +26 -0
  173. package/src/models/components/http.ts +9 -0
  174. package/src/models/components/httpcopyright.ts +39 -0
  175. package/src/models/components/index.ts +1 -0
  176. package/src/models/operations/v3globaldataassetcertificate.ts +13 -0
  177. package/src/models/operations/v3globaldataassethost.ts +13 -0
  178. package/src/models/operations/v3globaldataassethostenrichment.ts +13 -0
  179. package/src/models/operations/v3globaldataassetwebproperty.ts +13 -0
  180. package/src/sdk/adversaryinvestigation.ts +8 -8
  181. package/src/sdk/collections.ts +6 -6
  182. package/src/sdk/globaldata.ts +19 -19
  183. package/src/sdk/tagsandcomments.ts +1 -1
  184. package/src/sdk/threathunting.ts +9 -9
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get DNS resolution records for a name (ranges)
13
13
  *
14
14
  * @remarks
15
- * Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
15
+ * Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>In a SOC environment, use this endpoint to see when a domain's records changed over time, such as a sudden hosting move after takedown.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
16
16
  */
17
17
  export declare function globalDataListDnsNameResolutionRanges(client: SDKCore, request: operations.V3GlobaldataDnsNameResolutionRangesRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataDnsNameResolutionRangesResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListDnsNameResolutionRanges.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get DNS resolution records for a name (ranges)
52
52
  *
53
53
  * @remarks
54
- * Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
54
+ * Retrieve the records that resolved for a name during a time frame. This endpoint returns observed A, AAAA, MX, NS, SOA, and TXT records for the name you provide. You can filter by one or more record types using `record_types`.<br><br>Record results are broken down based on time range. For example, if `censys.com` resolved to `1.1.1.1` from January 1 to January 7 during two different ranges of January 1 to January 3 and January 5 to January 7, and you targeted January 1 through January 7 with your API call, then this endpoint will return one row for each of those distinct ranges for the `1.1.1.1` A record.<br><br>To retrieve records for a name with each result aggregated per record, use the [bounds endpoint endpoint](https://docs.censys.com/reference/v3-globaldata-dns-name-resolution-bound).<br><br>In a SOC environment, use this endpoint to see when a domain's records changed over time, such as a sudden hosting move after takedown.<br><br>This endpoint is only available to organizations on the Censys Search and Censys Core plans.<br><br>[Learn more about Censys Active DNS](https://docs.censys.com/docs/platform-active-dns).
55
55
  */
56
56
  function globalDataListDnsNameResolutionRanges(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get service history for a host
13
13
  *
14
14
  * @remarks
15
- * Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<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.<br><br>You can filter by port number, protocol, and transport protocol.
15
+ * Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<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.<br><br>You can filter by port number, protocol, and transport protocol.<br><br>In a SOC environment, use this endpoint to see when a specific service was exposed on an IP, so you can check whether it was live during the window of a suspected incident.
16
16
  */
17
17
  export declare function globalDataListServicesOnHost(client: SDKCore, request: operations.V3GlobaldataServiceOnHostRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataServiceOnHostResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataListServicesOnHost.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get service history for a host
52
52
  *
53
53
  * @remarks
54
- * Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<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.<br><br>You can filter by port number, protocol, and transport protocol.
54
+ * Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<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.<br><br>You can filter by port number, protocol, and transport protocol.<br><br>In a SOC environment, use this endpoint to see when a specific service was exposed on an IP, so you can check whether it was live during the window of a suspected incident.
55
55
  */
56
56
  function globalDataListServicesOnHost(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Run a search query
13
13
  *
14
14
  * @remarks
15
- * Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object.
15
+ * Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.<br><br>Host services that match your search criteria will be returned in a `matched_services` object.<br><br>In a SOC environment, use this endpoint to hunt for hosts, web properties, or certificates that match an indicator, such as a C2 banner, JARM, or favicon hash to scope infrastructure tied to an alert.
16
16
  */
17
17
  export declare function globalDataSearch(client: SDKCore, request: operations.V3GlobaldataSearchQueryRequest, options?: RequestOptions): APIPromise<Result<operations.V3GlobaldataSearchQueryResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=globalDataSearch.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Run a search query
52
52
  *
53
53
  * @remarks
54
- * Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax. Host services that match your search criteria will be returned in a `matched_services` object.
54
+ * Run a search query across Censys data. Reference the [documentation on Censys Query Language](https://docs.censys.com/docs/censys-query-language#/) for information about query syntax.<br><br>Host services that match your search criteria will be returned in a `matched_services` object.<br><br>In a SOC environment, use this endpoint to hunt for hosts, web properties, or certificates that match an indicator, such as a C2 banner, JARM, or favicon hash to scope infrastructure tied to an alert.
55
55
  */
56
56
  function globalDataSearch(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Update a tag
13
13
  *
14
14
  * @remarks
15
- * Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member.<br><br>This endpoint does not cost any credits to execute.
15
+ * Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member. A `shared` tag cannot be made `private`.<br><br>This endpoint does not cost any credits to execute.
16
16
  */
17
17
  export declare function tagsAndCommentsUpdateTag(client: SDKCore, request: operations.V3TagsUpdateTagRequest, options?: RequestOptions): APIPromise<Result<operations.V3TagsUpdateTagResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=tagsAndCommentsUpdateTag.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Update a tag
52
52
  *
53
53
  * @remarks
54
- * Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member.<br><br>This endpoint does not cost any credits to execute.
54
+ * Update an existing tag in your organization. Only the fields provided in the request body will be updated; omitted fields are left unchanged.<br><br>Only the tag's creator or an organization admin can update a `private` tag. Tags with the `shared` setting can be updated by any organization member. A `shared` tag cannot be made `private`.<br><br>This endpoint does not cost any credits to execute.
55
55
  */
56
56
  function tagsAndCommentsUpdateTag(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * CensEye: Create a pivot analysis job
13
13
  *
14
14
  * @remarks
15
- * 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 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.
15
+ * 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>Use this endpoint to start an analysis of a suspicious host, web property, or certificate that finds the rare attributes it shares with other assets, so you can uncover related attacker infrastructure.<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.
16
16
  */
17
17
  export declare function threatHuntingCreateCenseyeJob(client: SDKCore, request: operations.V3ThreathuntingCenseyeJobsCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingCenseyeJobsCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateCenseyeJob.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * CensEye: Create a pivot analysis job
52
52
  *
53
53
  * @remarks
54
- * 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 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.
54
+ * 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>Use this endpoint to start an analysis of a suspicious host, web property, or certificate that finds the rare attributes it shares with other assets, so you can uncover related attacker infrastructure.<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.
55
55
  */
56
56
  function threatHuntingCreateCenseyeJob(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Investigations: Create file upload
13
13
  *
14
14
  * @remarks
15
- * Prepare to attach an evidence file to an investigation. This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
15
+ * Prepare to attach an evidence file to an investigation. Use this endpoint to stage evidence, such as logs, malware reports, or alert exports, so an AI investigation can use it.<br><br>This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
16
16
  */
17
17
  export declare function threatHuntingCreateInvestigationFileUpload(client: SDKCore, request: operations.V3ThreathuntingInvestigationsFilesCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingInvestigationsFilesCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateInvestigationFileUpload.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Investigations: Create file upload
52
52
  *
53
53
  * @remarks
54
- * Prepare to attach an evidence file to an investigation. This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
54
+ * Prepare to attach an evidence file to an investigation. Use this endpoint to stage evidence, such as logs, malware reports, or alert exports, so an AI investigation can use it.<br><br>This endpoint does not accept the file. It returns a URL to send the file to and an identifier to pass to the [create job endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-jobs-create) afterwards.<br><br>Upload the file with an HTTP PUT to `upload_url` and send `upload_headers` exactly as returned by this endpoint. The URL grants access to that one file and stops working at `expire_time`; a file uploaded before that stays usable afterwards. Prepare one upload per file.<br><br>Start the investigation promptly after uploading. There is a limit on how many uploaded files you may hold without using them and starting an investigation from a file releases its slot. A file that no investigation references is discarded once it passes the service's retention window for unused uploads. A file an investigation does reference is kept with that investigation for as long as the investigation itself.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.<br><br>This endpoint does not cost any credits to execute.
55
55
  */
56
56
  function threatHuntingCreateInvestigationFileUpload(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Investigations: Create job
13
13
  *
14
14
  * @remarks
15
- * Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both. Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
15
+ * Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both to obtain a report on suspect infrastructure without doing the pivots by hand.<br><br>Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
16
16
  */
17
17
  export declare function threatHuntingCreateInvestigationJob(client: SDKCore, request: operations.V3ThreathuntingInvestigationsJobsCreateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingInvestigationsJobsCreateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateInvestigationJob.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Investigations: Create job
52
52
  *
53
53
  * @remarks
54
- * Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both. Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
54
+ * Start an [AI investigation](https://docs.censys.com/docs/platform-ai-investigations) from a set of indicators, a set of previously uploaded evidence files, or both to obtain a report on suspect infrastructure without doing the pivots by hand.<br><br>Supply at least one `indicators` or `file_ids`. To use files, upload them first with the [create file upload endpoint](https://docs.censys.com/reference/v3-threathunting-investigations-files-create).<br><br>This endpoint returns a `job_id` that you can poll to retrieve its status and results.<br><br>Provide `start_time` and `end_time` to scope the investigation to a time frame, or `start_time` alone to scope it from that time up to now. Omit both to investigate current data.<br><br>To use this endpoint, your organization must have access to the Adversary Investigation module.
55
55
  */
56
56
  function threatHuntingCreateInvestigationJob(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Live Discovery: Initiate a new scan
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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>Use this endpoint to scan for a service at an `ip:port` or `hostname:port`, such as a new IOC from an incident, so you can get data on it right away.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
16
16
  */
17
17
  export declare function threatHuntingCreateTrackedScan(client: SDKCore, request: operations.V3ThreathuntingScansDiscoveryRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingScansDiscoveryResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingCreateTrackedScan.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Live Discovery: Initiate a new scan
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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>Use this endpoint to scan for a service at an `ip:port` or `hostname:port`, such as a new IOC from an incident, so you can get data on it right away.<br><br>This endpoint is available to organizations that have access to the Adversary Investigation module. It costs 15 credits to execute this endpoint.
55
55
  */
56
56
  function threatHuntingCreateTrackedScan(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * CensEye: Get job results
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * Retrieve the results of a completed CensEye pivot analysis job. Use this endpoint to retrieve the pivots from a finished job, then turn the most distinctive ones into searches or blocklist candidates.<br><br>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.
16
16
  */
17
17
  export declare function threatHuntingGetCenseyeJobResults(client: SDKCore, request: operations.V3ThreathuntingCenseyeJobResultsRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingCenseyeJobResultsResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingGetCenseyeJobResults.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * CensEye: Get job results
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * Retrieve the results of a completed CensEye pivot analysis job. Use this endpoint to retrieve the pivots from a finished job, then turn the most distinctive ones into searches or blocklist candidates.<br><br>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.
55
55
  */
56
56
  function threatHuntingGetCenseyeJobResults(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get host history for a certificate
13
13
  *
14
14
  * @remarks
15
- * 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.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>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. This endpoint costs one credit per page of results.
15
+ * Retrieve the historical observations of hosts associated with a certificate. Use this endpoint to see every host that has presented a given certificate over time, so you can build a timeline and find other infrastructure using it.<br><br>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.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>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. This endpoint costs one credit per page of results.
16
16
  */
17
17
  export declare function threatHuntingGetHostObservationsWithCertificate(client: SDKCore, request: operations.V3ThreathuntingGetHostObservationsWithCertificateRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingGetHostObservationsWithCertificateResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingGetHostObservationsWithCertificate.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get host history for a certificate
52
52
  *
53
53
  * @remarks
54
- * 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.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>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. This endpoint costs one credit per page of results.
54
+ * Retrieve the historical observations of hosts associated with a certificate. Use this endpoint to see every host that has presented a given certificate over time, so you can build a timeline and find other infrastructure using it.<br><br>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.<br><br>For workspaces with a history limit, the API returns observation ranges that overlap the allowed history window. The window starts at 00:00 UTC the allowed number of days ago and ends at the time of the request. Ranges are returned in full, with their original start and end times, even if they extend outside the window.<br><br>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. This endpoint costs one credit per page of results.
55
55
  */
56
56
  function threatHuntingGetHostObservationsWithCertificate(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Get scan status
13
13
  *
14
14
  * @remarks
15
- * Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute.
15
+ * Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>Use this endpoint to check whether a Live Discovery or Live Rescan scan has finished, so automation knows when fresh data is ready to pull.<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all enterprise customers. This endpoint does not cost any credits to execute.
16
16
  */
17
17
  export declare function threatHuntingGetTrackedScanThreatHunting(client: SDKCore, request: operations.V3ThreathuntingScansGetRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingScansGetResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingGetTrackedScanThreatHunting.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Get scan status
52
52
  *
53
53
  * @remarks
54
- * Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute.
54
+ * Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>Use this endpoint to check whether a Live Discovery or Live Rescan scan has finished, so automation knows when fresh data is ready to pull.<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all enterprise customers. This endpoint does not cost any credits to execute.
55
55
  */
56
56
  function threatHuntingGetTrackedScanThreatHunting(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * List active threats
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Use this endpoint to see currently active threats so you can prioritize which malicious infrastructure to hunt or block first.<br><br>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.
16
16
  */
17
17
  export declare function threatHuntingListThreats(client: SDKCore, request: operations.V3ThreathuntingThreatsListRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingThreatsListResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingListThreats.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * List active threats
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Use this endpoint to see currently active threats so you can prioritize which malicious infrastructure to hunt or block first.<br><br>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.
55
55
  */
56
56
  function threatHuntingListThreats(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * CensEye: Retrieve value counts to discover pivots
13
13
  *
14
14
  * @remarks
15
- * 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.
15
+ * 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>Use this endpoint to see how many assets share a given field value, so you can tell which attributes are rare enough to pivot on and which are too common to be useful.<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.
16
16
  */
17
17
  export declare function threatHuntingValueCounts(client: SDKCore, request: operations.V3ThreathuntingValueCountsRequest, options?: RequestOptions): APIPromise<Result<operations.V3ThreathuntingValueCountsResponse, errors.AuthenticationError | errors.ErrorModel | SDKBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=threatHuntingValueCounts.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * CensEye: Retrieve value counts to discover pivots
52
52
  *
53
53
  * @remarks
54
- * 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.
54
+ * 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>Use this endpoint to see how many assets share a given field value, so you can tell which attributes are rare enough to pivot on and which are too common to be useful.<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.
55
55
  */
56
56
  function threatHuntingValueCounts(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
package/jsr.json CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  {
4
4
  "name": "@censys/platform-sdk",
5
- "version": "0.12.12",
5
+ "version": "0.12.14",
6
6
  "exports": {
7
7
  ".": "./src/index.ts",
8
8
  "./models/errors": "./src/models/errors/index.ts",
package/lib/config.d.ts CHANGED
@@ -34,9 +34,9 @@ export type SDKOptions = {
34
34
  export declare function serverURLFromOptions(options: SDKOptions): URL | null;
35
35
  export declare const SDK_METADATA: {
36
36
  readonly language: "typescript";
37
- readonly openapiDocVersion: "1.0.157";
38
- readonly sdkVersion: "0.12.12";
39
- readonly genVersion: "2.954.8";
40
- readonly userAgent: "speakeasy-sdk/typescript 0.12.12 2.954.8 1.0.157 @censys/platform-sdk";
37
+ readonly openapiDocVersion: "1.0.163";
38
+ readonly sdkVersion: "0.12.14";
39
+ readonly genVersion: "2.961.1";
40
+ readonly userAgent: "speakeasy-sdk/typescript 0.12.14 2.961.1 1.0.163 @censys/platform-sdk";
41
41
  };
42
42
  //# sourceMappingURL=config.d.ts.map
package/lib/config.js CHANGED
@@ -30,9 +30,9 @@ function serverURLFromOptions(options) {
30
30
  }
31
31
  exports.SDK_METADATA = {
32
32
  language: "typescript",
33
- openapiDocVersion: "1.0.157",
34
- sdkVersion: "0.12.12",
35
- genVersion: "2.954.8",
36
- userAgent: "speakeasy-sdk/typescript 0.12.12 2.954.8 1.0.157 @censys/platform-sdk",
33
+ openapiDocVersion: "1.0.163",
34
+ sdkVersion: "0.12.14",
35
+ genVersion: "2.961.1",
36
+ userAgent: "speakeasy-sdk/typescript 0.12.14 2.961.1 1.0.163 @censys/platform-sdk",
37
37
  };
38
38
  //# sourceMappingURL=config.js.map
@@ -2,6 +2,17 @@ import * as z from "zod/v3";
2
2
  import { OpenEnum } from "../../types/enums.js";
3
3
  import { Result as SafeParseResult } from "../../types/fp.js";
4
4
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
5
+ /**
6
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
7
+ */
8
+ export declare const CollectionPrivacy: {
9
+ readonly Private: "private";
10
+ readonly Shared: "shared";
11
+ };
12
+ /**
13
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
14
+ */
15
+ export type CollectionPrivacy = OpenEnum<typeof CollectionPrivacy>;
5
16
  export declare const CollectionStatus: {
6
17
  readonly Unspecified: "unspecified";
7
18
  readonly Populating: "populating";
@@ -24,12 +35,16 @@ export type Collection = {
24
35
  addedAssets24Hours: number;
25
36
  createTime: Date;
26
37
  /**
27
- * The ID of a Censys user who created the collection.
38
+ * The ID of the user or service account that created the collection.
28
39
  */
29
40
  createdBy?: string | undefined;
30
41
  description: string;
31
42
  id: string;
32
43
  name: string;
44
+ /**
45
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
46
+ */
47
+ privacy: CollectionPrivacy;
33
48
  query: string;
34
49
  removedAssets24Hours: number;
35
50
  status: CollectionStatus;
@@ -37,6 +52,8 @@ export type Collection = {
37
52
  totalAssets: number;
38
53
  };
39
54
  /** @internal */
55
+ export declare const CollectionPrivacy$inboundSchema: z.ZodType<CollectionPrivacy, z.ZodTypeDef, unknown>;
56
+ /** @internal */
40
57
  export declare const CollectionStatus$inboundSchema: z.ZodType<CollectionStatus, z.ZodTypeDef, unknown>;
41
58
  /** @internal */
42
59
  export declare const StatusReason$inboundSchema: z.ZodType<StatusReason, z.ZodTypeDef, unknown>;
@@ -1 +1 @@
1
- {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../src/models/components/collection.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE,eAAO,MAAM,gBAAgB;;;;;;CAMnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjE,eAAO,MAAM,YAAY;;;;;;;;CAQf,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD,MAAM,MAAM,UAAU,GAAG;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CACoC,CAAC;AAE9C,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAwBP,CAAC;AAEH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAMjD"}
1
+ {"version":3,"file":"collection.d.ts","sourceRoot":"","sources":["../../src/models/components/collection.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAI5B,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEnE,eAAO,MAAM,gBAAgB;;;;;;CAMnB,CAAC;AACX,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAEjE,eAAO,MAAM,YAAY;;;;;;;;CAQf,CAAC;AACX,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,OAAO,YAAY,CAAC,CAAC;AAEzD,MAAM,MAAM,UAAU,GAAG;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,iBAAiB,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,oBAAoB,EAAE,MAAM,CAAC;IAC7B,MAAM,EAAE,gBAAgB,CAAC;IACzB,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,OAAO,CACrD,iBAAiB,EACjB,CAAC,CAAC,UAAU,EACZ,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,8BAA8B,EAAE,CAAC,CAAC,OAAO,CACpD,gBAAgB,EAChB,CAAC,CAAC,UAAU,EACZ,OAAO,CACoC,CAAC;AAE9C,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,OAAO,CAChD,YAAY,EACZ,CAAC,CAAC,UAAU,EACZ,OAAO,CACgC,CAAC;AAE1C,gBAAgB;AAChB,eAAO,MAAM,wBAAwB,EAAE,CAAC,CAAC,OAAO,CAC9C,UAAU,EACV,CAAC,CAAC,UAAU,EACZ,OAAO,CAyBP,CAAC;AAEH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,UAAU,EAAE,kBAAkB,CAAC,CAMjD"}
@@ -36,12 +36,19 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  };
37
37
  })();
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.Collection$inboundSchema = exports.StatusReason$inboundSchema = exports.CollectionStatus$inboundSchema = exports.StatusReason = exports.CollectionStatus = void 0;
39
+ exports.Collection$inboundSchema = exports.StatusReason$inboundSchema = exports.CollectionStatus$inboundSchema = exports.CollectionPrivacy$inboundSchema = exports.StatusReason = exports.CollectionStatus = exports.CollectionPrivacy = void 0;
40
40
  exports.collectionFromJSON = collectionFromJSON;
41
41
  const z = __importStar(require("zod/v3"));
42
42
  const primitives_js_1 = require("../../lib/primitives.js");
43
43
  const schemas_js_1 = require("../../lib/schemas.js");
44
44
  const openEnums = __importStar(require("../../types/enums.js"));
45
+ /**
46
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
47
+ */
48
+ exports.CollectionPrivacy = {
49
+ Private: "private",
50
+ Shared: "shared",
51
+ };
45
52
  exports.CollectionStatus = {
46
53
  Unspecified: "unspecified",
47
54
  Populating: "populating",
@@ -59,6 +66,8 @@ exports.StatusReason = {
59
66
  Initial: "initial",
60
67
  };
61
68
  /** @internal */
69
+ exports.CollectionPrivacy$inboundSchema = openEnums.inboundSchema(exports.CollectionPrivacy);
70
+ /** @internal */
62
71
  exports.CollectionStatus$inboundSchema = openEnums.inboundSchema(exports.CollectionStatus);
63
72
  /** @internal */
64
73
  exports.StatusReason$inboundSchema = openEnums.inboundSchema(exports.StatusReason);
@@ -70,6 +79,7 @@ exports.Collection$inboundSchema = z.object({
70
79
  description: z.string(),
71
80
  id: z.string(),
72
81
  name: z.string(),
82
+ privacy: exports.CollectionPrivacy$inboundSchema,
73
83
  query: z.string(),
74
84
  removed_assets_24_hours: z.number().int(),
75
85
  status: exports.CollectionStatus$inboundSchema,
@@ -1 +1 @@
1
- {"version":3,"file":"collection.js","sourceRoot":"","sources":["../../src/models/components/collection.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2FH,gDAQC;AAjGD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,gEAAkD;AAKrC,QAAA,gBAAgB,GAAG;IAC9B,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAGE,QAAA,YAAY,GAAG;IAC1B,WAAW,EAAE,aAAa;IAC1B,gBAAgB,EAAE,oBAAoB;IACtC,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,iBAAiB;IAChC,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,eAAe;IAC7B,OAAO,EAAE,SAAS;CACV,CAAC;AAoBX,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,SAAS,CAAC,aAAa,CAAC,wBAAgB,CAAC,CAAC;AAE9C,gBAAgB;AACH,QAAA,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,oBAAY,CAAC,CAAC;AAE1C,gBAAgB;AACH,QAAA,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAC/D,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ;IACD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzC,MAAM,EAAE,sCAA8B;IACtC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,kCAA0B,CAAC;IACrD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC/B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,uBAAuB,EAAE,oBAAoB;QAC7C,aAAa,EAAE,YAAY;QAC3B,YAAY,EAAE,WAAW;QACzB,yBAAyB,EAAE,sBAAsB;QACjD,eAAe,EAAE,cAAc;QAC/B,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,kBAAkB,CAChC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpD,wCAAwC,CACzC,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"collection.js","sourceRoot":"","sources":["../../src/models/components/collection.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmHH,gDAQC;AAzHD,0CAA4B;AAC5B,2DAA0D;AAC1D,qDAAiD;AACjD,gEAAkD;AAKlD;;GAEG;AACU,QAAA,iBAAiB,GAAG;IAC/B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAC;AAME,QAAA,gBAAgB,GAAG;IAC9B,WAAW,EAAE,aAAa;IAC1B,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACZ,CAAC;AAGE,QAAA,YAAY,GAAG;IAC1B,WAAW,EAAE,aAAa;IAC1B,gBAAgB,EAAE,oBAAoB;IACtC,WAAW,EAAE,cAAc;IAC3B,aAAa,EAAE,iBAAiB;IAChC,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,eAAe;IAC7B,OAAO,EAAE,SAAS;CACV,CAAC;AAwBX,gBAAgB;AACH,QAAA,+BAA+B,GAIxC,SAAS,CAAC,aAAa,CAAC,yBAAiB,CAAC,CAAC;AAE/C,gBAAgB;AACH,QAAA,8BAA8B,GAIvC,SAAS,CAAC,aAAa,CAAC,wBAAgB,CAAC,CAAC;AAE9C,gBAAgB;AACH,QAAA,0BAA0B,GAInC,SAAS,CAAC,aAAa,CAAC,oBAAY,CAAC,CAAC;AAE1C,gBAAgB;AACH,QAAA,wBAAwB,GAIjC,CAAC,CAAC,MAAM,CAAC;IACX,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACvC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAC/D,IAAI,IAAI,CAAC,CAAC,CAAC,CACZ;IACD,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,uCAA+B;IACxC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,uBAAuB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzC,MAAM,EAAE,sCAA8B;IACtC,aAAa,EAAE,CAAC,CAAC,QAAQ,CAAC,kCAA0B,CAAC;IACrD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;CAC/B,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE;IACjB,OAAO,IAAA,qBAAM,EAAC,CAAC,EAAE;QACf,uBAAuB,EAAE,oBAAoB;QAC7C,aAAa,EAAE,YAAY;QAC3B,YAAY,EAAE,WAAW;QACzB,yBAAyB,EAAE,sBAAsB;QACjD,eAAe,EAAE,cAAc;QAC/B,cAAc,EAAE,aAAa;KAC9B,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,SAAgB,kBAAkB,CAChC,UAAkB;IAElB,OAAO,IAAA,sBAAS,EACd,UAAU,EACV,CAAC,CAAC,EAAE,EAAE,CAAC,gCAAwB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpD,wCAAwC,CACzC,CAAC;AACJ,CAAC"}
@@ -1,4 +1,16 @@
1
1
  import * as z from "zod/v3";
2
+ import { ClosedEnum } from "../../types/enums.js";
3
+ /**
4
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
5
+ */
6
+ export declare const CrudCreateInputBodyPrivacy: {
7
+ readonly Private: "private";
8
+ readonly Shared: "shared";
9
+ };
10
+ /**
11
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
12
+ */
13
+ export type CrudCreateInputBodyPrivacy = ClosedEnum<typeof CrudCreateInputBodyPrivacy>;
2
14
  export type CrudCreateInputBody = {
3
15
  /**
4
16
  * description of the collection
@@ -8,15 +20,22 @@ export type CrudCreateInputBody = {
8
20
  * name of the collection
9
21
  */
10
22
  name: string;
23
+ /**
24
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
25
+ */
26
+ privacy?: CrudCreateInputBodyPrivacy | undefined;
11
27
  /**
12
28
  * query string to search upon to build the collection
13
29
  */
14
30
  query: string;
15
31
  };
16
32
  /** @internal */
33
+ export declare const CrudCreateInputBodyPrivacy$outboundSchema: z.ZodNativeEnum<typeof CrudCreateInputBodyPrivacy>;
34
+ /** @internal */
17
35
  export type CrudCreateInputBody$Outbound = {
18
36
  description?: string | undefined;
19
37
  name: string;
38
+ privacy: string;
20
39
  query: string;
21
40
  };
22
41
  /** @internal */
@@ -1 +1 @@
1
- {"version":3,"file":"crudcreateinputbody.d.ts","sourceRoot":"","sources":["../../src/models/components/crudcreateinputbody.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,MAAM,MAAM,4BAA4B,GAAG;IACzC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,mBAAmB,CAKnB,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,mBAAmB,EAAE,mBAAmB,GACvC,MAAM,CAIR"}
1
+ {"version":3,"file":"crudcreateinputbody.d.ts","sourceRoot":"","sources":["../../src/models/components/crudcreateinputbody.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;CAG7B,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,UAAU,CACjD,OAAO,0BAA0B,CAClC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,0BAA0B,GAAG,SAAS,CAAC;IACjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yCAAyC,EAAE,CAAC,CAAC,aAAa,CACrE,OAAO,0BAA0B,CACS,CAAC;AAE7C,gBAAgB;AAChB,MAAM,MAAM,4BAA4B,GAAG;IACzC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,kCAAkC,EAAE,CAAC,CAAC,OAAO,CACxD,4BAA4B,EAC5B,CAAC,CAAC,UAAU,EACZ,mBAAmB,CAMnB,CAAC;AAEH,wBAAgB,yBAAyB,CACvC,mBAAmB,EAAE,mBAAmB,GACvC,MAAM,CAIR"}
@@ -36,13 +36,23 @@ var __importStar = (this && this.__importStar) || (function () {
36
36
  };
37
37
  })();
38
38
  Object.defineProperty(exports, "__esModule", { value: true });
39
- exports.CrudCreateInputBody$outboundSchema = void 0;
39
+ exports.CrudCreateInputBody$outboundSchema = exports.CrudCreateInputBodyPrivacy$outboundSchema = exports.CrudCreateInputBodyPrivacy = void 0;
40
40
  exports.crudCreateInputBodyToJSON = crudCreateInputBodyToJSON;
41
41
  const z = __importStar(require("zod/v3"));
42
+ /**
43
+ * Collection visibility. `private` collections are visible to their creator and organization admins. `shared` collections are also visible to all organization members. Only the creator and organization admins can edit a collection.
44
+ */
45
+ exports.CrudCreateInputBodyPrivacy = {
46
+ Private: "private",
47
+ Shared: "shared",
48
+ };
49
+ /** @internal */
50
+ exports.CrudCreateInputBodyPrivacy$outboundSchema = z.nativeEnum(exports.CrudCreateInputBodyPrivacy);
42
51
  /** @internal */
43
52
  exports.CrudCreateInputBody$outboundSchema = z.object({
44
53
  description: z.string().optional(),
45
54
  name: z.string(),
55
+ privacy: exports.CrudCreateInputBodyPrivacy$outboundSchema.default("private"),
46
56
  query: z.string(),
47
57
  });
48
58
  function crudCreateInputBodyToJSON(crudCreateInputBody) {
@@ -1 +1 @@
1
- {"version":3,"file":"crudcreateinputbody.js","sourceRoot":"","sources":["../../src/models/components/crudcreateinputbody.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqCH,8DAMC;AAzCD,0CAA4B;AAwB5B,gBAAgB;AACH,QAAA,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,SAAgB,yBAAyB,CACvC,mBAAwC;IAExC,OAAO,IAAI,CAAC,SAAS,CACnB,0CAAkC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAC9D,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"crudcreateinputbody.js","sourceRoot":"","sources":["../../src/models/components/crudcreateinputbody.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DH,8DAMC;AAnED,0CAA4B;AAG5B;;GAEG;AACU,QAAA,0BAA0B,GAAG;IACxC,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAC;AA2BX,gBAAgB;AACH,QAAA,yCAAyC,GAElD,CAAC,CAAC,UAAU,CAAC,kCAA0B,CAAC,CAAC;AAU7C,gBAAgB;AACH,QAAA,kCAAkC,GAI3C,CAAC,CAAC,MAAM,CAAC;IACX,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,iDAAyC,CAAC,OAAO,CAAC,SAAS,CAAC;IACrE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAC;AAEH,SAAgB,yBAAyB,CACvC,mBAAwC;IAExC,OAAO,IAAI,CAAC,SAAS,CACnB,0CAAkC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAC9D,CAAC;AACJ,CAAC"}