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

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

@@ -0,0 +1,44 @@
+import { FrameworkOptionsDto } from './framework-options-dto';
+import { TimeoutSettingsDto } from './timeout-settings-dto';
+import { VisuallyCompleteOptionsDto } from './visually-complete-options-dto';
+/**
+ * JavaScript Agent Settings.
+ */
+export interface JavaScriptAgentSettingsDto {
+    /**
+     * Custom configuration properties
+     */
+    customProperties?: string;
+    /**
+     * Experimental values support. If not defined in request, it will be set to false by default.
+     */
+    experimentalValues?: boolean;
+    /**
+     * Capture fetch() requests. If not defined in request, it will be set to true by default.
+     */
+    fetchRequests?: boolean;
+    /**
+     * Enable this setting to monitor JavaScript errors. The window.onError handler is used for capturing JavaScript errors. If not defined in request, it will be set to true by default.
+     */
+    javaScriptErrors?: boolean;
+    /**
+     * JS framework options of a JS Agent.
+     */
+    javaScriptFrameworkSupport?: FrameworkOptionsDto;
+    /**
+     * Within JavaScript frameworks, XHRs are often sent via setTimeout methods. Enable this setting to detect actions that trigger such XHRs. If not defined in request, it will be set to true by default.
+     */
+    timedActions?: boolean;
+    /**
+     * Timeout settings of a Browser Monitor.
+     */
+    timeoutSettings?: TimeoutSettingsDto;
+    /**
+     * Visually Complete Options of a Browser Monitor.
+     */
+    visuallyCompleteOptions?: VisuallyCompleteOptionsDto;
+    /**
+     * Capture xml Http requests (XHR). If not defined in request, it will be set to true by default.
+     */
+    xmlHttpRequests?: boolean;
+}

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

