elastic-enterprise-search 7.14.0 → 7.16.0

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

@@ -22,17 +22,17 @@ module Elastic
     module AppSearch
       module Actions
         # Documents - Partial update of documents
+        # Update specific document fields by id and field
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :documents List of documents to update (*Required*)
+        # @option arguments [Array] :documents
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/documents.html#documents-partial
         #
         def put_documents(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
 
           documents = arguments.delete(:documents) || {}
           headers = arguments.delete(:headers) || {}

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

@@ -21,18 +21,18 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Schema - Update schema for the current engine
+        # Schema - Update engine schema
+        # Update schema for the current engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Object] :schema Schema description (*Required*)
+        # @option arguments [Object] :schema
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/schema.html#schema-patch
         #
         def put_schema(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
-          raise ArgumentError, "Required parameter 'schema' missing" unless arguments[:schema]
 
           schema = arguments.delete(:schema) || {}
           headers = arguments.delete(:headers) || {}

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

@@ -23,9 +23,13 @@ module Elastic
       module Actions
         # Searchsettings - Update search settings 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 Search settings (*Required*)
+        # @option arguments [Hash] :body
+        # @option body :boosts
+        # @option body :search_fields
+        # @option body :result_fields
+        # @option body [Integer] :precision
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search-settings.html#search-settings-update

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

@@ -21,12 +21,15 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Synonyms - Update a synonym set by ID
+        # Synonyms - Update a synonym set
+        # Updates a synonym set by ID
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :synonym_set_id  (*Required*)
-        # @option arguments [Object] :body Synonym set description (*Required*)
+        # @option arguments [String] :synonym_set_id Synonym Set ID (*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-update
@@ -34,7 +37,7 @@ module Elastic
         def put_synonym_set(engine_name, arguments = {})
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
-          raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
+          raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body] || arguments[:synonyms]
 
           synonym_set_id = arguments[:synonym_set_id]
           body = arguments.delete(:body) || {}

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

@@ -21,20 +21,20 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Querysuggestion - Provide relevant query suggestions for incomplete queries
+        # QuerySuggestion - Retrieve query suggestions
+        # Provide relevant query suggestions for incomplete queries
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :query A partial query for which to receive suggestions (*Required*)
-        # @option arguments [Array] :fields List of fields to use to generate suggestions. Defaults to all text fields
-        # @option arguments [Integer] :size Number of query suggestions to return. Must be between 1 and 20. Defaults to 5
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body
+        # @option body [String] :query
+        # @option body :types
+        # @option body [Integer] :size
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/query-suggestion.html
         #
         def query_suggestion(engine_name, arguments = {})
-          raise ArgumentError, "Required parameter 'query' missing" unless arguments[:query]
           raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}

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

@@ -21,9 +21,10 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Searchsettings - Reset search settings for the engine
+        # Synonyms - Reset search settings
+        # Resets search settings for the engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @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

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

@@ -21,9 +21,10 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Schema - Retrieve current schema for the engine
+        # Schema - Retrieve engine schema
+        # Retrieve current schema for the engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @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

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

@@ -21,11 +21,22 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Search - Allows you to search over, facet and filter your data
+        # Search - Submit a search
+        # Submit a search and receive a set of results with meta data
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Object] :body Search request parameters
+        # @option arguments [Hash] :body  (Required: query)
+        # @option body [String] :query  (*Required)
+        # @option body :analytics
+        # @option body :boost
+        # @option body :facets
+        # @option body :filters
+        # @option body :group
+        # @option body :page
+        # @option body :result_fields
+        # @option body :search_fields
+        # @option body :sort
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/search.html

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

@@ -21,9 +21,10 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Searchsettings - Retrieve current search settings for the engine
+        # SearchSettings - Retrieve search settings
+        # Retrieve current search settings for the engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @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

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

@@ -21,11 +21,12 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Synonyms - Retrieve a synonym set by ID
+        # Synonyms - Retrieve a synonym set
+        # Retrieves a synonym set by ID
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :synonym_set_id  (*Required*)
+        # @option arguments [String] :synonym_set_id Synonym Set 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/top_clicks_analytics.rb

@@ -21,15 +21,15 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Analytics - Returns the number of clicks received by a document in descending order
+        # Analytics - Query for analytics click data
+        # Returns the number of clicks received by a document in descending order
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :query Filter clicks over a search query
-        # @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 [Array] :filters Analytics filters
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body
+        # @option body [String] :query
+        # @option body :filters
+        # @option body [Object] :page
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/clicks.html
@@ -41,7 +41,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/analytics/clicks/",
             arguments,
             body,

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

@@ -21,14 +21,14 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Analytics - Returns queries analytics by usage count
+        # Analytics - Query for analytics query data
+        # Returns queries analytics by usage count
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @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 [Array] :filters Analytics filters
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body
+        # @option body :filters
+        # @option body [Object] :page
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/queries.html#queries-top-queries
@@ -40,7 +40,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/analytics/queries/",
             arguments,
             body,

data/lib/elastic/app-search/app_search.rb

@@ -25,20 +25,10 @@ module Elastic
     #
     # @see https://www.elastic.co/guide/en/app-search/current/index.html
     module AppSearch
-      # The Request module is included in the AppSearch Client to override
-      # EnterpriseSearch client's authentication method with App's
-      # authentication.
-      module Request
-        def setup_authentication_header
-          "Bearer #{http_auth}"
-        end
-      end
-
       # The App Search Client
       # Extends EnterpriseSearch client but overrides authentication to use access token.
       class Client < Elastic::EnterpriseSearch::Client
         include Elastic::EnterpriseSearch::AppSearch::Actions
-        include Elastic::EnterpriseSearch::AppSearch::Request
 
         # Create a new Elastic::EnterpriseSearch::AppSearch::Client client
         #

