@dynatrace-sdk/client-classic-environment-v2 3.6.1 → 3.6.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-classic-environment-v2",
-  "version": "3.6.1",
+  "version": "3.6.8",
   "description": "Client for the Dynatrace Environment API v2",
   "license": "Apache-2.0",
   "dependencies": {

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

@@ -27,10 +27,19 @@ export declare class LogsClient {
      *
      * It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
      *
-     * If *Log Management and Analytics, powered by Grail* is enabled, then a bearer OAuth token (with *storage:logs:read* and *storage:buckets:read* scopes) needs to be used for authentication.
+     *
+     *
+     * If *Log Management and Analytics, powered by Grail* is enabled,
+     * then a bearer OAuth token (with `storage:logs:read` and `storage:buckets:read` scopes)
+     * needs to be used for authentication.
      *
      * Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
      *
+     * <br>
+     * **Logs on Grail:**
+     * <br>
+     * It is **not** recommended to run Grail queries using Logs v2 API, please use Grail API instead.
+     *
      * @returns {Promise<AggregatedLog>} Success
      *
      * @example <caption>Code example</caption>
@@ -125,7 +134,7 @@ export declare class LogsClient {
      *
      *  In order to fetch large amount of records (exceeding the **pageSize** value), one should repeat the **export** call with **nextPageKey** param.
      *
-     * Disabled on *Log Management and Analytics, powered by Grail*.
+     * <br>Please note that export works **only** for *Logs Classic*.
      *
      * @returns {Promise<ExportedLogRecordList>} Success
      *
@@ -235,10 +244,21 @@ export declare class LogsClient {
      *
      * 2. On the environment details page, in the **Cluster overload prevention settings** section, select the **Refresh cluster limit**.
      *
-     * **High-cardinality attributes:**
+     * <br />**High-cardinality attributes:**
      *
      * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
      *
+     * <br />**Error handling:**
+     *
+     * The following HTTP status codes are considered retryable:
+     *
+     *  * 429 Too Many Requests
+     *  * 502 Bad Gateway
+     *  * 503 Service Unavailable
+     *  * 504 Gateway Timeout
+     *
+     * It is recommended to use an exponential backoff strategy for retrying requests.
+     *
      * @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
      *
      * @example <caption>Code example</caption>
@@ -273,7 +293,7 @@ export declare class LogsClient {
      *   ],
      * });
      *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. | Client side error. | Server side error.
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.
      * @throws {InvalidResponseError}
      * @throws {ApiClientError}
      * @throws {ClientRequestError}
@@ -300,10 +320,17 @@ export declare class LogsClient {
      *
      * Results can be distributed unevenly between slices and some slices might be empty.
      *
-     * If *Log Management and Analytics, powered by Grail* is enabled, then a bearer OAuth token (with *storage:logs:read* and *storage:buckets:read* scopes) needs to be used for authentication.
+     * If *Log Management and Analytics, powered by Grail* is enabled,
+     * then a bearer OAuth token (with `storage:logs:read` and `storage:buckets:read` scopes)
+     * needs to be used for authentication.
      *
      * Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
      *
+     * <br>
+     * **Logs on Grail:**
+     * <br>
+     * It is **not** recommended to run Grail queries using Logs v2 API, please use Grail API instead.
+     *
      * @returns {Promise<LogRecordsList>} Success
      *
      * @example <caption>Code example</caption>

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

@@ -161,13 +161,13 @@ export declare class SettingsObjectsClient {
          * * `objectId`
          * * `modificationInfo.lastModifiedTime`
          *
-         * The fields can only be combined with `and` as a boolean operator. If this parameter is omitted or does not include a range for **modificationInfo.lastModifiedTime**, only revisions of the last 2 weeks are returned. (optional)
+         * The fields can only be combined with `and` as a boolean operator. If this parameter is omitted only revisions of the last 2 weeks are returned. If **modificationInfo.lastModifiedTime** does not specify a full range, it will be completed with current time minus 1 year for the missing lower bound or the current time for the upper bound. (optional)
          */ filter?: string;
         /**
          * The sort parameter, as explained [here](https://dt-url.net/platform-services-filtering). Sorting is supported on the following fields:
          * * `modificationInfo.lastModifiedTime` (optional, default to -modificationInfo.lastModifiedTime)
          */ sort?: string;
-        /** A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, **revision,modificationInfo**). Supported fields: **revision**, **jsonPatch**, **jsonBefore**, **jsonAfter**, **objectId**, **type**, **schemaVersion**,  **modificationInfo**.(optional, default to revision, modificationInfo) */ fields?: string;
+        /** A list of fields to be included to the response.Specify the required top-level fields, separated by commas (for example, **revision,modificationInfo**). Supported fields: **revision**, **jsonPatch**, **jsonBefore**, **jsonAfter**, **objectId**, **type**, **schemaId**, **schemaVersion**, **schemaDisplayName**, **modificationInfo**, **summary**, **source**, **appId**.(optional, default to revision, modificationInfo) */ fields?: string;
         /**
          * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
          *

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts

@@ -82,7 +82,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
     getLocations(config?: {
         /** Filters the resulting set of locations to those which are hosted on a specific cloud platform. */ cloudPlatform?: 'AWS' | 'AZURE' | 'ALIBABA' | 'GOOGLE_CLOUD' | 'OTHER';
         /** Filters the resulting set of locations to those of a specific type. */ type?: 'PUBLIC' | 'PRIVATE';
-        /** Filters the resulting set of locations to those which support specific capability. */ capability?: 'BROWSER' | 'HTTP' | 'ICMP' | 'TCP' | 'DNS';
+        /** Filters the resulting set of locations to those which support specific capability. */ capability?: 'BROWSER' | 'HTTP' | 'HTTP_HIGH_RESOURCE' | 'ICMP' | 'TCP' | 'DNS';
         abortSignal?: AbortSignal;
     }): Promise<SyntheticLocations>;
     /**

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

@@ -17,7 +17,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
     /**
      * Gets all synthetic monitors. Currently network availability monitors only. | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
+     * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
      *
      * @returns {Promise<SyntheticMonitorListDto>} Success
      *
@@ -52,7 +52,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
     /**
      * Creates a synthetic monitor definition. Currently network availability monitors only. | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
+     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
      *
      * @returns {Promise<MonitorEntityIdDto>} Success
      *
@@ -76,7 +76,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
     /**
      * Gets a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:viewer
+     * **Required scope:** environment-api:synthetic-monitors:read<br/>**Required permission:** environment:roles:manage-settings
      *
      * @returns {Promise<SyntheticMultiProtocolMonitorDto>} Success
      *
@@ -100,7 +100,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
     /**
      * Updates a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
+     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
      *
      * @example <caption>Code example</caption>
      * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -123,7 +123,7 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
     /**
      * Deletes a synthetic monitor definition for the given monitor ID. Currently network availability monitors only. | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:viewer
+     * **Required scope:** environment-api:synthetic-monitors:write<br/>**Required permission:** environment:roles:manage-settings
      *
      * @example <caption>Code example</caption>
      * import { syntheticNetworkAvailabilityMonitorsClient } from "@dynatrace-sdk/client-classic-environment-v2";

package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto-type.d.ts

@@ -9,6 +9,7 @@ export declare enum AssetInfoDtoType {
     CustomCards = "CUSTOM_CARDS",
     Dashboard = "DASHBOARD",
     DeclarativeProcesses = "DECLARATIVE_PROCESSES",
+    DocumentDashboard = "DOCUMENT_DASHBOARD",
     DqlLogMetric = "DQL_LOG_METRIC",
     DqlLogProcessingRule = "DQL_LOG_PROCESSING_RULE",
     GenericRelationship = "GENERIC_RELATIONSHIP",

package/types/packages/client/classic-environment-v2/src/lib/models/asset-info-dto.d.ts

@@ -18,5 +18,5 @@ export interface AssetInfoDto {
     /**
      * The type of the asset.
      */
-    type?: 'ALERT' | 'AWS_SERVICE' | 'CUSTOM_CARDS' | 'DASHBOARD' | 'DECLARATIVE_PROCESSES' | 'DQL_LOG_METRIC' | 'DQL_LOG_PROCESSING_RULE' | 'GENERIC_RELATIONSHIP' | 'GENERIC_TYPE' | 'LIST_SCREEN_FILTERS' | 'LIST_SCREEN_INJECTIONS' | 'LIST_SCREEN_LAYOUT' | 'LOG_EVENT' | 'LOG_METRIC' | 'LOG_PROCESSING_RULE' | 'LQL_LOG_METRIC' | 'LQL_LOG_PROCESSING_RULE' | 'METRIC_METADATA' | 'METRIC_QUERY' | 'SCREEN_ACTIONS' | 'SCREEN_CHART_GROUPS' | 'SCREEN_DQL_TABLE' | 'SCREEN_ENTITIES_LISTS' | 'SCREEN_EVENTS_CARDS' | 'SCREEN_FILTERS' | 'SCREEN_HEALTH_CARDS' | 'SCREEN_INJECTIONS' | 'SCREEN_LAYOUT' | 'SCREEN_LOGS_CARDS' | 'SCREEN_MESSAGE_CARDS' | 'SCREEN_METRIC_TABLES' | 'SCREEN_PROBLEMS' | 'SCREEN_PROPERTIES';
+    type?: 'ALERT' | 'AWS_SERVICE' | 'CUSTOM_CARDS' | 'DASHBOARD' | 'DECLARATIVE_PROCESSES' | 'DOCUMENT_DASHBOARD' | 'DQL_LOG_METRIC' | 'DQL_LOG_PROCESSING_RULE' | 'GENERIC_RELATIONSHIP' | 'GENERIC_TYPE' | 'LIST_SCREEN_FILTERS' | 'LIST_SCREEN_INJECTIONS' | 'LIST_SCREEN_LAYOUT' | 'LOG_EVENT' | 'LOG_METRIC' | 'LOG_PROCESSING_RULE' | 'LQL_LOG_METRIC' | 'LQL_LOG_PROCESSING_RULE' | 'METRIC_METADATA' | 'METRIC_QUERY' | 'SCREEN_ACTIONS' | 'SCREEN_CHART_GROUPS' | 'SCREEN_DQL_TABLE' | 'SCREEN_ENTITIES_LISTS' | 'SCREEN_EVENTS_CARDS' | 'SCREEN_FILTERS' | 'SCREEN_HEALTH_CARDS' | 'SCREEN_INJECTIONS' | 'SCREEN_LAYOUT' | 'SCREEN_LOGS_CARDS' | 'SCREEN_MESSAGE_CARDS' | 'SCREEN_METRIC_TABLES' | 'SCREEN_PROBLEMS' | 'SCREEN_PROPERTIES';
 }

package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.d.ts

@@ -5,6 +5,7 @@
  */
 export declare enum AuditLogEntryCategory {
     ActivegateToken = "ACTIVEGATE_TOKEN",
+    BuildUnitV2 = "BUILD_UNIT_V2",
     Config = "CONFIG",
     ManualTaggingService = "MANUAL_TAGGING_SERVICE",
     TenantLifecycle = "TENANT_LIFECYCLE",

package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-event-type.d.ts

@@ -19,6 +19,7 @@ export declare enum AuditLogEntryEventType {
     Delete = "DELETE",
     Login = "LOGIN",
     Logout = "LOGOUT",
+    Reorder = "REORDER",
     Revoke = "REVOKE",
     TagAdd = "TAG_ADD",
     TagRemove = "TAG_REMOVE",

package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts

@@ -6,7 +6,7 @@ export interface AuditLogEntry {
     /**
      * The category of the recorded operation.
      */
-    category: 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TENANT_LIFECYCLE' | 'TOKEN' | 'WEB_UI';
+    category: 'ACTIVEGATE_TOKEN' | 'BUILD_UNIT_V2' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TENANT_LIFECYCLE' | 'TOKEN' | 'WEB_UI';
     /**
      * The key of the affected object of a setting for entries of category `CONFIG`.
      */
@@ -55,7 +55,7 @@ export interface AuditLogEntry {
      * * `TAG_UPDATE` -> A manual tag was updated
      * * `REMOTE_CONFIGURATION_MANAGEMENT` -> A Remote Configuration Management related operation occurred
      */
-    eventType: 'CREATE' | 'DELETE' | 'LOGIN' | 'LOGOUT' | 'REVOKE' | 'TAG_ADD' | 'TAG_REMOVE' | 'TAG_UPDATE' | 'UPDATE';
+    eventType: 'CREATE' | 'DELETE' | 'LOGIN' | 'LOGOUT' | 'REORDER' | 'REVOKE' | 'TAG_ADD' | 'TAG_REMOVE' | 'TAG_UPDATE' | 'UPDATE';
     /**
      * The ID of the log entry.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/constraint.d.ts

@@ -10,6 +10,10 @@ export interface Constraint {
      * The ID of a custom validator.
      */
     customValidatorId?: string;
+    /**
+     * Whether to disallow usage of dangerous regexes
+     */
+    disallowDangerousRegex?: boolean;
     /**
      * The maximum allowed length of string values.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest-properties.d.ts

@@ -1,11 +1,11 @@
 /**
  * A map of event properties.
  *
- * Keys with prefix `dt.*` are generally disallowed, with the exceptions of `dt.event.*`, `dt.davis.*` and `dt.entity.*`. These reserved keys may be used to set event properties with predefined semantics within the Dynatrace product.
- * `dt.entity.*` keys may be used to provide additional information on an event, but will not lead to the event being tied to the specified entities.
- * All other keys are interpreted as user-defined event properties.
+ * * To set event properties with predefined behavior, use classic `dt.event.*` and `dt.davis.*` properties. To check which properties belong to classic API, see [Events API v2 - GET all event properties](https://dt-url.net/9622g1w).
+ * * To attach entity information to an event, use `dt.entity.*` keys.
+ * * To provide additional info, you can use any key outside of the `dt.*` namespace.
  *
- * Values of Dynatrace-reserved properties must fulfill the requirements of the respective property.
+ * Values of event properties with predefined behavior must fulfill the requirements of the respective property.
  *
  * A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.
  */

package/types/packages/client/classic-environment-v2/src/lib/models/event-ingest.d.ts

@@ -24,11 +24,11 @@ export interface EventIngest {
     /**
      * A map of event properties.
      *
-     * Keys with prefix `dt.*` are generally disallowed, with the exceptions of `dt.event.*`, `dt.davis.*` and `dt.entity.*`. These reserved keys may be used to set event properties with predefined semantics within the Dynatrace product.
-     * `dt.entity.*` keys may be used to provide additional information on an event, but will not lead to the event being tied to the specified entities.
-     * All other keys are interpreted as user-defined event properties.
+     * * To set event properties with predefined behavior, use classic `dt.event.*` and `dt.davis.*` properties. To check which properties belong to classic API, see [Events API v2 - GET all event properties](https://dt-url.net/9622g1w).
+     * * To attach entity information to an event, use `dt.entity.*` keys.
+     * * To provide additional info, you can use any key outside of the `dt.*` namespace.
      *
-     * Values of Dynatrace-reserved properties must fulfill the requirements of the respective property.
+     * Values of event properties with predefined behavior must fulfill the requirements of the respective property.
      *
      * A maximum of 100 properties can be specified. A property key is allowed to contain up to 100 characters. A property value is allowed to contain up to 4096 characters.
      */
@@ -41,6 +41,13 @@ export interface EventIngest {
      * Depending on the event type, the start time must not lie in the past more than 6 hours for problem-opening events and 30 days for info events.
      *
      * Depending on the event type, the start time must not lie in the future more than 5 minutes for problem-opening events and 7 days for info events.
+     *
+     * Events that can be sent up to 7 days in the future:
+     * * `CUSTOM_ANNOTATION`
+     * * `CUSTOM_CONFIGURATION`
+     * * `CUSTOM_DEPLOYMENT`
+     * * `CUSTOM_INFO`
+     * * `MARKED_FOR_TERMINATION`
      */
     startTime?: number;
     /**

package/types/packages/client/classic-environment-v2/src/lib/models/get-locations-query-capability.d.ts

@@ -4,6 +4,7 @@
 export declare enum GetLocationsQueryCapability {
     Browser = "BROWSER",
     Http = "HTTP",
+    HttpHighResource = "HTTP_HIGH_RESOURCE",
     Icmp = "ICMP",
     Tcp = "TCP",
     Dns = "DNS"