@dynatrace-sdk/client-classic-environment-v2 0.6.1 → 0.6.4

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

@@ -5,26 +5,10 @@ import { SLOStatus, _SLOStatusTransformation } from './slo-status';
  * Parameters of a service-level objective (SLO).
  */
 export interface SLO {
-    /**
-     * The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
-     */
-    problemFilters?: string[];
-    /**
-     * The error budget burn rate key for a metric expression.
-     */
-    burnRateMetricKey?: string;
-    /**
-     * The error budget key for a metric expression.
-     */
-    errorBudgetMetricKey?: string;
     /**
      * The normalized error budget key for a metric expression.
      */
     normalizedErrorBudgetMetricKey?: string;
-    /**
-     * The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
-     */
-    numeratorValue?: number;
     /**
      * The denominator value used to evaluate the SLO when **useRateMetric** is set to `false`.
      */
@@ -35,12 +19,6 @@ export interface SLO {
      * Has the value of `-1` if there's an error with fetching SLO related problems.
      */
     relatedOpenProblems?: number;
-    /**
-     * Total number of problems related to the SLO.
-     *
-     * Has the value of `-1` if there's an error with fetching SLO related problems.
-     */
-    relatedTotalProblems?: number;
     /**
      * The calculated value of the SLO. Has the value of the evaluated SLO or the value of `-1`:
      *
@@ -49,11 +27,9 @@ export interface SLO {
      */
     evaluatedPercentage?: number;
     /**
-     * The error budget of the calculated SLO.
-     *
-     * The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
+     * The entity filter for fetching the number of problems related to an SLO. Auto-generated in case no filter has been added to the SLO.
      */
-    errorBudget?: number;
+    problemFilters?: string[];
     /**
      * The percentage-based metric expression for the calculation of the SLO.
      */
@@ -87,6 +63,30 @@ export interface SLO {
     metricDenominator?: string;
     evaluationType?: SLOEvaluationType;
     errorBudgetBurnRate?: SloBurnRate;
+    /**
+     * The error budget burn rate key for a metric expression.
+     */
+    burnRateMetricKey?: string;
+    /**
+     * The error budget key for a metric expression.
+     */
+    errorBudgetMetricKey?: string;
+    /**
+     * The numerator value used to evaluate the SLO when **useRateMetric** is set to `false`.
+     */
+    numeratorValue?: number;
+    /**
+     * The error budget of the calculated SLO.
+     *
+     * The error budget is the difference between the calculated and target values. A positive number means all is good; a negative number means trouble.
+     */
+    errorBudget?: number;
+    /**
+     * Total number of problems related to the SLO.
+     *
+     * Has the value of `-1` if there's an error with fetching SLO related problems.
+     */
+    relatedTotalProblems?: number;
     /**
      * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
      */
@@ -95,10 +95,6 @@ export interface SLO {
      * The key for a metric expression. Once created, metric keys can't be changed
      */
     metricKey?: string;
-    /**
-     * The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
-     */
-    filter?: string;
     /**
      * The name of the SLO.
      */
@@ -111,6 +107,10 @@ export interface SLO {
      * The target value of the SLO.
      */
     target?: number;
+    /**
+     * The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
+     */
+    filter?: string;
     /**
      * A short description of the SLO.
      */
@@ -136,16 +136,11 @@ export interface SLO {
 /** @ignore */
 export declare namespace _SLOTransformation {
     interface AsJson {
-        problemFilters?: string[];
-        burnRateMetricKey?: string;
-        errorBudgetMetricKey?: string;
         normalizedErrorBudgetMetricKey?: string;
-        numeratorValue?: number;
         denominatorValue?: number;
         relatedOpenProblems?: number;
-        relatedTotalProblems?: number;
         evaluatedPercentage?: number;
-        errorBudget?: number;
+        problemFilters?: string[];
         metricExpression?: string;
         useRateMetric?: boolean;
         metricRate?: string;
@@ -153,12 +148,17 @@ export declare namespace _SLOTransformation {
         metricDenominator?: string;
         evaluationType?: _SLOEvaluationTypeTransformation.AsJson;
         errorBudgetBurnRate?: _SloBurnRateTransformation.AsJson;
+        burnRateMetricKey?: string;
+        errorBudgetMetricKey?: string;
+        numeratorValue?: number;
+        errorBudget?: number;
+        relatedTotalProblems?: number;
         timeframe?: string;
         metricKey?: string;
-        filter?: string;
         name?: string;
         id?: string;
         target?: number;
+        filter?: string;
         description?: string;
         enabled?: boolean;
         status?: _SLOStatusTransformation.AsJson;

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

@@ -9,7 +9,7 @@ export interface SyntheticOnDemandBatchStatus {
     /**
      * The identifier of the batch.
      */
-    batchId: number;
+    batchId: string;
     /**
      * The name of the user who triggered execution of the batch.
      */
@@ -43,7 +43,7 @@ export interface SyntheticOnDemandBatchStatus {
 /** @ignore */
 export declare namespace _SyntheticOnDemandBatchStatusTransformation {
     interface AsJson {
-        batchId: number;
+        batchId: string;
         userId: string;
         batchStatus: _SyntheticOnDemandBatchStatusBatchStatusTransformation.AsJson;
         triggeredCount: number;

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

@@ -8,9 +8,13 @@ import { SyntheticOnDemandExecutionRequestProcessingMode, _SyntheticOnDemandExec
 export interface SyntheticOnDemandExecutionRequest {
     processingMode?: SyntheticOnDemandExecutionRequestProcessingMode;
     /**
-     * If true, the status will be FAILED in case of performance issue.
+     * If true, the execution will fail in case of performance issue.
      */
     failOnPerformanceIssue?: boolean;
+    /**
+     * Applies to HTTP monitors only. If true, the execution will fail in case of an SSL certificate expiration warning or if the certificate is missing.
+     */
+    failOnSslWarning?: boolean;
     /**
      * If true, no executions will be scheduled if a problem occurs.
      */
@@ -31,6 +35,7 @@ export declare namespace _SyntheticOnDemandExecutionRequestTransformation {
     interface AsJson {
         processingMode?: _SyntheticOnDemandExecutionRequestProcessingModeTransformation.AsJson;
         failOnPerformanceIssue?: boolean;
+        failOnSslWarning?: boolean;
         stopOnProblem?: boolean;
         takeScreenshotsOnSuccess?: boolean;
         monitors?: _SyntheticOnDemandExecutionRequestMonitorTransformation.AsJson[];

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

@@ -5,14 +5,14 @@ import { Evidence, _EvidenceTransformation } from './evidence';
  * A behavior of a metric in an transaction that indicates the problem and/or is its root cause.
  */
 export interface TransactionalEvidence extends Evidence {
-    /**
-     * The metric's value after the problem start.
-     */
-    valueAfterChangePoint?: number;
     /**
      * The metric's value before the problem start.
      */
     valueBeforeChangePoint?: number;
+    /**
+     * The metric's value after the problem start.
+     */
+    valueAfterChangePoint?: number;
     /**
      * The end time of the evidence, in UTC milliseconds
      */
@@ -25,8 +25,8 @@ export interface TransactionalEvidence extends Evidence {
 /** @ignore */
 export declare namespace _TransactionalEvidenceTransformation {
     interface AsJson extends _EvidenceTransformation.AsJson {
-        valueAfterChangePoint?: number;
         valueBeforeChangePoint?: number;
+        valueAfterChangePoint?: number;
         endTime?: number;
         unit?: string;
     }

package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization-insert.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The position where the button should be shown in the UI
+ * This is just an alias for a type any.
+ * @typedef {any} UiButtonCustomizationInsert
+ */
+export declare type UiButtonCustomizationInsert = any;
+/** @ignore */
+export declare namespace _UiButtonCustomizationInsertTransformation {
+    type AsJson = any;
+    function fromJson(model: AsJson): UiButtonCustomizationInsert;
+    function toJson(model: UiButtonCustomizationInsert): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/ui-button-customization.d.ts

@@ -1,19 +1,17 @@
+import { UiButtonCustomizationInsert, _UiButtonCustomizationInsertTransformation } from './ui-button-customization-insert';
 /**
  * UI customization for defining a button that calls a function when pressed
  */
 export interface UiButtonCustomization {
+    insert: UiButtonCustomizationInsert;
     /**
-     * The path of a property where the button should be shown in the UI
+     * The identifier of the function to be called when the button is pressed
      */
-    insertAfter: string;
+    identifier: string;
     /**
      * The label of the button
      */
     displayName: string;
-    /**
-     * The identifier of the function to be called when the button is pressed
-     */
-    identifier: string;
     /**
      * The description to be shown in a tooltip when hovering over the button
      */
@@ -22,9 +20,9 @@ export interface UiButtonCustomization {
 /** @ignore */
 export declare namespace _UiButtonCustomizationTransformation {
     interface AsJson {
-        insertAfter: string;
-        displayName: string;
+        insert: _UiButtonCustomizationInsertTransformation.AsJson;
         identifier: string;
+        displayName: string;
         description?: string;
     }
     function fromJson(model: AsJson): UiButtonCustomization;

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

@@ -7,17 +7,17 @@ import { UiTabsCustomization, _UiTabsCustomizationTransformation } from './ui-ta
  * Customization for UI elements
  */
 export interface UiCustomization {
+    callback?: UiCallbackCustomization;
     tabs?: UiTabsCustomization;
     expandable?: UiExpandableCustomization;
-    callback?: UiCallbackCustomization;
     table?: UiTableCustomization;
 }
 /** @ignore */
 export declare namespace _UiCustomizationTransformation {
     interface AsJson {
+        callback?: _UiCallbackCustomizationTransformation.AsJson;
         tabs?: _UiTabsCustomizationTransformation.AsJson;
         expandable?: _UiExpandableCustomizationTransformation.AsJson;
-        callback?: _UiCallbackCustomizationTransformation.AsJson;
         table?: _UiTableCustomizationTransformation.AsJson;
     }
     function fromJson(model: AsJson): UiCustomization;

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

@@ -7,9 +7,9 @@ import { UpdateJobUpdateType, _UpdateJobUpdateTypeTransformation } from './updat
  */
 export interface UpdateJob {
     /**
-     * A list of environments (specified by IDs) the ActiveGate can connect to.
+     * The job can (`true`) or can't (`false`) be cancelled at the moment.
      */
-    environments?: string[];
+    cancelable?: boolean;
     /**
      * The ID of the update job.
      */
@@ -23,9 +23,9 @@ export interface UpdateJob {
      */
     startVersion?: string;
     /**
-     * The duration of the update, in milliseconds.
+     * A list of environments (specified by IDs) the ActiveGate can connect to.
      */
-    duration?: number;
+    environments?: string[];
     /**
      * The timestamp of the update job completion.
      *
@@ -33,37 +33,37 @@ export interface UpdateJob {
      */
     timestamp?: number;
     /**
-     * The target version of the update.
-     *
-     * Specify the version in the `<major>.<minor>.<revision>.<timestamp>` format.
-     *
-     * To update to the latest available version, use the `latest` value.
+     * The duration of the update, in milliseconds.
      */
-    targetVersion: string;
+    duration?: number;
     /**
      * The information about update error.
      */
     error?: string;
     /**
-     * The job can (`true`) or can't (`false`) be cancelled at the moment.
+     * The target version of the update.
+     *
+     * Specify the version in the `<major>.<minor>.<revision>.<timestamp>` format.
+     *
+     * To update to the latest available version, use the `latest` value.
      */
-    cancelable?: boolean;
+    targetVersion: string;
 }
 /** @ignore */
 export declare namespace _UpdateJobTransformation {
     interface AsJson {
-        environments?: string[];
+        cancelable?: boolean;
         jobId?: string;
         jobState?: _UpdateJobJobStateTransformation.AsJson;
         updateMethod?: _UpdateJobUpdateMethodTransformation.AsJson;
         updateType?: _UpdateJobUpdateTypeTransformation.AsJson;
         agType?: _UpdateJobAgTypeTransformation.AsJson;
         startVersion?: string;
-        duration?: number;
+        environments?: string[];
         timestamp?: number;
-        targetVersion: string;
+        duration?: number;
         error?: string;
-        cancelable?: boolean;
+        targetVersion: string;
     }
     function fromJson(model: AsJson): UpdateJob;
     function toJson(model: UpdateJob): AsJson;

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

@@ -10,6 +10,10 @@ export interface VulnerableComponent {
      * The display name of the vulnerable component.
      */
     displayName?: string;
+    /**
+     * The short, component-only name of the vulnerable component.
+     */
+    shortName?: string;
     /**
      * The file name of the vulnerable component.
      */
@@ -28,6 +32,7 @@ export declare namespace _VulnerableComponentTransformation {
     interface AsJson {
         id?: string;
         displayName?: string;
+        shortName?: string;
         fileName?: string;
         numberOfAffectedEntities?: number;
         affectedEntities?: string[];

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment-type.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The type of the input segment.
+ */
+export declare enum VulnerableFunctionInputSegmentType {
+    MaliciousInput = "MALICIOUS_INPUT",
+    RegularInput = "REGULAR_INPUT",
+    TaintedInput = "TAINTED_INPUT"
+}
+/** @ignore */
+export declare namespace _VulnerableFunctionInputSegmentTypeTransformation {
+    type AsJson = VulnerableFunctionInputSegmentType;
+    const toJson: (value: VulnerableFunctionInputSegmentType) => AsJson;
+    const fromJson: (value: AsJson) => VulnerableFunctionInputSegmentType;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment.d.ts

@@ -0,0 +1,20 @@
+import { VulnerableFunctionInputSegmentType, _VulnerableFunctionInputSegmentTypeTransformation } from './vulnerable-function-input-segment-type';
+/**
+ * Describes one segment that was passed into a vulnerable function.
+ */
+export interface VulnerableFunctionInputSegment {
+    /**
+     * The value of the input segment.
+     */
+    value?: string;
+    type?: VulnerableFunctionInputSegmentType;
+}
+/** @ignore */
+export declare namespace _VulnerableFunctionInputSegmentTransformation {
+    interface AsJson {
+        value?: string;
+        type?: _VulnerableFunctionInputSegmentTypeTransformation.AsJson;
+    }
+    function fromJson(model: AsJson): VulnerableFunctionInputSegment;
+    function toJson(model: VulnerableFunctionInputSegment): AsJson;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The type of the input.
+ */
+export declare enum VulnerableFunctionInputType {
+    Command = "COMMAND",
+    Jndi = "JNDI",
+    SqlStatement = "SQL_STATEMENT"
+}
+/** @ignore */
+export declare namespace _VulnerableFunctionInputTypeTransformation {
+    type AsJson = VulnerableFunctionInputType;
+    const toJson: (value: VulnerableFunctionInputType) => AsJson;
+    const fromJson: (value: AsJson) => VulnerableFunctionInputType;
+}

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

@@ -0,0 +1,21 @@
+import { VulnerableFunctionInputSegment, _VulnerableFunctionInputSegmentTransformation } from './vulnerable-function-input-segment';
+import { VulnerableFunctionInputType, _VulnerableFunctionInputTypeTransformation } from './vulnerable-function-input-type';
+/**
+ * Describes what got passed into the code level vulnerability.
+ */
+export interface VulnerableFunctionInput {
+    type?: VulnerableFunctionInputType;
+    /**
+     * A list of input segments.
+     */
+    inputSegments?: VulnerableFunctionInputSegment[];
+}
+/** @ignore */
+export declare namespace _VulnerableFunctionInputTransformation {
+    interface AsJson {
+        type?: _VulnerableFunctionInputTypeTransformation.AsJson;
+        inputSegments?: _VulnerableFunctionInputSegmentTransformation.AsJson[];
+    }
+    function fromJson(model: AsJson): VulnerableFunctionInput;
+    function toJson(model: VulnerableFunctionInput): AsJson;
+}

package/types/packages/platform/error-handlers/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/add-global-error-serializer';
+export * from './lib/types';

package/types/packages/platform/error-handlers/src/lib/add-global-error-serializer.d.ts

@@ -0,0 +1,14 @@
+import { GlobalErrorSerializer } from './types/global-error-serializer';
+/**
+ * Registers a global error serializer for handling uncatched errors.
+ *
+ * @param {GlobalErrorSerializer} serializer Asynchronous function which serializes error if it match the condition
+ */
+export declare function addGlobalErrorSerializer(serializer: GlobalErrorSerializer): void;
+/**
+ * Checks if global error serializer is supported.
+ *
+ * @return {boolean} information if global error serializer is supported on current environment.
+ */
+export declare function isGlobalErrorSerializerSupported(): boolean;
+export declare function getAddGlobalErrorSerializer(): ((serializer: GlobalErrorSerializer) => void) | undefined;

package/types/packages/platform/error-handlers/src/lib/types/common-serialized-error.d.ts

@@ -0,0 +1,10 @@
+import { ErrorType } from './error-type';
+/**
+ * Common serialized JS Error
+ */
+export interface CommonSerializedError {
+    name: string;
+    message: string;
+    stack?: string;
+    type: ErrorType.COMMON;
+}

package/types/packages/platform/error-handlers/src/lib/types/dt-runtime-error-handlers.d.ts

@@ -0,0 +1,5 @@
+import { GlobalErrorSerializer } from './global-error-serializer';
+/** @ignore */
+export interface DtRuntimeErrorHandlers {
+    addGlobalErrorSerializer(serializer: GlobalErrorSerializer): void;
+}

package/types/packages/platform/error-handlers/src/lib/types/error-type.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Possible serialized error types
+ * `COMMON`: Common JS error
+ * `HTTP`: Error thrown by a http-client
+ */
+export declare enum ErrorType {
+    COMMON = "JS Error",
+    HTTP = "Http Error"
+}

package/types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts

@@ -0,0 +1,7 @@
+import { DtRuntimeErrorHandlers } from './dt-runtime-error-handlers';
+/** @ignore */
+export declare type GlobalDtRuntimeWithErrorHandlers = typeof globalThis & {
+    dtRuntime?: {
+        errorHandlers?: DtRuntimeErrorHandlers;
+    };
+};

package/types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts

@@ -0,0 +1,10 @@
+import { SerializedError } from './serialized-error';
+/**
+ * Custom error serializing function.
+ * Should check the received error and, when the error matches, return a serialized error with the specified error type.
+ * Otherwise, nothing should be returned so that the error can be handled further.
+ *
+ * @param {any} error Error to be serialized
+ * @returns {TypedError | undefined} Serialized error or nothing
+ */
+export declare type GlobalErrorSerializer = (error: any) => Promise<SerializedError | undefined>;

package/types/packages/platform/error-handlers/src/lib/types/http-serialized-error.d.ts

@@ -0,0 +1,11 @@
+import { ErrorType } from './error-type';
+/**
+ * Serialized http exception with response status
+ */
+export interface HttpSerializedError {
+    name: string;
+    message: string;
+    stack?: string;
+    type: ErrorType.HTTP;
+    status: number;
+}

package/types/packages/platform/error-handlers/src/lib/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from './common-serialized-error';
+export * from './error-type';
+export * from './global-error-serializer';
+export * from './http-serialized-error';
+export * from './serialized-error';

package/types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts

@@ -0,0 +1,8 @@
+import { CommonSerializedError } from './common-serialized-error';
+import { HttpSerializedError } from './http-serialized-error';
+/**
+ * Serialized error object contains error type
+ *
+ * @property {ErrorType} type error type
+ */
+export declare type SerializedError = HttpSerializedError | CommonSerializedError;

package/types/packages/platform/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './utils/get-global-with-dt-runtime';

package/types/packages/platform/shared/utils/get-global-with-dt-runtime.d.ts

@@ -0,0 +1 @@
+export declare const getGlobalWithDtRuntime: <T extends typeof globalThis>() => T;