@dynatrace-sdk/client-classic-environment-v2 5.2.3 → 7.0.0

package/types/packages/client/classic-environment-v2/src/lib/apis/service-level-objectives-api.d.ts

@@ -1,369 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { AbstractSloAlertDto } from '../models/abstract-slo-alert-dto';
-import { EntityShortRepresentation } from '../models/entity-short-representation';
-import { SLOs } from '../models/sl-os';
-import { SLO } from '../models/slo';
-import { SloConfigItemDtoImpl } from '../models/slo-config-item-dto-impl';
-import { ApiClientOptions } from './api-client-options';
-/**
- * Manage SLOs
- */
-export declare class ServiceLevelObjectivesClient {
-    private httpClient;
-    private shouldTransformDates;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ServiceLevelObjectivesClient. Custom http client should implement {HttpClient} interface.
-     * @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
-     * @example
-     * const serviceLevelObjectivesClientNodeJs = new ServiceLevelObjectivesClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
-    /**
-     * Lists all available SLOs along with calculated values
-     *
-     * **Required scope:** environment-api:slo:read<br/>**One of the following permissions is required:**
-     * + environment:roles:viewer
-     * + settings:objects:read
-     *
-     * <br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
-     *
-     * 1. Set the **timeFrame** parameter to `GTF`.
-     * 2. Provide the timeframe in **from** and **to** parameters.
-     *
-     * @returns {Promise<SLOs>} Success. The response contains the parameters and calculated values of the requested SLO.
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.getSlo();
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getSlo(config?: {
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /**
-         * The amount of SLOs in a single response payload.
-         *
-         * The maximal allowed page size is 10000.
-         *
-         * If not set, 10 is used.
-         */ pageSize?: number;
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The scope of the query. Only SLOs matching the provided criteria are included in the response.
-         *
-         * You can add one or several of the criteria listed below.
-         * * SLO ID: `id("id-1","id-2")`.
-         * * Name: `name("name")`. Filters for an SLO with the given name. The filter is case-sensitive.
-         * * Health state: `healthState("HEALTHY")` or `healthState("UNHEALTHY")`. Filters for SLOs that have no related open problems (`HEALTHY`) or SLOs that have related open problems (`UNHEALTHY`). You can specify only one health state.
-         * * Text: `text("value")`. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.
-         * * Problem: `problemDisplayName("value")`. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).
-         * * Management zone name: `managementZone("MZ-A")`. Filters for all SLOs that are related to the given management zone name. Returned SLOs are evaluated against the given management zone.
-         * * Management zone ID: `managementZoneID("123")`. Filters for all SLOs that are related to the given management zone ID. Returned SLOs are evaluated against the given management zone.
-         *
-         * To set several criteria, separate them with comma (`,`). Only SLOs matching all criteria are included in the response. Examples:
-         * * .../api/v2/slo?sloSelector=name("Service Availability")
-         * * .../api/v2/slo?sloSelector=id("id")
-         * * .../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").
-         *
-         * The special characters `~` and `"` need to be escaped using a `~` (e.g. double quote search `text("~"")`).
-         */ sloSelector?: string;
-        /**
-         * The sorting of SLO entries:
-         * * `name`: Names in ascending order.
-         * * `-name`: Names in descending order.
-         *
-         * If not set, the ascending order is used.
-         */ sort?: string;
-        /**
-         * The timeframe to calculate the SLO values:
-         *
-         * * `CURRENT`: SLO's own timeframe.
-         * * `GTF`: timeframe specified by **from** and **to** parameters.
-         *
-         * If not set, the `CURRENT` value is used.
-         */ timeFrame?: 'CURRENT' | 'GTF';
-        /** Get your SLOs (`false`) or a set of demo SLOs (`true`). */ demo?: boolean;
-        /** Get your SLOs without them being evaluated (`false`) or with evaluations (`true`) with maximum `pageSize` of 25. */ evaluate?: 'true' | 'false';
-        /** Get your enabled SLOs (`true`), disabled ones (`false`) or both enabled and disabled ones (`all`). */ enabledSlos?: 'true' | 'false' | 'all';
-        /** Get your global SLOs (`true`) regardless of the selected filter or filter them out (`false`). */ showGlobalSlos?: boolean;
-        abortSignal?: AbortSignal;
-    }): Promise<SLOs>;
-    /**
-     * Creates a new SLO
-     *
-     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.createSlo({
-     *   body: {
-     *     evaluationType: "AGGREGATE",
-     *     name: "Payment service availability",
-     *     target: 95,
-     *     timeframe: "-1d",
-     *     warning: 97.5,
-     *   },
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. Conflicting resource. | Internal server error. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    createSlo(config: {
-        body: SloConfigItemDtoImpl;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Gets parameters and calculated values of a specific SLO
-     *
-     * **Required scope:** environment-api:slo:read<br/>**One of the following permissions is required:**
-     * + environment:roles:viewer
-     * + settings:objects:read
-     *
-     * <br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
-     *
-     * @returns {Promise<SLO>} Success. The response contains the parameters and calculated values of the requested SLO.
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.getSloById({
-     *   id: "...",
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getSloById(config: {
-        /** The ID of the required SLO. */ id: string;
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The timeframe to calculate the SLO values:
-         *
-         * * `CURRENT`: SLO's own timeframe.
-         * * `GTF`: timeframe specified by **from** and **to** parameters.
-         *
-         * If not set, the `CURRENT` value is used.
-         */ timeFrame?: 'CURRENT' | 'GTF';
-        abortSignal?: AbortSignal;
-    }): Promise<SLO>;
-    /**
-     * Updates an existing SLO
-     *
-     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await serviceLevelObjectivesClient.updateSloById({
-     *     id: "...",
-     *     body: {
-     *       evaluationType: "AGGREGATE",
-     *       name: "Payment service availability",
-     *       target: 95,
-     *       timeframe: "-1d",
-     *       warning: 97.5,
-     *     },
-     *   });
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Internal server error. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    updateSloById(config: {
-        body: SloConfigItemDtoImpl;
-        /** The ID of the required SLO. */ id: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Deletes an SLO
-     *
-     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.deleteSlo({
-     *   id: "...",
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Failed. The requested resource doesn't exist. | Failed. Conflicting resource. | Internal server error. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    deleteSlo(config: {
-        id: string;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Creates an alert of the provided alert type for an SLO
-     *
-     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @returns {Promise<EntityShortRepresentation>} Success. The new alert has been created. The response contains the parameters of the new alert. The **location** response header contains the ID of the new alert.
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.createAlert(
-     *   {
-     *     id: "...",
-     *     body: {
-     *       alertName: "...",
-     *       alertThreshold: 10,
-     *       alertType: "BURN_RATE",
-     *     },
-     *   },
-     * );
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The requested resource doesn't exist. | Precondition for creating an SLO alert not fulfilled. The SLO func metric cannot be created or is not created by the SLO. | Internal server error. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    createAlert(config: {
-        body: AbstractSloAlertDto;
-        /** The ID of the required SLO. */ id: string;
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The timeframe to calculate the SLO values:
-         *
-         * * `CURRENT`: SLO's own timeframe.
-         * * `GTF`: timeframe specified by **from** and **to** parameters.
-         *
-         * If not set, the `CURRENT` value is used.
-         */ timeFrame?: 'CURRENT' | 'GTF';
-        abortSignal?: AbortSignal;
-    }): Promise<EntityShortRepresentation>;
-}
-export declare const serviceLevelObjectivesClient: ServiceLevelObjectivesClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/settings-management-zones-api.d.ts

