@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
432 lines • 24.3 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.DashboardSecureEmbedApi = exports.DashboardSecureEmbedApiResponseProcessor = exports.DashboardSecureEmbedApiRequestFactory = 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 DashboardSecureEmbedApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
createDashboardSecureEmbed(dashboardId, body, _options) {
return __awaiter(this, void 0, void 0, function* () {
const _config = _options || this.configuration;
logger_1.logger.warn("Using unstable operation 'createDashboardSecureEmbed'");
if (!_config.unstableOperations["v2.createDashboardSecureEmbed"]) {
throw new Error("Unstable operation 'createDashboardSecureEmbed' is disabled");
}
// verify required parameter 'dashboardId' is not null or undefined
if (dashboardId === null || dashboardId === undefined) {
throw new baseapi_1.RequiredError("dashboardId", "createDashboardSecureEmbed");
}
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new baseapi_1.RequiredError("body", "createDashboardSecureEmbed");
}
// Path Params
const localVarPath = "/api/v2/dashboard/{dashboard_id}/shared/secure-embed".replace("{dashboard_id}", encodeURIComponent(String(dashboardId)));
// Make Request Context
const requestContext = _config
.getServer("v2.DashboardSecureEmbedApi.createDashboardSecureEmbed")
.makeRequestContext(localVarPath, http_1.HttpMethod.POST);
requestContext.setHeaderParam("Accept", "application/json");
requestContext.setHttpConfig(_config.httpConfig);
// Body Params
const contentType = ObjectSerializer_1.ObjectSerializer.getPreferredMediaType([
"application/json",
]);
requestContext.setHeaderParam("Content-Type", contentType);
const serializedBody = ObjectSerializer_1.ObjectSerializer.stringify(ObjectSerializer_1.ObjectSerializer.serialize(body, "SecureEmbedCreateRequest", ""), contentType);
requestContext.setBody(serializedBody);
// Apply auth methods
(0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
"apiKeyAuth",
"appKeyAuth",
"AuthZ",
]);
return requestContext;
});
}
deleteDashboardSecureEmbed(dashboardId, token, _options) {
return __awaiter(this, void 0, void 0, function* () {
const _config = _options || this.configuration;
logger_1.logger.warn("Using unstable operation 'deleteDashboardSecureEmbed'");
if (!_config.unstableOperations["v2.deleteDashboardSecureEmbed"]) {
throw new Error("Unstable operation 'deleteDashboardSecureEmbed' is disabled");
}
// verify required parameter 'dashboardId' is not null or undefined
if (dashboardId === null || dashboardId === undefined) {
throw new baseapi_1.RequiredError("dashboardId", "deleteDashboardSecureEmbed");
}
// verify required parameter 'token' is not null or undefined
if (token === null || token === undefined) {
throw new baseapi_1.RequiredError("token", "deleteDashboardSecureEmbed");
}
// Path Params
const localVarPath = "/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}"
.replace("{dashboard_id}", encodeURIComponent(String(dashboardId)))
.replace("{token}", encodeURIComponent(String(token)));
// Make Request Context
const requestContext = _config
.getServer("v2.DashboardSecureEmbedApi.deleteDashboardSecureEmbed")
.makeRequestContext(localVarPath, http_1.HttpMethod.DELETE);
requestContext.setHeaderParam("Accept", "*/*");
requestContext.setHttpConfig(_config.httpConfig);
// Apply auth methods
(0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
"apiKeyAuth",
"appKeyAuth",
"AuthZ",
]);
return requestContext;
});
}
getDashboardSecureEmbed(dashboardId, token, _options) {
return __awaiter(this, void 0, void 0, function* () {
const _config = _options || this.configuration;
logger_1.logger.warn("Using unstable operation 'getDashboardSecureEmbed'");
if (!_config.unstableOperations["v2.getDashboardSecureEmbed"]) {
throw new Error("Unstable operation 'getDashboardSecureEmbed' is disabled");
}
// verify required parameter 'dashboardId' is not null or undefined
if (dashboardId === null || dashboardId === undefined) {
throw new baseapi_1.RequiredError("dashboardId", "getDashboardSecureEmbed");
}
// verify required parameter 'token' is not null or undefined
if (token === null || token === undefined) {
throw new baseapi_1.RequiredError("token", "getDashboardSecureEmbed");
}
// Path Params
const localVarPath = "/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}"
.replace("{dashboard_id}", encodeURIComponent(String(dashboardId)))
.replace("{token}", encodeURIComponent(String(token)));
// Make Request Context
const requestContext = _config
.getServer("v2.DashboardSecureEmbedApi.getDashboardSecureEmbed")
.makeRequestContext(localVarPath, http_1.HttpMethod.GET);
requestContext.setHeaderParam("Accept", "application/json");
requestContext.setHttpConfig(_config.httpConfig);
// Apply auth methods
(0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
"apiKeyAuth",
"appKeyAuth",
"AuthZ",
]);
return requestContext;
});
}
updateDashboardSecureEmbed(dashboardId, token, body, _options) {
return __awaiter(this, void 0, void 0, function* () {
const _config = _options || this.configuration;
logger_1.logger.warn("Using unstable operation 'updateDashboardSecureEmbed'");
if (!_config.unstableOperations["v2.updateDashboardSecureEmbed"]) {
throw new Error("Unstable operation 'updateDashboardSecureEmbed' is disabled");
}
// verify required parameter 'dashboardId' is not null or undefined
if (dashboardId === null || dashboardId === undefined) {
throw new baseapi_1.RequiredError("dashboardId", "updateDashboardSecureEmbed");
}
// verify required parameter 'token' is not null or undefined
if (token === null || token === undefined) {
throw new baseapi_1.RequiredError("token", "updateDashboardSecureEmbed");
}
// verify required parameter 'body' is not null or undefined
if (body === null || body === undefined) {
throw new baseapi_1.RequiredError("body", "updateDashboardSecureEmbed");
}
// Path Params
const localVarPath = "/api/v2/dashboard/{dashboard_id}/shared/secure-embed/{token}"
.replace("{dashboard_id}", encodeURIComponent(String(dashboardId)))
.replace("{token}", encodeURIComponent(String(token)));
// Make Request Context
const requestContext = _config
.getServer("v2.DashboardSecureEmbedApi.updateDashboardSecureEmbed")
.makeRequestContext(localVarPath, http_1.HttpMethod.PATCH);
requestContext.setHeaderParam("Accept", "application/json");
requestContext.setHttpConfig(_config.httpConfig);
// Body Params
const contentType = ObjectSerializer_1.ObjectSerializer.getPreferredMediaType([
"application/json",
]);
requestContext.setHeaderParam("Content-Type", contentType);
const serializedBody = ObjectSerializer_1.ObjectSerializer.stringify(ObjectSerializer_1.ObjectSerializer.serialize(body, "SecureEmbedUpdateRequest", ""), contentType);
requestContext.setBody(serializedBody);
// Apply auth methods
(0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
"apiKeyAuth",
"appKeyAuth",
"AuthZ",
]);
return requestContext;
});
}
}
exports.DashboardSecureEmbedApiRequestFactory = DashboardSecureEmbedApiRequestFactory;
class DashboardSecureEmbedApiResponseProcessor {
/**
* 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 createDashboardSecureEmbed
* @throws ApiException if the response code was not in [200, 299]
*/
createDashboardSecureEmbed(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), "SecureEmbedCreateResponse");
return body;
}
if (response.httpStatusCode === 403 ||
response.httpStatusCode === 404 ||
response.httpStatusCode === 409) {
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), "SecureEmbedCreateResponse", "");
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
*
* @params response Response returned by the server for a request to deleteDashboardSecureEmbed
* @throws ApiException if the response code was not in [200, 299]
*/
deleteDashboardSecureEmbed(response) {
return __awaiter(this, void 0, void 0, function* () {
const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
if (response.httpStatusCode === 204) {
return;
}
if (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) {
return;
}
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
*
* @params response Response returned by the server for a request to getDashboardSecureEmbed
* @throws ApiException if the response code was not in [200, 299]
*/
getDashboardSecureEmbed(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), "SecureEmbedGetResponse");
return body;
}
if (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), "SecureEmbedGetResponse", "");
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
*
* @params response Response returned by the server for a request to updateDashboardSecureEmbed
* @throws ApiException if the response code was not in [200, 299]
*/
updateDashboardSecureEmbed(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), "SecureEmbedUpdateResponse");
return body;
}
if (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), "SecureEmbedUpdateResponse", "");
return body;
}
const body = (yield response.body.text()) || "";
throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
});
}
}
exports.DashboardSecureEmbedApiResponseProcessor = DashboardSecureEmbedApiResponseProcessor;
class DashboardSecureEmbedApi {
constructor(configuration, requestFactory, responseProcessor) {
this.configuration = configuration;
this.requestFactory =
requestFactory ||
new DashboardSecureEmbedApiRequestFactory(configuration);
this.responseProcessor =
responseProcessor || new DashboardSecureEmbedApiResponseProcessor();
}
/**
* Create a secure embed share for a dashboard. The response includes a one-time `credential` used for HMAC-SHA256 signing. Store it securely — it cannot be retrieved again.
* @param param The request object
*/
createDashboardSecureEmbed(param, options) {
const requestContextPromise = this.requestFactory.createDashboardSecureEmbed(param.dashboardId, param.body, options);
return requestContextPromise.then((requestContext) => {
return this.configuration.httpApi
.send(requestContext)
.then((responseContext) => {
return this.responseProcessor.createDashboardSecureEmbed(responseContext);
});
});
}
/**
* Delete a secure embed share for a dashboard.
* @param param The request object
*/
deleteDashboardSecureEmbed(param, options) {
const requestContextPromise = this.requestFactory.deleteDashboardSecureEmbed(param.dashboardId, param.token, options);
return requestContextPromise.then((requestContext) => {
return this.configuration.httpApi
.send(requestContext)
.then((responseContext) => {
return this.responseProcessor.deleteDashboardSecureEmbed(responseContext);
});
});
}
/**
* Retrieve an existing secure embed configuration for a dashboard.
* @param param The request object
*/
getDashboardSecureEmbed(param, options) {
const requestContextPromise = this.requestFactory.getDashboardSecureEmbed(param.dashboardId, param.token, options);
return requestContextPromise.then((requestContext) => {
return this.configuration.httpApi
.send(requestContext)
.then((responseContext) => {
return this.responseProcessor.getDashboardSecureEmbed(responseContext);
});
});
}
/**
* Partially update a secure embed configuration. All fields are optional (PATCH semantics).
* @param param The request object
*/
updateDashboardSecureEmbed(param, options) {
const requestContextPromise = this.requestFactory.updateDashboardSecureEmbed(param.dashboardId, param.token, param.body, options);
return requestContextPromise.then((requestContext) => {
return this.configuration.httpApi
.send(requestContext)
.then((responseContext) => {
return this.responseProcessor.updateDashboardSecureEmbed(responseContext);
});
});
}
}
exports.DashboardSecureEmbedApi = DashboardSecureEmbedApi;
//# sourceMappingURL=DashboardSecureEmbedApi.js.map