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

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

@@ -14,8 +14,25 @@ export declare class DavisSecurityAdvisorClient {
     /**
      * Provides advice for security problems.
      *
-     * **Required scope:** environment-api:security-problems:read<br/>**Required permission:** environment:roles:manage-security-problems<br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
+     * **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
+     *
+     * <br/><br/>You can narrow down the output by providing the management zone and pagination. If you specify a management zone, only problems originating from that zone are included to the request.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { davisSecurityAdvisorClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await davisSecurityAdvisorClient.getAdviceForSecurityProblems(
+     *     {
+     *       managementZoneFilter: "...",
+     *       nextPageKey: "...",
+     *       pageSize: 123,
+     *     }
+     *   );
      */
     getAdviceForSecurityProblems(config?: {
         /**

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

@@ -30,7 +30,15 @@ export declare class EventsClient {
      * + storage:events:write
      *
      * <br/><br/>The ingestion of custom events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the events pool.
+     *
      * @returns The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.createEvent({
+     *   body: {} as EventIngest,
+     * });
      */
     createEvent(config: {
         body: EventIngest;
@@ -40,7 +48,15 @@ export declare class EventsClient {
      * Gets the properties of an event
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success. The response contains the configuration of the event.
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEvent({
+     *   eventId: "...",
+     * });
      */
     getEvent(config: {
         /** The ID of the required event. */ eventId: string;
@@ -50,7 +66,16 @@ export declare class EventsClient {
      * Lists all event properties
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEventProperties({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     * });
      */
     getEventProperties(config?: {
         /**
@@ -73,7 +98,15 @@ export declare class EventsClient {
      * Gets the details of an event property
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEventProperty({
+     *   propertyKey: "...",
+     * });
      */
     getEventProperty(config: {
         /** The event property key you're inquiring. */ propertyKey: string;
@@ -83,7 +116,15 @@ export declare class EventsClient {
      * Gets the properties of an event type
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEventType({
+     *   eventType: "...",
+     * });
      */
     getEventType(config: {
         /** The event type you're inquiring. */ eventType: string;
@@ -93,7 +134,16 @@ export declare class EventsClient {
      * Lists all event types
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEventTypes({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     * });
      */
     getEventTypes(config?: {
         /**
@@ -116,7 +166,20 @@ export declare class EventsClient {
      * Lists events within the specified timeframe
      *
      * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success. The response contains the list of events.
+     *
+     * @example <caption>Code example</caption>
+     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await eventsClient.getEvents({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   from: "...",
+     *   to: "...",
+     *   eventSelector: "...",
+     *   entitySelector: "...",
+     * });
      */
     getEvents(config?: {
         /**

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

@@ -33,7 +33,16 @@ export declare class Extensions_2_0Client {
      * Gets the active environment configuration version of the specified extension 2.0
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.getActiveEnvironmentConfiguration(
+     *     { extensionName: "..." }
+     *   );
      */
     getActiveEnvironmentConfiguration(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -43,7 +52,19 @@ export declare class Extensions_2_0Client {
      * Updates the active environment configuration version of the extension 2.0
      *
      * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success. Environment configuration updated.
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.updateExtensionEnvironmentConfiguration(
+     *     {
+     *       extensionName: "...",
+     *       body: {} as ExtensionEnvironmentConfigurationVersion,
+     *     }
+     *   );
      */
     updateExtensionEnvironmentConfiguration(config: {
         body: ExtensionEnvironmentConfigurationVersion;
@@ -54,7 +75,19 @@ export declare class Extensions_2_0Client {
      * Activates the environment configuration from the specified version of the extension 2.0
      *
      * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success. Environment configuration created.
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.activateExtensionEnvironmentConfiguration(
+     *     {
+     *       extensionName: "...",
+     *       body: {} as ExtensionEnvironmentConfigurationVersion,
+     *     }
+     *   );
      */
     activateExtensionEnvironmentConfiguration(config: {
         body: ExtensionEnvironmentConfigurationVersion;
@@ -65,7 +98,16 @@ export declare class Extensions_2_0Client {
      * Deactivates the environment configuration of the specified extension 2.0
      *
      * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success. Environment configuration deactivated.
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.deleteEnvironmentConfiguration(
+     *     { extensionName: "..." }
+     *   );
      */
     deleteEnvironmentConfiguration(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -75,7 +117,22 @@ export declare class Extensions_2_0Client {
      * Lists all the monitoring configurations of the specified extension 2.0
      *
      * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.extensionMonitoringConfigurations(
+     *     {
+     *       extensionName: "...",
+     *       nextPageKey: "...",
+     *       pageSize: 123,
+     *       version: "...",
+     *       active: true,
+     *     }
+     *   );
      */
     extensionMonitoringConfigurations(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -101,7 +158,17 @@ export declare class Extensions_2_0Client {
      * Creates new monitoring configuration for the specified extension 2.0
      *
      * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success | Multi-Status, if not all requests resulted in the same status
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.createMonitoringConfiguration({
+     *     extensionName: "...",
+     *     body: {} as MonitoringConfigurationDto[],
+     *   });
      */
     createMonitoringConfiguration(config: {
         body: MonitoringConfigurationDto[];
@@ -117,7 +184,17 @@ export declare class Extensions_2_0Client {
      * Gets the configuration schema of the specified version of the extension 2.0
      *
      * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.extensionConfigurationSchema({
+     *     extensionName: "...",
+     *     extensionVersion: "...",
+     *   });
      */
     extensionConfigurationSchema(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -128,7 +205,16 @@ export declare class Extensions_2_0Client {
      * Gets details of the specified version of the extension 2.0
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.extensionDetails({
+     *   extensionName: "...",
+     *   extensionVersion: "...",
+     * });
      */
     extensionDetails(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -140,7 +226,16 @@ export declare class Extensions_2_0Client {
      * Deletes the specified version of the extension 2.0
      *
      * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success. The extension 2.0 version has been deleted.
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.removeExtension({
+     *   extensionName: "...",
+     *   extensionVersion: "...",
+     * });
      */
     removeExtension(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -151,7 +246,16 @@ export declare class Extensions_2_0Client {
      * Gets the information about assets in an active extension 2.0
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.getEnvironmentConfigurationAssetsInfo(
+     *     { extensionName: "..." }
+     *   );
      */
     getEnvironmentConfigurationAssetsInfo(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -163,7 +267,23 @@ export declare class Extensions_2_0Client {
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
      *
      * @deprecated
+     *
      * @returns List of the latest extension environment configuration events
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.getEnvironmentConfigurationEvents(
+     *     {
+     *       extensionName: "...",
+     *       from: "...",
+     *       to: "...",
+     *       content: "...",
+     *       status:
+     *         {} as GetEnvironmentConfigurationEventsQueryStatus,
+     *     }
+     *   );
      */
     getEnvironmentConfigurationEvents(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -213,7 +333,27 @@ export declare class Extensions_2_0Client {
      * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
      *
      * @deprecated
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.getExtensionMonitoringConfigurationEvents(
+     *     {
+     *       extensionName: "...",
+     *       configurationId: "...",
+     *       from: "...",
+     *       to: "...",
+     *       dtEntityHost: "...",
+     *       dtActiveGateId: "...",
+     *       dtExtensionDs: "...",
+     *       content: "...",
+     *       status:
+     *         {} as GetExtensionMonitoringConfigurationEventsQueryStatus,
+     *     }
+     *   );
      */
     getExtensionMonitoringConfigurationEvents(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -277,7 +417,16 @@ export declare class Extensions_2_0Client {
      * Gets the most recent status of the execution of given monitoring configuration
      *
      * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.getExtensionMonitoringConfigurationStatus(
+     *     { extensionName: "...", configurationId: "..." }
+     *   );
      */
     getExtensionMonitoringConfigurationStatus(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -288,7 +437,16 @@ export declare class Extensions_2_0Client {
      * Gets the extension 2.0 schema file in the specified version
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.getSchemaFile({
+     *   schemaVersion: "...",
+     *   fileName: "...",
+     * });
      */
     getSchemaFile(config: {
         /** The version of the schema. */ schemaVersion: string;
@@ -299,7 +457,18 @@ export declare class Extensions_2_0Client {
      * Lists all versions of the extension 2.0
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.listExtensionVersions({
+     *     extensionName: "...",
+     *     nextPageKey: "...",
+     *     pageSize: 123,
+     *   });
      */
     listExtensionVersions(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -323,7 +492,17 @@ export declare class Extensions_2_0Client {
      * Lists all the extensions 2.0 available in your environment
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.listExtensions({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   name: "...",
+     * });
      */
     listExtensions(config?: {
         /**
@@ -347,7 +526,16 @@ export declare class Extensions_2_0Client {
      * Uploads or verifies a new extension 2.0
      *
      * **Required scope:** environment-api:extensions:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns The extension is valid | Success. The extension 2.0 has been uploaded.
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.uploadExtension({
+     *   validateOnly: true,
+     *   body: {} as Binary,
+     * });
      */
     uploadExtension(config: {
         body: Blob;
@@ -359,7 +547,15 @@ export declare class Extensions_2_0Client {
      * Lists all the files available for the specified extension 2.0 schema version
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.listSchemaFiles({
+     *   schemaVersion: "...",
+     * });
      */
     listSchemaFiles(config: {
         /** The version of the schema. */ schemaVersion: string;
@@ -370,14 +566,29 @@ export declare class Extensions_2_0Client {
      * Lists all the extension 2.0 schemas versions available in your environment
      *
      * **Required scope:** environment-api:extensions:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await extensions_2_0Client.listSchemas();
      */
     listSchemas(abortSignal?: AbortSignal): Promise<SchemasList>;
     /**
      * Gets the details of the specified monitoring configuration
      *
      * **Required scope:** environment-api:extension-configurations:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.monitoringConfigurationDetails(
+     *     { extensionName: "...", configurationId: "..." }
+     *   );
      */
     monitoringConfigurationDetails(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;
@@ -388,7 +599,18 @@ export declare class Extensions_2_0Client {
      * Updates the specified monitoring configuration
      *
      * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.updateMonitoringConfiguration({
+     *     extensionName: "...",
+     *     configurationId: "...",
+     *     body: {} as MonitoringConfigurationUpdateDto,
+     *   });
      */
     updateMonitoringConfiguration(config: {
         body: MonitoringConfigurationUpdateDto;
@@ -400,6 +622,15 @@ export declare class Extensions_2_0Client {
      * Deletes the specified monitoring configuration
      *
      * **Required scope:** environment-api:extension-configurations:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { extensions_2_0Client } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await extensions_2_0Client.removeMonitoringConfiguration({
+     *     extensionName: "...",
+     *     configurationId: "...",
+     *   });
      */
     removeMonitoringConfiguration(config: {
         /** The name of the requested extension 2.0. */ extensionName: string;

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

@@ -54,7 +54,15 @@ export declare class LogsClient {
      * **High-cardinality attributes:**
      *
      * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
+     *
      * @returns Only a part of input events were ingested due to event invalidity. For details, check the response body.
+     *
+     * @example <caption>Code example</caption>
+     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await logsClient.storeLog({
+     *   body: {} as LogMessageJson,
+     * });
      */
     storeLog(config: ({
         body: LogMessageJson;
@@ -73,7 +81,22 @@ export declare class LogsClient {
      *  Unlike the **search** API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the **sort** query parameter.
      *
      *  In order to fetch large amount of records (exceeding the **pageSize** value), one should repeat the **export** call with **nextPageKey** param.
+     *
+     * Disabled on *Log Management and Analytics, powered by Grail*.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await logsClient.exportLogRecords({
+     *   from: "...",
+     *   to: "...",
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   query: "...",
+     *   sort: "...",
+     * });
      */
     exportLogRecords(config?: {
         /**
@@ -142,7 +165,22 @@ export declare class LogsClient {
      * **Required scope:** storage:logs:read<br/>**Required permission:** environment:roles:logviewer<br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
      *
      * It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
+     *
+     * If *Log Management and Analytics, powered by Grail* is enabled, then an OAuth token is required with *storage:logs:read* and *storage:buckets:read* scopes.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await logsClient.getLogHistogramData({
+     *   from: "...",
+     *   to: "...",
+     *   query: "...",
+     *   timeBuckets: 123,
+     *   maxGroupValues: 123,
+     *   groupBy: [],
+     * });
      */
     getLogHistogramData(config?: {
         /**
@@ -221,7 +259,22 @@ export declare class LogsClient {
      * If the query is too large to be processed in a single request, it is divided into slices. In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
      *
      * Results can be distributed unevenly between slices and some slices might be empty.
+     *
+     * If *Log Management and Analytics, powered by Grail* is enabled, then an OAuth token is required with *storage:logs:read* and *storage:buckets:read* scopes.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await logsClient.getLogRecords({
+     *   from: "...",
+     *   to: "...",
+     *   limit: 123,
+     *   query: "...",
+     *   sort: "...",
+     *   nextSliceKey: "...",
+     * });
      */
     getLogRecords(config?: {
         /**