@datadog/datadog-api-client 1.45.0 → 1.46.0

package/dist/packages/datadog-api-client-v2/apis/SecurityMonitoringApi.js

@@ -764,7 +764,7 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             return requestContext;
         });
     }
-    getSBOM(assetType, filterAssetName, filterRepoDigest, _options) {
+    getSBOM(assetType, filterAssetName, filterRepoDigest, extFormat, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
             logger_1.logger.warn("Using unstable operation 'getSBOM'");
@@ -794,6 +794,9 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             if (filterRepoDigest !== undefined) {
                 requestContext.setQueryParam("filter[repo_digest]", ObjectSerializer_1.ObjectSerializer.serialize(filterRepoDigest, "string", ""), "");
             }
+            if (extFormat !== undefined) {
+                requestContext.setQueryParam("ext:format", ObjectSerializer_1.ObjectSerializer.serialize(extFormat, "SBOMFormat", ""), "");
+            }
             // Apply auth methods
             (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
                 "apiKeyAuth",
@@ -1267,6 +1270,48 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             return requestContext;
         });
     }
+    listScannedAssetsMetadata(pageToken, pageNumber, filterAssetType, filterAssetName, filterLastSuccessOrigin, filterLastSuccessEnv, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'listScannedAssetsMetadata'");
+            if (!_config.unstableOperations["v2.listScannedAssetsMetadata"]) {
+                throw new Error("Unstable operation 'listScannedAssetsMetadata' is disabled");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/security/scanned-assets-metadata";
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.SecurityMonitoringApi.listScannedAssetsMetadata")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Query Params
+            if (pageToken !== undefined) {
+                requestContext.setQueryParam("page[token]", ObjectSerializer_1.ObjectSerializer.serialize(pageToken, "string", ""), "");
+            }
+            if (pageNumber !== undefined) {
+                requestContext.setQueryParam("page[number]", ObjectSerializer_1.ObjectSerializer.serialize(pageNumber, "number", "int64"), "");
+            }
+            if (filterAssetType !== undefined) {
+                requestContext.setQueryParam("filter[asset.type]", ObjectSerializer_1.ObjectSerializer.serialize(filterAssetType, "CloudAssetType", ""), "");
+            }
+            if (filterAssetName !== undefined) {
+                requestContext.setQueryParam("filter[asset.name]", ObjectSerializer_1.ObjectSerializer.serialize(filterAssetName, "string", ""), "");
+            }
+            if (filterLastSuccessOrigin !== undefined) {
+                requestContext.setQueryParam("filter[last_success.origin]", ObjectSerializer_1.ObjectSerializer.serialize(filterLastSuccessOrigin, "string", ""), "");
+            }
+            if (filterLastSuccessEnv !== undefined) {
+                requestContext.setQueryParam("filter[last_success.env]", ObjectSerializer_1.ObjectSerializer.serialize(filterLastSuccessEnv, "string", ""), "");
+            }
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+            ]);
+            return requestContext;
+        });
+    }
     listSecurityFilters(_options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -1476,7 +1521,7 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
                 requestContext.setQueryParam("filter[library.version]", ObjectSerializer_1.ObjectSerializer.serialize(filterLibraryVersion, "string", ""), "");
             }
             if (filterAdvisoryId !== undefined) {
-                requestContext.setQueryParam("filter[advisory_id]", ObjectSerializer_1.ObjectSerializer.serialize(filterAdvisoryId, "string", ""), "");
+                requestContext.setQueryParam("filter[advisory.id]", ObjectSerializer_1.ObjectSerializer.serialize(filterAdvisoryId, "string", ""), "");
             }
             if (filterRisksExploitationProbability !== undefined) {
                 requestContext.setQueryParam("filter[risks.exploitation_probability]", ObjectSerializer_1.ObjectSerializer.serialize(filterRisksExploitationProbability, "boolean", ""), "");
@@ -1578,7 +1623,7 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
                 throw new Error("Unstable operation 'listVulnerableAssets' is disabled");
             }
             // Path Params
-            const localVarPath = "/api/v2/security/assets";
+            const localVarPath = "/api/v2/security/vulnerable-assets";
             // Make Request Context
             const requestContext = _config
                 .getServer("v2.SecurityMonitoringApi.listVulnerableAssets")
