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

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

@@ -4,6 +4,9 @@ import { VulnerableFunctionProcessGroupsUsage } from './vulnerable-function-proc
  * A vulnerable function including its usage by specific process groups in context of the security problem.
  */
 export interface VulnerableFunctionProcessGroups {
+    /**
+     * Defines an vulnerable function.
+     */
     function?: VulnerableFunction;
     /**
      * The process group identifiers, where this vulnerable function is in use.
@@ -17,5 +20,11 @@ export interface VulnerableFunctionProcessGroups {
      * The process group identifiers, where this vulnerable function is not in use.
      */
     processGroupsNotInUse?: string[];
+    /**
+     * The vulnerable function usage based on the given process groups:
+     * * 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.
+     */
     usage?: VulnerableFunctionProcessGroupsUsage;
 }

package/types/packages/http-client/src/lib/types/binary.d.ts

@@ -8,8 +8,8 @@ export interface Binary {
      *
      * @param type  The type of the data.
      * Can be `text`, `json`, `array-buffer`, `blob`, `readable-stream`, `buffer` or `stream`.
-     * @throws DataTypeError when the data does not conform to the specified type.
-     * @throws UnsupportedOperationError when the type is not supported by the platform.
+     * @throws {DataTypeError} Data does not conform to the specified type.
+     * @throws {UnsupportedOperationError} Type is not supported by the platform.
      */
     get<T extends keyof DataTypes>(type: T): DataTypes[T];
 }

package/types/packages/http-client/src/lib/types/http-client-response.d.ts

@@ -26,8 +26,8 @@ export interface HttpClientResponse {
      * @param responseBodyType  The type of the response body.
      * Can be `text`, `json`, `binary`, `form-data`, `array-buffer`, `blob`, `readable-stream`, `buffer` or `stream`.
      * The default response body type is `json`.
-     * @throws DataTypeError when the response body does not conform to the specified response body type.
-     * @throws UnsupportedOperationError when the response body type is not supported by the platform.
+     * @throws {DataTypeError} Response body does not conform to the specified response body type.
+     * @throws {UnsupportedOperationError} Response body type is not supported by the platform.
      */
     body<T extends keyof ResponseBodyTypes = 'json'>(responseBodyType?: T): ResponseBodyTypes[T];
 }

package/types/packages/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/api-client-error.d.ts

@@ -1,4 +1,4 @@
-import { ErrorType } from '@dynatrace-sdk/error-handlers';
+import { ErrorType } from './types';
 /**
  * Error base. All client errors should extend this class.
  */

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

@@ -0,0 +1,18 @@
+import { HttpClientResponse } from '@dynatrace-sdk/http-client';
+import { ClientRequestError } from './client-request-error';
+import { CommonApiError, CommonErrorDetails, ErrorResponseBody } from './types';
+export type ApiGatewayErrorResponseBody = ErrorResponseBody<CommonApiError<ApiGatewayErrorDetails> & {
+    retryAfterSeconds?: number;
+}>;
+export interface ApiGatewayErrorDetails extends CommonErrorDetails {
+    errorCodeProperties?: {
+        [key: string]: string;
+    };
+}
+export declare class ApiGatewayError extends ClientRequestError<ApiGatewayErrorResponseBody> {
+    readonly isApiGatewayError = true;
+    readonly code: number;
+    readonly retryAfterSeconds: number | undefined;
+    constructor(response: HttpClientResponse, body: ApiGatewayErrorResponseBody);
+}
+export declare function isApiGatewayError(e: any): e is ApiGatewayError;

package/types/packages/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/client-request-error.d.ts

@@ -1,9 +1,10 @@
 import { HttpClientResponse } from '@dynatrace-sdk/http-client';
 import { ApiClientError } from './api-client-error';
-export declare class ClientRequestError<DTO> extends ApiClientError {
+import { ErrorResponseBody } from './types';
+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);
 }
-export declare function isClientRequestError<DTO>(e: any): e is ClientRequestError<DTO>;
+export declare function isClientRequestError(e: any): e is ClientRequestError;

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

@@ -0,0 +1,6 @@
+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/sdk-error.d.ts

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

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

@@ -0,0 +1,31 @@
+/**
+ * Possible serialized error types
+ * `COMMON`: Common JS error
+ * `HTTP`: Error thrown by a http-client
+ */
+export declare enum ErrorType {
+    COMMON = "JS Error",
+    HTTP = "Http Error"
+}
+export interface ErrorResponseBody<T = CommonApiError> {
+    error: T;
+}
+export interface CommonApiError<T extends Record<string, any> = Record<string, any>> {
+    code: number;
+    message: string;
+    help?: string;
+    details?: T;
+}
+export interface CommonErrorDetails {
+    errorRef?: string;
+    traceId?: string;
+    errorCode?: string;
+    constraintViolations?: ConstraintViolation[];
+    missingScopes?: string[];
+    missingPermissions?: string[];
+}
+export interface ConstraintViolation extends Record<string, string | undefined> {
+    message: string;
+    parameterLocation?: string;
+    path?: string;
+}