@datadog/datadog-api-client 1.48.0 → 1.50.0

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

@@ -69,6 +69,10 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
     attachJiraIssue(body, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'attachJiraIssue'");
+            if (!_config.unstableOperations["v2.attachJiraIssue"]) {
+                throw new Error("Unstable operation 'attachJiraIssue' is disabled");
+            }
             // verify required parameter 'body' is not null or undefined
             if (body === null || body === undefined) {
                 throw new baseapi_1.RequiredError("body", "attachJiraIssue");
@@ -279,6 +283,10 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
     createJiraIssues(body, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'createJiraIssues'");
+            if (!_config.unstableOperations["v2.createJiraIssues"]) {
+                throw new Error("Unstable operation 'createJiraIssues' is disabled");
+            }
             // verify required parameter 'body' is not null or undefined
             if (body === null || body === undefined) {
                 throw new baseapi_1.RequiredError("body", "createJiraIssues");
@@ -1228,6 +1236,37 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             return requestContext;
         });
     }
+    getSuppressionVersionHistory(suppressionId, pageSize, pageNumber, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            // verify required parameter 'suppressionId' is not null or undefined
+            if (suppressionId === null || suppressionId === undefined) {
+                throw new baseapi_1.RequiredError("suppressionId", "getSuppressionVersionHistory");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/security_monitoring/configuration/suppressions/{suppression_id}/version_history".replace("{suppression_id}", encodeURIComponent(String(suppressionId)));
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.SecurityMonitoringApi.getSuppressionVersionHistory")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Query Params
+            if (pageSize !== undefined) {
+                requestContext.setQueryParam("page[size]", ObjectSerializer_1.ObjectSerializer.serialize(pageSize, "number", "int64"), "");
+            }
+            if (pageNumber !== undefined) {
+                requestContext.setQueryParam("page[number]", ObjectSerializer_1.ObjectSerializer.serialize(pageNumber, "number", "int64"), "");
+            }
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+                "AuthZ",
+            ]);
+            return requestContext;
+        });
+    }
     getThreatHuntingJob(jobId, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -1683,7 +1722,7 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             return requestContext;
         });
     }
-    listVulnerabilities(pageToken, pageNumber, filterType, filterCvssBaseScoreOp, filterCvssBaseSeverity, filterCvssBaseVector, filterCvssDatadogScoreOp, filterCvssDatadogSeverity, filterCvssDatadogVector, filterStatus, filterTool, filterLibraryName, filterLibraryVersion, filterAdvisoryId, filterRisksExploitationProbability, filterRisksPocExploitAvailable, filterRisksExploitAvailable, filterRisksEpssScoreOp, filterRisksEpssSeverity, filterLanguage, filterEcosystem, filterCodeLocationLocation, filterCodeLocationFilePath, filterCodeLocationMethod, filterFixAvailable, filterRepoDigests, filterOrigin, filterAssetName, filterAssetType, filterAssetVersionFirst, filterAssetVersionLast, filterAssetRepositoryUrl, filterAssetRisksInProduction, filterAssetRisksUnderAttack, filterAssetRisksIsPubliclyAccessible, filterAssetRisksHasPrivilegedAccess, filterAssetRisksHasAccessToSensitiveData, filterAssetEnvironments, filterAssetTeams, filterAssetArch, filterAssetOperatingSystemName, filterAssetOperatingSystemVersion, _options) {
+    listVulnerabilities(pageToken, pageNumber, filterType, filterCvssBaseScoreOp, filterCvssBaseSeverity, filterCvssBaseVector, filterCvssDatadogScoreOp, filterCvssDatadogSeverity, filterCvssDatadogVector, filterStatus, filterTool, filterLibraryName, filterLibraryVersion, filterAdvisoryId, filterRisksExploitationProbability, filterRisksPocExploitAvailable, filterRisksExploitAvailable, filterRisksEpssScoreOp, filterRisksEpssSeverity, filterLanguage, filterEcosystem, filterCodeLocationLocation, filterCodeLocationFilePath, filterCodeLocationMethod, filterFixAvailable, filterRepoDigests, filterOrigin, filterRunningKernel, filterAssetName, filterAssetType, filterAssetVersionFirst, filterAssetVersionLast, filterAssetRepositoryUrl, filterAssetRisksInProduction, filterAssetRisksUnderAttack, filterAssetRisksIsPubliclyAccessible, filterAssetRisksHasPrivilegedAccess, filterAssetRisksHasAccessToSensitiveData, filterAssetEnvironments, filterAssetTeams, filterAssetArch, filterAssetOperatingSystemName, filterAssetOperatingSystemVersion, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
             logger_1.logger.warn("Using unstable operation 'listVulnerabilities'");
@@ -1780,6 +1819,9 @@ class SecurityMonitoringApiRequestFactory extends baseapi_1.BaseAPIRequestFactor
             if (filterOrigin !== undefined) {
                 requestContext.setQueryParam("filter[origin]", ObjectSerializer_1.ObjectSerializer.serialize(filterOrigin, "string", ""), "");
             }
+            if (filterRunningKernel !== undefined) {
+                requestContext.setQueryParam("filter[running_kernel]", ObjectSerializer_1.ObjectSerializer.serialize(filterRunningKernel, "boolean", ""), "");
+            }
             if (filterAssetName !== undefined) {
                 requestContext.setQueryParam("filter[asset.name]", ObjectSerializer_1.ObjectSerializer.serialize(filterAssetName, "string", ""), "");
             }
@@ -3937,6 +3979,43 @@ 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 getSuppressionVersionHistory
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getSuppressionVersionHistory(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), "GetSuppressionVersionHistoryResponse");
+                return body;
+            }
+            if (response.httpStatusCode === 403 ||
+                response.httpStatusCode === 404 ||
+                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), "GetSuppressionVersionHistoryResponse", "");
+                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
@@ -5137,7 +5216,8 @@ class SecurityMonitoringApi {
             responseProcessor || new SecurityMonitoringApiResponseProcessor();
     }
     /**
-     * Attach security findings to a case. You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.
+     * Attach security findings to a case.
+     * You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.
      * @param param The request object
      */
     attachCase(param, options) {
@@ -5151,7 +5231,8 @@ class SecurityMonitoringApi {
         });
     }
     /**
-     * Attach security findings to a Jira issue by providing the Jira issue URL. You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.
+     * Attach security findings to a Jira issue by providing the Jira issue URL.
+     * You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.
      * @param param The request object
      */
     attachJiraIssue(param, options) {
@@ -5233,7 +5314,8 @@ class SecurityMonitoringApi {
         });
     }
     /**
-     * Create cases for security findings. You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.
+     * Create cases for security findings.
+     * You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.
      * @param param The request object
      */
     createCases(param, options) {
@@ -5261,7 +5343,8 @@ class SecurityMonitoringApi {
         });
     }
     /**
-     * Create Jira issues for security findings. This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.
+     * Create Jira issues for security findings.
+     * This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. To configure the Jira integration, see [Bidirectional ticket syncing with Jira](https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira). You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.
      * @param param The request object
      */
     createJiraIssues(param, options) {
@@ -5446,7 +5529,8 @@ class SecurityMonitoringApi {
         });
     }
     /**
-     * Detach security findings from their case. This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.
+     * Detach security findings from their case.
+     * This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.
      * @param param The request object
      */
     detachCase(param, options) {
@@ -5572,7 +5656,7 @@ class SecurityMonitoringApi {
         });
     }
     /**
-     * Returns list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID
+     * Returns a list of Secrets rules with ID, Pattern, Description, Priority, and SDS ID.
      * @param param The request object
      */
     getSecretsRules(options) {
@@ -5728,6 +5812,20 @@ class SecurityMonitoringApi {
             });
         });
     }
