Auto-generated API code

Author: elasticmachine

docs/reference.asciidoc

@@ -862,7 +862,6 @@ client.getSource({ id, index })
 ** *`_source` (Optional, boolean | string | string[])*: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
 ** *`_source_excludes` (Optional, string | string[])*: A list of source fields to exclude in the response.
 ** *`_source_includes` (Optional, string | string[])*: A list of source fields to include in the response.
-** *`stored_fields` (Optional, string | string[])*: A list of stored fields to return as part of a hit.
 ** *`version` (Optional, number)*: The version number for concurrency control. It must match the current version of the document for the request to succeed.
 ** *`version_type` (Optional, Enum("internal" | "external" | "external_gte" | "force"))*: The version type.
 
@@ -1048,6 +1047,7 @@ client.index({ index })
 ** *`version_type` (Optional, Enum("internal" | "external" | "external_gte" | "force"))*: The version type.
 ** *`wait_for_active_shards` (Optional, number | Enum("all" | "index-setting"))*: The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.
 ** *`require_alias` (Optional, boolean)*: If `true`, the destination must be an index alias.
+** *`require_data_stream` (Optional, boolean)*: If `true`, the request's actions must target a data stream (existing or to be created).
 
 [discrete]
 === info
@@ -3845,6 +3845,7 @@ client.cluster.getComponentTemplate({ ... })
 ** *`name` (Optional, string)*: List of component template names used to limit the request.
 Wildcard (`*`) expressions are supported.
 ** *`flat_settings` (Optional, boolean)*: If `true`, returns settings in flat format.
+** *`settings_filter` (Optional, string | string[])*: Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
 ** *`include_defaults` (Optional, boolean)*: Return all default configurations for the component template (default: false)
 ** *`local` (Optional, boolean)*: If `true`, the request retrieves information from the local node only.
 If `false`, information is retrieved from the master node.
@@ -4040,6 +4041,7 @@ To unset `_meta`, replace the template without specifying this information.
 ** *`deprecated` (Optional, boolean)*: Marks this index template as deprecated. When creating or updating a non-deprecated index template
 that uses deprecated components, Elasticsearch will emit a deprecation warning.
 ** *`create` (Optional, boolean)*: If `true`, this request cannot replace or update existing component templates.
+** *`cause` (Optional, string)*: User defined reason for create the component template.
 ** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
 If no response is received before the timeout expires, the request fails and returns an error.
 
@@ -8585,7 +8587,7 @@ The only valid task type for the model to perform is `text_embedding`.
 
 [discrete]
 ==== rerank
-Perform rereanking inference on the service
+Perform reranking inference on the service
 
 {ref}/post-inference-api.html[Endpoint documentation]
 [source,ts]
@@ -8815,9 +8817,6 @@ client.ingest.getIpLocationDatabase({ ... })
 ** *`id` (Optional, string | string[])*: List of database configuration IDs to retrieve.
 Wildcard (`*`) expressions are supported.
 To get all database configurations, omit this parameter or use `*`.
-** *`master_timeout` (Optional, string | -1 | 0)*: The period to wait for a connection to the master node.
-If no response is received before the timeout expires, the request fails and returns an error.
-A value of `-1` indicates that the request should never time out.
 
 [discrete]
 ==== get_pipeline
@@ -9101,7 +9100,7 @@ client.license.postStartTrial({ ... })
 
 * *Request (object):*
 ** *`acknowledge` (Optional, boolean)*: whether the user has acknowledged acknowledge messages (default: false)
-** *`type_query_string` (Optional, string)*
+** *`type` (Optional, string)*: The type of trial license to generate (default: "trial")
 ** *`master_timeout` (Optional, string | -1 | 0)*: Period to wait for a connection to the master node.
 
 [discrete]
@@ -13120,16 +13119,9 @@ To check whether a user has a specific list of privileges, use the has privilege
 {ref}/security-api-get-user-privileges.html[Endpoint documentation]
 [source,ts]
 ----
