elasticsearch_ex

defmodule ElasticsearchEx.Api.Document.Source do
  @moduledoc """
  Provides the APIs for document source operations.
  """

  import ElasticsearchEx.Guards

  alias ElasticsearchEx.Client

  ## Typespecs

  @type document_id :: ElasticsearchEx.document_id()

  @type index :: ElasticsearchEx.index()

  @type opts :: ElasticsearchEx.opts()

  ## Public functions

  @doc """
  Retrieves the specified JSON document from an index.

  ### Query parameters

  Refer to the official [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get-api-query-params)
  for a detailed list of the parameters.

  ### Examples

      iex> ElasticsearchEx.Api.Document.Source.get("0", "my-index-000001")
      {:ok,
       %{
         "@timestamp" => "2099-11-15T14:12:12",
         "http" => %{
           "request" => %{"method" => "get"},
           "response" => %{"bytes" => 1_070_000, "status_code" => 200},
           "version" => "1.1"
         },
         "message" => "GET /search HTTP/1.1 200 1070000",
         "source" => %{"ip" => "127.0.0.1"},
         "user" => %{"id" => "kimchy"}
       }}
  """
  @spec get(index(), document_id(), keyword()) :: ElasticsearchEx.response()
  def get(index, document_id, opts \\ [])
      when is_index(index) and is_document_id(document_id) and is_list(opts) do
    Client.get("/#{index}/_source/#{document_id}", nil, nil, opts)
  end

  @doc """
  Checks if the specified JSON document from an index exists.

  ### Query parameters

  Refer to the official [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#docs-get-api-query-params)
  for a detailed list of the parameters.

  ### Examples

      iex> ElasticsearchEx.Api.Document.Source.exists?("0", "my-index-000001")
      true
  """
  @spec exists?(index(), document_id(), keyword()) :: boolean()
  def exists?(index, document_id, opts \\ [])
      when is_index(index) and is_document_id(document_id) and is_list(opts) do
    Client.head("/#{index}/_source/#{document_id}", nil, opts) == :ok
  end
end