@dynatrace-sdk/client-classic-environment-v2 4.2.0 → 5.1.0

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-browser-monitor-response.d.ts

@@ -0,0 +1,77 @@
+import { KeyPerformanceMetrics } from './key-performance-metrics';
+import { SyntheticBrowserMonitorConfigurationDto } from './synthetic-browser-monitor-configuration-dto';
+import { SyntheticBrowserMonitorStepDto } from './synthetic-browser-monitor-step-dto';
+import { SyntheticMonitorOutageHandlingSettingsDto } from './synthetic-monitor-outage-handling-settings-dto';
+import { SyntheticMonitorPerformanceThresholdsDto } from './synthetic-monitor-performance-thresholds-dto';
+import { SyntheticTagWithSourceDto } from './synthetic-tag-with-source-dto';
+/**
+ * Browser Monitor.
+ */
+export interface SyntheticBrowserMonitorResponse {
+    /**
+     * Automatically assigned entities.
+     */
+    automaticallyAssignedEntities?: string[];
+    /**
+     * Browser Monitor configuration.
+     */
+    configuration: SyntheticBrowserMonitorConfigurationDto;
+    /**
+     * Monitor description
+     */
+    description?: string;
+    /**
+     * If true, the monitor is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * The entity id of the monitor.
+     */
+    entityId: string;
+    /**
+     * The frequency of the monitor, in minutes.
+     */
+    frequencyMin?: number;
+    /**
+     * The key performance metrics configuration.
+     */
+    keyPerformanceMetrics: KeyPerformanceMetrics;
+    /**
+     * The locations to which the monitor is assigned.
+     */
+    locations?: string[];
+    /**
+     * Manually assigned entities.
+     */
+    manuallyAssignedEntities?: string[];
+    /**
+     * The timestamp of the last modification
+     */
+    modificationTimestamp?: number;
+    /**
+     * The name of the monitor.
+     */
+    name?: string;
+    /**
+     * Performance thresholds configuration.
+     */
+    performanceThresholds?: SyntheticMonitorPerformanceThresholdsDto;
+    /**
+     * The steps of the monitor.
+     */
+    steps: SyntheticBrowserMonitorStepDto[];
+    /**
+     * Outage handling configuration.
+     */
+    syntheticMonitorOutageHandlingSettings: SyntheticMonitorOutageHandlingSettingsDto;
+    /**
+     * A set of tags assigned to the monitor.
+     *
+     *  You can specify only the value of the tag here and the `CONTEXTLESS` context and source 'USER' will be added automatically. But preferred option is usage of SyntheticTagWithSourceDto model.
+     */
+    tags?: SyntheticTagWithSourceDto[];
+    /**
+     * Monitor type.
+     */
+    type: 'MULTI_PROTOCOL' | 'BROWSER';
+}

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

