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

data/lib/elastic/workplace-search/api/external_identity.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
+        # 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 arguments [Hash] endpoint arguments
+        # @option user [String] The username in context (*Required*)
+        #
+        # @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
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_key}/external_identities/#{user}/",
+            arguments,
+            {}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/index_documents.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
+        # 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 arguments [Hash] endpoint arguments
+        # @option body - The request body
+        #
+        #
+        # @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
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_key}/documents/bulk_create/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/list_external_identities.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
+        # 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 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
+        #
+        # @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
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_key}/external_identities/",
+            arguments,
+            {}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/list_permissions.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
+        # 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 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
+        #
+        # @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
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_key}/permissions/",
+            arguments,
+            {}
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_external_identity.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
+        # 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 arguments [Hash] endpoint arguments
+        # @option user [String] The username in context (*Required*)
+        # @option body - The request body
+        #
+        #
+        # @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
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :put,
+            "api/ws/v1/sources/#{content_source_key}/external_identities/#{user}/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/put_user_permissions.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
+        # 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 arguments [Hash] endpoint arguments
+        # @option user [String] The username in context (*Required*)
+        # @option body - The request body
+        #
+        #
+        # @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
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :put,
+            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/remove_user_permissions.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
+        # 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 arguments [Hash] endpoint arguments
+        # @option user [String] The username in context (*Required*)
+        # @option body - The request body
+        #
+        #
+        # @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
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/remove/",
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# 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
+        # Search - search across available sources with various query tuning options
+        # Issue a Search Query
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-search-api.html
+        #
+        def search(arguments = {})
+          body = arguments.delete(:body) || {}
+
+          request(
+            :post,
+            'api/ws/v1/search/',
+            arguments,
+            body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/workplace-search/api/user_permissions.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
+        # Permissions - Lists all permissions for one user
+        # List permissions for a user
+        #
+        # @param content_source_key [String] Unique key 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*)
+        #
+        # @see https://www.elastic.co/guide/en/workplace-search/current/workplace-search-document-permissions-api.html#list-one
+        #
+        def user_permissions(content_source_key, arguments = {})
+          raise ArgumentError, "Required parameter 'content_source_key' missing" unless content_source_key
+          raise ArgumentError, "Required parameter 'user' missing" unless arguments[:user]
+
+          user = arguments[:user]
+
+          request(
+            :get,
+            "api/ws/v1/sources/#{content_source_key}/permissions/#{user}/",
+            arguments,
+            {}
+          )
+        end
+      end
+    end
+  end
+end