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

package/types/packages/client/classic-environment-v2/src/lib/apis/network-zones-api.d.ts

@@ -0,0 +1,116 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { EntityShortRepresentation } from '../models/entity-short-representation';
+import { GetHostStatsQueryFilter } from '../models/get-host-stats-query-filter';
+import { NetworkZone } from '../models/network-zone';
+import { NetworkZoneConnectionStatistics } from '../models/network-zone-connection-statistics';
+import { NetworkZoneList } from '../models/network-zone-list';
+import { NetworkZoneSettings } from '../models/network-zone-settings';
+/**
+ * Manage network zones
+ */
+export declare class NetworkZonesClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a NetworkZonesClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Gets parameters of the specified network zone
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:network-zones:read
+     * @returns Success
+     */
+    getSingleNetworkZone(config: {
+        /** The ID of the required network zone. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<NetworkZone>;
+    /**
+     * Updates an existing network zone or creates a new one
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:network-zones:write
+     * <br/><br/>If the network zone with the specified ID does not exist, a new network zone is created.
+     *
+     *  The ID is not case sensitive. Dynatrace stores the ID in lowercase.
+     * @returns Success. The new network zone has been created. The response body contains the ID of the new network zone.
+     */
+    createOrUpdateNetworkZone(config: {
+        body: NetworkZone;
+        /**
+         * The ID of the network zone to be updated.
+         *
+         *  If you set the ID in the body as well, it must match this ID.
+         *
+         *  The ID is not case sensitive. Dynatrace stores the ID in lowercase.
+         */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<EntityShortRepresentation | void>;
+    /**
+     * Deletes the specified network zone
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:network-zones:write
+     * <br/><br/>You can only delete an empty network zone (a zone that no ActiveGate or OneAgent is using).
+     *
+     *  If the network zone is used as an alternative zone for any OneAgent, it will be automatically removed from the list of possible alternatives.
+     */
+    deleteNetworkZone(config: {
+        /** The ID of the network zone to be deleted. */ id: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Lists all existing network zones
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:network-zones:read
+     * @returns Success
+     */
+    getAllNetworkZones(abortSignal?: AbortSignal): Promise<NetworkZoneList>;
+    /**
+     * Gets the statistics about hosts using the network zone
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:network-zones:read
+     * @returns Success
+     */
+    getHostStats(config: {
+        /** The ID of the required network zone. */ id: string;
+        /**
+         * Filters the resulting set of hosts:
+         *
+         * * `all`: All hosts using the zone.
+         * * `configuredButNotConnectedOnly`: Hosts from the network zone that use other zones.
+         * * `connectedAsAlternativeOnly`: Hosts that use the network zone as an alternative.
+         * * `connectedAsFailoverOnly`: Hosts from other zones that use the zone (not configured as an alternative) even though ActiveGates of higher priority are available.
+         * * `connectedAsFailoverWithoutOwnActiveGatesOnly`: Hosts from other zones that use the zone (not configured as an alternative) and **no** ActiveGates of higher priority are available.
+         *
+         * If not set, `all` is used.
+         */ filter?: GetHostStatsQueryFilter;
+        abortSignal?: AbortSignal;
+    }): Promise<NetworkZoneConnectionStatistics>;
+    /**
+     * Gets the global configuration of network zones
+     *
+     * **Required scope:** environment-api:network-zones:read
+     * @returns Success
+     */
+    getNetworkZoneSettings(abortSignal?: AbortSignal): Promise<NetworkZoneSettings>;
+    /**
+     * Updates the global configuration of network zones
+     *
+     * **Required scope:** environment-api:network-zones:write
+     */
+    updateNetworkZoneSettings(config: {
+        body: NetworkZoneSettings;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+}
+export declare const networkZonesClient: NetworkZonesClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/problems-api.d.ts

@@ -0,0 +1,263 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { Comment } from '../models/comment';
+import { CommentRequestDtoImpl } from '../models/comment-request-dto-impl';
+import { CommentsList } from '../models/comments-list';
+import { Problem } from '../models/problem';
+import { ProblemCloseRequestDtoImpl } from '../models/problem-close-request-dto-impl';
+import { ProblemCloseResult } from '../models/problem-close-result';
+import { Problems } from '../models/problems';
+/**
+ * Manage problems and comments
+ */
+export declare class ProblemsClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ProblemsClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Closes the specified problem and adds a closing comment on it
+     *
+     * **Required scope:** environment-api:problems:write
+     * @returns Success
+     */
+    closeProblem(config: {
+        body: ProblemCloseRequestDtoImpl;
+        /** The ID of the required problem. */ problemId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<ProblemCloseResult | void>;
+    /**
+     * Gets all comments on the specified problem
+     *
+     * **Required scope:** environment-api:problems:read
+     * @returns Success
+     */
+    getComments(config: {
+        /** The ID of the required problem. */ problemId: string;
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters except the optional **fields** parameter.
+         */ nextPageKey?: string;
+        /**
+         * The amount of comments in a single response payload.
+         *
+         * The maximal allowed page size is 500.
+         *
+         * If not set, 10 is used.
+         */ pageSize?: number;
+        abortSignal?: AbortSignal;
+    }): Promise<CommentsList>;
+    /**
+     * Adds a new comment on the specified problem
+     *
+     * **Required scope:** environment-api:problems:write
+     */
+    createComment(config: {
+        body: CommentRequestDtoImpl;
+        /** The ID of the required problem. */ problemId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets the specified comment on a problem
+     *
+     * **Required scope:** environment-api:problems:read
+     * @returns Success
+     */
+    getComment(config: {
+        /** The ID of the required problem. */ problemId: string;
+        /** The ID of the required comment. */ commentId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<Comment>;
+    /**
+     * Updates the specified comment on a problem
+     *
+     * **Required scope:** environment-api:problems:write
+     */
+    updateComment(config: {
+        body: CommentRequestDtoImpl;
+        /** The ID of the required problem. */ problemId: string;
+        /** The ID of the required comment. */ commentId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Deletes the specified comment from a problem
+     *
+     * **Required scope:** environment-api:problems:write
+     */
+    deleteComment(config: {
+        /** The ID of the required problem. */ problemId: string;
+        /** The ID of the required comment. */ commentId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
+    /**
+     * Gets the properties of the specified problem
+     *
+     * **Required scope:** environment-api:problems:read
+     * @returns Success
+     */
+    getProblem(config: {
+        /** The ID of the required problem. */ problemId: string;
+        /**
+         * A list of additional problem properties you can add to the response.
+         *
+         * The following properties are available (all other properties are always included and you can't remove them from the response):
+         *
+         * * `evidenceDetails`: The details of the root cause.
+         * * `impactAnalysis`: The impact analysis of the problem on other entities/users.
+         * * `recentComments`: A list of the most recent comments to the problem.
+         *
+         * To add properties, specify them as a comma-separated list (for example, `evidenceDetails,impactAnalysis`).
+         */ fields?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<Problem>;
+    /**
+     * Lists problems observed within the specified timeframe
+     *
+     * **Required scope:** environment-api:problems:read
+     * @returns Success
+     */
+    getProblems(config: {
+        /**
+         * A list of additional problem properties you can add to the response.
+         *
+         * The following properties are available (all other properties are always included and you can't remove them from the response):
+         *
+         * * `evidenceDetails`: The details of the root cause.
+         * * `impactAnalysis`: The impact analysis of the problem on other entities/users.
+         * * `recentComments`: A list of the most recent comments to the problem.
+         *
+         * To add properties, specify them as a comma-separated list (for example, `evidenceDetails,impactAnalysis`).
+         *
+         *  The field is valid only for the current page of results. You must set it for each page you're requesting.
+         */ fields?: string;
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters except the optional **fields** parameter.
+         */ nextPageKey?: string;
+        /**
+         * The amount of problems in a single response payload.
+         *
+         * The maximal allowed page size is 500.
+         *
+         * If not set, 50 is used.
+         */ pageSize?: number;
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of two hours is used (`now-2h`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /**
+         * Defines the scope of the query. Only problems matching the specified criteria are included into response.
+         *
+         * You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the **OR** logic applies. All values must be quoted.
+         * * Status: `status("open")` or `status("closed")`. You can specify only one status.
+         * * Severity level: `severityLevel("level-1","level-2")`. Find the possible values in the description of the **severityLevel** field of the response.
+         * * Impact level: `impactLevel("level-11","level-2")` Find the possible values in the description of the **impactLevel** field of the response.
+         * * Root cause entity: `rootCauseEntity("id-1", "id-2")`.
+         * * Management zone ID: `managementZoneIds("mZId-1", "mzId-2")`.
+         * * Management zone name: `managementZones("value-1","value-2")`.
+         * * Impacted entities: `impactedEntities("id-1", "id-2")`.
+         * * Affected entities: `affectedEntities("id-1", "id-2")`.
+         * * Type of affected entities: `affectedEntityTypes("value-1","value-2")`.
+         * * Problem ID: `problemId("id-1", "id-2")`.
+         * * Alerting profile ID: `problemFilterIds("id-1", "id-2")`.
+         * * Alerting profile name (contains, case-insensitive): `problemFilterNames("value-1","value-2")`.
+         * * Alerting profile name (exact match, case-insensitive): `problemFilterNames.equals("value-1","value-2")`.
+         * * Entity tags: `entityTags("[context]key:value","key:value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. If a value-only tag has a colon (`:`) in it, you must escape the colon with a backslash(`\`). Otherwise, the tag will be parsed as a `key:value tag`. All tag values are case-sensitive.
+         * * Display ID of the problem: `displayId("id-1", "id-2")`.
+         * * Under maintenance: `underMaintenance(true|false)`. Shows (true) or hides (false) all problems created during maintenance mode.
+         * * Text search: `text("value")`. Text search on the following fields: problem title, event titles, displayId and the id of affected and impacted entities. The text search is case insensitive, partial matching and based on a relevance score. Therefore the `relevance` sort option should be used to get the most relevant problems first. The special characters `~` and `"` need to be escaped using a `~` (e.g. double quote search `text("~"")`). The search value is limited to 30 characters.
+         *
+         * To set several criteria, separate them with a comma (`,`). Only results matching **all** criteria are included in the response.
+         */ problemSelector?: string;
+        /**
+         * The entity scope of the query. You must set one of these criteria:
+         *
+         * * Entity type: `type("TYPE")`
+         * * Dynatrace entity ID: `entityId("id")`. You can specify several IDs, separated by a comma (`entityId("id-1","id-2")`). All requested entities must be of the same type.
+         *
+         * You can add one or several of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
+         *
+         * * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`), otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.
+         * * Management zone ID: `mzId(123)`
+         * * Management zone name: `mzName("value")`
+         * * Entity name:
+         * 	* `entityName.equals`: performs a non-casesensitive `EQUALS` query.
+         * 	* `entityName.startsWith`: changes the operator to `BEGINS WITH`.
+         * 	* `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
+         * 	* `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an arguments and makes the value case-sensitive.
+         * * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
+         * * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
+         * 	The following operators are available:
+         * 	* `lte`: earlier than or at the specified time
+         * 	* `lt`: earlier than the specified time
+         * 	* `gte`: later than or at the specified time
+         * 	* `gt`: later than the specified time
+         * * Entity attribute: `<attribute>("value1","value2")` and `<attribute>.exists()`. To fetch the list of available attributes, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **properties** field of the response.
+         * * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`. The criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **fromRelationships** and **toRelationships** fields.
+         * * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
+         *
+         * For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
+         *
+         * To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in response.
+         *
+         * Supported string length is 2,000 characters.
+         *
+         * The maximum number of entities that may be selected is limited to 10000.
+         */ entitySelector?: string;
+        /**
+         * Specifies a set of comma-separated (`,`) fields for sorting in the problem list.
+         *
+         * You can sort by the following properties with a sign prefix for the sorting order.
+         *
+         *  * `status`: problem status (`+` open problems first or `-` closed problems first)
+         *  * `startTime`: problem start time (`+` old problems first or `-` new problems first)
+         *  * `relevance`: problem relevance (`+` least relevant problems first or `-` most relevant problems first) - can be used only in combination with text search
+         *
+         * If no prefix is set, `+` is used.
+         *
+         * You can specify several levels of sorting. For example, `+status,-startTime` sorts problems by status, open problems first. Within the status, problems are sorted by start time, oldest first.
+         */ sort?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<Problems>;
+}
+export declare const problemsClient: ProblemsClient;

package/types/packages/client/classic-environment-v2/src/lib/apis/releases-api.d.ts

@@ -0,0 +1,108 @@
+import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { Releases } from '../models/releases';
+/**
+ * Analyze your deployed components
+ */
+export declare class ReleasesClient {
+    private httpClient;
+    /**
+     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a ReleasesClient. Custom http client should implement {HttpClient} interface.
+     * @example
+     * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
+     */
+    constructor(httpClientImplementation: HttpClient);
+    /**
+     * Returns all releases
+     *
+     * **One of the following scopes is required:**
+     * + environment-api
+     * + environment-api:releases:read
+     * @returns Success
+     */
+    getReleases(config: {
+        /**
+         * The start of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the relative timeframe of two weeks is used (`now-2w`).
+         */ from?: string;
+        /**
+         * The end of the requested timeframe.
+         *
+         * You can use one of the following formats:
+         * * Timestamp in UTC milliseconds.
+         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
+         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
+         * You can also specify relative timeframe without an alignment: `now-NU`.
+         * Supported time units for the relative timeframe are:
+         *    * `m`: minutes
+         *    * `h`: hours
+         *    * `d`: days
+         *    * `w`: weeks
+         *    * `M`: months
+         *    * `y`: years
+         *
+         * If not set, the current timestamp is used.
+         */ to?: string;
+        /**
+         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
+         *
+         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
+         *
+         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
+         */ nextPageKey?: string;
+        /**
+         * The amount of Releases in a single response payload.
+         *
+         * The maximal allowed page size is 1000.
+         *
+         * If not set, 100 is used.
+         */ pageSize?: number;
+        /** Get your Releases (`false`) or a set of demo Releases (`true`). */ demo?: boolean;
+        /**
+         * Defines the scope of the query. Only Releases matching the provided criteria are included in the response.
+         *
+         * You can add one or several of the criteria listed below.
+         * * Management zone: type(PROCESS_GROUP_INSTANCE),mzName("ManagementZone-A"). Filters for all releases in the given management zone. The filter is case-sensitive.
+         * * Monitoring state: monitoringState("Active") or monitoringState("Inactive"). You can specify only one monitoring state.
+         * * Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.
+         * * Security vulnerability: affectedBySecurityProblem("Detected") or affectedBySecurityProblem("Not detected"). You can specify only one security vulnerability state.
+         * * Name: entityName("name"). Filters for all releases that contain the given value in their name. The filter is case-insensitive.
+         * * Entity ID: entityId("id").
+         * * Product: releasesProduct("product"). Filters for all releases that contain the given value in their product. The filter is case-insensitive.
+         * * Stage: releasesStage("stage"). Filters for all releases that contain the given value in their stage. The filter is case-insensitive.
+         * * Version: releasesVersion("version"). Filters for all releases that contain the given value in their version. The filter is case-insensitive.
+         *
+         * To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response.
+         * e.g., .../api/v2/releases?releasesSelector=name("Server"),monitoringState("Active"),healthState("HEALTHY"),releasesVersion("1.0.7").
+         *
+         * The special characters ~ and " need to be escaped using a ~ (e.g. double quote search entityName("~"").
+         */ releasesSelector?: string;
+        /**
+         * Specifies the field that is used for sorting the releases list.
+         * The field has a sign prefix (+/-) which corresponds to the sorting order ('+' for ascending and '-' for descending). If no sign prefix is set, then the default ascending sorting order will be applied. You can sort by the following properties:
+         * * 'product': Product name
+         * * 'name': Release name
+         * * 'stage': Stage name
+         * * 'version': Version
+         * * 'instances': Instances
+         * * 'traffic': Traffic
+         *
+         * If not set, the ascending order sorting for name is applied.
+         */ sort?: string;
+        abortSignal?: AbortSignal;
+    }): Promise<Releases>;
+}
+export declare const releasesClient: ReleasesClient;