-client.security.getUserPrivileges({ ... })
+client.security.getUserPrivileges()
 ----
 
-[discrete]
-==== Arguments
-
-* *Request (object):*
-** *`application` (Optional, string)*: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.
-** *`priviledge` (Optional, string)*: The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.
-** *`username` (Optional, string | null)*
 
 [discrete]
 ==== get_user_profile
@@ -13204,6 +13196,10 @@ It is not valid with other grant types.
 If you specify the `password` grant type, this parameter is required.
 It is not valid with other grant types.
 ** *`run_as` (Optional, string)*: The name of the user to be impersonated.
+** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If 'true', Elasticsearch refreshes the affected shards to make this operation
+visible to search.
+If 'wait_for', it waits for a refresh to make this operation visible to search.
+If 'false', nothing is done with refreshes.
 
 [discrete]
 ==== has_privileges
@@ -14552,6 +14548,8 @@ client.snapshot.delete({ repository, snapshot })
 ** *`repository` (string)*: A repository name
 ** *`snapshot` (string)*: A list of snapshot names
 ** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node
+** *`wait_for_completion` (Optional, boolean)*: If `true`, the request returns a response when the matching snapshots are all deleted.
+If `false`, the request returns a response as soon as the deletes are scheduled.
 
 [discrete]
 ==== delete_repository

src/api/api/inference.ts

