Class: Telnyx::Models::TextToSpeechListVoicesResponse::Voice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/text_to_speech_list_voices_response.rb,
sig/telnyx/models/text_to_speech_list_voices_response.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(gender: nil, hosted: nil, language: nil, name: nil, provider: nil, voice_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::TextToSpeechListVoicesResponse::Voice for more details.

A voice available for text-to-speech synthesis.

Parameters:

  • gender (String) (defaults to: nil) —

    Voice gender.

  • hosted (Boolean) (defaults to: nil) —

    Whether this voice runs on Telnyx-hosted infrastructure (true) or is provided

  • language (String) (defaults to: nil) —

    Language code.

  • name (String) (defaults to: nil) —

    Voice name.

  • provider (String) (defaults to: nil) —

    The TTS provider.

  • voice_id (String) (defaults to: nil) —

    Voice identifier.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 18

class Voice < Telnyx::Internal::Type::BaseModel
  # @!attribute gender
  #   Voice gender.
  #
  #   @return [String, nil]
  optional :gender, String

  # @!attribute hosted
  #   Whether this voice runs on Telnyx-hosted infrastructure (`true`) or is provided
  #   by a third-party vendor (`false`).
  #
  #   @return [Boolean, nil]
  optional :hosted, Telnyx::Internal::Type::Boolean

  # @!attribute language
  #   Language code.
  #
  #   @return [String, nil]
  optional :language, String

  # @!attribute name
  #   Voice name.
  #
  #   @return [String, nil]
  optional :name, String

  # @!attribute provider
  #   The TTS provider.
  #
  #   @return [String, nil]
  optional :provider, String

  # @!attribute voice_id
  #   Voice identifier.
  #
  #   @return [String, nil]
  optional :voice_id, String

  # @!method initialize(gender: nil, hosted: nil, language: nil, name: nil, provider: nil, voice_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::TextToSpeechListVoicesResponse::Voice} for more details.
  #
  #   A voice available for text-to-speech synthesis.
  #
  #   @param gender [String] Voice gender.
  #
  #   @param hosted [Boolean] Whether this voice runs on Telnyx-hosted infrastructure (`true`) or is provided
  #
  #   @param language [String] Language code.
  #
  #   @param name [String] Voice name.
  #
  #   @param provider [String] The TTS provider.
  #
  #   @param voice_id [String] Voice identifier.
end

Instance Attribute Details

#gender ⇒ String?

Voice gender.

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 23

optional :gender, String

#hosted ⇒ Boolean?

Whether this voice runs on Telnyx-hosted infrastructure (true) or is provided by a third-party vendor (false).

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


30
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 30

optional :hosted, Telnyx::Internal::Type::Boolean

#language ⇒ String?

Language code.

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 36

optional :language, String

#name ⇒ String?

Voice name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


42
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 42

optional :name, String

#provider ⇒ String?

The TTS provider.

Parameters:

  • (String)

Returns:

  • (String, nil) 


48
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 48

optional :provider, String

#voice_id ⇒ String?

Voice identifier.

Parameters:

  • (String)

Returns:

  • (String, nil) 


54
 
# File 'lib/telnyx/models/text_to_speech_list_voices_response.rb', line 54

optional :voice_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


65
 
# File 'sig/telnyx/models/text_to_speech_list_voices_response.rbs', line 65

def to_hash: -> {