import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi"; import { Configuration } from "../../datadog-api-client-common/configuration"; import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http"; import { CreateBackfilledDegradationRequest } from "../models/CreateBackfilledDegradationRequest"; import { CreateBackfilledMaintenanceRequest } from "../models/CreateBackfilledMaintenanceRequest"; 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"; import { StatusPagesComponent } from "../models/StatusPagesComponent"; import { StatusPagesComponentArray } from "../models/StatusPagesComponentArray"; export declare class StatusPagesApiRequestFactory extends BaseAPIRequestFactory { createBackfilledDegradation(pageId: string, body: CreateBackfilledDegradationRequest, include?: string, _options?: Configuration): Promise; createBackfilledMaintenance(pageId: string, body: CreateBackfilledMaintenanceRequest, include?: string, _options?: Configuration): Promise; createComponent(pageId: string, body: CreateComponentRequest, include?: string, _options?: Configuration): Promise; createDegradation(pageId: string, body: CreateDegradationRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise; createMaintenance(pageId: string, body: CreateMaintenanceRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise; createStatusPage(body: CreateStatusPageRequest, include?: string, _options?: Configuration): Promise; deleteComponent(pageId: string, componentId: string, _options?: Configuration): Promise; deleteDegradation(pageId: string, degradationId: string, _options?: Configuration): Promise; deleteStatusPage(pageId: string, _options?: Configuration): Promise; getComponent(pageId: string, componentId: string, include?: string, _options?: Configuration): Promise; getDegradation(pageId: string, degradationId: string, include?: string, _options?: Configuration): Promise; getMaintenance(pageId: string, maintenanceId: string, include?: string, _options?: Configuration): Promise; getStatusPage(pageId: string, include?: string, _options?: Configuration): Promise; listComponents(pageId: string, include?: string, _options?: Configuration): Promise; listDegradations(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, sort?: string, _options?: Configuration): Promise; listMaintenances(filterPageId?: string, pageOffset?: number, pageLimit?: number, include?: string, filterStatus?: string, sort?: string, _options?: Configuration): Promise; listStatusPages(pageOffset?: number, pageLimit?: number, filterDomainPrefix?: string, include?: string, _options?: Configuration): Promise; publishStatusPage(pageId: string, _options?: Configuration): Promise; unpublishStatusPage(pageId: string, _options?: Configuration): Promise; updateComponent(pageId: string, componentId: string, body: PatchComponentRequest, include?: string, _options?: Configuration): Promise; updateDegradation(pageId: string, degradationId: string, body: PatchDegradationRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise; updateMaintenance(pageId: string, maintenanceId: string, body: PatchMaintenanceRequest, notifySubscribers?: boolean, include?: string, _options?: Configuration): Promise; updateStatusPage(pageId: string, body: PatchStatusPageRequest, deleteSubscribers?: boolean, include?: string, _options?: Configuration): Promise; } export declare class StatusPagesApiResponseProcessor { /** * 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 createBackfilledDegradation * @throws ApiException if the response code was not in [200, 299] */ createBackfilledDegradation(response: ResponseContext): Promise; /** * 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 createBackfilledMaintenance * @throws ApiException if the response code was not in [200, 299] */ createBackfilledMaintenance(response: ResponseContext): Promise; /** * 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 createComponent * @throws ApiException if the response code was not in [200, 299] */ createComponent(response: ResponseContext): Promise; /** * 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 createDegradation * @throws ApiException if the response code was not in [200, 299] */ createDegradation(response: ResponseContext): Promise; /** * 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; /** * 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 createStatusPage * @throws ApiException if the response code was not in [200, 299] */ createStatusPage(response: ResponseContext): Promise; /** * 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 deleteComponent * @throws ApiException if the response code was not in [200, 299] */ deleteComponent(response: ResponseContext): Promise; /** * 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 deleteDegradation * @throws ApiException if the response code was not in [200, 299] */ deleteDegradation(response: ResponseContext): Promise; /** * 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 deleteStatusPage * @throws ApiException if the response code was not in [200, 299] */ deleteStatusPage(response: ResponseContext): Promise; /** * 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 getComponent * @throws ApiException if the response code was not in [200, 299] */ getComponent(response: ResponseContext): Promise; /** * 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 getDegradation * @throws ApiException if the response code was not in [200, 299] */ getDegradation(response: ResponseContext): Promise; /** * 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; /** * 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 getStatusPage * @throws ApiException if the response code was not in [200, 299] */ getStatusPage(response: ResponseContext): Promise; /** * 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 listComponents * @throws ApiException if the response code was not in [200, 299] */ listComponents(response: ResponseContext): Promise; /** * 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 listDegradations * @throws ApiException if the response code was not in [200, 299] */ listDegradations(response: ResponseContext): Promise; /** * 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; /** * 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 listStatusPages * @throws ApiException if the response code was not in [200, 299] */ listStatusPages(response: ResponseContext): Promise; /** * 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 publishStatusPage * @throws ApiException if the response code was not in [200, 299] */ publishStatusPage(response: ResponseContext): Promise; /** * 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 unpublishStatusPage * @throws ApiException if the response code was not in [200, 299] */ unpublishStatusPage(response: ResponseContext): Promise; /** * 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 updateComponent * @throws ApiException if the response code was not in [200, 299] */ updateComponent(response: ResponseContext): Promise; /** * 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 updateDegradation * @throws ApiException if the response code was not in [200, 299] */ updateDegradation(response: ResponseContext): Promise; /** * 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; /** * 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 updateStatusPage * @throws ApiException if the response code was not in [200, 299] */ updateStatusPage(response: ResponseContext): Promise; } export interface StatusPagesApiCreateBackfilledDegradationRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * @type CreateBackfilledDegradationRequest */ body: CreateBackfilledDegradationRequest; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page. * @type string */ include?: string; } export interface StatusPagesApiCreateBackfilledMaintenanceRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * @type CreateBackfilledMaintenanceRequest */ body: CreateBackfilledMaintenanceRequest; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page. * @type string */ include?: string; } export interface StatusPagesApiCreateComponentRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * @type CreateComponentRequest */ body: CreateComponentRequest; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group. * @type string */ include?: string; } export interface StatusPagesApiCreateDegradationRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * @type CreateDegradationRequest */ body: CreateDegradationRequest; /** * Whether to notify page subscribers of the degradation. * @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 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 */ body: CreateStatusPageRequest; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. * @type string */ include?: string; } export interface StatusPagesApiDeleteComponentRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the component. * @type string */ componentId: string; } export interface StatusPagesApiDeleteDegradationRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the degradation. * @type string */ degradationId: string; } export interface StatusPagesApiDeleteStatusPageRequest { /** * The ID of the status page. * @type string */ pageId: string; } export interface StatusPagesApiGetComponentRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the component. * @type string */ componentId: string; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group. * @type string */ include?: string; } export interface StatusPagesApiGetDegradationRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the degradation. * @type string */ degradationId: 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 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. * @type string */ pageId: string; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. * @type string */ include?: string; } export interface StatusPagesApiListComponentsRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group. * @type string */ include?: string; } export interface StatusPagesApiListDegradationsRequest { /** * Optional page id filter. * @type string */ filterPageId?: string; /** * Offset to use as the start of the page. * @type number */ pageOffset?: number; /** * The number of degradations 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 degradation status filter. Supported values: investigating, identified, monitoring, resolved. * @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 { /** * Offset to use as the start of the page. * @type number */ pageOffset?: number; /** * The number of status pages to return per page. * @type number */ pageLimit?: number; /** * Filter status pages by exact domain prefix match. Returns at most one result. * @type string */ filterDomainPrefix?: string; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. * @type string */ include?: string; } export interface StatusPagesApiPublishStatusPageRequest { /** * The ID of the status page. * @type string */ pageId: string; } export interface StatusPagesApiUnpublishStatusPageRequest { /** * The ID of the status page. * @type string */ pageId: string; } export interface StatusPagesApiUpdateComponentRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the component. * @type string */ componentId: string; /** * @type PatchComponentRequest */ body: PatchComponentRequest; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, status_page, group. * @type string */ include?: string; } export interface StatusPagesApiUpdateDegradationRequest { /** * The ID of the status page. * @type string */ pageId: string; /** * The ID of the degradation. * @type string */ degradationId: string; /** * @type PatchDegradationRequest */ body: PatchDegradationRequest; /** * Whether to notify page subscribers of the degradation. * @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 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. * @type string */ pageId: string; /** * @type PatchStatusPageRequest */ body: PatchStatusPageRequest; /** * Whether to delete existing subscribers when updating a status page's type. * @type boolean */ deleteSubscribers?: boolean; /** * Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user. * @type string */ include?: string; } export declare class StatusPagesApi { private requestFactory; private responseProcessor; private configuration; constructor(configuration: Configuration, requestFactory?: StatusPagesApiRequestFactory, responseProcessor?: StatusPagesApiResponseProcessor); /** * Creates a backfilled degradation with predefined updates. * @param param The request object */ createBackfilledDegradation(param: StatusPagesApiCreateBackfilledDegradationRequest, options?: Configuration): Promise; /** * Creates a backfilled maintenance with predefined updates. * @param param The request object */ createBackfilledMaintenance(param: StatusPagesApiCreateBackfilledMaintenanceRequest, options?: Configuration): Promise; /** * Creates a new component. * @param param The request object */ createComponent(param: StatusPagesApiCreateComponentRequest, options?: Configuration): Promise; /** * Creates a new degradation. * @param param The request object */ createDegradation(param: StatusPagesApiCreateDegradationRequest, options?: Configuration): Promise; /** * Schedules a new maintenance. * @param param The request object */ createMaintenance(param: StatusPagesApiCreateMaintenanceRequest, options?: Configuration): Promise; /** * Creates a new status page in an unpublished state. Use the dedicated [publish](#publish-status-page) status page endpoint to publish the page after creation. * @param param The request object */ createStatusPage(param: StatusPagesApiCreateStatusPageRequest, options?: Configuration): Promise; /** * Deletes a component by its ID. * @param param The request object */ deleteComponent(param: StatusPagesApiDeleteComponentRequest, options?: Configuration): Promise; /** * Deletes a degradation by its ID. * @param param The request object */ deleteDegradation(param: StatusPagesApiDeleteDegradationRequest, options?: Configuration): Promise; /** * Deletes a status page by its ID. * @param param The request object */ deleteStatusPage(param: StatusPagesApiDeleteStatusPageRequest, options?: Configuration): Promise; /** * Retrieves a specific component by its ID. * @param param The request object */ getComponent(param: StatusPagesApiGetComponentRequest, options?: Configuration): Promise; /** * Retrieves a specific degradation by its ID. * @param param The request object */ getDegradation(param: StatusPagesApiGetDegradationRequest, options?: Configuration): Promise; /** * Retrieves a specific maintenance by its ID. * @param param The request object */ getMaintenance(param: StatusPagesApiGetMaintenanceRequest, options?: Configuration): Promise; /** * Retrieves a specific status page by its ID. * @param param The request object */ getStatusPage(param: StatusPagesApiGetStatusPageRequest, options?: Configuration): Promise; /** * Lists all components for a status page. * @param param The request object */ listComponents(param: StatusPagesApiListComponentsRequest, options?: Configuration): Promise; /** * Lists all degradations for the organization. Optionally filter by status and page. * @param param The request object */ listDegradations(param?: StatusPagesApiListDegradationsRequest, options?: Configuration): Promise; /** * Lists all maintenances for the organization. Optionally filter by status and page. * @param param The request object */ listMaintenances(param?: StatusPagesApiListMaintenancesRequest, options?: Configuration): Promise; /** * Lists all status pages for the organization. * @param param The request object */ listStatusPages(param?: StatusPagesApiListStatusPagesRequest, options?: Configuration): Promise; /** * Publishes a status page. For pages of type `public`, makes the status page available on the public internet and requires the `status_pages_public_page_publish` permission. For pages of type `internal`, makes the status page available under the `status-pages/$domain_prefix/view` route within the Datadog organization and requires the `status_pages_internal_page_publish` permission. The `status_pages_settings_write` permission is temporarily honored as we migrate publishing functionality from the update status page endpoint to the publish status page endpoint. * @param param The request object */ publishStatusPage(param: StatusPagesApiPublishStatusPageRequest, options?: Configuration): Promise; /** * 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 */ unpublishStatusPage(param: StatusPagesApiUnpublishStatusPageRequest, options?: Configuration): Promise; /** * Updates an existing component's attributes. * @param param The request object */ updateComponent(param: StatusPagesApiUpdateComponentRequest, options?: Configuration): Promise; /** * Updates an existing degradation's attributes. * @param param The request object */ updateDegradation(param: StatusPagesApiUpdateDegradationRequest, options?: Configuration): Promise; /** * Updates an existing maintenance's attributes. * @param param The request object */ updateMaintenance(param: StatusPagesApiUpdateMaintenanceRequest, options?: Configuration): Promise; /** * Updates an existing status page's attributes. **Note**: Publishing and unpublishing via the `enabled` property will be deprecated on this endpoint. Use the dedicated [publish](#publish-status-page) and [unpublish](#unpublish-status-page) status page endpoints instead. * @param param The request object */ updateStatusPage(param: StatusPagesApiUpdateStatusPageRequest, options?: Configuration): Promise; }