@dynatrace-sdk/client-classic-environment-v2 3.7.2 → 4.1.0

package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts

@@ -36,6 +36,7 @@ export declare enum MonitoredEntityStatesState {
     ProcessGroupDisabledViaGlobalSettings = "process_group_disabled_via_global_settings",
     ProcessGroupDisabledViaInjectionRule = "process_group_disabled_via_injection_rule",
     ProcessGroupDisabledViaInjectionRuleRestart = "process_group_disabled_via_injection_rule_restart",
+    ProcessGroupPgrGroupUpdateSuppressed = "process_group_pgr_group_update_suppressed",
     RestartRequired = "restart_required",
     RestartRequiredApache = "restart_required_apache",
     RestartRequiredDockerDeamon = "restart_required_docker_deamon",

package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts

@@ -18,5 +18,5 @@ export interface MonitoredEntityStates {
     /**
      * The name of the monitoring state.
      */
-    state?: 'agent_injection_status_go_dynamizer_failed' | 'agent_injection_status_go_fips_detected_but_feature_disabled' | 'agent_injection_status_go_pclntab_failed' | 'agent_injection_status_go_vertigo_support_added' | 'agent_injection_status_nginx_patched_binary_detected' | 'agent_injection_status_php_opcache_disabled' | 'agent_injection_status_php_stack_size_too_low' | 'agent_injection_suppression' | 'aix_enable_full_monitoring_needed' | 'bad_installer' | 'boshbpm_disabled' | 'container_injection_failed' | 'containerd_disabled' | 'crio_disabled' | 'custom_pg_rule_required' | 'deep_monitoring_successful' | 'deep_monitoring_unsuccessful' | 'docker_disabled' | 'garden_disabled' | 'host_infra_structure_only' | 'host_monitoring_disabled' | 'network_agent_inactive' | 'ok' | 'parent_process_restart_required' | 'podman_disabled' | 'process_group_different_id_due_to_declarative_grouping' | 'process_group_disabled' | 'process_group_disabled_via_container_injection_rule' | 'process_group_disabled_via_container_injection_rule_restart' | 'process_group_disabled_via_global_settings' | 'process_group_disabled_via_injection_rule' | 'process_group_disabled_via_injection_rule_restart' | 'restart_required' | 'restart_required_apache' | 'restart_required_docker_deamon' | 'restart_required_host_group_inconsistent' | 'restart_required_host_id_inconsistent' | 'restart_required_outdated_agent_apache_update' | 'restart_required_outdated_agent_injected' | 'restart_required_using_different_data_storage_dir' | 'restart_required_using_different_log_path' | 'restart_required_virtualized_container' | 'unsupported_state' | 'winc_disabled';
+    state?: 'agent_injection_status_go_dynamizer_failed' | 'agent_injection_status_go_fips_detected_but_feature_disabled' | 'agent_injection_status_go_pclntab_failed' | 'agent_injection_status_go_vertigo_support_added' | 'agent_injection_status_nginx_patched_binary_detected' | 'agent_injection_status_php_opcache_disabled' | 'agent_injection_status_php_stack_size_too_low' | 'agent_injection_suppression' | 'aix_enable_full_monitoring_needed' | 'bad_installer' | 'boshbpm_disabled' | 'container_injection_failed' | 'containerd_disabled' | 'crio_disabled' | 'custom_pg_rule_required' | 'deep_monitoring_successful' | 'deep_monitoring_unsuccessful' | 'docker_disabled' | 'garden_disabled' | 'host_infra_structure_only' | 'host_monitoring_disabled' | 'network_agent_inactive' | 'ok' | 'parent_process_restart_required' | 'podman_disabled' | 'process_group_different_id_due_to_declarative_grouping' | 'process_group_disabled' | 'process_group_disabled_via_container_injection_rule' | 'process_group_disabled_via_container_injection_rule_restart' | 'process_group_disabled_via_global_settings' | 'process_group_disabled_via_injection_rule' | 'process_group_disabled_via_injection_rule_restart' | 'process_group_pgr_group_update_suppressed' | 'restart_required' | 'restart_required_apache' | 'restart_required_docker_deamon' | 'restart_required_host_group_inconsistent' | 'restart_required_host_id_inconsistent' | 'restart_required_outdated_agent_apache_update' | 'restart_required_outdated_agent_injected' | 'restart_required_using_different_data_storage_dir' | 'restart_required_using_different_log_path' | 'restart_required_virtualized_container' | 'unsupported_state' | 'winc_disabled';
 }

package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts

@@ -6,7 +6,7 @@ import { PrivateSyntheticLocationNodeNames } from './private-synthetic-location-
  */
 export interface PrivateSyntheticLocation {
     /**
-     * Auto upgrade of Chromium is enabled (`true`) or disabled (`false`).
+     * Non-containerized location property. Auto upgrade of Chromium is enabled (`true`) or disabled (`false`).
      */
     autoUpdateChromium?: boolean;
     /**
@@ -22,7 +22,7 @@ export interface PrivateSyntheticLocation {
      */
     availabilityNotificationsEnabled?: boolean;
     /**
-     * Boolean value describes if browser monitors will be executed on this location:
+     * Containerized location property. Boolean value describes if browser monitors will be executed on this location:
      *
      * * `false`: Browser monitor executions disabled.
      * * `true`: Browser monitor executions enabled.
@@ -70,7 +70,7 @@ export interface PrivateSyntheticLocation {
      */
     longitude: number;
     /**
-     * Boolean value describes if icmp monitors will be executed on this location:
+     * Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
      *
      * * `false`: Icmp monitor executions disabled.
      * * `true`: Icmp monitor executions enabled.
@@ -110,7 +110,7 @@ export interface PrivateSyntheticLocation {
     status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
     type: 'CLUSTER' | 'PRIVATE' | 'PUBLIC';
     /**
-     * Boolean value describes which kubernetes version will be used:
+     * Containerized location property. Boolean value describes which kubernetes version will be used:
      *
      * * `false`: Version 1.23+ that is older than 1.26
      * * `true`: Version 1.26+.

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

@@ -4,6 +4,7 @@
  * @deprecated Use literal values.
  */
 export declare enum SchemaConstraintRestDtoType {
+    ByteSizeLimit = "BYTE_SIZE_LIMIT",
     CustomValidatorRef = "CUSTOM_VALIDATOR_REF",
     MultiScopeCustomValidatorRef = "MULTI_SCOPE_CUSTOM_VALIDATOR_REF",
     MultiScopeUnique = "MULTI_SCOPE_UNIQUE",

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

@@ -1,4 +1,8 @@
 export interface SchemaConstraintRestDto {
+    /**
+     * The maximum allowed size in bytes for the sum over all persisted values for the schema
+     */
+    byteLimit?: number;
     /**
      * A custom message for invalid values.
      */
@@ -14,7 +18,7 @@ export interface SchemaConstraintRestDto {
     /**
      * The type of the schema constraint.
      */
-    type: 'CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_UNIQUE' | 'UNIQUE' | 'UNKNOWN';
+    type: 'BYTE_SIZE_LIMIT' | 'CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_CUSTOM_VALIDATOR_REF' | 'MULTI_SCOPE_UNIQUE' | 'UNIQUE' | 'UNKNOWN';
     /**
      * The list of properties for which the combination of values needs to be unique
      */

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

@@ -18,6 +18,10 @@ export interface SchemaStub {
      * Ordered flag. `True` if the schema is an ordered multi-object schema.
      */
     ordered?: boolean;
+    /**
+     * Owner based access control flag. `True` if the schema has owner based access control enabled.
+     */
+    ownerBasedAccessControl?: boolean;
     /**
      * The ID of the schema.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-outage-handling-settings-dto.d.ts

@@ -5,7 +5,7 @@ export interface SyntheticMonitorOutageHandlingSettingsDto {
     /**
      * Number of consecutive failures for all locations.
      */
-    globalConsecutiveOutageCountThreshold: number;
+    globalConsecutiveOutageCountThreshold?: number;
     /**
      * Generate a problem and send an alert when the monitor is unavailable at all configured locations.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Type of performance threshold
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum SyntheticMonitorPerformanceThresholdDtoType {
+    Monitor = "MONITOR",
+    Step = "STEP"
+}

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-monitor-performance-threshold-dto.d.ts

@@ -17,11 +17,15 @@ export interface SyntheticMonitorPerformanceThresholdDto {
     /**
      * Specify the step's index to which a threshold applies.
      */
-    stepIndex: number;
+    stepIndex?: number;
     /**
      * Notify if monitor request takes longer than *X* milliseconds to execute.
      */
     threshold: number;
+    /**
+     * Type of performance threshold
+     */
+    type?: 'MONITOR' | 'STEP';
     /**
      * Number of violating request executions in analyzed sliding window
      */

package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-update-dto-type.d.ts → synthetic-multi-protocol-monitor-request-type.d.ts}

@@ -3,6 +3,6 @@
  *
  * @deprecated Use literal values.
  */
-export declare enum SyntheticMultiProtocolMonitorUpdateDtoType {
+export declare enum SyntheticMultiProtocolMonitorRequestType {
     MultiProtocol = "MULTI_PROTOCOL"
 }

package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-update-dto.d.ts → synthetic-multi-protocol-monitor-request.d.ts}

@@ -5,7 +5,7 @@ import { SyntheticTagWithSourceDto } from './synthetic-tag-with-source-dto';
 /**
  * Network Availability monitor.
  */
-export interface SyntheticMultiProtocolMonitorUpdateDto {
+export interface SyntheticMultiProtocolMonitorRequest {
     /**
      * Monitor description
      */

package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-dto-type.d.ts → synthetic-multi-protocol-monitor-response-type.d.ts}

@@ -3,7 +3,7 @@
  *
  * @deprecated Use literal values.
  */
-export declare enum SyntheticMultiProtocolMonitorDtoType {
+export declare enum SyntheticMultiProtocolMonitorResponseType {
     MultiProtocol = "MULTI_PROTOCOL",
     Browser = "BROWSER",
     Http = "HTTP"

package/types/packages/client/classic-environment-v2/src/lib/models/{synthetic-multi-protocol-monitor-dto.d.ts → synthetic-multi-protocol-monitor-response.d.ts}

@@ -5,7 +5,7 @@ import { SyntheticTagWithSourceDto } from './synthetic-tag-with-source-dto';
 /**
  * Network Availability monitor.
  */
-export interface SyntheticMultiProtocolMonitorDto {
+export interface SyntheticMultiProtocolMonitorResponse {
     /**
      * Monitor description
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-private-location-update.d.ts

@@ -4,7 +4,7 @@ import { SyntheticLocationUpdate } from './synthetic-location-update';
  */
 export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate {
     /**
-     * Auto upgrade of Chromium is enabled (`true`) or disabled (`false`).
+     * Non-containerized location property. Auto upgrade of Chromium is enabled (`true`) or disabled (`false`).
      */
     autoUpdateChromium?: boolean;
     /**
@@ -20,7 +20,7 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      */
     availabilityNotificationsEnabled?: boolean;
     /**
-     * Boolean value describes if browser monitors will be executed on this location:
+     * Containerized location property. Boolean value describes if browser monitors will be executed on this location:
      *
      * * `false`: Browser monitor executions disabled.
      * * `true`: Browser monitor executions enabled.
@@ -56,7 +56,15 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      */
     longitude?: number;
     /**
-     * Boolean value describes if icmp monitors will be executed on this location:
+     * Containerized location property. The maximum number of ActiveGates deployed for the location (required for a Kubernetes location).
+     */
+    maxActiveGateCount?: number;
+    /**
+     * Containerized location property. The minimum number of ActiveGates deployed for the location (required for a Kubernetes location).
+     */
+    minActiveGateCount?: number;
+    /**
+     * Containerized location property. Boolean value describes if icmp monitors will be executed on this location:
      *
      * * `false`: Icmp monitor executions disabled.
      * * `true`: Icmp monitor executions enabled.
@@ -66,6 +74,15 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      * The name of the location.
      */
     name?: string;
+    /**
+     * Containerized location property. The size of a containerized node deployed for the location (required for a Kubernetes location). Accepted values:
+     *
+     * * `XS`: extra small
+     * * `S`: small
+     * * `M`: medium
+     * The node size `L` is not supported in containerized locations.
+     */
+    nodeSize?: 'M' | 'S' | 'UNSUPPORTED' | 'XS';
     /**
      * A list of synthetic nodes belonging to the location.
      *
@@ -87,7 +104,7 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      */
     status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
     /**
-     * Boolean value describes which kubernetes version will be used:
+     * Containerized location property. Boolean value describes which kubernetes version will be used:
      *
      * * `false`: Version 1.23+ that is older than 1.26
      * * `true`: Version 1.26+.

package/types/packages/{client/classic-environment-v2/src/lib/apis → shared-client-utils/src}/api-client-options.d.ts

@@ -1,5 +1,5 @@
 /**
- * Configuration for generated TypeScript SDK clients
+ * Configuration for the API client.
  * @param {boolean} transformDates - Flag to control date transformations, enabled by default.
  */
 export interface ApiClientOptions {

package/types/packages/shared-client-utils/src/api-gateway-errors-handler.d.ts

@@ -0,0 +1,9 @@
+import type { HttpClientResponse } from '@dynatrace-sdk/http-client';
+/**
+ * Handles errors from API Gateway responses.
+ * Throws an ApiGatewayError if the response source is 'API Gateway'.
+ *
+ * @param {HttpClientResponse} response - The HTTP response to check for API Gateway errors.
+ * @throws {ApiGatewayError} If the response is from API Gateway and contains an error.
+ */
+export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

package/types/packages/shared-client-utils/src/encoding.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Available formats to transform models to and from
+ */
+export declare enum Encoding {
+    Json = "json",
+    Text = "text",
+    Binary = "binary",
+    FormData = "form-data"
+}
+/**
+ * Maps a MIME type string to an Encoding.
+ *
+ * @param {string} mimeType - The MIME type to convert (e.g., 'application/json').
+ * @param {Encoding} [defaultEncoding] - The encoding to return if the MIME type isn't recognized.
+ * @returns {Encoding} The corresponding Encoding enum value, or the defaultEncoding if not recognized.
+ */
+export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/shared-client-utils/src/get-error-message.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a user-friendly error message from an error body object.
+ *
+ * @param {unknown} errorBody - The error object or response body to extract the message from.
+ * @param {string} defaultMessage - The default message to use if no error message is found.
+ * @returns {string} The extracted or default error message, possibly including details.
+ */
+export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/shared-client-utils/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api-client-options';
+export * from './api-gateway-errors-handler';
+export * from './encoding';
+export * from './get-error-message';
+export * from './transformations';
+export * from './url-helpers';

package/types/packages/shared-client-utils/src/transformations.d.ts

@@ -0,0 +1,64 @@
+import { FormDataRequestBody, FormDataRequestField, FormDataResponseBody } from '@dynatrace-sdk/http-client';
+export type TransformRuleConfig = {
+    force?: boolean;
+    datetime?: boolean;
+};
+export type TransformRulesParam = Array<string | [string, TransformRuleConfig]>;
+/**
+ * Transforms an object by applying transformation rules before sending it in a request.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformRequest<T = any>(object: T, rules: TransformRulesParam): T;
+/**
+ * Transforms an object by applying transformation rules after receiving it in a response.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformResponse<T = any>(object: T, rules: TransformRulesParam): T;
+export interface FormDataRequestFieldDefinition {
+    key: string;
+    type: 'text' | 'json' | 'binary';
+    required: boolean;
+}
+export interface FormDataResponseGenericFieldDefinition {
+    type: 'text' | 'binary';
+}
+export interface FormDataResponseJsonFieldDefinition {
+    type: 'json';
+    transformations: Array<string | [string, TransformRuleConfig]>;
+}
+export type FormDataResponseFieldDefinition = FormDataResponseGenericFieldDefinition | FormDataResponseJsonFieldDefinition;
+/**
+ * Converts an object to a FormDataRequestBody using field definitions.
+ *
+ * @template T
+ * @param {T} value - The object to convert.
+ * @param {Array<FormDataRequestFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {FormDataRequestBody} The resulting form data body.
+ */
+export declare function transformToFormData<T extends Record<any, any>>(value: T, fields: Array<FormDataRequestFieldDefinition>): FormDataRequestBody;
+/**
+ * Converts a value to a FormDataRequestField based on the field definition.
+ *
+ * @template T
+ * @param {T} value - The value to convert.
+ * @param {FormDataRequestFieldDefinition} field - The field definition.
+ * @returns {FormDataRequestField | null} The resulting form data field or null if not required and undefined.
+ */
+export declare function transformToFormDataField<T = any>(value: T, field: FormDataRequestFieldDefinition): FormDataRequestField | null;
+/**
+ * Converts form data and field definitions into a typed object, applying transformations for JSON fields.
+ *
+ * @template T
+ * @param {FormDataResponseBody} formData - The form data to convert.
+ * @param {Record<string, FormDataResponseFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {T} The resulting typed object.
+ */
+export declare function transformFromFormData<T extends Record<any, any>>(formData: FormDataResponseBody, fields: Record<string, FormDataResponseFieldDefinition>): T;

package/types/packages/shared-client-utils/src/url-helpers.d.ts

@@ -0,0 +1,12 @@
+export type QueryParamsType = Record<string | number, any>;
+export interface ParametersFlags {
+    explode?: Record<string, boolean>;
+}
+/**
+ * Converts an object of query parameters into a URL query string.
+ *
+ * @param {QueryParamsType} [rawQuery] - The object containing query parameters.
+ * @param {ParametersFlags} [flags] - Flags to control parameter formatting (e.g., explode arrays).
+ * @returns {string} The resulting query string.
+ */
+export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts

@@ -1,2 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/get-error-message.d.ts

@@ -1 +0,0 @@
-export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts

@@ -1,10 +0,0 @@
-/**
- * Available formats to transform models to and from
- */
-export declare enum Encoding {
-    Json = "json",
-    Text = "text",
-    Binary = "binary",
-    FormData = "form-data"
-}
-export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/client/classic-environment-v2/src/lib/utils/transformations.d.ts

@@ -1,8 +0,0 @@
-type TransformRuleConfig = {
-    force?: boolean;
-    datetime?: boolean;
-};
-type TransformRulesParam = Array<string | [string, TransformRuleConfig]>;
-export declare function transformRequest<T = any>(object: T, rules: TransformRulesParam): T;
-export declare function transformResponse<T = any>(object: T, rules: TransformRulesParam): T;
-export {};

package/types/packages/client/classic-environment-v2/src/lib/utils/url-helpers.d.ts

@@ -1,6 +0,0 @@
-type QueryParamsType = Record<string | number, any>;
-interface ParametersFlags {
-    explode?: Record<string, boolean>;
-}
-export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;
-export {};