# 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.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessage do
  @moduledoc """
  Represents a response message that can be returned by a conversational agent. Response messages are also used for output audio synthesis. The approach is as follows: * If at least one OutputAudioText response is present, then all OutputAudioText responses are linearly concatenated, and the result is used for output audio synthesis. * If the OutputAudioText responses are a mixture of text and SSML, then the concatenated result is treated as SSML; otherwise, the result is treated as either text or SSML as appropriate. The agent designer should ideally use either text or SSML consistently throughout the bot design. * Otherwise, all Text responses are linearly concatenated, and the result is used for output audio synthesis. This approach allows for more sophisticated user experience scenarios, where the text displayed to the user may differ from what is heard.

  ## Attributes

  *   `conversationSuccess` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess.t`, *default:* `nil`) - Indicates that the conversation succeeded.
  *   `endInteraction` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageEndInteraction.t`, *default:* `nil`) - Output only. A signal that indicates the interaction with the Dialogflow agent has ended. This message is generated by Dialogflow only when the conversation reaches `END_SESSION` page. It is not supposed to be defined by the user. It's guaranteed that there is at most one such message in each response.
  *   `liveAgentHandoff` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff.t`, *default:* `nil`) - Hands off conversation to a human agent.
  *   `mixedAudio` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageMixedAudio.t`, *default:* `nil`) - Output only. An audio response message composed of both the synthesized Dialogflow agent responses and responses defined via play_audio. This message is generated by Dialogflow only and not supposed to be defined by the user.
  *   `outputAudioText` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText.t`, *default:* `nil`) - A text or ssml response that is preferentially used for TTS output audio synthesis, as described in the comment on the ResponseMessage message.
  *   `payload` (*type:* `map()`, *default:* `nil`) - Returns a response containing a custom, platform-specific payload.
  *   `playAudio` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessagePlayAudio.t`, *default:* `nil`) - Signal that the client should play an audio clip hosted at a client-specific URI. Dialogflow uses this to construct mixed_audio. However, Dialogflow itself does not try to read or process the URI in any way.
  *   `text` (*type:* `GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageText.t`, *default:* `nil`) - Returns a text response.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :conversationSuccess =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess.t()
            | nil,
          :endInteraction =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageEndInteraction.t()
            | nil,
          :liveAgentHandoff =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff.t()
            | nil,
          :mixedAudio =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageMixedAudio.t()
            | nil,
          :outputAudioText =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText.t()
            | nil,
          :payload => map() | nil,
          :playAudio =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessagePlayAudio.t()
            | nil,
          :text =>
            GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageText.t() | nil
        }

  field(:conversationSuccess,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageConversationSuccess
  )

  field(:endInteraction,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageEndInteraction
  )

  field(:liveAgentHandoff,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageLiveAgentHandoff
  )

  field(:mixedAudio,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageMixedAudio
  )

  field(:outputAudioText,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageOutputAudioText
  )

  field(:payload, type: :map)

  field(:playAudio,
    as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessagePlayAudio
  )

  field(:text, as: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessageText)
end

defimpl Poison.Decoder,
  for: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessage do
  def decode(value, options) do
    GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessage.decode(value, options)
  end
end

defimpl Poison.Encoder,
  for: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowCxV3ResponseMessage do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end