opensearch-ruby 3.4.0 → 4.0.0.pre.beta.1

data/lib/opensearch/api/actions/nodes/usage.rb

@@ -3,26 +3,11 @@
 # The OpenSearch Contributors require contributions made to
 # this file be licensed under the Apache-2.0 license or a
 # compatible open source license.
-#
-# Modifications Copyright OpenSearch Contributors. See
-# GitHub history for details.
-#
-# 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.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
 
 module OpenSearch
   module API
@@ -30,43 +15,26 @@ module OpenSearch
       module Actions
         # Returns low-level information about REST actions usage on nodes.
         #
-        # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
-        # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions)
-        # @option arguments [Time] :timeout Explicit operation timeout
-        # @option arguments [Hash] :headers Custom HTTP headers
-        #
-        #
-        def usage(arguments = {})
-          headers = arguments.delete(:headers) || {}
-
-          arguments = arguments.clone
+        # @option args [Enumerable<String>, String] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
+        # @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
+        # @option args [Enumerable<String>] :metric Limits the information returned to the specific metrics. A comma-separated list of the following options: `_all`, `rest_actions`.
+        def usage(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          _node_id = args.delete('node_id')
+          _metric = args.delete('metric')
 
-          _node_id = arguments.delete(:node_id)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_nodes', _node_id, 'usage', _metric)
 
-          _metric = arguments.delete(:metric)
-
-          method = OpenSearch::API::HTTP_GET
-          path   = if _node_id && _metric
-                     "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}"
-                   elsif _node_id
-                     "_nodes/#{Utils.__listify(_node_id)}/usage"
-                   elsif _metric
-                     "_nodes/usage/#{Utils.__listify(_metric)}"
-                   else
-                     '_nodes/usage'
-                   end
-          params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
-
-          body = nil
-          perform_request(method, path, params, body, headers).body
+          Utils.validate_query_params! args, USAGE_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
         end
 
-        # Register this action with its valid params when the module is loaded.
-        #
-        # @since 6.2.0
-        ParamsRegistry.register(:usage, [
-          :timeout
-        ].freeze)
+        USAGE_QUERY_PARAMS = Set.new(%w[
+          timeout
+        ]).freeze
       end
     end
   end

data/lib/opensearch/api/actions/notifications/create_config.rb

@@ -0,0 +1,34 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Create channel configuration.
+        #
+        # @option args [Hash] :body *Required*
+        def create_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_notifications/configs'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/delete_config.rb

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Delete a channel configuration.
+        #
+        # @option args [String] :config_id *Required* The ID of the channel configuration to delete.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          _config_id = args.delete('config_id')
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_notifications/configs', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/delete_configs.rb

@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Delete multiple channel configurations.
+        #
+        # @option args [String] :config_id *Required* The ID of the channel configuration to delete.
+        # @option args [String] :config_id_list A comma-separated list of channel IDs to delete.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_configs(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_plugins/_notifications/configs'
+
+          Utils.validate_query_params! args, DELETE_CONFIGS_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+
+        DELETE_CONFIGS_QUERY_PARAMS = Set.new(%w[
+          config_id
+          config_id_list
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/get_config.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Get a specific channel configuration.
+        #
+        # @option args [String] :config_id *Required*
+        def get_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          _config_id = args.delete('config_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = Utils.build_url('_plugins/_notifications/configs', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/get_configs.rb

@@ -0,0 +1,115 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Get multiple channel configurations with filtering.
+        #
+        # @option args [String] :chime.url
+        # @option args [String] :chime.url.keyword
+        # @option args [String] :config_id Notification configuration ID.
+        # @option args [Enumerable<String>] :config_id_list Notification configuration IDs.
+        # @option args [String] :config_type Type of notification configuration.
+        # @option args [Integer] :created_time_ms
+        # @option args [String] :description
+        # @option args [String] :description.keyword
+        # @option args [String] :email.email_account_id
+        # @option args [String] :email.email_group_id_list
+        # @option args [String] :email.recipient_list.recipient
+        # @option args [String] :email.recipient_list.recipient.keyword
+        # @option args [String] :email_group.recipient_list.recipient
+        # @option args [String] :email_group.recipient_list.recipient.keyword
+        # @option args [Boolean] :is_enabled
+        # @option args [Integer] :last_updated_time_ms
+        # @option args [String] :microsoft_teams.url
+        # @option args [String] :microsoft_teams.url.keyword
+        # @option args [String] :name
+        # @option args [String] :name.keyword
+        # @option args [String] :query
+        # @option args [String] :ses_account.from_address
+        # @option args [String] :ses_account.from_address.keyword
+        # @option args [String] :ses_account.region
+        # @option args [String] :ses_account.role_arn
+        # @option args [String] :ses_account.role_arn.keyword
+        # @option args [String] :slack.url
+        # @option args [String] :slack.url.keyword
+        # @option args [String] :smtp_account.from_address
+        # @option args [String] :smtp_account.from_address.keyword
+        # @option args [String] :smtp_account.host
+        # @option args [String] :smtp_account.host.keyword
+        # @option args [String] :smtp_account.method
+        # @option args [String] :sns.role_arn
+        # @option args [String] :sns.role_arn.keyword
+        # @option args [String] :sns.topic_arn
+        # @option args [String] :sns.topic_arn.keyword
+        # @option args [String] :text_query
+        # @option args [String] :webhook.url
+        # @option args [String] :webhook.url.keyword
+        # @option args [Hash] :body
+        def get_configs(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_notifications/configs'
+
+          Utils.validate_query_params! args, GET_CONFIGS_QUERY_PARAMS
+          transport.perform_request(method, url, args, body, headers).body
+        end
+
+        GET_CONFIGS_QUERY_PARAMS = Set.new(%w[
+          chime.url
+          chime.url.keyword
+          config_id
+          config_id_list
+          config_type
+          created_time_ms
+          description
+          description.keyword
+          email.email_account_id
+          email.email_group_id_list
+          email.recipient_list.recipient
+          email.recipient_list.recipient.keyword
+          email_group.recipient_list.recipient
+          email_group.recipient_list.recipient.keyword
+          is_enabled
+          last_updated_time_ms
+          microsoft_teams.url
+          microsoft_teams.url.keyword
+          name
+          name.keyword
+          query
+          ses_account.from_address
+          ses_account.from_address.keyword
+          ses_account.region
+          ses_account.role_arn
+          ses_account.role_arn.keyword
+          slack.url
+          slack.url.keyword
+          smtp_account.from_address
+          smtp_account.from_address.keyword
+          smtp_account.host
+          smtp_account.host.keyword
+          smtp_account.method
+          sns.role_arn
+          sns.role_arn.keyword
+          sns.topic_arn
+          sns.topic_arn.keyword
+          text_query
+          webhook.url
+          webhook.url.keyword
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/list_channels.rb

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # List created notification channels.
+        #
+        def list_channels(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_notifications/channels'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/list_features.rb

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # List supported channel configurations.
+        #
+        def list_features(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_notifications/features'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/send_test.rb

@@ -0,0 +1,36 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Send a test notification.
+        #
+        # @option args [String] :config_id *Required*
+        def send_test(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+
+          _config_id = args.delete('config_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = body ? 'POST' : 'GET'
+          url     = Utils.build_url('_plugins/_notifications/feature/test', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/notifications/update_config.rb

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Notifications
+      module Actions
+        # Update channel configuration.
+        #
+        # @option args [String] :config_id *Required*
+        # @option args [Hash] :body *Required*
+        def update_config(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'config_id' missing" if args['config_id'].nil?
+          raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
+
+          _config_id = args.delete('config_id')
+
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'PUT'
+          url     = Utils.build_url('_plugins/_notifications/configs', _config_id)
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/observability/create_object.rb

@@ -0,0 +1,32 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Observability
+      module Actions
+        # Creates a new observability object.
+        #
+        # @option args [Hash] :body
+        def create_object(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'POST'
+          url     = '_plugins/_observability/object'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/observability/delete_object.rb

@@ -0,0 +1,38 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Observability
+      module Actions
+        # Deletes specific observability object specified by ID.
+        #
+        # @option args [String] :object_id *Required* The ID of the Observability Object.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_object(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          raise ArgumentError, "Required argument 'object_id' missing" if args['object_id'].nil?
+
+          _object_id = args.delete('object_id')
+
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = Utils.build_url('_plugins/_observability/object', _object_id)
+
+          Utils.validate_query_params! args
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/observability/delete_objects.rb

@@ -0,0 +1,40 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Observability
+      module Actions
+        # Deletes specific observability objects specified by ID or a list of IDs.
+        #
+        # @option args [String] :objectId The ID of a single Observability Object to delete.
+        # @option args [String] :objectIdList A comma-separated list of Observability Object IDs to delete.
+        # @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
+        def delete_objects(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          ignore  = args.delete('ignore') || []
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'DELETE'
+          url     = '_plugins/_observability/object'
+
+          Utils.validate_query_params! args, DELETE_OBJECTS_QUERY_PARAMS
+          transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
+        end
+
+        DELETE_OBJECTS_QUERY_PARAMS = Set.new(%w[
+          objectId
+          objectIdList
+        ]).freeze
+      end
+    end
+  end
+end

data/lib/opensearch/api/actions/observability/get_localstats.rb

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+
+# This file is generated from the OpenSearch REST API spec.
+# Do not modify it by hand. Instead, modify the generator or the spec.
+
+# frozen_string_literal: true
+
+module OpenSearch
+  module API
+    module Observability
+      module Actions
+        # Retrieves local stats of all observability objects.
+        #
+        def get_localstats(args = {})
+          args = Utils.clone_and_normalize_arguments(args)
+          headers = args.delete('headers') || {}
+          body    = args.delete('body')
+          method  = 'GET'
+          url     = '_plugins/_observability/_local/stats'
+
+          Utils.validate_query_params! args
+          transport.perform_request(method, url, args, body, headers).body
+        end
+      end
+    end
+  end
+end