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

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

@@ -1,10 +1,7 @@
 import { ExecutionFullResults } from './execution-full-results';
 import { ExecutionSimpleResults } from './execution-simple-results';
 import { ObjectNode } from './object-node';
-import { SyntheticOnDemandExecutionExecutionStage } from './synthetic-on-demand-execution-execution-stage';
 import { SyntheticOnDemandExecutionMetadata } from './synthetic-on-demand-execution-metadata';
-import { SyntheticOnDemandExecutionProcessingMode } from './synthetic-on-demand-execution-processing-mode';
-import { SyntheticOnDemandExecutionSource } from './synthetic-on-demand-execution-source';
 /**
  * Describes the status of an on-demand execution.
  */
@@ -28,7 +25,7 @@ export interface SyntheticOnDemandExecution {
     /**
      * Execution stage.
      */
-    executionStage: SyntheticOnDemandExecutionExecutionStage;
+    executionStage: 'DATA_RETRIEVED' | 'EXECUTED' | 'NOT_TRIGGERED' | 'TIMED_OUT' | 'TRIGGERED' | 'WAITING';
     /**
      * The timestamp when execution was finished, in UTC milliseconds.
      */
@@ -56,7 +53,7 @@ export interface SyntheticOnDemandExecution {
     /**
      * The processing mode of the execution.
      */
-    processingMode: SyntheticOnDemandExecutionProcessingMode;
+    processingMode: 'DISABLE_PROBLEM_DETECTION' | 'EXECUTIONS_DETAILS_ONLY' | 'NONE' | 'STANDARD' | 'UNKNOWN';
     /**
      * The scheduling timestamp, in UTC milliseconds.
      */
@@ -68,7 +65,7 @@ export interface SyntheticOnDemandExecution {
     /**
      * The source of the triggering request.
      */
-    source: SyntheticOnDemandExecutionSource;
+    source: 'API' | 'UI';
     /**
      * The name of the user who triggered the on-demand execution.
      */

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.d.ts

@@ -1,5 +1,7 @@
 /**
  * Execution stage.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum SyntheticOnDemandFailedExecutionStatusExecutionStage {
     DataRetrieved = "DATA_RETRIEVED",

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status-execution-stage.transformation.d.ts

@@ -1,4 +1,3 @@
-import { SyntheticOnDemandFailedExecutionStatusExecutionStage } from './synthetic-on-demand-failed-execution-status-execution-stage';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): SyntheticOnDemandFailedExecutionStatusExecutionStage;
-export declare function toJson($model: SyntheticOnDemandFailedExecutionStatusExecutionStage): AsJson;
+export declare function fromJson($model: AsJson): 'DATA_RETRIEVED' | 'EXECUTED' | 'NOT_TRIGGERED' | 'TIMED_OUT' | 'TRIGGERED' | 'WAITING';
+export declare function toJson($model: 'DATA_RETRIEVED' | 'EXECUTED' | 'NOT_TRIGGERED' | 'TIMED_OUT' | 'TRIGGERED' | 'WAITING'): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-on-demand-failed-execution-status.d.ts

@@ -1,4 +1,3 @@
-import { SyntheticOnDemandFailedExecutionStatusExecutionStage } from './synthetic-on-demand-failed-execution-status-execution-stage';
 /**
  * Contains information about on-demand executions that failed or failed to be executed.
  */
@@ -14,7 +13,7 @@ export interface SyntheticOnDemandFailedExecutionStatus {
     /**
      * Execution stage.
      */
-    executionStage?: SyntheticOnDemandFailedExecutionStatusExecutionStage;
+    executionStage?: 'DATA_RETRIEVED' | 'EXECUTED' | 'NOT_TRIGGERED' | 'TIMED_OUT' | 'TRIGGERED' | 'WAITING';
     /**
      * The timestamp when execution was finished, in UTC milliseconds.
      */

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

@@ -35,7 +35,7 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      * * `STANDARD`: The location is deployed on Windows or Linux.
      * * `KUBERNETES`: The location is deployed on Kubernetes.
      */
-    deploymentType?: string;
+    deploymentType?: 'KUBERNETES' | 'OPENSHIFT' | 'STANDARD' | 'UNKNOWN';
     /**
      * The latitude of the location in `DDD.dddd` format.
      */
@@ -78,7 +78,7 @@ export interface SyntheticPrivateLocationUpdate extends SyntheticLocationUpdate
      * * `DISABLED`: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
      * * `HIDDEN`: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as `HIDDEN` when no monitor is assigned to it.
      */
-    status?: string;
+    status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
     /**
      * Boolean value describes which kubernetes version will be used:
      *

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

@@ -7,7 +7,7 @@ export interface AsJson extends _SyntheticLocationUpdateTransformation.AsJson {
     availabilityNotificationsEnabled?: boolean;
     city?: string;
     countryCode?: string;
-    deploymentType?: string;
+    deploymentType?: 'KUBERNETES' | 'OPENSHIFT' | 'STANDARD' | 'UNKNOWN';
     latitude?: number;
     locationNodeOutageDelayInMinutes?: number;
     longitude?: number;
@@ -15,7 +15,7 @@ export interface AsJson extends _SyntheticLocationUpdateTransformation.AsJson {
     name?: string;
     nodes?: string[];
     regionCode?: string;
-    status?: string;
+    status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
     useNewKubernetesVersion?: boolean;
 }
 export declare function fromJson($model: AsJson): SyntheticPrivateLocationUpdate;

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

@@ -10,5 +10,5 @@ export interface SyntheticPublicLocationUpdate extends SyntheticLocationUpdate {
      * * `DISABLED`: The location is displayed as inactive in the UI. You can't assign monitors to the location. Monitors already assigned to the location will stay there and will be executed from the location.
      * * `HIDDEN`: The location is not displayed in the UI. You can't assign monitors to the location. You can only set location as `HIDDEN` when no monitor is assigned to it.
      */
-    status?: string;
+    status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
 }

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

@@ -1,7 +1,7 @@
 import * as _SyntheticLocationUpdateTransformation from './synthetic-location-update.transformation';
 import { SyntheticPublicLocationUpdate } from './synthetic-public-location-update';
 export interface AsJson extends _SyntheticLocationUpdateTransformation.AsJson {
-    status?: string;
+    status?: 'DISABLED' | 'ENABLED' | 'HIDDEN';
 }
 export declare function fromJson($model: AsJson): SyntheticPublicLocationUpdate;
 export declare function toJson($model: SyntheticPublicLocationUpdate): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto-source.d.ts

@@ -1,5 +1,7 @@
 /**
  * The source of the tag, such as USER, RULE_BASED or AUTO.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum SyntheticTagWithSourceDtoSource {
     Auto = "AUTO",

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto-source.transformation.d.ts

@@ -1,4 +1,3 @@
-import { SyntheticTagWithSourceDtoSource } from './synthetic-tag-with-source-dto-source';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): SyntheticTagWithSourceDtoSource;
-export declare function toJson($model: SyntheticTagWithSourceDtoSource): AsJson;
+export declare function fromJson($model: AsJson): 'AUTO' | 'RULE_BASED' | 'USER';
+export declare function toJson($model: 'AUTO' | 'RULE_BASED' | 'USER'): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/synthetic-tag-with-source-dto.d.ts

@@ -1,4 +1,3 @@
-import { SyntheticTagWithSourceDtoSource } from './synthetic-tag-with-source-dto-source';
 /**
  * The tag with source of a monitored entity.
  */
@@ -16,7 +15,7 @@ export interface SyntheticTagWithSourceDto {
     /**
      * The source of the tag, such as USER, RULE_BASED or AUTO.
      */
-    source?: SyntheticTagWithSourceDtoSource;
+    source?: 'AUTO' | 'RULE_BASED' | 'USER';
     /**
      * The value of the tag.
      */

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

@@ -1,5 +1,7 @@
 /**
  * The type of the ActiveGate.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum UpdateJobAgType {
     Cluster = "CLUSTER",

package/types/packages/client/classic-environment-v2/src/lib/models/update-job-ag-type.transformation.d.ts

@@ -1,4 +1,3 @@
-import { UpdateJobAgType } from './update-job-ag-type';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): UpdateJobAgType;
-export declare function toJson($model: UpdateJobAgType): AsJson;
+export declare function fromJson($model: AsJson): 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
+export declare function toJson($model: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI'): AsJson;

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

@@ -1,5 +1,7 @@
 /**
  * The status of the update job.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum UpdateJobJobState {
     Failed = "FAILED",

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

@@ -1,4 +1,3 @@
-import { UpdateJobJobState } from './update-job-job-state';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): UpdateJobJobState;
-export declare function toJson($model: UpdateJobJobState): AsJson;
+export declare function fromJson($model: AsJson): 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED';
+export declare function toJson($model: 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED'): AsJson;

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

@@ -1,5 +1,7 @@
 /**
  * The method of updating the ActiveGate or its component.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum UpdateJobUpdateMethod {
     Automatic = "AUTOMATIC",

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

@@ -1,4 +1,3 @@
-import { UpdateJobUpdateMethod } from './update-job-update-method';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): UpdateJobUpdateMethod;
-export declare function toJson($model: UpdateJobUpdateMethod): AsJson;
+export declare function fromJson($model: AsJson): 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND';
+export declare function toJson($model: 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND'): AsJson;

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

@@ -1,5 +1,7 @@
 /**
  * The component to be updated.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum UpdateJobUpdateType {
     ActiveGate = "ACTIVE_GATE",

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

@@ -1,4 +1,3 @@
-import { UpdateJobUpdateType } from './update-job-update-type';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): UpdateJobUpdateType;
-export declare function toJson($model: UpdateJobUpdateType): AsJson;
+export declare function fromJson($model: AsJson): 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
+export declare function toJson($model: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE'): AsJson;

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

@@ -1,7 +1,3 @@
-import { UpdateJobAgType } from './update-job-ag-type';
-import { UpdateJobJobState } from './update-job-job-state';
-import { UpdateJobUpdateMethod } from './update-job-update-method';
-import { UpdateJobUpdateType } from './update-job-update-type';
 /**
  * Configuration of the ActiveGate update job.
  */
@@ -9,7 +5,7 @@ export interface UpdateJob {
     /**
      * The type of the ActiveGate.
      */
-    agType?: UpdateJobAgType;
+    agType?: 'CLUSTER' | 'ENVIRONMENT' | 'ENVIRONMENT_MULTI';
     /**
      * The job can (`true`) or can't (`false`) be cancelled at the moment.
      */
@@ -33,7 +29,7 @@ export interface UpdateJob {
     /**
      * The status of the update job.
      */
-    jobState?: UpdateJobJobState;
+    jobState?: 'FAILED' | 'IN_PROGRESS' | 'PENDING' | 'ROLLBACK' | 'SCHEDULED' | 'SKIPPED' | 'SUCCEED';
     /**
      * The initial version of the ActiveGate.
      */
@@ -55,9 +51,9 @@ export interface UpdateJob {
     /**
      * The method of updating the ActiveGate or its component.
      */
-    updateMethod?: UpdateJobUpdateMethod;
+    updateMethod?: 'AUTOMATIC' | 'MANUAL_INSTALLATION' | 'ON_DEMAND';
     /**
      * The component to be updated.
      */
-    updateType?: UpdateJobUpdateType;
+    updateType?: 'ACTIVE_GATE' | 'REMOTE_PLUGIN_AGENT' | 'SYNTHETIC' | 'Z_REMOTE';
 }

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment-type.d.ts

@@ -1,5 +1,7 @@
 /**
  * The type of the input segment.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum VulnerableFunctionInputSegmentType {
     MaliciousInput = "MALICIOUS_INPUT",

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment-type.transformation.d.ts

@@ -1,4 +1,3 @@
-import { VulnerableFunctionInputSegmentType } from './vulnerable-function-input-segment-type';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): VulnerableFunctionInputSegmentType;
-export declare function toJson($model: VulnerableFunctionInputSegmentType): AsJson;
+export declare function fromJson($model: AsJson): 'MALICIOUS_INPUT' | 'REGULAR_INPUT' | 'TAINTED_INPUT';
+export declare function toJson($model: 'MALICIOUS_INPUT' | 'REGULAR_INPUT' | 'TAINTED_INPUT'): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-segment.d.ts

@@ -1,4 +1,3 @@
-import { VulnerableFunctionInputSegmentType } from './vulnerable-function-input-segment-type';
 /**
  * Describes one segment that was passed into a vulnerable function.
  */
@@ -6,7 +5,7 @@ export interface VulnerableFunctionInputSegment {
     /**
      * The type of the input segment.
      */
-    type?: VulnerableFunctionInputSegmentType;
+    type?: 'MALICIOUS_INPUT' | 'REGULAR_INPUT' | 'TAINTED_INPUT';
     /**
      * The value of the input segment.
      */

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

@@ -1,5 +1,7 @@
 /**
  * The type of the input.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum VulnerableFunctionInputType {
     Command = "COMMAND",

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input-type.transformation.d.ts

@@ -1,4 +1,3 @@
-import { VulnerableFunctionInputType } from './vulnerable-function-input-type';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): VulnerableFunctionInputType;
-export declare function toJson($model: VulnerableFunctionInputType): AsJson;
+export declare function fromJson($model: AsJson): 'COMMAND' | 'HTTP_CLIENT' | 'JNDI' | 'SQL_STATEMENT';
+export declare function toJson($model: 'COMMAND' | 'HTTP_CLIENT' | 'JNDI' | 'SQL_STATEMENT'): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-input.d.ts

@@ -1,5 +1,4 @@
 import { VulnerableFunctionInputSegment } from './vulnerable-function-input-segment';
-import { VulnerableFunctionInputType } from './vulnerable-function-input-type';
 /**
  * Describes what got passed into the code level vulnerability.
  */
@@ -11,5 +10,5 @@ export interface VulnerableFunctionInput {
     /**
      * The type of the input.
      */
-    type?: VulnerableFunctionInputType;
+    type?: 'COMMAND' | 'HTTP_CLIENT' | 'JNDI' | 'SQL_STATEMENT';
 }

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups-usage.d.ts

@@ -3,6 +3,8 @@
  * * IN_USE if at least one process group calls this vulnerable function.
  * * NOT_IN_USE if all process groups do not call this vulnerable function.
  * * NOT_AVAILABLE if vulnerable function usage could not be calculated for at least one process group and no process group calls this vulnerable function.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum VulnerableFunctionProcessGroupsUsage {
     InUse = "IN_USE",

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups-usage.transformation.d.ts

@@ -1,4 +1,3 @@
-import { VulnerableFunctionProcessGroupsUsage } from './vulnerable-function-process-groups-usage';
 export type AsJson = string;
-export declare function fromJson($model: AsJson): VulnerableFunctionProcessGroupsUsage;
-export declare function toJson($model: VulnerableFunctionProcessGroupsUsage): AsJson;
+export declare function fromJson($model: AsJson): 'IN_USE' | 'NOT_AVAILABLE' | 'NOT_IN_USE';
+export declare function toJson($model: 'IN_USE' | 'NOT_AVAILABLE' | 'NOT_IN_USE'): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/vulnerable-function-process-groups.d.ts

@@ -1,5 +1,4 @@
 import { VulnerableFunction } from './vulnerable-function';
-import { VulnerableFunctionProcessGroupsUsage } from './vulnerable-function-process-groups-usage';
 /**
  * A vulnerable function including its usage by specific process groups in context of the security problem.
  */
@@ -26,5 +25,5 @@ export interface VulnerableFunctionProcessGroups {
      * * NOT_IN_USE if all process groups do not call this vulnerable function.
      * * NOT_AVAILABLE if vulnerable function usage could not be calculated for at least one process group and no process group calls this vulnerable function.
      */
-    usage?: VulnerableFunctionProcessGroupsUsage;
+    usage?: 'IN_USE' | 'NOT_AVAILABLE' | 'NOT_IN_USE';
 }

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);
-}