# Copyright 2019 Google LLC
#
# Licensed 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.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.KnowledgeGraphSearch.V1.Api.Entities do
  @moduledoc """
  API calls for all endpoints tagged `Entities`.
  """

  alias GoogleApi.KnowledgeGraphSearch.V1.Connection
  alias GoogleApi.Gax.{Request, Response}

  @library_version Mix.Project.config() |> Keyword.get(:version, "")

  @doc """
  Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org

  ## Parameters

  *   `connection` (*type:* `GoogleApi.KnowledgeGraphSearch.V1.Connection.t`) - Connection to server
  *   `optional_params` (*type:* `keyword()`) - Optional parameters
      *   `:"$.xgafv"` (*type:* `String.t`) - V1 error format.
      *   `:access_token` (*type:* `String.t`) - OAuth access token.
      *   `:alt` (*type:* `String.t`) - Data format for response.
      *   `:callback` (*type:* `String.t`) - JSONP
      *   `:fields` (*type:* `String.t`) - Selector specifying which fields to include in a partial response.
      *   `:key` (*type:* `String.t`) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
      *   `:oauth_token` (*type:* `String.t`) - OAuth 2.0 token for the current user.
      *   `:prettyPrint` (*type:* `boolean()`) - Returns response with indentations and line breaks.
      *   `:quotaUser` (*type:* `String.t`) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
      *   `:uploadType` (*type:* `String.t`) - Legacy upload protocol for media (e.g. "media", "multipart").
      *   `:upload_protocol` (*type:* `String.t`) - Upload protocol for media (e.g. "raw", "multipart").
      *   `:ids` (*type:* `list(String.t)`) - The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B
      *   `:indent` (*type:* `boolean()`) - Enables indenting of json results.
      *   `:languages` (*type:* `list(String.t)`) - The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
      *   `:limit` (*type:* `integer()`) - Limits the number of entities to be returned.
      *   `:prefix` (*type:* `boolean()`) - Enables prefix match against names and aliases of entities
      *   `:query` (*type:* `String.t`) - The literal query string for search.
      *   `:types` (*type:* `list(String.t)`) - Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
  *   `opts` (*type:* `keyword()`) - Call options

  ## Returns

  *   `{:ok, %GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse{}}` on success
  *   `{:error, info}` on failure
  """
  @spec kgsearch_entities_search(Tesla.Env.client(), keyword(), keyword()) ::
          {:ok, GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse.t()}
          | {:ok, Tesla.Env.t()}
          | {:ok, list()}
          | {:error, any()}
  def kgsearch_entities_search(connection, optional_params \\ [], opts \\ []) do
    optional_params_config = %{
      :"$.xgafv" => :query,
      :access_token => :query,
      :alt => :query,
      :callback => :query,
      :fields => :query,
      :key => :query,
      :oauth_token => :query,
      :prettyPrint => :query,
      :quotaUser => :query,
      :uploadType => :query,
      :upload_protocol => :query,
      :ids => :query,
      :indent => :query,
      :languages => :query,
      :limit => :query,
      :prefix => :query,
      :query => :query,
      :types => :query
    }

    request =
      Request.new()
      |> Request.method(:get)
      |> Request.url("/v1/entities:search", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)
      |> Request.library_version(@library_version)

    connection
    |> Connection.execute(request)
    |> Response.decode(
      opts ++ [struct: %GoogleApi.KnowledgeGraphSearch.V1.Model.SearchResponse{}]
    )
  end
end
