@dynatrace-sdk/client-query 1.11.1 → 1.12.1

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 @dynatrace-sdk/client-query
 
+## 1.12.1
+
+### Patch Changes
+
+- Updated boolean serialization handling. APPDEV-9047
+
+## 1.12.0
+
+### Minor Changes
+
+- Client updated to support latest API changes. NOISSUE
+- Updated dependencies
+  - @dynatrace-sdk/http-client@1.3.0
+
+### Patch Changes
+
+- Documentation removed from the package. APPDEV-8356
+
 ## 1.11.1
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # @dynatrace-sdk/client-query
 
-[![npm](https://img.shields.io/badge/npm-v1.11.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.11.1)
+[![npm](https://img.shields.io/badge/npm-v1.12.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.12.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
@@ -826,7 +826,7 @@ 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<sup>*required</sup>|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>| |
+|details|<a href="#errorresponsedetails" target="_blank" rel="noopener noreferrer">ErrorResponseDetails</a>| |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short, clear error message without details |
 
 ### ErrorResponseDetails
@@ -838,15 +838,31 @@ Detailed information about the error.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|arguments<sup>*required</sup>|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
-|errorMessage<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
-|errorMessageFormat<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
-|errorMessageFormatSpecifierTypes<sup>*required</sup>|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. |
-|errorType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error type, e.g. COMMAND_NAME_MISSING |
-|exceptionType<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The exception type. |
+|arguments|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|The arguments for the message format. |
+|constraintViolations|Array&lt;<a href="#errorresponsedetailsconstraintviolationsitem">ErrorResponseDetailsConstraintViolationsItem</a>&gt;|Information about an input parameter that violated some validation rule of the service API. |
+|errorMessage|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Complete error message. |
+|errorMessageFormat|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The message format of the error message, string.format based. |
+|errorMessageFormatSpecifierTypes|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. |
+|errorType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error type, e.g. COMMAND_NAME_MISSING |
+|exceptionType|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The exception type. |
+|missingPermissions|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|List of missing IAM permissions necessary to successfully execute the request. |
+|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<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Submitted query string. |
-|syntaxErrorPosition|<a href="#tokenposition">TokenPosition</a>| |
+|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>| |
+
+### ErrorResponseDetailsConstraintViolationsItem
+
+
+
+
+
+
+| Name | Type | Description |
+| --- | --- | --- |
+|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Message describing the error. |
+|parameterDescriptor|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Describes the violating parameter. |
+|parameterLocation|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Describes the general location of the violating parameter. |
 
 ### ExecuteRequest
 
@@ -867,7 +883,7 @@ Detailed information about the error.
 |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">QueryOptions</a>| |
 |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' |
 
@@ -881,7 +897,7 @@ The possible type of a field in DQL.
 | Name | Type |
 | --- | --- |
 |type<sup>*required</sup>|FieldTypeType| 
-|types|Array&lt;<a href="#rangedfieldtypes">RangedFieldTypes</a>&gt;|
+|types|Array&lt;<a href="#rangedfieldtypes" target="_blank" rel="noopener noreferrer">RangedFieldTypes</a>&gt;|
 
 ### GeoPoint
 
@@ -904,12 +920,12 @@ Collects various bits of metadata information.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|analysisTimeframe|<a href="#timeframe" target="_blank" rel="noopener noreferrer">Timeframe</a>| |
+|analysisTimeframe|<a href="#timeframe">Timeframe</a>| |
 |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">MetadataNotification</a>&gt;|Collected messages during the execution of the query. |
+|notifications|Array&lt;<a href="#metadatanotification" target="_blank" rel="noopener noreferrer">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. |
@@ -927,8 +943,8 @@ Collects various bits of metadata information.
 
 | Name | Type |
 | --- | --- |
-|grail|<a href="#grailmetadata" target="_blank" rel="noopener noreferrer">GrailMetadata</a>| 
-|metrics|Array&lt;<a href="#metricmetadata">MetricMetadata</a>&gt;|
+|grail|<a href="#grailmetadata">GrailMetadata</a>| 
+|metrics|Array&lt;<a href="#metricmetadata" target="_blank" rel="noopener noreferrer">MetricMetadata</a>&gt;|
 
 ### MetadataNotification
 
@@ -945,7 +961,7 @@ 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" target="_blank" rel="noopener noreferrer">TokenPosition</a>| |
+|syntaxPosition|<a href="#tokenposition">TokenPosition</a>| |
 
 ### MetricMetadata
 
@@ -976,7 +992,7 @@ An object that defines additional metric metadata.
 | --- | --- | --- |
 |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>| |
 |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
@@ -1009,7 +1025,7 @@ 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" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
+|result|<a href="#queryresult">QueryResult</a>| |
 |state<sup>*required</sup>|QueryState| |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
@@ -1022,9 +1038,9 @@ The result of the DQL query.
 
 | Name | Type | Description |
 | --- | --- | --- |
-|metadata<sup>*required</sup>|<a href="#metadata">Metadata</a>| |
-|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. |
+|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. |
 
 ### QueryStartResponse
 
@@ -1037,7 +1053,7 @@ The response when starting a query.
 | --- | --- | --- |
 |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" target="_blank" rel="noopener noreferrer">QueryResult</a>| |
+|result|<a href="#queryresult">QueryResult</a>| |
 |state<sup>*required</sup>|QueryState| |
 |ttlSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Time to live in seconds. |
 
@@ -1051,7 +1067,7 @@ 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">RangedFieldTypesMappings</a>| |
+|mappings<sup>*required</sup>|<a href="#rangedfieldtypesmappings" target="_blank" rel="noopener noreferrer">RangedFieldTypesMappings</a>| |
 
 ### RangedFieldTypesMappings
 **type**: Record&lt;string, FieldType | undefined&gt;
@@ -1088,8 +1104,8 @@ The position of a token in a query string used for errors and notification to ma
 
 | Name | Type |
 | --- | --- |
-|end<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>| 
-|start<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>|
+|end<sup>*required</sup>|<a href="#positioninfo">PositionInfo</a>| 
+|start<sup>*required</sup>|<a href="#positioninfo" target="_blank" rel="noopener noreferrer">PositionInfo</a>|
 
 ### VerifyRequest
 
@@ -1103,7 +1119,7 @@ The position of a token in a query string used for errors and notification to ma
 |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" target="_blank" rel="noopener noreferrer">QueryOptions</a>| |
+|queryOptions|<a href="#queryoptions">QueryOptions</a>| |
 |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
@@ -1116,7 +1132,7 @@ Verify response.
 | Name | Type | Description |
 | --- | --- | --- |
 |canonicalQuery|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
-|notifications|Array&lt;<a href="#metadatanotification">MetadataNotification</a>&gt;|The notifications related to the supplied DQL query string. |
+|notifications|Array&lt;<a href="#metadatanotification" target="_blank" rel="noopener noreferrer">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