@@ -1,46 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { ManagementZoneDetails } from '../models/management-zone-details';
-import { ApiClientOptions } from './api-client-options';
-/**
- * View management zone details
- */
-export declare class SettingsManagementZonesClient {
-    private httpClient;
-    private shouldTransformDates;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a SettingsManagementZonesClient. Custom http client should implement {HttpClient} interface.
-     * @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
-     * @example
-     * const settingsManagementZonesClientNodeJs = new SettingsManagementZonesClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
-    /**
-     * Reads management zone details.
-     *
-     * **Required scope:** settings:objects:read<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:read
-     *
-     * <br/><br/>Allows to convert from an objectId to the ID of the management zone, and can serve as a replacement for [the old config endpoint](index.jsp?urls.primaryName=Configuration%20API#/Management%20zones) for that purpose.
-     *
-     * @returns {Promise<ManagementZoneDetails>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsManagementZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsManagementZonesClient.getManagementZoneDetails(
-     *     { objectId: "..." },
-     *   );
-     *
-     * @throws {ErrorEnvelopeError} Failed. Forbidden. | No object available for the given objectId | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getManagementZoneDetails(config: {
-        /** The ID of the required settings object. */ objectId: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ManagementZoneDetails>;
-}
-export declare const settingsManagementZonesClient: SettingsManagementZonesClient;