elastic-enterprise-search 7.12.1 → 7.15.0

data/lib/elastic/workplace-search/api/list_synonym_sets.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 WorkplaceSearch
+      module Actions
+        # Synonyms - Retrieves all synonym sets
+        # Retrieve a list of synonym sets
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body
+        # @option body :page
+        # @option body :sort
+        # @option body :filter
+        # @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#list-synonyms
+        #
+        def list_synonym_sets(arguments = {})
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            'api/ws/v1/synonyms/',
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# 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 - Update a content source
+        # Update a 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 Definition to update a Workplace Search Content Source (Required: name, is_searchable)
+        # @option body [String] :name The human readable display name for this Content Source. (*Required)
+        # @option body :schema The schema that each document in this Content Source will adhere to.
+        # @option body :display The display details which governs which fields will be displayed, and in what order, in the search results.
+        # @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
+        #
+        def put_content_source(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(
+            :put,
+            "api/ws/v1/sources/#{content_source_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_content_source_icons.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 WorkplaceSearch
+      module Actions
+        # ContentSources - Upload content source icons
+        # Upload content source icons
+        #
+        # @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 Definition to upload Workplace Search Custom Source icons
+        # @option body [String] :main_icon
+        # @option body [String] :alt_icon
+        # @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#upload-content-source-icon-api
+        #
+        def put_content_source_icons(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(
+            :put,
+            "api/ws/v1/sources/#{content_source_id}/icon/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -27,7 +27,9 @@ module Elastic
         # @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 [String] :user The username in context (*Required*)
-        # @option arguments [Object] :body  (Required: source_user_id, user)
+        # @option arguments [Hash] :body  (Required: source_user_id, user)
+        # @option body [String] :source_user_id  (*Required)
+        # @option body [String] :user  (*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#update-external-identity

data/lib/elastic/workplace-search/api/put_synonym_set.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 WorkplaceSearch
+      module Actions
+        # Synonyms - Update a synonym set
+        # Update a synonym set
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @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
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-synonyms-api.html#update-synonym
+        #
+        def put_synonym_set(arguments = {})
+          raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
+
+          synonym_set_id = arguments.delete(:synonym_set_id)
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :put,
+            "api/ws/v1/synonyms/#{synonym_set_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -26,7 +26,7 @@ module Elastic
         #
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :access_token OAuth Access Token (*Required*)
-        # @option arguments [Object] :body
+        # @option arguments [Hash] :body
         # @option body [String] :query A string or number used to find related documents
         # @option body [Boolean] :automatic_query_refinement Set to false to not automatically refine the query by keywords
         # @option body [Object] :page Paging controls for the result set
@@ -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

@@ -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 WorkplaceSearch
+      module Actions
+        # Synonyms - Retrieve a synonym set by ID
+        # Retrieve a synonym set by ID
+        #
+        # @param arguments [Hash] endpoint arguments
+        # @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
+        #
+        def synonym_set(arguments = {})
+          raise ArgumentError, "Required parameter 'synonym_set_id' missing" unless arguments[:synonym_set_id]
+
+          synonym_set_id = arguments[:synonym_set_id]
+
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/ws/v1/synonyms/#{synonym_set_id}/",
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# 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
+        # Get current triggers blocklist
+        #
+        # @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/automatic-query-refinement-blocklist.html
+        #
+        def triggers_blocklist(arguments = {})
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            'api/ws/v1/automatic_query_refinement/',
+            arguments,
+            {},
+            headers
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -21,20 +21,10 @@ module Elastic
   module EnterpriseSearch
     # Workplace Search client for Enterprise Search.
     module WorkplaceSearch
-      # The Request module is included in the WorkplaceSearch Client to override
-      # EnterpriseSearch client's authentication method with Workplace's
-      # authentication.
-      module Request
-        def setup_authentication_header
-          "Bearer #{http_auth}"
-        end
-      end
-
       # The Workplace Search Client
       # Extends EnterpriseSearch client but overrides authentication to use access token.
       class Client < Elastic::EnterpriseSearch::Client
         include Elastic::EnterpriseSearch::WorkplaceSearch::Actions
-        include Elastic::EnterpriseSearch::WorkplaceSearch::Request
         include Elastic::EnterpriseSearch::Utils
 
         # Create a new Elastic::EnterpriseSearch::WorkplaceSearch::Client client

data/rake_tasks/unified_release_tasks.rake

@@ -0,0 +1,46 @@
+# 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.
+
+# frozen_string_literal: true
+
+namespace :unified_release do
+  desc <<-DESC
+  Update Rubygems versions in version.rb and *.gemspec files
+
+  Example:
+
+      $ rake unified_release:bump[42.0.0]
+  DESC
+  task :bump, :version do |_, args|
+    abort('[!] Required argument [version] missing') unless args[:version]
+
+    regexp = Regexp.new(/VERSION = ("|'([0-9.]+(-SNAPSHOT)?)'|")/)
+    file = './lib/elastic/enterprise-search/version.rb'
+    content = File.read(file)
+
+    if (match = content.match(regexp))
+      old_version = match[2]
+      content.gsub!(old_version, args[:version])
+      puts "[#{old_version}] -> [#{args[:version]}] in #{file.gsub('./', '')}"
+      File.open(file, 'w') { |f| f.puts content }
+    else
+      abort "Couldn't find the version in #{file} "
+    end
+  rescue StandardError => e
+    abort "[!!!] #{e.class} : #{e.message}"
+  end
+end

data/spec/enterprise-search/client_spec.rb

@@ -18,7 +18,6 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require_relative './../webmock_requires'
 
 describe Elastic::EnterpriseSearch::Client do
   let(:host) { 'https://localhost:8080' }

data/spec/enterprise-search/request_spec.rb

@@ -112,6 +112,32 @@ describe Elastic::EnterpriseSearch::Client do
         expect(client.put('test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
       end
     end
+
+    context 'Test headers' do
+      context 'when using an empty header' do
+        let(:custom_header) { {} }
+        it 'builds the right request' do
+          stub_request(:get, "#{host}/test")
+            .with(body: { 'params' => 'test' })
+            .with(headers: headers)
+            .to_return(stub_response)
+
+          expect(client.request(:get, 'test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+        end
+      end
+
+      context 'when using invalid header' do
+        let(:custom_header) { 'Test' }
+        it 'builds the right request' do
+          stub_request(:get, "#{host}/test")
+            .with(body: { 'params' => 'test' })
+            .with(headers: headers)
+            .to_return(stub_response)
+
+          expect(client.request(:get, 'test', {}, { 'params' => 'test' }, custom_header).status).to eq(200)
+        end
+      end
+    end
   end
 
   context 'with ssl' do

data/spec/integration/app-search/api_key_spec.rb

@@ -0,0 +1,110 @@
+# 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.
+
+# frozen_string_literal: true
+
+require_relative "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'API Key' do
+    it 'creates and deletes an API key' do
+      name = 'created-key'
+      body = { name: name, type: 'private', read: true, write: true, access_all_engines: true }
+      response = client.create_api_key(body: body)
+
+      expect(response.status).to eq 200
+      expect(response.body.keys).to include('id')
+      expect(response.body.keys).to include('key')
+      expect(response.body).to include('name' => name)
+      expect(response.body).to include('type' => 'private')
+      expect(response.body).to include('read' => true)
+      expect(response.body).to include('write' => true)
+      expect(response.body).to include('access_all_engines' => true)
+
+      response = client.delete_api_key(api_key_name: name)
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq({ 'deleted' => true })
+    end
+
+    it 'gets the details of an API key' do
+      name = 'details-key'
+      body = { name: name, type: 'private', read: true, write: true, access_all_engines: true }
+      client.create_api_key(body: body)
+
+      response = client.api_key(api_key_name: name)
+
+      expect(response.status).to eq 200
+      expect(response.body.keys).to include('id')
+      expect(response.body.keys).to include('key')
+      expect(response.body).to include('name' => name)
+      expect(response.body).to include('type' => 'private')
+      expect(response.body).to include('read' => true)
+      expect(response.body).to include('write' => true)
+      expect(response.body).to include('access_all_engines' => true)
+      expect(response.body)
+
+      client.delete_api_key(api_key_name: name)
+    end
+
+    it 'updates an API key' do
+      key_name = 'updates-key'
+      engine_name = 'update-engine'
+      body = { name: key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      client.create_api_key(body: body)
+      client.create_engine(name: engine_name)
+
+      body = { name: key_name, type: 'private', read: true, write: true, engines: [engine_name] }
+      attempts = 0
+      begin
+        response = put_api_key(key_name, body)
+      # Since we're creating the API key and trying to update it right away, we sometimes get a 404
+      # if the transaction hasn't been confirmed. We give it a second and try again for a few times:
+      rescue Elasticsearch::Transport::Transport::Errors::NotFound
+        attempts += 1
+        if attempts > 5
+          Logger.new($stdout).log('Attempted 6 times')
+          raise e
+        end
+
+        sleep 1
+        response = put_api_key(key_name, body)
+      end
+      expect(response.status).to eq 200
+      expect(response.body['engines']).to eq [engine_name]
+      client.delete_engine(engine_name)
+    end
+
+    def put_api_key(key_name, body)
+      client.put_api_key(api_key_name: key_name, body: body)
+    end
+
+    it 'lists API keys' do
+      body = { name: 'api-key-1', type: 'private', read: true, write: true, access_all_engines: true }
+      client.create_api_key(body: body)
+      body = { name: 'api-key-2', type: 'private', read: true, write: true, access_all_engines: true }
+      client.create_api_key(body: body)
+
+      response = client.list_api_keys
+      expect(response.status).to eq 200
+      expect(response.body['results'].select { |r| ['api-key-1', 'api-key-2'].include? r['name'] }.count).to be 2
+      expect(response.body['results'].count).to be >= 2
+      client.delete_api_key(api_key_name: 'api-key-1')
+      client.delete_api_key(api_key_name: 'api-key-2')
+    end
+  end
+end

data/spec/integration/app-search/api_logs_spec.rb

@@ -0,0 +1,59 @@
+# 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.
+
+# frozen_string_literal: true
+
+require_relative "#{__dir__}/app_search_helper.rb"
+
+describe Elastic::EnterpriseSearch::AppSearch::Client do
+  context 'API logs' do
+    let(:engine_name) { 'videogames' }
+    let(:api_key_name) { 'logs-api-key' }
+
+    before do
+      client.create_engine(name: engine_name)
+      # Create API Key Client to log events:
+      body = { name: api_key_name, type: 'private', read: true, write: true, access_all_engines: true }
+      api_key = client.create_api_key(body: body).body['key']
+      private_key_client = Elastic::EnterpriseSearch::AppSearch::Client.new(
+        host: ENV['ELASTIC_ENTERPRISE_HOST'] || 'http://localhost:3002',
+        http_auth: api_key
+      )
+      id = private_key_client.index_documents(engine_name, documents: [{ title: 'Test Document' }]).body.first['id']
+      private_key_client.documents(engine_name, document_ids: [id])
+      private_key_client.delete_documents(engine_name, document_ids: [id])
+    end
+
+    after do
+      client.delete_engine(engine_name)
+      client.delete_api_key(api_key_name: api_key_name)
+    end
+
+    it 'returns api logs' do
+      response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
+      expect(response.status).to eq 200
+
+      attempts = 0
+      while response.body['results'].count < 1 && attempts < 20
+        sleep 1
+        attempts += 1
+        response = client.api_logs(engine_name, from_date: Date.today - 1, to_date: Date.today + 1)
+      end
+      expect(response.body['results'].count).to be >= 1
+    end
+  end
+end