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

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-technology.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The technology of the security problem.
+ */
+export declare enum SecurityProblemTechnology {
+    Dotnet = "DOTNET",
+    Go = "GO",
+    Java = "JAVA",
+    Kubernetes = "KUBERNETES",
+    NodeJs = "NODE_JS",
+    Php = "PHP"
+}
+/** @ignore */
+export declare namespace _SecurityProblemTechnologyTransformation {
+    type AsJson = SecurityProblemTechnology;
+    const toJson: (value: SecurityProblemTechnology) => AsJson;
+    const fromJson: (value: AsJson) => SecurityProblemTechnology;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute-reason.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The reason for un-muting a security problem.
+ */
+export declare enum SecurityProblemUnmuteReason {
+    Affected = "AFFECTED"
+}
+/** @ignore */
+export declare namespace _SecurityProblemUnmuteReasonTransformation {
+    type AsJson = SecurityProblemUnmuteReason;
+    const toJson: (value: SecurityProblemUnmuteReason) => AsJson;
+    const fromJson: (value: AsJson) => SecurityProblemUnmuteReason;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-unmute.d.ts

@@ -0,0 +1,20 @@
+import { SecurityProblemUnmuteReason, _SecurityProblemUnmuteReasonTransformation } from './security-problem-unmute-reason';
+/**
+ * Information on un-muting a security problem.
+ */
+export interface SecurityProblemUnmute {
+    reason: SecurityProblemUnmuteReason;
+    /**
+     * A comment about the un-muting reason.
+     */
+    comment: string;
+}
+/** @ignore */
+export declare namespace _SecurityProblemUnmuteTransformation {
+    interface AsJson {
+        reason: _SecurityProblemUnmuteReasonTransformation.AsJson;
+        comment: string;
+    }
+    function fromJson(model: AsJson): SecurityProblemUnmute;
+    function toJson(model: SecurityProblemUnmute): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/security-problem-vulnerability-type.d.ts

@@ -0,0 +1,14 @@
+/**
+ * The type of the vulnerability.
+ */
+export declare enum SecurityProblemVulnerabilityType {
+    CodeLevel = "CODE_LEVEL",
+    Runtime = "RUNTIME",
+    ThirdParty = "THIRD_PARTY"
+}
+/** @ignore */
+export declare namespace _SecurityProblemVulnerabilityTypeTransformation {
+    type AsJson = SecurityProblemVulnerabilityType;
+    const toJson: (value: SecurityProblemVulnerabilityType) => AsJson;
+    const fromJson: (value: AsJson) => SecurityProblemVulnerabilityType;
+}

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

@@ -0,0 +1,83 @@
+import { CodeLevelVulnerabilityDetails, _CodeLevelVulnerabilityDetailsTransformation } from './code-level-vulnerability-details';
+import { ManagementZone, _ManagementZoneTransformation } from './management-zone';
+import { RiskAssessment, _RiskAssessmentTransformation } from './risk-assessment';
+import { SecurityProblemStatus, _SecurityProblemStatusTransformation } from './security-problem-status';
+import { SecurityProblemTechnology, _SecurityProblemTechnologyTransformation } from './security-problem-technology';
+import { SecurityProblemVulnerabilityType, _SecurityProblemVulnerabilityTypeTransformation } from './security-problem-vulnerability-type';
+/**
+ * Parameters of a security problem
+ */
+export interface SecurityProblem {
+    /**
+     * The ID of the security problem.
+     */
+    securityProblemId?: string;
+    /**
+     * The display ID of the security problem.
+     */
+    displayId?: string;
+    status?: SecurityProblemStatus;
+    /**
+     * The security problem is (`true`) or is not (`false`) muted.
+     */
+    muted?: boolean;
+    /**
+     * The external vulnerability ID of the security problem.
+     */
+    externalVulnerabilityId?: string;
+    vulnerabilityType?: SecurityProblemVulnerabilityType;
+    /**
+     * The title of the security problem.
+     */
+    title?: string;
+    /**
+     * The package name of the security problem.
+     */
+    packageName?: string;
+    /**
+     * The URL to the security problem details page.
+     */
+    url?: string;
+    technology?: SecurityProblemTechnology;
+    /**
+     * The timestamp of the first occurrence of the security problem.
+     */
+    firstSeenTimestamp?: number;
+    /**
+     * The timestamp of the most recent security problem change.
+     */
+    lastUpdatedTimestamp?: number;
+    riskAssessment?: RiskAssessment;
+    /**
+     * A list of management zones which the affected entities belong to.
+     */
+    managementZones?: ManagementZone[];
+    /**
+     * A list of CVE IDs of the security problem.
+     */
+    cveIds?: string[];
+    codeLevelVulnerabilityDetails?: CodeLevelVulnerabilityDetails;
+}
+/** @ignore */
+export declare namespace _SecurityProblemTransformation {
+    interface AsJson {
+        securityProblemId?: string;
+        displayId?: string;
+        status?: _SecurityProblemStatusTransformation.AsJson;
+        muted?: boolean;
+        externalVulnerabilityId?: string;
+        vulnerabilityType?: _SecurityProblemVulnerabilityTypeTransformation.AsJson;
+        title?: string;
+        packageName?: string;
+        url?: string;
+        technology?: _SecurityProblemTechnologyTransformation.AsJson;
+        firstSeenTimestamp?: number;
+        lastUpdatedTimestamp?: number;
+        riskAssessment?: _RiskAssessmentTransformation.AsJson;
+        managementZones?: _ManagementZoneTransformation.AsJson[];
+        cveIds?: string[];
+        codeLevelVulnerabilityDetails?: _CodeLevelVulnerabilityDetailsTransformation.AsJson;
+    }
+    function fromJson(model: AsJson): SecurityProblem;
+    function toJson(model: SecurityProblem): AsJson;
+}

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

@@ -0,0 +1,18 @@
+import { Impact, _ImpactTransformation } from './impact';
+/**
+ * Analysis of problem impact to a service.
+ */
+export interface ServiceImpact extends Impact {
+    /**
+     * The number of potentially impacted services.
+     */
+    numberOfPotentiallyAffectedServiceCalls?: number;
+}
+/** @ignore */
+export declare namespace _ServiceImpactTransformation {
+    interface AsJson extends _ImpactTransformation.AsJson {
+        numberOfPotentiallyAffectedServiceCalls?: number;
+    }
+    function fromJson(model: AsJson): ServiceImpact;
+    function toJson(model: ServiceImpact): AsJson;
+}

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

@@ -0,0 +1,48 @@
+import { SettingsValue, _SettingsValueTransformation } from './settings-value';
+/**
+ * Configuration of a new settings object.
+ */
+export interface SettingsObjectCreate {
+    /**
+     * The position of the new object. The new object will be added after the specified one.
+     *
+     * If `null`, the new object will be placed in the last position.
+     *
+     * If set to empty string, the new object will be placed in the first position.
+     *
+     * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
+     */
+    insertAfter?: string;
+    /**
+     * The version of the schema on which the object is based.
+     */
+    schemaVersion?: string;
+    /**
+     * External identifier for the object being created
+     */
+    externalId?: string;
+    /**
+     * The schema on which the object is based.
+     */
+    schemaId: string;
+    /**
+     * The scope that the object targets.
+     *
+     * If omitted on creation of a new object and if the schema supports scope generation, the operation will generate a scope from the provided value.
+     */
+    scope?: string;
+    value: SettingsValue;
+}
+/** @ignore */
+export declare namespace _SettingsObjectCreateTransformation {
+    interface AsJson {
+        insertAfter?: string;
+        schemaVersion?: string;
+        externalId?: string;
+        schemaId: string;
+        scope?: string;
+        value: _SettingsValueTransformation.AsJson;
+    }
+    function fromJson(model: AsJson): SettingsObjectCreate;
+    function toJson(model: SettingsObjectCreate): AsJson;
+}

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

@@ -0,0 +1,28 @@
+import { Error, _ErrorTransformation } from './error';
+import { SettingsValue, _SettingsValueTransformation } from './settings-value';
+/**
+ * The response to a creation- or update-request.
+ */
+export interface SettingsObjectResponse {
+    invalidValue?: SettingsValue;
+    /**
+     * The HTTP status code for the object.
+     */
+    code: number;
+    error?: Error;
+    /**
+     * For a successful request, the ID of the created or modified settings object.
+     */
+    objectId?: string;
+}
+/** @ignore */
+export declare namespace _SettingsObjectResponseTransformation {
+    interface AsJson {
+        invalidValue?: _SettingsValueTransformation.AsJson;
+        code: number;
+        error?: _ErrorTransformation.AsJson;
+        objectId?: string;
+    }
+    function fromJson(model: AsJson): SettingsObjectResponse;
+    function toJson(model: SettingsObjectResponse): AsJson;
+}

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

@@ -0,0 +1,55 @@
+import { SettingsValue, _SettingsValueTransformation } from './settings-value';
+/**
+ * An update of a settings object.
+ */
+export interface SettingsObjectUpdate {
+    /**
+     * The position of the updated object. The new object will be moved behind the specified one.
+     *
+     * **insertAfter** and **insertBefore** are evaluated together and only one of both can be set.
+     *
+     * If `null` and **insertBefore** 'null', the existing object keeps the current position.
+     *
+     * If set to empty string, the updated object will be placed in the first position.
+     *
+     * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
+     */
+    insertAfter?: string;
+    /**
+     * The position of the updated object. The new object will be moved in front of the specified one.
+     *
+     * **insertAfter** and **insertBefore** are evaluated together and only one of both can be set.
+     *
+     * If `null` and **insertAfter** 'null', the existing object keeps the current position.
+     *
+     * If set to empty string, the updated object will be placed in the last position.
+     *
+     * Only applicable for objects based on schemas with ordered objects (schema's **ordered** parameter is set to `true`).
+     */
+    insertBefore?: string;
+    /**
+     * The version of the schema on which the object is based.
+     */
+    schemaVersion?: string;
+    /**
+     * The update token of the object. You can use it to detect simultaneous modifications by different users.
+     *
+     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
+     *
+     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
+     */
+    updateToken?: string;
+    value: SettingsValue;
+}
+/** @ignore */
+export declare namespace _SettingsObjectUpdateTransformation {
+    interface AsJson {
+        insertAfter?: string;
+        insertBefore?: string;
+        schemaVersion?: string;
+        updateToken?: string;
+        value: _SettingsValueTransformation.AsJson;
+    }
+    function fromJson(model: AsJson): SettingsObjectUpdate;
+    function toJson(model: SettingsObjectUpdate): AsJson;
+}

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

@@ -0,0 +1,69 @@
+import { SettingsValue, _SettingsValueTransformation } from './settings-value';
+/**
+ * A settings object.
+ */
+export interface SettingsObject {
+    /**
+     * The version of the schema on which the object is based.
+     */
+    schemaVersion?: string;
+    /**
+     * The update token of the object. You can use it to detect simultaneous modifications by different users.
+     *
+     * It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
+     *
+     * If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
+     */
+    updateToken?: string;
+    /**
+     * The timestamp of the last modification.
+     */
+    modified?: number;
+    /**
+     * The external identifier of the settings object.
+     */
+    externalId?: string;
+    /**
+     * The user (identified by a user ID or a public token ID) who performed that most recent modification.
+     */
+    author?: string;
+    /**
+     * The schema on which the object is based.
+     */
+    schemaId?: string;
+    /**
+     * The timestamp of the creation.
+     */
+    created?: number;
+    /**
+     * The scope that the object targets.
+     */
+    scope?: string;
+    value?: SettingsValue;
+    /**
+     * A short summary of settings.
+     */
+    summary?: string;
+    /**
+     * The ID of the settings object.
+     */
+    objectId?: string;
+}
+/** @ignore */
+export declare namespace _SettingsObjectTransformation {
+    interface AsJson {
+        schemaVersion?: string;
+        updateToken?: string;
+        modified?: number;
+        externalId?: string;
+        author?: string;
+        schemaId?: string;
+        created?: number;
+        scope?: string;
+        value?: _SettingsValueTransformation.AsJson;
+        summary?: string;
+        objectId?: string;
+    }
+    function fromJson(model: AsJson): SettingsObject;
+    function toJson(model: SettingsObject): AsJson;
+}

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

@@ -0,0 +1,16 @@
+/**
+   * The value of the setting.
+
+ It defines the actual values of settings' parameters.
+
+The actual content depends on the object's schema.
+   * This is just an alias for a type any.
+   * @typedef {any} SettingsValue
+   */
+export declare type SettingsValue = any;
+/** @ignore */
+export declare namespace _SettingsValueTransformation {
+    type AsJson = any;
+    function fromJson(model: AsJson): SettingsValue;
+    function toJson(model: SettingsValue): AsJson;
+}

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

@@ -0,0 +1,35 @@
+import { SLO, _SLOTransformation } from './slo';
+/**
+ * Contains SLOs and paging information.
+ */
+export interface SLOs {
+    /**
+     * The list of SLOs.
+     */
+    slo?: SLO[];
+    /**
+     * The number of entries per page.
+     */
+    pageSize?: number;
+    /**
+     * The cursor for the next page of results. Has the value of `null` on the last page.
+     *
+     * Use it in the **nextPageKey** query parameter to obtain subsequent pages of the result.
+     */
+    nextPageKey?: string;
+    /**
+     * The total number of entries in the result.
+     */
+    totalCount: number;
+}
+/** @ignore */
+export declare namespace _SLOsTransformation {
+    interface AsJson {
+        slo?: _SLOTransformation.AsJson[];
+        pageSize?: number;
+        nextPageKey?: string;
+        totalCount: number;
+    }
+    function fromJson(model: AsJson): SLOs;
+    function toJson(model: SLOs): AsJson;
+}

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

@@ -0,0 +1,16 @@
+/**
+ * The calculated burn rate type.
+ *
+ * Has a value of 'FAST', 'SLOW' or 'NONE'.
+ */
+export declare enum SloBurnRateBurnRateType {
+    Fast = "FAST",
+    None = "NONE",
+    Slow = "SLOW"
+}
+/** @ignore */
+export declare namespace _SloBurnRateBurnRateTypeTransformation {
+    type AsJson = SloBurnRateBurnRateType;
+    const toJson: (value: SloBurnRateBurnRateType) => AsJson;
+    const fromJson: (value: AsJson) => SloBurnRateBurnRateType;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Error budget burn rate configuration of a service-level objective (SLO).
+ */
+export interface SloBurnRateConfig {
+    /**
+     * The error budget burn rate visualization is enabled (`true`) or disabled (`false`).
+     *
+     * In case of `false`, no calculated values will be present here.
+     */
+    burnRateVisualizationEnabled?: boolean;
+    /**
+     * The threshold between a slow and a fast burn rate.
+     */
+    fastBurnThreshold?: number;
+}
+/** @ignore */
+export declare namespace _SloBurnRateConfigTransformation {
+    interface AsJson {
+        burnRateVisualizationEnabled?: boolean;
+        fastBurnThreshold?: number;
+    }
+    function fromJson(model: AsJson): SloBurnRateConfig;
+    function toJson(model: SloBurnRateConfig): AsJson;
+}

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

@@ -0,0 +1,42 @@
+import { SloBurnRateBurnRateType, _SloBurnRateBurnRateTypeTransformation } from './slo-burn-rate-burn-rate-type';
+/**
+ * Error budget burn rate evaluation of a service-level objective (SLO).
+ */
+export interface SloBurnRate {
+    /**
+     * The calculated value of the SLO for the timeframe chosen for the burn rate calculation.
+     */
+    sloValue?: number;
+    /**
+     * The estimated time left to consume the error budget in hours.
+     */
+    estimatedTimeToConsumeErrorBudget?: number;
+    /**
+     * The error budget burn rate visualization is enabled (`true`) or disabled (`false`).
+     *
+     * In case of `false`, no calculated values will be present here.
+     */
+    burnRateVisualizationEnabled?: boolean;
+    /**
+     * The threshold between a slow and a fast burn rate.
+     */
+    fastBurnThreshold?: number;
+    burnRateType?: SloBurnRateBurnRateType;
+    /**
+     * The burn rate of the SLO, calculated for the last hour.
+     */
+    burnRateValue?: number;
+}
+/** @ignore */
+export declare namespace _SloBurnRateTransformation {
+    interface AsJson {
+        sloValue?: number;
+        estimatedTimeToConsumeErrorBudget?: number;
+        burnRateVisualizationEnabled?: boolean;
+        fastBurnThreshold?: number;
+        burnRateType?: _SloBurnRateBurnRateTypeTransformation.AsJson;
+        burnRateValue?: number;
+    }
+    function fromJson(model: AsJson): SloBurnRate;
+    function toJson(model: SloBurnRate): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/slo-config-item-dto-impl-evaluation-type.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The evaluation type of the SLO.
+ */
+export declare enum SloConfigItemDtoImplEvaluationType {
+    Aggregate = "AGGREGATE"
+}
+/** @ignore */
+export declare namespace _SloConfigItemDtoImplEvaluationTypeTransformation {
+    type AsJson = SloConfigItemDtoImplEvaluationType;
+    const toJson: (value: SloConfigItemDtoImplEvaluationType) => AsJson;
+    const fromJson: (value: AsJson) => SloConfigItemDtoImplEvaluationType;
+}

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

@@ -0,0 +1,93 @@
+import { SloBurnRateConfig, _SloBurnRateConfigTransformation } from './slo-burn-rate-config';
+import { SloConfigItemDtoImplEvaluationType, _SloConfigItemDtoImplEvaluationTypeTransformation } from './slo-config-item-dto-impl-evaluation-type';
+export interface SloConfigItemDtoImpl {
+    /**
+     * The SLO is enabled (`true`) or disabled (`false`).
+     */
+    enabled?: boolean;
+    /**
+     * The name of the SLO.
+     */
+    name?: string;
+    /**
+     * The description of the SLO (optional).
+     */
+    description?: string;
+    /**
+     * The name for a metric expression
+     */
+    metricName?: string;
+    /**
+     * The percentage-based metric expression for the calculation of the SLO.
+     */
+    metricExpression?: string;
+    evaluationType?: SloConfigItemDtoImplEvaluationType;
+    /**
+     * The entity filter for the SLO evaluation. Use the [syntax of entity selector](https://dt-url.net/entityselector).
+     */
+    filter?: string;
+    /**
+     * The target value of the SLO.
+     */
+    target?: number;
+    /**
+     * The warning value of the SLO.
+     *
+     *  At warning state the SLO is still fulfilled but is getting close to failure.
+     */
+    warning?: number;
+    errorBudgetBurnRate?: SloBurnRateConfig;
+    /**
+     * The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
+     */
+    timeframe?: string;
+    /**
+     * The type of the metric to use for SLO calculation:
+     *
+     * * `true`: An existing percentage-based metric.
+     * * `false`: A ratio of two metrics.
+     *
+     * For a list of available metrics, see [Built-in metric page](https://dt-url.net/be03kow) or try the [GET metrics](https://dt-url.net/8e43kxf) API call.
+     */
+    useRateMetric?: boolean | null;
+    /**
+     * The percentage-based metric for the calculation of the SLO.
+     *
+     * Required when the **useRateMetric** is set to `true`.
+     */
+    metricRate?: string;
+    /**
+     * The metric for the count of successes (the numerator in rate calculation).
+     *
+     * Required when the **useRateMetric** is set to `false`.
+     */
+    metricNumerator?: string;
+    /**
+     * The total count metric (the denominator in rate calculation).
+     *
+     * Required when the **useRateMetric** is set to `false`.
+     */
+    metricDenominator?: string;
+}
+/** @ignore */
+export declare namespace _SloConfigItemDtoImplTransformation {
+    interface AsJson {
+        enabled?: boolean;
+        name?: string;
+        description?: string;
+        metricName?: string;
+        metricExpression?: string;
+        evaluationType?: _SloConfigItemDtoImplEvaluationTypeTransformation.AsJson;
+        filter?: string;
+        target?: number;
+        warning?: number;
+        errorBudgetBurnRate?: _SloBurnRateConfigTransformation.AsJson;
+        timeframe?: string;
+        useRateMetric?: boolean | null;
+        metricRate?: string;
+        metricNumerator?: string;
+        metricDenominator?: string;
+    }
+    function fromJson(model: AsJson): SloConfigItemDtoImpl;
+    function toJson(model: SloConfigItemDtoImpl): AsJson;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * The evaluation type of the SLO.
+ */
+export declare enum SLOEvaluationType {
+    Aggregate = "AGGREGATE"
+}
+/** @ignore */
+export declare namespace _SLOEvaluationTypeTransformation {
+    type AsJson = SLOEvaluationType;
+    const toJson: (value: SLOEvaluationType) => AsJson;
+    const fromJson: (value: AsJson) => SLOEvaluationType;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * The status of the calculated SLO.
+ */
+export declare enum SLOStatus {
+    Failure = "FAILURE",
+    Success = "SUCCESS",
+    Warning = "WARNING"
+}
+/** @ignore */
+export declare namespace _SLOStatusTransformation {
+    type AsJson = SLOStatus;
+    const toJson: (value: SLOStatus) => AsJson;
+    const fromJson: (value: AsJson) => SLOStatus;
+}