data/lib/elastic/enterprise-search/api/health.rb

@@ -23,6 +23,7 @@ module Elastic
       # Health - Get information on the health of a deployment and basic statistics around resource usage
       # Get information on the health of a deployment and basic statistics around resource usage
       #
+      # @param arguments [Hash] endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/monitoring-apis.html#health-api-example

data/lib/elastic/enterprise-search/api/put_read_only.rb

@@ -23,8 +23,9 @@ module Elastic
       # Read-Only - Update the read-only flag's state
       # Update the read-only flag's state
       #
-      # @option arguments [Object] :body
-      # @option body [Boolean] :enabled
+      # @param arguments [Hash] endpoint arguments
+      # @option arguments [Hash] :body  (Required: enabled)
+      # @option body [Boolean] :enabled  (*Required)
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#setting-read-only-state

data/lib/elastic/enterprise-search/api/read_only.rb

@@ -23,6 +23,7 @@ module Elastic
       # Read-Only - Get the read-only flag's state
       # Get the read-only flag's state
       #
+      # @param arguments [Hash] endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/read-only-api.html#getting-read-only-state

data/lib/elastic/enterprise-search/api/version.rb

@@ -23,6 +23,7 @@ module Elastic
       # Version - Get version information for this server
       # Get version information for this server
       #
+      # @param arguments [Hash] endpoint arguments
       # @option arguments [Hash] :headers optional HTTP headers to send with the request
       #
       # @see https://www.elastic.co/guide/en/enterprise-search/current/management-apis.html

data/lib/elastic/enterprise-search/client.rb

@@ -67,7 +67,7 @@ module Elastic
 
       def transport
         @options[:transport] ||
-          Elasticsearch::Client.new(
+          transport_klass.new(
             host: host,
             log: log,
             logger: logger,
@@ -110,6 +110,17 @@ module Elastic
 
         @options[:host]
       end
+
+      private
+
+      def transport_klass
+        case Elasticsearch::Transport::VERSION
+        when /7\.1[123]/
+          Elasticsearch::Client
+        else
+          Elasticsearch::Transport::Client
+        end
+      end
     end
   end
 end

data/lib/elastic/enterprise-search/request.rb

@@ -58,7 +58,16 @@ module Elastic
       end
 
       def setup_authentication_header
-        basic_auth_header
+        if instance_of? Elastic::EnterpriseSearch::Client
+          basic_auth_header
+        else
+          case http_auth
+          when Hash
+            basic_auth_header
+          when String
+            "Bearer #{http_auth}"
+          end
+        end
       end
 
       def basic_auth_header

data/lib/elastic/enterprise-search/version.rb

@@ -19,6 +19,6 @@
 
 module Elastic
   module EnterpriseSearch
-    VERSION = '7.14.0'
+    VERSION = '7.16.0'
   end
 end

data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb

@@ -0,0 +1,49 @@
+# 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 WorkplaceSearch
+      module Actions
+        # ContentSources - Retrieves a content source's automatic query refinement details
+        # Retrieves a content source's automatic query refinement details
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#get-automatic-query-refinement-details-api
+        #
+        def auto_query_refinement_details(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_id}/automatic_query_refinement/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/create_content_source.rb

@@ -32,6 +32,7 @@ module Elastic
         # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page.
         # @option body :indexing
         # @option body :facets
+        # @option body :automatic_query_refinement
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#create-content-source-api

data/lib/elastic/workplace-search/api/delete_synonym_set.rb

@@ -25,7 +25,7 @@ module Elastic
         # Delete a synonym set
         #
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
+        # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#delete-synonym

data/lib/elastic/workplace-search/api/list_documents.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 WorkplaceSearch
+      module Actions
+        # Documents - Lists documents from a custom content source
+        # Lists documents from a custom content source
+        #
+        # @param content_source_id [String] Unique ID for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body [Object] :page Paging controls for the result set
+        # @option body :filters
+        # @option body :sort
+        # @option body [String] :cursor
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-custom-sources-api.html#list-documents
+        #
+        def list_documents(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_id}/documents/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_content_source.rb

@@ -33,6 +33,7 @@ module Elastic
         # @option body [Boolean] :is_searchable Whether or not this Content Source will be searchable on the search page. (*Required)
         # @option body :indexing
         # @option body :facets
+        # @option body :automatic_query_refinement
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-content-sources-api.html#update-content-source-api

data/lib/elastic/workplace-search/api/put_synonym_set.rb

@@ -25,7 +25,7 @@ module Elastic
         # Update a synonym set
         #
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
+        # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
         # @option arguments [Hash] :body  (Required: synonyms)
         # @option body [Array] :synonyms A list of terms for this synonym set (*Required)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request

data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb

@@ -0,0 +1,47 @@
+# 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 WorkplaceSearch
+      module Actions
+        # Update current triggers blocklist
+        #
+        # @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/workplace-search/current/automatic-query-refinement-blocklist.html
+        #
+        def put_triggers_blocklist(arguments = {})
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            'api/ws/v1/automatic_query_refinement/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/search.rb

@@ -36,6 +36,9 @@ module Elastic
         # @option body :sort
         # @option body [Object] :facets
         # @option body [Object] :boosts
+        # @option body :source_type Optional parameter to search standard, remote only, or all available sources
+        # @option body [Integer] :timeout Optional timeout in ms for searching remote sources
+        # @option body [Array] :content_sources Optional list of content source ids to only return results from
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html

data/lib/elastic/workplace-search/api/synonym_set.rb

@@ -25,7 +25,7 @@ module Elastic
         # Retrieve a synonym set by ID
         #
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :synonym_set_id Unique ID for a content source document. Provided upon or returned at creation. (*Required*)
+        # @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#show-synonym