@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.3.2

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

@@ -25,7 +25,7 @@ export declare class MetricsClient {
      *
      * 2. Then use the cursor from the **nextPageKey** field of the response in the **nextPageKey** query parameter to obtain subsequent pages. All other query parameters must be omitted.
      *
-     * @returns Success
+     * @returns {Promise<MetricDescriptorCollection>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -33,6 +33,11 @@ export declare class MetricsClient {
      * const data = await metricsClient.allMetrics({
      *   acceptType: "application/json; charset=utf-8",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     allMetrics(config: {
         /**
@@ -153,7 +158,7 @@ export declare class MetricsClient {
      *
      * **Required scope:** storage:metrics:write<br/>**Required permission:** storage:metrics:write
      *
-     * @returns The provided metric data points are accepted and will be processed in the background.
+     * @returns {Promise<ValidationResponse>} The provided metric data points are accepted and will be processed in the background.
      *
      * @example <caption>Code example</caption>
      * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -161,6 +166,12 @@ export declare class MetricsClient {
      * const data = await metricsClient.ingest({
      *   body: "server.cpu.temperature,cpu.id=0 42",
      * });
+     *
+     * @throws {ValidationResponseError} Some data points are invalid. Valid data points are accepted and will be processed in the background.
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     ingest(config: {
         body: string;
@@ -178,7 +189,7 @@ export declare class MetricsClient {
      * The **dataPointCountRatio** specifies the ratio of queried data points divided by the maximum number of data points per metric that are allowed in a single query.
      * The **dimensionCountRatio** specifies the ratio of queried dimension tuples divided by the maximum number of dimension tuples allowed in a single query.
      *
-     * @returns Success
+     * @returns {Promise<MetricData>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -186,6 +197,11 @@ export declare class MetricsClient {
      * const data = await metricsClient.query({
      *   acceptType: "application/json; charset=utf-8",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     query(config: {
         /**
@@ -321,7 +337,7 @@ export declare class MetricsClient {
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<MetricDescriptor>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -330,6 +346,11 @@ export declare class MetricsClient {
      *   acceptType: "application/json; charset=utf-8",
      *   metricKey: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     metric(config: {
         /**
@@ -351,6 +372,11 @@ export declare class MetricsClient {
      * const data = await metricsClient.delete({
      *   metricKey: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     delete(config: {
         /** The key of the required metric. */ metricKey: string;

package/types/packages/client/classic-environment-v2/src/lib/apis/metrics-units-api.d.ts

@@ -18,12 +18,17 @@ export declare class MetricsUnitsClient {
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can narrow down the output by providing filter criteria in the **unitSelector** field.
      *
-     * @returns Success
+     * @returns {Promise<UnitList>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await metricsUnitsClient.allUnits();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     allUnits(config?: {
         /**
@@ -52,7 +57,7 @@ export declare class MetricsUnitsClient {
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<Unit>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -60,6 +65,11 @@ export declare class MetricsUnitsClient {
      * const data = await metricsUnitsClient.unit({
      *   unitId: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     unit(config: {
         unitId: string;
@@ -70,7 +80,7 @@ export declare class MetricsUnitsClient {
      *
      * **Required scope:** environment-api:metrics:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If no target unit is set, the request finds an appropriate target unit automatically, taking into account the preferred number format (if specified).
      *
-     * @returns Success
+     * @returns {Promise<UnitConversionResult>} Success
      *
      * @example <caption>Code example</caption>
      * import { metricsUnitsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -79,6 +89,11 @@ export declare class MetricsUnitsClient {
      *   unitId: "...",
      *   value: 10,
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     convert(config: {
         /** The ID of the source unit. */ unitId: string;

package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-api.d.ts

@@ -33,12 +33,17 @@ export declare class MonitoredEntitiesClient {
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
      *
-     * @returns Success
+     * @returns {Promise<EntitiesList>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await monitoredEntitiesClient.getEntities();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEntities(config?: {
         /**
@@ -149,7 +154,7 @@ export declare class MonitoredEntitiesClient {
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
      *
-     * @returns Success
+     * @returns {Promise<CustomDeviceCreationResult | void>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -157,6 +162,11 @@ export declare class MonitoredEntitiesClient {
      * const data = await monitoredEntitiesClient.pushCustomDevice(
      *   { body: { customDeviceId: "...", displayName: "..." } },
      * );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     pushCustomDevice(config: {
         body: CustomDeviceCreation;
@@ -174,7 +184,7 @@ export declare class MonitoredEntitiesClient {
      * This endpoint does not create a new management zone, if there is no management zone with the provided name.
      * Automatic management zone rules will not apply to entities with a set security context. It will need to be removed, to have them apply again.
      *
-     * @returns Success
+     * @returns {Promise<SecurityContextResultDto>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -184,6 +194,11 @@ export declare class MonitoredEntitiesClient {
      *     entitySelector: "...",
      *     body: {},
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     setSecurityContext(config: {
         body: SecurityContextDtoImpl;
@@ -269,7 +284,7 @@ export declare class MonitoredEntitiesClient {
      *
      * <br/><br/>Automatic management zone rules will apply again to entities without a security context.
      *
-     * @returns Success
+     * @returns {Promise<SecurityContextResultDto>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -278,6 +293,11 @@ export declare class MonitoredEntitiesClient {
      *   await monitoredEntitiesClient.deleteSecurityContext({
      *     entitySelector: "...",
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     deleteSecurityContext(config: {
         /**
@@ -358,7 +378,7 @@ export declare class MonitoredEntitiesClient {
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<Entity>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -366,6 +386,11 @@ export declare class MonitoredEntitiesClient {
      * const data = await monitoredEntitiesClient.getEntity({
      *   entityId: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEntity(config: {
         /** The ID of the required entity. */ entityId: string;
@@ -423,12 +448,17 @@ export declare class MonitoredEntitiesClient {
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
      *
-     * @returns Success
+     * @returns {Promise<EntityTypeList>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await monitoredEntitiesClient.getEntityTypes();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEntityTypes(config?: {
         /**
@@ -452,7 +482,7 @@ export declare class MonitoredEntitiesClient {
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<EntityType>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -460,6 +490,11 @@ export declare class MonitoredEntitiesClient {
      * const data = await monitoredEntitiesClient.getEntityType({
      *   type: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getEntityType(config: {
         /** The required entity type. */ type: string;

package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-custom-tags-api.d.ts

@@ -19,7 +19,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Automatically applied tags and imported tags are not included.
      *
-     * @returns Success
+     * @returns {Promise<CustomEntityTags>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -28,6 +28,11 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *   await monitoredEntitiesCustomTagsClient.getTags({
      *     entitySelector: "...",
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getTags(config: {
         /**
@@ -108,7 +113,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>All existing tags remain unaffected.
      *
-     * @returns Success
+     * @returns {Promise<AddedEntityTags>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -118,6 +123,11 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *     entitySelector: "...",
      *     body: { tags: [{ key: "..." }] },
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     postTags(config: {
         body: AddEntityTags;
@@ -199,7 +209,7 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *
      * **Required scope:** environment-api:entities:write<br/>**Required permission:** environment:roles:manage-settings
      *
-     * @returns Success
+     * @returns {Promise<DeletedEntityTags>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesCustomTagsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -209,6 +219,11 @@ export declare class MonitoredEntitiesCustomTagsClient {
      *     key: "...",
      *     entitySelector: "...",
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     deleteTags(config: {
         /**

package/types/packages/client/classic-environment-v2/src/lib/apis/monitored-entities-monitoring-state-api.d.ts

@@ -16,13 +16,18 @@ export declare class MonitoredEntitiesMonitoringStateClient {
      *
      * **Required scope:** environment-api:entities:read<br/>**Required permission:** environment:roles:viewer<br/><br/>Only process group instances are supported.
      *
-     * @returns Success
+     * @returns {Promise<MonitoredStates>} Success
      *
      * @example <caption>Code example</caption>
      * import { monitoredEntitiesMonitoringStateClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data =
      *   await monitoredEntitiesMonitoringStateClient.getStates();
+     *
+     * @throws {ErrorEnvelopeError} Unavailable | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getStates(config?: {
         /**
@@ -74,6 +79,42 @@ export declare class MonitoredEntitiesMonitoringStateClient {
          *
          * The maximum string length is 2,000 characters.
          */ entitySelector?: 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 24 hours is used (`now-24h`).
+         */ 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;
         abortSignal?: AbortSignal;
     }): Promise<MonitoredStates>;
 }

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

@@ -21,15 +21,22 @@ export declare class NetworkZonesClient {
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<NetworkZoneSettings>} Success
      *
      * @example <caption>Code example</caption>
      * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data =
      *   await networkZonesClient.getNetworkZoneSettings();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
-    getNetworkZoneSettings(abortSignal?: AbortSignal): Promise<NetworkZoneSettings>;
+    getNetworkZoneSettings(config?: {
+        abortSignal?: AbortSignal;
+    } | AbortSignal): Promise<NetworkZoneSettings>;
     /**
      * Updates the global configuration of network zones
      *
@@ -42,6 +49,11 @@ export declare class NetworkZonesClient {
      *   await networkZonesClient.updateNetworkZoneSettings({
      *     body: {},
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateNetworkZoneSettings(config: {
         body: NetworkZoneSettings;
@@ -52,20 +64,27 @@ export declare class NetworkZonesClient {
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<NetworkZoneList>} Success
      *
      * @example <caption>Code example</caption>
      * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await networkZonesClient.getAllNetworkZones();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
-    getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
+    getAllNetworkZones(config?: {
+        abortSignal?: AbortSignal;
+    } | AbortSignal): Promise<NetworkZoneList>;
     /**
      * Gets parameters of the specified network zone
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:viewer
      *
-     * @returns Success
+     * @returns {Promise<NetworkZone>} Success
      *
      * @example <caption>Code example</caption>
      * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -73,6 +92,11 @@ export declare class NetworkZonesClient {
      * const data = await networkZonesClient.getSingleNetworkZone({
      *   id: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getSingleNetworkZone(config: {
         /** The ID of the required network zone. */ id: string;
@@ -85,7 +109,7 @@ export declare class NetworkZonesClient {
      *
      *  The ID is not case sensitive. Dynatrace stores the ID in lowercase.
      *
-     * @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
+     * @returns {Promise<EntityShortRepresentation | void>} Success. The new network zone has been created. The response body contains the ID of the new network zone.
      *
      * @example <caption>Code example</caption>
      * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -95,6 +119,11 @@ export declare class NetworkZonesClient {
      *     id: "...",
      *     body: {},
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     createOrUpdateNetworkZone(config: {
         body: NetworkZone;
@@ -120,6 +149,11 @@ export declare class NetworkZonesClient {
      * const data = await networkZonesClient.deleteNetworkZone({
      *   id: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Failed. See error message in the response body for details. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     deleteNetworkZone(config: {
         /** The ID of the network zone to be deleted. */ id: string;
@@ -130,7 +164,7 @@ export declare class NetworkZonesClient {
      *
      * **Required scope:** environment-api:network-zones:read<br/>**Required permission:** environment:roles:manage-settings
      *
-     * @returns Success
+     * @returns {Promise<NetworkZoneConnectionStatistics>} Success
      *
      * @example <caption>Code example</caption>
      * import { networkZonesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -138,6 +172,11 @@ export declare class NetworkZonesClient {
      * const data = await networkZonesClient.getHostStats({
      *   id: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getHostStats(config: {
         /** The ID of the required network zone. */ id: string;