@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
149 lines • 8.8 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ComplianceApi = exports.ComplianceApiResponseProcessor = exports.ComplianceApiRequestFactory = void 0;
const baseapi_1 = require("../../datadog-api-client-common/baseapi");
const configuration_1 = require("../../datadog-api-client-common/configuration");
const http_1 = require("../../datadog-api-client-common/http/http");
const logger_1 = require("../../../logger");
const ObjectSerializer_1 = require("../models/ObjectSerializer");
const exception_1 = require("../../datadog-api-client-common/exception");
class ComplianceApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
getRuleBasedView(to, framework, version, queryFindingsWithoutFrameworkVersion, includeRulesWithoutFindings, isCustom, query, _options) {
return __awaiter(this, void 0, void 0, function* () {
const _config = _options || this.configuration;
logger_1.logger.warn("Using unstable operation 'getRuleBasedView'");
if (!_config.unstableOperations["v2.getRuleBasedView"]) {
throw new Error("Unstable operation 'getRuleBasedView' is disabled");
}
// verify required parameter 'to' is not null or undefined
if (to === null || to === undefined) {
throw new baseapi_1.RequiredError("to", "getRuleBasedView");
}
// Path Params
const localVarPath = "/api/v2/compliance_findings/rule_based_view";
// Make Request Context
const requestContext = _config
.getServer("v2.ComplianceApi.getRuleBasedView")
.makeRequestContext(localVarPath, http_1.HttpMethod.GET);
requestContext.setHeaderParam("Accept", "application/json");
requestContext.setHttpConfig(_config.httpConfig);
// Query Params
if (to !== undefined) {
requestContext.setQueryParam("to", ObjectSerializer_1.ObjectSerializer.serialize(to, "number", "int64"), "");
}
if (framework !== undefined) {
requestContext.setQueryParam("framework", ObjectSerializer_1.ObjectSerializer.serialize(framework, "string", ""), "");
}
if (version !== undefined) {
requestContext.setQueryParam("version", ObjectSerializer_1.ObjectSerializer.serialize(version, "string", ""), "");
}
if (queryFindingsWithoutFrameworkVersion !== undefined) {
requestContext.setQueryParam("query_findings_without_framework_version", ObjectSerializer_1.ObjectSerializer.serialize(queryFindingsWithoutFrameworkVersion, "boolean", ""), "");
}
if (includeRulesWithoutFindings !== undefined) {
requestContext.setQueryParam("include_rules_without_findings", ObjectSerializer_1.ObjectSerializer.serialize(includeRulesWithoutFindings, "boolean", ""), "");
}
if (isCustom !== undefined) {
requestContext.setQueryParam("is_custom", ObjectSerializer_1.ObjectSerializer.serialize(isCustom, "boolean", ""), "");
}
if (query !== undefined) {
requestContext.setQueryParam("query", ObjectSerializer_1.ObjectSerializer.serialize(query, "string", ""), "");
}
// Apply auth methods
(0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
"apiKeyAuth",
"appKeyAuth",
"AuthZ",
]);
return requestContext;
});
}
}
exports.ComplianceApiRequestFactory = ComplianceApiRequestFactory;
class ComplianceApiResponseProcessor {
/**
* 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 getRuleBasedView
* @throws ApiException if the response code was not in [200, 299]
*/
getRuleBasedView(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), "RuleBasedViewResponse");
return body;
}
if (response.httpStatusCode === 400 || response.httpStatusCode === 503) {
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 === 403 || 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), "RuleBasedViewResponse", "");
return body;
}
const body = (yield response.body.text()) || "";
throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
});
}
}
exports.ComplianceApiResponseProcessor = ComplianceApiResponseProcessor;
class ComplianceApi {
constructor(configuration, requestFactory, responseProcessor) {
this.configuration = configuration;
this.requestFactory =
requestFactory || new ComplianceApiRequestFactory(configuration);
this.responseProcessor =
responseProcessor || new ComplianceApiResponseProcessor();
}
/**
* **This endpoint is deprecated.** Use the [Security Monitoring - Search Security Findings](https://docs.datadoghq.com/api/latest/security-monitoring/search-security-findings/) endpoint instead.
*
* Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
* Supports filtering by compliance framework, framework version, and additional query filters.
* @param param The request object
*/
getRuleBasedView(param, options) {
const requestContextPromise = this.requestFactory.getRuleBasedView(param.to, param.framework, param.version, param.queryFindingsWithoutFrameworkVersion, param.includeRulesWithoutFindings, param.isCustom, param.query, options);
return requestContextPromise.then((requestContext) => {
return this.configuration.httpApi
.send(requestContext)
.then((responseContext) => {
return this.responseProcessor.getRuleBasedView(responseContext);
});
});
}
}
exports.ComplianceApi = ComplianceApi;
//# sourceMappingURL=ComplianceApi.js.map