@dynatrace-sdk/client-classic-environment-v2 1.0.4 → 1.2.2

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

@@ -29,10 +29,20 @@ export declare class SecurityProblemsClient {
      */
     constructor(httpClientImplementation: HttpClient);
     /**
-     * Mutes several remediation items | maturity=EARLY_ADOPTER
+     * Mutes several remediation items
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
      * @returns Success. The remediation item(s) have been muted.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.bulkMuteRemediationItems({
+     *     id: "...",
+     *     body: {} as RemediationItemsBulkMute,
+     *   });
      */
     bulkMuteRemediationItems(config: {
         body: RemediationItemsBulkMute;
@@ -40,20 +50,39 @@ export declare class SecurityProblemsClient {
         abortSignal?: AbortSignal;
     }): Promise<RemediationItemsBulkMuteResponse>;
     /**
-     * Mutes several security problems | maturity=EARLY_ADOPTER
+     * Mutes several security problems
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
      * @returns Success. The security problem(s) have been muted.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.bulkMuteSecurityProblems({
+     *     body: {} as SecurityProblemsBulkMute,
+     *   });
      */
     bulkMuteSecurityProblems(config: {
         body: SecurityProblemsBulkMute;
         abortSignal?: AbortSignal;
     }): Promise<SecurityProblemsBulkMuteResponse>;
     /**
-     * Un-mutes several remediation items | maturity=EARLY_ADOPTER
+     * Un-mutes several remediation items
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
      * @returns Success. The remediation item(s) have been un-muted.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.bulkUnmuteRemediationItems({
+     *     id: "...",
+     *     body: {} as RemediationItemsBulkUnmute,
+     *   });
      */
     bulkUnmuteRemediationItems(config: {
         body: RemediationItemsBulkUnmute;
@@ -61,10 +90,19 @@ export declare class SecurityProblemsClient {
         abortSignal?: AbortSignal;
     }): Promise<RemediationItemsBulkUnmuteResponse>;
     /**
-     * Un-mutes several security problems | maturity=EARLY_ADOPTER
+     * Un-mutes several security problems
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
      * @returns Success. The security problem(s) have been un-muted.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.bulkUnmuteSecurityProblems({
+     *     body: {} as SecurityProblemsBulkUnmute,
+     *   });
      */
     bulkUnmuteSecurityProblems(config: {
         body: SecurityProblemsBulkUnmute;
@@ -73,8 +111,21 @@ export declare class SecurityProblemsClient {
     /**
      * Lists all events of a security problem
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains the list of security problem events.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getEventsForSecurityProblem({
+     *     id: "...",
+     *     from: "...",
+     *     to: "...",
+     *   });
      */
     getEventsForSecurityProblem(config: {
         /** The ID of the required security problem. */ id: string;
@@ -119,8 +170,20 @@ export declare class SecurityProblemsClient {
     /**
      * Gets parameters of a remediation item of a security problem | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains details of a single remediation item of a security problem.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getRemediationItem({
+     *     id: "...",
+     *     remediationItemId: "...",
+     *   });
      */
     getRemediationItem(config: {
         /** The ID of the required third-party security problem. */ id: string;
@@ -130,8 +193,20 @@ export declare class SecurityProblemsClient {
     /**
      * Lists remediation items of a third-party security problem
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains the list of remediation items of a problem.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getRemediationItems({
+     *     id: "...",
+     *     remediationItemSelector: "...",
+     *   });
      */
     getRemediationItems(config: {
         /** The ID of the required third-party security problem. */ id: string;
@@ -160,8 +235,23 @@ export declare class SecurityProblemsClient {
     /**
      * Lists remediation progress entities | maturity=EARLY_ADOPTER
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains a list of remediation progress entities of a remediation item of a security problem. The number of entities returned is limited.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getRemediationProgressEntities(
+     *     {
+     *       id: "...",
+     *       remediationItemId: "...",
+     *       remediationProgressEntitySelector: "...",
+     *     }
+     *   );
      */
     getRemediationProgressEntities(config: {
         /** The ID of the required third-party security problem. */ id: string;
@@ -187,8 +277,21 @@ export declare class SecurityProblemsClient {
     /**
      * Gets parameters of a security problem
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains parameters of the security problem.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getSecurityProblem({
+     *     id: "...",
+     *     fields: "...",
+     *     from: "...",
+     *   });
      */
     getSecurityProblem(config: {
         /** The ID of the required security problem. */ id: string;
@@ -211,6 +314,7 @@ export declare class SecurityProblemsClient {
          * * `relatedEntities`: A list of related entities of the security problem within the provided filter range.
          * * `relatedContainerImages`: A list of related container images of the security problem within the provided filter range.
          * * `relatedAttacks`: A list of attacks detected on the exposed security problem.
+         * * `entryPoints`: A list of entry points and a flag which indicates whether this list was truncated or not.
          *
          * To add properties, specify them in a comma-separated list and prefix each property with a plus (for example, `+riskAssessment,+managementZones`).
          */ fields?: string;
@@ -238,8 +342,25 @@ export declare class SecurityProblemsClient {
     /**
      * Lists all security problems
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains the list of security problems.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getSecurityProblems({
+     *     nextPageKey: "...",
+     *     pageSize: 123,
+     *     securityProblemSelector: "...",
+     *     sort: "...",
+     *     fields: "...",
+     *     from: "...",
+     *     to: "...",
+     *   });
      */
     getSecurityProblems(config?: {
         /**
@@ -397,8 +518,21 @@ export declare class SecurityProblemsClient {
     /**
      * Lists all vulnerable functions and their usage for a third-party security problem
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems
+     * **Required scope:** environment-api:security-problems:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-security-problems
+     * + environment:roles:view-security-problems
+     *
      * @returns Success. The response contains the list of vulnerable functions.
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.getVulnerableFunctions({
+     *     id: "...",
+     *     vulnerableFunctionsSelector: "...",
+     *     groupBy: "...",
+     *   });
      */
     getVulnerableFunctions(config: {
         /** The ID of the required third-party security problem. */ id: string;
@@ -430,6 +564,15 @@ export declare class SecurityProblemsClient {
      * Mutes a security problem
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.muteSecurityProblem({
+     *     id: "...",
+     *     body: {} as SecurityProblemMute,
+     *   });
      */
     muteSecurityProblem(config: {
         body: SecurityProblemMute;
@@ -440,6 +583,16 @@ export declare class SecurityProblemsClient {
      * Sets the mute state of a remediation item | maturity=EARLY_ADOPTER
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.setRemediationItemMuteState({
+     *     id: "...",
+     *     remediationItemId: "...",
+     *     body: {} as RemediationItemMuteStateChange,
+     *   });
      */
     setRemediationItemMuteState(config: {
         body: RemediationItemMuteStateChange;
@@ -451,6 +604,15 @@ export declare class SecurityProblemsClient {
      * Un-mutes a security problem
      *
      * **Required scope:** environment-api:security-problems:write<br/>**Required permission:** environment:roles:manage-security-problems
+     *
+     * @example <caption>Code example</caption>
+     * import { securityProblemsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await securityProblemsClient.unmuteSecurityProblem({
+     *     id: "...",
+     *     body: {} as SecurityProblemUnmute,
+     *   });
      */
     unmuteSecurityProblem(config: {
         body: SecurityProblemUnmute;

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

@@ -24,7 +24,21 @@ export declare class ServiceLevelObjectivesClient {
      * 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;
@@ -82,7 +96,25 @@ export declare class ServiceLevelObjectivesClient {
      *
      * 1. Set the **timeFrame** parameter to `GTF`.
      * 2. Provide the timeframe in **from** and **to** parameters.
+     *
      * @returns Success. The response contains the parameters and calculated values of the requested SLO.
+     *
+     * @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,
+     * });
      */
     getSlo(config?: {
         /**
@@ -139,16 +171,20 @@ export declare class ServiceLevelObjectivesClient {
          * The scope of the query. Only SLOs matching the provided criteria are included in the response.
          *
          * You can add one or several of the criteria listed below.
-         * * SLO ID: id("id-1","id-2").
-         * * Name: name("name"). Filters for an SLO with the given name. The filter is case-sensitive.
-         * * Health state: healthState("HEALTHY") or healthState("UNHEALTHY"). You can specify only one health state.
-         * * Text: text("value"). Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.
-         * * Problem: problemDisplayName("value"). Filters for all SLOs that are related to a given problem display name (e.g. P-12345).
+         * * SLO ID: `id("id-1","id-2")`.
+         * * Name: `name("name")`. Filters for an SLO with the given name. The filter is case-sensitive.
+         * * Health state: `healthState("HEALTHY")` or `healthState("UNHEALTHY")`. Filters for SLOs that have no related open problems (`HEALTHY`) or SLOs that have related open problems (`UNHEALTHY`). You can specify only one health state.
+         * * Text: `text("value")`. Filters for all SLOs that contain the given value in their name or description. The filter is case-insensitive.
+         * * Problem: `problemDisplayName("value")`. Filters for all SLOs that are related to a given problem display name (e.g. P-12345).
+         * * Management zone name: `managementZone("MZ-A")`. Filters for all SLOs that are related to the given management zone name.
+         * * Management zone ID: `managementZoneID("123")`. Filters for all SLOs that are related to the given management zone ID.
          *
-         * To set several criteria, separate them with comma (,). Only results matching all criteria are included in the response.
-         * e.g., .../api/v2/slo?sloSelector=name("Service Availability"), .../api/v2/slo?sloSelector=id("id"), .../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").
+         * To set several criteria, separate them with comma (`,`). Only SLOs matching all criteria are included in the response. Examples:
+         * * .../api/v2/slo?sloSelector=name("Service Availability")
+         * * .../api/v2/slo?sloSelector=id("id")
+         * * .../api/v2/slo?sloSelector=text("Description"),healthState("HEALTHY").
          *
-         * The special characters ~ and " need to be escaped using a ~ (e.g. double quote search text("~"").
+         * The special characters `~` and `"` need to be escaped using a `~` (e.g. double quote search `text("~"")`).
          */ sloSelector?: string;
         /**
          * The sorting of SLO entries:
@@ -175,6 +211,13 @@ export declare class ServiceLevelObjectivesClient {
      * Creates a new SLO
      *
      * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await serviceLevelObjectivesClient.createSlo({
+     *   body: {} as SloConfigItemDtoImpl,
+     * });
      */
     createSlo(config: {
         body: SloConfigItemDtoImpl;
@@ -184,7 +227,18 @@ 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.
+     *
      * @returns Success. The response contains the parameters and calculated values of the requested SLO.
+     *
+     * @example <caption>Code example</caption>
+     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await serviceLevelObjectivesClient.getSloById({
+     *   id: "...",
+     *   from: "...",
+     *   to: "...",
+     *   timeFrame: {} as GetSloByIdQueryTimeFrame,
+     * });
      */
     getSloById(config: {
         /** The ID of the required SLO. */ id: string;
@@ -238,6 +292,15 @@ export declare class ServiceLevelObjectivesClient {
      * Updates an existing SLO
      *
      * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await serviceLevelObjectivesClient.updateSloById({
+     *     id: "...",
+     *     body: {} as SloConfigItemDtoImpl,
+     *   });
      */
     updateSloById(config: {
         body: SloConfigItemDtoImpl;
@@ -248,6 +311,13 @@ export declare class ServiceLevelObjectivesClient {
      * Deletes an SLO
      *
      * **Required scope:** environment-api:slo:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { serviceLevelObjectivesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await serviceLevelObjectivesClient.deleteSlo({
+     *   id: "...",
+     * });
      */
     deleteSlo(config: {
         id: string;

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

@@ -19,8 +19,19 @@ export declare class SettingsObjectsClient {
     /**
      * Gets the specified settings object
      *
-     * **Required scope:** settings:objects:read
+     * **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;
@@ -29,8 +40,20 @@ export declare class SettingsObjectsClient {
     /**
      * Updates an existing settings object
      *
-     * **Required scope:** settings:objects:write
+     * **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;
@@ -40,7 +63,17 @@ export declare class SettingsObjectsClient {
     /**
      * Deletes the specified settings object
      *
-     * **Required scope:** settings:objects:write
+     * **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;
@@ -56,12 +89,29 @@ export declare class SettingsObjectsClient {
     /**
      * Lists effective settings values
      *
-     * **Required scope:** settings:objects:read<br/><br/>Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see [/settings/objects](#/Settings%20-%20Objects/getSettingsObjects))
+     * **Required scope:** settings:objects:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:read
+     *
+     * <br/><br/>Lists effective settings values for selected schemas at a selected scope (or entity). This operation evaluates the hierarchy of persisted objects (see [/settings/objects](#/Settings%20-%20Objects/getSettingsObjects))
      *
      * It will always return a result for a schema/scope combination, even if the schema would not be relevant to the given scope/entity.
      *
      * If no object along the hierarchy is persisted, the default value as defined in the schema will be returned.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsObjectsClient.getEffectiveSettingsValues({
+     *     schemaIds: "...",
+     *     scope: "...",
+     *     fields: "...",
+     *     nextPageKey: "...",
+     *     pageSize: 123,
+     *   });
      */
     getEffectiveSettingsValues(config?: {
         /**
@@ -72,7 +122,7 @@ export declare class SettingsObjectsClient {
         /**
          * The scope that the requested objects target.
          *
-         * The selection only matches objects directly targeting the specified scope. For example, `environment` will not match objects that target a host within environment.
+         * The selection only matches objects directly targeting the specified scope. For example, `environment` will not match objects that target a host within environment. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
          *
          * To load the first page, when the **nextPageKey** is not set, this parameter is required.
          */ scope?: string;
@@ -102,12 +152,31 @@ export declare class SettingsObjectsClient {
     /**
      * Lists persisted settings objects
      *
-     * **Required scope:** settings:objects:read<br/><br/>Lists persisted settings objects for selected schemas at selected scopes (or entities).
+     * **Required scope:** settings:objects:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:read
+     *
+     * <br/><br/>Lists persisted settings objects for selected schemas at selected scopes (or entities).
      *
      * If nothing is persisted or if all persisted settings objects are not accessible due to missing permissions, no items will be returned.
      *
      * To query the effective values (including schema defaults) please see [/settings/effectiveValues](#/Settings%20-%20Objects/getEffectiveSettingsValues).
+     *
      * @returns Success. Accessible objects returned.
+     *
+     * @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,
+     *   }
+     * );
      */
     getSettingsObjects(config?: {
         /**
@@ -120,18 +189,23 @@ export declare class SettingsObjectsClient {
         /**
          * A list of comma-separated scopes, that the requested objects target.
          *
-         * The selection only matches objects directly targeting the specified scopes. For example, `environment` will not match objects that target a host within environment.
+         * The selection only matches objects directly targeting the specified scopes. For example, `environment` will not match objects that target a host within environment. For more details, please see [Dynatrace Documentation](https://dt-url.net/ky03459).
          *
          * To load the first page, when the **nextPageKey** is not set, either this parameter or **schemaIds** is required.
          *
          * To load all objects belonging to the given scopes leave the **schemaIds** parameter empty.
          */ scopes?: string;
+        /**
+         * A list of comma-separated external IDs that the requested objects have.
+         *
+         * Only considered on load of the first page, when the **nextPageKey** is not set.
+         */ externalIds?: string;
         /**
          * A list of fields to be included to the response. The provided set of fields replaces the default set.
          *
          *  Specify the required top-level fields, separated by commas (for example, `objectId,value`).
          *
-         * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `author`, `updateToken`, `scope`, `schemaId`, `schemaVersion`, `value`, `externalId`.
+         * Supported fields: `objectId`, `summary`, `searchSummary`, `created`, `modified`, `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.
@@ -152,8 +226,22 @@ export declare class SettingsObjectsClient {
     /**
      * Creates a new settings object
      *
-     * **Required scope:** settings:objects:write<br/><br/>You can upload several objects at once. In that case each object returns its own response code. Check the response body for details.
+     * **Required scope:** settings:objects:write<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:objects:write
+     *
+     * <br/><br/>You can upload several objects at once. In that case each object returns its own response code. Check the response body for details.
+     *
      * @returns Success | Multi-status: different objects in the payload resulted in different statuses.
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsObjectsClient.postSettingsObjects({
+     *     validateOnly: true,
+     *     body: {} as SettingsObjectCreate[],
+     *   });
      */
     postSettingsObjects(config: {
         body: SettingsObjectCreate[];

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

@@ -15,15 +15,36 @@ export declare class SettingsSchemasClient {
     /**
      * Lists available settings schemas
      *
-     * **Required scope:** settings:schemas:read
+     * **Required scope:** settings:schemas:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:schemas:read
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsSchemasClient.getAvailableSchemaDefinitions();
      */
     getAvailableSchemaDefinitions(abortSignal?: AbortSignal): Promise<SchemaList>;
     /**
      * Gets parameters of the specified settings schema
      *
-     * **Required scope:** settings:schemas:read
+     * **Required scope:** settings:schemas:read<br/>**One of the following permissions is required:**
+     * + environment:roles:manage-settings
+     * + settings:schemas:read
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { settingsSchemasClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await settingsSchemasClient.getSchemaDefinition({
+     *     schemaId: "...",
+     *     schemaVersion: "...",
+     *   });
      */
     getSchemaDefinition(config: {
         /** The ID of the required schema. */ schemaId: string;