@dynatrace-sdk/client-classic-environment-v2 3.0.0 → 3.2.0

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts

@@ -31,6 +31,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.getConfiguration();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getConfiguration(abortSignal?: AbortSignal): Promise<SyntheticConfigDto>;
     /**
@@ -47,6 +52,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.updateConfiguration(
      *     { body: { bmMonitorTimeout: 10, bmStepTimeout: 10 } },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateConfiguration(config: {
         body: SyntheticConfigDto;
@@ -64,6 +74,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.getLocations();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocations(config?: {
         /** Filters the resulting set of locations to those which are hosted on a specific cloud platform. */ cloudPlatform?: GetLocationsQueryCloudPlatform;
@@ -85,6 +100,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.addLocation(
      *     { body: {} },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     addLocation(config: {
         body: PrivateSyntheticLocation;
@@ -102,6 +122,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentApplyCommands();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocationDeploymentApplyCommands(config?: {
         /** Container platform, currently supported are: KUBERNETES and OPENSHIFT. Default value is KUBERNETES. */ platform?: string;
@@ -121,6 +146,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.getLocationsStatus();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocationsStatus(abortSignal?: AbortSignal): Promise<SyntheticPublicLocationsStatus>;
     /**
@@ -135,6 +165,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.updateLocationsStatus(
      *     { body: { publicLocationsEnabled: false } },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateLocationsStatus(config: {
         body: SyntheticPublicLocationsStatus;
@@ -154,6 +189,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.getLocation(
      *     { locationId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocation(config: {
         /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -171,6 +211,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.updateLocation(
      *     { locationId: "...", body: {} },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateLocation(config: {
         body: SyntheticLocationUpdate;
@@ -189,6 +234,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.removeLocation(
      *     { locationId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     removeLocation(config: {
         /** The Dynatrace entity ID of the private synthetic location to be deleted. */ locationId: string;
@@ -208,6 +258,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentDeleteCommands(
      *     { locationId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocationDeploymentDeleteCommands(config: {
         /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -230,6 +285,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.getLocationDeploymentYaml(
      *     { locationId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getLocationDeploymentYaml(config: {
         /** The Dynatrace entity ID of the required location. */ locationId: string;
@@ -253,6 +313,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.getNodes();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getNodes(abortSignal?: AbortSignal): Promise<Nodes>;
     /**
@@ -269,6 +334,11 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *   await syntheticLocationsNodesAndConfigurationClient.getNode(
      *     { nodeId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getNode(config: {
         /** The ID of the required synthetic node. */ nodeId: string;

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

@@ -26,6 +26,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
      *
      * const data =
      *   await syntheticNetworkAvailabilityMonitorsClient.getMonitors();
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getMonitors(config?: {
         /**
@@ -58,6 +63,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
      *   await syntheticNetworkAvailabilityMonitorsClient.createMonitor(
      *     {},
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     createMonitor(config: {
         body: SyntheticMultiProtocolMonitorUpdateDto;
@@ -77,6 +87,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
      *   await syntheticNetworkAvailabilityMonitorsClient.getMonitor(
      *     { monitorId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getMonitor(config: {
         /** The identifier of the monitor. */ monitorId: string;
@@ -94,6 +109,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
      *   await syntheticNetworkAvailabilityMonitorsClient.updateMonitor(
      *     { monitorId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     updateMonitor(config: {
         body: SyntheticMultiProtocolMonitorUpdateDto;
@@ -112,6 +132,11 @@ export declare class SyntheticNetworkAvailabilityMonitorsClient {
      *   await syntheticNetworkAvailabilityMonitorsClient.deleteMonitor(
      *     { monitorId: "..." },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     deleteMonitor(config: {
         /** The identifier of the monitor. */ monitorId: string;

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

@@ -29,6 +29,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
      *
      * const data =
      *   await syntheticOnDemandMonitorExecutionsClient.getExecutions();
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getExecutions(config?: {
         /** Filters the resulting set of executions by their stage. */ executionStage?: GetExecutionsQueryExecutionStage;
@@ -161,6 +166,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
      *   await syntheticOnDemandMonitorExecutionsClient.execute({
      *     body: {},
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Unavailable | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     execute(config: {
         body: SyntheticOnDemandExecutionRequest;
@@ -180,6 +190,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
      *   await syntheticOnDemandMonitorExecutionsClient.getBatch({
      *     batchId: 10,
      *   });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Batch with the given ID doesn't exist. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getBatch(config: {
         /** The batch identifier of the executions. */ batchId: number;
@@ -199,11 +214,40 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
      *   await syntheticOnDemandMonitorExecutionsClient.getExecution(
      *     { executionId: 10 },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Execution with the given ID doesn't exist. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getExecution(config: {
         /** The identifier of the on-demand execution. */ executionId: number;
         abortSignal?: AbortSignal;
     }): Promise<SyntheticOnDemandExecution>;
+    /**
+     * Reruns specified on-demand execution of synthetic monitors
+     *
+     * **Required scope:** environment-api:synthetic-execution:write<br/>**Required permission:** environment:roles:viewer
+     *
+     * @returns Success. The monitor's execution response details
+     *
+     * @example <caption>Code example</caption>
+     * import { syntheticOnDemandMonitorExecutionsClient } from "@dynatrace-sdk/client-classic-environment-v2";
+     *
+     * const data =
+     *   await syntheticOnDemandMonitorExecutionsClient.rerun({
+     *     executionId: 10,
+     *   });
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Unavailable | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
+     */
+    rerun(config: {
+        /** The identifier of the on-demand execution. */ executionId: number;
+        abortSignal?: AbortSignal;
+    }): Promise<SyntheticOnDemandExecutionResult>;
     /**
      * Gets detailed results of the specified on-demand execution
      *
@@ -218,6 +262,11 @@ export declare class SyntheticOnDemandMonitorExecutionsClient {
      *   await syntheticOnDemandMonitorExecutionsClient.getExecutionFullReport(
      *     { executionId: 10 },
      *   );
+     *
+     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Execution with the given ID doesn't exist. | Client side error. | Server side error.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     getExecutionFullReport(config: {
         /** The identifier of the on-demand execution. */ executionId: number;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts

@@ -0,0 +1,2 @@
+import { HttpClientResponse } from '@dynatrace-sdk/http-client';
+export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/biz-event-ingest-result-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * BizEventIngestResult
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { BizEventIngestResult } from '../models';
 export declare class BizEventIngestResultError extends ClientRequestError<BizEventIngestResult> {
     readonly isBizEventIngestResultError = true;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-envelope-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * ErrorEnvelope
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { ErrorEnvelope } from '../models';
 export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope> {
     readonly isErrorEnvelopeError = true;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts

@@ -1,6 +1,4 @@
-export { isClientRequestError } from './client-request-error';
-export { isApiClientError } from './api-client-error';
-export { isInvalidResponseError } from './invalid-response-error';
+export { ApiClientError, ApiGatewayError, ClientRequestError, InvalidResponseError, isApiClientError, isApiGatewayError, isClientRequestError, isInvalidResponseError, } from '@dynatrace-sdk/shared-errors';
 export { isErrorEnvelopeError } from './error-envelope-error';
 export { isBizEventIngestResultError } from './biz-event-ingest-result-error';
 export { isValidationResponseError } from './validation-response-error';

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-array-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * SettingsObjectResponse[]
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { SettingsObjectResponse } from '../models';
 export declare class SettingsObjectResponseArrayError extends ClientRequestError<SettingsObjectResponse[]> {
     readonly isSettingsObjectResponseArrayError = true;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/settings-object-response-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * SettingsObjectResponse
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { SettingsObjectResponse } from '../models';
 export declare class SettingsObjectResponseError extends ClientRequestError<SettingsObjectResponse> {
     readonly isSettingsObjectResponseError = true;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/validation-response-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * ValidationResponse
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { ValidationResponse } from '../models';
 export declare class ValidationResponseError extends ClientRequestError<ValidationResponse> {
     readonly isValidationResponseError = true;

package/types/packages/client/classic-environment-v2/src/lib/models/abstract-credentials-response-element.d.ts

@@ -26,11 +26,25 @@ export interface AbstractCredentialsResponseElement {
      * Flag indicating that this credential is visible only to the owner.
      */
     ownerAccessOnly: boolean;
+    /**
+     * The scope of the credentials set.
+     */
     scope?: AbstractCredentialsResponseElementScope;
+    /**
+     * Configuration for external vault synchronization for username and password credentials.
+     */
     externalVault?: ExternalVaultConfig;
     /**
      * The list contains summary data related to the use of credentials.
      */
     credentialUsageSummary: CredentialUsageHandler[];
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `USERNAME_PASSWORD` -> CredentialsDetailsUsernamePasswordResponseElement
+     * * `CERTIFICATE` -> CredentialsDetailsCertificateResponseElement
+     * * `TOKEN` -> CredentialsDetailsTokenResponseElement
+     * * `PUBLIC_CERTIFICATE` -> CredentialsDetailsCertificateResponseElement
+     */
     type: AbstractCredentialsResponseElementType;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/abstract-slo-alert-dto.d.ts

@@ -8,5 +8,11 @@ export interface AbstractSloAlertDto {
      * Threshold of the alert. Status alerts trigger if they fall below this value, burn rate alerts trigger if they exceed the value.
      */
     alertThreshold: number;
+    /**
+     * Defines the actual set of fields depending on the value. See one of the following objects:
+     *
+     * * `BURN_RATE` -> BurnRateAlert
+     * * `STATUS` -> StatusAlert
+     */
     alertType: AbstractSloAlertDtoAlertType;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-auto-update-config.d.ts

@@ -4,6 +4,16 @@ import { ActiveGateAutoUpdateConfigSetting } from './active-gate-auto-update-con
  * Configuration of the ActiveGate auto-updates.
  */
 export interface ActiveGateAutoUpdateConfig {
+    /**
+     * The actual state of the ActiveGate auto-update.
+     *
+     * Applicable only if the **setting** parameter is set to `INHERITED`. In that case, the value is taken from the parent setting. Otherwise, it's just a duplicate of the **setting** value.
+     */
     effectiveSetting?: ActiveGateAutoUpdateConfigEffectiveSetting;
+    /**
+     * The state of the ActiveGate auto-update: enabled, disabled, or inherited.
+     *
+     * If set to `INHERITED`, the setting is inherited from the global configuration set on the environment or Managed cluster level.
+     */
     setting: ActiveGateAutoUpdateConfigSetting;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-global-auto-update-config.d.ts

@@ -4,6 +4,14 @@ import { ConfigurationMetadata } from './configuration-metadata';
  * Global configuration of ActiveGates auto-update.
  */
 export interface ActiveGateGlobalAutoUpdateConfig {
+    /**
+     * The state of auto-updates for all ActiveGates connected to the environment or Managed cluster.
+     *
+     * This setting is inherited by all ActiveGates that have the `INHERITED` setting.
+     */
     globalSetting: ActiveGateGlobalAutoUpdateConfigGlobalSetting;
+    /**
+     * Metadata useful for debugging
+     */
     metadata?: ConfigurationMetadata;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Information about ActiveGate group.
+ */
+export interface ActiveGateGroup {
+    /**
+     * Name of ActiveGate group
+     */
+    name?: string;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-group.transformation.d.ts

@@ -0,0 +1,6 @@
+import { ActiveGateGroup } from './active-gate-group';
+export interface AsJson {
+    name?: string;
+}
+export declare function fromJson($model: AsJson): ActiveGateGroup;
+export declare function toJson($model: ActiveGateGroup): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.d.ts

@@ -0,0 +1,10 @@
+import { ActiveGateGroup } from './active-gate-group';
+/**
+ * The collection of ActiveGate groups.
+ */
+export interface ActiveGateGroups {
+    /**
+     * List of ActiveGate groups
+     */
+    groups?: ActiveGateGroup[];
+}

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-groups.transformation.d.ts

@@ -0,0 +1,7 @@
+import * as _ActiveGateGroupTransformation from './active-gate-group.transformation';
+import { ActiveGateGroups } from './active-gate-groups';
+export interface AsJson {
+    groups?: _ActiveGateGroupTransformation.AsJson[];
+}
+export declare function fromJson($model: AsJson): ActiveGateGroups;
+export declare function toJson($model: ActiveGateGroups): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-module.d.ts

@@ -4,6 +4,9 @@ import { ActiveGateModuleType } from './active-gate-module-type';
  * Information about ActiveGate module
  */
 export interface ActiveGateModule {
+    /**
+     * The attributes of the ActiveGate module.
+     */
     attributes?: ActiveGateModuleAttributes;
     /**
      * The module is enabled (`true`) or disabled (`false`).
@@ -13,6 +16,9 @@ export interface ActiveGateModule {
      * The module is misconfigured (`true`) or not (`false`).
      */
     misconfigured?: boolean;
+    /**
+     * The type of ActiveGate module.
+     */
     type?: ActiveGateModuleType;
     /**
      * The version of the ActiveGate module.

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-create.d.ts

@@ -3,6 +3,9 @@ import { ActiveGateTokenCreateActiveGateType } from './active-gate-token-create-
  * Parameters of a new ActiveGate token.
  */
 export interface ActiveGateTokenCreate {
+    /**
+     * The type of the ActiveGate for which the token is valid.
+     */
     activeGateType: ActiveGateTokenCreateActiveGateType;
     /**
      * The expiration date of the token.

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token-info-dto.d.ts

@@ -13,5 +13,8 @@ export interface ActiveGateTokenInfoDto {
      * The ActiveGate token identifier, consisting of [prefix and public part](https://dt-url.net/rn00tjg) of the token.
      */
     id?: string;
+    /**
+     * State of the ActiveGate token.
+     */
     state?: ActiveGateTokenInfoDtoState;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate-token.d.ts

@@ -3,6 +3,9 @@ import { ActiveGateTokenActiveGateType } from './active-gate-token-active-gate-t
  * Metadata of an ActiveGate token.
  */
 export interface ActiveGateToken {
+    /**
+     * The type of the ActiveGate for which the token is valid.
+     */
     activeGateType: ActiveGateTokenActiveGateType;
     /**
      * The token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`).

package/types/packages/client/classic-environment-v2/src/lib/models/active-gate.d.ts

@@ -15,8 +15,17 @@ export interface ActiveGate {
      * A list of the ActiveGate tokens.
      */
     activeGateTokens?: ActiveGateTokenInfoDto[];
+    /**
+     * Configuration of the ActiveGate auto-updates.
+     */
     autoUpdateSettings?: ActiveGateAutoUpdateConfig;
+    /**
+     * The current status of auto-updates of the ActiveGate.
+     */
     autoUpdateStatus?: ActiveGateAutoUpdateStatus;
+    /**
+     * Information about hosts currently connected to the ActiveGate
+     */
     connectedHosts?: ActiveGateConnectedHosts;
     /**
      * ActiveGate is deployed in container (`true`) or not (`false`).
@@ -64,9 +73,21 @@ export interface ActiveGate {
      *  The `null` value means the ActiveGate is online.
      */
     offlineSince?: number;
+    /**
+     * The OS architecture that the ActiveGate is running on.
+     */
     osArchitecture?: ActiveGateOsArchitecture;
+    /**
+     * The OS bitness that the ActiveGate is running on.
+     */
     osBitness?: ActiveGateOsBitness;
+    /**
+     * The OS type that the ActiveGate is running on.
+     */
     osType?: ActiveGateOsType;
+    /**
+     * The type of the ActiveGate.
+     */
     type?: ActiveGateType;
     /**
      * The current version of the ActiveGate in the `<major>.<minor>.<revision>.<timestamp>` format.

package/types/packages/client/classic-environment-v2/src/lib/models/affected-entities.d.ts

@@ -3,6 +3,12 @@ import { AffectedEntity } from './affected-entity';
  * Information about affected entities of an attack.
  */
 export interface AffectedEntities {
+    /**
+     * Information about an affected entity.
+     */
     processGroup?: AffectedEntity;
+    /**
+     * Information about an affected entity.
+     */
     processGroupInstance?: AffectedEntity;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/aggregated-log.d.ts

@@ -3,6 +3,9 @@ import { AggregatedLogAggregationResult } from './aggregated-log-aggregation-res
  * Aggregated log records.
  */
 export interface AggregatedLog {
+    /**
+     * Aggregated log records.
+     */
     aggregationResult?: AggregatedLogAggregationResult;
     /**
      * Optional warning messages.

package/types/packages/client/classic-environment-v2/src/lib/models/api-token-create.d.ts

@@ -70,8 +70,8 @@ export interface ApiTokenCreate {
      * * `events.ingest`: Ingest events.
      * * `openpipeline.events`: OpenPipeline - Ingest Events.
      * * `openpipeline.events.custom`: OpenPipeline - Ingest Events (Custom).
-     * * `openpipeline.events_security`: OpenPipeline - Ingest Events, Application Security.
-     * * `openpipeline.events_security.custom`: OpenPipeline - Ingest Events, Application Security (Custom).
+     * * `openpipeline.events_security`: OpenPipeline - Ingest Security Events (Built-in).
+     * * `openpipeline.events_security.custom`: OpenPipeline - Ingest Security Events (Custom).
      * * `openpipeline.events_sdlc`: OpenPipeline - Ingest Events, Software Development Lifecycle.
      * * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Events, Software Development Lifecycle (Custom).
      * * `bizevents.ingest`: Ingest bizevents.

package/types/packages/client/classic-environment-v2/src/lib/models/api-token-update.d.ts

@@ -51,8 +51,8 @@ export interface ApiTokenUpdate {
      * * `events.ingest`: Ingest events.
      * * `openpipeline.events`: OpenPipeline - Ingest Events.
      * * `openpipeline.events.custom`: OpenPipeline - Ingest Events (Custom).
-     * * `openpipeline.events_security`: OpenPipeline - Ingest Events, Application Security.
-     * * `openpipeline.events_security.custom`: OpenPipeline - Ingest Events, Application Security (Custom).
+     * * `openpipeline.events_security`: OpenPipeline - Ingest Security Events (Built-in).
+     * * `openpipeline.events_security.custom`: OpenPipeline - Ingest Security Events (Custom).
      * * `openpipeline.events_sdlc`: OpenPipeline - Ingest Events, Software Development Lifecycle.
      * * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Events, Software Development Lifecycle (Custom).
      * * `bizevents.ingest`: Ingest bizevents.

package/types/packages/client/classic-environment-v2/src/lib/models/api-token.d.ts

@@ -4,6 +4,12 @@ import { ApiTokenScopesItem } from './api-token-scopes-item';
  * Metadata of an API token.
  */
 export interface ApiToken {
+    /**
+     * Contains additional properties for specific kinds of token. Examples:
+     *
+     * * A `dashboardId` property for dashboard sharing tokens.
+     * * A `reportId` property for report sharing tokens
+     */
     additionalMetadata?: ApiTokenAdditionalMetadata;
     /**
      * Token creation date in ISO 8601 format (`yyyy-MM-dd'T'HH:mm:ss.SSS'Z'`)

package/types/packages/client/classic-environment-v2/src/lib/models/applied-filter.d.ts

@@ -9,5 +9,8 @@ export interface AppliedFilter {
      * Can contain multiple metrics for complex expressions and always at least one key.
      */
     appliedTo: string[];
+    /**
+     * A dimensional or series filter on a metric.
+     */
     filter?: Filter;
 }