@dynatrace-sdk/client-classic-environment-v2 0.6.7 → 0.6.11

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

@@ -0,0 +1,27 @@
+/**
+ * A list of available categories.
+ */
+export interface Category {
+    /**
+     * Id of the category
+     */
+    id?: string;
+    /**
+     * Name of the category
+     */
+    name?: string;
+    /**
+     * Description of the category
+     */
+    description?: string;
+}
+/** @ignore */
+export declare namespace _CategoryTransformation {
+    interface AsJson {
+        id?: string;
+        name?: string;
+        description?: string;
+    }
+    function fromJson(model: AsJson): Category;
+    function toJson(model: Category): AsJson;
+}

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

@@ -2,14 +2,14 @@
  * The comment to a problem.
  */
 export interface Comment {
-    /**
-     * The user who wrote the comment.
-     */
-    authorName?: string;
     /**
      * The timestamp of comment creation, in UTC milliseconds.
      */
     createdAtTimestamp: number;
+    /**
+     * The user who wrote the comment.
+     */
+    authorName?: string;
     /**
      * The context of the comment.
      */
@@ -26,8 +26,8 @@ export interface Comment {
 /** @ignore */
 export declare namespace _CommentTransformation {
     interface AsJson {
-        authorName?: string;
         createdAtTimestamp: number;
+        authorName?: string;
         context?: string;
         id?: string;
         content?: string;

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

@@ -11,24 +11,24 @@ export interface CommentsList {
      * The total number of entries in the result.
      */
     totalCount: number;
+    /**
+     * 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 number of entries per page.
-     */
-    pageSize?: number;
 }
 /** @ignore */
 export declare namespace _CommentsListTransformation {
     interface AsJson {
         comments: _CommentTransformation.AsJson[];
         totalCount: number;
-        nextPageKey?: string;
         pageSize?: number;
+        nextPageKey?: string;
     }
     function fromJson(model: AsJson): CommentsList;
     function toJson(model: CommentsList): AsJson;

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

@@ -7,6 +7,10 @@ export interface ComplexConstraint {
      * A custom message for invalid values.
      */
     customMessage?: string;
+    /**
+     * The ID of a custom validator.
+     */
+    customValidatorId?: string;
     /**
      * The minimum number of properties that must be set.
      */
@@ -15,10 +19,6 @@ export interface ComplexConstraint {
      * The maximum number of properties that can be set.
      */
     maximumPropertyCount?: number;
-    /**
-     * The ID of a custom validator.
-     */
-    customValidatorId?: string;
     /**
      * A list of properties (defined by IDs) that are used to check the constraint.
      */
@@ -29,9 +29,9 @@ export interface ComplexConstraint {
 export declare namespace _ComplexConstraintTransformation {
     interface AsJson {
         customMessage?: string;
+        customValidatorId?: string;
         minimumPropertyCount?: number;
         maximumPropertyCount?: number;
-        customValidatorId?: string;
         properties?: string[];
         type: _ComplexConstraintTypeTransformation.AsJson;
     }

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

@@ -2,14 +2,14 @@
  * Metadata useful for debugging
  */
 export interface ConfigurationMetadata {
-    /**
-     * A sorted list of the version numbers of the configuration.
-     */
-    configurationVersions?: number[];
     /**
      * A sorted list of version numbers of the configuration.
      */
     currentConfigurationVersions?: string[];
+    /**
+     * A sorted list of the version numbers of the configuration.
+     */
+    configurationVersions?: number[];
     /**
      * Dynatrace version.
      */
@@ -18,8 +18,8 @@ export interface ConfigurationMetadata {
 /** @ignore */
 export declare namespace _ConfigurationMetadataTransformation {
     interface AsJson {
-        configurationVersions?: number[];
         currentConfigurationVersions?: string[];
+        configurationVersions?: number[];
         clusterVersion?: string;
     }
     function fromJson(model: AsJson): ConfigurationMetadata;

package/types/packages/client/classic-environment-v2/src/lib/models/constraint-violation-parameter-location.d.ts

@@ -1,4 +1,5 @@
 export declare enum ConstraintViolationParameterLocation {
+    Header = "HEADER",
     Path = "PATH",
     PayloadBody = "PAYLOAD_BODY",
     Query = "QUERY"

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

@@ -3,14 +3,6 @@ import { ConstraintType, _ConstraintTypeTransformation } from './constraint-type
  * A constraint on the values accepted for a settings property.
  */
 export interface Constraint {
-    /**
-     * The maximum allowed length of string values.
-     */
-    maxLength?: number;
-    /**
-     * The minimum required length of string values.
-     */
-    minLength?: number;
     /**
      * A list of properties for which the combination of values must be unique.
      */
@@ -23,6 +15,15 @@ export interface Constraint {
      * The ID of a custom validator.
      */
     customValidatorId?: string;
+    /**
+     * The maximum allowed length of string values.
+     */
+    maxLength?: number;
+    /**
+     * The minimum required length of string values.
+     */
+    minLength?: number;
+    type: ConstraintType;
     /**
      * The maximum allowed value.
      */
@@ -31,7 +32,6 @@ export interface Constraint {
      * The minimum allowed value.
      */
     minimum?: number;
-    type: ConstraintType;
     /**
      * The regular expression pattern for valid string values.
      */
@@ -40,14 +40,14 @@ export interface Constraint {
 /** @ignore */
 export declare namespace _ConstraintTransformation {
     interface AsJson {
-        maxLength?: number;
-        minLength?: number;
         uniqueProperties?: string[];
         customMessage?: string;
         customValidatorId?: string;
+        maxLength?: number;
+        minLength?: number;
+        type: _ConstraintTypeTransformation.AsJson;
         maximum?: number;
         minimum?: number;
-        type: _ConstraintTypeTransformation.AsJson;
         pattern?: string;
     }
     function fromJson(model: AsJson): Constraint;

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

@@ -0,0 +1,17 @@
+/**
+ * A short representation of the credentials set.
+ */
+export interface CredentialsId {
+    /**
+     * The ID of the credentials set.
+     */
+    id: string;
+}
+/** @ignore */
+export declare namespace _CredentialsIdTransformation {
+    interface AsJson {
+        id: string;
+    }
+    function fromJson(model: AsJson): CredentialsId;
+    function toJson(model: CredentialsId): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-config.d.ts

@@ -0,0 +1,20 @@
+import { ExternalVaultConfig, _ExternalVaultConfigTransformation } from './external-vault-config';
+export interface CyberArkConfig extends ExternalVaultConfig {
+    certificate?: string;
+    applicationId?: string;
+    safeName?: string;
+    folderName?: string;
+    accountName?: string;
+}
+/** @ignore */
+export declare namespace _CyberArkConfigTransformation {
+    interface AsJson extends _ExternalVaultConfigTransformation.AsJson {
+        certificate?: string;
+        applicationId?: string;
+        safeName?: string;
+        folderName?: string;
+        accountName?: string;
+    }
+    function fromJson(model: AsJson): CyberArkConfig;
+    function toJson(model: CyberArkConfig): AsJson;
+}

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

@@ -0,0 +1,38 @@
+import { ExternalVault, _ExternalVaultTransformation } from './external-vault';
+/**
+ * Synchronization credentials with CyberArk Vault using IP based access authentication method, which means adding location's IP addresses (used in monitor synchronizing credentials) to whitelist in CyberArk.
+ */
+export interface CyberArkDto extends ExternalVault {
+    /**
+     * [Optional] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV.
+     */
+    certificate?: string;
+    /**
+     * Application ID connected to CyberArk Vault.
+     */
+    applicationId?: string;
+    /**
+     * Safe name connected to CyberArk Vault.
+     */
+    safeName?: string;
+    /**
+     * [Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'.
+     */
+    folderName?: string;
+    /**
+     * Account name which stores username and password to retrieve and synchronize with Dynatrace Credential Vault. This is NOT the name of the account logged into CyberArk Central Policy Manager.
+     */
+    accountName?: string;
+}
+/** @ignore */
+export declare namespace _CyberArkDtoTransformation {
+    interface AsJson extends _ExternalVaultTransformation.AsJson {
+        certificate?: string;
+        applicationId?: string;
+        safeName?: string;
+        folderName?: string;
+        accountName?: string;
+    }
+    function fromJson(model: AsJson): CyberArkDto;
+    function toJson(model: CyberArkDto): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password-config.d.ts

@@ -0,0 +1,22 @@
+import { ExternalVaultConfig, _ExternalVaultConfigTransformation } from './external-vault-config';
+export interface CyberArkUsernamePasswordConfig extends ExternalVaultConfig {
+    usernamePasswordForCPM?: string;
+    certificate?: string;
+    applicationId?: string;
+    safeName?: string;
+    folderName?: string;
+    accountName?: string;
+}
+/** @ignore */
+export declare namespace _CyberArkUsernamePasswordConfigTransformation {
+    interface AsJson extends _ExternalVaultConfigTransformation.AsJson {
+        usernamePasswordForCPM?: string;
+        certificate?: string;
+        applicationId?: string;
+        safeName?: string;
+        folderName?: string;
+        accountName?: string;
+    }
+    function fromJson(model: AsJson): CyberArkUsernamePasswordConfig;
+    function toJson(model: CyberArkUsernamePasswordConfig): AsJson;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/cyber-ark-username-password.d.ts

@@ -0,0 +1,43 @@
+import { ExternalVault, _ExternalVaultTransformation } from './external-vault';
+/**
+ * Synchronization credentials with CyberArk Vault using username password authentication method.
+ */
+export interface CyberArkUsernamePassword extends ExternalVault {
+    /**
+     * Username password credentials for authentication to Central Policy Manager in CyberArk. ID of username password credential saved in Dynatrace CV.
+     */
+    usernamePasswordForCPM?: string;
+    /**
+     * [Optional] Certificate used for authentication to CyberArk application. ID of certificate credential saved in Dynatrace CV.
+     */
+    certificate?: string;
+    /**
+     * Application ID connected to CyberArk Vault.
+     */
+    applicationId?: string;
+    /**
+     * Safe name connected to CyberArk Vault.
+     */
+    safeName?: string;
+    /**
+     * [Optional] Folder name where credentials in CyberArk Vault are stored. Default folder name is 'Root'.
+     */
+    folderName?: string;
+    /**
+     * Account name which stores username and password to retrieve and synchronize with Dynatrace Credential Vault. This is NOT the name of the account logged into CyberArk Central Policy Manager.
+     */
+    accountName?: string;
+}
+/** @ignore */
+export declare namespace _CyberArkUsernamePasswordTransformation {
+    interface AsJson extends _ExternalVaultTransformation.AsJson {
+        usernamePasswordForCPM?: string;
+        certificate?: string;
+        applicationId?: string;
+        safeName?: string;
+        folderName?: string;
+        accountName?: string;
+    }
+    function fromJson(model: AsJson): CyberArkUsernamePassword;
+    function toJson(model: CyberArkUsernamePassword): AsJson;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * A constraint on the values that are going to be deleted.
+ */
+export interface DeletionConstraint {
+    /**
+     * A custom message for invalid values.
+     */
+    customMessage?: string;
+    /**
+     * The ID of a custom validator.
+     */
+    customValidatorId?: string;
+}
+/** @ignore */
+export declare namespace _DeletionConstraintTransformation {
+    interface AsJson {
+        customMessage?: string;
+        customValidatorId?: string;
+    }
+    function fromJson(model: AsJson): DeletionConstraint;
+    function toJson(model: DeletionConstraint): AsJson;
+}

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

@@ -0,0 +1,13 @@
+/**
+ * Type of the data, either markdown or gallery.
+ */
+export declare enum DescriptionBlockType {
+    Gallery = "GALLERY",
+    Markdown = "MARKDOWN"
+}
+/** @ignore */
+export declare namespace _DescriptionBlockTypeTransformation {
+    type AsJson = DescriptionBlockType;
+    const toJson: (value: DescriptionBlockType) => AsJson;
+    const fromJson: (value: AsJson) => DescriptionBlockType;
+}

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

@@ -0,0 +1,36 @@
+import { DescriptionBlockType, _DescriptionBlockTypeTransformation } from './description-block-type';
+import { Image, _ImageTransformation } from './image';
+/**
+ * Represents a section of data describing the given capability.
+ */
+export interface DescriptionBlock {
+    type?: DescriptionBlockType;
+    /**
+     * Title of the description block.
+     */
+    title?: string;
+    /**
+     * Source of the description block (in case of markdown).
+     */
+    source?: string | null;
+    /**
+     * Collection of images (in case of gallery).
+     */
+    images?: (Image | null)[] | null;
+    /**
+     * Optional identifier of special description blocks.
+     */
+    sourceId?: string | null;
+}
+/** @ignore */
+export declare namespace _DescriptionBlockTransformation {
+    interface AsJson {
+        type?: _DescriptionBlockTypeTransformation.AsJson;
+        title?: string;
+        source?: string | null;
+        images?: (_ImageTransformation.AsJson | null)[] | null;
+        sourceId?: string | null;
+    }
+    function fromJson(model: AsJson): DescriptionBlock;
+    function toJson(model: DescriptionBlock): AsJson;
+}

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

@@ -12,28 +12,32 @@ export interface EffectiveSettingsValue {
      */
     created?: number;
     /**
-     * The external identifier of the settings object.
+     * The timestamp of the last modification.
      */
-    externalId?: string;
+    modified?: number;
     /**
      * The user (identified by a user ID or a public token ID) who performed that most recent modification.
      */
     author?: string;
     /**
-     * The timestamp of the last modification.
+     * The external identifier of the settings object.
      */
-    modified?: number;
+    externalId?: string;
+    /**
+     * The schema on which the object is based.
+     */
+    schemaId?: string;
+    value?: SettingsValue;
     /**
      * The version of the schema on which the object is based.
      */
     schemaVersion?: string;
     /**
-     * The schema on which the object is based.
+     * A searchable summary string of the setting value. Plain text without Markdown.
      */
-    schemaId?: string;
-    value?: SettingsValue;
+    searchSummary?: string;
     /**
-     * A short summary of settings.
+     * A short summary of settings. This can contain Markdown and will be escaped accordingly.
      */
     summary?: string;
 }
@@ -42,12 +46,13 @@ export declare namespace _EffectiveSettingsValueTransformation {
     interface AsJson {
         origin?: string;
         created?: number;
-        externalId?: string;
-        author?: string;
         modified?: number;
-        schemaVersion?: string;
+        author?: string;
+        externalId?: string;
         schemaId?: string;
         value?: _SettingsValueTransformation.AsJson;
+        schemaVersion?: string;
+        searchSummary?: string;
         summary?: string;
     }
     function fromJson(model: AsJson): EffectiveSettingsValue;

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

@@ -3,14 +3,14 @@ import { EffectiveSettingsValue, _EffectiveSettingsValueTransformation } from '.
  * A list of effective settings values.
  */
 export interface EffectiveSettingsValuesList {
-    /**
-     * A list of effective settings values.
-     */
-    items: EffectiveSettingsValue[];
     /**
      * The number of entries per page.
      */
     pageSize: number;
+    /**
+     * A list of effective settings values.
+     */
+    items: EffectiveSettingsValue[];
     /**
      * The total number of entries in the result.
      */
@@ -25,8 +25,8 @@ export interface EffectiveSettingsValuesList {
 /** @ignore */
 export declare namespace _EffectiveSettingsValuesListTransformation {
     interface AsJson {
-        items: _EffectiveSettingsValueTransformation.AsJson[];
         pageSize: number;
+        items: _EffectiveSettingsValueTransformation.AsJson[];
         totalCount: number;
         nextPageKey?: string;
     }

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

@@ -2,6 +2,12 @@
  * The icon of a monitored entity.
  */
 export interface EntityIcon {
+    /**
+     * The secondary icon of the entity.
+     *
+     * Specified by the [barista](https://dt-url.net/u403suy) ID of the icon.
+     */
+    secondaryIconType?: string;
     /**
      * The user-defined icon of the entity.
      *
@@ -14,19 +20,13 @@ export interface EntityIcon {
      * Specified by the [barista](https://dt-url.net/u403suy) ID of the icon.
      */
     primaryIconType?: string;
-    /**
-     * The secondary icon of the entity.
-     *
-     * Specified by the [barista](https://dt-url.net/u403suy) ID of the icon.
-     */
-    secondaryIconType?: string;
 }
 /** @ignore */
 export declare namespace _EntityIconTransformation {
     interface AsJson {
+        secondaryIconType?: string;
         customIconPath?: string;
         primaryIconType?: string;
-        secondaryIconType?: string;
     }
     function fromJson(model: AsJson): EntityIcon;
     function toJson(model: EntityIcon): AsJson;

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

@@ -5,10 +5,6 @@ import { ToPosition, _ToPositionTransformation } from './to-position';
  * A list of properties of the monitored entity type.
  */
 export interface EntityType {
-    /**
-     * Whether the entity creation limit for the given type has been exceeded
-     */
-    entityLimitExceeded?: boolean;
     /**
      * A list of possible relationships where the monitored entity type occupies the FROM position
      */
@@ -17,6 +13,14 @@ export interface EntityType {
      * A list of possible relationships where the monitored entity type occupies the TO position.
      */
     toRelationships?: FromPosition[];
+    /**
+     * Whether the entity creation limit for the given type has been exceeded
+     */
+    entityLimitExceeded?: boolean;
+    /**
+     * The dimension key used within metrics for this monitored entity.
+     */
+    dimensionKey?: string;
     /**
      * The placeholder for the list of tags of an actual entity.
      */
@@ -25,10 +29,6 @@ export interface EntityType {
      * The placeholder for the list of management zones of an actual entity.
      */
     managementZones?: string;
-    /**
-     * The dimension key used within metrics for this monitored entity.
-     */
-    dimensionKey?: string;
     /**
      * The display name of the monitored entity.
      */
@@ -45,12 +45,12 @@ export interface EntityType {
 /** @ignore */
 export declare namespace _EntityTypeTransformation {
     interface AsJson {
-        entityLimitExceeded?: boolean;
         fromRelationships?: _ToPositionTransformation.AsJson[];
         toRelationships?: _FromPositionTransformation.AsJson[];
+        entityLimitExceeded?: boolean;
+        dimensionKey?: string;
         tags?: string;
         managementZones?: string;
-        dimensionKey?: string;
         displayName?: string;
         properties?: _EntityTypePropertyDtoTransformation.AsJson[];
         type?: string;

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

@@ -8,16 +8,20 @@ import { METag, _METagTransformation } from './me-tag';
  * The properties of a monitored entity.
  */
 export interface Entity {
+    fromRelationships?: EntityFromRelationships;
+    toRelationships?: EntityToRelationships;
+    /**
+     * The timestamp at which the entity was last seen, in UTC milliseconds.
+     */
+    lastSeenTms?: number;
     /**
      * The timestamp at which the entity was first seen, in UTC milliseconds.
      */
     firstSeenTms?: number;
     /**
-     * The timestamp at which the entity was last seen, in UTC milliseconds.
+     * The ID of the entity.
      */
-    lastSeenTms?: number;
-    fromRelationships?: EntityFromRelationships;
-    toRelationships?: EntityToRelationships;
+    entityId?: string;
     /**
      * A set of tags assigned to the entity.
      */
@@ -26,15 +30,11 @@ export interface Entity {
      * A set of management zones to which the entity belongs.
      */
     managementZones?: ManagementZone[];
-    /**
-     * The ID of the entity.
-     */
-    entityId?: string;
-    icon?: EntityIcon;
     /**
      * The name of the entity, displayed in the UI.
      */
     displayName?: string;
+    icon?: EntityIcon;
     properties?: EntityProperties;
     /**
      * The type of the entity.
@@ -44,15 +44,15 @@ export interface Entity {
 /** @ignore */
 export declare namespace _EntityTransformation {
     interface AsJson {
-        firstSeenTms?: number;
-        lastSeenTms?: number;
         fromRelationships?: _EntityFromRelationshipsTransformation.AsJson;
         toRelationships?: _EntityToRelationshipsTransformation.AsJson;
+        lastSeenTms?: number;
+        firstSeenTms?: number;
+        entityId?: string;
         tags?: _METagTransformation.AsJson[];
         managementZones?: _ManagementZoneTransformation.AsJson[];
-        entityId?: string;
-        icon?: _EntityIconTransformation.AsJson;
         displayName?: string;
+        icon?: _EntityIconTransformation.AsJson;
         properties?: _EntityPropertiesTransformation.AsJson;
         type?: string;
     }