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

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dynatrace-sdk/client-classic-environment-v2",
-  "version": "1.0.4",
+  "version": "1.2.2",
   "license": "Apache-2.0",
   "dependencies": {
-    "@dynatrace-sdk/http-client": "^1.0.1"
+    "@dynatrace-sdk/http-client": "^1.0.3"
   },
   "main": "./cjs/index.js",
   "module": "./esm/index.js",

package/types/packages/client/classic-environment-v2/src/lib/apis/access-tokens-active-gate-tokens-api.d.ts

@@ -20,7 +20,17 @@ export declare class AccessTokensActiveGateTokensClient {
      * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can limit the output by using pagination:
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     *
      * @returns Success. The response contains the list of ActiveGate tokens.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensActiveGateTokensClient.listTokens({
+     *     nextPageKey: "...",
+     *     pageSize: 123,
+     *   });
      */
     listTokens(config?: {
         /**
@@ -47,7 +57,16 @@ export declare class AccessTokensActiveGateTokensClient {
      * + environment-api:activegate-tokens:write
      *
      * <br/>**Required permission:** environment:roles:manage-settings<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
+     *
      * @returns Success. The token has been created. The body of the response contains the token secret.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensActiveGateTokensClient.createToken({
+     *     body: {} as ActiveGateTokenCreate,
+     *   });
      */
     createToken(config: {
         body: ActiveGateTokenCreate;
@@ -57,7 +76,16 @@ export declare class AccessTokensActiveGateTokensClient {
      * Gets metadata of an ActiveGate token
      *
      * **Required scope:** environment-api:activegate-tokens:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The token secret is **not** exposed.
+     *
      * @returns Success. The response contains the metadata of the tokens.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensActiveGateTokensClient.getToken({
+     *     activeGateTokenIdentifier: "...",
+     *   });
      */
     getToken(config: {
         /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token. */ activeGateTokenIdentifier: string;
@@ -67,6 +95,14 @@ export declare class AccessTokensActiveGateTokensClient {
      * Deletes an ActiveGate token
      *
      * **Required scope:** environment-api:activegate-tokens:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensActiveGateTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensActiveGateTokensClient.revokeToken({
+     *     activeGateTokenIdentifier: "...",
+     *   });
      */
     revokeToken(config: {
         /** The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token to be deleted. */ activeGateTokenIdentifier: string;

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

@@ -22,7 +22,22 @@ export declare class AccessTokensApiTokensClient {
      * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>You can limit the output by using pagination:
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensApiTokensClient.listApiTokens({
+     *     nextPageKey: "...",
+     *     pageSize: 123,
+     *     apiTokenSelector: "...",
+     *     fields: "...",
+     *     from: "...",
+     *     to: "...",
+     *     sort: "...",
+     *   });
      */
     listApiTokens(config?: {
         /**
@@ -137,7 +152,18 @@ export declare class AccessTokensApiTokensClient {
      * Creates a new API token
      *
      * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The newly created token will be owned by the same user who owns the token used for authentication of the call.
+     *
+     *  Creating personal access tokens requires the `environment:roles:viewer` permission. Creating access tokens requires the `environment:roles:manage-settings` permission.
+     *
      * @returns Success. The token has been created. The body of the response contains the token secret.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensApiTokensClient.createApiToken({
+     *     body: {} as ApiTokenCreate,
+     *   });
      */
     createApiToken(config: {
         body: ApiTokenCreate;
@@ -147,7 +173,15 @@ export declare class AccessTokensApiTokensClient {
      * Gets API token metadata by token ID
      *
      * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The token secret is **not** exposed.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await accessTokensApiTokensClient.getApiToken({
+     *   id: "...",
+     * });
      */
     getApiToken(config: {
         id: string;
@@ -157,6 +191,15 @@ export declare class AccessTokensApiTokensClient {
      * Updates an API token
      *
      * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensApiTokensClient.updateApiToken({
+     *     id: "...",
+     *     body: {} as ApiTokenUpdate,
+     *   });
      */
     updateApiToken(config: {
         body: ApiTokenUpdate;
@@ -171,6 +214,14 @@ export declare class AccessTokensApiTokensClient {
      * Deletes an API token
      *
      * **Required scope:** environment-api:api-tokens:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensApiTokensClient.deleteApiToken({
+     *     id: "...",
+     *   });
      */
     deleteApiToken(config: {
         /**
@@ -186,7 +237,16 @@ export declare class AccessTokensApiTokensClient {
      * Gets API token metadata by token secret
      *
      * **Required scope:** environment-api:api-tokens:read<br/>**Required permission:** environment:roles:viewer
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensApiTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensApiTokensClient.lookupApiToken({
+     *     body: {} as ApiTokenSecret,
+     *   });
      */
     lookupApiToken(config: {
         body: ApiTokenSecret;

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

@@ -15,21 +15,42 @@ export declare class AccessTokensTenantTokensClient {
      * Cancels tenant token rotation
      *
      * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     *
      * @returns Success. Rotation process has been cancelled. The current tenant token remains valid.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensTenantTokensClient.cancelRotation();
      */
     cancelRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
     /**
      * Finishes tenant token rotation
      *
      * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     *
      * @returns Success. The rotation process is completed. The **active** field of the response contains the new tenant token.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensTenantTokensClient.finishRotation();
      */
     finishRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
     /**
      * Starts tenant token rotation
      *
      * **Required scope:** environment-api:tenant-token-rotation:write<br/>**Required permission:** environment:roles:manage-settings<br/><br/>To learn how to rotate tokens, see [Token rotation](https://dt-url.net/1543sf6) in Dynatrace Documentation.
+     *
      * @returns Success. The new tenant token is created and will replace the old one. The **active** field of the response contains the new tenant token.
+     *
+     * @example <caption>Code example</caption>
+     * import { accessTokensTenantTokensClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await accessTokensTenantTokensClient.startRotation();
      */
     startRotation(abortSignal?: AbortSignal): Promise<TenantTokenConfig>;
 }

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

@@ -24,7 +24,32 @@ export declare class ActiveGatesClient {
      * Lists all available ActiveGates
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes all ActiveGates that are currently connected to the environment or have been connected during last 2 hours.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await activeGatesClient.getAllActiveGates({
+     *   hostname: "...",
+     *   osType: {} as GetAllActiveGatesQueryOsType,
+     *   networkAddress: "...",
+     *   loadBalancerAddress: "...",
+     *   type: {} as GetAllActiveGatesQueryType,
+     *   networkZone: "...",
+     *   updateStatus: {} as GetAllActiveGatesQueryUpdateStatus,
+     *   versionCompareType:
+     *     {} as GetAllActiveGatesQueryVersionCompareType,
+     *   version: "...",
+     *   autoUpdate: {} as GetAllActiveGatesQueryAutoUpdate,
+     *   group: "...",
+     *   online: true,
+     *   enabledModule: [],
+     *   disabledModule: [],
+     *   containerized: true,
+     *   tokenState: {} as GetAllActiveGatesQueryTokenState,
+     *   tokenExpirationSet: true,
+     * });
      */
     getAllActiveGates(config?: {
         /**
@@ -78,7 +103,15 @@ export declare class ActiveGatesClient {
      * Gets the details of the specified ActiveGate
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await activeGatesClient.getOneActiveGateById({
+     *   agId: "...",
+     * });
      */
     getOneActiveGateById(config: {
         /** The ID of the required ActiveGate. */ agId: string;

package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-configuration-api.d.ts

@@ -16,7 +16,16 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
      * Gets the configuration of auto-update for the specified ActiveGate
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.getAutoUpdateConfigById(
+     *     { agId: "..." }
+     *   );
      */
     getAutoUpdateConfigById(config: {
         /** The ID of the required ActiveGate. */ agId: string;
@@ -26,6 +35,14 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
      * Updates the configuration of auto-update for the specified ActiveGate
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.putAutoUpdateConfigById(
+     *     { agId: "...", body: {} as ActiveGateAutoUpdateConfig }
+     *   );
      */
     putAutoUpdateConfigById(config: {
         body: ActiveGateAutoUpdateConfig;
@@ -36,6 +53,14 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
      * Validates the payload for the `POST /activeGates/{agId}/autoUpdate` request.
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.validateAutoUpdateConfigById(
+     *     { agId: "...", body: {} as ActiveGateAutoUpdateConfig }
+     *   );
      */
     validateAutoUpdateConfigById(config: {
         body: ActiveGateAutoUpdateConfig;
@@ -46,13 +71,28 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
      * Gets the global auto-update configuration of environment ActiveGates.
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.getGlobalAutoUpdateConfigForTenant();
      */
     getGlobalAutoUpdateConfigForTenant(abortSignal?: AbortSignal): Promise<ActiveGateGlobalAutoUpdateConfig>;
     /**
      * Puts the global auto-update configuration of environment ActiveGates.
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.putGlobalAutoUpdateConfigForTenant(
+     *     { body: {} as ActiveGateGlobalAutoUpdateConfig }
+     *   );
      */
     putGlobalAutoUpdateConfigForTenant(config: {
         body: ActiveGateGlobalAutoUpdateConfig;
@@ -62,6 +102,14 @@ export declare class ActiveGatesAutoUpdateConfigurationClient {
      * Validates the payload for the `POST /activeGates/autoUpdate` request.
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateConfigurationClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateConfigurationClient.validateGlobalAutoUpdateConfigForTenant(
+     *     { body: {} as ActiveGateGlobalAutoUpdateConfig }
+     *   );
      */
     validateGlobalAutoUpdateConfigForTenant(config: {
         body: ActiveGateGlobalAutoUpdateConfig;

package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-auto-update-jobs-api.d.ts

@@ -23,7 +23,27 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * List ActiveGates with update jobs
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The response includes ActiveGates that have both completed (successful and failed) jobs and jobs in progress.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.getAllUpdateJobList(
+     *     {
+     *       from: "...",
+     *       to: "...",
+     *       startVersionCompareType:
+     *         {} as GetAllUpdateJobListQueryStartVersionCompareType,
+     *       startVersion: "...",
+     *       updateType: "ACTIVE_GATE",
+     *       targetVersionCompareType:
+     *         {} as GetAllUpdateJobListQueryTargetVersionCompareType,
+     *       targetVersion: "...",
+     *       lastUpdates: true,
+     *     }
+     *   );
      */
     getAllUpdateJobList(config?: {
         /**
@@ -84,7 +104,28 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * Lists update jobs for the specified ActiveGate
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>The job can update the ActiveGate to the specified version or the latest available one.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.getUpdateJobListByAgId(
+     *     {
+     *       agId: "...",
+     *       from: "...",
+     *       to: "...",
+     *       startVersionCompareType:
+     *         {} as GetUpdateJobListByAgIdQueryStartVersionCompareType,
+     *       startVersion: "...",
+     *       updateType: "ACTIVE_GATE",
+     *       targetVersionCompareType:
+     *         {} as GetUpdateJobListByAgIdQueryTargetVersionCompareType,
+     *       targetVersion: "...",
+     *       lastUpdates: true,
+     *     }
+     *   );
      */
     getUpdateJobListByAgId(config: {
         /** The ID of the required ActiveGate. */ agId: string;
@@ -146,7 +187,16 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * Creates a new update job for the specified ActiveGate
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success. The update-job have been created.
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.createUpdateJobForAg(
+     *     { agId: "...", body: {} as UpdateJob }
+     *   );
      */
     createUpdateJobForAg(config: {
         body: UpdateJob;
@@ -157,7 +207,16 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * Gets the parameters of the specified update job
      *
      * **Required scope:** environment-api:activegates:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.getUpdateJobByJobIdForAg(
+     *     { agId: "...", jobId: "..." }
+     *   );
      */
     getUpdateJobByJobIdForAg(config: {
         /** The ID of the required ActiveGate. */ agId: string;
@@ -168,6 +227,14 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * Deletes the specified update job
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.deleteUpdateJobByJobIdForAg(
+     *     { agId: "...", jobId: "..." }
+     *   );
      */
     deleteUpdateJobByJobIdForAg(config: {
         /** The ID of the required ActiveGate. */ agId: string;
@@ -178,6 +245,14 @@ export declare class ActiveGatesAutoUpdateJobsClient {
      * Validates the payload for the `POST /activeGates/{agId}/updateJobs` request.
      *
      * **Required scope:** environment-api:activegates:write<br/>**Required permission:** environment:roles:manage-settings
+     *
+     * @example <caption>Code example</caption>
+     * import { activeGatesAutoUpdateJobsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await activeGatesAutoUpdateJobsClient.validateUpdateJobForAg(
+     *     { agId: "...", body: {} as UpdateJob }
+     *   );
      */
     validateUpdateJobForAg(config: {
         body: UpdateJob;

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

@@ -16,7 +16,13 @@ export declare class AuditLogsClient {
      * Gets the specified entry of the audit log | maturity=EARLY_ADOPTER
      *
      * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await auditLogsClient.getLog({ id: "..." });
      */
     getLog(config: {
         /** The ID of the required log entry. */ id: string;
@@ -28,7 +34,20 @@ export declare class AuditLogsClient {
      * **Required scope:** environment-api:audit-logs:read<br/>**Required permission:** environment:roles:manage-settings<br/><br/>You can limit the output by using pagination:
      * 1. Specify the number of results per page in the **pageSize** query parameter.
      * 2. Use the cursor from the **nextPageKey** field of the previous response in the **nextPageKey** query parameter to obtain subsequent pages.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { auditLogsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await auditLogsClient.getLogs({
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     *   filter: "...",
+     *   from: "...",
+     *   to: "...",
+     *   sort: "...",
+     * });
      */
     getLogs(config?: {
         /**

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

@@ -13,7 +13,32 @@ export declare class BusinessEventsClient {
      * Ingests a business event
      *
      * **Required scope:** storage:events:write<br/>**Required permission:** storage:events:write<br/><br/>The ingestion of business events consumes [Davis Data Units](https://dt-url.net/ddu) (DDUs) from the business events pool.
+     *
      * @returns The provided business events are all accepted and will be processed.
+     *
+     * @example <caption>Code example</caption>
+     * import { businessEventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await businessEventsClient.ingest({
+     *   body: {
+     *     specversion: "1.0",
+     *     id: "1",
+     *     source: "custom.source",
+     *     type: "com.mycompany.shop.checkout",
+     *     dtcontext:
+     *       'dt.session_id="234234234324235345345",dt.entity.rum_application="APPLICATION-53453458340758",host.name="123.123.123.123"',
+     *     dataschema:
+     *       "http://dynatrace.com/schema/bizevents/generic/1.0",
+     *     traceparent:
+     *       "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00",
+     *     data: {
+     *       id: "OR-838475",
+     *       paymentType: "paypal",
+     *       plannedDeliveryDate: "01.01.2021",
+     *       total: 234,
+     *     },
+     *   } as CloudEvent,
+     * });
      */
     ingest(config: ({
         body: CloudEvent;

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

@@ -20,7 +20,20 @@ export declare class CredentialVaultClient {
      * Lists all sets of credentials for synthetic monitors stored in your environment.
      *
      * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (username/certificate and password) is not included in the response.
+     *
      * @returns Success
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await credentialVaultClient.listCredentials({
+     *   type: {} as ListCredentialsQueryType,
+     *   name: "...",
+     *   user: "...",
+     *   scope: "...",
+     *   nextPageKey: "...",
+     *   pageSize: 123,
+     * });
      */
     listCredentials(config?: {
         /** Filters the result by the specified credentials type. */ type?: ListCredentialsQueryType;
@@ -47,7 +60,15 @@ export declare class CredentialVaultClient {
      * Creates a new credentials set.
      *
      * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. An ID is assigned automatically by the Dynatrace server.
+     *
      * @returns Success. The new credentials set has been created. The response contains the ID of the set.
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await credentialVaultClient.createCredentials({
+     *   body: {} as Credentials,
+     * });
      */
     createCredentials(config: {
         body: Credentials;
@@ -57,7 +78,15 @@ export declare class CredentialVaultClient {
      * Gets the metadata of the specified credentials set.
      *
      * **Required scope:** environment-api:credentials:read<br/>**Required permission:** environment:roles:viewer<br/><br/>The credentials set itself (e.g. username/certificate and password) is not included in the response.
+     *
      * @returns Success. The response contains the metadata of the credentials set.
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await credentialVaultClient.getCredentials({
+     *   id: "...",
+     * });
      */
     getCredentials(config: {
         /** The Dynatrace entity ID of the required credentials set. */ id: string;
@@ -67,7 +96,16 @@ export declare class CredentialVaultClient {
      * Updates the specified credentials set.
      *
      * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>The body must not provide an ID. The ID should be provided in the path.
+     *
      * @returns Success. The new credentials set has been created. The response contains the ID of the set.
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await credentialVaultClient.updateCredentials({
+     *   id: "...",
+     *   body: {} as Credentials,
+     * });
      */
     updateCredentials(config: {
         body: Credentials;
@@ -78,6 +116,13 @@ export declare class CredentialVaultClient {
      * Deletes the specified credentials set
      *
      * **Required scope:** environment-api:credentials:write<br/>**Required permission:** environment:roles:viewer<br/><br/>Provide credential ID in the path.
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data = await credentialVaultClient.removeCredentials({
+     *   id: "...",
+     * });
      */
     removeCredentials(config: {
         /** The ID of the credentials set to be deleted. */ id: string;
@@ -87,7 +132,16 @@ export declare class CredentialVaultClient {
      * Gets the details of the specified credentials set.
      *
      * **Required scope:** environment-api:credentials:read<br/><br/>The credentials set including username/certificate, password or token is included in the response.
+     *
      * @returns Success. The response contains the details of the credentials set.
+     *
+     * @example <caption>Code example</caption>
+     * import { credentialVaultClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await credentialVaultClient.getCredentialsDetails({
+     *     id: "...",
+     *   });
      */
     getCredentialsDetails(config: {
         /** The Dynatrace entity ID of the required credentials set. */ id: string;