@datadog/datadog-api-client 1.59.0 → 1.60.0

package/dist/packages/datadog-api-client-v2/apis/StatusPagesApi.d.ts

@@ -9,10 +9,12 @@ import { CreateMaintenanceRequest } from "../models/CreateMaintenanceRequest";
 import { CreateStatusPageRequest } from "../models/CreateStatusPageRequest";
 import { Degradation } from "../models/Degradation";
 import { DegradationArray } from "../models/DegradationArray";
+import { DegradationUpdate } from "../models/DegradationUpdate";
 import { Maintenance } from "../models/Maintenance";
 import { MaintenanceArray } from "../models/MaintenanceArray";
 import { PatchComponentRequest } from "../models/PatchComponentRequest";
 import { PatchDegradationRequest } from "../models/PatchDegradationRequest";
+import { PatchDegradationUpdateRequest } from "../models/PatchDegradationUpdateRequest";
 import { PatchMaintenanceRequest } from "../models/PatchMaintenanceRequest";
 import { PatchStatusPageRequest } from "../models/PatchStatusPageRequest";
 import { StatusPage } from "../models/StatusPage";
@@ -29,6 +31,7 @@ export declare class StatusPagesApiRequestFactory extends BaseAPIRequestFactory
     deleteComponent(pageId: string, componentId: string, _options?: Configuration): Promise<RequestContext>;
     deleteDegradation(pageId: string, degradationId: string, _options?: Configuration): Promise<RequestContext>;
     deleteStatusPage(pageId: string, _options?: Configuration): Promise<RequestContext>;
