elastic-enterprise-search 7.10.0.beta.1 → 7.11.0

data/lib/elastic/enterprise_search.rb

@@ -19,7 +19,7 @@
 
 require 'elastic/enterprise-search/version'
 
-# Require generated API code:
+# Require API code:
 [
   "#{File.dirname(__FILE__)}/enterprise-search/api/*.rb",
   "#{File.dirname(__FILE__)}/workplace-search/api/*.rb",

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

@@ -24,27 +24,28 @@ module Elastic
         # Permissions - Adds one or more new permissions atop existing permissions
         # Add one or more permission for a given user. Permissions are added atop the existing
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-one
         #
-        def add_user_permissions(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def add_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
-            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/add/",
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/add/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -0,0 +1,59 @@
+# 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
+        # Analytics - capture click and feedback analytic events
+        # Capture Analytic Events
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :access_token OAuth Access Token (*Required*)
+        # @option arguments [Object] :body
+        # @option body [String] :type
+        # @option body [String] :query_id query identifier for the event
+        # @option body [Integer] :page page number of the document in the query result set
+        # @option body [String] :content_source_id content source identifier for the event document
+        # @option body [String] :document_id document identifier for the event
+        # @option body [Integer] :rank rank of the document in the overall result set
+        # @option body [String] :event the target identifier for a click event
+        # @option body [Integer] :score the feedback score, constrained to the values -1 or 1
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-analytics-api.html
+        #
+        def create_analytics_event(arguments = {})
+          raise ArgumentError, "Required parameter 'access_token' missing" unless arguments[:access_token]
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :post,
+            'api/ws/v1/analytics/event/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -24,23 +24,25 @@ module Elastic
         # ExternalIdentities - Adds a new external identity
         # Adds a new external identity
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 body - The request body
-        #
+        # @option arguments [Object] :body  (Required: source_user_id, user)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#add-external-identity
         #
-        def create_external_identity(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def create_external_identity(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_key}/external_identities/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -24,23 +24,25 @@ module Elastic
         # Documents - Deletes a list of documents from a custom content source
         # Remove documents from a Custom API Source
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 body - The request body
-        #
+        # @option arguments [Array] :body
+        # @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#destroy
         #
-        def delete_documents(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def delete_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_key}/documents/bulk_destroy/",
+            "api/ws/v1/sources/#{content_source_id}/documents/bulk_destroy/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -24,23 +24,27 @@ module Elastic
         # ExternalIdentities - Deletes an external identity
         # Deletes an external identity
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#remove-external-identity
         #
-        def delete_external_identity(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def delete_external_identity(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
 
+          headers = arguments.delete(:headers) || {}
+
           request(
             :delete,
-            "api/ws/v1/sources/#{content_source_key}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
             arguments,
-            {}
+            {},
+            headers
           )
         end
       end

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

@@ -24,23 +24,27 @@ module Elastic
         # ExternalIdentities - Retrieves an external identity
         # Retrieves an external identity
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#show-external-identity
         #
-        def external_identity(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def external_identity(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
 
+          headers = arguments.delete(:headers) || {}
+
           request(
             :get,
-            "api/ws/v1/sources/#{content_source_key}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
             arguments,
-            {}
+            {},
+            headers
           )
         end
       end

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

@@ -24,23 +24,26 @@ module Elastic
         # Documents - Indexes one or more new documents into a custom content source, or updates one or more existing documents
         # Indexes one or more new documents into a custom content source, or updates one or more existing documents
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 body - The request body
-        #
+        # @option arguments [Array] :documents (*Required*)
+        # @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#index-and-update
         #
-        def index_documents(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def index_documents(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
+          raise ArgumentError, "Required parameter 'documents' missing" unless arguments[:documents]
 
-          body = arguments.delete(:body) || {}
+          documents = arguments.delete(:documents) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
-            "api/ws/v1/sources/#{content_source_key}/documents/bulk_create/",
+            "api/ws/v1/sources/#{content_source_id}/documents/bulk_create/",
             arguments,
-            body
+            documents,
+            headers
           )
         end
       end

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

@@ -24,21 +24,25 @@ module Elastic
         # ExternalIdentities - Retrieves all external identities
         # Retrieves all external identities
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 current_page [Integer] Which page of results to request
-        # @option page_size [Integer] The number of results to return in a page
+        # @option arguments [Integer] :current_page Which page of results to request
+        # @option arguments [Integer] :page_size The number of results to return in a page
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#list-external-identities
         #
-        def list_external_identities(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def list_external_identities(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_key}/external_identities/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/",
             arguments,
-            {}
+            {},
+            headers
           )
         end
       end

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

@@ -24,21 +24,25 @@ module Elastic
         # Permissions - Lists all permissions for all users
         # List all permissions for all users
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 current_page [Integer] Which page of results to request
-        # @option page_size [Integer] The number of results to return in a page
+        # @option arguments [Integer] :current_page Which page of results to request
+        # @option arguments [Integer] :page_size The number of results to return in a page
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list
         #
-        def list_permissions(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def list_permissions(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_key}/permissions/",
+            "api/ws/v1/sources/#{content_source_id}/permissions/",
             arguments,
-            {}
+            {},
+            headers
           )
         end
       end

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

@@ -24,27 +24,28 @@ module Elastic
         # ExternalIdentities - Updates an external identity
         # Updates an external identity
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Object] :body  (Required: source_user_id, user)
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-external-identities-api.html#update-external-identity
         #
-        def put_external_identity(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def put_external_identity(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :put,
-            "api/ws/v1/sources/#{content_source_key}/external_identities/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/external_identities/#{user}/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -24,27 +24,28 @@ module Elastic
         # Permissions - Creates a new set of permissions or over-writes all existing permissions
         # Create a set of permissions or overwrite existing permissions
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#add-all
         #
-        def put_user_permissions(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def put_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :put,
-            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/",
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end

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

@@ -24,27 +24,28 @@ module Elastic
         # Permissions - Removes one or more permissions from an existing set of permissions
         # Remove one or more permission for a given user
         #
-        # @param content_source_key [String] Unique key for a Custom API source, provided upon creation of a Custom API Source (*Required*)
+        # @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 user [String] The username in context (*Required*)
-        # @option body - The request body
-        #
+        # @option arguments [String] :user The username in context (*Required*)
+        # @option arguments [Array] :body List of permissions
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#remove-one
         #
-        def remove_user_permissions(content_source_key, arguments = {})
-          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+        def remove_user_permissions(content_source_id, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_id' missing" unless content_source_id
           raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
 
           user = arguments[:user]
-
           body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
 
           request(
             :post,
-            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/remove/",
+            "api/ws/v1/sources/#{content_source_id}/permissions/#{user}/remove/",
             arguments,
-            body
+            body,
+            headers
           )
         end
       end