# 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 class is auto generated by the elixir code generator program.
# Do not edit the class manually.

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

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

  @doc """
  Finds named entities (currently proper names and common nouns) in the text
  along with entity types, salience, mentions for each entity, and
  other properties.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.AnalyzeEntitiesRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.AnalyzeEntitiesResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_analyze_entities(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.AnalyzeEntitiesResponse.t()} | {:error, Tesla.Env.t()}
  def language_documents_analyze_entities(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:analyzeEntities", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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

  @doc """
  Finds entities, similar to AnalyzeEntities in the text and analyzes
  sentiment associated with each entity and its mentions.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.AnalyzeEntitySentimentRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.AnalyzeEntitySentimentResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_analyze_entity_sentiment(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.AnalyzeEntitySentimentResponse.t()}
          | {:error, Tesla.Env.t()}
  def language_documents_analyze_entity_sentiment(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:analyzeEntitySentiment", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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

  @doc """
  Analyzes the sentiment of the provided text.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.AnalyzeSentimentRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.AnalyzeSentimentResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_analyze_sentiment(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.AnalyzeSentimentResponse.t()}
          | {:error, Tesla.Env.t()}
  def language_documents_analyze_sentiment(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:analyzeSentiment", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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

  @doc """
  Analyzes the syntax of the text and provides sentence boundaries and
  tokenization along with part of speech tags, dependency trees, and other
  properties.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.AnalyzeSyntaxRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.AnalyzeSyntaxResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_analyze_syntax(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.AnalyzeSyntaxResponse.t()} | {:error, Tesla.Env.t()}
  def language_documents_analyze_syntax(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:analyzeSyntax", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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

  @doc """
  A convenience method that provides all the features that analyzeSentiment,
  analyzeEntities, and analyzeSyntax provide in one call.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.AnnotateTextRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.AnnotateTextResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_annotate_text(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.AnnotateTextResponse.t()} | {:error, Tesla.Env.t()}
  def language_documents_annotate_text(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:annotateText", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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

  @doc """
  Classifies a document into categories.

  ## Parameters

  - connection (GoogleApi.Language.V1.Connection): Connection to server
  - optional_params (keyword()): [optional] Optional parameters
    - :$.xgafv (String.t): V1 error format.
    - :access_token (String.t): OAuth access token.
    - :alt (String.t): Data format for response.
    - :callback (String.t): JSONP
    - :fields (String.t): Selector specifying which fields to include in a partial response.
    - :key (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 (String.t): OAuth 2.0 token for the current user.
    - :prettyPrint (boolean()): Returns response with indentations and line breaks.
    - :quotaUser (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 (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    - :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    - :body (GoogleApi.Language.V1.Model.ClassifyTextRequest.t): 

  ## Returns

  {:ok, %GoogleApi.Language.V1.Model.ClassifyTextResponse{}} on success
  {:error, info} on failure
  """
  @spec language_documents_classify_text(Tesla.Env.client(), keyword()) ::
          {:ok, GoogleApi.Language.V1.Model.ClassifyTextResponse.t()} | {:error, Tesla.Env.t()}
  def language_documents_classify_text(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,
      :body => :body
    }

    request =
      Request.new()
      |> Request.method(:post)
      |> Request.url("/v1/documents:classifyText", %{})
      |> Request.add_optional_params(optional_params_config, optional_params)

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