elastic-enterprise-search 7.14.0 → 7.16.0

data/lib/elastic/app-search/api/crawler_url_validation_result.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Validate URL with Crawler
+        # Performs a number of checks on a given URL to make sure it is ready to be crawled and ingested into App Search.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-url
+        #
+        def crawler_url_validation_result(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/validate_url/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/crawler_user_agent.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Get the User-Agent header value for the crawler
+        # Retrieves the currently configured value for the User-Agent header used for all Crawler HTTP requests
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-user-agent
+        #
+        def crawler_user_agent(arguments = {})
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            'api/as/v0/crawler/user_agent/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_api_key.rb

@@ -22,9 +22,17 @@ module Elastic
     module AppSearch
       module Actions
         # Credentials - Create an API key
+        # Creates an App Search API key
         #
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Object] :body API key details (*Required*)
+        # @option arguments [Hash] :body Details of an API key (Required: name, type)
+        # @option body [String] :id
+        # @option body [String] :name  (*Required)
+        # @option body [String] :type  (*Required)
+        # @option body [Boolean] :access_all_engines
+        # @option body :engines
+        # @option body [Boolean] :write
+        # @option body [Boolean] :read
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-create

data/lib/elastic/app-search/api/create_crawler_crawl_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a crawl request
+        # Creates a request to perform a crawl of a given engine with the Crawler.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-crawl-requests
+        #
+        def create_crawler_crawl_request(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a crawl rule
+        # Creates a crawl rule for a given engine and domain
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
+        # @option arguments [Hash] :body  (Required: order, policy, rule, pattern)
+        # @option body [String] :id
+        # @option body [Integer] :order  (*Required)
+        # @option body [String] :policy  (*Required)
+        # @option body [String] :rule  (*Required)
+        # @option body [String] :pattern  (*Required)
+        # @option body [String] :created_at
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawl-rules
+        #
+        def create_crawler_crawl_rule(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
+
+          domain_id = arguments[:domain_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/crawl_rules/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_crawler_domain.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a crawler domain
+        # Creates a crawler domain configuration for a given engine
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body [String] :name
+        # @option body [Array] :entry_points
+        # @option body [Array] :crawl_rules
+        # @option body [Array] :sitemaps
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-domains
+        #
+        def create_crawler_domain(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_crawler_entry_point.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a crawler entry point
+        # Creates a crawler domain entry point for a given engine and domain
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
+        # @option arguments [Hash] :body  (Required: value)
+        # @option body [String] :id
+        # @option body [String] :value  (*Required)
+        # @option body [String] :created_at
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-entry-points
+        #
+        def create_crawler_entry_point(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
+
+          domain_id = arguments[:domain_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/entry_points/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_crawler_process_crawl.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a process crawl
+        # Queues a task to reprocess crawled documents with current crawl configuration
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body [Boolean] :dry_run
+        # @option body [Array] :domains
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-process-crawls
+        #
+        def create_crawler_process_crawl(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/process_crawls/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_crawler_sitemap.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Create a crawler sitemap
+        # Creates a crawler sitemap configuration for a given engine and domain
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
+        # @option arguments [Hash] :body  (Required: url)
+        # @option body [String] :id
+        # @option body [String] :url  (*Required)
+        # @option body [String] :created_at
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-sitemaps
+        #
+        def create_crawler_sitemap(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
+
+          domain_id = arguments[:domain_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/sitemaps/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/create_curation.rb

@@ -22,19 +22,21 @@ module Elastic
     module AppSearch
       module Actions
         # Curations - Create a new curation
+        # Create a new curation for the engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :queries List of affected search queries (*Required*)
-        # @option arguments :promoted_doc_ids List of promoted document IDs
-        # @option arguments :hidden_doc_ids List of hidden document IDs
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body  (Required: queries)
+        # @option body [String] :id
+        # @option body [Array] :queries List of affected search queries (*Required)
+        # @option body [Array] :promoted List of promoted document IDs
+        # @option body [Array] :hidden List of hidden document IDs
+        # @option body :suggestion
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create
         #
         def create_curation(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}

data/lib/elastic/app-search/api/create_engine.rb

@@ -21,20 +21,22 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Engine - Creates a new engine
+        # Engines - Create an Engine
+        # Creates an App Search Engine
         #
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :name Engine name (*Required*)
-        # @option arguments [String] :language Engine language (null for universal)
-        # @option arguments [String] :type Engine type
-        # @option arguments [Array] :source_engines Sources engines list
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body  (Required: name)
+        # @option body :name  (*Required)
+        # @option body [String] :language Engine language (null for universal)
+        # @option body :type
+        # @option body :source_engines
+        # @option body [Integer] :document_count
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-create
         #
         def create_engine(arguments = {})
-          raise ArgumentError, "Required parameter 'name' missing" unless arguments[:name]
+          raise ArgumentError, "Required parameter 'body (name)' missing" unless arguments[:body] || arguments[:name]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}

data/lib/elastic/app-search/api/create_synonym_set.rb

@@ -21,18 +21,21 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Synonyms - Create a new synonym set
+        # Synonyms - Create a synonym set
+        # Creates a new synonym set for the engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Object] :body Synonym set description (*Required*)
+        # @option arguments [Hash] :body  (Required: synonyms)
+        # @option body [String] :id
+        # @option body :synonyms  (*Required)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-create
         #
         def create_synonym_set(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body]
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}

data/lib/elastic/app-search/api/curation.rb

@@ -21,11 +21,12 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Curations - Retrieve a curation by ID
+        # Curations - Retrieve a curation
+        # Retrieves a curation by ID
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :curation_id  (*Required*)
+        # @option arguments [String] :curation_id Curation ID (*Required*)
         # @option arguments [Hash] :body The request body
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #

data/lib/elastic/app-search/api/delete_active_crawl_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Cancel an active crawl request
+        # Cancels an active crawl request, stopping a running crawl if needed.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-crawl-requests-active-cancel
+        #
+        def delete_active_crawl_request(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/cancel/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/delete_api_key.rb

@@ -22,6 +22,7 @@ module Elastic
     module AppSearch
       module Actions
         # Credentials - Delete an API key
+        # Deletes a given API key
         #
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :api_key_name Name of an API key (*Required*)