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

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/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,9 +1,10 @@
-import { ErrorType } from '@dynatrace-sdk/error-handlers';
+import { ErrorType } from './types';
 /**
  * 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);
 }

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,8 +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/{client/classic-environment-v2/src/lib/error-envelopes → shared-errors/src}/invalid-response-error.d.ts

@@ -1,5 +1,6 @@
 import { ApiClientError } from './api-client-error';
 export declare class InvalidResponseError extends ApiClientError {
+    readonly isInvalidResponseError = true;
     responseBody: any;
     expectedType?: string;
     nestedError?: Error;

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

package/types/packages/client/classic-environment-v2/src/lib/apis/settings-privacy-operations-sync-api-api.d.ts

@@ -1,64 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { PaginatedPersonalDataResponse } from '../models/paginated-personal-data-response';
-import { PersonalDataRequest } from '../models/personal-data-request';
-/**
- * Enables synchronous export and deletion of personal data from Settings 2.0 Platform
- */
-export declare class SettingsPrivacyOperationsSyncApiClient {
-    private httpClient;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a SettingsPrivacyOperationsSyncApiClient. Custom http client should implement {HttpClient} interface.
-     * @example
-     * const settingsPrivacyOperationsSyncApiClientNodeJs = new SettingsPrivacyOperationsSyncApiClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient);
-    /**
-     * Export all internal personal data the Settings 2.0 Platform stores for the specified user
-     *
-     * **Required scope:** settings:operations.privacy:read<br/>**Required permission:** settings:operations.privacy:read<br/><br/>Export all internal personal data the Settings 2.0 Platform stores for the specified user in a paged response.
-     * The amount of elements in a single response page is limited to 100.
-     *
-     * @returns Success
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsPrivacyOperationsSyncApiClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsPrivacyOperationsSyncApiClient.exportPersonalDataSync(
-     *     {
-     *       body: {
-     *         email: "user@foo.com",
-     *         userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
-     *       },
-     *     },
-     *   );
-     */
-    exportPersonalDataSync(config: {
-        body: PersonalDataRequest;
-        /** The page to retrieve (optional; if not set, a PersonalDataRequestDto must be provided and the first page of data will be returned) */ pageKey?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<PaginatedPersonalDataResponse>;
-    /**
-     * Delete all internal personal data the Settings 2.0 Platform stores for the specified user
-     *
-     * **Required scope:** settings:operations.privacy:write<br/>**Required permission:** settings:operations.privacy:write
-     *
-     * @example <caption>Code example</caption>
-     * import { settingsPrivacyOperationsSyncApiClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data =
-     *   await settingsPrivacyOperationsSyncApiClient.deletePersonalDataSync(
-     *     {
-     *       body: {
-     *         email: "user@foo.com",
-     *         userId: "da7d78b7-4e94-46d4-b76d-934eff92af9a",
-     *       },
-     *     },
-     *   );
-     */
-    deletePersonalDataSync(config: {
-        body: PersonalDataRequest;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-}
-export declare const settingsPrivacyOperationsSyncApiClient: SettingsPrivacyOperationsSyncApiClient;

package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.d.ts

@@ -1,10 +0,0 @@
-import { Schema } from './schema';
-/**
- * The data of the response payload to the personal data request.
- */
-export interface PaginatedPersonalDataResponseData {
-    /**
-     * The list of settings schemas containing personal data.
-     */
-    schemas: Schema[];
-}

package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response-data.transformation.d.ts

@@ -1,7 +0,0 @@
-import { PaginatedPersonalDataResponseData } from './paginated-personal-data-response-data';
-import * as _SchemaTransformation from './schema.transformation';
-export interface AsJson {
-    schemas: _SchemaTransformation.AsJson[];
-}
-export declare function fromJson($model: AsJson): PaginatedPersonalDataResponseData;
-export declare function toJson($model: PaginatedPersonalDataResponseData): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.d.ts

@@ -1,11 +0,0 @@
-import { PaginatedPersonalDataResponseData } from './paginated-personal-data-response-data';
-/**
- * The response payload to the personal data request.
- */
-export interface PaginatedPersonalDataResponse {
-    data: PaginatedPersonalDataResponseData;
-    /**
-     * In case of paginated results, this contains the pageKey for the next page.
-     */
-    nextPageKey?: string;
-}

package/types/packages/client/classic-environment-v2/src/lib/models/paginated-personal-data-response.transformation.d.ts

@@ -1,8 +0,0 @@
-import { PaginatedPersonalDataResponse } from './paginated-personal-data-response';
-import * as _PaginatedPersonalDataResponseDataTransformation from './paginated-personal-data-response-data.transformation';
-export interface AsJson {
-    data: _PaginatedPersonalDataResponseDataTransformation.AsJson;
-    nextPageKey?: string;
-}
-export declare function fromJson($model: AsJson): PaginatedPersonalDataResponse;
-export declare function toJson($model: PaginatedPersonalDataResponse): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/personal-data-request.d.ts

@@ -1,13 +0,0 @@
-/**
- * The request payload for the exporting personal data
- */
-export interface PersonalDataRequest {
-    /**
-     * User's e-mail
-     */
-    email: string;
-    /**
-     * IAM user UUID
-     */
-    userId: string;
-}

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

@@ -1,7 +0,0 @@
-import { PersonalDataRequest } from './personal-data-request';
-export interface AsJson {
-    email: string;
-    userId: string;
-}
-export declare function fromJson($model: AsJson): PersonalDataRequest;
-export declare function toJson($model: PersonalDataRequest): AsJson;

package/types/packages/client/classic-environment-v2/src/lib/models/pii-relationships-item.d.ts

@@ -1,6 +0,0 @@
-export declare enum PiiRelationshipsItem {
-    Creator = "CREATOR",
-    LastModifier = "LAST_MODIFIER",
-    Modifier = "MODIFIER",
-    Owner = "OWNER"
-}

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

@@ -1,4 +0,0 @@
-import { PiiRelationshipsItem } from './pii-relationships-item';
-export type AsJson = string;
-export declare function fromJson($model: AsJson): PiiRelationshipsItem;
-export declare function toJson($model: PiiRelationshipsItem): AsJson;

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

@@ -1,10 +0,0 @@
-import { PiiRelationshipsItem } from './pii-relationships-item';
-/**
- * The information about relationships of the user to the settings object.
- */
-export interface Pii {
-    /**
-     * A list of user relationships.
-     */
-    relationships: PiiRelationshipsItem[];
-}

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

@@ -1,7 +0,0 @@
-import { Pii } from './pii';
-import * as _PiiRelationshipsItemTransformation from './pii-relationships-item.transformation';
-export interface AsJson {
-    relationships: _PiiRelationshipsItemTransformation.AsJson[];
-}
-export declare function fromJson($model: AsJson): Pii;
-export declare function toJson($model: Pii): AsJson;

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

@@ -1,18 +0,0 @@
-import { Value } from './value';
-/**
- * The information about settings schema containing personal data.
- */
-export interface Schema {
-    /**
-     * The name of the schema.
-     */
-    displayName: string;
-    /**
-     * The ID of the schema.
-     */
-    id: string;
-    /**
-     * The list of settings values containing personal data.
-     */
-    values: Value[];
-}

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

@@ -1,9 +0,0 @@
-import { Schema } from './schema';
-import * as _ValueTransformation from './value.transformation';
-export interface AsJson {
-    displayName: string;
-    id: string;
-    values: _ValueTransformation.AsJson[];
-}
-export declare function fromJson($model: AsJson): Schema;
-export declare function toJson($model: Schema): AsJson;

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

@@ -1,15 +0,0 @@
-import { Pii } from './pii';
-/**
- * The information about settings value containing personal data.
- */
-export interface Value {
-    /**
-     * A short summary of the settings object. This can contain Markdown and will be escaped accordingly.
-     */
-    displayName?: string;
-    /**
-     * The ID of the settings object.
-     */
-    objectId: string;
-    pii: Pii;
-}

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

@@ -1,9 +0,0 @@
-import * as _PiiTransformation from './pii.transformation';
-import { Value } from './value';
-export interface AsJson {
-    displayName?: string;
-    objectId: string;
-    pii: _PiiTransformation.AsJson;
-}
-export declare function fromJson($model: AsJson): Value;
-export declare function toJson($model: Value): AsJson;