@dynatrace-sdk/client-classic-environment-v2 3.7.2 → 3.7.3

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts

@@ -1,4 +1,5 @@
 import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ApiClientOptions } from '@dynatrace-sdk/shared-client-utils';
 import { Node } from '../models/node';
 import { Nodes } from '../models/nodes';
 import { PrivateSyntheticLocation } from '../models/private-synthetic-location';
@@ -8,7 +9,6 @@ import { SyntheticLocationIdsDto } from '../models/synthetic-location-ids-dto';
 import { SyntheticLocationUpdate } from '../models/synthetic-location-update';
 import { SyntheticLocations } from '../models/synthetic-locations';
 import { SyntheticPublicLocationsStatus } from '../models/synthetic-public-locations-status';
-import { ApiClientOptions } from './api-client-options';
 export declare class SyntheticLocationsNodesAndConfigurationClient {
     private httpClient;
     private shouldTransformDates;
@@ -106,7 +106,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *         longitude: 10,
      *         name: "...",
      *         nodes: ["..."],
-     *         type: PrivateSyntheticLocationType.Cluster,
+     *         type: "CLUSTER",
      *       },
      *     },
      *   );
@@ -221,10 +221,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
      *
      * const data =
      *   await syntheticLocationsNodesAndConfigurationClient.updateLocation(
-     *     {
-     *       locationId: "...",
-     *       body: { type: SyntheticLocationUpdateType.Private },
-     *     },
+     *     { locationId: "...", body: { type: "PRIVATE" } },
      *   );
      *
      * @throws {ErrorEnvelopeError} Client side error. | Server side error.

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-network-availability-monitors-api.d.ts

@@ -1,9 +1,9 @@
 import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ApiClientOptions } from '@dynatrace-sdk/shared-client-utils';
 import { MonitorEntityIdDto } from '../models/monitor-entity-id-dto';
 import { SyntheticMonitorListDto } from '../models/synthetic-monitor-list-dto';
 import { SyntheticMultiProtocolMonitorDto } from '../models/synthetic-multi-protocol-monitor-dto';
 import { SyntheticMultiProtocolMonitorUpdateDto } from '../models/synthetic-multi-protocol-monitor-update-dto';
-import { ApiClientOptions } from './api-client-options';
 /**
  * Create, read, update and delete synthetic monitors. Currently network availability monitors only.
  */

package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-on-demand-monitor-executions-api.d.ts

@@ -1,10 +1,10 @@
 import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
+import { ApiClientOptions } from '@dynatrace-sdk/shared-client-utils';
 import { SyntheticOnDemandBatchStatus } from '../models/synthetic-on-demand-batch-status';
 import { SyntheticOnDemandExecution } from '../models/synthetic-on-demand-execution';
 import { SyntheticOnDemandExecutionRequest } from '../models/synthetic-on-demand-execution-request';
 import { SyntheticOnDemandExecutionResult } from '../models/synthetic-on-demand-execution-result';
 import { SyntheticOnDemandExecutions } from '../models/synthetic-on-demand-executions';
-import { ApiClientOptions } from './api-client-options';
 /**
  * Trigger and view information about on-demand synthetic monitor executions
  */

package/types/packages/{client/classic-environment-v2/src/lib/apis → shared-client-utils/src}/api-client-options.d.ts