@@ -0,0 +1,22 @@
+/**
+ * Defines the actual set of fields depending on the value. See one of the following objects:
+ *
+ * * `NAVIGATE` -> NavigateStepDto
+ * * `CLICK` -> InteractionStepDto
+ * * `TAP` -> InteractionStepDto
+ * * `KEYSTROKES` -> KeyStrokesStepDto
+ * * `JAVASCRIPT` -> JavaScriptStepDto
+ * * `SELECT_OPTION` -> SelectOptionStepDto
+ * * `COOKIE` -> CookieStepDto
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum SyntheticBrowserMonitorStepDtoType {
+    Click = "CLICK",
+    Cookie = "COOKIE",
+    Javascript = "JAVASCRIPT",
+    Keystrokes = "KEYSTROKES",
+    Navigate = "NAVIGATE",
+    SelectOption = "SELECT_OPTION",
+    Tap = "TAP"
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Base step of Browser Monitor.
+ */
+export interface SyntheticBrowserMonitorStepDto {
+    /**
+     * Entity Id.
+     */
+    entityId?: string;
+    /**
+     * The name of Browser Monitor step.
+     */
+    name: string;
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `NAVIGATE` -> NavigateStepDto
+     * * `CLICK` -> InteractionStepDto
+     * * `TAP` -> InteractionStepDto
+     * * `KEYSTROKES` -> KeyStrokesStepDto
+     * * `JAVASCRIPT` -> JavaScriptStepDto
+     * * `SELECT_OPTION` -> SelectOptionStepDto
+     * * `COOKIE` -> CookieStepDto
+     */
+    type: 'CLICK' | 'COOKIE' | 'JAVASCRIPT' | 'KEYSTROKES' | 'NAVIGATE' | 'SELECT_OPTION' | 'TAP';
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Cookie dto for Synthetic Monitor step.
+ */
+export interface SyntheticMonitorCookieDto {
+    /**
+     * Cookie domain.
+     */
+    domain: string;
+    /**
+     * Cookie name.
+     */
+    name: string;
+    /**
+     * Cookie path.
+     */
+    path?: string;
+    /**
+     * Cookie value.
+     */
+    value: string;
+}

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

@@ -4,5 +4,6 @@
  * @deprecated Use literal values.
  */
 export declare enum SyntheticMultiProtocolMonitorRequestType {
-    MultiProtocol = "MULTI_PROTOCOL"
+    MultiProtocol = "MULTI_PROTOCOL",
+    Browser = "BROWSER"
 }

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

@@ -47,5 +47,5 @@ export interface SyntheticMultiProtocolMonitorRequest {
     /**
      * Monitor type.
      */
-    type: 'MULTI_PROTOCOL';
+    type: 'MULTI_PROTOCOL' | 'BROWSER';
 }

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

@@ -5,6 +5,5 @@
  */
 export declare enum SyntheticMultiProtocolMonitorResponseType {
     MultiProtocol = "MULTI_PROTOCOL",
-    Browser = "BROWSER",
-    Http = "HTTP"
+    Browser = "BROWSER"
 }

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

@@ -25,7 +25,7 @@ export interface SyntheticMultiProtocolMonitorResponse {
     /**
      * The locations to which the monitor is assigned.
      */
-    locations: string[];
+    locations?: string[];
     /**
      * The timestamp of the last modification
      */
@@ -33,7 +33,7 @@ export interface SyntheticMultiProtocolMonitorResponse {
     /**
      * The name of the monitor.
      */
-    name: string;
+    name?: string;
     /**
      * Performance thresholds configuration.
      */
@@ -55,5 +55,5 @@ export interface SyntheticMultiProtocolMonitorResponse {
     /**
      * Monitor type.
      */
-    type: 'MULTI_PROTOCOL' | 'BROWSER' | 'HTTP';
+    type: 'MULTI_PROTOCOL' | 'BROWSER';
 }

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-execution.d.ts

@@ -49,7 +49,7 @@ export interface SyntheticOnDemandExecution {
     /**
      * Next execution id for sequential mode.
      */
-    nextExecutionId?: number;
+    nextExecutionId?: string;
     /**
      * The processing mode of the execution.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-triggering-problem-details.d.ts

@@ -17,7 +17,7 @@ export interface SyntheticOnDemandTriggeringProblemDetails {
     /**
      * The execution identifier.
      */
-    executionId: number;
+    executionId: string;
     /**
      * The location identifier.
      */

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

@@ -43,6 +43,15 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      * * `KUBERNETES`: The location is deployed on Kubernetes.
      */
     deploymentType?: 'KUBERNETES' | 'OPENSHIFT' | 'STANDARD' | 'UNKNOWN';
+    /**
+     * Containerized location property indicating whether FIPS mode is enabled on this location:
+     *
+     * * `DISABLED`: FIPS is not enabled on the location.
+     * * `ENABLED`: FIPS is enabled on the location.
+     * * `ENABLED_WITH_CORPORATE_PROXY`: FIPS with corporate proxy is enabled on this location.
+     * Default: DISABLED
+     */
+    fipsMode?: 'DISABLED' | 'ENABLED' | 'ENABLED_WITH_CORPORATE_PROXY';
     /**
      * The latitude of the location in `DDD.dddd` format.
      */

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

@@ -0,0 +1,14 @@
+import { LocatorDto } from './locator-dto';
+/**
+ * Target of Browser Monitor step.
+ */
+export interface TargetDto {
+    /**
+     * List of locators.
+     */
+    locators: LocatorDto[];
+    /**
+     * Target window.
+     */
+    window: string;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Test device of a Browser Monitor.
+ */
+export interface TestDeviceDto {
+    /**
+     * Device height in px.
+     */
+    height: number;
+    /**
+     * Device is mobile. If not defined in request, it will be set to false by default.
+     */
+    mobile?: boolean;
+    /**
+     * Device name.
+     */
+    name: string;
+    /**
+     * Device is touch enabled. If not defined in request, it will be set to false by default.
+     */
+    touchEnabled?: boolean;
+    /**
+     * Device width in px.
+     */
+    width: number;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/time-wait-condition-dto.d.ts

@@ -0,0 +1,10 @@
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+/**
+ * Time wait condition for Browser Monitor step.
+ */
+export interface TimeWaitConditionDto extends BaseWaitConditionDto {
+    /**
+     * Wait time in milliseconds.
+     */
+    milliseconds?: number;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Timeout settings of a Browser Monitor.
+ */
+export interface TimeoutSettingsDto {
+    /**
+     * Cascading setTimeout calls number limit. If not defined in request, it will be set to 1 by default.
+     */
+    temporaryActionLimit?: number;
+    /**
+     * No additional timeout actions will be created once this time limit is reached. Value must be higher than 0 ms. If not defined in request, it will be set to 100 by default.
+     */
+    temporaryActionTotalTimeout?: number;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * Type of validation.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum ValidationRuleDtoType {
+    TextMatch = "TEXT_MATCH",
+    ContentMatch = "CONTENT_MATCH",
+    ElementMatch = "ELEMENT_MATCH"
+}

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

@@ -0,0 +1,26 @@
+import { TargetDto } from './target-dto';
+/**
+ * Validation rule of Browser Monitor step.
+ */
+export interface ValidationRuleDto {
+    /**
+     * Boolean value, true if we should fail on found pattern. If not defined in request, it will be set to false by default.
+     */
+    failIfFound: boolean;
+    /**
+     * Text pattern that should match on the website.
+     */
+    matchingPattern: string;
+    /**
+     * Boolean value, true if the "matchingPattern" value is a regex. If not defined in request, it will be set to false by default.
+     */
+    regex?: boolean;
+    /**
+     * Target of Browser Monitor step.
+     */
+    target?: TargetDto;
+    /**
+     * Type of validation.
+     */
+    type: 'TEXT_MATCH' | 'CONTENT_MATCH' | 'ELEMENT_MATCH';
+}

package/types/packages/client/classic-environment-v2/src/lib/models/validation-wait-condition-dto.d.ts

@@ -0,0 +1,15 @@
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+import { ValidationRuleDto } from './validation-rule-dto';
+/**
+ * Validation wait condition for Browser Monitor step.
+ */
+export interface ValidationWaitConditionDto extends BaseWaitConditionDto {
+    /**
+     * Validation timeout in milliseconds.
+     */
+    timeoutInMilliseconds?: number;
+    /**
+     * Validation rule of Browser Monitor step.
+     */
+    validationRule?: ValidationRuleDto;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/visually-complete-options-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Visually Complete Options of a Browser Monitor.
+ */
+export interface VisuallyCompleteOptionsDto {
+    /**
+     * Query CSS selectors to specify mutation nodes (elements that change) to ignore in Visually complete and Speed index calculation.
+     */
+    excludedElements?: string[];
+    /**
+     * Use regular expressions to define URLs for images and iFrames to exclude from detection by the Visually complete module.
+     */
+    excludedUrls?: string[];
+    /**
+     * Use this setting to define the minimum visible area per element (in pixels) for an element to be counted towards Visually complete and Speed index. If not defined in request, it will be set to 50 by default.
+     */
+    imageSizeThreshold?: number;
+    /**
+     * The time the Visually complete module waits for inactivity and no further mutations on the page after the load action. If not defined in request, it will be set to 1000 by default.
+     */
+    inactivityTimeout?: number;
+    /**
+     * The time the Visually complete module waits after an XHR or custom action closes to start the calculation. If not defined in request, it will be set to 50 by default.
+     */
+    mutationTimeout?: number;
+}

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

@@ -0,0 +1,10 @@
+/**
+ * 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

@@ -0,0 +1,8 @@
+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

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

package/types/packages/shared-errors/src/client-request-error.d.ts

@@ -36,4 +36,4 @@ export declare class ClientRequestError<DTO = ErrorResponseBody> extends ApiClie
  *   }
  * }
  */
-export declare function isClientRequestError(e: any): e is ClientRequestError;
+export declare function isClientRequestError<T = ErrorResponseBody>(e: any): e is ClientRequestError<T>;

package/types/packages/shared-errors/src/types.d.ts

@@ -16,7 +16,7 @@ export interface ErrorResponseBody<T = CommonApiError> {
 /**
  * Common API error structure, established by Dynatrace API guidelines.
  * */
-export interface CommonApiError<T extends Record<string, any> = Record<string, any>> {
+export interface CommonApiError<T extends CommonErrorDetails & Record<string, any> = CommonErrorDetails & Record<string, any>> {
     /** The error code should be set to the HTTP error code by default.<br>
      * The error code may be set to an API-specific error code which must be properly documented.*/
     code: number;

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

@@ -1,9 +0,0 @@
-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

@@ -1,17 +0,0 @@
-/**
- * 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

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,6 +0,0 @@
-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

@@ -1,64 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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;