@elastic/elasticsearch 8.9.0 → 8.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. package/.tool-versions +1 -0
  2. package/catalog-info.yaml +5 -4
  3. package/lib/api/api/async_search.d.ts +4 -4
  4. package/lib/api/api/autoscaling.d.ts +4 -4
  5. package/lib/api/api/bulk.d.ts +1 -1
  6. package/lib/api/api/cat.d.ts +26 -26
  7. package/lib/api/api/ccr.d.ts +13 -13
  8. package/lib/api/api/clear_scroll.d.ts +1 -1
  9. package/lib/api/api/close_point_in_time.d.ts +1 -1
  10. package/lib/api/api/cluster.d.ts +16 -16
  11. package/lib/api/api/cluster.js +1 -1
  12. package/lib/api/api/cluster.js.map +1 -1
  13. package/lib/api/api/count.d.ts +1 -1
  14. package/lib/api/api/create.d.ts +1 -1
  15. package/lib/api/api/dangling_indices.d.ts +3 -3
  16. package/lib/api/api/delete.d.ts +1 -1
  17. package/lib/api/api/delete_by_query.d.ts +1 -1
  18. package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
  19. package/lib/api/api/delete_script.d.ts +1 -1
  20. package/lib/api/api/enrich.d.ts +5 -5
  21. package/lib/api/api/eql.d.ts +4 -4
  22. package/lib/api/api/exists.d.ts +1 -1
  23. package/lib/api/api/exists_source.d.ts +1 -1
  24. package/lib/api/api/explain.d.ts +1 -1
  25. package/lib/api/api/features.d.ts +2 -2
  26. package/lib/api/api/field_caps.d.ts +1 -1
  27. package/lib/api/api/fleet.d.ts +1 -1
  28. package/lib/api/api/get.d.ts +1 -1
  29. package/lib/api/api/get_script.d.ts +1 -1
  30. package/lib/api/api/get_script_context.d.ts +1 -1
  31. package/lib/api/api/get_script_languages.d.ts +1 -1
  32. package/lib/api/api/get_source.d.ts +1 -1
  33. package/lib/api/api/graph.d.ts +1 -1
  34. package/lib/api/api/health_report.d.ts +1 -1
  35. package/lib/api/api/ilm.d.ts +11 -11
  36. package/lib/api/api/index.d.ts +1 -1
  37. package/lib/api/api/indices.d.ts +58 -58
  38. package/lib/api/api/info.d.ts +1 -1
  39. package/lib/api/api/ingest.d.ts +6 -6
  40. package/lib/api/api/knn_search.d.ts +1 -1
  41. package/lib/api/api/license.d.ts +7 -7
  42. package/lib/api/api/logstash.d.ts +3 -3
  43. package/lib/api/api/mget.d.ts +1 -1
  44. package/lib/api/api/migration.d.ts +3 -3
  45. package/lib/api/api/ml.d.ts +73 -73
  46. package/lib/api/api/monitoring.d.ts +1 -1
  47. package/lib/api/api/msearch.d.ts +1 -1
  48. package/lib/api/api/msearch_template.d.ts +1 -1
  49. package/lib/api/api/mtermvectors.d.ts +1 -1
  50. package/lib/api/api/nodes.d.ts +7 -7
  51. package/lib/api/api/open_point_in_time.d.ts +1 -1
  52. package/lib/api/api/ping.d.ts +1 -1
  53. package/lib/api/api/put_script.d.ts +1 -1
  54. package/lib/api/api/query_ruleset.d.ts +39 -0
  55. package/lib/api/api/query_ruleset.js +116 -0
  56. package/lib/api/api/query_ruleset.js.map +1 -0
  57. package/lib/api/api/rank_eval.d.ts +1 -1
  58. package/lib/api/api/reindex.d.ts +1 -1
  59. package/lib/api/api/reindex_rethrottle.d.ts +1 -1
  60. package/lib/api/api/render_search_template.d.ts +1 -1
  61. package/lib/api/api/rollup.d.ts +8 -8
  62. package/lib/api/api/scripts_painless_execute.d.ts +1 -1
  63. package/lib/api/api/scroll.d.ts +1 -1
  64. package/lib/api/api/search.d.ts +1 -1
  65. package/lib/api/api/search_application.d.ts +9 -9
  66. package/lib/api/api/search_mvt.d.ts +1 -1
  67. package/lib/api/api/search_shards.d.ts +1 -1
  68. package/lib/api/api/search_template.d.ts +1 -1
  69. package/lib/api/api/searchable_snapshots.d.ts +4 -4
  70. package/lib/api/api/security.d.ts +57 -57
  71. package/lib/api/api/slm.d.ts +9 -9
  72. package/lib/api/api/snapshot.d.ts +12 -12
  73. package/lib/api/api/sql.d.ts +6 -6
  74. package/lib/api/api/ssl.d.ts +1 -1
  75. package/lib/api/api/synonyms.d.ts +40 -12
  76. package/lib/api/api/synonyms.js +108 -11
  77. package/lib/api/api/synonyms.js.map +1 -1
  78. package/lib/api/api/tasks.d.ts +3 -3
  79. package/lib/api/api/terms_enum.d.ts +1 -1
  80. package/lib/api/api/termvectors.d.ts +1 -1
  81. package/lib/api/api/text_structure.d.ts +1 -1
  82. package/lib/api/api/transform.d.ts +11 -11
  83. package/lib/api/api/update.d.ts +1 -1
  84. package/lib/api/api/update_by_query.d.ts +1 -1
  85. package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
  86. package/lib/api/api/watcher.d.ts +13 -13
  87. package/lib/api/api/xpack.d.ts +2 -2
  88. package/lib/api/index.d.ts +4 -0
  89. package/lib/api/index.js +14 -2
  90. package/lib/api/index.js.map +1 -1
  91. package/lib/api/types.d.ts +249 -85
  92. package/lib/api/typesWithBodyKey.d.ts +258 -85
  93. package/package.json +4 -8