@@ -1027,7 +1027,7 @@ export default class Inference {
   }
 
   /**
-    * Perform rereanking inference on the service
+    * Perform reranking inference on the service
     * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.18/post-inference-api.html | Elasticsearch API documentation}
     */
   async rerank (this: That, params: T.InferenceRerankRequest | TB.InferenceRerankRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceRerankResponse>

src/api/types.ts

@@ -458,7 +458,6 @@ export interface GetSourceRequest extends RequestBase {
   _source?: SearchSourceConfigParam
   _source_excludes?: Fields
   _source_includes?: Fields
-  stored_fields?: Fields
   version?: VersionNumber
   version_type?: VersionType
 }
@@ -659,6 +658,7 @@ export interface IndexRequest<TDocument = unknown> extends RequestBase {
   version_type?: VersionType
   wait_for_active_shards?: WaitForActiveShards
   require_alias?: boolean
+  require_data_stream?: boolean
   document?: TDocument
 }
 
@@ -9360,6 +9360,7 @@ export type ClusterExistsComponentTemplateResponse = boolean
 export interface ClusterGetComponentTemplateRequest extends RequestBase {
   name?: Name
   flat_settings?: boolean
+  settings_filter?: string | string[]
   include_defaults?: boolean
   local?: boolean
   master_timeout?: Duration
@@ -9488,6 +9489,7 @@ export type ClusterPostVotingConfigExclusionsResponse = boolean
 export interface ClusterPutComponentTemplateRequest extends RequestBase {
   name: Name
   create?: boolean
+  cause?: string
   master_timeout?: Duration
   template: IndicesIndexState
   version?: VersionNumber
@@ -14508,7 +14510,6 @@ export interface IngestGetIpLocationDatabaseDatabaseConfigurationMetadata {
 
 export interface IngestGetIpLocationDatabaseRequest extends RequestBase {
   id?: Ids
-  master_timeout?: Duration
 }
 
 export interface IngestGetIpLocationDatabaseResponse {
@@ -14672,7 +14673,7 @@ export interface LicensePostStartBasicResponse {
 
 export interface LicensePostStartTrialRequest extends RequestBase {
   acknowledge?: boolean
-  type_query_string?: string
+  type?: string
   master_timeout?: Duration
 }
 
@@ -19482,9 +19483,6 @@ export interface SecurityGetUserRequest extends RequestBase {
 export type SecurityGetUserResponse = Record<string, SecurityUser>
 
 export interface SecurityGetUserPrivilegesRequest extends RequestBase {
-  application?: Name
-  priviledge?: Name
-  username?: Name | null
 }
 
 export interface SecurityGetUserPrivilegesResponse {
@@ -19522,6 +19520,7 @@ export interface SecurityGrantApiKeyGrantApiKey {
 }
 
 export interface SecurityGrantApiKeyRequest extends RequestBase {
+  refresh?: Refresh
   api_key: SecurityGrantApiKeyGrantApiKey
   grant_type: SecurityGrantApiKeyApiKeyGrantType
   access_token?: string
@@ -20483,6 +20482,7 @@ export interface SnapshotDeleteRequest extends RequestBase {
   repository: Name
   snapshot: Name
   master_timeout?: Duration
+  wait_for_completion?: boolean
 }
 
 export type SnapshotDeleteResponse = AcknowledgedResponseBase

src/api/typesWithBodyKey.ts

@@ -479,7 +479,6 @@ export interface GetSourceRequest extends RequestBase {
   _source?: SearchSourceConfigParam
   _source_excludes?: Fields
   _source_includes?: Fields
-  stored_fields?: Fields
   version?: VersionNumber
   version_type?: VersionType
 }
@@ -680,6 +679,7 @@ export interface IndexRequest<TDocument = unknown> extends RequestBase {
   version_type?: VersionType
   wait_for_active_shards?: WaitForActiveShards
   require_alias?: boolean
+  require_data_stream?: boolean
   /** @deprecated The use of the 'body' key has been deprecated, use 'document' instead. */
   body?: TDocument
 }
@@ -9456,6 +9456,7 @@ export type ClusterExistsComponentTemplateResponse = boolean
 export interface ClusterGetComponentTemplateRequest extends RequestBase {
   name?: Name
   flat_settings?: boolean
+  settings_filter?: string | string[]
   include_defaults?: boolean
   local?: boolean
   master_timeout?: Duration
@@ -9584,6 +9585,7 @@ export type ClusterPostVotingConfigExclusionsResponse = boolean
 export interface ClusterPutComponentTemplateRequest extends RequestBase {
   name: Name
   create?: boolean
+  cause?: string
   master_timeout?: Duration
   /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
   body?: {
@@ -14819,7 +14821,6 @@ export interface IngestGetIpLocationDatabaseDatabaseConfigurationMetadata {
 
 export interface IngestGetIpLocationDatabaseRequest extends RequestBase {
   id?: Ids
-  master_timeout?: Duration
 }
 
 export interface IngestGetIpLocationDatabaseResponse {
@@ -14996,7 +14997,7 @@ export interface LicensePostStartBasicResponse {
 
 export interface LicensePostStartTrialRequest extends RequestBase {
   acknowledge?: boolean
-  type_query_string?: string
+  type?: string
   master_timeout?: Duration
 }
 
@@ -19981,9 +19982,6 @@ export interface SecurityGetUserRequest extends RequestBase {
 export type SecurityGetUserResponse = Record<string, SecurityUser>
 
 export interface SecurityGetUserPrivilegesRequest extends RequestBase {
-  application?: Name
-  priviledge?: Name
-  username?: Name | null
 }
 
 export interface SecurityGetUserPrivilegesResponse {
@@ -20021,6 +20019,7 @@ export interface SecurityGrantApiKeyGrantApiKey {
 }
 
 export interface SecurityGrantApiKeyRequest extends RequestBase {
+  refresh?: Refresh
   /** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
   body?: {
     api_key: SecurityGrantApiKeyGrantApiKey
@@ -21072,6 +21071,7 @@ export interface SnapshotDeleteRequest extends RequestBase {
   repository: Name
   snapshot: Name
   master_timeout?: Duration
+  wait_for_completion?: boolean
 }
 
 export type SnapshotDeleteResponse = AcknowledgedResponseBase