@elastic/elasticsearch 8.16.2 → 8.16.3

package/lib/api/api/count.d.ts

@@ -5,7 +5,7 @@ interface That {
     transport: Transport;
 }
 /**
-  * Returns number of documents matching a query.
+  * Count search results. Get the number of documents matching a query.
   * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-count.html | Elasticsearch API documentation}
   */
 export default function CountApi(this: That, params?: T.CountRequest | TB.CountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CountResponse>;

package/lib/api/api/enrich.d.ts

@@ -15,7 +15,7 @@ export default class Enrich {
     deletePolicy(this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EnrichDeletePolicyResponse, unknown>>;
     deletePolicy(this: That, params: T.EnrichDeletePolicyRequest | TB.EnrichDeletePolicyRequest, options?: TransportRequestOptions): Promise<T.EnrichDeletePolicyResponse>;
     /**
-      * Creates the enrich index for an existing enrich policy.
+      * Run an enrich policy. Create the enrich index for an existing enrich policy.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html | Elasticsearch API documentation}
       */
     executePolicy(this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichExecutePolicyResponse>;

package/lib/api/api/eql.d.ts

@@ -8,28 +8,28 @@ export default class Eql {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
+      * Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html | Elasticsearch API documentation}
       */
     delete(this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlDeleteResponse>;
     delete(this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlDeleteResponse, unknown>>;
     delete(this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptions): Promise<T.EqlDeleteResponse>;
     /**
-      * Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
+      * Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html | Elasticsearch API documentation}
       */
     get<TEvent = unknown>(this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetResponse<TEvent>>;
     get<TEvent = unknown>(this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetResponse<TEvent>, unknown>>;
     get<TEvent = unknown>(this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptions): Promise<T.EqlGetResponse<TEvent>>;
     /**
-      * Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
+      * Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html | Elasticsearch API documentation}
       */
     getStatus(this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetStatusResponse>;
     getStatus(this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetStatusResponse, unknown>>;
     getStatus(this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptions): Promise<T.EqlGetStatusResponse>;
     /**
-      * Returns results matching a query expressed in Event Query Language (EQL)
+      * Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html | Elasticsearch API documentation}
       */
     search<TEvent = unknown>(this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlSearchResponse<TEvent>>;

package/lib/api/api/esql.d.ts

@@ -22,7 +22,7 @@ export default class Esql {
     asyncQueryGet(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
     asyncQueryGet(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
-      * Executes an ES|QL request
+      * Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html | Elasticsearch API documentation}
       */
     query(this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EsqlQueryResponse>;

package/lib/api/api/graph.d.ts

@@ -8,7 +8,7 @@ export default class Graph {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
+      * Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html | Elasticsearch API documentation}
       */
     explore(this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GraphExploreResponse>;

package/lib/api/api/indices.d.ts

@@ -134,7 +134,7 @@ export default class Indices {
     existsAlias(this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExistsAliasResponse, unknown>>;
     existsAlias(this: That, params: T.IndicesExistsAliasRequest | TB.IndicesExistsAliasRequest, options?: TransportRequestOptions): Promise<T.IndicesExistsAliasResponse>;
     /**
-      * Returns information about whether a particular index template exists.
+      * Check index templates. Check whether index templates exist.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-templates.html | Elasticsearch API documentation}
       */
     existsIndexTemplate(this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsIndexTemplateResponse>;
@@ -337,7 +337,7 @@ export default class Indices {
     resolveCluster(this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesResolveClusterResponse, unknown>>;
     resolveCluster(this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptions): Promise<T.IndicesResolveClusterResponse>;
     /**
-      * Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
+      * Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-index-api.html | Elasticsearch API documentation}
       */
     resolveIndex(this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesResolveIndexResponse>;

package/lib/api/api/ingest.d.ts

@@ -8,7 +8,7 @@ export default class Ingest {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Deletes a geoip database configuration.
+      * Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-geoip-database-api.html | Elasticsearch API documentation}
       */
     deleteGeoipDatabase(this: That, params: T.IngestDeleteGeoipDatabaseRequest | TB.IngestDeleteGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestDeleteGeoipDatabaseResponse>;
@@ -22,21 +22,21 @@ export default class Ingest {
     deleteIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
     deleteIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
-      * Deletes one or more existing ingest pipeline.
+      * Delete pipelines. Delete one or more ingest pipelines.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-pipeline-api.html | Elasticsearch API documentation}
       */
     deletePipeline(this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestDeletePipelineResponse>;
     deletePipeline(this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IngestDeletePipelineResponse, unknown>>;
     deletePipeline(this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptions): Promise<T.IngestDeletePipelineResponse>;
     /**
-      * Gets download statistics for GeoIP2 databases used with the geoip processor.
+      * Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-processor.html | Elasticsearch API documentation}
       */
     geoIpStats(this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGeoIpStatsResponse>;
     geoIpStats(this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IngestGeoIpStatsResponse, unknown>>;
     geoIpStats(this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptions): Promise<T.IngestGeoIpStatsResponse>;
     /**
-      * Returns information about one or more geoip database configurations.
+      * Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-geoip-database-api.html | Elasticsearch API documentation}
       */
     getGeoipDatabase(this: That, params?: T.IngestGetGeoipDatabaseRequest | TB.IngestGetGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGetGeoipDatabaseResponse>;
@@ -50,21 +50,21 @@ export default class Ingest {
     getIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
     getIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
-      * Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.
+      * Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-pipeline-api.html | Elasticsearch API documentation}
       */
     getPipeline(this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGetPipelineResponse>;
     getPipeline(this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IngestGetPipelineResponse, unknown>>;
     getPipeline(this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptions): Promise<T.IngestGetPipelineResponse>;
     /**
-      * Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
+      * Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html | Elasticsearch API documentation}
       */
     processorGrok(this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestProcessorGrokResponse>;
     processorGrok(this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IngestProcessorGrokResponse, unknown>>;
     processorGrok(this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptions): Promise<T.IngestProcessorGrokResponse>;
     /**
-      * Returns information about one or more geoip database configurations.
+      * Create or update GeoIP database configurations. Create or update IP geolocation database configurations.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-geoip-database-api.html | Elasticsearch API documentation}
       */
     putGeoipDatabase(this: That, params: T.IngestPutGeoipDatabaseRequest | TB.IngestPutGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestPutGeoipDatabaseResponse>;
@@ -78,14 +78,14 @@ export default class Ingest {
     putIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
     putIpLocationDatabase(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
     /**
-      * Creates or updates an ingest pipeline. Changes made using this API take effect immediately.
+      * Create or update a pipeline. Changes made using this API take effect immediately.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html | Elasticsearch API documentation}
       */
     putPipeline(this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestPutPipelineResponse>;
     putPipeline(this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IngestPutPipelineResponse, unknown>>;
     putPipeline(this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptions): Promise<T.IngestPutPipelineResponse>;
     /**
-      * Executes an ingest pipeline against a set of provided documents.
+      * Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/simulate-pipeline-api.html | Elasticsearch API documentation}
       */
     simulate(this: That, params: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestSimulateResponse>;

package/lib/api/api/query_rules.d.ts

@@ -8,56 +8,56 @@ export default class QueryRules {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Deletes a query rule within a query ruleset.
+      * Delete a query rule. Delete a query rule within a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-rule.html | Elasticsearch API documentation}
       */
     deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest | TB.QueryRulesDeleteRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRuleResponse>;
     deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest | TB.QueryRulesDeleteRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesDeleteRuleResponse, unknown>>;
     deleteRule(this: That, params: T.QueryRulesDeleteRuleRequest | TB.QueryRulesDeleteRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesDeleteRuleResponse>;
     /**
-      * Deletes a query ruleset.
+      * Delete a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-ruleset.html | Elasticsearch API documentation}
       */
     deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest | TB.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRulesetResponse>;
     deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest | TB.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesDeleteRulesetResponse, unknown>>;
     deleteRuleset(this: That, params: T.QueryRulesDeleteRulesetRequest | TB.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesDeleteRulesetResponse>;
     /**
-      * Returns the details about a query rule within a query ruleset
+      * Get a query rule. Get details about a query rule within a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-rule.html | Elasticsearch API documentation}
       */
     getRule(this: That, params: T.QueryRulesGetRuleRequest | TB.QueryRulesGetRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRuleResponse>;
     getRule(this: That, params: T.QueryRulesGetRuleRequest | TB.QueryRulesGetRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesGetRuleResponse, unknown>>;
     getRule(this: That, params: T.QueryRulesGetRuleRequest | TB.QueryRulesGetRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesGetRuleResponse>;
     /**
-      * Returns the details about a query ruleset
+      * Get a query ruleset. Get details about a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-ruleset.html | Elasticsearch API documentation}
       */
     getRuleset(this: That, params: T.QueryRulesGetRulesetRequest | TB.QueryRulesGetRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRulesetResponse>;
     getRuleset(this: That, params: T.QueryRulesGetRulesetRequest | TB.QueryRulesGetRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesGetRulesetResponse, unknown>>;
     getRuleset(this: That, params: T.QueryRulesGetRulesetRequest | TB.QueryRulesGetRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesGetRulesetResponse>;
     /**
-      * Returns summarized information about existing query rulesets.
+      * Get all query rulesets. Get summarized information about the query rulesets.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-query-rulesets.html | Elasticsearch API documentation}
       */
     listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest | TB.QueryRulesListRulesetsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesListRulesetsResponse>;
     listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest | TB.QueryRulesListRulesetsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesListRulesetsResponse, unknown>>;
     listRulesets(this: That, params?: T.QueryRulesListRulesetsRequest | TB.QueryRulesListRulesetsRequest, options?: TransportRequestOptions): Promise<T.QueryRulesListRulesetsResponse>;
     /**
-      * Creates or updates a query rule within a query ruleset.
+      * Create or update a query rule. Create or update a query rule within a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-rule.html | Elasticsearch API documentation}
       */
     putRule(this: That, params: T.QueryRulesPutRuleRequest | TB.QueryRulesPutRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRuleResponse>;
     putRule(this: That, params: T.QueryRulesPutRuleRequest | TB.QueryRulesPutRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesPutRuleResponse, unknown>>;
     putRule(this: That, params: T.QueryRulesPutRuleRequest | TB.QueryRulesPutRuleRequest, options?: TransportRequestOptions): Promise<T.QueryRulesPutRuleResponse>;
     /**
-      * Creates or updates a query ruleset.
+      * Create or update a query ruleset.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-ruleset.html | Elasticsearch API documentation}
       */
     putRuleset(this: That, params: T.QueryRulesPutRulesetRequest | TB.QueryRulesPutRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRulesetResponse>;
     putRuleset(this: That, params: T.QueryRulesPutRulesetRequest | TB.QueryRulesPutRulesetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesPutRulesetResponse, unknown>>;
     putRuleset(this: That, params: T.QueryRulesPutRulesetRequest | TB.QueryRulesPutRulesetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesPutRulesetResponse>;
     /**
-      * Creates or updates a query ruleset.
+      * Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-query-ruleset.html | Elasticsearch API documentation}
       */
     test(this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesTestResponse>;

package/lib/api/api/sql.d.ts

@@ -8,42 +8,42 @@ export default class Sql {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Clears the SQL cursor
+      * Clear an SQL search cursor.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-sql-cursor-api.html | Elasticsearch API documentation}
       */
     clearCursor(this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlClearCursorResponse>;
     clearCursor(this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SqlClearCursorResponse, unknown>>;
     clearCursor(this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptions): Promise<T.SqlClearCursorResponse>;
     /**
-      * Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+      * Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-async-sql-search-api.html | Elasticsearch API documentation}
       */
     deleteAsync(this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlDeleteAsyncResponse>;
     deleteAsync(this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SqlDeleteAsyncResponse, unknown>>;
     deleteAsync(this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptions): Promise<T.SqlDeleteAsyncResponse>;
     /**
-      * Returns the current status and available results for an async SQL search or stored synchronous SQL search
+      * Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-api.html | Elasticsearch API documentation}
       */
     getAsync(this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlGetAsyncResponse>;
     getAsync(this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SqlGetAsyncResponse, unknown>>;
     getAsync(this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptions): Promise<T.SqlGetAsyncResponse>;
     /**
-      * Returns the current status of an async SQL search or a stored synchronous SQL search
+      * Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-status-api.html | Elasticsearch API documentation}
       */
     getAsyncStatus(this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlGetAsyncStatusResponse>;
     getAsyncStatus(this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SqlGetAsyncStatusResponse, unknown>>;
     getAsyncStatus(this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptions): Promise<T.SqlGetAsyncStatusResponse>;
     /**
-      * Executes a SQL request
+      * Get SQL search results. Run an SQL request.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-search-api.html | Elasticsearch API documentation}
       */
     query(this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlQueryResponse>;
     query(this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SqlQueryResponse, unknown>>;
     query(this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptions): Promise<T.SqlQueryResponse>;
     /**
-      * Translates SQL into Elasticsearch queries
+      * Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-translate-api.html | Elasticsearch API documentation}
       */
     translate(this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlTranslateResponse>;

package/lib/api/api/synonyms.d.ts

@@ -8,49 +8,49 @@ export default class Synonyms {
     transport: Transport;
     constructor(transport: Transport);
     /**
-      * Deletes a synonym set
+      * Delete a synonym set.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonyms-set.html | Elasticsearch API documentation}
       */
     deleteSynonym(this: That, params: T.SynonymsDeleteSynonymRequest | TB.SynonymsDeleteSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsDeleteSynonymResponse>;
     deleteSynonym(this: That, params: T.SynonymsDeleteSynonymRequest | TB.SynonymsDeleteSynonymRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsDeleteSynonymResponse, unknown>>;
     deleteSynonym(this: That, params: T.SynonymsDeleteSynonymRequest | TB.SynonymsDeleteSynonymRequest, options?: TransportRequestOptions): Promise<T.SynonymsDeleteSynonymResponse>;
     /**
-      * Deletes a synonym rule in a synonym set
+      * Delete a synonym rule. Delete a synonym rule from a synonym set.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonym-rule.html | Elasticsearch API documentation}
       */
     deleteSynonymRule(this: That, params: T.SynonymsDeleteSynonymRuleRequest | TB.SynonymsDeleteSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsDeleteSynonymRuleResponse>;
     deleteSynonymRule(this: That, params: T.SynonymsDeleteSynonymRuleRequest | TB.SynonymsDeleteSynonymRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsDeleteSynonymRuleResponse, unknown>>;
     deleteSynonymRule(this: That, params: T.SynonymsDeleteSynonymRuleRequest | TB.SynonymsDeleteSynonymRuleRequest, options?: TransportRequestOptions): Promise<T.SynonymsDeleteSynonymRuleResponse>;
     /**
-      * Retrieves a synonym set
+      * Get a synonym set.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonyms-set.html | Elasticsearch API documentation}
       */
     getSynonym(this: That, params: T.SynonymsGetSynonymRequest | TB.SynonymsGetSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymResponse>;
     getSynonym(this: That, params: T.SynonymsGetSynonymRequest | TB.SynonymsGetSynonymRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsGetSynonymResponse, unknown>>;
     getSynonym(this: That, params: T.SynonymsGetSynonymRequest | TB.SynonymsGetSynonymRequest, options?: TransportRequestOptions): Promise<T.SynonymsGetSynonymResponse>;
     /**
-      * Retrieves a synonym rule from a synonym set
+      * Get a synonym rule. Get a synonym rule from a synonym set.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonym-rule.html | Elasticsearch API documentation}
       */
     getSynonymRule(this: That, params: T.SynonymsGetSynonymRuleRequest | TB.SynonymsGetSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymRuleResponse>;
     getSynonymRule(this: That, params: T.SynonymsGetSynonymRuleRequest | TB.SynonymsGetSynonymRuleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsGetSynonymRuleResponse, unknown>>;
     getSynonymRule(this: That, params: T.SynonymsGetSynonymRuleRequest | TB.SynonymsGetSynonymRuleRequest, options?: TransportRequestOptions): Promise<T.SynonymsGetSynonymRuleResponse>;
     /**
-      * Retrieves a summary of all defined synonym sets
+      * Get all synonym sets. Get a summary of all defined synonym sets.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-synonyms-sets.html | Elasticsearch API documentation}
       */
     getSynonymsSets(this: That, params?: T.SynonymsGetSynonymsSetsRequest | TB.SynonymsGetSynonymsSetsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymsSetsResponse>;
     getSynonymsSets(this: That, params?: T.SynonymsGetSynonymsSetsRequest | TB.SynonymsGetSynonymsSetsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsGetSynonymsSetsResponse, unknown>>;
     getSynonymsSets(this: That, params?: T.SynonymsGetSynonymsSetsRequest | TB.SynonymsGetSynonymsSetsRequest, options?: TransportRequestOptions): Promise<T.SynonymsGetSynonymsSetsResponse>;
     /**
-      * Creates or updates a synonym set.
+      * Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonyms-set.html | Elasticsearch API documentation}
       */
     putSynonym(this: That, params: T.SynonymsPutSynonymRequest | TB.SynonymsPutSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsPutSynonymResponse>;
     putSynonym(this: That, params: T.SynonymsPutSynonymRequest | TB.SynonymsPutSynonymRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SynonymsPutSynonymResponse, unknown>>;
     putSynonym(this: That, params: T.SynonymsPutSynonymRequest | TB.SynonymsPutSynonymRequest, options?: TransportRequestOptions): Promise<T.SynonymsPutSynonymResponse>;
     /**
-      * Creates or updates a synonym rule in a synonym set
+      * Create or update a synonym rule. Create or update a synonym rule in a synonym set.
       * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonym-rule.html | Elasticsearch API documentation}
       */
     putSynonymRule(this: That, params: T.SynonymsPutSynonymRuleRequest | TB.SynonymsPutSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsPutSynonymRuleResponse>;

package/lib/api/types.d.ts

@@ -747,6 +747,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
     preference?: string;
     routing?: Routing;
     expand_wildcards?: ExpandWildcards;
+    allow_partial_search_results?: boolean;
     index_filter?: QueryDslQueryContainer;
 }
 export interface OpenPointInTimeResponse {
@@ -5583,6 +5584,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
 export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>;
 export interface AsyncSearchStatusRequest extends RequestBase {
     id: Id;
+    keep_alive?: Duration;
 }
 export type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase;
 export interface AsyncSearchStatusStatusResponseBase extends AsyncSearchAsyncSearchResponseBase {
@@ -5613,7 +5615,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
     pre_filter_shard_size?: long;
     request_cache?: boolean;
     routing?: Routing;
-    scroll?: Duration;
     search_type?: SearchType;
     suggest_field?: Field;
     suggest_mode?: SuggestMode;
@@ -5666,6 +5667,8 @@ export interface AutoscalingAutoscalingPolicy {
 }
 export interface AutoscalingDeleteAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
+    timeout?: Duration;
 }
 export type AutoscalingDeleteAutoscalingPolicyResponse = AcknowledgedResponseBase;
 export interface AutoscalingGetAutoscalingCapacityAutoscalingCapacity {
@@ -5691,16 +5694,20 @@ export interface AutoscalingGetAutoscalingCapacityAutoscalingResources {
     memory: integer;
 }
 export interface AutoscalingGetAutoscalingCapacityRequest extends RequestBase {
+    master_timeout?: Duration;
 }
 export interface AutoscalingGetAutoscalingCapacityResponse {
     policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>;
 }
 export interface AutoscalingGetAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
 }
 export type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy;
 export interface AutoscalingPutAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
+    timeout?: Duration;
     policy?: AutoscalingAutoscalingPolicy;
 }
 export type AutoscalingPutAutoscalingPolicyResponse = AcknowledgedResponseBase;
@@ -11412,10 +11419,12 @@ export interface LogstashPutPipelineRequest extends RequestBase {
 }
 export type LogstashPutPipelineResponse = boolean;
 export interface MigrationDeprecationsDeprecation {
-    details: string;
+    details?: string;
     level: MigrationDeprecationsDeprecationLevel;
     message: string;
     url: string;
+    resolve_during_rolling_upgrade: boolean;
+    _meta?: Record<string, any>;
 }
 export type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical';
 export interface MigrationDeprecationsRequest extends RequestBase {
@@ -14134,7 +14143,7 @@ export interface NodesInfoNodeInfoPath {
     logs?: string;
     home?: string;
     repo?: string[];
-    data?: string[];
+    data?: string | string[];
 }
 export interface NodesInfoNodeInfoRepositories {
     url: NodesInfoNodeInfoRepositoriesUrl;
@@ -14430,6 +14439,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem {
     ruleset_id: Id;
     rule_total_count: integer;
     rule_criteria_types_counts: Record<string, integer>;
+    rule_type_counts: Record<string, integer>;
 }
 export interface QueryRulesListRulesetsRequest extends RequestBase {
     from?: integer;
@@ -14753,20 +14763,24 @@ export interface SecurityAccess {
     search?: SecuritySearchAccess[];
 }
 export interface SecurityApiKey {
-    creation?: long;
-    expiration?: long;
     id: Id;
-    invalidated?: boolean;
     name: Name;
-    realm?: string;
+    type: SecurityApiKeyType;
+    creation: EpochTime<UnitMillis>;
+    expiration?: EpochTime<UnitMillis>;
+    invalidated: boolean;
+    invalidation?: EpochTime<UnitMillis>;
+    username: Username;
+    realm: string;
     realm_type?: string;
-    username?: Username;
-    profile_uid?: string;
-    metadata?: Metadata;
+    metadata: Metadata;
     role_descriptors?: Record<string, SecurityRoleDescriptor>;
     limited_by?: Record<string, SecurityRoleDescriptor>[];
+    access?: SecurityAccess;
+    profile_uid?: string;
     _sort?: SortResults;
 }
+export type SecurityApiKeyType = 'rest' | 'cross_cluster';
 export interface SecurityApplicationGlobalUserPrivileges {
     manage: SecurityManageUserPrivileges;
 }
@@ -14931,10 +14945,14 @@ export interface SecurityActivateUserProfileRequest extends RequestBase {
     username?: string;
 }
 export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata;
+export interface SecurityAuthenticateAuthenticateApiKey {
+    id: Id;
+    name?: Name;
+}
 export interface SecurityAuthenticateRequest extends RequestBase {
 }
 export interface SecurityAuthenticateResponse {
-    api_key?: SecurityApiKey;
+    api_key?: SecurityAuthenticateAuthenticateApiKey;
     authentication_realm: SecurityRealmInfo;
     email?: string | null;
     full_name?: Name | null;

package/lib/api/typesWithBodyKey.d.ts

@@ -780,6 +780,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
     preference?: string;
     routing?: Routing;
     expand_wildcards?: ExpandWildcards;
+    allow_partial_search_results?: boolean;
     /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
     body?: {
         index_filter?: QueryDslQueryContainer;
@@ -5659,6 +5660,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
 export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<AggregateName, AggregationsAggregate>> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, TAggregations>;
 export interface AsyncSearchStatusRequest extends RequestBase {
     id: Id;
+    keep_alive?: Duration;
 }
 export type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase;
 export interface AsyncSearchStatusStatusResponseBase extends AsyncSearchAsyncSearchResponseBase {
@@ -5689,7 +5691,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
     pre_filter_shard_size?: long;
     request_cache?: boolean;
     routing?: Routing;
-    scroll?: Duration;
     search_type?: SearchType;
     suggest_field?: Field;
     suggest_mode?: SuggestMode;
@@ -5745,6 +5746,8 @@ export interface AutoscalingAutoscalingPolicy {
 }
 export interface AutoscalingDeleteAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
+    timeout?: Duration;
 }
 export type AutoscalingDeleteAutoscalingPolicyResponse = AcknowledgedResponseBase;
 export interface AutoscalingGetAutoscalingCapacityAutoscalingCapacity {
@@ -5770,16 +5773,20 @@ export interface AutoscalingGetAutoscalingCapacityAutoscalingResources {
     memory: integer;
 }
 export interface AutoscalingGetAutoscalingCapacityRequest extends RequestBase {
+    master_timeout?: Duration;
 }
 export interface AutoscalingGetAutoscalingCapacityResponse {
     policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>;
 }
 export interface AutoscalingGetAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
 }
 export type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy;
 export interface AutoscalingPutAutoscalingPolicyRequest extends RequestBase {
     name: Name;
+    master_timeout?: Duration;
+    timeout?: Duration;
     /** @deprecated The use of the 'body' key has been deprecated, use 'policy' instead. */
     body?: AutoscalingAutoscalingPolicy;
 }
@@ -11653,10 +11660,12 @@ export interface LogstashPutPipelineRequest extends RequestBase {
 }
 export type LogstashPutPipelineResponse = boolean;
 export interface MigrationDeprecationsDeprecation {
-    details: string;
+    details?: string;
     level: MigrationDeprecationsDeprecationLevel;
     message: string;
     url: string;
+    resolve_during_rolling_upgrade: boolean;
+    _meta?: Record<string, any>;
 }
 export type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical';
 export interface MigrationDeprecationsRequest extends RequestBase {
@@ -14489,7 +14498,7 @@ export interface NodesInfoNodeInfoPath {
     logs?: string;
     home?: string;
     repo?: string[];
-    data?: string[];
+    data?: string | string[];
 }
 export interface NodesInfoNodeInfoRepositories {
     url: NodesInfoNodeInfoRepositoriesUrl;
@@ -14788,6 +14797,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem {
     ruleset_id: Id;
     rule_total_count: integer;
     rule_criteria_types_counts: Record<string, integer>;
+    rule_type_counts: Record<string, integer>;
 }
 export interface QueryRulesListRulesetsRequest extends RequestBase {
     from?: integer;
@@ -15133,20 +15143,24 @@ export interface SecurityAccess {
     search?: SecuritySearchAccess[];
 }
 export interface SecurityApiKey {
-    creation?: long;
-    expiration?: long;
     id: Id;
-    invalidated?: boolean;
     name: Name;
-    realm?: string;
+    type: SecurityApiKeyType;
+    creation: EpochTime<UnitMillis>;
+    expiration?: EpochTime<UnitMillis>;
+    invalidated: boolean;
+    invalidation?: EpochTime<UnitMillis>;
+    username: Username;
+    realm: string;
     realm_type?: string;
-    username?: Username;
-    profile_uid?: string;
-    metadata?: Metadata;
+    metadata: Metadata;
     role_descriptors?: Record<string, SecurityRoleDescriptor>;
     limited_by?: Record<string, SecurityRoleDescriptor>[];
+    access?: SecurityAccess;
+    profile_uid?: string;
     _sort?: SortResults;
 }
+export type SecurityApiKeyType = 'rest' | 'cross_cluster';
 export interface SecurityApplicationGlobalUserPrivileges {
     manage: SecurityManageUserPrivileges;
 }
@@ -15314,10 +15328,14 @@ export interface SecurityActivateUserProfileRequest extends RequestBase {
     };
 }
 export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata;
+export interface SecurityAuthenticateAuthenticateApiKey {
+    id: Id;
+    name?: Name;
+}
 export interface SecurityAuthenticateRequest extends RequestBase {
 }
 export interface SecurityAuthenticateResponse {
-    api_key?: SecurityApiKey;
+    api_key?: SecurityAuthenticateAuthenticateApiKey;
     authentication_realm: SecurityRealmInfo;
     email?: string | null;
     full_name?: Name | null;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elastic/elasticsearch",
-  "version": "8.16.2",
-  "versionCanary": "8.16.2-canary.0",
+  "version": "8.16.3",
+  "versionCanary": "8.16.3-canary.0",
   "description": "The official Elasticsearch client for Node.js",
   "main": "./index.js",
   "types": "index.d.ts",