@@ -3690,6 +3735,55 @@ class SecurityMonitoringApiResponseProcessor {
             throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
         });
     }
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to listScannedAssetsMetadata
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listScannedAssetsMetadata(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ScannedAssetsMetadata");
+                return body;
+            }
+            if (response.httpStatusCode === 400 ||
+                response.httpStatusCode === 403 ||
+                response.httpStatusCode === 404) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "JSONAPIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            if (response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ScannedAssetsMetadata", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -4930,7 +5024,7 @@ class SecurityMonitoringApi {
      * @param param The request object
      */
     getSBOM(param, options) {
-        const requestContextPromise = this.requestFactory.getSBOM(param.assetType, param.filterAssetName, param.filterRepoDigest, options);
+        const requestContextPromise = this.requestFactory.getSBOM(param.assetType, param.filterAssetName, param.filterRepoDigest, param.extFormat, options);
         return requestContextPromise.then((requestContext) => {
             return this.configuration.httpApi
                 .send(requestContext)
@@ -5248,6 +5342,63 @@ class SecurityMonitoringApi {
             });
         });
     }
+    /**
+     * Get a list of security scanned assets metadata for an organization.
+     *
+     * ### Pagination
+     *
+     * For the "List Vulnerabilities" endpoint, see the [Pagination section](#pagination).
+     *
+     * ### Filtering
+     *
+     * For the "List Vulnerabilities" endpoint, see the [Filtering section](#filtering).
+     *
+     * ### Metadata
+     *
+     *  For the "List Vulnerabilities" endpoint, see the [Metadata section](#metadata).
+     *
+     * ### Related endpoints
+     *
+     * This endpoint returns additional metadata for cloud resources that is not available from the standard resource endpoints. To access a richer dataset, call this endpoint together with the relevant resource endpoint(s) and merge (join) their results using the resource identifier.
+     *
+     * **Hosts**
+     *
+     * To enrich host data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+     *
+     * | ENDPOINT | JOIN KEY | TYPE |
+     * | --- | --- | --- |
+     * | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.host_name | string |
+     * | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+     *
+     * **Host Images**
+     *
+     * To enrich host image data, join the response from the [Hosts](https://docs.datadoghq.com/api/latest/hosts/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+     *
+     * | ENDPOINT | JOIN KEY | TYPE |
+     * | --- | --- | --- |
+     * | [/api/v1/hosts](https://docs.datadoghq.com/api/latest/hosts/) | host_list.tags_by_source["Amazon Web Services"]["image"] | string |
+     * | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+     *
+     * **Container Images**
+     *
+     * To enrich container image data, join the response from the [Container Images](https://docs.datadoghq.com/api/latest/container-images/) endpoint with the response from the scanned-assets-metadata endpoint on the following key fields:
+     *
+     * | ENDPOINT | JOIN KEY | TYPE |
+     * | --- | --- | --- |
+     * | [/api/v2/container_images](https://docs.datadoghq.com/api/latest/container-images/) | `data.attributes.name`@`data.attributes.repo_digest` | string |
+     * | /api/v2/security/scanned-assets-metadata | data.attributes.asset.name | string |
+     * @param param The request object
+     */
+    listScannedAssetsMetadata(param = {}, options) {
+        const requestContextPromise = this.requestFactory.listScannedAssetsMetadata(param.pageToken, param.pageNumber, param.filterAssetType, param.filterAssetName, param.filterLastSuccessOrigin, param.filterLastSuccessEnv, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.listScannedAssetsMetadata(responseContext);
+            });
+        });
+    }
     /**
      * Get the list of configured security filters with their definitions.
      * @param param The request object
@@ -5403,6 +5554,8 @@ class SecurityMonitoringApi {
      *
      * This token can then be used in the subsequent paginated requests.
      *
+     * *Note: The first request may take longer to complete than subsequent requests.*
+     *
      * #### Subsequent requests
      *
      * Any request containing valid `page[token]` and `page[number]` parameters will be considered a subsequent request.
@@ -5411,6 +5564,8 @@ class SecurityMonitoringApi {
      *
      * If the page `number` is invalid, a `400` response will be returned.
      *
+     * The returned `token` is valid for all requests in the pagination sequence. To send paginated requests in parallel, reuse the same `token` and change only the `page[number]` parameter.
+     *
      * ### Filtering
      *
      * The request can include some filter parameters to filter the data to be retrieved. The format of the filter parameters follows the [JSON:API format](https://jsonapi.org/format/#fetching-filtering): `filter[$prop_name]`, where `prop_name` is the property name in the entity being filtered by.
@@ -5442,6 +5597,11 @@ class SecurityMonitoringApi {
      *   "links": {...}
      * }
      * ```
+     * ### Extensions
+     *
+     * Requests may include extensions to modify the behavior of the requested endpoint. The filter parameters follow the [JSON:API format](https://jsonapi.org/extensions/#extensions) format: `ext:$extension_name`, where `extension_name` is the name of the modifier that is being applied.
+     *
+     * Extensions can only include one value: `ext:modifier=value`.
      * @param param The request object
      */
     listVulnerabilities(param = {}, options) {