+    editDegradationUpdate(degradationId: string, pageId: string, updateId: string, body: PatchDegradationUpdateRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     getComponent(pageId: string, componentId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getDegradation(pageId: string, degradationId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getMaintenance(pageId: string, maintenanceId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
@@ -38,6 +41,7 @@ export declare class StatusPagesApiRequestFactory extends BaseAPIRequestFactory
     listMaintenances(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, sort?: string, _options?: Configuration): Promise<RequestContext>;
     listStatusPages(pageOffset?: number, pageLimit?: number, filterDomainPrefix?: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     publishStatusPage(pageId: string, _options?: Configuration): Promise<RequestContext>;
+    softDeleteDegradationUpdate(degradationId: string, pageId: string, updateId: string, _options?: Configuration): Promise<RequestContext>;
     unpublishStatusPage(pageId: string, _options?: Configuration): Promise<RequestContext>;
     updateComponent(pageId: string, componentId: string, body: PatchComponentRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     updateDegradation(pageId: string, degradationId: string, body: PatchDegradationRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise<RequestContext>;
@@ -117,6 +121,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     deleteStatusPage(response: ResponseContext): Promise<void>;
+    /**
+     * 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 editDegradationUpdate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    editDegradationUpdate(response: ResponseContext): Promise<DegradationUpdate>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -189,6 +201,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     publishStatusPage(response: ResponseContext): Promise<void>;
+    /**
+     * 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 softDeleteDegradationUpdate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    softDeleteDegradationUpdate(response: ResponseContext): Promise<void>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -362,6 +382,32 @@ export interface StatusPagesApiDeleteStatusPageRequest {
      */
     pageId: string;
 }
+export interface StatusPagesApiEditDegradationUpdateRequest {
+    /**
+     * The ID of the degradation.
+     * @type string
+     */
+    degradationId: string;
+    /**
+     * The ID of the status page.
+     * @type string
+     */
+    pageId: string;
+    /**
+     * The ID of the degradation update.
+     * @type string
+     */
+    updateId: string;
+    /**
+     * @type PatchDegradationUpdateRequest
+     */
+    body: PatchDegradationUpdateRequest;
+    /**
+     * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, degradation, status_page.
+     * @type string
+     */
+    include?: string;
+}
 export interface StatusPagesApiGetComponentRequest {
     /**
      * The ID of the status page.
@@ -530,6 +576,23 @@ export interface StatusPagesApiPublishStatusPageRequest {
      */
     pageId: string;
 }
+export interface StatusPagesApiSoftDeleteDegradationUpdateRequest {
+    /**
+     * The ID of the degradation.
+     * @type string
+     */
+    degradationId: string;
+    /**
+     * The ID of the status page.
+     * @type string
+     */
+    pageId: string;
+    /**
+     * The ID of the degradation update.
+     * @type string
+     */
+    updateId: string;
+}
 export interface StatusPagesApiUnpublishStatusPageRequest {
     /**
      * The ID of the status page.
@@ -681,6 +744,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     deleteStatusPage(param: StatusPagesApiDeleteStatusPageRequest, options?: Configuration): Promise<void>;
+    /**
+     * Edits a specific degradation update.
+     * @param param The request object
+     */
+    editDegradationUpdate(param: StatusPagesApiEditDegradationUpdateRequest, options?: Configuration): Promise<DegradationUpdate>;
     /**
      * Retrieves a specific component by its ID.
      * @param param The request object
@@ -726,6 +794,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     publishStatusPage(param: StatusPagesApiPublishStatusPageRequest, options?: Configuration): Promise<void>;
+    /**
+     * Soft-deletes a degradation update.
+     * @param param The request object
+     */
+    softDeleteDegradationUpdate(param: StatusPagesApiSoftDeleteDegradationUpdateRequest, options?: Configuration): Promise<void>;
     /**
      * Unpublishes a status page. For pages of type `public`, removes the status page from the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, removes the `status-pages/$domain_prefix/view` route from the Datadog organization and requires the `status_pages_internal_page_publish` permission. The `status_pages_settings_write` permission is temporarily honored as we migrate unpublishing functionality from the update status page endpoint to the unpublish status page endpoint.
      * @param param The request object

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

@@ -337,6 +337,56 @@ class StatusPagesApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
+    editDegradationUpdate(degradationId, pageId, updateId, body, include, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            // verify required parameter 'degradationId' is not null or undefined
+            if (degradationId === null || degradationId === undefined) {
+                throw new baseapi_1.RequiredError("degradationId", "editDegradationUpdate");
+            }
+            // verify required parameter 'pageId' is not null or undefined
+            if (pageId === null || pageId === undefined) {
+                throw new baseapi_1.RequiredError("pageId", "editDegradationUpdate");
+            }
+            // verify required parameter 'updateId' is not null or undefined
+            if (updateId === null || updateId === undefined) {
+                throw new baseapi_1.RequiredError("updateId", "editDegradationUpdate");
+            }
+            // verify required parameter 'body' is not null or undefined
+            if (body === null || body === undefined) {
+                throw new baseapi_1.RequiredError("body", "editDegradationUpdate");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/statuspages/{page_id}/degradations/{degradation_id}/updates/{update_id}"
+                .replace("{degradation_id}", encodeURIComponent(String(degradationId)))
+                .replace("{page_id}", encodeURIComponent(String(pageId)))
+                .replace("{update_id}", encodeURIComponent(String(updateId)));
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.StatusPagesApi.editDegradationUpdate")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.PATCH);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Query Params
+            if (include !== undefined) {
+                requestContext.setQueryParam("include", ObjectSerializer_1.ObjectSerializer.serialize(include, "string", ""), "");
+            }
+            // 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, "PatchDegradationUpdateRequest", ""), contentType);
+            requestContext.setBody(serializedBody);
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+                "AuthZ",
+            ]);
+            return requestContext;
+        });
+    }
     getComponent(pageId, componentId, include, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -630,6 +680,41 @@ class StatusPagesApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
+    softDeleteDegradationUpdate(degradationId, pageId, updateId, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            // verify required parameter 'degradationId' is not null or undefined
+            if (degradationId === null || degradationId === undefined) {
+                throw new baseapi_1.RequiredError("degradationId", "softDeleteDegradationUpdate");
+            }
+            // verify required parameter 'pageId' is not null or undefined
+            if (pageId === null || pageId === undefined) {
+                throw new baseapi_1.RequiredError("pageId", "softDeleteDegradationUpdate");
+            }
+            // verify required parameter 'updateId' is not null or undefined
+            if (updateId === null || updateId === undefined) {
+                throw new baseapi_1.RequiredError("updateId", "softDeleteDegradationUpdate");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/statuspages/{page_id}/degradations/{degradation_id}/updates/{update_id}"
+                .replace("{degradation_id}", encodeURIComponent(String(degradationId)))
+                .replace("{page_id}", encodeURIComponent(String(pageId)))
+                .replace("{update_id}", encodeURIComponent(String(updateId)));
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.StatusPagesApi.softDeleteDegradationUpdate")
+                .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;
+        });
+    }
     unpublishStatusPage(pageId, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
@@ -1149,6 +1234,41 @@ class StatusPagesApiResponseProcessor {
             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 editDegradationUpdate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    editDegradationUpdate(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), "DegradationUpdate");
+                return 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), "DegradationUpdate", "");
+                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
@@ -1462,6 +1582,39 @@ class StatusPagesApiResponseProcessor {
             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 softDeleteDegradationUpdate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    softDeleteDegradationUpdate(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 === 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
@@ -1771,6 +1924,20 @@ class StatusPagesApi {
             });
         });
     }
+    /**
+     * Edits a specific degradation update.
+     * @param param The request object
+     */
+    editDegradationUpdate(param, options) {
+        const requestContextPromise = this.requestFactory.editDegradationUpdate(param.degradationId, param.pageId, param.updateId, param.body, param.include, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.editDegradationUpdate(responseContext);
+            });
+        });
+    }
     /**
      * Retrieves a specific component by its ID.
      * @param param The request object
@@ -1897,6 +2064,20 @@ class StatusPagesApi {
             });
         });
     }
+    /**
+     * Soft-deletes a degradation update.
+     * @param param The request object
+     */
+    softDeleteDegradationUpdate(param, options) {
+        const requestContextPromise = this.requestFactory.softDeleteDegradationUpdate(param.degradationId, param.pageId, param.updateId, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.softDeleteDegradationUpdate(responseContext);
+            });
+        });
+    }
     /**
      * Unpublishes a status page. For pages of type `public`, removes the status page from the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, removes the `status-pages/$domain_prefix/view` route from the Datadog organization and requires the `status_pages_internal_page_publish` permission. The `status_pages_settings_write` permission is temporarily honored as we migrate unpublishing functionality from the update status page endpoint to the unpublish status page endpoint.
      * @param param The request object