@@ -1,5 +1,5 @@
 /**
- * Configuration for generated TypeScript SDK clients
+ * Configuration for the API client.
  * @param {boolean} transformDates - Flag to control date transformations, enabled by default.
  */
 export interface ApiClientOptions {

package/types/packages/shared-client-utils/src/api-gateway-errors-handler.d.ts

@@ -0,0 +1,9 @@
+import type { HttpClientResponse } from '@dynatrace-sdk/http-client';
+/**
+ * Handles errors from API Gateway responses.
+ * Throws an ApiGatewayError if the response source is 'API Gateway'.
+ *
+ * @param {HttpClientResponse} response - The HTTP response to check for API Gateway errors.
+ * @throws {ApiGatewayError} If the response is from API Gateway and contains an error.
+ */
+export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

package/types/packages/shared-client-utils/src/encoding.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Available formats to transform models to and from
+ */
+export declare enum Encoding {
+    Json = "json",
+    Text = "text",
+    Binary = "binary",
+    FormData = "form-data"
+}
+/**
+ * Maps a MIME type string to an Encoding.
+ *
+ * @param {string} mimeType - The MIME type to convert (e.g., 'application/json').
+ * @param {Encoding} [defaultEncoding] - The encoding to return if the MIME type isn't recognized.
+ * @returns {Encoding} The corresponding Encoding enum value, or the defaultEncoding if not recognized.
+ */
+export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

package/types/packages/shared-client-utils/src/get-error-message.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returns a user-friendly error message from an error body object.
+ *
+ * @param {unknown} errorBody - The error object or response body to extract the message from.
+ * @param {string} defaultMessage - The default message to use if no error message is found.
+ * @returns {string} The extracted or default error message, possibly including details.
+ */
+export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

package/types/packages/shared-client-utils/src/index.d.ts

@@ -0,0 +1,6 @@
+export * from './api-client-options';
+export * from './api-gateway-errors-handler';
+export * from './encoding';
+export * from './get-error-message';
+export * from './transformations';
+export * from './url-helpers';

package/types/packages/shared-client-utils/src/transformations.d.ts

@@ -0,0 +1,64 @@
+import { FormDataRequestBody, FormDataRequestField, FormDataResponseBody } from '@dynatrace-sdk/http-client';
+export type TransformRuleConfig = {
+    force?: boolean;
+    datetime?: boolean;
+};
+export type TransformRulesParam = Array<string | [string, TransformRuleConfig]>;
+/**
+ * Transforms an object by applying transformation rules before sending it in a request.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformRequest<T = any>(object: T, rules: TransformRulesParam): T;
+/**
+ * Transforms an object by applying transformation rules after receiving it in a response.
+ *
+ * @template T
+ * @param {T} object - The object to transform.
+ * @param {TransformRulesParam} rules - The transformation rules to apply.
+ * @returns {T} The transformed object.
+ */
+export declare function transformResponse<T = any>(object: T, rules: TransformRulesParam): T;
+export interface FormDataRequestFieldDefinition {
+    key: string;
+    type: 'text' | 'json' | 'binary';
+    required: boolean;
+}
+export interface FormDataResponseGenericFieldDefinition {
+    type: 'text' | 'binary';
+}
+export interface FormDataResponseJsonFieldDefinition {
+    type: 'json';
+    transformations: Array<string | [string, TransformRuleConfig]>;
+}
+export type FormDataResponseFieldDefinition = FormDataResponseGenericFieldDefinition | FormDataResponseJsonFieldDefinition;
+/**
+ * Converts an object to a FormDataRequestBody using field definitions.
+ *
+ * @template T
+ * @param {T} value - The object to convert.
+ * @param {Array<FormDataRequestFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {FormDataRequestBody} The resulting form data body.
+ */
+export declare function transformToFormData<T extends Record<any, any>>(value: T, fields: Array<FormDataRequestFieldDefinition>): FormDataRequestBody;
+/**
+ * Converts a value to a FormDataRequestField based on the field definition.
+ *
+ * @template T
+ * @param {T} value - The value to convert.
+ * @param {FormDataRequestFieldDefinition} field - The field definition.
+ * @returns {FormDataRequestField | null} The resulting form data field or null if not required and undefined.
+ */
+export declare function transformToFormDataField<T = any>(value: T, field: FormDataRequestFieldDefinition): FormDataRequestField | null;
+/**
+ * Converts form data and field definitions into a typed object, applying transformations for JSON fields.
+ *
+ * @template T
+ * @param {FormDataResponseBody} formData - The form data to convert.
+ * @param {Record<string, FormDataResponseFieldDefinition>} fields - The field definitions for the form data.
+ * @returns {T} The resulting typed object.
+ */
+export declare function transformFromFormData<T extends Record<any, any>>(formData: FormDataResponseBody, fields: Record<string, FormDataResponseFieldDefinition>): T;

package/types/packages/shared-client-utils/src/url-helpers.d.ts

@@ -0,0 +1,12 @@
+export type QueryParamsType = Record<string | number, any>;
+export interface ParametersFlags {
+    explode?: Record<string, boolean>;
+}
+/**
+ * Converts an object of query parameters into a URL query string.
+ *
+ * @param {QueryParamsType} [rawQuery] - The object containing query parameters.
+ * @param {ParametersFlags} [flags] - Flags to control parameter formatting (e.g., explode arrays).
+ * @returns {string} The resulting query string.
+ */
+export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;

package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/api-gateway-errors-handler.d.ts

@@ -1,2 +0,0 @@
-import { HttpClientResponse } from '@dynatrace-sdk/http-client';
-export declare function apiGatewayErrorsHandler(response: HttpClientResponse): Promise<void>;

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

@@ -1 +0,0 @@
-export declare function getErrorMessage(errorBody: unknown, defaultMessage: string): string;

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

@@ -1,10 +0,0 @@
-/**
- * Available formats to transform models to and from
- */
-export declare enum Encoding {
-    Json = "json",
-    Text = "text",
-    Binary = "binary",
-    FormData = "form-data"
-}
-export declare function mimeTypeToEncoding(mimeType: string, defaultEncoding?: Encoding): Encoding;

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

@@ -1,8 +0,0 @@
-type TransformRuleConfig = {
-    force?: boolean;
-    datetime?: boolean;
-};
-type TransformRulesParam = Array<string | [string, TransformRuleConfig]>;
-export declare function transformRequest<T = any>(object: T, rules: TransformRulesParam): T;
-export declare function transformResponse<T = any>(object: T, rules: TransformRulesParam): T;
-export {};

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

@@ -1,6 +0,0 @@
-type QueryParamsType = Record<string | number, any>;
-interface ParametersFlags {
-    explode?: Record<string, boolean>;
-}
-export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string;
-export {};