@@ -9,7 +9,7 @@ export default class Monitoring {
9
9
  constructor(transport: Transport);
10
10
  /**
11
11
  * Used by the monitoring features to send monitoring data.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/monitor-elasticsearch-cluster.html | Elasticsearch API documentation}
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/monitor-elasticsearch-cluster.html | Elasticsearch API documentation}
13
13
  */
14
14
  bulk<TDocument = unknown, TPartialDocument = unknown>(this: That, params: T.MonitoringBulkRequest<TDocument, TPartialDocument> | TB.MonitoringBulkRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithOutMeta): Promise<T.MonitoringBulkResponse>;
15
15
  bulk<TDocument = unknown, TPartialDocument = unknown>(this: That, params: T.MonitoringBulkRequest<TDocument, TPartialDocument> | TB.MonitoringBulkRequest<TDocument, TPartialDocument>, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MonitoringBulkResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to execute several search operations in one request.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-multi-search.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-multi-search.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function MsearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MsearchResponse<TDocument, TAggregations>>;
12
12
  export default function MsearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchRequest | TB.MsearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MsearchResponse<TDocument, TAggregations>, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to execute several search template operations in one request.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-multi-search.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-multi-search.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function MsearchTemplateApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MsearchTemplateResponse<TDocument, TAggregations>>;
12
12
  export default function MsearchTemplateApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.MsearchTemplateRequest | TB.MsearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MsearchTemplateResponse<TDocument, TAggregations>, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Returns multiple termvectors in one request.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-multi-termvectors.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/docs-multi-termvectors.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function MtermvectorsApi(this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MtermvectorsResponse>;
12
12
  export default function MtermvectorsApi(this: That, params?: T.MtermvectorsRequest | TB.MtermvectorsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MtermvectorsResponse, unknown>>;
@@ -9,49 +9,49 @@ export default class Nodes {
9
9
  constructor(transport: Transport);
10
10
  /**
11
11
  * Removes the archived repositories metering information present in the cluster.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/clear-repositories-metering-archive-api.html | Elasticsearch API documentation}
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/clear-repositories-metering-archive-api.html | Elasticsearch API documentation}
13
13
  */
14
14
  clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesClearRepositoriesMeteringArchiveResponse>;
15
15
  clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesClearRepositoriesMeteringArchiveResponse, unknown>>;
16
16
  clearRepositoriesMeteringArchive(this: That, params: T.NodesClearRepositoriesMeteringArchiveRequest | TB.NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptions): Promise<T.NodesClearRepositoriesMeteringArchiveResponse>;
17
17
  /**
18
18
  * Returns cluster repositories metering information.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-repositories-metering-api.html | Elasticsearch API documentation}
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/get-repositories-metering-api.html | Elasticsearch API documentation}
20
20
  */
21
21
  getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesGetRepositoriesMeteringInfoResponse>;
22
22
  getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesGetRepositoriesMeteringInfoResponse, unknown>>;
23
23
  getRepositoriesMeteringInfo(this: That, params: T.NodesGetRepositoriesMeteringInfoRequest | TB.NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptions): Promise<T.NodesGetRepositoriesMeteringInfoResponse>;
24
24
  /**
25
25
  * Returns information about hot threads on each node in the cluster.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-hot-threads.html | Elasticsearch API documentation}
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/cluster-nodes-hot-threads.html | Elasticsearch API documentation}
27
27
  */
28
28
  hotThreads(this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesHotThreadsResponse>;
29
29
  hotThreads(this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesHotThreadsResponse, unknown>>;
30
30
  hotThreads(this: That, params?: T.NodesHotThreadsRequest | TB.NodesHotThreadsRequest, options?: TransportRequestOptions): Promise<T.NodesHotThreadsResponse>;
31
31
  /**
32
32
  * Returns information about nodes in the cluster.
33
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-info.html | Elasticsearch API documentation}
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/cluster-nodes-info.html | Elasticsearch API documentation}
34
34
  */
35
35
  info(this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesInfoResponse>;
36
36
  info(this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesInfoResponse, unknown>>;
37
37
  info(this: That, params?: T.NodesInfoRequest | TB.NodesInfoRequest, options?: TransportRequestOptions): Promise<T.NodesInfoResponse>;
38
38
  /**
39
39
  * Reloads secure settings.
40
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/secure-settings.html#reloadable-secure-settings | Elasticsearch API documentation}
40
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/secure-settings.html#reloadable-secure-settings | Elasticsearch API documentation}
41
41
  */
42
42
  reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesReloadSecureSettingsResponse>;
43
43
  reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesReloadSecureSettingsResponse, unknown>>;
44
44
  reloadSecureSettings(this: That, params?: T.NodesReloadSecureSettingsRequest | TB.NodesReloadSecureSettingsRequest, options?: TransportRequestOptions): Promise<T.NodesReloadSecureSettingsResponse>;
45
45
  /**
46
46
  * Returns statistical information about nodes in the cluster.
47
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-stats.html | Elasticsearch API documentation}
47
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/cluster-nodes-stats.html | Elasticsearch API documentation}
48
48
  */
49
49
  stats(this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesStatsResponse>;
50
50
  stats(this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesStatsResponse, unknown>>;
51
51
  stats(this: That, params?: T.NodesStatsRequest | TB.NodesStatsRequest, options?: TransportRequestOptions): Promise<T.NodesStatsResponse>;
52
52
  /**
53
53
  * Returns low-level information about REST actions usage on nodes.
54
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/cluster-nodes-usage.html | Elasticsearch API documentation}
54
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/cluster-nodes-usage.html | Elasticsearch API documentation}
55
55
  */
56
56
  usage(this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.NodesUsageResponse>;
57
57
  usage(this: That, params?: T.NodesUsageRequest | TB.NodesUsageRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.NodesUsageResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Open a point in time that can be used in subsequent searches
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/point-in-time-api.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/point-in-time-api.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function OpenPointInTimeApi(this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.OpenPointInTimeResponse>;
12
12
  export default function OpenPointInTimeApi(this: That, params: T.OpenPointInTimeRequest | TB.OpenPointInTimeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.OpenPointInTimeResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Returns whether the cluster is running.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/index.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/index.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function PingApi(this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PingResponse>;
12
12
  export default function PingApi(this: That, params?: T.PingRequest | TB.PingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.PingResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Creates or updates a script.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/modules-scripting.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/modules-scripting.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function PutScriptApi(this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.PutScriptResponse>;
12
12
  export default function PutScriptApi(this: That, params: T.PutScriptRequest | TB.PutScriptRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.PutScriptResponse, unknown>>;
@@ -0,0 +1,39 @@
1
+ import { Transport, TransportRequestOptions, TransportRequestOptionsWithMeta, TransportRequestOptionsWithOutMeta, TransportResult } from '@elastic/transport';
2
+ import * as T from '../types';
3
+ import * as TB from '../typesWithBodyKey';
4
+ interface That {
5
+ transport: Transport;
6
+ }
7
+ export default class QueryRuleset {
8
+ transport: Transport;
9
+ constructor(transport: Transport);
10
+ /**
11
+ * Deletes a query ruleset.
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/delete-query-ruleset.html | Elasticsearch API documentation}
13
+ */
14
+ delete(this: That, params: T.QueryRulesetDeleteRequest | TB.QueryRulesetDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesetDeleteResponse>;
15
+ delete(this: That, params: T.QueryRulesetDeleteRequest | TB.QueryRulesetDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesetDeleteResponse, unknown>>;
16
+ delete(this: That, params: T.QueryRulesetDeleteRequest | TB.QueryRulesetDeleteRequest, options?: TransportRequestOptions): Promise<T.QueryRulesetDeleteResponse>;
17
+ /**
18
+ * Returns the details about a query ruleset.
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/get-query-ruleset.html | Elasticsearch API documentation}
20
+ */
21
+ get(this: That, params: T.QueryRulesetGetRequest | TB.QueryRulesetGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesetGetResponse>;
22
+ get(this: That, params: T.QueryRulesetGetRequest | TB.QueryRulesetGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesetGetResponse, unknown>>;
23
+ get(this: That, params: T.QueryRulesetGetRequest | TB.QueryRulesetGetRequest, options?: TransportRequestOptions): Promise<T.QueryRulesetGetResponse>;
24
+ /**
25
+ * Lists query rulesets.
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/list-query-rulesets.html | Elasticsearch API documentation}
27
+ */
28
+ list(this: That, params?: T.QueryRulesetListRequest | TB.QueryRulesetListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesetListResponse>;
29
+ list(this: That, params?: T.QueryRulesetListRequest | TB.QueryRulesetListRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesetListResponse, unknown>>;
30
+ list(this: That, params?: T.QueryRulesetListRequest | TB.QueryRulesetListRequest, options?: TransportRequestOptions): Promise<T.QueryRulesetListResponse>;
31
+ /**
32
+ * Creates or updates a query ruleset.
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/put-query-ruleset.html | Elasticsearch API documentation}
34
+ */
35
+ put(this: That, params: T.QueryRulesetPutRequest | TB.QueryRulesetPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesetPutResponse>;
36
+ put(this: That, params: T.QueryRulesetPutRequest | TB.QueryRulesetPutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.QueryRulesetPutResponse, unknown>>;
37
+ put(this: That, params: T.QueryRulesetPutRequest | TB.QueryRulesetPutRequest, options?: TransportRequestOptions): Promise<T.QueryRulesetPutResponse>;
38
+ }
39
+ export {};
@@ -0,0 +1,116 @@
1
+ "use strict";
2
+ /*
3
+ * Licensed to Elasticsearch B.V. under one or more contributor
4
+ * license agreements. See the NOTICE file distributed with
5
+ * this work for additional information regarding copyright
6
+ * ownership. Elasticsearch B.V. licenses this file to you under
7
+ * the Apache License, Version 2.0 (the "License"); you may
8
+ * not use this file except in compliance with the License.
9
+ * You may obtain a copy of the License at
10
+ *
11
+ * http://www.apache.org/licenses/LICENSE-2.0
12
+ *
13
+ * Unless required by applicable law or agreed to in writing,
14
+ * software distributed under the License is distributed on an
15
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ * KIND, either express or implied. See the License for the
17
+ * specific language governing permissions and limitations
18
+ * under the License.
19
+ */
20
+ Object.defineProperty(exports, "__esModule", { value: true });
21
+ class QueryRuleset {
22
+ constructor(transport) {
23
+ Object.defineProperty(this, "transport", {
24
+ enumerable: true,
25
+ configurable: true,
26
+ writable: true,
27
+ value: void 0
28
+ });
29
+ this.transport = transport;
30
+ }
31
+ async delete(params, options) {
32
+ const acceptedPath = ['ruleset_id'];
33
+ const querystring = {};
34
+ const body = undefined;
35
+ for (const key in params) {
36
+ if (acceptedPath.includes(key)) {
37
+ continue;
38
+ }
39
+ else if (key !== 'body') {
40
+ // @ts-expect-error
41
+ querystring[key] = params[key];
42
+ }
43
+ }
44
+ const method = 'DELETE';
45
+ const path = `/_query_rules/${encodeURIComponent(params.ruleset_id.toString())}`;
46
+ return await this.transport.request({ path, method, querystring, body }, options);
47
+ }
48
+ async get(params, options) {
49
+ const acceptedPath = ['ruleset_id'];
50
+ const querystring = {};
51
+ const body = undefined;
52
+ for (const key in params) {
53
+ if (acceptedPath.includes(key)) {
54
+ continue;
55
+ }
56
+ else if (key !== 'body') {
57
+ // @ts-expect-error
58
+ querystring[key] = params[key];
59
+ }
60
+ }
61
+ const method = 'GET';
62
+ const path = `/_query_rules/${encodeURIComponent(params.ruleset_id.toString())}`;
63
+ return await this.transport.request({ path, method, querystring, body }, options);
64
+ }
65
+ async list(params, options) {
66
+ const acceptedPath = [];
67
+ const querystring = {};
68
+ const body = undefined;
69
+ params = params !== null && params !== void 0 ? params : {};
70
+ for (const key in params) {
71
+ if (acceptedPath.includes(key)) {
72
+ continue;
73
+ }
74
+ else if (key !== 'body') {
75
+ // @ts-expect-error
76
+ querystring[key] = params[key];
77
+ }
78
+ }
79
+ const method = 'GET';
80
+ const path = '/_query_rules';
81
+ return await this.transport.request({ path, method, querystring, body }, options);
82
+ }
83
+ async put(params, options) {
84
+ const acceptedPath = ['ruleset_id'];
85
+ const acceptedBody = ['rules'];
86
+ const querystring = {};
87
+ // @ts-expect-error
88
+ const userBody = params === null || params === void 0 ? void 0 : params.body;
89
+ let body;
90
+ if (typeof userBody === 'string') {
91
+ body = userBody;
92
+ }
93
+ else {
94
+ body = userBody != null ? { ...userBody } : undefined;
95
+ }
96
+ for (const key in params) {
97
+ if (acceptedBody.includes(key)) {
98
+ body = body !== null && body !== void 0 ? body : {};
99
+ // @ts-expect-error
100
+ body[key] = params[key];
101
+ }
102
+ else if (acceptedPath.includes(key)) {
103
+ continue;
104
+ }
105
+ else if (key !== 'body') {
106
+ // @ts-expect-error
107
+ querystring[key] = params[key];
108
+ }
109
+ }
110
+ const method = 'PUT';
111
+ const path = `/_query_rules/${encodeURIComponent(params.ruleset_id.toString())}`;
112
+ return await this.transport.request({ path, method, querystring, body }, options);
113
+ }
114
+ }
115
+ exports.default = QueryRuleset;
116
+ //# sourceMappingURL=query_ruleset.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"query_ruleset.js","sourceRoot":"","sources":["../../../src/api/api/query_ruleset.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;GAiBG;;AAsBH,MAAqB,YAAY;IAE/B,YAAa,SAAoB;QADjC;;;;;WAAoB;QAElB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IASD,KAAK,CAAC,MAAM,CAAc,MAAkE,EAAE,OAAiC;QAC7H,MAAM,YAAY,GAAa,CAAC,YAAY,CAAC,CAAA;QAC7C,MAAM,WAAW,GAAwB,EAAE,CAAA;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAA;QAEtB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC9B,SAAQ;aACT;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,mBAAmB;gBACnB,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;aAC/B;SACF;QAED,MAAM,MAAM,GAAG,QAAQ,CAAA;QACvB,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAA;QAChF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;IACnF,CAAC;IASD,KAAK,CAAC,GAAG,CAAc,MAA4D,EAAE,OAAiC;QACpH,MAAM,YAAY,GAAa,CAAC,YAAY,CAAC,CAAA;QAC7C,MAAM,WAAW,GAAwB,EAAE,CAAA;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAA;QAEtB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC9B,SAAQ;aACT;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,mBAAmB;gBACnB,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;aAC/B;SACF;QAED,MAAM,MAAM,GAAG,KAAK,CAAA;QACpB,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAA;QAChF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;IACnF,CAAC;IASD,KAAK,CAAC,IAAI,CAAc,MAA+D,EAAE,OAAiC;QACxH,MAAM,YAAY,GAAa,EAAE,CAAA;QACjC,MAAM,WAAW,GAAwB,EAAE,CAAA;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAA;QAEtB,MAAM,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAA;QACrB,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC9B,SAAQ;aACT;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,mBAAmB;gBACnB,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;aAC/B;SACF;QAED,MAAM,MAAM,GAAG,KAAK,CAAA;QACpB,MAAM,IAAI,GAAG,eAAe,CAAA;QAC5B,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;IACnF,CAAC;IASD,KAAK,CAAC,GAAG,CAAc,MAA4D,EAAE,OAAiC;QACpH,MAAM,YAAY,GAAa,CAAC,YAAY,CAAC,CAAA;QAC7C,MAAM,YAAY,GAAa,CAAC,OAAO,CAAC,CAAA;QACxC,MAAM,WAAW,GAAwB,EAAE,CAAA;QAC3C,mBAAmB;QACnB,MAAM,QAAQ,GAAQ,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAA;QAClC,IAAI,IAAkC,CAAA;QACtC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,IAAI,GAAG,QAAQ,CAAA;SAChB;aAAM;YACL,IAAI,GAAG,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC,CAAC,SAAS,CAAA;SACtD;QAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;YACxB,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBAC9B,IAAI,GAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAA;gBACjB,mBAAmB;gBACnB,IAAI,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;aACxB;iBAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;gBACrC,SAAQ;aACT;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,mBAAmB;gBACnB,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;aAC/B;SACF;QAED,MAAM,MAAM,GAAG,KAAK,CAAA;QACpB,MAAM,IAAI,GAAG,iBAAiB,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAA;QAChF,OAAO,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;IACnF,CAAC;CACF;AA1HD,+BA0HC"}
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to evaluate the quality of ranked search results over a set of typical search queries
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-rank-eval.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-rank-eval.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function RankEvalApi(this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RankEvalResponse>;
12
12
  export default function RankEvalApi(this: That, params: T.RankEvalRequest | TB.RankEvalRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RankEvalResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-reindex.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/docs-reindex.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function ReindexApi(this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexResponse>;
12
12
  export default function ReindexApi(this: That, params: T.ReindexRequest | TB.ReindexRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ReindexResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Changes the number of requests per second for a particular Reindex operation.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docs-reindex.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/docs-reindex.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function ReindexRethrottleApi(this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ReindexRethrottleResponse>;
12
12
  export default function ReindexRethrottleApi(this: That, params: T.ReindexRethrottleRequest | TB.ReindexRethrottleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ReindexRethrottleResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to use the Mustache language to pre-render a search definition.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/render-search-template-api.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/render-search-template-api.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function RenderSearchTemplateApi(this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RenderSearchTemplateResponse>;
12
12
  export default function RenderSearchTemplateApi(this: That, params?: T.RenderSearchTemplateRequest | TB.RenderSearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RenderSearchTemplateResponse, unknown>>;
@@ -9,56 +9,56 @@ export default class Rollup {
9
9
  constructor(transport: Transport);
10
10
  /**
11
11
  * Deletes an existing rollup job.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-delete-job.html | Elasticsearch API documentation}
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-delete-job.html | Elasticsearch API documentation}
13
13
  */
14
14
  deleteJob(this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupDeleteJobResponse>;
15
15
  deleteJob(this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupDeleteJobResponse, unknown>>;
16
16
  deleteJob(this: That, params: T.RollupDeleteJobRequest | TB.RollupDeleteJobRequest, options?: TransportRequestOptions): Promise<T.RollupDeleteJobResponse>;
17
17
  /**
18
18
  * Retrieves the configuration, stats, and status of rollup jobs.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-job.html | Elasticsearch API documentation}
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-get-job.html | Elasticsearch API documentation}
20
20
  */
21
21
  getJobs(this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetJobsResponse>;
22
22
  getJobs(this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetJobsResponse, unknown>>;
23
23
  getJobs(this: That, params?: T.RollupGetJobsRequest | TB.RollupGetJobsRequest, options?: TransportRequestOptions): Promise<T.RollupGetJobsResponse>;
24
24
  /**
25
25
  * Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-rollup-caps.html | Elasticsearch API documentation}
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-get-rollup-caps.html | Elasticsearch API documentation}
27
27
  */
28
28
  getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetRollupCapsResponse>;
29
29
  getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetRollupCapsResponse, unknown>>;
30
30
  getRollupCaps(this: That, params?: T.RollupGetRollupCapsRequest | TB.RollupGetRollupCapsRequest, options?: TransportRequestOptions): Promise<T.RollupGetRollupCapsResponse>;
31
31
  /**
32
32
  * Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored).
33
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-get-rollup-index-caps.html | Elasticsearch API documentation}
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-get-rollup-index-caps.html | Elasticsearch API documentation}
34
34
  */
35
35
  getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupGetRollupIndexCapsResponse>;
36
36
  getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupGetRollupIndexCapsResponse, unknown>>;
37
37
  getRollupIndexCaps(this: That, params: T.RollupGetRollupIndexCapsRequest | TB.RollupGetRollupIndexCapsRequest, options?: TransportRequestOptions): Promise<T.RollupGetRollupIndexCapsResponse>;
38
38
  /**
39
39
  * Creates a rollup job.
40
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-put-job.html | Elasticsearch API documentation}
40
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-put-job.html | Elasticsearch API documentation}
41
41
  */
42
42
  putJob(this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupPutJobResponse>;
43
43
  putJob(this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupPutJobResponse, unknown>>;
44
44
  putJob(this: That, params: T.RollupPutJobRequest | TB.RollupPutJobRequest, options?: TransportRequestOptions): Promise<T.RollupPutJobResponse>;
45
45
  /**
46
46
  * Enables searching rolled-up data using the standard query DSL.
47
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-search.html | Elasticsearch API documentation}
47
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-search.html | Elasticsearch API documentation}
48
48
  */
49
49
  rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupRollupSearchResponse<TDocument, TAggregations>>;
50
50
  rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupRollupSearchResponse<TDocument, TAggregations>, unknown>>;
51
51
  rollupSearch<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.RollupRollupSearchRequest | TB.RollupRollupSearchRequest, options?: TransportRequestOptions): Promise<T.RollupRollupSearchResponse<TDocument, TAggregations>>;
52
52
  /**
53
53
  * Starts an existing, stopped rollup job.
54
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-start-job.html | Elasticsearch API documentation}
54
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-start-job.html | Elasticsearch API documentation}
55
55
  */
56
56
  startJob(this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupStartJobResponse>;
57
57
  startJob(this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupStartJobResponse, unknown>>;
58
58
  startJob(this: That, params: T.RollupStartJobRequest | TB.RollupStartJobRequest, options?: TransportRequestOptions): Promise<T.RollupStartJobResponse>;
59
59
  /**
60
60
  * Stops an existing, started rollup job.
61
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/rollup-stop-job.html | Elasticsearch API documentation}
61
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/rollup-stop-job.html | Elasticsearch API documentation}
62
62
  */
63
63
  stopJob(this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.RollupStopJobResponse>;
64
64
  stopJob(this: That, params: T.RollupStopJobRequest | TB.RollupStopJobRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.RollupStopJobResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows an arbitrary script to be executed and a result to be returned
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/8.9/painless-execute-api.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/painless/8.10/painless-execute-api.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function ScriptsPainlessExecuteApi<TResult = unknown>(this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ScriptsPainlessExecuteResponse<TResult>>;
12
12
  export default function ScriptsPainlessExecuteApi<TResult = unknown>(this: That, params?: T.ScriptsPainlessExecuteRequest | TB.ScriptsPainlessExecuteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ScriptsPainlessExecuteResponse<TResult>, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to retrieve a large numbers of results from a single search request.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-request-body.html#request-body-search-scroll | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-request-body.html#request-body-search-scroll | Elasticsearch API documentation}
10
10
  */
11
11
  export default function ScrollApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.ScrollResponse<TDocument, TAggregations>>;
12
12
  export default function ScrollApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.ScrollRequest | TB.ScrollRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.ScrollResponse<TDocument, TAggregations>, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Returns results matching a query.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-search.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-search.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchResponse<TDocument, TAggregations>>;
12
12
  export default function SearchApi<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params?: T.SearchRequest | TB.SearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchResponse<TDocument, TAggregations>, unknown>>;
@@ -9,35 +9,35 @@ export default class SearchApplication {
9
9
  constructor(transport: Transport);
10
10
  /**
11
11
  * Deletes a search application.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-search-application.html | Elasticsearch API documentation}
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/put-search-application.html | Elasticsearch API documentation}
13
13
  */
14
14
  delete(this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationDeleteResponse>;
15
15
  delete(this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationDeleteResponse, unknown>>;
16
16
  delete(this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationDeleteResponse>;
17
17
  /**
18
18
  * Delete a behavioral analytics collection.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/delete-analytics-collection.html | Elasticsearch API documentation}
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/delete-analytics-collection.html | Elasticsearch API documentation}
20
20
  */
21
21
  deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationDeleteBehavioralAnalyticsResponse>;
22
22
  deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationDeleteBehavioralAnalyticsResponse, unknown>>;
23
23
  deleteBehavioralAnalytics(this: That, params: T.SearchApplicationDeleteBehavioralAnalyticsRequest | TB.SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationDeleteBehavioralAnalyticsResponse>;
24
24
  /**
25
25
  * Returns the details about a search application.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/get-search-application.html | Elasticsearch API documentation}
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/get-search-application.html | Elasticsearch API documentation}
27
27
  */
28
28
  get(this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationGetResponse>;
29
29
  get(this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationGetResponse, unknown>>;
30
30
  get(this: That, params: T.SearchApplicationGetRequest | TB.SearchApplicationGetRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationGetResponse>;
31
31
  /**
32
32
  * Returns the existing behavioral analytics collections.
33
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/list-analytics-collection.html | Elasticsearch API documentation}
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/list-analytics-collection.html | Elasticsearch API documentation}
34
34
  */
35
35
  getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationGetBehavioralAnalyticsResponse>;
36
36
  getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationGetBehavioralAnalyticsResponse, unknown>>;
37
37
  getBehavioralAnalytics(this: That, params?: T.SearchApplicationGetBehavioralAnalyticsRequest | TB.SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationGetBehavioralAnalyticsResponse>;
38
38
  /**
39
39
  * Returns the existing search applications.
40
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/list-search-applications.html | Elasticsearch API documentation}
40
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/list-search-applications.html | Elasticsearch API documentation}
41
41
  */
42
42
  list(this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationListResponse>;
43
43
  list(this: That, params?: T.SearchApplicationListRequest | TB.SearchApplicationListRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationListResponse, unknown>>;
@@ -51,28 +51,28 @@ export default class SearchApplication {
51
51
  postBehavioralAnalyticsEvent(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
52
52
  /**
53
53
  * Creates or updates a search application.
54
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-search-application.html | Elasticsearch API documentation}
54
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/put-search-application.html | Elasticsearch API documentation}
55
55
  */
56
56
  put(this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationPutResponse>;
57
57
  put(this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationPutResponse, unknown>>;
58
58
  put(this: That, params: T.SearchApplicationPutRequest | TB.SearchApplicationPutRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationPutResponse>;
59
59
  /**
60
60
  * Creates a behavioral analytics collection.
61
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/put-analytics-collection.html | Elasticsearch API documentation}
61
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/put-analytics-collection.html | Elasticsearch API documentation}
62
62
  */
63
63
  putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationPutBehavioralAnalyticsResponse>;
64
64
  putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationPutBehavioralAnalyticsResponse, unknown>>;
65
65
  putBehavioralAnalytics(this: That, params: T.SearchApplicationPutBehavioralAnalyticsRequest | TB.SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptions): Promise<T.SearchApplicationPutBehavioralAnalyticsResponse>;
66
66
  /**
67
67
  * Renders a query for given search application search parameters
68
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-application-render-query.html | Elasticsearch API documentation}
68
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-application-render-query.html | Elasticsearch API documentation}
69
69
  */
70
70
  renderQuery(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
71
71
  renderQuery(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
72
72
  renderQuery(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
73
73
  /**
74
74
  * Perform a search against a search application
75
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-application-search.html | Elasticsearch API documentation}
75
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-application-search.html | Elasticsearch API documentation}
76
76
  */
77
77
  search<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationSearchResponse<TDocument, TAggregations>>;
78
78
  search<TDocument = unknown, TAggregations = Record<T.AggregateName, T.AggregationsAggregate>>(this: That, params: T.SearchApplicationSearchRequest | TB.SearchApplicationSearchRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationSearchResponse<TDocument, TAggregations>, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-vector-tile-api.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-vector-tile-api.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function SearchMvtApi(this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchMvtResponse>;
12
12
  export default function SearchMvtApi(this: That, params: T.SearchMvtRequest | TB.SearchMvtRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchMvtResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Returns information about the indices and shards that a search request would be executed against.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-shards.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-shards.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function SearchShardsApi(this: That, params?: T.SearchShardsRequest | TB.SearchShardsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchShardsResponse>;
12
12
  export default function SearchShardsApi(this: That, params?: T.SearchShardsRequest | TB.SearchShardsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchShardsResponse, unknown>>;
@@ -6,7 +6,7 @@ interface That {
6
6
  }
7
7
  /**
8
8
  * Allows to use the Mustache language to pre-render a search definition.
9
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/search-template.html | Elasticsearch API documentation}
9
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/search-template.html | Elasticsearch API documentation}
10
10
  */
11
11
  export default function SearchTemplateApi<TDocument = unknown>(this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchTemplateResponse<TDocument>>;
12
12
  export default function SearchTemplateApi<TDocument = unknown>(this: That, params?: T.SearchTemplateRequest | TB.SearchTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchTemplateResponse<TDocument>, unknown>>;
@@ -9,28 +9,28 @@ export default class SearchableSnapshots {
9
9
  constructor(transport: Transport);
10
10
  /**
11
11
  * Retrieve node-level cache statistics about searchable snapshots.
12
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html | Elasticsearch API documentation}
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/searchable-snapshots-apis.html | Elasticsearch API documentation}
13
13
  */
14
14
  cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsCacheStatsResponse>;
15
15
  cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsCacheStatsResponse, unknown>>;
16
16
  cacheStats(this: That, params?: T.SearchableSnapshotsCacheStatsRequest | TB.SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsCacheStatsResponse>;
17
17
  /**
18
18
  * Clear the cache of searchable snapshots.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html | Elasticsearch API documentation}
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/searchable-snapshots-apis.html | Elasticsearch API documentation}
20
20
  */
21
21
  clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsClearCacheResponse>;
22
22
  clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsClearCacheResponse, unknown>>;
23
23
  clearCache(this: That, params?: T.SearchableSnapshotsClearCacheRequest | TB.SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsClearCacheResponse>;
24
24
  /**
25
25
  * Mount a snapshot as a searchable index.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-api-mount-snapshot.html | Elasticsearch API documentation}
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/searchable-snapshots-api-mount-snapshot.html | Elasticsearch API documentation}
27
27
  */
28
28
  mount(this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsMountResponse>;
29
29
  mount(this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsMountResponse, unknown>>;
30
30
  mount(this: That, params: T.SearchableSnapshotsMountRequest | TB.SearchableSnapshotsMountRequest, options?: TransportRequestOptions): Promise<T.SearchableSnapshotsMountResponse>;
31
31
  /**
32
32
  * Retrieve shard-level statistics about searchable snapshots.
33
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/searchable-snapshots-apis.html | Elasticsearch API documentation}
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.10/searchable-snapshots-apis.html | Elasticsearch API documentation}
34
34
  */
35
35
  stats(this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchableSnapshotsStatsResponse>;
36
36
  stats(this: That, params?: T.SearchableSnapshotsStatsRequest | TB.SearchableSnapshotsStatsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchableSnapshotsStatsResponse, unknown>>;