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

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

@@ -3,6 +3,12 @@ import { TenantToken } from './tenant-token';
  * Configuration of a [tenant token](https://dt-url.net/b403ss9).
  */
 export interface TenantTokenConfig {
+    /**
+     * Tenant token
+     */
     active?: TenantToken;
+    /**
+     * Tenant token
+     */
     old?: TenantToken;
 }

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

@@ -4,6 +4,9 @@ import { ExternalVault } from './external-vault';
  * A credentials set of the `TOKEN` type.
  */
 export interface TokenCredentials extends Credentials {
+    /**
+     * Information for synchronization credentials with external vault
+     */
     externalVault?: ExternalVault;
     /**
      * Token in the string format.

package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-attack-request-header.d.ts

@@ -4,6 +4,9 @@ import { TruncationInfo } from './truncation-info';
  * A list of values that has possibly been truncated.
  */
 export interface TruncatableListAttackRequestHeader {
+    /**
+     * Information on a possible truncation.
+     */
     truncationInfo?: TruncationInfo;
     /**
      * Values of the list.

package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-http-request-parameter.d.ts

@@ -4,6 +4,9 @@ import { TruncationInfo } from './truncation-info';
  * A list of values that has possibly been truncated.
  */
 export interface TruncatableListHttpRequestParameter {
+    /**
+     * Information on a possible truncation.
+     */
     truncationInfo?: TruncationInfo;
     /**
      * Values of the list.

package/types/packages/client/classic-environment-v2/src/lib/models/truncatable-list-string.d.ts

@@ -3,6 +3,9 @@ import { TruncationInfo } from './truncation-info';
  * A list of values that has possibly been truncated.
  */
 export interface TruncatableListString {
+    /**
+     * Information on a possible truncation.
+     */
     truncationInfo?: TruncationInfo;
     /**
      * Values of the list.

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

@@ -6,8 +6,20 @@ import { UiTabsCustomization } from './ui-tabs-customization';
  * Customization for UI elements
  */
 export interface UiCustomization {
+    /**
+     * UI customization options for defining custom callbacks
+     */
     callback?: UiCallbackCustomization;
+    /**
+     * UI customization for expandable section
+     */
     expandable?: UiExpandableCustomization;
+    /**
+     * Customization for UI tables
+     */
     table?: UiTableCustomization;
+    /**
+     * UI customization for tabs
+     */
     tabs?: UiTabsCustomization;
 }

package/types/packages/client/classic-environment-v2/src/lib/models/ui-table-customization.d.ts

@@ -8,5 +8,8 @@ export interface UiTableCustomization {
      * A list of columns for the UI table
      */
     columns?: UiTableColumnCustomization[];
+    /**
+     * UI customization for empty state in a table
+     */
     emptyState?: UiEmptyStateCustomization;
 }

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

@@ -6,6 +6,9 @@ import { UpdateJobUpdateType } from './update-job-update-type';
  * Configuration of the ActiveGate update job.
  */
 export interface UpdateJob {
+    /**
+     * The type of the ActiveGate.
+     */
     agType?: UpdateJobAgType;
     /**
      * The job can (`true`) or can't (`false`) be cancelled at the moment.
@@ -27,6 +30,9 @@ export interface UpdateJob {
      * The ID of the update job.
      */
     jobId?: string;
+    /**
+     * The status of the update job.
+     */
     jobState?: UpdateJobJobState;
     /**
      * The initial version of the ActiveGate.
@@ -46,6 +52,12 @@ export interface UpdateJob {
      *  The `null` value means the job is still running.
      */
     timestamp?: number;
+    /**
+     * The method of updating the ActiveGate or its component.
+     */
     updateMethod?: UpdateJobUpdateMethod;
+    /**
+     * The component to be updated.
+     */
     updateType?: UpdateJobUpdateType;
 }

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

@@ -4,6 +4,9 @@ import { ExternalVault } from './external-vault';
  * A credentials set of the `USERNAME_PASSWORD` type.
  */
 export interface UserPasswordCredentials extends Credentials {
+    /**
+     * Information for synchronization credentials with external vault
+     */
     externalVault?: ExternalVault;
     /**
      * The password of the credential.

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

@@ -5,6 +5,9 @@ import { VulnerableFunctionInput } from './vulnerable-function-input';
  * Describes the exploited vulnerability.
  */
 export interface Vulnerability {
+    /**
+     * Information about a code location.
+     */
     codeLocation?: CodeLocation;
     /**
      * The display name of the vulnerability.
@@ -14,6 +17,12 @@ export interface Vulnerability {
      * The id of the vulnerability.
      */
     vulnerabilityId?: string;
+    /**
+     * Information about a function definition.
+     */
     vulnerableFunction?: FunctionDefinition;
+    /**
+     * Describes what got passed into the code level vulnerability.
+     */
     vulnerableFunctionInput?: VulnerableFunctionInput;
 }

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

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

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

@@ -8,5 +8,8 @@ export interface VulnerableFunctionInput {
      * A list of input segments.
      */
     inputSegments?: VulnerableFunctionInputSegment[];
+    /**
+     * The type of the input.
+     */
     type?: VulnerableFunctionInputType;
 }

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/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/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/shared-errors/src/api-client-error.d.ts

@@ -0,0 +1,23 @@
+import { ErrorType } from './types';
+/**
+ * Base error for all client SDKs. All other errors extend this class.
+ */
+export declare class ApiClientError extends Error {
+    readonly cause?: any;
+    readonly isApiClientError = true;
+    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

@@ -0,0 +1,37 @@
+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;
+}>;
+/**
+ * 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

@@ -0,0 +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

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

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

@@ -0,0 +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;
+    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

@@ -0,0 +1,88 @@
+/** @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/client/classic-environment-v2/src/lib/error-envelopes/api-client-error.d.ts

@@ -1,11 +0,0 @@
-import { ErrorType } from '@dynatrace-sdk/error-handlers';
-/**
- * Error base. All client errors should extend this class.
- */
-export declare class ApiClientError extends Error {
-    readonly cause?: any;
-    readonly isApiClientError = true;
-    errorType: ErrorType;
-    constructor(name: string, message?: string, cause?: any);
-}
-export declare function isApiClientError(e: any): e is ApiClientError;

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

@@ -1,9 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-import { ApiClientError } from './api-client-error';
-export declare class ClientRequestError<DTO> 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>;

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

@@ -1,9 +0,0 @@
-import { ApiClientError } from './api-client-error';
-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);
-}
-export declare function isInvalidResponseError(e: any): e is InvalidResponseError;