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

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"
+}

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;
+}