elastic-enterprise-search 7.13.0 → 7.15.1

data/docs/guide/release_notes/715.asciidoc

@@ -0,0 +1,48 @@
+[[release_notes_715]]
+=== 7.15 Release notes
+
+[discrete]
+[[release_notes_7151]]
+=== 7.15.1 Release notes
+
+==== Dependency fix
+
+Updates dependency on `elasticsearch-transport` to be more open. At least 7.11 is required, but this way it can be used with different versions of the `elasticsearch` gem (bigger than or equal to `7.11`) in the same project, without a conflict in `elasticsearch-transport`. When instantiating transport, we now check if version is `< 7.14` so we use the right class.
+
+[discrete]
+[[release_notes_7150]]
+=== 7.15.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.15.0.
+- Better source code documentation in general for API endpoints.
+
+[discrete]
+==== App Search
+
+- The test suite was migrated to full integration testing https://clients-ci.elastic.co/view/Ruby/[in Jenkins]. We were using VCR for testing the API, but now we're running the API tests against an instance of Elastic Enterprise Search.
+
+- Some APIs that used to work with `GET` query parameters in App Search are now `POST` and the parameters being sent with the body. We'll use the body from `7.15`, but we'll keep supporting arguments parameters in 7.x for backwards compatibility. Some parameters previously required through the generated code don't throw an exception anymore and the error is delegated to server. As mentioned, these should go through the body instead of part of the query parameters, but we still support sending them as query parameters in `7.x` to keep backwards compatibility.
+
+[discrete]
+===== Web Crawler API
+
+[CAUTION]
+====
+The Elastic Enterprise Search web crawler API is a *beta* feature.
+Beta features are subject to change and are not covered by the support SLA of general release (GA) features.
+Elastic plans to promote this feature to GA in a future release.
+====
+
+New Web Crawler API endpoints:
+
+`crawler_active_crawl_request`, `crawler_crawl_request`, `crawler_crawl_schedule`, `crawler_domain`, `crawler_domain_validation_result`, `crawler_metrics`, `crawler_overview`, `crawler_process_crawl_denied_urls`, `crawler_process_crawl`, `crawler_url_extraction_result`, `crawler_url_tracing_result`, `crawler_url_validation_result`, `crawler_user_agent`, `create_crawler_crawl_request`, `create_crawler_crawl_rule`, `create_crawler_domain`, `create_crawler_entry_point`, `create_crawler_process_crawl`, `create_crawler_sitemap`, `delete_active_crawl_request`, `delete_crawler_active_crawl_request`, `delete_crawler_crawl_rule`, `delete_crawler_crawl_schedule`, `delete_crawler_domain`, `delete_crawler_entry_point`, `delete_crawler_sitemap`, `list_crawler_crawl_requests`, `list_crawler_process_crawls`, `put_crawler_crawl_rule`, `put_crawler_crawl_schedule`, `put_crawler_domain`, `put_crawler_entry_point`, `put_crawler_sitemap`.
+
+Refer to https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html[App Search API] for more information and examples.
+
+[discrete]
+==== Workplace Search
+
+- New APIs: `auto_query_refinement_details`, `triggers_blocklist` and `put_triggers_blocklist`. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html[Workplace Search API] for more information and examples.

data/docs/guide/release_notes/index.asciidoc

@@ -5,11 +5,15 @@
 [discrete]
 === 7.x
 
+* <<release_notes_715, 7.15.0 Release Notes>>
+* <<release_notes_714, 7.14.0 Release Notes>>
 * <<release_notes_713, 7.13.0 Release Notes>>
 * <<release_notes_712, 7.12.0 Release Notes>>
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::715.asciidoc[]
+include::714.asciidoc[]
 include::713.asciidoc[]
 include::712.asciidoc[]
 include::711.asciidoc[]

data/docs/guide/workplace-search-api.asciidoc

@@ -26,6 +26,20 @@ body = {
   is_searchable: true
 }
 client.put_content_source(id, body: body)
+
+# Issue commands to a Content Source's sync jobs
+client.command_sync_jobs(content_source_id, body: { command: 'interrupt' })
+
+# Update a content source icon
+# You need to encode the file with Base64:
+require 'base64'
+
+path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
+icon = Base64.strict_encode64(File.read(path))
+response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
+
+# Retrieves a content source's automatic query refinement details
+client.auto_query_refinement_details(content_source_id)
 ----------------------------
 
 === Documents
@@ -50,6 +64,9 @@ client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e
 
 # Delete all documents for a given content source
 client.delete_all_documents(content_source_id)
+
+# Delete documents by query
+client.delete_documents_by_query(content_source_id, query: query)
 ----------------------------
 
 [discrete]
