@dynatrace-sdk/client-query 1.13.0 → 1.17.0

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.13.0",
+  "version": "1.17.0",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {
     "@dynatrace-sdk/error-handlers": "^1.2.0",
-    "@dynatrace-sdk/http-client": "^1.3.0"
+    "@dynatrace-sdk/http-client": "^1.3.0",
+    "@dynatrace-sdk/shared-errors": "^1.0.0"
   },
   "main": "./cjs/index.js",
   "module": "./esm/index.js",

package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts

@@ -26,7 +26,7 @@ export declare class QueryAssistanceClient {
      * Verifies the supplied query string and other query parameters for lack of any errors, but without actually
      * submitting the query for execution.
      *
-     * @returns Supplied query and parameters were verified.
+     * @returns {Promise<VerifyResponse>} Supplied query and parameters were verified.
      *
      * @example <caption>Code example</caption>
      * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
@@ -37,6 +37,11 @@ export declare class QueryAssistanceClient {
      *       'fetch events | filter event.type == "davis" AND davis.status != "CLOSED" | fields timestamp, davis.title, davis.underMaintenance, davis.status | sort timestamp | limit 10',
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. | An internal server error has occurred.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryVerify(config: {
         body: VerifyRequest;
@@ -237,7 +242,7 @@ export declare class QueryAssistanceClient {
      *   for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
      *   used to help the user understand what this parameter means.
      *
-     * @returns A node containing more nodes,  a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
+     * @returns {Promise<DQLNode>} A node containing more nodes,  a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
      *
      * @example <caption>Code example</caption>
      * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
@@ -248,6 +253,11 @@ export declare class QueryAssistanceClient {
      *       'fetch events | filter event.type == "davis" AND davis.status != "CLOSED" | fields timestamp, davis.title, davis.underMaintenance, davis.status | sort timestamp | limit 10',
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. Either the query itself or other parameters are wrong. | An internal server error has occurred.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryParse(config: {
         body: ParseRequest;
@@ -292,7 +302,7 @@ export declare class QueryAssistanceClient {
      * The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
      * a link to docs, etc.
      *
-     * @returns A list of structured autocomplete suggestions.
+     * @returns {Promise<AutocompleteResponse>} A list of structured autocomplete suggestions.
      *
      * @example <caption>Code example</caption>
      * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
@@ -303,6 +313,11 @@ export declare class QueryAssistanceClient {
      *       'fetch events | filter event.type == "davis" AND davis.status != "CLOSED" | fields timestamp, davis.title, davis.underMaintenance, davis.status | sort timestamp | limit 10',
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. Either the query itself or other parameters are wrong. | An internal server error has occurred.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryAutocomplete(config: {
         body: AutocompleteRequest;

package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts

@@ -49,7 +49,7 @@ export declare class QueryExecutionClient {
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
      *
-     * @returns The current status and results of the supplied query.
+     * @returns {Promise<QueryPollResponse>} The current status and results of the supplied query.
      *
      * @example <caption>Code example</caption>
      * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
@@ -57,6 +57,11 @@ export declare class QueryExecutionClient {
      * const data = await queryExecutionClient.queryPoll({
      *   requestToken: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. Either the query itself or other parameters are wrong. | An internal server error has occurred.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryPoll(config: {
         /** The request-token of the query. */ requestToken: string;
@@ -103,7 +108,7 @@ export declare class QueryExecutionClient {
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
      *
-     * @returns The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
+     * @returns {Promise<QueryStartResponse>} The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
      *
      * @example <caption>Code example</caption>
      * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
@@ -114,6 +119,12 @@ export declare class QueryExecutionClient {
      *       'fetch events | filter event.type == "davis" AND davis.status != "CLOSED" | fields timestamp, davis.title, davis.underMaintenance, davis.status | sort timestamp | limit 10',
      *   },
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. Either the query itself or other parameters are wrong. | Too many requests. | An internal server error has occurred. | Service is unavailable. | Client error. | Server error.
+     * @throws {InsufficientPermission} Insufficient permissions.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryExecute(config: {
         body: ExecuteRequest;
@@ -158,7 +169,7 @@ export declare class QueryExecutionClient {
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
      *
-     * @returns The query already finished.
+     * @returns {Promise<QueryPollResponse | void>} The query already finished.
      *
      * @example <caption>Code example</caption>
      * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
@@ -166,6 +177,11 @@ export declare class QueryExecutionClient {
      * const data = await queryExecutionClient.queryCancel({
      *   requestToken: "...",
      * });
+     *
+     * @throws {ErrorEnvelopeError} The supplied request is wrong. Either the query itself or other parameters are wrong. | An internal server error has occurred.
+     * @throws {InvalidResponseError}
+     * @throws {ApiClientError}
+     * @throws {ClientRequestError}
      */
     queryCancel(config: {
         /** The request-token of the query. */ requestToken: string;

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

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

package/types/packages/client/query/src/lib/error-envelopes/error-envelope-error.d.ts

@@ -1,7 +1,7 @@
 /**
  * ErrorEnvelope
  */
-import { ClientRequestError } from './client-request-error';
+import { ClientRequestError } from '@dynatrace-sdk/shared-errors';
 import { ErrorEnvelope } from '../models';
 export declare class ErrorEnvelopeError extends ClientRequestError<ErrorEnvelope> {
     readonly isErrorEnvelopeError = true;

package/types/packages/client/query/src/lib/error-envelopes/index.d.ts

@@ -1,4 +1,3 @@
-export { isClientRequestError } from './client-request-error';
-export { isApiClientError } from './api-client-error';
-export { isInvalidResponseError } from './invalid-response-error';
-export { isErrorEnvelopeError } from './error-envelope-error';
+export { ApiClientError, ApiGatewayError, ClientRequestError, InvalidResponseError, isApiClientError, isApiGatewayError, isClientRequestError, isInvalidResponseError, } from '@dynatrace-sdk/shared-errors';
+export { ErrorEnvelopeError, isErrorEnvelopeError } from './error-envelope-error';
+export { InsufficientPermission, isInsufficientPermission } from './responses/insufficient-permission';

package/types/packages/client/query/src/lib/error-envelopes/responses/insufficient-permission.d.ts

@@ -0,0 +1,9 @@
+/**
+ * ErrorEnvelope
+ */
+import { ErrorEnvelopeError } from '../error-envelope-error';
+export declare class InsufficientPermission extends ErrorEnvelopeError {
+    readonly isInsufficientPermission = true;
+    readonly name = "InsufficientPermission";
+}
+export declare function isInsufficientPermission(e: any): e is InsufficientPermission;

package/types/packages/client/query/src/lib/models/autocomplete-request.d.ts

@@ -14,5 +14,8 @@ export interface AutocompleteRequest {
      */
     locale?: string;
     maxDataSuggestions?: number;
+    /**
+     * Query options enhance query functionality for Dynatrace internal services.
+     */
     queryOptions?: QueryOptions;
 }

package/types/packages/client/query/src/lib/models/autocomplete-suggestion-part.d.ts

@@ -1,9 +1,11 @@
-import { TokenType } from './token-type';
 /**
  * Part of the suggestion.
  */
 export interface AutocompleteSuggestionPart {
-    type: TokenType;
+    /**
+     * The type of the autocomplete token.
+     */
+    type: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'ENTITY_SELECTOR_PART' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
     /**
      * The type of the suggestion.
      */

package/types/packages/client/query/src/lib/models/dql-container-node.d.ts

@@ -6,7 +6,7 @@ export interface DQLContainerNode extends DQLNode {
     /**
      * The type of the node.
      */
-    type?: string;
+    type?: 'QUERY' | 'EXECUTION_BLOCK' | 'COMMAND' | 'COMMAND_SEPARATOR' | 'PARAMETER_WITH_KEY' | 'GROUP' | 'PARAMETERS' | 'PARAMETER_NAMING' | 'PARAMETER_ASSIGNMENT' | 'PARAMETER_SEPARATOR' | 'FUNCTION' | 'FUNCTION_PART' | 'EXPRESSION' | 'IDENTIFIER' | 'SOURCE_ID' | 'DURATION' | 'TIMESTAMP' | 'TIMEFRAME' | 'TRAVERSAL_PATH' | 'TRAVERSAL_STEP';
     /**
      * The list of children nodes.
      */

package/types/packages/client/query/src/lib/models/dql-container-node.transformation.d.ts

@@ -1,7 +1,7 @@
 import { DQLContainerNode } from './dql-container-node';
 import * as _DQLNodeTransformation from './dql-node.transformation';
 export interface AsJson extends _DQLNodeTransformation.AsJson {
-    type?: string;
+    type?: 'QUERY' | 'EXECUTION_BLOCK' | 'COMMAND' | 'COMMAND_SEPARATOR' | 'PARAMETER_WITH_KEY' | 'GROUP' | 'PARAMETERS' | 'PARAMETER_NAMING' | 'PARAMETER_ASSIGNMENT' | 'PARAMETER_SEPARATOR' | 'FUNCTION' | 'FUNCTION_PART' | 'EXPRESSION' | 'IDENTIFIER' | 'SOURCE_ID' | 'DURATION' | 'TIMESTAMP' | 'TIMEFRAME' | 'TRAVERSAL_PATH' | 'TRAVERSAL_STEP';
     children?: _DQLNodeTransformation.AsJson[];
 }
 export declare function isDqlContainerNode(value: any): value is DQLContainerNode;

package/types/packages/client/query/src/lib/models/dql-node-node-type.d.ts

@@ -1,5 +1,7 @@
 /**
  * The type of the node.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum DQLNodeNodeType {
     Terminal = "TERMINAL",

package/types/packages/client/query/src/lib/models/dql-node-node-type.transformation.d.ts

@@ -1,6 +1,5 @@
-import { DQLNodeNodeType } from './dql-node-node-type';
 export type AsJson = string;
-export declare function isDqlNodeNodeType(value: any): value is DQLNodeNodeType;
+export declare function isTerminalContainerAlternative(value: any): value is 'TERMINAL' | 'CONTAINER' | 'ALTERNATIVE';
 export declare function isJson(value: any): value is AsJson;
-export declare function fromJson($model: AsJson): DQLNodeNodeType;
-export declare function toJson($model: DQLNodeNodeType): AsJson;
+export declare function fromJson($model: AsJson): 'TERMINAL' | 'CONTAINER' | 'ALTERNATIVE';
+export declare function toJson($model: 'TERMINAL' | 'CONTAINER' | 'ALTERNATIVE'): AsJson;

package/types/packages/client/query/src/lib/models/dql-node.d.ts

@@ -1,10 +1,15 @@
-import { DQLNodeNodeType } from './dql-node-node-type';
 import { TokenPosition } from './token-position';
 /**
  * General Node in the DQL query.
  */
 export interface DQLNode {
-    nodeType: DQLNodeNodeType;
+    /**
+     * The type of the node.
+     */
+    nodeType: 'TERMINAL' | 'CONTAINER' | 'ALTERNATIVE';
+    /**
+     * The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
+     */
     tokenPosition?: TokenPosition;
     /**
      * True if the node is optional.

package/types/packages/client/query/src/lib/models/dql-terminal-node.d.ts

@@ -1,10 +1,12 @@
 import { DQLNode } from './dql-node';
-import { TokenType } from './token-type';
 /**
  * Node that represents single token.
  */
 export interface DQLTerminalNode extends DQLNode {
-    type?: TokenType;
+    /**
+     * The type of the autocomplete token.
+     */
+    type?: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'ENTITY_SELECTOR_PART' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
     /**
      * For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
      */

package/types/packages/client/query/src/lib/models/error-envelope.d.ts

@@ -3,5 +3,8 @@ import { ErrorResponse } from './error-response';
  * An 'envelope' error object that has the mandatory error object.
  */
 export interface ErrorEnvelope {
+    /**
+     * The response for error state
+     */
     error: ErrorResponse;
 }

package/types/packages/client/query/src/lib/models/error-response-details.d.ts

@@ -8,6 +8,9 @@ export interface ErrorResponseDetails {
      * The exception type.
      */
     exceptionType?: string;
+    /**
+     * The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
+     */
     syntaxErrorPosition?: TokenPosition;
     /**
      * The error type, e.g. COMMAND_NAME_MISSING

package/types/packages/client/query/src/lib/models/error-response.d.ts

@@ -7,6 +7,9 @@ export interface ErrorResponse {
      * A short, clear error message without details
      */
     message: string;
+    /**
+     * Detailed information about the error.
+     */
     details?: ErrorResponseDetails;
     /**
      * Error code, which normally matches the HTTP error code.

package/types/packages/client/query/src/lib/models/execute-request.d.ts

@@ -49,6 +49,12 @@ export interface ExecuteRequest {
      * Limit in gigabytes for the amount data that will be scanned during read.
      */
     defaultScanLimitGbytes?: number;
+    /**
+     * Query options enhance query functionality for Dynatrace internal services.
+     */
     queryOptions?: QueryOptions;
+    /**
+     * Represents a collection of filter segments.
+     */
     filterSegments?: FilterSegments;
 }

package/types/packages/client/query/src/lib/models/field-type-type.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @deprecated Use literal values.
+ */
 export declare enum FieldTypeType {
     Boolean = "boolean",
     String = "string",
@@ -12,5 +15,6 @@ export declare enum FieldTypeType {
     Array = "array",
     Record = "record",
     Uid = "uid",
+    SmartscapeId = "smartscape_id",
     Undefined = "undefined"
 }

package/types/packages/client/query/src/lib/models/field-type-type.transformation.d.ts

@@ -1,6 +1,5 @@
-import { FieldTypeType } from './field-type-type';
 export type AsJson = string;
-export declare function isFieldTypeType(value: any): value is FieldTypeType;
+export declare function isBooleanStringDoubleLongTimestampTimeframeDurationBinaryIpAddressGeoPointArrayRecordUidSmartscapeIdUndefined(value: any): value is 'boolean' | 'string' | 'double' | 'long' | 'timestamp' | 'timeframe' | 'duration' | 'binary' | 'ip_address' | 'geo_point' | 'array' | 'record' | 'uid' | 'smartscape_id' | 'undefined';
 export declare function isJson(value: any): value is AsJson;
-export declare function fromJson($model: AsJson): FieldTypeType;
-export declare function toJson($model: FieldTypeType): AsJson;
+export declare function fromJson($model: AsJson): 'boolean' | 'string' | 'double' | 'long' | 'timestamp' | 'timeframe' | 'duration' | 'binary' | 'ip_address' | 'geo_point' | 'array' | 'record' | 'uid' | 'smartscape_id' | 'undefined';
+export declare function toJson($model: 'boolean' | 'string' | 'double' | 'long' | 'timestamp' | 'timeframe' | 'duration' | 'binary' | 'ip_address' | 'geo_point' | 'array' | 'record' | 'uid' | 'smartscape_id' | 'undefined'): AsJson;

package/types/packages/client/query/src/lib/models/field-type.d.ts

@@ -1,9 +1,8 @@
-import { FieldTypeType } from './field-type-type';
 import { RangedFieldTypes } from './ranged-field-types';
 /**
  * The possible type of a field in DQL.
  */
 export interface FieldType {
-    type: FieldTypeType;
+    type: 'boolean' | 'string' | 'double' | 'long' | 'timestamp' | 'timeframe' | 'duration' | 'binary' | 'ip_address' | 'geo_point' | 'array' | 'record' | 'uid' | 'smartscape_id' | 'undefined';
     types?: RangedFieldTypes[];
 }

package/types/packages/client/query/src/lib/models/grail-metadata.d.ts

@@ -29,6 +29,9 @@ export interface GrailMetadata {
      */
     scannedBytes?: number;
     scannedDataPoints?: number;
+    /**
+     * DQL data type timeframe.
+     */
     analysisTimeframe?: Timeframe;
     /**
      * Effective locale for the query.

package/types/packages/client/query/src/lib/models/metadata-notification.d.ts

@@ -11,6 +11,9 @@ export interface MetadataNotification {
      * The message format of the notification, string.format based
      */
     messageFormat?: string;
+    /**
+     * The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
+     */
     syntaxPosition?: TokenPosition;
     /**
      * The corresponding DQL format specifier types for each format specifier used in the error message format.

package/types/packages/client/query/src/lib/models/metadata.d.ts

@@ -4,6 +4,9 @@ import { MetricMetadata } from './metric-metadata';
  * Collects various bits of metadata information.
  */
 export interface Metadata {
+    /**
+     * Collects various bits of metadata information.
+     */
     grail?: GrailMetadata;
     metrics?: MetricMetadata[];
 }

package/types/packages/client/query/src/lib/models/parse-request.d.ts

@@ -12,5 +12,8 @@ export interface ParseRequest {
      * The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
      */
     locale?: string;
+    /**
+     * Query options enhance query functionality for Dynatrace internal services.
+     */
     queryOptions?: QueryOptions;
 }

package/types/packages/client/query/src/lib/models/query-poll-response.d.ts

@@ -1,9 +1,11 @@
 import { QueryResult } from './query-result';
-import { QueryState } from './query-state';
 /**
  * The response of GET query:execute call.
  */
 export interface QueryPollResponse {
+    /**
+     * The result of the DQL query.
+     */
     result?: QueryResult;
     /**
      * Time to live in seconds.
@@ -13,5 +15,8 @@ export interface QueryPollResponse {
      * The progress of the query from 0 to 100.
      */
     progress?: number;
-    state: QueryState;
+    /**
+     * Possible state of the query.
+     */
+    state: 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
 }

package/types/packages/client/query/src/lib/models/query-result.d.ts

@@ -9,6 +9,9 @@ export interface QueryResult {
      * List of records containing the result fields data.
      */
     records: (ResultRecord | null)[];
+    /**
+     * Collects various bits of metadata information.
+     */
     metadata: Metadata;
     /**
      * The data types for the result records.

package/types/packages/client/query/src/lib/models/query-start-response.d.ts

@@ -1,9 +1,11 @@
 import { QueryResult } from './query-result';
-import { QueryState } from './query-state';
 /**
  * The response when starting a query.
  */
 export interface QueryStartResponse {
+    /**
+     * The result of the DQL query.
+     */
     result?: QueryResult;
     /**
      * Time to live in seconds.
@@ -17,5 +19,8 @@ export interface QueryStartResponse {
      * The token returned by the POST query:execute call.
      */
     requestToken?: string;
-    state: QueryState;
+    /**
+     * Possible state of the query.
+     */
+    state: 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
 }

package/types/packages/client/query/src/lib/models/query-state.d.ts

@@ -1,5 +1,7 @@
 /**
  * Possible state of the query.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum QueryState {
     NotStarted = "NOT_STARTED",

package/types/packages/client/query/src/lib/models/query-state.transformation.d.ts

@@ -1,6 +1,5 @@
-import { QueryState } from './query-state';
 export type AsJson = string;
-export declare function isQueryState(value: any): value is QueryState;
+export declare function isNotStartedRunningSucceededResultGoneCancelledFailed(value: any): value is 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
 export declare function isJson(value: any): value is AsJson;
-export declare function fromJson($model: AsJson): QueryState;
-export declare function toJson($model: QueryState): AsJson;
+export declare function fromJson($model: AsJson): 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED';
+export declare function toJson($model: 'NOT_STARTED' | 'RUNNING' | 'SUCCEEDED' | 'RESULT_GONE' | 'CANCELLED' | 'FAILED'): AsJson;

package/types/packages/client/query/src/lib/models/ranged-field-types.d.ts

@@ -3,6 +3,9 @@ import { RangedFieldTypesMappings } from './ranged-field-types-mappings';
  * The field type in range.
  */
 export interface RangedFieldTypes {
+    /**
+     * The mapping between the field name and data type.
+     */
     mappings: RangedFieldTypesMappings;
     /**
      * The range of elements at use this type in arrays (null for records).

package/types/packages/client/query/src/lib/models/token-position.d.ts

@@ -3,6 +3,12 @@ import { PositionInfo } from './position-info';
  * The position of a token in a query string used for errors and notification to map the message to a specific part of the query.
  */
 export interface TokenPosition {
+    /**
+     * The exact position in the query string.
+     */
     start: PositionInfo;
+    /**
+     * The exact position in the query string.
+     */
     end: PositionInfo;
 }

package/types/packages/client/query/src/lib/models/token-type.d.ts

@@ -1,5 +1,7 @@
 /**
  * The type of the autocomplete token.
+ *
+ * @deprecated Use literal values.
  */
 export declare enum TokenType {
     Space = "SPACE",
@@ -47,5 +49,6 @@ export declare enum TokenType {
     EntitySelectorPart = "ENTITY_SELECTOR_PART",
     FieldModifier = "FIELD_MODIFIER",
     EntityType = "ENTITY_TYPE",
-    EntityAttribute = "ENTITY_ATTRIBUTE"
+    EntityAttribute = "ENTITY_ATTRIBUTE",
+    SmartscapeIdValue = "SMARTSCAPE_ID_VALUE"
 }

package/types/packages/client/query/src/lib/models/token-type.transformation.d.ts

@@ -1,6 +1,5 @@
-import { TokenType } from './token-type';
 export type AsJson = string;
-export declare function isTokenType(value: any): value is TokenType;
+export declare function isSpaceLinebreakIndentPipeDotColonCommaAssignmentBraceOpenBraceCloseBracketOpenBracketCloseParenthesisOpenParenthesisCloseQuoteSingleQuoteSlashBooleanTrueBooleanFalseNullCommandNameParameterKeyParameterValueScopeFunctionNameTimeseriesAggregationTimeseriesAggregationExpressionOperatorTraversalOperatorTraversalRelationNameTraversalHopCountSimpleIdentifierDataObjectNumberStringTimeUnitTimestampValueMetricKeyVariableEndCommentUidValueParsePatternFieldPatternEntitySelectorPartFieldModifierEntityTypeEntityAttributeSmartscapeIdValue(value: any): value is 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'ENTITY_SELECTOR_PART' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
 export declare function isJson(value: any): value is AsJson;
-export declare function fromJson($model: AsJson): TokenType;
-export declare function toJson($model: TokenType): AsJson;
+export declare function fromJson($model: AsJson): 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'ENTITY_SELECTOR_PART' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE';
+export declare function toJson($model: 'SPACE' | 'LINEBREAK' | 'INDENT' | 'PIPE' | 'DOT' | 'COLON' | 'COMMA' | 'ASSIGNMENT' | 'BRACE_OPEN' | 'BRACE_CLOSE' | 'BRACKET_OPEN' | 'BRACKET_CLOSE' | 'PARENTHESIS_OPEN' | 'PARENTHESIS_CLOSE' | 'QUOTE' | 'SINGLE_QUOTE' | 'SLASH' | 'BOOLEAN_TRUE' | 'BOOLEAN_FALSE' | 'NULL' | 'COMMAND_NAME' | 'PARAMETER_KEY' | 'PARAMETER_VALUE_SCOPE' | 'FUNCTION_NAME' | 'TIMESERIES_AGGREGATION' | 'TIMESERIES_AGGREGATION_EXPRESSION' | 'OPERATOR' | 'TRAVERSAL_OPERATOR' | 'TRAVERSAL_RELATION_NAME' | 'TRAVERSAL_HOP_COUNT' | 'SIMPLE_IDENTIFIER' | 'DATA_OBJECT' | 'NUMBER' | 'STRING' | 'TIME_UNIT' | 'TIMESTAMP_VALUE' | 'METRIC_KEY' | 'VARIABLE' | 'END_COMMENT' | 'UID_VALUE' | 'PARSE_PATTERN' | 'FIELD_PATTERN' | 'ENTITY_SELECTOR_PART' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE'): AsJson;

package/types/packages/client/query/src/lib/models/verify-request.d.ts

@@ -12,6 +12,9 @@ export interface VerifyRequest {
      * The query locale. If none specified, then a language/country neutral locale is chosen. The input values take the ISO-639 Language code with an optional ISO-3166 country code appended to it with an underscore. For instance, both values are valid 'en' or 'en_US'.
      */
     locale?: string;
+    /**
+     * Query options enhance query functionality for Dynatrace internal services.
+     */
     queryOptions?: QueryOptions;
     generateCanonicalQuery?: boolean;
 }

package/types/packages/client/query/src/lib/utils/encoding.d.ts

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