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

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

@@ -49,12 +49,12 @@ export interface ApiTokenUpdate {
      * * `problems.write`: Write problems.
      * * `events.read`: Read events.
      * * `events.ingest`: Ingest events.
-     * * `openpipeline.events`: OpenPipeline - Ingest Events.
+     * * `openpipeline.events`: OpenPipeline - Ingest Events (Built-in).
      * * `openpipeline.events.custom`: OpenPipeline - Ingest Events (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).
+     * * `openpipeline.events_sdlc`: OpenPipeline - Ingest Software Development Lifecycle Events (Built-in).
+     * * `openpipeline.events_sdlc.custom`: OpenPipeline - Ingest Software Development Lifecycle Events (Custom).
      * * `bizevents.ingest`: Ingest bizevents.
      * * `analyzers.read`: Read analyzers.
      * * `analyzers.write`: Write & execute analyzers.

package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.d.ts

@@ -0,0 +1,18 @@
+import { Credentials } from './credentials';
+/**
+ * A credentials set of the `AWS_KEY_BASED` type.
+ */
+export interface AWSKeyBasedCredentialsDto extends Credentials {
+    /**
+     * Access Key ID  of the credentials set.
+     */
+    accessKeyID?: string;
+    /**
+     * AWS partition of the credential.
+     */
+    awsPartition?: string;
+    /**
+     * Secret access key of the credential.
+     */
+    secretKey?: string;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/aws-key-based-credentials-dto.transformation.d.ts

@@ -0,0 +1,9 @@
+import { AWSKeyBasedCredentialsDto } from './aws-key-based-credentials-dto';
+import * as _CredentialsTransformation from './credentials.transformation';
+export interface AsJson extends _CredentialsTransformation.AsJson {
+    accessKeyID?: string;
+    awsPartition?: string;
+    secretKey?: string;
+}
+export declare function fromJson($model: AsJson): AWSKeyBasedCredentialsDto;
+export declare function toJson($model: AWSKeyBasedCredentialsDto): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.d.ts

@@ -0,0 +1,14 @@
+import { Credentials } from './credentials';
+/**
+ * A credentials set of the `AWS_ROLE_BASED` type.
+ */
+export interface AWSRoleBasedCredentials extends Credentials {
+    /**
+     * Amazon account ID of the credential.
+     */
+    accountID?: string;
+    /**
+     * The IAM role name of the credentials set.
+     */
+    iamRole?: string;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/aws-role-based-credentials.transformation.d.ts

@@ -0,0 +1,8 @@
+import { AWSRoleBasedCredentials } from './aws-role-based-credentials';
+import * as _CredentialsTransformation from './credentials.transformation';
+export interface AsJson extends _CredentialsTransformation.AsJson {
+    accountID?: string;
+    iamRole?: string;
+}
+export declare function fromJson($model: AsJson): AWSRoleBasedCredentials;
+export declare function toJson($model: AWSRoleBasedCredentials): AsJson;

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

@@ -2,6 +2,8 @@
  * The type of the credentials set.
  */
 export declare enum CredentialsResponseElementType {
+    AwsMonitoringKeyBased = "AWS_MONITORING_KEY_BASED",
+    AwsMonitoringRoleBased = "AWS_MONITORING_ROLE_BASED",
     Certificate = "CERTIFICATE",
     PublicCertificate = "PUBLIC_CERTIFICATE",
     Snmpv3 = "SNMPV3",

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

@@ -5,10 +5,16 @@
  * * `PUBLIC_CERTIFICATE` -> PublicCertificateCredentials
  * * `USERNAME_PASSWORD` -> UserPasswordCredentials
  * * `TOKEN` -> TokenCredentials
+ * * `SNMPV3` -> SNMPV3Credentials
+ * * `AWS_KEY_BASED` -> AWSKeyBasedCredentialsDto
+ * * `AWS_ROLE_BASED` -> AWSRoleBasedCredentials
  */
 export declare enum CredentialsType {
+    AwsKeyBased = "AWS_KEY_BASED",
+    AwsRoleBased = "AWS_ROLE_BASED",
     Certificate = "CERTIFICATE",
     PublicCertificate = "PUBLIC_CERTIFICATE",
+    Snmpv3 = "SNMPV3",
     Token = "TOKEN",
     UsernamePassword = "USERNAME_PASSWORD"
 }

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

@@ -51,6 +51,9 @@ export interface Credentials {
      * * `PUBLIC_CERTIFICATE` -> PublicCertificateCredentials
      * * `USERNAME_PASSWORD` -> UserPasswordCredentials
      * * `TOKEN` -> TokenCredentials
+     * * `SNMPV3` -> SNMPV3Credentials
+     * * `AWS_KEY_BASED` -> AWSKeyBasedCredentialsDto
+     * * `AWS_ROLE_BASED` -> AWSRoleBasedCredentials
      */
     type?: CredentialsType;
 }

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

@@ -1,3 +1,5 @@
+import { AWSKeyBasedCredentialsDto } from './aws-key-based-credentials-dto';
+import { AWSRoleBasedCredentials } from './aws-role-based-credentials';
 import { CertificateCredentials } from './certificate-credentials';
 import * as _CredentialAccessDataTransformation from './credential-access-data.transformation';
 import { Credentials } from './credentials';
@@ -5,10 +7,14 @@ import * as _CredentialsScopeTransformation from './credentials-scope.transforma
 import * as _CredentialsScopesItemTransformation from './credentials-scopes-item.transformation';
 import * as _CredentialsTypeTransformation from './credentials-type.transformation';
 import { PublicCertificateCredentials } from './public-certificate-credentials';
+import { SNMPV3Credentials } from './snmpv3-credentials';
 import { TokenCredentials } from './token-credentials';
 import { UserPasswordCredentials } from './user-password-credentials';
+export declare function isAwsKeyBasedCredentialsDto($model: Credentials): $model is AWSKeyBasedCredentialsDto;
+export declare function isAwsRoleBasedCredentials($model: Credentials): $model is AWSRoleBasedCredentials;
 export declare function isCertificateCredentials($model: Credentials): $model is CertificateCredentials;
 export declare function isPublicCertificateCredentials($model: Credentials): $model is PublicCertificateCredentials;
+export declare function isSnmpv3Credentials($model: Credentials): $model is SNMPV3Credentials;
 export declare function isTokenCredentials($model: Credentials): $model is TokenCredentials;
 export declare function isUserPasswordCredentials($model: Credentials): $model is UserPasswordCredentials;
 export interface AsJson {

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

@@ -1,3 +1,7 @@
+export * from './aws-key-based-credentials-dto';
+export * as _AWSKeyBasedCredentialsDtoTransformation from './aws-key-based-credentials-dto.transformation';
+export * from './aws-role-based-credentials';
+export * as _AWSRoleBasedCredentialsTransformation from './aws-role-based-credentials.transformation';
 export * from './abstract-credentials-response-element';
 export * as _AbstractCredentialsResponseElementTransformation from './abstract-credentials-response-element.transformation';
 export * from './abstract-credentials-response-element-scope';
@@ -876,6 +880,8 @@ export * from './slo-status';
 export * as _SLOStatusTransformation from './slo-status.transformation';
 export * from './sl-os';
 export * as _SLOsTransformation from './sl-os.transformation';
+export * from './snmpv3-credentials';
+export * as _SNMPV3CredentialsTransformation from './snmpv3-credentials.transformation';
 export * from './schema-constraint-rest-dto';
 export * as _SchemaConstraintRestDtoTransformation from './schema-constraint-rest-dto.transformation';
 export * from './schema-constraint-rest-dto-type';

package/types/packages/client/classic-environment-v2/src/lib/models/list-credentials-query-type.d.ts

@@ -2,5 +2,7 @@ export declare enum ListCredentialsQueryType {
     Certificate = "CERTIFICATE",
     UsernamePassword = "USERNAME_PASSWORD",
     Token = "TOKEN",
-    Snmpv3 = "SNMPV3"
+    Snmpv3 = "SNMPV3",
+    AwsKeyBased = "AWS_KEY_BASED",
+    AwsRoleBased = "AWS_ROLE_BASED"
 }

package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.d.ts

@@ -10,6 +10,10 @@ export interface MetricMetadataDto {
      * The name of the metric in the user interface
      */
     displayName?: string;
+    /**
+     * Interval value (numeric or variable reference) defined for this metric on subgroup level
+     */
+    metricInterval?: string;
     /**
      * The unit of the metric
      */

package/types/packages/client/classic-environment-v2/src/lib/models/metric-metadata-dto.transformation.d.ts

@@ -2,6 +2,7 @@ import { MetricMetadataDto } from './metric-metadata-dto';
 export interface AsJson {
     description?: string;
     displayName?: string;
+    metricInterval?: string;
     unit?: string;
 }
 export declare function fromJson($model: AsJson): MetricMetadataDto;

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

@@ -0,0 +1,30 @@
+import { Credentials } from './credentials';
+/**
+ * A credentials set of the `SNMPV3` type.
+ */
+export interface SNMPV3Credentials extends Credentials {
+    /**
+     * The authentication password in the string format (should not be empty for AUTH_PRIV and AUTH_NO_PRIV security levels)
+     */
+    authenticationPassword?: string;
+    /**
+     * The authentication protocol, supported protocols: MD5, SHA, SHA224, SHA256, SHA384, SHA512
+     */
+    authenticationProtocol?: string;
+    /**
+     * The privacy password in the string format (should not be empty for AUTH_PRIV security level)
+     */
+    privacyPassword?: string;
+    /**
+     * The privacy protocol
+     */
+    privacyProtocol?: string;
+    /**
+     * The security level, supported levels: AUTH_PRIV, NO_AUTH_NO_PRIV, AUTH_NO_PRIV
+     */
+    securityLevel?: string;
+    /**
+     * User name value
+     */
+    username?: string;
+}

package/types/packages/client/classic-environment-v2/src/lib/models/snmpv3-credentials.transformation.d.ts

@@ -0,0 +1,12 @@
+import * as _CredentialsTransformation from './credentials.transformation';
+import { SNMPV3Credentials } from './snmpv3-credentials';
+export interface AsJson extends _CredentialsTransformation.AsJson {
+    authenticationPassword?: string;
+    authenticationProtocol?: string;
+    privacyPassword?: string;
+    privacyProtocol?: string;
+    securityLevel?: string;
+    username?: string;
+}
+export declare function fromJson($model: AsJson): SNMPV3Credentials;
+export declare function toJson($model: SNMPV3Credentials): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.d.ts

@@ -21,7 +21,7 @@ export interface SyntheticLocation {
     /**
      * The Dynatrace entity ID of the location.
      */
-    entityId: string;
+    entityId?: string;
     /**
      * The Dynatrace GeoLocation ID of the location.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-location.transformation.d.ts

@@ -8,7 +8,7 @@ export declare function isPublicSyntheticLocation($model: SyntheticLocation): $m
 export interface AsJson {
     city?: string;
     countryCode?: string;
-    entityId: string;
+    entityId?: string;
     geoLocationId?: string;
     latitude: number;
     longitude: number;

package/types/packages/client/classic-environment-v2/src/lib/utils/encoding.d.ts

@@ -7,4 +7,4 @@ export declare enum Encoding {
     Binary = "binary",
     FormData = "form-data"
 }
-export declare function mimeTypeToEncoding(mimeType: string): Encoding;
+export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/shared-errors/src/api-client-error.d.ts

@@ -1,6 +1,6 @@
 import { ErrorType } from './types';
 /**
- * Error base. All client errors should extend this class.
+ * Base error for all client SDKs. All other errors extend this class.
  */
 export declare class ApiClientError extends Error {
     readonly cause?: any;
@@ -8,4 +8,16 @@ export declare class ApiClientError extends Error {
     errorType: ErrorType;
     constructor(name: string, message?: string, cause?: any);
 }
+/**
+ * ApiClientError type guard function.
+ * Does a structural check of the passed object.
+ * @example
+ * try {
+ *   doSomething();
+ * } catch (e: unknown) {
+ *   if(isApiClientError(e)) {
+ *     handleTheError();
+ *   }
+ * }
+ */
 export declare function isApiClientError(e: any): e is ApiClientError;

package/types/packages/shared-errors/src/api-gateway-error.d.ts

@@ -4,15 +4,34 @@ import { CommonApiError, CommonErrorDetails, ErrorResponseBody } from './types';
 export type ApiGatewayErrorResponseBody = ErrorResponseBody<CommonApiError<ApiGatewayErrorDetails> & {
     retryAfterSeconds?: number;
 }>;
+/**
+ * Reference for *ApiGatewayError* details object. Contains information about received API Getaway error.
+ * */
 export interface ApiGatewayErrorDetails extends CommonErrorDetails {
     errorCodeProperties?: {
         [key: string]: string;
     };
 }
+/**
+ * Dedicated error response class for errors thrown by API Gateway.
+ * Autogenerated SDK Clients have built-in handler for API Gateway errors that throws this error.
+ */
 export declare class ApiGatewayError extends ClientRequestError<ApiGatewayErrorResponseBody> {
     readonly isApiGatewayError = true;
     readonly code: number;
     readonly retryAfterSeconds: number | undefined;
     constructor(response: HttpClientResponse, body: ApiGatewayErrorResponseBody);
 }
+/**
+ * APIGatewayError type guard function.
+ * Does a structural check of the passed object.
+ * @example
+ * try {
+ *   doSomething();
+ * } catch (e: unknown) {
+ *   if(isApiClientError(e)) {
+ *     handleTheError();
+ *   }
+ * }
+ */
 export declare function isApiGatewayError(e: any): e is ApiGatewayError;

package/types/packages/shared-errors/src/client-request-error.d.ts

@@ -1,10 +1,39 @@
 import { HttpClientResponse } from '@dynatrace-sdk/http-client';
 import { ApiClientError } from './api-client-error';
 import { ErrorResponseBody } from './types';
+/**
+ * Generic error class for service errors, used to handle both expected and unexpected service-level errors.
+ * @example Handling unexpected error response, received by the SDK Client
+ * const responseValue = await response.body('json');
+ *
+ * throw new ClientRequestError(
+ *   `${response.status}`,
+ *   response,
+ *   responseValue,
+ *   getErrorMessage(
+ *     responseValue,
+ *     `Unexpected api response: code=${response.status} body="${responseValue}"`,
+ *   ),
+ *   e,
+ * );
+ *
+ */
 export declare class ClientRequestError<DTO = ErrorResponseBody> extends ApiClientError {
     readonly isClientRequestError = true;
     body: DTO;
     response: HttpClientResponse;
     constructor(name: string, response: HttpClientResponse, body: DTO, message?: string, cause?: any);
 }
+/**
+ * ClientRequestError type guard function.
+ * Does a structural check of the passed object.
+ * @example
+ * try {
+ *   doSomething();
+ * } catch (e: unknown) {
+ *   if(isClientRequestError(e)) {
+ *     handleTheError();
+ *   }
+ * }
+ */
 export declare function isClientRequestError(e: any): e is ClientRequestError;

package/types/packages/shared-errors/src/index.d.ts

@@ -2,5 +2,4 @@ export * from './api-client-error';
 export * from './api-gateway-error';
 export * from './client-request-error';
 export * from './invalid-response-error';
-export * from './sdk-error';
 export * from './types';

package/types/packages/shared-errors/src/invalid-response-error.d.ts

@@ -1,9 +1,26 @@
 import { ApiClientError } from './api-client-error';
+/**
+ * Dedicated error class for errors related to response serialization.
+ * Thrown when received service response can't be deserialized.
+ **/
 export declare class InvalidResponseError extends ApiClientError {
     readonly isInvalidResponseError = true;
     responseBody: any;
     expectedType?: string;
     nestedError?: Error;
-    constructor(name: string, nestedError: Error | any | undefined, body: any, expectedType?: string, message?: string);
+    response: any;
+    constructor(name: string, nestedError: Error | any | undefined, body: any, expectedType?: string, message?: string, response?: any);
 }
+/**
+ * InvalidResponseError type guard function.
+ * Does a structural check of the passed object.
+ * @example
+ * try {
+ *    doSomething();
+ * } catch (e: unknown) {
+ *    if (isInvalidResponseError(e)) {
+ *      throw e;
+ *    }
+ * }
+ */
 export declare function isInvalidResponseError(e: any): e is InvalidResponseError;

package/types/packages/shared-errors/src/types.d.ts

@@ -1,31 +1,88 @@
-/**
- * Possible serialized error types
- * `COMMON`: Common JS error
- * `HTTP`: Error thrown by a http-client
- */
+/** @ignore*/
 export declare enum ErrorType {
     COMMON = "JS Error",
     HTTP = "Http Error"
 }
+/**
+ * Basic error envelope, that enforces all error to have mandatory "error" property.
+ * */
 export interface ErrorResponseBody<T = CommonApiError> {
+    /**
+     * *error* object must have two mandatory fields (*code, message*) and may have two additional fields (*help, details*):
+     * refer to the *CommonApiError* for more details.
+     * */
     error: T;
 }
+/**
+ * Common API error structure, established by Dynatrace API guidelines.
+ * */
 export interface CommonApiError<T extends Record<string, any> = Record<string, any>> {
+    /** The error code should be set to the HTTP error code by default.<br>
+     * The error code may be set to an API-specific error code which must be properly documented.*/
     code: number;
+    /** The error message should be short and precise, it should not contain details.*/
     message: string;
+    /**
+     * An additional help field may be added which must be a URL to further information on how to deal with the error.<br>
+     * This may be some detailed error documentation page or a link to the Dynatrace support system, etc.
+     * */
     help?: string;
+    /**
+     * Additional details about the error may be added in a details field.
+     * Refer to *CommonErrorDetails*
+     * */
     details?: T;
 }
+/**
+ * *CommonApiError* details object reference. Contains common API error information.
+ *  This object is used to convey additional information about the error like e.g., which query parameter exactly violated a precondition. <br>
+ *  Details may contain any fields to further describe the error
+ * */
 export interface CommonErrorDetails {
+    /**
+     * UUID string that represents a reference of the error into e.g., the log file of the service.
+     * */
     errorRef?: string;
+    /**
+     * String containing a 32-character hex integer value that is used for tracing.
+     * */
     traceId?: string;
+    /**
+     * String value representing a more detailed error information than the http response code alone.
+     * Must be a single word in CamelCase, and all possible values must be documented.
+     * */
     errorCode?: string;
+    /**
+     * An array of *ConstraintViolation* object, refer to ConstraintViolation object reference for more details.
+     * */
     constraintViolations?: ConstraintViolation[];
+    /**
+     * Must be an array of strings containing a complete list of missing IAM scopes necessary to successfully execute the request.
+     * Should be set if the API returns a 403 - Forbidden response in case of missing OAuth scopes.
+     * */
     missingScopes?: string[];
+    /**
+     * Must be an array of strings containing a complete list of missing IAM permissions necessary to successfully execute the request.
+     * Should be set if the API returns a 403 - Forbidden response in case of missing OAuth user permissions.
+     * */
     missingPermissions?: string[];
 }
+/**
+ * Contains information about an input parameter (path, query or request body)
+ * that violated some validation rule of the service API and caused the warning.<br>
+ * May contain additional fields further describing the warning.
+ * */
 export interface ConstraintViolation extends Record<string, string | undefined> {
+    /**
+     * Mandatory field message describing the warning.
+     * */
     message: string;
+    /**
+     * Describes the general location of the violating parameter (query parameter, request body, etc.)
+     */
     parameterLocation?: string;
+    /**
+     * Refers to the violating parameter within the parameterLocation.
+     */
     path?: string;
 }

package/types/packages/shared-errors/src/sdk-error.d.ts

@@ -1,5 +0,0 @@
-export declare class SDKError extends Error {
-    cause?: Error | undefined;
-    name: string;
-    constructor(message: string, cause?: Error | undefined);
-}