269 lines
14 KiB
TypeScript
269 lines
14 KiB
TypeScript
/*
|
|
* Licensed to Elasticsearch B.V. under one or more contributor
|
|
* license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright
|
|
* ownership. Elasticsearch B.V. licenses this file to you under
|
|
* the Apache License, Version 2.0 (the "License"); you may
|
|
* not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
/* eslint-disable import/export */
|
|
/* eslint-disable @typescript-eslint/no-misused-new */
|
|
/* eslint-disable @typescript-eslint/no-extraneous-class */
|
|
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
|
|
// This file was automatically generated by elastic/elastic-client-generator-js
|
|
// DO NOT MODIFY IT BY HAND. Instead, modify the source open api file,
|
|
// and elastic/elastic-client-generator-js to regenerate this file again.
|
|
|
|
import {
|
|
Transport,
|
|
TransportRequestMetadata,
|
|
TransportRequestOptions,
|
|
TransportRequestOptionsWithMeta,
|
|
TransportRequestOptionsWithOutMeta,
|
|
TransportResult
|
|
} from '@elastic/transport'
|
|
import * as T from '../types'
|
|
import * as TB from '../typesWithBodyKey'
|
|
interface That { transport: Transport }
|
|
|
|
export default class License {
|
|
transport: Transport
|
|
constructor (transport: Transport) {
|
|
this.transport = transport
|
|
}
|
|
|
|
/**
|
|
* Delete the license. When the license expires, your subscription level reverts to Basic. If the operator privileges feature is enabled, only operator users can use this API.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/delete-license.html | Elasticsearch API documentation}
|
|
*/
|
|
async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicenseDeleteResponse>
|
|
async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicenseDeleteResponse, unknown>>
|
|
async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptions): Promise<T.LicenseDeleteResponse>
|
|
async delete (this: That, params?: T.LicenseDeleteRequest | TB.LicenseDeleteRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'DELETE'
|
|
const path = '/_license'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.delete'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Get license information. Get information about your Elastic license including its type, its status, when it was issued, and when it expires. >info > If the master node is generating a new cluster state, the get license API may return a `404 Not Found` response. > If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/get-license.html | Elasticsearch API documentation}
|
|
*/
|
|
async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicenseGetResponse>
|
|
async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicenseGetResponse, unknown>>
|
|
async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptions): Promise<T.LicenseGetResponse>
|
|
async get (this: That, params?: T.LicenseGetRequest | TB.LicenseGetRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'GET'
|
|
const path = '/_license'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.get'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Get the basic license status.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/get-basic-status.html | Elasticsearch API documentation}
|
|
*/
|
|
async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicenseGetBasicStatusResponse>
|
|
async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicenseGetBasicStatusResponse, unknown>>
|
|
async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptions): Promise<T.LicenseGetBasicStatusResponse>
|
|
async getBasicStatus (this: That, params?: T.LicenseGetBasicStatusRequest | TB.LicenseGetBasicStatusRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'GET'
|
|
const path = '/_license/basic_status'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.get_basic_status'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Get the trial status.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/get-trial-status.html | Elasticsearch API documentation}
|
|
*/
|
|
async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicenseGetTrialStatusResponse>
|
|
async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicenseGetTrialStatusResponse, unknown>>
|
|
async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptions): Promise<T.LicenseGetTrialStatusResponse>
|
|
async getTrialStatus (this: That, params?: T.LicenseGetTrialStatusRequest | TB.LicenseGetTrialStatusRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'GET'
|
|
const path = '/_license/trial_status'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.get_trial_status'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Update the license. You can update your license at runtime without shutting down your nodes. License updates take effect immediately. If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. If the operator privileges feature is enabled, only operator users can use this API.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/update-license.html | Elasticsearch API documentation}
|
|
*/
|
|
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicensePostResponse>
|
|
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicensePostResponse, unknown>>
|
|
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise<T.LicensePostResponse>
|
|
async post (this: That, params?: T.LicensePostRequest | TB.LicensePostRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const acceptedBody: string[] = ['license', 'licenses']
|
|
const querystring: Record<string, any> = {}
|
|
// @ts-expect-error
|
|
const userBody: any = params?.body
|
|
let body: Record<string, any> | string
|
|
if (typeof userBody === 'string') {
|
|
body = userBody
|
|
} else {
|
|
body = userBody != null ? { ...userBody } : undefined
|
|
}
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedBody.includes(key)) {
|
|
body = body ?? {}
|
|
// @ts-expect-error
|
|
body[key] = params[key]
|
|
} else if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'PUT'
|
|
const path = '/_license'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.post'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Start a basic license. Start an indefinite basic license, which gives access to all the basic features. NOTE: In order to start a basic license, you must not currently have a basic license. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the `acknowledge` parameter set to `true`. To check the status of your basic license, use the get basic license API.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/start-basic.html | Elasticsearch API documentation}
|
|
*/
|
|
async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicensePostStartBasicResponse>
|
|
async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicensePostStartBasicResponse, unknown>>
|
|
async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptions): Promise<T.LicensePostStartBasicResponse>
|
|
async postStartBasic (this: That, params?: T.LicensePostStartBasicRequest | TB.LicensePostStartBasicRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'POST'
|
|
const path = '/_license/start_basic'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.post_start_basic'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
|
|
/**
|
|
* Start a trial. Start a 30-day trial, which gives access to all subscription features. NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. To check the status of your trial, use the get trial status API.
|
|
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/start-trial.html | Elasticsearch API documentation}
|
|
*/
|
|
async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.LicensePostStartTrialResponse>
|
|
async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.LicensePostStartTrialResponse, unknown>>
|
|
async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptions): Promise<T.LicensePostStartTrialResponse>
|
|
async postStartTrial (this: That, params?: T.LicensePostStartTrialRequest | TB.LicensePostStartTrialRequest, options?: TransportRequestOptions): Promise<any> {
|
|
const acceptedPath: string[] = []
|
|
const querystring: Record<string, any> = {}
|
|
const body = undefined
|
|
|
|
params = params ?? {}
|
|
for (const key in params) {
|
|
if (acceptedPath.includes(key)) {
|
|
continue
|
|
} else if (key !== 'body') {
|
|
// @ts-expect-error
|
|
querystring[key] = params[key]
|
|
}
|
|
}
|
|
|
|
const method = 'POST'
|
|
const path = '/_license/start_trial'
|
|
const meta: TransportRequestMetadata = {
|
|
name: 'license.post_start_trial'
|
|
}
|
|
return await this.transport.request({ path, method, querystring, body, meta }, options)
|
|
}
|
|
}
|