@@ -0,0 +1,20 @@
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+import { SyntheticBrowserMonitorStepDto } from './synthetic-browser-monitor-step-dto';
+import { TargetDto } from './target-dto';
+/**
+ * JavaScript step of Browser Monitor.
+ */
+export interface JavaScriptStepDto extends SyntheticBrowserMonitorStepDto {
+    /**
+     * String containing a script in JavaScript.
+     */
+    javaScript?: string;
+    /**
+     * Target of Browser Monitor step.
+     */
+    target?: TargetDto;
+    /**
+     * Wait condition for Browser Monitor step.
+     */
+    waitCondition?: BaseWaitConditionDto;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics-load-action-kpm.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Load action key performance metric.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum KeyPerformanceMetricsLoadActionKpm {
+    UserActionDuration = "USER_ACTION_DURATION",
+    VisuallyComplete = "VISUALLY_COMPLETE",
+    SpeedIndex = "SPEED_INDEX",
+    DomInteractive = "DOM_INTERACTIVE",
+    LoadEventStart = "LOAD_EVENT_START",
+    LoadEventEnd = "LOAD_EVENT_END",
+    ResponseStart = "RESPONSE_START",
+    ResponseEnd = "RESPONSE_END",
+    LargestContentfulPaint = "LARGEST_CONTENTFUL_PAINT",
+    CumulativeLayoutShift = "CUMULATIVE_LAYOUT_SHIFT"
+}

package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics-xhr-action-kpm.d.ts

@@ -0,0 +1,11 @@
+/**
+ * XHR action key performance metric.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum KeyPerformanceMetricsXhrActionKpm {
+    UserActionDuration = "USER_ACTION_DURATION",
+    VisuallyComplete = "VISUALLY_COMPLETE",
+    ResponseStart = "RESPONSE_START",
+    ResponseEnd = "RESPONSE_END"
+}

package/types/packages/client/classic-environment-v2/src/lib/models/key-performance-metrics.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The key performance metrics configuration.
+ */
+export interface KeyPerformanceMetrics {
+    /**
+     * Load action key performance metric.
+     */
+    loadActionKpm?: 'USER_ACTION_DURATION' | 'VISUALLY_COMPLETE' | 'SPEED_INDEX' | 'DOM_INTERACTIVE' | 'LOAD_EVENT_START' | 'LOAD_EVENT_END' | 'RESPONSE_START' | 'RESPONSE_END' | 'LARGEST_CONTENTFUL_PAINT' | 'CUMULATIVE_LAYOUT_SHIFT';
+    /**
+     * XHR action key performance metric.
+     */
+    xhrActionKpm?: 'USER_ACTION_DURATION' | 'VISUALLY_COMPLETE' | 'RESPONSE_START' | 'RESPONSE_END';
+}

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

@@ -0,0 +1,34 @@
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+import { KeystrokesInputDto } from './keystrokes-input-dto';
+import { SyntheticBrowserMonitorStepDto } from './synthetic-browser-monitor-step-dto';
+import { TargetDto } from './target-dto';
+import { ValidationRuleDto } from './validation-rule-dto';
+/**
+ * Key strokes step of Browser Monitor.
+ */
+export interface KeyStrokesStepDto extends SyntheticBrowserMonitorStepDto {
+    /**
+     * Key strokes step input.
+     */
+    input?: KeystrokesInputDto;
+    /**
+     * Boolean value set to true if blur event should be simulated.
+     */
+    simulateBlurEvent?: boolean;
+    /**
+     * Boolean value set to true if return key should be simulated.
+     */
+    simulateReturnKey?: boolean;
+    /**
+     * Target of Browser Monitor step.
+     */
+    target?: TargetDto;
+    /**
+     * List of validation rules for the step to perform.
+     */
+    validationRules?: ValidationRuleDto[];
+    /**
+     * Wait condition for Browser Monitor step.
+     */
+    waitCondition?: BaseWaitConditionDto;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Defines the actual set of fields depending on the value. See one of the following objects:
+ *
+ * * `SECURE` -> SecureKeystrokesInputDto
+ * * `PLAIN` -> PlainKeystrokesInputDto
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum KeystrokesInputDtoType {
+    Plain = "PLAIN",
+    Secure = "SECURE"
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Key strokes step input.
+ */
+export interface KeystrokesInputDto {
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `SECURE` -> SecureKeystrokesInputDto
+     * * `PLAIN` -> PlainKeystrokesInputDto
+     */
+    type: 'PLAIN' | 'SECURE';
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Enum value of the locator type.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum LocatorDtoType {
+    Css = "CSS",
+    Dom = "DOM"
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Browser Monitor locator.
+ */
+export interface LocatorDto {
+    /**
+     * Enum value of the locator type.
+     */
+    type: 'CSS' | 'DOM';
+    /**
+     * Value of the locator.
+     */
+    value: string;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Property of a Browser Monitor.
+ */
+export interface MonitorPropertyDto {
+    /**
+     * Property name.
+     */
+    name: string;
+    /**
+     * Property value.
+     */
+    value: string;
+}

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

@@ -0,0 +1,30 @@
+import { AuthenticationDto } from './authentication-dto';
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+import { SyntheticBrowserMonitorStepDto } from './synthetic-browser-monitor-step-dto';
+import { TargetDto } from './target-dto';
+import { ValidationRuleDto } from './validation-rule-dto';
+/**
+ * Step of Browser Monitor that navigates to a website.
+ */
+export interface NavigateStepDto extends SyntheticBrowserMonitorStepDto {
+    /**
+     * Authentication dto for Browser Monitor step.
+     */
+    authentication?: AuthenticationDto;
+    /**
+     * Target of Browser Monitor step.
+     */
+    target?: TargetDto;
+    /**
+     * Field containing the url that the monitor should navigate to.
+     */
+    url?: string;
+    /**
+     * List of validation rules for the step to perform.
+     */
+    validationRules?: ValidationRuleDto[];
+    /**
+     * Wait condition for Browser Monitor step.
+     */
+    waitCondition?: BaseWaitConditionDto;
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Network throttling of a Browser Monitor.
+ */
+export interface NetworkThrottlingDto {
+    /**
+     * Download throughput. If not defined in request, it will be set to -1 by default.
+     */
+    download?: number;
+    /**
+     * Latency. If not defined in request, it will be set to 0 by default.
+     */
+    latency?: number;
+    /**
+     * Predefined network type. If not defined in request, it will be set to "" by default.
+     */
+    name?: string;
+    /**
+     * Upload throughput. If not defined in request, it will be set to -1 by default.
+     */
+    upload?: number;
+}

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

@@ -0,0 +1,14 @@
+import { AuthenticationDto } from './authentication-dto';
+/**
+ * Plain authentication dto for Browser Monitor step.
+ */
+export interface PlainAuthenticationDto extends AuthenticationDto {
+    /**
+     * String containing the password.
+     */
+    password?: string;
+    /**
+     * String containing the username.
+     */
+    username?: string;
+}

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

@@ -0,0 +1,14 @@
+import { KeystrokesInputDto } from './keystrokes-input-dto';
+/**
+ * Credential-based input for keystrokes step.
+ */
+export interface PlainKeystrokesInputDto extends KeystrokesInputDto {
+    /**
+     * Boolean value set to true if key strokes should be masked. If not defined in request, the default value will be set to false.
+     */
+    masked?: boolean;
+    /**
+     * String value containing the text.
+     */
+    textValue?: string;
+}

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

@@ -0,0 +1,15 @@
+/**
+ * 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
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum PrivateSyntheticLocationFipsMode {
+    Disabled = "DISABLED",
+    Enabled = "ENABLED",
+    EnabledWithCorporateProxy = "ENABLED_WITH_CORPORATE_PROXY"
+}

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

@@ -53,6 +53,15 @@ export interface PrivateSyntheticLocation {
      * The Dynatrace entity ID of the location.
      */
     entityId?: string;
+    /**
+     * 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 Dynatrace GeoLocation ID of the location.
      */

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

@@ -0,0 +1,9 @@
+/**
+ * Browser Monitor proxy.
+ */
+export interface ProxyDto {
+    /**
+     * pacUrl
+     */
+    pacUrl: string;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * Filter type.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum RequestFilterDtoType {
+    StartsWith = "STARTS_WITH",
+    EndsWith = "ENDS_WITH",
+    Contains = "CONTAINS",
+    Equals = "EQUALS",
+    Regex = "REGEX"
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Request filter for Browser Monitor.
+ */
+export interface RequestFilterDto {
+    /**
+     * Regex for request that filter will be applied to.
+     */
+    matchingPattern: string;
+    /**
+     * Filter type.
+     */
+    type: 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS' | 'EQUALS' | 'REGEX';
+}

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

@@ -0,0 +1,14 @@
+import { MonitorRequestHeader } from './monitor-request-header';
+/**
+ * Header Options of a Browser Monitor.
+ */
+export interface RequestHeaderOptionsDto {
+    /**
+     * Apply headers to requests matching pattern.
+     */
+    matchingPatterns: string[];
+    /**
+     * Request headers list.
+     */
+    requestHeaders: MonitorRequestHeader[];
+}

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

@@ -0,0 +1,10 @@
+import { AuthenticationDto } from './authentication-dto';
+/**
+ * Secure authentication dto for Browser Monitor step.
+ */
+export interface SecureAuthenticationDto extends AuthenticationDto {
+    /**
+     * Id of the username and password credential which will be used for authentication.
+     */
+    credentialId?: string;
+}

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

@@ -0,0 +1,14 @@
+import { KeystrokesInputDto } from './keystrokes-input-dto';
+/**
+ * Credential-based input for keystrokes step.
+ */
+export interface SecureKeystrokesInputDto extends KeystrokesInputDto {
+    /**
+     * Enum value of the credential field.
+     */
+    credentialField?: 'USERNAME' | 'PASSWORD' | 'TOKEN';
+    /**
+     * String value containing the credential id.
+     */
+    credentialId?: string;
+}

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

@@ -0,0 +1,26 @@
+import { BaseWaitConditionDto } from './base-wait-condition-dto';
+import { SelectionDto } from './selection-dto';
+import { SyntheticBrowserMonitorStepDto } from './synthetic-browser-monitor-step-dto';
+import { TargetDto } from './target-dto';
+import { ValidationRuleDto } from './validation-rule-dto';
+/**
+ * Select option step of Browser Monitor.
+ */
+export interface SelectOptionStepDto extends SyntheticBrowserMonitorStepDto {
+    /**
+     * Field containing the credential.
+     */
+    selections?: SelectionDto[];
+    /**
+     * Target of Browser Monitor step.
+     */
+    target?: TargetDto;
+    /**
+     * List of validation rules for the step to perform.
+     */
+    validationRules?: ValidationRuleDto[];
+    /**
+     * Wait condition for Browser Monitor step.
+     */
+    waitCondition?: BaseWaitConditionDto;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Option selection for Browser Monitor step.
+ */
+export interface SelectionDto {
+    /**
+     * Selection index.
+     */
+    index: number;
+    /**
+     * Selection value.
+     */
+    value: string;
+}

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

@@ -0,0 +1,85 @@
+import { BrowserPermissionsDto } from './browser-permissions-dto';
+import { ChromiumStartupFlagsDto } from './chromium-startup-flags-dto';
+import { ClientCertificateDto } from './client-certificate-dto';
+import { FilteredRequestsDto } from './filtered-requests-dto';
+import { IgnoredErrorCodesDto } from './ignored-error-codes-dto';
+import { JavaScriptAgentSettingsDto } from './java-script-agent-settings-dto';
+import { MonitorPropertyDto } from './monitor-property-dto';
+import { NetworkThrottlingDto } from './network-throttling-dto';
+import { ProxyDto } from './proxy-dto';
+import { RequestHeaderOptionsDto } from './request-header-options-dto';
+import { SyntheticMonitorCookieDto } from './synthetic-monitor-cookie-dto';
+import { TestDeviceDto } from './test-device-dto';
+/**
+ * Browser Monitor configuration.
+ */
+export interface SyntheticBrowserMonitorConfigurationDto {
+    /**
+     * All requests matching the specified patterns will be blocked during the execution of the monitor.
+     */
+    blockedRequests?: string[];
+    /**
+     * Permissions settings for browser.
+     */
+    browserPermissions?: BrowserPermissionsDto;
+    /**
+     * Bypass ContentSecurity Policy for monitored pages. If not defined in request, it will be set to false by default.
+     */
+    bypassCSP?: boolean;
+    /**
+     * Chromium startup flags of a Browser Monitor.
+     */
+    chromiumStartupFlags?: ChromiumStartupFlagsDto;
+    /**
+     * Identifier of stored client's certificate.
+     */
+    clientCertificates?: ClientCertificateDto[];
+    /**
+     * Cookies list.
+     */
+    cookies?: SyntheticMonitorCookieDto[];
+    /**
+     * Test device of a Browser Monitor.
+     */
+    device: TestDeviceDto;
+    /**
+     * Experimental properties list.
+     */
+    experimentalProperties?: MonitorPropertyDto[];
+    /**
+     * Filtered requests of a Browser Monitor.
+     */
+    filteredRequests?: FilteredRequestsDto;
+    /**
+     * Ignored Error Codes of a Browser Monitor.
+     */
+    ignoredErrorCodes?: IgnoredErrorCodesDto;
+    /**
+     * JavaScript Agent Settings.
+     */
+    javaScriptSettings?: JavaScriptAgentSettingsDto;
+    /**
+     * Capture performance metrics for pages loaded in frames. If not defined in request, it will be set to false by default.
+     */
+    monitorFrames?: boolean;
+    /**
+     * Network throttling of a Browser Monitor.
+     */
+    networkThrottling?: NetworkThrottlingDto;
+    /**
+     * Browser Monitor proxy.
+     */
+    proxy?: ProxyDto;
+    /**
+     * Header Options of a Browser Monitor.
+     */
+    requestHeaderOptions?: RequestHeaderOptionsDto;
+    /**
+     * useIESupportedAgent flag. If not defined in request, it will be set to false by default.
+     */
+    useIESupportedAgent?: boolean;
+    /**
+     * User agent
+     */
+    userAgent?: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Monitor type.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum SyntheticBrowserMonitorRequestType {
+    MultiProtocol = "MULTI_PROTOCOL",
+    Browser = "BROWSER"
+}

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

@@ -0,0 +1,65 @@
+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 update.
+ */
+export interface SyntheticBrowserMonitorRequest {
+    /**
+     * Browser Monitor configuration.
+     */
+    configuration: SyntheticBrowserMonitorConfigurationDto;
+    /**
+     * Monitor description
+     */
+    description?: string;
+    /**
+     * If true, the monitor is enabled.
+     */
+    enabled?: boolean;
+    /**
+     * 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 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-response-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Monitor type.
+ *
+ * @deprecated Use literal values.
+ */
+export declare enum SyntheticBrowserMonitorResponseType {
+    MultiProtocol = "MULTI_PROTOCOL",
+    Browser = "BROWSER"
+}