@dynatrace-sdk/client-classic-environment-v2 1.2.3 → 1.3.0

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

@@ -20,79 +20,14 @@ export declare class ServiceLevelObjectivesClient {
      * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
      */
     constructor(httpClientImplementation: HttpClient);
-    /**
-     * Creates an alert of the provided alert type for an SLO
-     *
-     * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
-     *
-     * @returns Success. The new alert has been created. The response contains the parameters of the new alert. The **location** response header contains the ID of the new alert.
-     *
-     * @example <caption>Code example</caption>
-     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await serviceLevelObjectivesClient.createAlert(
-     *   {
-     *     id: "...",
-     *     from: "...",
-     *     to: "...",
-     *     timeFrame: {} as CreateAlertQueryTimeFrame,
-     *     body: {} as AbstractSloAlertDto,
-     *   }
-     * );
-     */
-    createAlert(config: {
-        body: AbstractSloAlertDto;
-        /** The ID of the required SLO. */ id: string;
-        /**
-         * 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 timeframe to calculate the SLO values:
-         *
-         * * `CURRENT`: SLO's own timeframe.
-         * * `GTF`: timeframe specified by **from** and **to** parameters.
-         *
-         * If not set, the `CURRENT` value is used.
-         */ timeFrame?: CreateAlertQueryTimeFrame;
-        abortSignal?: AbortSignal;
-    }): Promise<EntityShortRepresentation>;
     /**
      * Lists all available SLOs along with calculated values
      *
-     * **Required scope:** environment-api:slo:read<br/>**Required permission:** environment:roles:viewer<br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
+     * **Required scope:** environment-api:slo:read<br/>**One of the following permissions is required:**
+     * + environment:roles:viewer
+     * + settings:objects:read
+     *
+     * <br/><br/>By default the values are calculated for the SLO's own timeframe. You can use a custom timeframe:
      *
      * 1. Set the **timeFrame** parameter to `GTF`.
      * 2. Provide the timeframe in **from** and **to** parameters.
@@ -102,19 +37,7 @@ export declare class ServiceLevelObjectivesClient {
      * @example <caption>Code example</caption>
      * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
-     * const data = await serviceLevelObjectivesClient.getSlo({
-     *   nextPageKey: "...",
-     *   pageSize: 123,
-     *   from: "...",
-     *   to: "...",
-     *   sloSelector: "...",
-     *   sort: "...",
-     *   timeFrame: {} as GetSloQueryTimeFrame,
-     *   demo: true,
-     *   evaluate: {} as GetSloQueryEvaluate,
-     *   enabledSlos: {} as GetSloQueryEnabledSlos,
-     *   showGlobalSlos: true,
-     * });
+     * const data = await serviceLevelObjectivesClient.getSlo();
      */
     getSlo(config?: {
         /**
@@ -210,13 +133,20 @@ export declare class ServiceLevelObjectivesClient {
     /**
      * Creates a new SLO
      *
-     * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
      *
      * @example <caption>Code example</caption>
      * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data = await serviceLevelObjectivesClient.createSlo({
-     *   body: {} as SloConfigItemDtoImpl,
+     *   body: {
+     *     name: "Payment service availability",
+     *     target: 95,
+     *     timeframe: "-1d",
+     *     warning: 97.5,
+     *   },
      * });
      */
     createSlo(config: {
@@ -226,7 +156,11 @@ export declare class ServiceLevelObjectivesClient {
     /**
      * Gets parameters and calculated values of a specific SLO
      *
-     * **Required scope:** environment-api:slo:read<br/>**Required permission:** environment:roles:viewer<br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
+     * **Required scope:** environment-api:slo:read<br/>**One of the following permissions is required:**
+     * + environment:roles:viewer
+     * + settings:objects:read
+     *
+     * <br/><br/>If **from** and **to** parameters are provided, the SLO is calculated for that timeframe; otherwise the SLO's own timeframe is used.
      *
      * @returns Success. The response contains the parameters and calculated values of the requested SLO.
      *
@@ -235,9 +169,6 @@ export declare class ServiceLevelObjectivesClient {
      *
      * const data = await serviceLevelObjectivesClient.getSloById({
      *   id: "...",
-     *   from: "...",
-     *   to: "...",
-     *   timeFrame: {} as GetSloByIdQueryTimeFrame,
      * });
      */
     getSloById(config: {
@@ -291,7 +222,9 @@ export declare class ServiceLevelObjectivesClient {
     /**
      * Updates an existing SLO
      *
-     * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
      *
      * @example <caption>Code example</caption>
      * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -299,7 +232,12 @@ export declare class ServiceLevelObjectivesClient {
      * const data =
      *   await serviceLevelObjectivesClient.updateSloById({
      *     id: "...",
-     *     body: {} as SloConfigItemDtoImpl,
+     *     body: {
+     *       name: "Payment service availability",
+     *       target: 95,
+     *       timeframe: "-1d",
+     *       warning: 97.5,
+     *     },
      *   });
      */
     updateSloById(config: {
@@ -310,7 +248,9 @@ export declare class ServiceLevelObjectivesClient {
     /**
      * Deletes an SLO
      *
-     * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
      *
      * @example <caption>Code example</caption>
      * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
@@ -323,5 +263,73 @@ export declare class ServiceLevelObjectivesClient {
         id: string;
         abortSignal?: AbortSignal;
     }): Promise<void>;
+    /**
+     * Creates an alert of the provided alert type for an SLO
+     *
+     * **Required scope:** environment-api:slo:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
+     *
+     * @returns Success. The new alert has been created. The response contains the parameters of the new alert. The **location** response header contains the ID of the new alert.
+     *
+     * @example <caption>Code example</caption>
+     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await serviceLevelObjectivesClient.createAlert(
+     *   {
+     *     id: "...",
+     *     body: { alertName: "...", alertThreshold: 10 },
+     *   },
+     * );
+     */
+    createAlert(config: {
+        body: AbstractSloAlertDto;
+        /** The ID of the required SLO. */ id: string;
+        /**
+         * 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 timeframe to calculate the SLO values:
+         *
+         * * `CURRENT`: SLO's own timeframe.
+         * * `GTF`: timeframe specified by **from** and **to** parameters.
+         *
+         * If not set, the `CURRENT` value is used.
+         */ timeFrame?: CreateAlertQueryTimeFrame;
+        abortSignal?: AbortSignal;
+    }): Promise<EntityShortRepresentation>;
 }
 export declare const serviceLevelObjectivesClient: ServiceLevelObjectivesClient;

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

@@ -16,76 +16,6 @@ export declare class SettingsObjectsClient {
      * const queryClientNodeJs = new QueryClient(yourCustomImplementation);
      */
     constructor(httpClientImplementation: HttpClient);
-    /**
-     * Gets the specified settings object
-     *
-     * **Required scope:** settings:objects:read<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:read
-     *
-     * @returns Success
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsObjectsClient.getSettingsObjectByObjectId({
-     *     objectId: "...",
-     *   });
-     */
-    getSettingsObjectByObjectId(config: {
-        /** The ID of the required settings object. */ objectId: string;
-        abortSignal?: AbortSignal;
-    }): Promise<SettingsObject>;
-    /**
-     * Updates an existing settings object
-     *
-     * **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @returns Success
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsObjectsClient.putSettingsObjectByObjectId({
-     *     objectId: "...",
-     *     body: {} as SettingsObjectUpdate,
-     *   });
-     */
-    putSettingsObjectByObjectId(config: {
-        body: SettingsObjectUpdate;
-        /** The ID of the required settings object. */ objectId: string;
-        abortSignal?: AbortSignal;
-    }): Promise<SettingsObjectResponse>;
-    /**
-     * Deletes the specified settings object
-     *
-     * **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
-     * + environment:roles:manage-settings
-     * + settings:objects:write
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsObjectsClient.deleteSettingsObjectByObjectId(
-     *     { objectId: "...", updateToken: "..." }
-     *   );
-     */
-    deleteSettingsObjectByObjectId(config: {
-        /** The ID of the required settings object. */ objectId: 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;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
     /**
      * Lists effective settings values
      *
@@ -105,13 +35,7 @@ export declare class SettingsObjectsClient {
      * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
      * const data =
-     *   await settingsObjectsClient.getEffectiveSettingsValues({
-     *     schemaIds: "...",
-     *     scope: "...",
-     *     fields: "...",
-     *     nextPageKey: "...",
-     *     pageSize: 123,
-     *   });
+     *   await settingsObjectsClient.getEffectiveSettingsValues();
      */
     getEffectiveSettingsValues(config?: {
         /**
@@ -131,7 +55,7 @@ export declare class SettingsObjectsClient {
          *
          *  Specify the required top-level fields, separated by commas (for example, `origin,value`).
          *
-         * Supported fields: `summary`, `searchSummary`, `created`, `modified`, `author`, `origin`, `schemaId`, `schemaVersion`, `value`, `externalId`.
+         * Supported fields: `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `origin`, `schemaId`, `schemaVersion`, `value`, `externalId`.
          */ fields?: string;
         /**
          * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
@@ -167,16 +91,8 @@ export declare class SettingsObjectsClient {
      * @example <caption>Code example</caption>
      * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
      *
-     * const data = await settingsObjectsClient.getSettingsObjects(
-     *   {
-     *     schemaIds: "...",
-     *     scopes: "...",
-     *     externalIds: "...",
-     *     fields: "...",
-     *     nextPageKey: "...",
-     *     pageSize: 123,
-     *   }
-     * );
+     * const data =
+     *   await settingsObjectsClient.getSettingsObjects();
      */
     getSettingsObjects(config?: {
         /**
@@ -198,6 +114,8 @@ export declare class SettingsObjectsClient {
         /**
          * A list of comma-separated external IDs that the requested objects have.
          *
+         * Each external ID has a maximum length of 500 characters.
+         *
          * Only considered on load of the first page, when the **nextPageKey** is not set.
          */ externalIds?: string;
         /**
@@ -205,7 +123,7 @@ export declare class SettingsObjectsClient {
          *
          *  Specify the required top-level fields, separated by commas (for example, `objectId,value`).
          *
-         * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `author`, `updateToken`, `scope`, `modificationInfo`, `schemaId`, `schemaVersion`, `value`, `externalId`.
+         * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `createdBy`, `modifiedBy`, `author`, `updateToken`, `scope`, `modificationInfo`, `schemaId`, `schemaVersion`, `value`, `externalId`.
          */ fields?: string;
         /**
          * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
@@ -239,8 +157,13 @@ export declare class SettingsObjectsClient {
      *
      * const data =
      *   await settingsObjectsClient.postSettingsObjects({
-     *     validateOnly: true,
-     *     body: {} as SettingsObjectCreate[],
+     *     body: [
+     *       {
+     *         schemaId:
+     *           "builtin:container.built-in-monitoring-rule",
+     *         scope: "HOST-D3A3C5A146830A79",
+     *       },
+     *     ],
      *   });
      */
     postSettingsObjects(config: {
@@ -248,5 +171,79 @@ export declare class SettingsObjectsClient {
         /** If `true`, the request runs only validation of the submitted settings objects, without saving them. */ validateOnly?: boolean;
         abortSignal?: AbortSignal;
     }): Promise<SettingsObjectResponse[]>;
+    /**
+     * Gets the specified settings object
+     *
+     * **Required scope:** settings:objects:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:read
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsObjectsClient.getSettingsObjectByObjectId({
+     *     objectId: "...",
+     *   });
+     */
+    getSettingsObjectByObjectId(config: {
+        /** The ID of the required settings object. */ objectId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<SettingsObject>;
+    /**
+     * Updates an existing settings object
+     *
+     * **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
+     *
+     * <br/><br/>To update a property of the `secret` type you need to pass the new value unmasked. To keep the current value, send the current masked secret. You can obtain it via [GET an object](https://dt-url.net/kj036oj) endpoint.
+     *
+     * Some schemas don't allow passing of the masked secret. In that case you need to send the unmasked secret with every update of the object.
+     *
+     * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsObjectsClient.putSettingsObjectByObjectId({
+     *     objectId: "...",
+     *     body: {},
+     *   });
+     */
+    putSettingsObjectByObjectId(config: {
+        body: SettingsObjectUpdate;
+        /** The ID of the required settings object. */ objectId: string;
+        abortSignal?: AbortSignal;
+    }): Promise<SettingsObjectResponse>;
+    /**
+     * Deletes the specified settings object
+     *
+     * **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsObjectsClient.deleteSettingsObjectByObjectId(
+     *     { objectId: "..." },
+     *   );
+     */
+    deleteSettingsObjectByObjectId(config: {
+        /** The ID of the required settings object. */ objectId: 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;
+        abortSignal?: AbortSignal;
+    }): Promise<void>;
 }
 export declare const settingsObjectsClient: SettingsObjectsClient;

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

@@ -43,7 +43,6 @@ export declare class SettingsSchemasClient {
      * const data =
      *   await settingsSchemasClient.getSchemaDefinition({
      *     schemaId: "...",
-     *     schemaVersion: "...",
      *   });
      */
     getSchemaDefinition(config: {

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-http-monitor-executions-api.d.ts

@@ -23,9 +23,8 @@ export declare class SyntheticHttpMonitorExecutionsClient {
      *   await syntheticHttpMonitorExecutionsClient.getExecutionResult(
      *     {
      *       monitorId: "...",
-     *       resultType: {} as GetExecutionResultPathResultType,
-     *       locationId: "...",
-     *     }
+     *       resultType: GetExecutionResultPathResultType.Success,
+     *     },
      *   );
      */
     getExecutionResult(config: {