@datadog/datadog-api-client 1.52.0 → 1.53.0

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

@@ -3,11 +3,15 @@ import { Configuration } from "../../datadog-api-client-common/configuration";
 import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
 import { CreateComponentRequest } from "../models/CreateComponentRequest";
 import { CreateDegradationRequest } from "../models/CreateDegradationRequest";
+import { CreateMaintenanceRequest } from "../models/CreateMaintenanceRequest";
 import { CreateStatusPageRequest } from "../models/CreateStatusPageRequest";
 import { Degradation } from "../models/Degradation";
 import { DegradationArray } from "../models/DegradationArray";
+import { Maintenance } from "../models/Maintenance";
+import { MaintenanceArray } from "../models/MaintenanceArray";
 import { PatchComponentRequest } from "../models/PatchComponentRequest";
 import { PatchDegradationRequest } from "../models/PatchDegradationRequest";
+import { PatchMaintenanceRequest } from "../models/PatchMaintenanceRequest";
 import { PatchStatusPageRequest } from "../models/PatchStatusPageRequest";
 import { StatusPage } from "../models/StatusPage";
 import { StatusPageArray } from "../models/StatusPageArray";
@@ -16,18 +20,22 @@ import { StatusPagesComponentArray } from "../models/StatusPagesComponentArray";
 export declare class StatusPagesApiRequestFactory extends BaseAPIRequestFactory {
     createComponent(pageId: string, body: CreateComponentRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     createDegradation(pageId: string, body: CreateDegradationRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise<RequestContext>;
+    createMaintenance(pageId: string, body: CreateMaintenanceRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise<RequestContext>;
     createStatusPage(body: CreateStatusPageRequest, include?: string, _options?: Configuration): Promise<RequestContext>;
     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>;
     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>;
     getStatusPage(pageId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     listComponents(pageId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
-    listDegradations(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, _options?: Configuration): Promise<RequestContext>;
+    listDegradations(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, sort?: string, _options?: Configuration): Promise<RequestContext>;
+    listMaintenances(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, sort?: string, _options?: Configuration): Promise<RequestContext>;
     listStatusPages(pageOffset?: number, pageLimit?: number, include?: 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>;
+    updateMaintenance(pageId: string, maintenanceId: string, body: PatchMaintenanceRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise<RequestContext>;
     updateStatusPage(pageId: string, body: PatchStatusPageRequest, deleteSubscribers?: boolean, include?: string, _options?: Configuration): Promise<RequestContext>;
 }
 export declare class StatusPagesApiResponseProcessor {
@@ -47,6 +55,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     createDegradation(response: ResponseContext): Promise<Degradation>;
+    /**
+     * 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 createMaintenance
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    createMaintenance(response: ResponseContext): Promise<Maintenance>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -95,6 +111,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     getDegradation(response: ResponseContext): Promise<Degradation>;
+    /**
+     * 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 getMaintenance
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getMaintenance(response: ResponseContext): Promise<Maintenance>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -119,6 +143,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     listDegradations(response: ResponseContext): Promise<DegradationArray>;
+    /**
+     * 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 listMaintenances
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    listMaintenances(response: ResponseContext): Promise<MaintenanceArray>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -143,6 +175,14 @@ export declare class StatusPagesApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     updateDegradation(response: ResponseContext): Promise<Degradation>;
+    /**
+     * 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 updateMaintenance
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    updateMaintenance(response: ResponseContext): Promise<Maintenance>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
@@ -189,6 +229,27 @@ export interface StatusPagesApiCreateDegradationRequest {
      */
     include?: string;
 }
+export interface StatusPagesApiCreateMaintenanceRequest {
+    /**
+     * The ID of the status page.
+     * @type string
+     */
+    pageId: string;
+    /**
+     * @type CreateMaintenanceRequest
+     */
+    body: CreateMaintenanceRequest;
+    /**
+     * Whether to notify page subscribers of the maintenance.
+     * @type boolean
+     */
+    notifySubscribers?: boolean;
+    /**
+     * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
+     * @type string
+     */
+    include?: string;
+}
 export interface StatusPagesApiCreateStatusPageRequest {
     /**
      * @type CreateStatusPageRequest
@@ -265,6 +326,23 @@ export interface StatusPagesApiGetDegradationRequest {
      */
     include?: string;
 }
+export interface StatusPagesApiGetMaintenanceRequest {
+    /**
+     * The ID of the status page.
+     * @type string
+     */
+    pageId: string;
+    /**
+     * The ID of the maintenance.
+     * @type string
+     */
+    maintenanceId: string;
+    /**
+     * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
+     * @type string
+     */
+    include?: string;
+}
 export interface StatusPagesApiGetStatusPageRequest {
     /**
      * The ID of the status page.
@@ -315,6 +393,43 @@ export interface StatusPagesApiListDegradationsRequest {
      * @type string
      */
     filterStatus?: string;
+    /**
+     * Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, modified_at, -modified_at.
+     * @type string
+     */
+    sort?: string;
+}
+export interface StatusPagesApiListMaintenancesRequest {
+    /**
+     * Optional page id filter.
+     * @type string
+     */
+    filterPageId?: string;
+    /**
+     * Offset to use as the start of the page.
+     * @type number
+     */
+    pageOffset?: number;
+    /**
+     * The number of maintenances to return per page.
+     * @type number
+     */
+    pageLimit?: number;
+    /**
+     * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
+     * @type string
+     */
+    include?: string;
+    /**
+     * Optional maintenance status filter. Supported values: scheduled, in_progress, completed.
+     * @type string
+     */
+    filterStatus?: string;
+    /**
+     * Sort order. Prefix with '-' for descending. Supported values: created_at, -created_at, start_date, -start_date.
+     * @type string
+     */
+    sort?: string;
 }
 export interface StatusPagesApiListStatusPagesRequest {
     /**
@@ -380,6 +495,32 @@ export interface StatusPagesApiUpdateDegradationRequest {
      */
     include?: string;
 }
+export interface StatusPagesApiUpdateMaintenanceRequest {
+    /**
+     * The ID of the status page.
+     * @type string
+     */
+    pageId: string;
+    /**
+     * The ID of the maintenance.
+     * @type string
+     */
+    maintenanceId: string;
+    /**
+     * @type PatchMaintenanceRequest
+     */
+    body: PatchMaintenanceRequest;
+    /**
+     * Whether to notify page subscribers of the maintenance.
+     * @type boolean
+     */
+    notifySubscribers?: boolean;
+    /**
+     * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page.
+     * @type string
+     */
+    include?: string;
+}
 export interface StatusPagesApiUpdateStatusPageRequest {
     /**
      * The ID of the status page.
@@ -416,6 +557,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     createDegradation(param: StatusPagesApiCreateDegradationRequest, options?: Configuration): Promise<Degradation>;
+    /**
+     * Schedules a new maintenance.
+     * @param param The request object
+     */
+    createMaintenance(param: StatusPagesApiCreateMaintenanceRequest, options?: Configuration): Promise<Maintenance>;
     /**
      * Creates a new status page.
      * @param param The request object
@@ -446,6 +592,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     getDegradation(param: StatusPagesApiGetDegradationRequest, options?: Configuration): Promise<Degradation>;
+    /**
+     * Retrieves a specific maintenance by its ID.
+     * @param param The request object
+     */
+    getMaintenance(param: StatusPagesApiGetMaintenanceRequest, options?: Configuration): Promise<Maintenance>;
     /**
      * Retrieves a specific status page by its ID.
      * @param param The request object
@@ -461,6 +612,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     listDegradations(param?: StatusPagesApiListDegradationsRequest, options?: Configuration): Promise<DegradationArray>;
+    /**
+     * Lists all maintenances for the organization. Optionally filter by status and page.
+     * @param param The request object
+     */
+    listMaintenances(param?: StatusPagesApiListMaintenancesRequest, options?: Configuration): Promise<MaintenanceArray>;
     /**
      * Lists all status pages for the organization.
      * @param param The request object
@@ -476,6 +632,11 @@ export declare class StatusPagesApi {
      * @param param The request object
      */
     updateDegradation(param: StatusPagesApiUpdateDegradationRequest, options?: Configuration): Promise<Degradation>;
+    /**
+     * Updates an existing maintenance's attributes.
+     * @param param The request object
+     */
+    updateMaintenance(param: StatusPagesApiUpdateMaintenanceRequest, options?: Configuration): Promise<Maintenance>;
     /**
      * Updates an existing status page's attributes.
      * @param param The request object