diff --git a/api/kibana.d.ts b/api/kibana.d.ts new file mode 100644 index 000000000..f66d4d024 --- /dev/null +++ b/api/kibana.d.ts @@ -0,0 +1,465 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information + +/// + +import { + ClientOptions, + ConnectionPool, + Serializer, + Transport, + errors, + RequestEvent, + ResurrectEvent, + ApiError +} from '../index' +import Helpers from '../lib/Helpers' +import { + ApiResponse, + RequestBody, + RequestNDBody, + TransportRequestParams, + TransportRequestOptions, + TransportRequestPromise +} from '../lib/Transport' +import * as RequestParams from './requestParams' + +// Extend API +interface ClientExtendsCallbackOptions { + ConfigurationError: errors.ConfigurationError, + makeRequest(params: TransportRequestParams, options?: TransportRequestOptions): Promise | void; + result: { + body: null, + statusCode: null, + headers: null, + warnings: null + } +} +declare type extendsCallback = (options: ClientExtendsCallbackOptions) => any; +// /Extend API + +interface KibanaClient { + connectionPool: ConnectionPool + transport: Transport + serializer: Serializer + extend(method: string, fn: extendsCallback): void + extend(method: string, opts: { force: boolean }, fn: extendsCallback): void; + helpers: Helpers + child(opts?: ClientOptions): KibanaClient + close(): Promise; + emit(event: string | symbol, ...args: any[]): boolean; + on(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this; + on(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this; + once(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'response', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'sniff', listener: (err: ApiError, meta: RequestEvent) => void): this; + once(event: 'resurrect', listener: (err: null, meta: ResurrectEvent) => void): this; + off(event: string | symbol, listener: (...args: any[]) => void): this; + /* GENERATED */ + asyncSearch: { + delete, TContext = unknown>(params?: RequestParams.AsyncSearchDelete, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.AsyncSearchGet, options?: TransportRequestOptions): TransportRequestPromise> + submit, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.AsyncSearchSubmit, options?: TransportRequestOptions): TransportRequestPromise> + } + autoscaling: { + deleteAutoscalingPolicy, TContext = unknown>(params?: RequestParams.AutoscalingDeleteAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise> + getAutoscalingDecision, TContext = unknown>(params?: RequestParams.AutoscalingGetAutoscalingDecision, options?: TransportRequestOptions): TransportRequestPromise> + getAutoscalingPolicy, TContext = unknown>(params?: RequestParams.AutoscalingGetAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise> + putAutoscalingPolicy, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.AutoscalingPutAutoscalingPolicy, options?: TransportRequestOptions): TransportRequestPromise> + } + bulk, TRequestBody extends RequestNDBody = Record[], TContext = unknown>(params?: RequestParams.Bulk, options?: TransportRequestOptions): TransportRequestPromise> + cat: { + aliases, TContext = unknown>(params?: RequestParams.CatAliases, options?: TransportRequestOptions): TransportRequestPromise> + allocation, TContext = unknown>(params?: RequestParams.CatAllocation, options?: TransportRequestOptions): TransportRequestPromise> + count, TContext = unknown>(params?: RequestParams.CatCount, options?: TransportRequestOptions): TransportRequestPromise> + fielddata, TContext = unknown>(params?: RequestParams.CatFielddata, options?: TransportRequestOptions): TransportRequestPromise> + health, TContext = unknown>(params?: RequestParams.CatHealth, options?: TransportRequestOptions): TransportRequestPromise> + help, TContext = unknown>(params?: RequestParams.CatHelp, options?: TransportRequestOptions): TransportRequestPromise> + indices, TContext = unknown>(params?: RequestParams.CatIndices, options?: TransportRequestOptions): TransportRequestPromise> + master, TContext = unknown>(params?: RequestParams.CatMaster, options?: TransportRequestOptions): TransportRequestPromise> + mlDataFrameAnalytics, TContext = unknown>(params?: RequestParams.CatMlDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + mlDatafeeds, TContext = unknown>(params?: RequestParams.CatMlDatafeeds, options?: TransportRequestOptions): TransportRequestPromise> + mlJobs, TContext = unknown>(params?: RequestParams.CatMlJobs, options?: TransportRequestOptions): TransportRequestPromise> + mlTrainedModels, TContext = unknown>(params?: RequestParams.CatMlTrainedModels, options?: TransportRequestOptions): TransportRequestPromise> + nodeattrs, TContext = unknown>(params?: RequestParams.CatNodeattrs, options?: TransportRequestOptions): TransportRequestPromise> + nodes, TContext = unknown>(params?: RequestParams.CatNodes, options?: TransportRequestOptions): TransportRequestPromise> + pendingTasks, TContext = unknown>(params?: RequestParams.CatPendingTasks, options?: TransportRequestOptions): TransportRequestPromise> + plugins, TContext = unknown>(params?: RequestParams.CatPlugins, options?: TransportRequestOptions): TransportRequestPromise> + recovery, TContext = unknown>(params?: RequestParams.CatRecovery, options?: TransportRequestOptions): TransportRequestPromise> + repositories, TContext = unknown>(params?: RequestParams.CatRepositories, options?: TransportRequestOptions): TransportRequestPromise> + segments, TContext = unknown>(params?: RequestParams.CatSegments, options?: TransportRequestOptions): TransportRequestPromise> + shards, TContext = unknown>(params?: RequestParams.CatShards, options?: TransportRequestOptions): TransportRequestPromise> + snapshots, TContext = unknown>(params?: RequestParams.CatSnapshots, options?: TransportRequestOptions): TransportRequestPromise> + tasks, TContext = unknown>(params?: RequestParams.CatTasks, options?: TransportRequestOptions): TransportRequestPromise> + templates, TContext = unknown>(params?: RequestParams.CatTemplates, options?: TransportRequestOptions): TransportRequestPromise> + threadPool, TContext = unknown>(params?: RequestParams.CatThreadPool, options?: TransportRequestOptions): TransportRequestPromise> + transforms, TContext = unknown>(params?: RequestParams.CatTransforms, options?: TransportRequestOptions): TransportRequestPromise> + } + ccr: { + deleteAutoFollowPattern, TContext = unknown>(params?: RequestParams.CcrDeleteAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise> + follow, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.CcrFollow, options?: TransportRequestOptions): TransportRequestPromise> + followInfo, TContext = unknown>(params?: RequestParams.CcrFollowInfo, options?: TransportRequestOptions): TransportRequestPromise> + followStats, TContext = unknown>(params?: RequestParams.CcrFollowStats, options?: TransportRequestOptions): TransportRequestPromise> + forgetFollower, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.CcrForgetFollower, options?: TransportRequestOptions): TransportRequestPromise> + getAutoFollowPattern, TContext = unknown>(params?: RequestParams.CcrGetAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise> + pauseAutoFollowPattern, TContext = unknown>(params?: RequestParams.CcrPauseAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise> + pauseFollow, TContext = unknown>(params?: RequestParams.CcrPauseFollow, options?: TransportRequestOptions): TransportRequestPromise> + putAutoFollowPattern, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.CcrPutAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise> + resumeAutoFollowPattern, TContext = unknown>(params?: RequestParams.CcrResumeAutoFollowPattern, options?: TransportRequestOptions): TransportRequestPromise> + resumeFollow, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.CcrResumeFollow, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.CcrStats, options?: TransportRequestOptions): TransportRequestPromise> + unfollow, TContext = unknown>(params?: RequestParams.CcrUnfollow, options?: TransportRequestOptions): TransportRequestPromise> + } + clearScroll, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ClearScroll, options?: TransportRequestOptions): TransportRequestPromise> + cluster: { + allocationExplain, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ClusterAllocationExplain, options?: TransportRequestOptions): TransportRequestPromise> + deleteComponentTemplate, TContext = unknown>(params?: RequestParams.ClusterDeleteComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise> + deleteVotingConfigExclusions, TContext = unknown>(params?: RequestParams.ClusterDeleteVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise> + existsComponentTemplate, TContext = unknown>(params?: RequestParams.ClusterExistsComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise> + getComponentTemplate, TContext = unknown>(params?: RequestParams.ClusterGetComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise> + getSettings, TContext = unknown>(params?: RequestParams.ClusterGetSettings, options?: TransportRequestOptions): TransportRequestPromise> + health, TContext = unknown>(params?: RequestParams.ClusterHealth, options?: TransportRequestOptions): TransportRequestPromise> + pendingTasks, TContext = unknown>(params?: RequestParams.ClusterPendingTasks, options?: TransportRequestOptions): TransportRequestPromise> + postVotingConfigExclusions, TContext = unknown>(params?: RequestParams.ClusterPostVotingConfigExclusions, options?: TransportRequestOptions): TransportRequestPromise> + putComponentTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ClusterPutComponentTemplate, options?: TransportRequestOptions): TransportRequestPromise> + putSettings, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ClusterPutSettings, options?: TransportRequestOptions): TransportRequestPromise> + remoteInfo, TContext = unknown>(params?: RequestParams.ClusterRemoteInfo, options?: TransportRequestOptions): TransportRequestPromise> + reroute, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ClusterReroute, options?: TransportRequestOptions): TransportRequestPromise> + state, TContext = unknown>(params?: RequestParams.ClusterState, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.ClusterStats, options?: TransportRequestOptions): TransportRequestPromise> + } + count, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Count, options?: TransportRequestOptions): TransportRequestPromise> + create, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Create, options?: TransportRequestOptions): TransportRequestPromise> + danglingIndices: { + deleteDanglingIndex, TContext = unknown>(params?: RequestParams.DanglingIndicesDeleteDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise> + importDanglingIndex, TContext = unknown>(params?: RequestParams.DanglingIndicesImportDanglingIndex, options?: TransportRequestOptions): TransportRequestPromise> + listDanglingIndices, TContext = unknown>(params?: RequestParams.DanglingIndicesListDanglingIndices, options?: TransportRequestOptions): TransportRequestPromise> + } + dataFrameTransformDeprecated: { + deleteTransform, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedDeleteTransform, options?: TransportRequestOptions): TransportRequestPromise> + getTransform, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedGetTransform, options?: TransportRequestOptions): TransportRequestPromise> + getTransformStats, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedGetTransformStats, options?: TransportRequestOptions): TransportRequestPromise> + previewTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedPreviewTransform, options?: TransportRequestOptions): TransportRequestPromise> + putTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedPutTransform, options?: TransportRequestOptions): TransportRequestPromise> + startTransform, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedStartTransform, options?: TransportRequestOptions): TransportRequestPromise> + stopTransform, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedStopTransform, options?: TransportRequestOptions): TransportRequestPromise> + updateTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.DataFrameTransformDeprecatedUpdateTransform, options?: TransportRequestOptions): TransportRequestPromise> + } + delete, TContext = unknown>(params?: RequestParams.Delete, options?: TransportRequestOptions): TransportRequestPromise> + deleteByQuery, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.DeleteByQuery, options?: TransportRequestOptions): TransportRequestPromise> + deleteByQueryRethrottle, TContext = unknown>(params?: RequestParams.DeleteByQueryRethrottle, options?: TransportRequestOptions): TransportRequestPromise> + deleteScript, TContext = unknown>(params?: RequestParams.DeleteScript, options?: TransportRequestOptions): TransportRequestPromise> + enrich: { + deletePolicy, TContext = unknown>(params?: RequestParams.EnrichDeletePolicy, options?: TransportRequestOptions): TransportRequestPromise> + executePolicy, TContext = unknown>(params?: RequestParams.EnrichExecutePolicy, options?: TransportRequestOptions): TransportRequestPromise> + getPolicy, TContext = unknown>(params?: RequestParams.EnrichGetPolicy, options?: TransportRequestOptions): TransportRequestPromise> + putPolicy, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.EnrichPutPolicy, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.EnrichStats, options?: TransportRequestOptions): TransportRequestPromise> + } + eql: { + delete, TContext = unknown>(params?: RequestParams.EqlDelete, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.EqlGet, options?: TransportRequestOptions): TransportRequestPromise> + search, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.EqlSearch, options?: TransportRequestOptions): TransportRequestPromise> + } + exists, TContext = unknown>(params?: RequestParams.Exists, options?: TransportRequestOptions): TransportRequestPromise> + existsSource, TContext = unknown>(params?: RequestParams.ExistsSource, options?: TransportRequestOptions): TransportRequestPromise> + explain, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Explain, options?: TransportRequestOptions): TransportRequestPromise> + fieldCaps, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.FieldCaps, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.Get, options?: TransportRequestOptions): TransportRequestPromise> + getScript, TContext = unknown>(params?: RequestParams.GetScript, options?: TransportRequestOptions): TransportRequestPromise> + getScriptContext, TContext = unknown>(params?: RequestParams.GetScriptContext, options?: TransportRequestOptions): TransportRequestPromise> + getScriptLanguages, TContext = unknown>(params?: RequestParams.GetScriptLanguages, options?: TransportRequestOptions): TransportRequestPromise> + getSource, TContext = unknown>(params?: RequestParams.GetSource, options?: TransportRequestOptions): TransportRequestPromise> + graph: { + explore, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.GraphExplore, options?: TransportRequestOptions): TransportRequestPromise> + } + ilm: { + deleteLifecycle, TContext = unknown>(params?: RequestParams.IlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + explainLifecycle, TContext = unknown>(params?: RequestParams.IlmExplainLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + getLifecycle, TContext = unknown>(params?: RequestParams.IlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + getStatus, TContext = unknown>(params?: RequestParams.IlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise> + moveToStep, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IlmMoveToStep, options?: TransportRequestOptions): TransportRequestPromise> + putLifecycle, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IlmPutLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + removePolicy, TContext = unknown>(params?: RequestParams.IlmRemovePolicy, options?: TransportRequestOptions): TransportRequestPromise> + retry, TContext = unknown>(params?: RequestParams.IlmRetry, options?: TransportRequestOptions): TransportRequestPromise> + start, TContext = unknown>(params?: RequestParams.IlmStart, options?: TransportRequestOptions): TransportRequestPromise> + stop, TContext = unknown>(params?: RequestParams.IlmStop, options?: TransportRequestOptions): TransportRequestPromise> + } + index, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Index, options?: TransportRequestOptions): TransportRequestPromise> + indices: { + addBlock, TContext = unknown>(params?: RequestParams.IndicesAddBlock, options?: TransportRequestOptions): TransportRequestPromise> + analyze, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesAnalyze, options?: TransportRequestOptions): TransportRequestPromise> + clearCache, TContext = unknown>(params?: RequestParams.IndicesClearCache, options?: TransportRequestOptions): TransportRequestPromise> + clone, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesClone, options?: TransportRequestOptions): TransportRequestPromise> + close, TContext = unknown>(params?: RequestParams.IndicesClose, options?: TransportRequestOptions): TransportRequestPromise> + create, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesCreate, options?: TransportRequestOptions): TransportRequestPromise> + createDataStream, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesCreateDataStream, options?: TransportRequestOptions): TransportRequestPromise> + delete, TContext = unknown>(params?: RequestParams.IndicesDelete, options?: TransportRequestOptions): TransportRequestPromise> + deleteAlias, TContext = unknown>(params?: RequestParams.IndicesDeleteAlias, options?: TransportRequestOptions): TransportRequestPromise> + deleteDataStream, TContext = unknown>(params?: RequestParams.IndicesDeleteDataStream, options?: TransportRequestOptions): TransportRequestPromise> + deleteIndexTemplate, TContext = unknown>(params?: RequestParams.IndicesDeleteIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise> + deleteTemplate, TContext = unknown>(params?: RequestParams.IndicesDeleteTemplate, options?: TransportRequestOptions): TransportRequestPromise> + exists, TContext = unknown>(params?: RequestParams.IndicesExists, options?: TransportRequestOptions): TransportRequestPromise> + existsAlias, TContext = unknown>(params?: RequestParams.IndicesExistsAlias, options?: TransportRequestOptions): TransportRequestPromise> + existsIndexTemplate, TContext = unknown>(params?: RequestParams.IndicesExistsIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise> + existsTemplate, TContext = unknown>(params?: RequestParams.IndicesExistsTemplate, options?: TransportRequestOptions): TransportRequestPromise> + existsType, TContext = unknown>(params?: RequestParams.IndicesExistsType, options?: TransportRequestOptions): TransportRequestPromise> + flush, TContext = unknown>(params?: RequestParams.IndicesFlush, options?: TransportRequestOptions): TransportRequestPromise> + forcemerge, TContext = unknown>(params?: RequestParams.IndicesForcemerge, options?: TransportRequestOptions): TransportRequestPromise> + freeze, TContext = unknown>(params?: RequestParams.IndicesFreeze, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.IndicesGet, options?: TransportRequestOptions): TransportRequestPromise> + getAlias, TContext = unknown>(params?: RequestParams.IndicesGetAlias, options?: TransportRequestOptions): TransportRequestPromise> + getDataStream, TContext = unknown>(params?: RequestParams.IndicesGetDataStream, options?: TransportRequestOptions): TransportRequestPromise> + getFieldMapping, TContext = unknown>(params?: RequestParams.IndicesGetFieldMapping, options?: TransportRequestOptions): TransportRequestPromise> + getIndexTemplate, TContext = unknown>(params?: RequestParams.IndicesGetIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise> + getMapping, TContext = unknown>(params?: RequestParams.IndicesGetMapping, options?: TransportRequestOptions): TransportRequestPromise> + getSettings, TContext = unknown>(params?: RequestParams.IndicesGetSettings, options?: TransportRequestOptions): TransportRequestPromise> + getTemplate, TContext = unknown>(params?: RequestParams.IndicesGetTemplate, options?: TransportRequestOptions): TransportRequestPromise> + getUpgrade, TContext = unknown>(params?: RequestParams.IndicesGetUpgrade, options?: TransportRequestOptions): TransportRequestPromise> + open, TContext = unknown>(params?: RequestParams.IndicesOpen, options?: TransportRequestOptions): TransportRequestPromise> + putAlias, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesPutAlias, options?: TransportRequestOptions): TransportRequestPromise> + putIndexTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesPutIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise> + putMapping, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesPutMapping, options?: TransportRequestOptions): TransportRequestPromise> + putSettings, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesPutSettings, options?: TransportRequestOptions): TransportRequestPromise> + putTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesPutTemplate, options?: TransportRequestOptions): TransportRequestPromise> + recovery, TContext = unknown>(params?: RequestParams.IndicesRecovery, options?: TransportRequestOptions): TransportRequestPromise> + refresh, TContext = unknown>(params?: RequestParams.IndicesRefresh, options?: TransportRequestOptions): TransportRequestPromise> + reloadSearchAnalyzers, TContext = unknown>(params?: RequestParams.IndicesReloadSearchAnalyzers, options?: TransportRequestOptions): TransportRequestPromise> + resolveIndex, TContext = unknown>(params?: RequestParams.IndicesResolveIndex, options?: TransportRequestOptions): TransportRequestPromise> + rollover, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesRollover, options?: TransportRequestOptions): TransportRequestPromise> + segments, TContext = unknown>(params?: RequestParams.IndicesSegments, options?: TransportRequestOptions): TransportRequestPromise> + shardStores, TContext = unknown>(params?: RequestParams.IndicesShardStores, options?: TransportRequestOptions): TransportRequestPromise> + shrink, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesShrink, options?: TransportRequestOptions): TransportRequestPromise> + simulateIndexTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSimulateIndexTemplate, options?: TransportRequestOptions): TransportRequestPromise> + simulateTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSimulateTemplate, options?: TransportRequestOptions): TransportRequestPromise> + split, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesSplit, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.IndicesStats, options?: TransportRequestOptions): TransportRequestPromise> + unfreeze, TContext = unknown>(params?: RequestParams.IndicesUnfreeze, options?: TransportRequestOptions): TransportRequestPromise> + updateAliases, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesUpdateAliases, options?: TransportRequestOptions): TransportRequestPromise> + upgrade, TContext = unknown>(params?: RequestParams.IndicesUpgrade, options?: TransportRequestOptions): TransportRequestPromise> + validateQuery, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IndicesValidateQuery, options?: TransportRequestOptions): TransportRequestPromise> + } + info, TContext = unknown>(params?: RequestParams.Info, options?: TransportRequestOptions): TransportRequestPromise> + ingest: { + deletePipeline, TContext = unknown>(params?: RequestParams.IngestDeletePipeline, options?: TransportRequestOptions): TransportRequestPromise> + getPipeline, TContext = unknown>(params?: RequestParams.IngestGetPipeline, options?: TransportRequestOptions): TransportRequestPromise> + processorGrok, TContext = unknown>(params?: RequestParams.IngestProcessorGrok, options?: TransportRequestOptions): TransportRequestPromise> + putPipeline, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IngestPutPipeline, options?: TransportRequestOptions): TransportRequestPromise> + simulate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.IngestSimulate, options?: TransportRequestOptions): TransportRequestPromise> + } + license: { + delete, TContext = unknown>(params?: RequestParams.LicenseDelete, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.LicenseGet, options?: TransportRequestOptions): TransportRequestPromise> + getBasicStatus, TContext = unknown>(params?: RequestParams.LicenseGetBasicStatus, options?: TransportRequestOptions): TransportRequestPromise> + getTrialStatus, TContext = unknown>(params?: RequestParams.LicenseGetTrialStatus, options?: TransportRequestOptions): TransportRequestPromise> + post, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.LicensePost, options?: TransportRequestOptions): TransportRequestPromise> + postStartBasic, TContext = unknown>(params?: RequestParams.LicensePostStartBasic, options?: TransportRequestOptions): TransportRequestPromise> + postStartTrial, TContext = unknown>(params?: RequestParams.LicensePostStartTrial, options?: TransportRequestOptions): TransportRequestPromise> + } + mget, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Mget, options?: TransportRequestOptions): TransportRequestPromise> + migration: { + deprecations, TContext = unknown>(params?: RequestParams.MigrationDeprecations, options?: TransportRequestOptions): TransportRequestPromise> + } + ml: { + closeJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlCloseJob, options?: TransportRequestOptions): TransportRequestPromise> + deleteCalendar, TContext = unknown>(params?: RequestParams.MlDeleteCalendar, options?: TransportRequestOptions): TransportRequestPromise> + deleteCalendarEvent, TContext = unknown>(params?: RequestParams.MlDeleteCalendarEvent, options?: TransportRequestOptions): TransportRequestPromise> + deleteCalendarJob, TContext = unknown>(params?: RequestParams.MlDeleteCalendarJob, options?: TransportRequestOptions): TransportRequestPromise> + deleteDataFrameAnalytics, TContext = unknown>(params?: RequestParams.MlDeleteDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + deleteDatafeed, TContext = unknown>(params?: RequestParams.MlDeleteDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + deleteExpiredData, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlDeleteExpiredData, options?: TransportRequestOptions): TransportRequestPromise> + deleteFilter, TContext = unknown>(params?: RequestParams.MlDeleteFilter, options?: TransportRequestOptions): TransportRequestPromise> + deleteForecast, TContext = unknown>(params?: RequestParams.MlDeleteForecast, options?: TransportRequestOptions): TransportRequestPromise> + deleteJob, TContext = unknown>(params?: RequestParams.MlDeleteJob, options?: TransportRequestOptions): TransportRequestPromise> + deleteModelSnapshot, TContext = unknown>(params?: RequestParams.MlDeleteModelSnapshot, options?: TransportRequestOptions): TransportRequestPromise> + deleteTrainedModel, TContext = unknown>(params?: RequestParams.MlDeleteTrainedModel, options?: TransportRequestOptions): TransportRequestPromise> + estimateModelMemory, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlEstimateModelMemory, options?: TransportRequestOptions): TransportRequestPromise> + evaluateDataFrame, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlEvaluateDataFrame, options?: TransportRequestOptions): TransportRequestPromise> + explainDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlExplainDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + findFileStructure, TRequestBody extends RequestNDBody = Record[], TContext = unknown>(params?: RequestParams.MlFindFileStructure, options?: TransportRequestOptions): TransportRequestPromise> + flushJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlFlushJob, options?: TransportRequestOptions): TransportRequestPromise> + forecast, TContext = unknown>(params?: RequestParams.MlForecast, options?: TransportRequestOptions): TransportRequestPromise> + getBuckets, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetBuckets, options?: TransportRequestOptions): TransportRequestPromise> + getCalendarEvents, TContext = unknown>(params?: RequestParams.MlGetCalendarEvents, options?: TransportRequestOptions): TransportRequestPromise> + getCalendars, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetCalendars, options?: TransportRequestOptions): TransportRequestPromise> + getCategories, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetCategories, options?: TransportRequestOptions): TransportRequestPromise> + getDataFrameAnalytics, TContext = unknown>(params?: RequestParams.MlGetDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + getDataFrameAnalyticsStats, TContext = unknown>(params?: RequestParams.MlGetDataFrameAnalyticsStats, options?: TransportRequestOptions): TransportRequestPromise> + getDatafeedStats, TContext = unknown>(params?: RequestParams.MlGetDatafeedStats, options?: TransportRequestOptions): TransportRequestPromise> + getDatafeeds, TContext = unknown>(params?: RequestParams.MlGetDatafeeds, options?: TransportRequestOptions): TransportRequestPromise> + getFilters, TContext = unknown>(params?: RequestParams.MlGetFilters, options?: TransportRequestOptions): TransportRequestPromise> + getInfluencers, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetInfluencers, options?: TransportRequestOptions): TransportRequestPromise> + getJobStats, TContext = unknown>(params?: RequestParams.MlGetJobStats, options?: TransportRequestOptions): TransportRequestPromise> + getJobs, TContext = unknown>(params?: RequestParams.MlGetJobs, options?: TransportRequestOptions): TransportRequestPromise> + getModelSnapshots, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetModelSnapshots, options?: TransportRequestOptions): TransportRequestPromise> + getOverallBuckets, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetOverallBuckets, options?: TransportRequestOptions): TransportRequestPromise> + getRecords, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlGetRecords, options?: TransportRequestOptions): TransportRequestPromise> + getTrainedModels, TContext = unknown>(params?: RequestParams.MlGetTrainedModels, options?: TransportRequestOptions): TransportRequestPromise> + getTrainedModelsStats, TContext = unknown>(params?: RequestParams.MlGetTrainedModelsStats, options?: TransportRequestOptions): TransportRequestPromise> + info, TContext = unknown>(params?: RequestParams.MlInfo, options?: TransportRequestOptions): TransportRequestPromise> + openJob, TContext = unknown>(params?: RequestParams.MlOpenJob, options?: TransportRequestOptions): TransportRequestPromise> + postCalendarEvents, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPostCalendarEvents, options?: TransportRequestOptions): TransportRequestPromise> + postData, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPostData, options?: TransportRequestOptions): TransportRequestPromise> + previewDatafeed, TContext = unknown>(params?: RequestParams.MlPreviewDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + putCalendar, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutCalendar, options?: TransportRequestOptions): TransportRequestPromise> + putCalendarJob, TContext = unknown>(params?: RequestParams.MlPutCalendarJob, options?: TransportRequestOptions): TransportRequestPromise> + putDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + putDatafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + putFilter, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutFilter, options?: TransportRequestOptions): TransportRequestPromise> + putJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutJob, options?: TransportRequestOptions): TransportRequestPromise> + putTrainedModel, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlPutTrainedModel, options?: TransportRequestOptions): TransportRequestPromise> + revertModelSnapshot, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlRevertModelSnapshot, options?: TransportRequestOptions): TransportRequestPromise> + setUpgradeMode, TContext = unknown>(params?: RequestParams.MlSetUpgradeMode, options?: TransportRequestOptions): TransportRequestPromise> + startDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlStartDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + startDatafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlStartDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + stopDataFrameAnalytics, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlStopDataFrameAnalytics, options?: TransportRequestOptions): TransportRequestPromise> + stopDatafeed, TContext = unknown>(params?: RequestParams.MlStopDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + updateDatafeed, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateDatafeed, options?: TransportRequestOptions): TransportRequestPromise> + updateFilter, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateFilter, options?: TransportRequestOptions): TransportRequestPromise> + updateJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateJob, options?: TransportRequestOptions): TransportRequestPromise> + updateModelSnapshot, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlUpdateModelSnapshot, options?: TransportRequestOptions): TransportRequestPromise> + validate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlValidate, options?: TransportRequestOptions): TransportRequestPromise> + validateDetector, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.MlValidateDetector, options?: TransportRequestOptions): TransportRequestPromise> + } + monitoring: { + bulk, TRequestBody extends RequestNDBody = Record[], TContext = unknown>(params?: RequestParams.MonitoringBulk, options?: TransportRequestOptions): TransportRequestPromise> + } + msearch, TRequestBody extends RequestNDBody = Record[], TContext = unknown>(params?: RequestParams.Msearch, options?: TransportRequestOptions): TransportRequestPromise> + msearchTemplate, TRequestBody extends RequestNDBody = Record[], TContext = unknown>(params?: RequestParams.MsearchTemplate, options?: TransportRequestOptions): TransportRequestPromise> + mtermvectors, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Mtermvectors, options?: TransportRequestOptions): TransportRequestPromise> + nodes: { + hotThreads, TContext = unknown>(params?: RequestParams.NodesHotThreads, options?: TransportRequestOptions): TransportRequestPromise> + info, TContext = unknown>(params?: RequestParams.NodesInfo, options?: TransportRequestOptions): TransportRequestPromise> + reloadSecureSettings, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.NodesReloadSecureSettings, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.NodesStats, options?: TransportRequestOptions): TransportRequestPromise> + usage, TContext = unknown>(params?: RequestParams.NodesUsage, options?: TransportRequestOptions): TransportRequestPromise> + } + ping, TContext = unknown>(params?: RequestParams.Ping, options?: TransportRequestOptions): TransportRequestPromise> + putScript, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.PutScript, options?: TransportRequestOptions): TransportRequestPromise> + rankEval, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.RankEval, options?: TransportRequestOptions): TransportRequestPromise> + reindex, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Reindex, options?: TransportRequestOptions): TransportRequestPromise> + reindexRethrottle, TContext = unknown>(params?: RequestParams.ReindexRethrottle, options?: TransportRequestOptions): TransportRequestPromise> + renderSearchTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.RenderSearchTemplate, options?: TransportRequestOptions): TransportRequestPromise> + rollup: { + deleteJob, TContext = unknown>(params?: RequestParams.RollupDeleteJob, options?: TransportRequestOptions): TransportRequestPromise> + getJobs, TContext = unknown>(params?: RequestParams.RollupGetJobs, options?: TransportRequestOptions): TransportRequestPromise> + getRollupCaps, TContext = unknown>(params?: RequestParams.RollupGetRollupCaps, options?: TransportRequestOptions): TransportRequestPromise> + getRollupIndexCaps, TContext = unknown>(params?: RequestParams.RollupGetRollupIndexCaps, options?: TransportRequestOptions): TransportRequestPromise> + putJob, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.RollupPutJob, options?: TransportRequestOptions): TransportRequestPromise> + rollupSearch, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.RollupRollupSearch, options?: TransportRequestOptions): TransportRequestPromise> + startJob, TContext = unknown>(params?: RequestParams.RollupStartJob, options?: TransportRequestOptions): TransportRequestPromise> + stopJob, TContext = unknown>(params?: RequestParams.RollupStopJob, options?: TransportRequestOptions): TransportRequestPromise> + } + scriptsPainlessExecute, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.ScriptsPainlessExecute, options?: TransportRequestOptions): TransportRequestPromise> + scroll, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Scroll, options?: TransportRequestOptions): TransportRequestPromise> + search, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Search, options?: TransportRequestOptions): TransportRequestPromise> + searchShards, TContext = unknown>(params?: RequestParams.SearchShards, options?: TransportRequestOptions): TransportRequestPromise> + searchTemplate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SearchTemplate, options?: TransportRequestOptions): TransportRequestPromise> + searchableSnapshots: { + clearCache, TContext = unknown>(params?: RequestParams.SearchableSnapshotsClearCache, options?: TransportRequestOptions): TransportRequestPromise> + mount, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SearchableSnapshotsMount, options?: TransportRequestOptions): TransportRequestPromise> + repositoryStats, TContext = unknown>(params?: RequestParams.SearchableSnapshotsRepositoryStats, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.SearchableSnapshotsStats, options?: TransportRequestOptions): TransportRequestPromise> + } + security: { + authenticate, TContext = unknown>(params?: RequestParams.SecurityAuthenticate, options?: TransportRequestOptions): TransportRequestPromise> + changePassword, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityChangePassword, options?: TransportRequestOptions): TransportRequestPromise> + clearCachedPrivileges, TContext = unknown>(params?: RequestParams.SecurityClearCachedPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + clearCachedRealms, TContext = unknown>(params?: RequestParams.SecurityClearCachedRealms, options?: TransportRequestOptions): TransportRequestPromise> + clearCachedRoles, TContext = unknown>(params?: RequestParams.SecurityClearCachedRoles, options?: TransportRequestOptions): TransportRequestPromise> + createApiKey, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityCreateApiKey, options?: TransportRequestOptions): TransportRequestPromise> + deletePrivileges, TContext = unknown>(params?: RequestParams.SecurityDeletePrivileges, options?: TransportRequestOptions): TransportRequestPromise> + deleteRole, TContext = unknown>(params?: RequestParams.SecurityDeleteRole, options?: TransportRequestOptions): TransportRequestPromise> + deleteRoleMapping, TContext = unknown>(params?: RequestParams.SecurityDeleteRoleMapping, options?: TransportRequestOptions): TransportRequestPromise> + deleteUser, TContext = unknown>(params?: RequestParams.SecurityDeleteUser, options?: TransportRequestOptions): TransportRequestPromise> + disableUser, TContext = unknown>(params?: RequestParams.SecurityDisableUser, options?: TransportRequestOptions): TransportRequestPromise> + enableUser, TContext = unknown>(params?: RequestParams.SecurityEnableUser, options?: TransportRequestOptions): TransportRequestPromise> + getApiKey, TContext = unknown>(params?: RequestParams.SecurityGetApiKey, options?: TransportRequestOptions): TransportRequestPromise> + getBuiltinPrivileges, TContext = unknown>(params?: RequestParams.SecurityGetBuiltinPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + getPrivileges, TContext = unknown>(params?: RequestParams.SecurityGetPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + getRole, TContext = unknown>(params?: RequestParams.SecurityGetRole, options?: TransportRequestOptions): TransportRequestPromise> + getRoleMapping, TContext = unknown>(params?: RequestParams.SecurityGetRoleMapping, options?: TransportRequestOptions): TransportRequestPromise> + getToken, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityGetToken, options?: TransportRequestOptions): TransportRequestPromise> + getUser, TContext = unknown>(params?: RequestParams.SecurityGetUser, options?: TransportRequestOptions): TransportRequestPromise> + getUserPrivileges, TContext = unknown>(params?: RequestParams.SecurityGetUserPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + hasPrivileges, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityHasPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + invalidateApiKey, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityInvalidateApiKey, options?: TransportRequestOptions): TransportRequestPromise> + invalidateToken, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityInvalidateToken, options?: TransportRequestOptions): TransportRequestPromise> + putPrivileges, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityPutPrivileges, options?: TransportRequestOptions): TransportRequestPromise> + putRole, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityPutRole, options?: TransportRequestOptions): TransportRequestPromise> + putRoleMapping, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityPutRoleMapping, options?: TransportRequestOptions): TransportRequestPromise> + putUser, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SecurityPutUser, options?: TransportRequestOptions): TransportRequestPromise> + } + slm: { + deleteLifecycle, TContext = unknown>(params?: RequestParams.SlmDeleteLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + executeLifecycle, TContext = unknown>(params?: RequestParams.SlmExecuteLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + executeRetention, TContext = unknown>(params?: RequestParams.SlmExecuteRetention, options?: TransportRequestOptions): TransportRequestPromise> + getLifecycle, TContext = unknown>(params?: RequestParams.SlmGetLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + getStats, TContext = unknown>(params?: RequestParams.SlmGetStats, options?: TransportRequestOptions): TransportRequestPromise> + getStatus, TContext = unknown>(params?: RequestParams.SlmGetStatus, options?: TransportRequestOptions): TransportRequestPromise> + putLifecycle, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SlmPutLifecycle, options?: TransportRequestOptions): TransportRequestPromise> + start, TContext = unknown>(params?: RequestParams.SlmStart, options?: TransportRequestOptions): TransportRequestPromise> + stop, TContext = unknown>(params?: RequestParams.SlmStop, options?: TransportRequestOptions): TransportRequestPromise> + } + snapshot: { + cleanupRepository, TContext = unknown>(params?: RequestParams.SnapshotCleanupRepository, options?: TransportRequestOptions): TransportRequestPromise> + create, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SnapshotCreate, options?: TransportRequestOptions): TransportRequestPromise> + createRepository, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SnapshotCreateRepository, options?: TransportRequestOptions): TransportRequestPromise> + delete, TContext = unknown>(params?: RequestParams.SnapshotDelete, options?: TransportRequestOptions): TransportRequestPromise> + deleteRepository, TContext = unknown>(params?: RequestParams.SnapshotDeleteRepository, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.SnapshotGet, options?: TransportRequestOptions): TransportRequestPromise> + getRepository, TContext = unknown>(params?: RequestParams.SnapshotGetRepository, options?: TransportRequestOptions): TransportRequestPromise> + restore, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SnapshotRestore, options?: TransportRequestOptions): TransportRequestPromise> + status, TContext = unknown>(params?: RequestParams.SnapshotStatus, options?: TransportRequestOptions): TransportRequestPromise> + verifyRepository, TContext = unknown>(params?: RequestParams.SnapshotVerifyRepository, options?: TransportRequestOptions): TransportRequestPromise> + } + sql: { + clearCursor, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SqlClearCursor, options?: TransportRequestOptions): TransportRequestPromise> + query, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SqlQuery, options?: TransportRequestOptions): TransportRequestPromise> + translate, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.SqlTranslate, options?: TransportRequestOptions): TransportRequestPromise> + } + ssl: { + certificates, TContext = unknown>(params?: RequestParams.SslCertificates, options?: TransportRequestOptions): TransportRequestPromise> + } + tasks: { + cancel, TContext = unknown>(params?: RequestParams.TasksCancel, options?: TransportRequestOptions): TransportRequestPromise> + get, TContext = unknown>(params?: RequestParams.TasksGet, options?: TransportRequestOptions): TransportRequestPromise> + list, TContext = unknown>(params?: RequestParams.TasksList, options?: TransportRequestOptions): TransportRequestPromise> + } + termvectors, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Termvectors, options?: TransportRequestOptions): TransportRequestPromise> + transform: { + deleteTransform, TContext = unknown>(params?: RequestParams.TransformDeleteTransform, options?: TransportRequestOptions): TransportRequestPromise> + getTransform, TContext = unknown>(params?: RequestParams.TransformGetTransform, options?: TransportRequestOptions): TransportRequestPromise> + getTransformStats, TContext = unknown>(params?: RequestParams.TransformGetTransformStats, options?: TransportRequestOptions): TransportRequestPromise> + previewTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.TransformPreviewTransform, options?: TransportRequestOptions): TransportRequestPromise> + putTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.TransformPutTransform, options?: TransportRequestOptions): TransportRequestPromise> + startTransform, TContext = unknown>(params?: RequestParams.TransformStartTransform, options?: TransportRequestOptions): TransportRequestPromise> + stopTransform, TContext = unknown>(params?: RequestParams.TransformStopTransform, options?: TransportRequestOptions): TransportRequestPromise> + updateTransform, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.TransformUpdateTransform, options?: TransportRequestOptions): TransportRequestPromise> + } + update, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.Update, options?: TransportRequestOptions): TransportRequestPromise> + updateByQuery, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.UpdateByQuery, options?: TransportRequestOptions): TransportRequestPromise> + updateByQueryRethrottle, TContext = unknown>(params?: RequestParams.UpdateByQueryRethrottle, options?: TransportRequestOptions): TransportRequestPromise> + watcher: { + ackWatch, TContext = unknown>(params?: RequestParams.WatcherAckWatch, options?: TransportRequestOptions): TransportRequestPromise> + activateWatch, TContext = unknown>(params?: RequestParams.WatcherActivateWatch, options?: TransportRequestOptions): TransportRequestPromise> + deactivateWatch, TContext = unknown>(params?: RequestParams.WatcherDeactivateWatch, options?: TransportRequestOptions): TransportRequestPromise> + deleteWatch, TContext = unknown>(params?: RequestParams.WatcherDeleteWatch, options?: TransportRequestOptions): TransportRequestPromise> + executeWatch, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.WatcherExecuteWatch, options?: TransportRequestOptions): TransportRequestPromise> + getWatch, TContext = unknown>(params?: RequestParams.WatcherGetWatch, options?: TransportRequestOptions): TransportRequestPromise> + putWatch, TRequestBody extends RequestBody = Record, TContext = unknown>(params?: RequestParams.WatcherPutWatch, options?: TransportRequestOptions): TransportRequestPromise> + start, TContext = unknown>(params?: RequestParams.WatcherStart, options?: TransportRequestOptions): TransportRequestPromise> + stats, TContext = unknown>(params?: RequestParams.WatcherStats, options?: TransportRequestOptions): TransportRequestPromise> + stop, TContext = unknown>(params?: RequestParams.WatcherStop, options?: TransportRequestOptions): TransportRequestPromise> + } + xpack: { + info, TContext = unknown>(params?: RequestParams.XpackInfo, options?: TransportRequestOptions): TransportRequestPromise> + usage, TContext = unknown>(params?: RequestParams.XpackUsage, options?: TransportRequestOptions): TransportRequestPromise> + } + /* /GENERATED */ +} + +export { KibanaClient } diff --git a/index.d.ts b/index.d.ts index e6fa4a0ea..5f51ff089 100644 --- a/index.d.ts +++ b/index.d.ts @@ -48,10 +48,6 @@ interface ClientExtendsCallbackOptions { } } declare type extendsCallback = (options: ClientExtendsCallbackOptions) => any; -interface ClientExtends { - (method: string, fn: extendsCallback): void; - (method: string, opts: { force: boolean }, fn: extendsCallback): void; -} // /Extend API interface NodeOptions { @@ -107,9 +103,12 @@ declare class Client { connectionPool: ConnectionPool; transport: Transport; serializer: Serializer; - extend: ClientExtends; + extend(method: string, fn: extendsCallback): void + extend(method: string, opts: { force: boolean }, fn: extendsCallback): void; helpers: Helpers; child(opts?: ClientOptions): Client; + close(): Promise; + close(callback: Function): void; close(callback?: Function): Promise | void; emit(event: string | symbol, ...args: any[]): boolean; on(event: 'request', listener: (err: ApiError, meta: RequestEvent) => void): this; diff --git a/package.json b/package.json index 2cf24d448..cfbe4f85e 100644 --- a/package.json +++ b/package.json @@ -68,7 +68,7 @@ "standard": "^13.0.2", "stoppable": "^1.1.0", "tap": "^14.4.1", - "tsd": "^0.11.0", + "tsd": "^0.12.1", "workq": "^2.1.0", "xmlbuilder2": "^2.1.2" }, diff --git a/scripts/generate.js b/scripts/generate.js index 3a68b28da..e1c011303 100644 --- a/scripts/generate.js +++ b/scripts/generate.js @@ -33,6 +33,7 @@ function start (opts) { const apiOutputFolder = join(packageFolder, 'api') const mainOutputFile = join(packageFolder, 'index.js') const typeDefFile = join(__dirname, '..', 'index.d.ts') + const kibanaTypeDefFile = join(packageFolder, 'kibana.d.ts') const docOutputFile = join(__dirname, '..', 'docs', 'reference.asciidoc') const requestParamsOutputFile = join(packageFolder, 'requestParams.d.ts') const allSpec = [] @@ -58,23 +59,33 @@ function start (opts) { { encoding: 'utf8' } ) - const { fn: factory, types } = genFactory(apiOutputFolder, [apiFolder, xPackFolder]) + const { fn: factory, types, kibanaTypes } = genFactory(apiOutputFolder, [apiFolder, xPackFolder]) writeFileSync( mainOutputFile, factory, { encoding: 'utf8' } ) - const oldTypeDefString = readFileSync(typeDefFile, 'utf8') - const start = oldTypeDefString.indexOf('/* GENERATED */') - const end = oldTypeDefString.indexOf('/* /GENERATED */') - const newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + types + '\n ' + oldTypeDefString.slice(end) + let oldTypeDefString = readFileSync(typeDefFile, 'utf8') + let start = oldTypeDefString.indexOf('/* GENERATED */') + let end = oldTypeDefString.indexOf('/* /GENERATED */') + let newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + types + '\n ' + oldTypeDefString.slice(end) writeFileSync( typeDefFile, newTypeDefString, { encoding: 'utf8' } ) + oldTypeDefString = readFileSync(kibanaTypeDefFile, 'utf8') + start = oldTypeDefString.indexOf('/* GENERATED */') + end = oldTypeDefString.indexOf('/* /GENERATED */') + newTypeDefString = oldTypeDefString.slice(0, start + 15) + '\n' + kibanaTypes + '\n ' + oldTypeDefString.slice(end) + writeFileSync( + kibanaTypeDefFile, + newTypeDefString, + { encoding: 'utf8' } + ) + lintFiles(log, () => { log.text = 'Generating documentation' const allSpec = apiFolderContents.filter(f => f !== '_common.json') diff --git a/scripts/utils/generateMain.js b/scripts/utils/generateMain.js index f0361c9ad..e359dc749 100644 --- a/scripts/utils/generateMain.js +++ b/scripts/utils/generateMain.js @@ -36,7 +36,7 @@ function genFactory (folder, paths) { .reverse() .reduce((acc, val) => { const body = hasBody(paths, file.slice(0, -3)) - const methods = acc === null ? buildMethodDefinition(val, name, body) : null + const methods = acc === null ? buildMethodDefinition({ kibana: false }, val, name, body) : null const obj = {} if (methods) { for (const m of methods) { @@ -53,6 +53,33 @@ function genFactory (folder, paths) { }) .reduce((acc, val) => deepmerge(acc, val), {}) + const kibanaTypes = apiFiles + .map(file => { + const name = file + .slice(0, -3) + .replace(/\.([a-z])/g, k => k[1].toUpperCase()) + .replace(/_([a-z])/g, k => k[1].toUpperCase()) + + return file + .slice(0, -3) // remove `.js` extension + .split('.') + .reverse() + .reduce((acc, val) => { + const body = hasBody(paths, file.slice(0, -3)) + const methods = acc === null ? buildMethodDefinition({ kibana: true }, val, name, body) : null + const obj = {} + if (methods) { + for (const m of methods) { + obj[m.key] = m.val + } + } else { + obj[camelify(val)] = acc + } + return obj + }, null) + }) + .reduce((acc, val) => deepmerge(acc, val), {}) + const apis = apiFiles .map(file => { // const name = format(file.slice(0, -3)) @@ -97,6 +124,18 @@ function genFactory (folder, paths) { // remove useless quotes and commas .replace(/"/g, '') .replace(/,$/gm, '') + const kibanaTypesStr = Object.keys(kibanaTypes) + .map(key => { + const line = ` ${key}: ${JSON.stringify(kibanaTypes[key], null, 4)}` + if (line.slice(-1) === '}') { + return line.slice(0, -1) + ' }' + } + return line + }) + .join('\n') + // remove useless quotes and commas + .replace(/"/g, '') + .replace(/,$/gm, '') const fn = dedent` // Licensed to Elasticsearch B.V under one or more agreements. @@ -161,7 +200,7 @@ function genFactory (folder, paths) { ` // new line at the end of file - return { fn: fn + '\n', types: typesStr } + return { fn: fn + '\n', types: typesStr, kibanaTypes: kibanaTypesStr } } // from snake_case to camelCase @@ -177,11 +216,23 @@ function toPascalCase (str) { return str[0].toUpperCase() + str.slice(1) } -function buildMethodDefinition (api, name, hasBody) { +function buildMethodDefinition (opts, api, name, hasBody) { const Name = toPascalCase(name) const bodyType = ndjsonApiKey.includes(Name) ? 'RequestNDBody' : 'RequestBody' const defaultBodyType = ndjsonApiKey.includes(Name) ? 'Record[]' : 'Record' + if (opts.kibana) { + if (hasBody) { + return [ + { key: `${camelify(api)}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = unknown>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: `TransportRequestPromise>` } + ] + } else { + return [ + { key: `${camelify(api)}, TContext = unknown>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: `TransportRequestPromise>` } + ] + } + } + if (hasBody) { let methods = [ { key: `${api}, TRequestBody extends ${bodyType} = ${defaultBodyType}, TContext = unknown>(params?: RequestParams.${Name}, options?: TransportRequestOptions)`, val: `TransportRequestPromise>` }, diff --git a/test/types/client.test-d.ts b/test/types/client.test-d.ts index 339120f1e..e70cc23eb 100644 --- a/test/types/client.test-d.ts +++ b/test/types/client.test-d.ts @@ -4,7 +4,7 @@ import { expectType } from 'tsd' import { Client, ApiError, ApiResponse, RequestEvent, ResurrectEvent } from '../../' -import { TransportRequestCallback, TransportRequestPromise } from '../..//lib/Transport'; +import { TransportRequestCallback, TransportRequestPromise } from '../../lib/Transport' const client = new Client({ node: 'http://localhost:9200' @@ -120,4 +120,4 @@ client.on('resurrect', (err, meta) => { } catch (err) { expectType(err) } -} \ No newline at end of file +} diff --git a/test/types/kibana.test-d.ts b/test/types/kibana.test-d.ts new file mode 100644 index 000000000..2a32cf766 --- /dev/null +++ b/test/types/kibana.test-d.ts @@ -0,0 +1,113 @@ +// Licensed to Elasticsearch B.V under one or more agreements. +// Elasticsearch B.V licenses this file to you under the Apache 2.0 License. +// See the LICENSE file in the project root for more information + +import { expectType, expectNotType, expectError } from 'tsd' +import { Client, RequestEvent, ResurrectEvent, ApiError, ApiResponse } from '../../' +import { KibanaClient } from '../../api/kibana' +import { TransportRequestPromise } from '../../lib/Transport' + +const client: KibanaClient = new Client({ + node: 'http://localhost:9200' +}) + +client.on('request', (err, meta) => { + expectType(err) + expectType(meta) +}) + +client.on('response', (err, meta) => { + expectType(err) + expectType(meta) +}) + +client.on('sniff', (err, meta) => { + expectType(err) + expectType(meta) +}) + +client.on('resurrect', (err, meta) => { + expectType(err) + expectType(meta) +}) + +// No generics +{ + const response = await client.cat.count({ index: 'test' }) + + expectType>(response.body) + expectType(response.meta.context) +} + +// Define only the response body +{ + const response = await client.cat.count({ index: 'test' }) + + expectType(response.body) + expectType(response.meta.context) +} + +// Define response body and the context +{ + const response = await client.cat.count({ index: 'test' }) + + expectType(response.body) + expectType(response.meta.context) +} + +// Check API returned type and optional parameters +{ + const promise = client.info() + expectType>(promise) + promise + .then(result => expectType(result)) + .catch((err: ApiError) => expectType(err)) + expectType(promise.abort()) +} + +{ + const promise = client.info({ pretty: true }) + expectType>(promise) + promise + .then(result => expectType(result)) + .catch((err: ApiError) => expectType(err)) + expectType(promise.abort()) +} + +{ + const promise = client.info({ pretty: true }, { ignore: [404] }) + expectType>(promise) + promise + .then(result => expectType(result)) + .catch((err: ApiError) => expectType(err)) + expectType(promise.abort()) +} + +// body that does not respect the RequestBody constraint +expectError( + client.search({ + index: 'hello', + body: 42 + }).then(console.log) +) +/* + * We cannot test yet the absence of a property because tsd is still shipping + * TypeScript v3.7, as soon as it will be 3.9, we'll uncomment the following test. + +// @ts-expect-error +client.async_search.get() + +*/ + +// callback api is not supported +expectError(client.cat.count({ index: 'test' }, {}, (err: any, result: any) => {})) + +// close api, only promises should be supported +// callback api is not supported +expectType>(client.close()) +expectError(client.close(() => {})) + +// the child api should return a KibanaClient instance +const child = client.child() +expectType(child) +expectNotType(child)