@dynatrace-sdk/client-query 1.15.0 → 1.17.1

package/CHANGELOG.md

@@ -2,9 +2,36 @@
 
 @dynatrace-sdk/client-query
 
+## 1.17.1
+
+### Patch Changes
+
+- Replace model transformations with single transformation function. (APPDEV-10818)
+- Redundant error serializers are removed. (APPDEV-10272)
+- Missing await added for API Gateway handler and line breaks at the end of the string are ignored. APPDEV-10883
+- Imports reformatted and fixed incorrect type rendered for arrays of enum values. APPDEV-10701
+
+## 1.17.0
+
+### Minor Changes
+
+- Enums are replaced with unions of literals. APPDEV-10338
+- Inline enums as union of literals. APPDEV-9924
+
+### Patch Changes
+
+- Add return types and improve usage examples inside JSDoc. APPDEV-7536
+
+## 1.16.0
+
+### Features
+
+- Export errors from the package.
+
 ## 1.15.0
 
 ### Minor Changes
+
 - Add new token type to the `TokenType` enum and new field type to the `FieldType` enum.
 
 ## 1.14.0

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.15.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.15.0)
+[![npm](https://img.shields.io/badge/npm-v1.17.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.17.1)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 Exposes an API to fetch records stored in Grail
@@ -97,7 +97,16 @@ a link to docs, etc.
 
 #### Returns
 
-A list of structured autocomplete suggestions.
+| Return type | Description |
+|---|---|
+|Promise<AutocompleteResponse>|A list of structured autocomplete suggestions.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
 
 
 <details>
@@ -341,7 +350,16 @@ When displaying the query, pick one option. You may use the other options for ho
 
 #### 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.
+| Return type | Description |
+|---|---|
+|Promise&lt;DQLNode&gt;|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.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
 
 
 <details>
@@ -400,7 +418,16 @@ submitting the query for execution.
 
 #### Returns
 
-Supplied query and parameters were verified.
+| Return type | Description |
+|---|---|
+|Promise&lt;VerifyResponse&gt;|Supplied query and parameters were verified.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|ErrorEnvelopeError|The supplied request is wrong. \| An internal server error has occurred.|
 
 
 <details>
@@ -494,7 +521,16 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Returns
 
-The query already finished.
+| Return type | Description |
+|---|---|
+|Promise&lt;QueryPollResponse | void&gt;|The query already finished.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
 
 
 <details>
@@ -580,7 +616,17 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Returns
 
-The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
+| Return type | Description |
+|---|---|
+|Promise&lt;QueryStartResponse&gt;|The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. \| The status of the query to start.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|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.|
+|InsufficientPermission|Insufficient permissions.|
 
 
 <details>
@@ -667,7 +713,16 @@ It is guaranteed that every field of every record will have a corresponding type
 
 #### Returns
 
-The current status and results of the supplied query.
+| Return type | Description |
+|---|---|
+|Promise&lt;QueryPollResponse&gt;|The current status and results of the supplied query.|
+
+
+#### Throws
+
+| Error Type | Error Message |
+|---|---|
+|ErrorEnvelopeError|The supplied request is wrong. Either the query itself or other parameters are wrong. \| An internal server error has occurred.|
 
 
 <details>
@@ -693,25 +748,17 @@ const data = await queryExecutionClient.queryPoll({
 
 ### AutocompleteRequest
 
-
-
-
-
-
 | Name | Type | Description |
 | --- | --- | --- |
 |cursorPosition|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
 |maxDataSuggestions|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### AutocompleteResponse
 
-
-
-
 The response of the autocomplete call.
 
 | Name | Type | Description |
@@ -722,9 +769,6 @@ The response of the autocomplete call.
 
 ### AutocompleteSuggestion
 
-
-
-
 Single suggestion for completion of the query.
 
 | Name | Type | Description |
@@ -735,9 +779,6 @@ Single suggestion for completion of the query.
 
 ### AutocompleteSuggestionPart
 
-
-
-
 Part of the suggestion.
 
 | Name | Type | Description |
@@ -745,55 +786,43 @@ Part of the suggestion.
 |info|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the suggestion. |
 |suggestion<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The suggested continuation of the query. |
 |synopsis|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The synopsis of the suggestion. |
-|type<sup>*required</sup>|TokenType| |
+|type<sup>*required</sup>|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE"|The type of the autocomplete token. |
 
 ### DQLAlternativeNode
 
-
-
-
 The DQL node that has alternatives.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |alternatives|object|The different alternatives. |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
-|nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
+|nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
 
 ### DQLContainerNode
 
-
-
-
 The DQL node that contains other nodes.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |children|Array&lt;<a href="#dqlnode">DQLNode</a>&gt;|The list of children nodes. |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
-|nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
-|type|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The type of the node. |
+|nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
+|type|"QUERY" &#124; "EXECUTION_BLOCK" &#124; "COMMAND" &#124; "COMMAND_SEPARATOR" &#124; "PARAMETER_WITH_KEY" &#124; "GROUP" &#124; "PARAMETERS" &#124; "PARAMETER_NAMING" &#124; "PARAMETER_ASSIGNMENT" &#124; "PARAMETER_SEPARATOR" &#124; "FUNCTION" &#124; "FUNCTION_PART" &#124; "EXPRESSION" &#124; "IDENTIFIER" &#124; "SOURCE_ID" &#124; "DURATION" &#124; "TIMESTAMP" &#124; "TIMEFRAME" &#124; "TRAVERSAL_PATH" &#124; "TRAVERSAL_STEP"|The type of the node. |
 
 ### DQLNode
 
-
-
-
 General Node in the DQL query.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
-|nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|<a href="#tokenposition">TokenPosition</a>| |
+|nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
+|tokenPosition|<a href="#tokenposition">TokenPosition</a>|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. |
 
 ### DQLTerminalNode
 
-
-
-
 Node that represents single token.
 
 | Name | Type | Description |
@@ -801,39 +830,30 @@ Node that represents single token.
 |canonicalString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Canonical form. |
 |isMandatoryOnUserOrder|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces' |
 |isOptional<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the node is optional. |
-|nodeType<sup>*required</sup>|DQLNodeNodeType| |
-|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
-|type|TokenType| |
+|nodeType<sup>*required</sup>|"TERMINAL" &#124; "CONTAINER" &#124; "ALTERNATIVE"|The type of the node. |
+|tokenPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
+|type|"SPACE" &#124; "LINEBREAK" &#124; "INDENT" &#124; "PIPE" &#124; "DOT" &#124; "COLON" &#124; "COMMA" &#124; "ASSIGNMENT" &#124; "BRACE_OPEN" &#124; "BRACE_CLOSE" &#124; "BRACKET_OPEN" &#124; "BRACKET_CLOSE" &#124; "PARENTHESIS_OPEN" &#124; "PARENTHESIS_CLOSE" &#124; "QUOTE" &#124; "SINGLE_QUOTE" &#124; "SLASH" &#124; "BOOLEAN_TRUE" &#124; "BOOLEAN_FALSE" &#124; "NULL" &#124; "COMMAND_NAME" &#124; "PARAMETER_KEY" &#124; "PARAMETER_VALUE_SCOPE" &#124; "FUNCTION_NAME" &#124; "TIMESERIES_AGGREGATION" &#124; "TIMESERIES_AGGREGATION_EXPRESSION" &#124; "OPERATOR" &#124; "TRAVERSAL_OPERATOR" &#124; "TRAVERSAL_RELATION_NAME" &#124; "TRAVERSAL_HOP_COUNT" &#124; "SIMPLE_IDENTIFIER" &#124; "DATA_OBJECT" &#124; "NUMBER" &#124; "STRING" &#124; "TIME_UNIT" &#124; "TIMESTAMP_VALUE" &#124; "METRIC_KEY" &#124; "VARIABLE" &#124; "END_COMMENT" &#124; "UID_VALUE" &#124; "PARSE_PATTERN" &#124; "FIELD_PATTERN" &#124; "ENTITY_SELECTOR_PART" &#124; "FIELD_MODIFIER" &#124; "ENTITY_TYPE" &#124; "ENTITY_ATTRIBUTE" &#124; "SMARTSCAPE_ID_VALUE"|The type of the autocomplete token. |
 
 ### ErrorEnvelope
 
-
-
-
 An &apos;envelope&apos; error object that has the mandatory error object.
 
-| Name | Type |
-| --- | --- |
-|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|
+| Name | Type | Description |
+| --- | --- | --- |
+|error<sup>*required</sup>|<a href="#errorresponse">ErrorResponse</a>|The response for error state |
 
 ### ErrorResponse
 
-
-
-
 The response for error state
 
 | Name | Type | Description |
 | --- | --- | --- |
 |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Error code, which normally matches the HTTP error code. |
-|details|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>| |
+|details|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>|Detailed information about the error. |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
 
 ### ErrorResponseDetails
 
-
-
-
 Detailed information about the error.
 
 | Name | Type | Description |
@@ -849,15 +869,10 @@ Detailed information about the error.
 |missingScopes|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|List of missing IAM scopes necessary to successfully execute the request. |
 |queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
 |queryString|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
-|syntaxErrorPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
+|syntaxErrorPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
 
 ### ErrorResponseDetailsConstraintViolationsItem
 
-
-
-
-
-
 | Name | Type | Description |
 | --- | --- | --- |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Message describing the error. |
@@ -866,11 +881,6 @@ Detailed information about the error.
 
 ### ExecuteRequest
 
-
-
-
-
-
 | Name | Type | Description |
 | --- | --- | --- |
 |defaultSamplingRatio|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|In case not specified in the DQL string, the sampling ratio defined here is applied. Note that this is only applicable to log queries. |
@@ -879,32 +889,26 @@ Detailed information about the error.
 |defaultTimeframeStart|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timeframe 'start' timestamp in ISO-8601 or RFC3339 format. If the timeframe 'end' parameter is missing, the whole timeframe is ignored. <em>Note that if a timeframe is specified within the query string (query) then it has precedence over this query request parameter.</em> |
 |enablePreview|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Request preview results. If a preview is available within the requestTimeoutMilliseconds, then it will be returned as part of the response. |
 |fetchTimeoutSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The query will stop reading data after reaching the fetch-timeout. The query execution will continue, providing a partial result based on the read data. |
-|filterSegments|<a href="#filtersegments">FilterSegments</a>| |
+|filterSegments|<a href="#filtersegments">FilterSegments</a>|Represents a collection of filter segments. |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
 |maxResultBytes|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result bytes that this query will return. |
 |maxResultRecords|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The maximum number of result records that this query will return. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |requestTimeoutMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time a client is willing to wait for the query result. In case the query finishes within the specified timeout, the query result is returned. Otherwise, the requestToken is returned, allowing polling for the result. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### FieldType
 
-
-
-
 The possible type of a field in DQL.
 
 | Name | Type |
 | --- | --- |
-|type<sup>*required</sup>|FieldTypeType| 
+|type<sup>*required</sup>|"string" &#124; "boolean" &#124; "undefined" &#124; "binary" &#124; "double" &#124; "long" &#124; "timestamp" &#124; "timeframe" &#124; "duration" &#124; "ip_address" &#124; "geo_point" &#124; "array" &#124; "record" &#124; "uid" &#124; "smartscape_id"| 
 |types|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|
 
 ### FilterSegment
 
-
-
-
 A filter segment is identified by an ID. Each segment includes a list of variable definitions.
 
 | Name | Type |
@@ -914,9 +918,6 @@ A filter segment is identified by an ID. Each segment includes a list of variabl
 
 ### FilterSegmentVariableDefinition
 
-
-
-
 Defines a variable with a name and a list of values.
 
 | Name | Type |
@@ -926,21 +927,12 @@ Defines a variable with a name and a list of values.
 
 ### FilterSegments
 
-
-extends `Array<FilterSegment>`
-
 Represents a collection of filter segments.
 
-| Name | Type | Description |
-| --- | --- | --- |
-|[unscopables]<sup>*required</sup>|Object|<p>Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.</p>  |
-|length<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Gets or sets the length of the array. This is a number one higher than the highest index in the array. |
+**type**: Array&lt;<a href="#filtersegment">FilterSegment</a>&gt;
 
 ### GeoPoint
 
-
-
-
 DQL data type representing a geolocation point.
 
 | Name | Type | Description |
@@ -950,19 +942,16 @@ DQL data type representing a geolocation point.
 
 ### GrailMetadata
 
-
-
-
 Collects various bits of metadata information.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|analysisTimeframe|<a href="#timeframe">Timeframe</a>| |
+|analysisTimeframe|<a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a>|DQL data type timeframe. |
 |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The canonical form of the query. It has normalized spaces and canonical constructs. |
 |dqlVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of DQL that was used to process the query request. |
 |executionTimeMilliseconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The time it took to execute the query. |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Effective locale for the query. |
-|notifications|Array&lt;<a href="#metadatanotification" target="_blank" rel="noopener noreferrer">MetadataNotification</a>&gt;|Collected messages during the execution of the query. |
+|notifications|Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;|Collected messages during the execution of the query. |
 |query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The submitted query. |
 |queryId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the query |
 |sampled|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if sampling was used for at least one segment. |
@@ -973,21 +962,15 @@ Collects various bits of metadata information.
 
 ### Metadata
 
-
-
-
 Collects various bits of metadata information.
 
-| Name | Type |
-| --- | --- |
-|grail|<a href="#grailmetadata">GrailMetadata</a>| 
-|metrics|Array&lt;<a href="#metricmetadata" target="_blank" rel="noopener noreferrer">MetricMetadata</a>&gt;|
+| Name | Type | Description |
+| --- | --- | --- |
+|grail|<a href="#grailmetadata" target="_blank" rel="noopener noreferrer">GrailMetadata</a>|Collects various bits of metadata information. |
+|metrics|Array&lt;<a href="#metricmetadata">MetricMetadata</a>&gt;| |
 
 ### MetadataNotification
 
-
-
-
 The message that provides additional information about the execution of the query.
 
 | Name | Type | Description |
@@ -998,13 +981,10 @@ The message that provides additional information about the execution of the quer
 |messageFormatSpecifierTypes|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The corresponding DQL format specifier types for each format specifier used in the error message format. |
 |notificationType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The notification type, e.g. LIMIT_ADDED. |
 |severity|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The severity of the notification, currently: INFO, WARN, ERROR. |
-|syntaxPosition|<a href="#tokenposition">TokenPosition</a>| |
+|syntaxPosition|<a href="#tokenposition" target="_blank" rel="noopener noreferrer">TokenPosition</a>|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. |
 
 ### MetricMetadata
 
-
-
-
 An object that defines additional metric metadata.
 
 | Name | Type | Description |
@@ -1020,23 +1000,15 @@ An object that defines additional metric metadata.
 
 ### ParseRequest
 
-
-
-
-
-
 | Name | Type | Description |
 | --- | --- | --- |
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### PositionInfo
 
-
-
-
 The exact position in the query string.
 
 | Name | Type | Description |
@@ -1046,84 +1018,66 @@ The exact position in the query string.
 |line<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Query position line zero based index. |
 
 ### QueryOptions
-**type**: Record&lt;string, string | undefined&gt;
-
-
 
 Query options enhance query functionality for Dynatrace internal services.
 
-### QueryPollResponse
-
-
+**type**: Record&lt;string, string | undefined&gt;
 
+### QueryPollResponse
 
 The response of GET query:execute call.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
-|result|<a href="#queryresult">QueryResult</a>| |
-|state<sup>*required</sup>|QueryState| |
+|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>|The result of the DQL query. |
+|state<sup>*required</sup>|"NOT_STARTED" &#124; "RUNNING" &#124; "SUCCEEDED" &#124; "RESULT_GONE" &#124; "CANCELLED" &#124; "FAILED"|Possible state of the query. |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
 ### QueryResult
 
-
-
-
 The result of the DQL query.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|metadata<sup>*required</sup>|<a href="#metadata" target="_blank" rel="noopener noreferrer">Metadata</a>| |
-|records<sup>*required</sup>|Array&lt;null &#124; <a href="#resultrecord">ResultRecord</a>&gt;|List of records containing the result fields data. |
-|types<sup>*required</sup>|Array&lt;<a href="#rangedfieldtypes" target="_blank" rel="noopener noreferrer">RangedFieldTypes</a>&gt;|The data types for the result records. |
+|metadata<sup>*required</sup>|<a href="#metadata">Metadata</a>|Collects various bits of metadata information. |
+|records<sup>*required</sup>|Array&lt;null &#124; <a href="#resultrecord" target="_blank" rel="noopener noreferrer">ResultRecord</a>&gt;|List of records containing the result fields data. |
+|types<sup>*required</sup>|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|The data types for the result records. |
 
 ### QueryStartResponse
 
-
-
-
 The response when starting a query.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |progress|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The progress of the query from 0 to 100. |
 |requestToken|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The token returned by the POST query:execute call. |
-|result|<a href="#queryresult">QueryResult</a>| |
-|state<sup>*required</sup>|QueryState| |
+|result|<a href="#queryresult" target="_blank" rel="noopener noreferrer">QueryResult</a>|The result of the DQL query. |
+|state<sup>*required</sup>|"NOT_STARTED" &#124; "RUNNING" &#124; "SUCCEEDED" &#124; "RESULT_GONE" &#124; "CANCELLED" &#124; "FAILED"|Possible state of the query. |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
 ### RangedFieldTypes
 
-
-
-
 The field type in range.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |indexRange|Array&lt;[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)&gt;|The range of elements at use this type in arrays (null for records). |
-|mappings<sup>*required</sup>|<a href="#rangedfieldtypesmappings" target="_blank" rel="noopener noreferrer">RangedFieldTypesMappings</a>| |
+|mappings<sup>*required</sup>|<a href="#rangedfieldtypesmappings">RangedFieldTypesMappings</a>|The mapping between the field name and data type. |
 
 ### RangedFieldTypesMappings
-**type**: Record&lt;string, FieldType | undefined&gt;
-
-
 
 The mapping between the field name and data type.
 
-### ResultRecord
-**type**: Record&lt;string, ResultRecordValue | null | undefined&gt;
-
+**type**: Record&lt;string, FieldType | undefined&gt;
 
+### ResultRecord
 
 Single record that contains the result fields.
 
-### Timeframe
-
-
+**type**: Record&lt;string, ResultRecordValue | null | undefined&gt;
 
+### Timeframe
 
 DQL data type timeframe.
 
@@ -1134,42 +1088,31 @@ DQL data type timeframe.
 
 ### TokenPosition
 
-
-
-
 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.
 
-| Name | Type |
-| --- | --- |
-|end<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>| 
-|start<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>|
+| Name | Type | Description |
+| --- | --- | --- |
+|end<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>|The exact position in the query string. |
+|start<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>|The exact position in the query string. |
 
 ### VerifyRequest
 
-
-
-
-
-
 | Name | Type | Description |
 | --- | --- | --- |
 |generateCanonicalQuery|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)| <i>default:</i> <code>false</code>|
 |locale|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|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'. |
 |query<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The full query string. |
-|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions" target="_blank" rel="noopener noreferrer">QueryOptions</a>|Query options enhance query functionality for Dynatrace internal services. |
 |timezone|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The query timezone. If none is specified, UTC is used as fallback. The list of valid input values matches that of the IANA Time Zone Database (TZDB). It accepts values in their canonical names like 'Europe/Paris', the abbreviated version like CET or the UTC offset format like '+01:00' |
 
 ### VerifyResponse
 
-
-
-
 Verify response.
 
 | Name | Type | Description |
 | --- | --- | --- |
 |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
-|notifications|Array&lt;<a href="#metadatanotification" target="_blank" rel="noopener noreferrer">MetadataNotification</a>&gt;|The notifications related to the supplied DQL query string. |
+|notifications|Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;|The notifications related to the supplied DQL query string. |
 |valid<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|True if the supplied DQL query string is valid. |
 
 ## Enums