@@ -163,3 +180,55 @@ body = {
 
 client.create_analytics_event(access_token: oauth_access_token, body: body)
 ----------------------------
+
+=== Synonym Sets
+
+[source,rb]
+----------------------------
+body = {
+  synonym_sets: [
+    { 'synonyms' => ['house', 'home', 'abode'] },
+    { 'synonyms' => ['cat', 'feline', 'kitty'] },
+    { 'synonyms' => ['mouses', 'mice'] }
+  ]
+}
+
+# Create batch synonym set
+client.create_batch_synonym_sets(body: body)
+
+# Delete synonym set
+client.delete_synonym_set(synonym_set_id: id)
+
+# List synonym sets
+client.list_synonym_sets
+
+# Get a synonym set
+client.synonym_set(synonym_set_id: id)
+
+# Update a synonym set
+body = { synonyms: ['mouses', 'mice', 'luch'] }
+client.put_synonym_set(synonym_set_id: id, body: body)
+----------------------------
+
+
+=== Current User
+
+[source,rb]
+----------------------------
+# Get the current user
+client.current_user
+
+# Get the current user and return the access token
+client.current_user(get_token: true)
+----------------------------
+
+=== Triggers Blocklist
+
+[source,rb]
+----------------------------
+# Get current triggers blocklist
+client.triggers_blocklist
+
+# Update current triggers blocklist
+client.put_triggers_blocklist(body: { blocklist: ['in', 'it', 'page'] })
+----------------------------

data/elastic-enterprise-search.gemspec

@@ -47,7 +47,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'elasticsearch-transport', '~> 7.13.0'
+  s.add_dependency 'elasticsearch-transport', '>= 7.11'
   s.add_runtime_dependency 'jwt', '>= 1.5', '< 3.0'
   s.add_development_dependency 'awesome_print'
   s.add_development_dependency 'byebug' unless defined?(JRUBY_VERSION)

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

@@ -21,9 +21,10 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Engine - Add a source engine to an existing meta engine
+        # Engines - Add a source engine
+        # Adds a source engine to a given meta engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [Array] :source_engines List of engine names (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request

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

@@ -0,0 +1,52 @@
+# 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
+        # Credentials - Retrieve an API key
+        # Retrieves details of an API key
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :api_key_name Name of an API key (*Required*)
+        # @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/credentials.html#credentials-single
+        #
+        def api_key(arguments = {})
+          raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
+
+          api_key_name = arguments[:api_key_name]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v1/credentials/#{api_key_name}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -21,27 +21,28 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Logs - The API Log displays API request and response data at the Engine level
+        # APILogs - Retrieve API logs
+        # The API Log displays API request and response data at the Engine level
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :from_date Filter date from (*Required*)
-        # @option arguments [String] :to_date Filter date to (*Required*)
-        # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
-        # @option arguments [Integer] :page_size The number of results per page
-        # @option arguments [String] :query Use this to specify a particular endpoint, like analytics, search, curations and so on
-        # @option arguments [String] :http_status_filter Filter based on a particular status code: 400, 401, 403, 429, 200
-        # @option arguments [String] :http_method_filter Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
-        # @option arguments [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest?
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Date] :from_date Filter date from (*Required*)
+        # @option arguments [Date] :to_date Filter date to (*Required*)
+        # @option arguments [Hash] :body
+        # @option body [String] :query You can search over the full_request_path of an API Log event. Use this to specify a particular endpoint, like analytics, search, curations and so on.
+        # @option body [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest? Accepts asc or desc. Defaults to ascending.
+        # @option body [Integer] :page current for current page, total_pages for the net number of pages, total_results for the overall number of results, size for the amount of results per page.
+        # @option body :filters
+        # @option filters [String] :status Filter based on a particular status code: 400, 401, 403, 429, 200
+        # @option filters [String] :method Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
         #
         def api_logs(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
           raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
@@ -49,7 +50,7 @@ module Elastic
           arguments['filters[date][to]'] = date_to_rfc3339(arguments.delete(:to_date))
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/logs/api/",
             arguments,
             body,

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

@@ -21,13 +21,14 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Analytics - Returns the number of clicks and total number of queries over a period
+        # Analytics - Query for analytics counts data
+        # Returns the number of clicks and total number of queries over a period
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :filters Analytics filters
-        # @option arguments [String] :interval You can define an interval along with your date range. Can be either hour or day
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body
+        # @option body :filters Analytics filters
+        # @option body [String] :interval You can define an interval along with your date range. Can be either hour or day
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/counts.html
@@ -39,7 +40,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/analytics/counts/",
             arguments,
             body,

data/lib/elastic/app-search/api/crawler_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 - Get active crawl request details
+        # Returns active crawl request details.
+        #
+        # @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-get-crawler-crawl-requests-active
+        #
+        def crawler_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(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 crawl request details
+        # Returns crawl request details.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :crawl_request_id Crawl Request ID (*Required*)
+        # @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-get-crawler-crawl-requests-id
+        #
+        def crawler_crawl_request(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'crawl_request_id' missing" unless arguments[:crawl_request_id]
+
+          crawl_request_id = arguments[:crawl_request_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/crawler_crawl_schedule.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 - Get crawl schedule
+        # Returns the current crawl schedule for a given engine
+        #
+        # @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-get-crawler-crawl-schedule
+        #
+        def crawler_crawl_schedule(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_schedule/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 domain configuration
+        # Returns crawler domain configuration details
+        #
+        # @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 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-get-crawler-domain
+        #
+        def crawler_domain(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(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/crawler_domain_validation_result.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 - Validate Domain with Crawler
+        # Performs a number of checks on a given domain name to make sure it is ready to be crawled and ingested into App Search.
+        #
+        # @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
+        #
+        def crawler_domain_validation_result(arguments = {})
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            'api/as/v0/crawler/validate_url/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/crawler_metrics.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 - Retrieve a snapshot of crawler metrics
+        # Retrieves a momentary snapshot of key crawler metrics, including global and node-level crawler health
+        #
+        # @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
+        #
+        def crawler_metrics(arguments = {})
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            'api/as/v0/crawler/metrics/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end