+    /**
+     * Get a suppression's version history.
+     * @param param The request object
+     */
+    getSuppressionVersionHistory(param, options) {
+        const requestContextPromise = this.requestFactory.getSuppressionVersionHistory(param.suppressionId, param.pageSize, param.pageNumber, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.getSuppressionVersionHistory(responseContext);
+            });
+        });
+    }
     /**
      * Get a job's details.
      * @param param The request object
@@ -6185,7 +6283,7 @@ class SecurityMonitoringApi {
      * @param param The request object
      */
     listVulnerabilities(param = {}, options) {
-        const requestContextPromise = this.requestFactory.listVulnerabilities(param.pageToken, param.pageNumber, param.filterType, param.filterCvssBaseScoreOp, param.filterCvssBaseSeverity, param.filterCvssBaseVector, param.filterCvssDatadogScoreOp, param.filterCvssDatadogSeverity, param.filterCvssDatadogVector, param.filterStatus, param.filterTool, param.filterLibraryName, param.filterLibraryVersion, param.filterAdvisoryId, param.filterRisksExploitationProbability, param.filterRisksPocExploitAvailable, param.filterRisksExploitAvailable, param.filterRisksEpssScoreOp, param.filterRisksEpssSeverity, param.filterLanguage, param.filterEcosystem, param.filterCodeLocationLocation, param.filterCodeLocationFilePath, param.filterCodeLocationMethod, param.filterFixAvailable, param.filterRepoDigests, param.filterOrigin, param.filterAssetName, param.filterAssetType, param.filterAssetVersionFirst, param.filterAssetVersionLast, param.filterAssetRepositoryUrl, param.filterAssetRisksInProduction, param.filterAssetRisksUnderAttack, param.filterAssetRisksIsPubliclyAccessible, param.filterAssetRisksHasPrivilegedAccess, param.filterAssetRisksHasAccessToSensitiveData, param.filterAssetEnvironments, param.filterAssetTeams, param.filterAssetArch, param.filterAssetOperatingSystemName, param.filterAssetOperatingSystemVersion, options);
+        const requestContextPromise = this.requestFactory.listVulnerabilities(param.pageToken, param.pageNumber, param.filterType, param.filterCvssBaseScoreOp, param.filterCvssBaseSeverity, param.filterCvssBaseVector, param.filterCvssDatadogScoreOp, param.filterCvssDatadogSeverity, param.filterCvssDatadogVector, param.filterStatus, param.filterTool, param.filterLibraryName, param.filterLibraryVersion, param.filterAdvisoryId, param.filterRisksExploitationProbability, param.filterRisksPocExploitAvailable, param.filterRisksExploitAvailable, param.filterRisksEpssScoreOp, param.filterRisksEpssSeverity, param.filterLanguage, param.filterEcosystem, param.filterCodeLocationLocation, param.filterCodeLocationFilePath, param.filterCodeLocationMethod, param.filterFixAvailable, param.filterRepoDigests, param.filterOrigin, param.filterRunningKernel, param.filterAssetName, param.filterAssetType, param.filterAssetVersionFirst, param.filterAssetVersionLast, param.filterAssetRepositoryUrl, param.filterAssetRisksInProduction, param.filterAssetRisksUnderAttack, param.filterAssetRisksIsPubliclyAccessible, param.filterAssetRisksHasPrivilegedAccess, param.filterAssetRisksHasAccessToSensitiveData, param.filterAssetEnvironments, param.filterAssetTeams, param.filterAssetArch, param.filterAssetOperatingSystemName, param.filterAssetOperatingSystemVersion, options);
         return requestContextPromise.then((requestContext) => {
             return this.configuration.httpApi
                 .send(requestContext)