@dynatrace-sdk/client-query 1.21.2 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.21.2",
+  "version": "1.22.0",
   "description": "Exposes an API to fetch records stored in Grail.",
   "license": "Apache-2.0",
   "dependencies": {

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

@@ -20,37 +20,67 @@ export declare class QueryAssistanceClient {
      */
     constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
     /**
-     * Verifies a query without executing it.
+     * Get a structured list of suggestions for the query at the given position.
      *
      * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ## Overview
      *
-     * Verifies the supplied query string and other query parameters for lack of any errors, but without actually
-     * submitting the query for execution.
+     * We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
+     * same results:
      *
-     * @returns {Promise<VerifyResponse>} Supplied query and parameters were verified.
+     * * `query: "f"`
+     * * `query: "f", cursorPosition:1`
+     * * `query: "fetch ", cursorPosition:1`
+     *
+     * Available fields:
+     *
+     * | Field       | Description                                                                                                                                                                             |
+     * |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+     * | suggestions | a list of suggestions. Each item is a separate possible suggestion, despite they might have the same outputs.                                                                           |
+     * | optional    | whether the suggestion is optional. If `true`, the query until the cursor position might work. If `false`, the query is definitely incomplete or invalid if cut at the cursor position. |
+     *
+     * Fields in the `suggestions`
+     *
+     * | Field                  | Description                                                                                                |
+     * |------------------------|------------------------------------------------------------------------------------------------------------|
+     * | suggestion             | a string representing the whole suggestion. This information could also be derived from the parts.         |
+     * | alreadyTypedCharacters | how many characters of this suggestion have already been typed (and will be overridden by the suggestion). |
+     * | parts                  | a list of semantically enriched information on what are the parts of a suggestion.                         |
+     *
+     * Fields in `parts`
+     *
+     * | Field      | Description                                               |
+     * |------------|-----------------------------------------------------------|
+     * | suggestion | a string representing the current part of the suggestion. |
+     * | type       | current types: SPACE, PIPE, COMMAND (may be extended)     |
+     *
+     * The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
+     * a link to docs, etc.
+     *
+     * @returns {Promise<AutocompleteResponse>} A list of structured autocomplete suggestions.
      *
      * @example <caption>Code example</caption>
      * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
      *
-     * const data = await queryAssistanceClient.queryVerify({
+     * const data = await queryAssistanceClient.queryAutocomplete({
      *   body: {
      *     query:
      *       '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 {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}
      */
-    queryVerify(config: {
-        body: VerifyRequest;
+    queryAutocomplete(config: {
+        body: AutocompleteRequest;
         /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
+        /** (DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
         abortSignal?: AbortSignal;
-    }): Promise<VerifyResponse>;
+    }): Promise<AutocompleteResponse>;
     /**
      * Get a structured tree of the canonical form of the query.
      *
@@ -269,66 +299,36 @@ export declare class QueryAssistanceClient {
         abortSignal?: AbortSignal;
     }): Promise<DQLNode>;
     /**
-     * Get a structured list of suggestions for the query at the given position.
+     * Verifies a query without executing it.
      *
      * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ## Overview
      *
-     * We provide a list of suggestions that may be used after the cursor position. The following queries will all provide the
-     * same results:
-     *
-     * * `query: "f"`
-     * * `query: "f", cursorPosition:1`
-     * * `query: "fetch ", cursorPosition:1`
-     *
-     * Available fields:
-     *
-     * | Field       | Description                                                                                                                                                                             |
-     * |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-     * | suggestions | a list of suggestions. Each item is a separate possible suggestion, despite they might have the same outputs.                                                                           |
-     * | optional    | whether the suggestion is optional. If `true`, the query until the cursor position might work. If `false`, the query is definitely incomplete or invalid if cut at the cursor position. |
-     *
-     * Fields in the `suggestions`
-     *
-     * | Field                  | Description                                                                                                |
-     * |------------------------|------------------------------------------------------------------------------------------------------------|
-     * | suggestion             | a string representing the whole suggestion. This information could also be derived from the parts.         |
-     * | alreadyTypedCharacters | how many characters of this suggestion have already been typed (and will be overridden by the suggestion). |
-     * | parts                  | a list of semantically enriched information on what are the parts of a suggestion.                         |
-     *
-     * Fields in `parts`
-     *
-     * | Field      | Description                                               |
-     * |------------|-----------------------------------------------------------|
-     * | suggestion | a string representing the current part of the suggestion. |
-     * | type       | current types: SPACE, PIPE, COMMAND (may be extended)     |
-     *
-     * The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
-     * a link to docs, etc.
+     * Verifies the supplied query string and other query parameters for lack of any errors, but without actually
+     * submitting the query for execution.
      *
-     * @returns {Promise<AutocompleteResponse>} A list of structured autocomplete suggestions.
+     * @returns {Promise<VerifyResponse>} Supplied query and parameters were verified.
      *
      * @example <caption>Code example</caption>
      * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
      *
-     * const data = await queryAssistanceClient.queryAutocomplete({
+     * const data = await queryAssistanceClient.queryVerify({
      *   body: {
      *     query:
      *       '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 {ErrorEnvelopeError} The supplied request is wrong. | An internal server error has occurred.
      * @throws {InvalidResponseError}
      * @throws {ApiClientError}
      * @throws {ClientRequestError}
      */
-    queryAutocomplete(config: {
-        body: AutocompleteRequest;
+    queryVerify(config: {
+        body: VerifyRequest;
         /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
-        /** (DEPRECATED use body parameter 'enforceQueryConsumptionLimit' instead) If set, query consumption limit will be enforced. */ enforceQueryConsumptionLimit?: boolean;
         abortSignal?: AbortSignal;
-    }): Promise<AutocompleteResponse>;
+    }): Promise<VerifyResponse>;
 }
 export declare const queryAssistanceClient: QueryAssistanceClient;

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

@@ -17,20 +17,22 @@ export declare class QueryExecutionClient {
      */
     constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
     /**
-     * Retrieves query status and final result from Grail.
+     * Cancels the query and returns the result if the query was already finished, otherwise discards it.
      *
      * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ### Overview:
      *
-     * Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
+     * Cancels a running Grail query and returns a list of records if the query already finished.
      *
      * ### The response format:
-     * The json response will contain the state of the query. If the query succeeded, the result will be included.
      *
-     * The result has two main sections:
-     * * The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
-     * * The 'types' section describes the corresponding data types that a record field has.
+     * If the query was already finished, a response body including the result will be returned. Otherwise the response will contain no body.
+     *
+     * The result has three main sections:
+     * * the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+     * * the 'types' section describes the corresponding data types that a record field has.
+     * * the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
      *
      * Every record has an implicit 'index' according to the position in the 'records' JSON array.
      * The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
@@ -52,12 +54,12 @@ 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 {Promise<QueryPollResponse>} The current status and results of the supplied query.
+     * @returns {Promise<QueryPollResponse | void>} The query already finished.
      *
      * @example <caption>Code example</caption>
      * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
      *
-     * const data = await queryExecutionClient.queryPoll({
+     * const data = await queryExecutionClient.queryCancel({
      *   requestToken: "...",
      * });
      *
@@ -66,13 +68,12 @@ export declare class QueryExecutionClient {
      * @throws {ApiClientError}
      * @throws {ClientRequestError}
      */
-    queryPoll(config: {
+    queryCancel(config: {
         /** The request-token of the query. */ requestToken: string;
-        /** 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 query status is returned. */ requestTimeoutMilliseconds?: number;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
         /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
-    }): Promise<QueryPollResponse>;
+    }): Promise<QueryPollResponse | void>;
     /**
      * Starts a Grail query.
      *
@@ -138,22 +139,20 @@ export declare class QueryExecutionClient {
         abortSignal?: AbortSignal;
     }): Promise<QueryStartResponse>;
     /**
-     * Cancels the query and returns the result if the query was already finished, otherwise discards it.
+     * Retrieves query status and final result from Grail.
      *
      * For information about the required permissions see the [Bucket and table permissions in Grail documentation](https://docs.dynatrace.com/docs/shortlink/assign-bucket-table-permissions).
      *
      * ### Overview:
      *
-     * Cancels a running Grail query and returns a list of records if the query already finished.
+     * Polls the status of a Grail query. Returns the status of the query, including the result if the query finished.
      *
      * ### The response format:
+     * The json response will contain the state of the query. If the query succeeded, the result will be included.
      *
-     * If the query was already finished, a response body including the result will be returned. Otherwise the response will contain no body.
-     *
-     * The result has three main sections:
-     * * the 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
-     * * the 'types' section describes the corresponding data types that a record field has.
-     * * the 'metadata' section contains information about the query like 'analysisTimeframe', 'timezone' or 'locale'.
+     * The result has two main sections:
+     * * The 'records' section contains the individual records, where each record consists of a set of fields and their corresponding values.
+     * * The 'types' section describes the corresponding data types that a record field has.
      *
      * Every record has an implicit 'index' according to the position in the 'records' JSON array.
      * The types section has a list of 1..N possible type 'buckets'. Each such bucket has an 'indexRange' which indicates which
@@ -175,12 +174,12 @@ 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 {Promise<QueryPollResponse | void>} The query already finished.
+     * @returns {Promise<QueryPollResponse>} The current status and results of the supplied query.
      *
      * @example <caption>Code example</caption>
      * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
      *
-     * const data = await queryExecutionClient.queryCancel({
+     * const data = await queryExecutionClient.queryPoll({
      *   requestToken: "...",
      * });
      *
@@ -189,11 +188,12 @@ export declare class QueryExecutionClient {
      * @throws {ApiClientError}
      * @throws {ClientRequestError}
      */
-    queryCancel(config: {
+    queryPoll(config: {
         /** The request-token of the query. */ requestToken: string;
+        /** Time the response is allowed to be delayed for either a preview or the final result to become available. No default value (immediate response). */ requestTimeoutMilliseconds?: number;
         /** If set additional data will be available in the metadata section. */ enrich?: string;
         /** The dt-client-context header is an optional string parameter used for monitoring purposes. When included in a request, it helps retrieve information about the execution of the query. It shouldn't hold sensitive information. */ dtClientContext?: string;
         abortSignal?: AbortSignal;
-    }): Promise<QueryPollResponse | void>;
+    }): Promise<QueryPollResponse>;
 }
 export declare const queryExecutionClient: QueryExecutionClient;

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

@@ -1,25 +1,31 @@
 import { QueryOptions } from './query-options';
 export interface AutocompleteRequest {
     /**
-     * The full query string.
+     * No upper limit but must be lower than length of query. No default value.
      */
-    query: string;
     cursorPosition?: number;
     /**
-     * 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'
+     * Boolean to indicate if the query consumption limit should be enforced
      */
-    timezone?: string;
+    enforceQueryConsumptionLimit?: boolean;
     /**
      * 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;
+    /**
+     * Limit the number of data suggestions, such as field names. No upper limit. No default value.
+     */
     maxDataSuggestions?: number;
+    /**
+     * The full query string.
+     */
+    query: string;
     /**
      * Query options enhance query functionality for Dynatrace internal services.
      */
     queryOptions?: QueryOptions;
     /**
-     * Boolean to indicate if the query consumption limit should be enforced
+     * 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'
      */
-    enforceQueryConsumptionLimit?: boolean;
+    timezone?: string;
 }

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

@@ -7,12 +7,12 @@ export interface AutocompleteResponse {
      * True if the suggestions are optional.
      */
     optional: boolean;
-    /**
-     * The list of suggestions.
-     */
-    suggestions: AutocompleteSuggestion[];
     /**
      * Suggested duration in seconds, for how long the response may be cached and reused by the client. It is derived from the volatility of the suggestions on the server (if the suggestions are static, how long the server will cache the volatile suggestions, ...). If not provided, then the result may be cached for long time. Value below 1 means that the result should not be cached.
      */
     suggestedTtlSeconds?: number;
+    /**
+     * The list of suggestions.
+     */
+    suggestions: AutocompleteSuggestion[];
 }

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

@@ -2,20 +2,20 @@
  * Part of the suggestion.
  */
 export interface AutocompleteSuggestionPart {
-    /**
-     * 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' | 'SEARCH_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' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE';
     /**
      * The type of the suggestion.
      */
     info?: string;
+    /**
+     * The suggested continuation of the query.
+     */
+    suggestion: string;
     /**
      * The synopsis of the suggestion.
      */
     synopsis?: string;
     /**
-     * The suggested continuation of the query.
+     * The type of the autocomplete token.
      */
-    suggestion: string;
+    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' | 'SEARCH_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' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE' | 'JSON_PATH' | 'URL';
 }

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

@@ -3,14 +3,14 @@ import { AutocompleteSuggestionPart } from './autocomplete-suggestion-part';
  * Single suggestion for completion of the query.
  */
 export interface AutocompleteSuggestion {
-    /**
-     * List of suggestion parts.
-     */
-    parts: AutocompleteSuggestionPart[];
     /**
      * Number of characters that the user already typed for this suggestion.
      */
     alreadyTypedCharacters: number;
+    /**
+     * List of suggestion parts.
+     */
+    parts: AutocompleteSuggestionPart[];
     /**
      * The suggested continuation of the query.
      */

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

@@ -0,0 +1,6 @@
+export interface BucketContribution {
+    matchedRecordsRatio?: number;
+    name?: string;
+    scannedBytes?: number;
+    table?: string;
+}

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

@@ -0,0 +1,4 @@
+import { BucketContribution } from './bucket-contribution';
+export interface Contributions {
+    buckets?: BucketContribution[];
+}

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

@@ -6,5 +6,5 @@ export interface DQLAlternativeNode extends DQLNode {
     /**
      * The different alternatives.
      */
-    alternatives?: object;
+    alternatives: object;
 }

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

@@ -4,11 +4,11 @@ import { DQLNode } from './dql-node';
  */
 export interface DQLContainerNode extends DQLNode {
     /**
-     * The type of the node.
+     * The list of children nodes.
      */
-    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: DQLNode[];
     /**
-     * The list of children nodes.
+     * The type of the node.
      */
-    children?: DQLNode[];
+    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';
 }

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

@@ -3,6 +3,10 @@ import { TokenPosition } from './token-position';
  * General Node in the DQL query.
  */
 export interface DQLNode {
+    /**
+     * True if the node is optional.
+     */
+    isOptional: boolean;
     /**
      * The type of the node.
      */
@@ -11,8 +15,4 @@ export interface DQLNode {
      * 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.
-     */
-    isOptional: boolean;
 }

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

@@ -4,15 +4,15 @@ import { DQLNode } from './dql-node';
  */
 export interface DQLTerminalNode extends DQLNode {
     /**
-     * The type of the autocomplete token.
+     * Canonical form.
      */
-    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' | 'SEARCH_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' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE';
+    canonicalString: string;
     /**
      * For optional items only: whether this node becomes mandatory when user order is used. True only for some optional 'ghost braces'
      */
-    isMandatoryOnUserOrder?: boolean;
+    isMandatoryOnUserOrder: boolean;
     /**
-     * Canonical form.
+     * The type of the autocomplete token.
      */
-    canonicalString?: string;
+    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' | 'SEARCH_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' | 'SEARCH_PATTERN' | 'ENTITY_SELECTOR_PART' | 'SAVED_TABLE_NAME' | 'TABULAR_FILE_NAME' | 'PARAMETER_MODIFIER' | 'FIELD_MODIFIER' | 'ENTITY_TYPE' | 'ENTITY_ATTRIBUTE' | 'SMARTSCAPE_ID_VALUE' | 'ENUM_STRING' | 'FIELD_PREFIX' | 'BUCKET' | 'SMARTSCAPE_NODE_PATTERN' | 'SMARTSCAPE_EDGE_PATTERN' | 'SMARTSCAPE_NODE_TYPE' | 'SMARTSCAPE_EDGE_TYPE' | 'JSON_PATH' | 'URL';
 }

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

@@ -3,12 +3,12 @@ export interface ErrorResponseDetailsConstraintViolationsItem {
      * Message describing the error.
      */
     message: string;
-    /**
-     * Describes the general location of the violating parameter.
-     */
-    parameterLocation?: string;
     /**
      * Describes the violating parameter.
      */
     parameterDescriptor?: string;
+    /**
+     * Describes the general location of the violating parameter.
+     */
+    parameterLocation?: string;
 }

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

@@ -5,48 +5,48 @@ import { TokenPosition } from './token-position';
  */
 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.
+     * The arguments for the message format.
      */
-    syntaxErrorPosition?: TokenPosition;
+    arguments?: string[];
     /**
-     * The error type, e.g. COMMAND_NAME_MISSING
+     * Information about an input parameter that violated some validation rule of the service API.
      */
-    errorType?: string;
+    constraintViolations?: ErrorResponseDetailsConstraintViolationsItem[];
     /**
      * Complete error message.
      */
     errorMessage?: string;
     /**
-     * The arguments for the message format.
-     */
-    arguments?: string[];
-    /**
-     * Submitted query string.
+     * The message format of the error message, string.format based.
      */
-    queryString?: string;
+    errorMessageFormat?: string;
     /**
      * The corresponding DQL format specifier types for each format specifier used in the error message format.
      */
     errorMessageFormatSpecifierTypes?: string[];
     /**
-     * The message format of the error message, string.format based.
+     * The error type, e.g. COMMAND_NAME_MISSING
      */
-    errorMessageFormat?: string;
-    queryId?: string;
+    errorType?: string;
     /**
-     * Information about an input parameter that violated some validation rule of the service API.
+     * The exception type.
      */
-    constraintViolations?: ErrorResponseDetailsConstraintViolationsItem[];
+    exceptionType?: string;
+    /**
+     * List of missing IAM permissions necessary to successfully execute the request.
+     */
+    missingPermissions?: string[];
     /**
      * List of missing IAM scopes necessary to successfully execute the request.
      */
     missingScopes?: string[];
+    queryId?: string;
     /**
-     * List of missing IAM permissions necessary to successfully execute the request.
+     * Submitted query string.
      */
-    missingPermissions?: string[];
+    queryString?: 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;
 }

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

@@ -4,17 +4,17 @@ import { ErrorResponseDetails } from './error-response-details';
  */
 export interface ErrorResponse {
     /**
-     * A short, clear error message without details
+     * Error code, which normally matches the HTTP error code.
      */
-    message: string;
+    code: number;
     /**
      * Detailed information about the error.
      */
     details?: ErrorResponseDetails;
     /**
-     * Error code, which normally matches the HTTP error code.
+     * A short, clear error message without details
      */
-    code: number;
+    message: string;
     /**
      * The number of seconds to wait until the next retry.
      */