# Copyright 2020 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.

require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'

module Google
  module Apis
    module TexttospeechV1
      
      # Used for advanced voice options.
      class AdvancedVoiceOptions
        include Google::Apis::Core::Hashable
      
        # Only for Jounrney voices. If false, the synthesis will be context aware and
        # have higher latency.
        # Corresponds to the JSON property `lowLatencyJourneySynthesis`
        # @return [Boolean]
        attr_accessor :low_latency_journey_synthesis
        alias_method :low_latency_journey_synthesis?, :low_latency_journey_synthesis
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @low_latency_journey_synthesis = args[:low_latency_journey_synthesis] if args.key?(:low_latency_journey_synthesis)
        end
      end
      
      # Description of audio data to be synthesized.
      class AudioConfig
        include Google::Apis::Core::Hashable
      
        # Required. The format of the audio byte stream.
        # Corresponds to the JSON property `audioEncoding`
        # @return [String]
        attr_accessor :audio_encoding
      
        # Optional. Input only. An identifier which selects 'audio effects' profiles
        # that are applied on (post synthesized) text to speech. Effects are applied on
        # top of each other in the order they are given. See [audio profiles](https://
        # cloud.google.com/text-to-speech/docs/audio-profiles) for current supported
        # profile ids.
        # Corresponds to the JSON property `effectsProfileId`
        # @return [Array<String>]
        attr_accessor :effects_profile_id
      
        # Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means
        # increase 20 semitones from the original pitch. -20 means decrease 20 semitones
        # from the original pitch.
        # Corresponds to the JSON property `pitch`
        # @return [Float]
        attr_accessor :pitch
      
        # Optional. The synthesis sample rate (in hertz) for this audio. When this is
        # specified in SynthesizeSpeechRequest, if this is different from the voice's
        # natural sample rate, then the synthesizer will honor this request by
        # converting to the desired sample rate (which might result in worse audio
        # quality), unless the specified sample rate is not supported for the encoding
        # chosen, in which case it will fail the request and return google.rpc.Code.
        # INVALID_ARGUMENT.
        # Corresponds to the JSON property `sampleRateHertz`
        # @return [Fixnum]
        attr_accessor :sample_rate_hertz
      
        # Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is
        # the normal native speed supported by the specific voice. 2.0 is twice as fast,
        # and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any
        # other values < 0.25 or > 4.0 will return an error.
        # Corresponds to the JSON property `speakingRate`
        # @return [Float]
        attr_accessor :speaking_rate
      
        # Optional. Input only. Volume gain (in dB) of the normal native volume
        # supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set
        # to a value of 0.0 (dB), will play at normal native signal amplitude. A value
        # of -6.0 (dB) will play at approximately half the amplitude of the normal
        # native signal amplitude. A value of +6.0 (dB) will play at approximately twice
        # the amplitude of the normal native signal amplitude. Strongly recommend not to
        # exceed +10 (dB) as there's usually no effective increase in loudness for any
        # value greater than that.
        # Corresponds to the JSON property `volumeGainDb`
        # @return [Float]
        attr_accessor :volume_gain_db
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @audio_encoding = args[:audio_encoding] if args.key?(:audio_encoding)
          @effects_profile_id = args[:effects_profile_id] if args.key?(:effects_profile_id)
          @pitch = args[:pitch] if args.key?(:pitch)
          @sample_rate_hertz = args[:sample_rate_hertz] if args.key?(:sample_rate_hertz)
          @speaking_rate = args[:speaking_rate] if args.key?(:speaking_rate)
          @volume_gain_db = args[:volume_gain_db] if args.key?(:volume_gain_db)
        end
      end
      
      # The request message for Operations.CancelOperation.
      class CancelOperationRequest
        include Google::Apis::Core::Hashable
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
        end
      end
      
      # Pronunciation customization for a phrase.
      class CustomPronunciationParams
        include Google::Apis::Core::Hashable
      
        # The phonetic encoding of the phrase.
        # Corresponds to the JSON property `phoneticEncoding`
        # @return [String]
        attr_accessor :phonetic_encoding
      
        # The phrase to which the customization will be applied. The phrase can be
        # multiple words (in the case of proper nouns etc), but should not span to a
        # whole sentence.
        # Corresponds to the JSON property `phrase`
        # @return [String]
        attr_accessor :phrase
      
        # The pronunciation of the phrase. This must be in the phonetic encoding
        # specified above.
        # Corresponds to the JSON property `pronunciation`
        # @return [String]
        attr_accessor :pronunciation
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @phonetic_encoding = args[:phonetic_encoding] if args.key?(:phonetic_encoding)
          @phrase = args[:phrase] if args.key?(:phrase)
          @pronunciation = args[:pronunciation] if args.key?(:pronunciation)
        end
      end
      
      # A collection of pronunciation customizations.
      class CustomPronunciations
        include Google::Apis::Core::Hashable
      
        # The pronunciation customizations to be applied.
        # Corresponds to the JSON property `pronunciations`
        # @return [Array<Google::Apis::TexttospeechV1::CustomPronunciationParams>]
        attr_accessor :pronunciations
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @pronunciations = args[:pronunciations] if args.key?(:pronunciations)
        end
      end
      
      # Description of the custom voice to be synthesized.
      class CustomVoiceParams
        include Google::Apis::Core::Hashable
      
        # Required. The name of the AutoML model that synthesizes the custom voice.
        # Corresponds to the JSON property `model`
        # @return [String]
        attr_accessor :model
      
        # Optional. Deprecated. The usage of the synthesized audio to be reported.
        # Corresponds to the JSON property `reportedUsage`
        # @return [String]
        attr_accessor :reported_usage
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @model = args[:model] if args.key?(:model)
          @reported_usage = args[:reported_usage] if args.key?(:reported_usage)
        end
      end
      
      # A generic empty message that you can re-use to avoid defining duplicated empty
      # messages in your APIs. A typical example is to use it as the request or the
      # response type of an API method. For instance: service Foo ` rpc Bar(google.
      # protobuf.Empty) returns (google.protobuf.Empty); `
      class Empty
        include Google::Apis::Core::Hashable
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
        end
      end
      
      # Metadata for response returned by the `SynthesizeLongAudio` method.
      class GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata
        include Google::Apis::Core::Hashable
      
        # Deprecated. Do not use.
        # Corresponds to the JSON property `lastUpdateTime`
        # @return [String]
        attr_accessor :last_update_time
      
        # The progress of the most recent processing update in percentage, ie. 70.0%.
        # Corresponds to the JSON property `progressPercentage`
        # @return [Float]
        attr_accessor :progress_percentage
      
        # Time when the request was received.
        # Corresponds to the JSON property `startTime`
        # @return [String]
        attr_accessor :start_time
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
          @progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
          @start_time = args[:start_time] if args.key?(:start_time)
        end
      end
      
      # The response message for Operations.ListOperations.
      class ListOperationsResponse
        include Google::Apis::Core::Hashable
      
        # The standard List next-page token.
        # Corresponds to the JSON property `nextPageToken`
        # @return [String]
        attr_accessor :next_page_token
      
        # A list of operations that matches the specified filter in the request.
        # Corresponds to the JSON property `operations`
        # @return [Array<Google::Apis::TexttospeechV1::Operation>]
        attr_accessor :operations
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
          @operations = args[:operations] if args.key?(:operations)
        end
      end
      
      # The message returned to the client by the `ListVoices` method.
      class ListVoicesResponse
        include Google::Apis::Core::Hashable
      
        # The list of voices.
        # Corresponds to the JSON property `voices`
        # @return [Array<Google::Apis::TexttospeechV1::Voice>]
        attr_accessor :voices
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @voices = args[:voices] if args.key?(:voices)
        end
      end
      
      # This resource represents a long-running operation that is the result of a
      # network API call.
      class Operation
        include Google::Apis::Core::Hashable
      
        # If the value is `false`, it means the operation is still in progress. If `true`
        # , the operation is completed, and either `error` or `response` is available.
        # Corresponds to the JSON property `done`
        # @return [Boolean]
        attr_accessor :done
        alias_method :done?, :done
      
        # The `Status` type defines a logical error model that is suitable for different
        # programming environments, including REST APIs and RPC APIs. It is used by [
        # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
        # data: error code, error message, and error details. You can find out more
        # about this error model and how to work with it in the [API Design Guide](https:
        # //cloud.google.com/apis/design/errors).
        # Corresponds to the JSON property `error`
        # @return [Google::Apis::TexttospeechV1::Status]
        attr_accessor :error
      
        # Service-specific metadata associated with the operation. It typically contains
        # progress information and common metadata such as create time. Some services
        # might not provide such metadata. Any method that returns a long-running
        # operation should document the metadata type, if any.
        # Corresponds to the JSON property `metadata`
        # @return [Hash<String,Object>]
        attr_accessor :metadata
      
        # The server-assigned name, which is only unique within the same service that
        # originally returns it. If you use the default HTTP mapping, the `name` should
        # be a resource name ending with `operations/`unique_id``.
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        # The normal, successful response of the operation. If the original method
        # returns no data on success, such as `Delete`, the response is `google.protobuf.
        # Empty`. If the original method is standard `Get`/`Create`/`Update`, the
        # response should be the resource. For other methods, the response should have
        # the type `XxxResponse`, where `Xxx` is the original method name. For example,
        # if the original method name is `TakeSnapshot()`, the inferred response type is
        # `TakeSnapshotResponse`.
        # Corresponds to the JSON property `response`
        # @return [Hash<String,Object>]
        attr_accessor :response
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @done = args[:done] if args.key?(:done)
          @error = args[:error] if args.key?(:error)
          @metadata = args[:metadata] if args.key?(:metadata)
          @name = args[:name] if args.key?(:name)
          @response = args[:response] if args.key?(:response)
        end
      end
      
      # The `Status` type defines a logical error model that is suitable for different
      # programming environments, including REST APIs and RPC APIs. It is used by [
      # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
      # data: error code, error message, and error details. You can find out more
      # about this error model and how to work with it in the [API Design Guide](https:
      # //cloud.google.com/apis/design/errors).
      class Status
        include Google::Apis::Core::Hashable
      
        # The status code, which should be an enum value of google.rpc.Code.
        # Corresponds to the JSON property `code`
        # @return [Fixnum]
        attr_accessor :code
      
        # A list of messages that carry the error details. There is a common set of
        # message types for APIs to use.
        # Corresponds to the JSON property `details`
        # @return [Array<Hash<String,Object>>]
        attr_accessor :details
      
        # A developer-facing error message, which should be in English. Any user-facing
        # error message should be localized and sent in the google.rpc.Status.details
        # field, or localized by the client.
        # Corresponds to the JSON property `message`
        # @return [String]
        attr_accessor :message
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @code = args[:code] if args.key?(:code)
          @details = args[:details] if args.key?(:details)
          @message = args[:message] if args.key?(:message)
        end
      end
      
      # Contains text input to be synthesized. Either `text` or `ssml` must be
      # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT.
      # The input size is limited to 5000 bytes.
      class SynthesisInput
        include Google::Apis::Core::Hashable
      
        # A collection of pronunciation customizations.
        # Corresponds to the JSON property `customPronunciations`
        # @return [Google::Apis::TexttospeechV1::CustomPronunciations]
        attr_accessor :custom_pronunciations
      
        # The SSML document to be synthesized. The SSML document must be valid and well-
        # formed. Otherwise the RPC will fail and return google.rpc.Code.
        # INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/
        # text-to-speech/docs/ssml).
        # Corresponds to the JSON property `ssml`
        # @return [String]
        attr_accessor :ssml
      
        # The raw text to be synthesized.
        # Corresponds to the JSON property `text`
        # @return [String]
        attr_accessor :text
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @custom_pronunciations = args[:custom_pronunciations] if args.key?(:custom_pronunciations)
          @ssml = args[:ssml] if args.key?(:ssml)
          @text = args[:text] if args.key?(:text)
        end
      end
      
      # Metadata for response returned by the `SynthesizeLongAudio` method.
      class SynthesizeLongAudioMetadata
        include Google::Apis::Core::Hashable
      
        # Deprecated. Do not use.
        # Corresponds to the JSON property `lastUpdateTime`
        # @return [String]
        attr_accessor :last_update_time
      
        # The progress of the most recent processing update in percentage, ie. 70.0%.
        # Corresponds to the JSON property `progressPercentage`
        # @return [Float]
        attr_accessor :progress_percentage
      
        # Time when the request was received.
        # Corresponds to the JSON property `startTime`
        # @return [String]
        attr_accessor :start_time
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @last_update_time = args[:last_update_time] if args.key?(:last_update_time)
          @progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
          @start_time = args[:start_time] if args.key?(:start_time)
        end
      end
      
      # The top-level message sent by the client for the `SynthesizeLongAudio` method.
      class SynthesizeLongAudioRequest
        include Google::Apis::Core::Hashable
      
        # Description of audio data to be synthesized.
        # Corresponds to the JSON property `audioConfig`
        # @return [Google::Apis::TexttospeechV1::AudioConfig]
        attr_accessor :audio_config
      
        # Contains text input to be synthesized. Either `text` or `ssml` must be
        # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT.
        # The input size is limited to 5000 bytes.
        # Corresponds to the JSON property `input`
        # @return [Google::Apis::TexttospeechV1::SynthesisInput]
        attr_accessor :input
      
        # Required. Specifies a Cloud Storage URI for the synthesis results. Must be
        # specified in the format: `gs://bucket_name/object_name`, and the bucket must
        # already exist.
        # Corresponds to the JSON property `outputGcsUri`
        # @return [String]
        attr_accessor :output_gcs_uri
      
        # Description of which voice to use for a synthesis request.
        # Corresponds to the JSON property `voice`
        # @return [Google::Apis::TexttospeechV1::VoiceSelectionParams]
        attr_accessor :voice
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @audio_config = args[:audio_config] if args.key?(:audio_config)
          @input = args[:input] if args.key?(:input)
          @output_gcs_uri = args[:output_gcs_uri] if args.key?(:output_gcs_uri)
          @voice = args[:voice] if args.key?(:voice)
        end
      end
      
      # The top-level message sent by the client for the `SynthesizeSpeech` method.
      class SynthesizeSpeechRequest
        include Google::Apis::Core::Hashable
      
        # Used for advanced voice options.
        # Corresponds to the JSON property `advancedVoiceOptions`
        # @return [Google::Apis::TexttospeechV1::AdvancedVoiceOptions]
        attr_accessor :advanced_voice_options
      
        # Description of audio data to be synthesized.
        # Corresponds to the JSON property `audioConfig`
        # @return [Google::Apis::TexttospeechV1::AudioConfig]
        attr_accessor :audio_config
      
        # Contains text input to be synthesized. Either `text` or `ssml` must be
        # supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT.
        # The input size is limited to 5000 bytes.
        # Corresponds to the JSON property `input`
        # @return [Google::Apis::TexttospeechV1::SynthesisInput]
        attr_accessor :input
      
        # Description of which voice to use for a synthesis request.
        # Corresponds to the JSON property `voice`
        # @return [Google::Apis::TexttospeechV1::VoiceSelectionParams]
        attr_accessor :voice
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @advanced_voice_options = args[:advanced_voice_options] if args.key?(:advanced_voice_options)
          @audio_config = args[:audio_config] if args.key?(:audio_config)
          @input = args[:input] if args.key?(:input)
          @voice = args[:voice] if args.key?(:voice)
        end
      end
      
      # The message returned to the client by the `SynthesizeSpeech` method.
      class SynthesizeSpeechResponse
        include Google::Apis::Core::Hashable
      
        # The audio data bytes encoded as specified in the request, including the header
        # for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For
        # LINEAR16 audio, we include the WAV header. Note: as with all bytes fields,
        # protobuffers use a pure binary representation, whereas JSON representations
        # use base64.
        # Corresponds to the JSON property `audioContent`
        # NOTE: Values are automatically base64 encoded/decoded in the client library.
        # @return [String]
        attr_accessor :audio_content
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @audio_content = args[:audio_content] if args.key?(:audio_content)
        end
      end
      
      # Description of a voice supported by the TTS service.
      class Voice
        include Google::Apis::Core::Hashable
      
        # The languages that this voice supports, expressed as [BCP-47](https://www.rfc-
        # editor.org/rfc/bcp/bcp47.txt) language tags (e.g. "en-US", "es-419", "cmn-tw").
        # Corresponds to the JSON property `languageCodes`
        # @return [Array<String>]
        attr_accessor :language_codes
      
        # The name of this voice. Each distinct voice has a unique name.
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        # The natural sample rate (in hertz) for this voice.
        # Corresponds to the JSON property `naturalSampleRateHertz`
        # @return [Fixnum]
        attr_accessor :natural_sample_rate_hertz
      
        # The gender of this voice.
        # Corresponds to the JSON property `ssmlGender`
        # @return [String]
        attr_accessor :ssml_gender
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @language_codes = args[:language_codes] if args.key?(:language_codes)
          @name = args[:name] if args.key?(:name)
          @natural_sample_rate_hertz = args[:natural_sample_rate_hertz] if args.key?(:natural_sample_rate_hertz)
          @ssml_gender = args[:ssml_gender] if args.key?(:ssml_gender)
        end
      end
      
      # Description of which voice to use for a synthesis request.
      class VoiceSelectionParams
        include Google::Apis::Core::Hashable
      
        # Description of the custom voice to be synthesized.
        # Corresponds to the JSON property `customVoice`
        # @return [Google::Apis::TexttospeechV1::CustomVoiceParams]
        attr_accessor :custom_voice
      
        # Required. The language (and potentially also the region) of the voice
        # expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language
        # tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn"
        # rather than "cmn-Hant-cn"), because the script will be inferred from the input
        # provided in the SynthesisInput. The TTS service will use this parameter to
        # help choose an appropriate voice. Note that the TTS service may choose a voice
        # with a slightly different language code than the one selected; it may
        # substitute a different region (e.g. using en-US rather than en-CA if there isn'
        # t a Canadian voice available), or even a different language, e.g. using "nb" (
        # Norwegian Bokmal) instead of "no" (Norwegian)".
        # Corresponds to the JSON property `languageCode`
        # @return [String]
        attr_accessor :language_code
      
        # The name of the voice. If both the name and the gender are not set, the
        # service will choose a voice based on the other parameters such as
        # language_code.
        # Corresponds to the JSON property `name`
        # @return [String]
        attr_accessor :name
      
        # The preferred gender of the voice. If not set, the service will choose a voice
        # based on the other parameters such as language_code and name. Note that this
        # is only a preference, not requirement; if a voice of the appropriate gender is
        # not available, the synthesizer should substitute a voice with a different
        # gender rather than failing the request.
        # Corresponds to the JSON property `ssmlGender`
        # @return [String]
        attr_accessor :ssml_gender
      
        def initialize(**args)
           update!(**args)
        end
      
        # Update properties of this object
        def update!(**args)
          @custom_voice = args[:custom_voice] if args.key?(:custom_voice)
          @language_code = args[:language_code] if args.key?(:language_code)
          @name = args[:name] if args.key?(:name)
          @ssml_gender = args[:ssml_gender] if args.key?(:ssml_gender)
        end
      end
    end
  end
end