Current section

Files

Jump to
google_api_translate lib google_api translate v2 api detections.ex
Raw

lib/google_api/translate/v2/api/detections.ex

# Copyright 2017 Google Inc.
#
# 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 swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.Translate.V2.Api.Detections do
@moduledoc """
API calls for all endpoints tagged `Detections`.
"""
alias GoogleApi.Translate.V2.Connection
import GoogleApi.Translate.V2.RequestBuilder
@doc """
Detects the language of text within a request.
## Parameters
- connection (GoogleApi.Translate.V2.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :callback (String.t): JSONP
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :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. Overrides userIp if both are provided.
- :pp (boolean()): Pretty-print response.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :bearer_token (String.t): OAuth bearer token.
- :body (DetectLanguageRequest):
## Returns
{:ok, %GoogleApi.Translate.V2.Model.DetectionsListResponse{}} on success
{:error, info} on failure
"""
@spec language_detections_detect(Tesla.Env.client(), keyword()) ::
{:ok, GoogleApi.Translate.V2.Model.DetectionsListResponse.t()} | {:error, Tesla.Env.t()}
def language_detections_detect(connection, opts \\ []) do
optional_params = %{
:upload_protocol => :query,
:prettyPrint => :query,
:fields => :query,
:uploadType => :query,
:callback => :query,
:"$.xgafv" => :query,
:alt => :query,
:access_token => :query,
:key => :query,
:quotaUser => :query,
:pp => :query,
:oauth_token => :query,
:bearer_token => :query,
:body => :body
}
%{}
|> method(:post)
|> url("/v2/detect")
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.Translate.V2.Model.DetectionsListResponse{}, dataWrapped: true)
end
@doc """
Detects the language of text within a request.
## Parameters
- connection (GoogleApi.Translate.V2.Connection): Connection to server
- q ([String.t]): The input text upon which to perform language detection. Repeat this parameter to perform language detection on multiple text inputs.
- opts (KeywordList): [optional] Optional parameters
- :upload_protocol (String.t): Upload protocol for media (e.g. \"raw\", \"multipart\").
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :uploadType (String.t): Legacy upload protocol for media (e.g. \"media\", \"multipart\").
- :callback (String.t): JSONP
- :$.xgafv (String.t): V1 error format.
- :alt (String.t): Data format for response.
- :access_token (String.t): OAuth access token.
- :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.
- :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. Overrides userIp if both are provided.
- :pp (boolean()): Pretty-print response.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :bearer_token (String.t): OAuth bearer token.
## Returns
{:ok, %GoogleApi.Translate.V2.Model.DetectionsListResponse{}} on success
{:error, info} on failure
"""
@spec language_detections_list(Tesla.Env.client(), list(String.t()), keyword()) ::
{:ok, GoogleApi.Translate.V2.Model.DetectionsListResponse.t()} | {:error, Tesla.Env.t()}
def language_detections_list(connection, q, opts \\ []) do
optional_params = %{
:upload_protocol => :query,
:prettyPrint => :query,
:fields => :query,
:uploadType => :query,
:callback => :query,
:"$.xgafv" => :query,
:alt => :query,
:access_token => :query,
:key => :query,
:quotaUser => :query,
:pp => :query,
:oauth_token => :query,
:bearer_token => :query
}
%{}
|> method(:get)
|> url("/v2/detect")
|> add_param(:query, :q, q)
|> add_optional_params(optional_params, opts)
|> Enum.into([])
|> (&Connection.request(connection, &1)).()
|> decode(%GoogleApi.Translate.V2.Model.DetectionsListResponse{}, dataWrapped: true)
end
end