telnyx 5.38.1 → 5.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/azure_voice_settings.rb +99 -0
  5. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +9 -3
  6. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +30 -15
  7. data/lib/telnyx/models/calls/action_speak_params.rb +30 -15
  8. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +9 -3
  9. data/lib/telnyx/models/conferences/action_speak_params.rb +30 -15
  10. data/lib/telnyx/models/resemble_voice_settings.rb +97 -0
  11. data/lib/telnyx/models/rime_voice_settings.rb +36 -0
  12. data/lib/telnyx/models.rb +6 -0
  13. data/lib/telnyx/resources/calls/actions.rb +4 -4
  14. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  15. data/lib/telnyx/version.rb +1 -1
  16. data/lib/telnyx.rb +3 -0
  17. data/rbi/telnyx/models/azure_voice_settings.rbi +161 -0
  18. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +20 -5
  19. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +62 -29
  20. data/rbi/telnyx/models/calls/action_speak_params.rbi +62 -29
  21. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +20 -5
  22. data/rbi/telnyx/models/conferences/action_speak_params.rbi +62 -29
  23. data/rbi/telnyx/models/resemble_voice_settings.rbi +204 -0
  24. data/rbi/telnyx/models/rime_voice_settings.rbi +67 -0
  25. data/rbi/telnyx/models.rbi +6 -0
  26. data/rbi/telnyx/resources/calls/actions.rbi +58 -28
  27. data/rbi/telnyx/resources/conferences/actions.rbi +25 -13
  28. data/sig/telnyx/models/azure_voice_settings.rbs +91 -0
  29. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +3 -0
  30. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +3 -0
  31. data/sig/telnyx/models/calls/action_speak_params.rbs +3 -0
  32. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +3 -0
  33. data/sig/telnyx/models/conferences/action_speak_params.rbs +3 -0
  34. data/sig/telnyx/models/resemble_voice_settings.rbs +97 -0
  35. data/sig/telnyx/models/rime_voice_settings.rbs +34 -0
  36. data/sig/telnyx/models.rbs +6 -0
  37. metadata +11 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 18f02735965f6afbffaec63905bdc5d5b951c5cac8a5eb4ec550c1777933d485
4
- data.tar.gz: 23493c86e9635ca193f9b0b6aac0b97c5003907bcc559108bdc0f544529516e7
3
+ metadata.gz: bbb818b04590729b70d63c3dcfafbfd5e09e13dff11e6208faf748a3c5c98e37
4
+ data.tar.gz: 503565a1f0999ddbfdb76e1cde900f7007b38510b77c7cff689fa3a47cb806f9
5
5
  SHA512:
6
- metadata.gz: 7d456f5bc0c2a1cbc4a15cb6b434234894539c6e3327d15b35159decc0797d752b4381147521714d9031dd4b2941618fc03c7b079eb8ad4270b05381747c5721
7
- data.tar.gz: 9a85318ee403c82111ced92fdcc0dee90a4ee266c9b657b52ed7b7270405408d06b5f74438861bedd29c47c76d0c099efb277434c02ebeb369ba52ad8d77fc73
6
+ metadata.gz: 4108291f09de6c4ca02235381f2a4f78420be13976859bc82cb23edeea21b2e53cc373e0b0aecb7c647009f05026f74fdac6e1189c4c5176e82581a72ab0064e
7
+ data.tar.gz: cc6b8aaa16504df85988bf458bd1b611f42105d8fbf1289083ddd7532d54e014476b6b7414ba990f86de22227aa4b738b8a900339b0c13fe5fc5567dc9b546af
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.40.0 (2026-02-25)
4
+
5
+ Full Changelog: [v5.39.0...v5.40.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.39.0...v5.40.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** manual updates ([eccdf50](https://github.com/team-telnyx/telnyx-ruby/commit/eccdf50b6292e000beac27eb86803fd799785a91))
10
+
11
+ ## 5.39.0 (2026-02-25)
12
+
13
+ Full Changelog: [v5.38.1...v5.39.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.38.1...v5.39.0)
14
+
15
+ ### Features
16
+
17
+ * Add missing TTS voice settings schemas and update voice descriptions ([eb43986](https://github.com/team-telnyx/telnyx-ruby/commit/eb439865bd26c00206ecc63ded05f811a520d0b4))
18
+
3
19
  ## 5.38.1 (2026-02-24)
4
20
 
5
21
  Full Changelog: [v5.38.0...v5.38.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.38.0...v5.38.1)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.38.1"
27
+ gem "telnyx", "~> 5.40.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -0,0 +1,99 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class AzureVoiceSettings < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute type
7
+ # Voice settings provider type
8
+ #
9
+ # @return [Symbol, Telnyx::Models::AzureVoiceSettings::Type]
10
+ required :type, enum: -> { Telnyx::AzureVoiceSettings::Type }
11
+
12
+ # @!attribute api_key_ref
13
+ # The `identifier` for an integration secret that refers to your Azure Speech API
14
+ # key.
15
+ #
16
+ # @return [String, nil]
17
+ optional :api_key_ref, String
18
+
19
+ # @!attribute deployment_id
20
+ # The deployment ID for a custom Azure neural voice.
21
+ #
22
+ # @return [String, nil]
23
+ optional :deployment_id, String
24
+
25
+ # @!attribute effect
26
+ # Audio effect to apply.
27
+ #
28
+ # @return [Symbol, Telnyx::Models::AzureVoiceSettings::Effect, nil]
29
+ optional :effect, enum: -> { Telnyx::AzureVoiceSettings::Effect }
30
+
31
+ # @!attribute gender
32
+ # Voice gender filter.
33
+ #
34
+ # @return [Symbol, Telnyx::Models::AzureVoiceSettings::Gender, nil]
35
+ optional :gender, enum: -> { Telnyx::AzureVoiceSettings::Gender }
36
+
37
+ # @!attribute region
38
+ # The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
39
+ # when using a custom API key.
40
+ #
41
+ # @return [String, nil]
42
+ optional :region, String
43
+
44
+ # @!method initialize(type:, api_key_ref: nil, deployment_id: nil, effect: nil, gender: nil, region: nil)
45
+ # Some parameter documentations has been truncated, see
46
+ # {Telnyx::Models::AzureVoiceSettings} for more details.
47
+ #
48
+ # @param type [Symbol, Telnyx::Models::AzureVoiceSettings::Type] Voice settings provider type
49
+ #
50
+ # @param api_key_ref [String] The `identifier` for an integration secret that refers to your Azure Speech API
51
+ #
52
+ # @param deployment_id [String] The deployment ID for a custom Azure neural voice.
53
+ #
54
+ # @param effect [Symbol, Telnyx::Models::AzureVoiceSettings::Effect] Audio effect to apply.
55
+ #
56
+ # @param gender [Symbol, Telnyx::Models::AzureVoiceSettings::Gender] Voice gender filter.
57
+ #
58
+ # @param region [String] The Azure region for the Speech service (e.g., `eastus`, `westeurope`). Required
59
+
60
+ # Voice settings provider type
61
+ #
62
+ # @see Telnyx::Models::AzureVoiceSettings#type
63
+ module Type
64
+ extend Telnyx::Internal::Type::Enum
65
+
66
+ AZURE = :azure
67
+
68
+ # @!method self.values
69
+ # @return [Array<Symbol>]
70
+ end
71
+
72
+ # Audio effect to apply.
73
+ #
74
+ # @see Telnyx::Models::AzureVoiceSettings#effect
75
+ module Effect
76
+ extend Telnyx::Internal::Type::Enum
77
+
78
+ EQ_CAR = :eq_car
79
+ EQ_TELECOMHP8K = :eq_telecomhp8k
80
+
81
+ # @!method self.values
82
+ # @return [Array<Symbol>]
83
+ end
84
+
85
+ # Voice gender filter.
86
+ #
87
+ # @see Telnyx::Models::AzureVoiceSettings#gender
88
+ module Gender
89
+ extend Telnyx::Internal::Type::Enum
90
+
91
+ MALE = :Male
92
+ FEMALE = :Female
93
+
94
+ # @!method self.values
95
+ # @return [Array<Symbol>]
96
+ end
97
+ end
98
+ end
99
+ end
@@ -135,7 +135,7 @@ module Telnyx
135
135
  # @!attribute voice_settings
136
136
  # The settings associated with the voice selected
137
137
  #
138
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, nil]
138
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
139
139
  optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }
140
140
 
141
141
  # @!method initialize(parameters:, assistant: nil, client_state: nil, command_id: nil, gather_ended_speech: nil, greeting: nil, interruption_settings: nil, language: nil, message_history: nil, send_message_history_updates: nil, send_partial_results: nil, transcription: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {})
@@ -170,7 +170,7 @@ module Telnyx
170
170
  #
171
171
  # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
172
172
  #
173
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings] The settings associated with the voice selected
173
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
174
174
  #
175
175
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
176
176
 
@@ -218,8 +218,14 @@ module Telnyx
218
218
 
219
219
  variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
220
220
 
221
+ variant :azure, -> { Telnyx::AzureVoiceSettings }
222
+
223
+ variant :rime, -> { Telnyx::RimeVoiceSettings }
224
+
225
+ variant :resemble, -> { Telnyx::ResembleVoiceSettings }
226
+
221
227
  # @!method self.variants
222
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings)]
228
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings)]
223
229
  end
224
230
  end
225
231
  end
@@ -27,25 +27,34 @@ module Telnyx
27
27
  # the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
28
28
  # [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
29
29
  # for compatibility.
30
- # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
31
- # Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
32
- # Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
33
- # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
30
+ # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
31
+ # `Azure.en-US-BrianMultilingualNeural`,
32
+ # `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
33
+ # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery). Use
34
+ # `voice_settings` to configure custom deployments, regions, or API keys.
34
35
  # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
35
36
  # `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part
36
37
  # is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an
37
38
  # integration identifier secret in
38
- # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. Check
39
+ # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. See
40
+ # [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
41
+ # for details. Check
39
42
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
40
- # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
43
+ # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
44
+ # Use `voice_settings` to configure voice_speed and other synthesis parameters.
41
45
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
42
46
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
43
- # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Optional parameters:
44
- # `speed` (float, default 1.0), `vol` (float, default 1.0), `pitch` (integer,
45
- # default 0).
46
- # - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
47
- # `Resemble.Pro.my_voice`). Supported models: `Pro` (multilingual) and `Turbo`
48
- # (English only).
47
+ # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
48
+ # to configure speed, volume, pitch, and language_boost.
49
+ # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
50
+ # Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
51
+ # voice_speed.
52
+ # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
53
+ # `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
54
+ # `voice_settings` to configure precision, sample_rate, and format.
55
+ #
56
+ # For service_level basic, you may define the gender of the speaker (male or
57
+ # female).
49
58
  #
50
59
  # @return [String]
51
60
  required :voice, String
@@ -142,7 +151,7 @@ module Telnyx
142
151
  # @!attribute voice_settings
143
152
  # The settings associated with the voice selected
144
153
  #
145
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, nil]
154
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
146
155
  optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings }
147
156
 
148
157
  # @!method initialize(payload:, voice:, client_state: nil, command_id: nil, inter_digit_timeout_millis: nil, invalid_payload: nil, language: nil, maximum_digits: nil, maximum_tries: nil, minimum_digits: nil, payload_type: nil, service_level: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, voice_settings: nil, request_options: {})
@@ -180,7 +189,7 @@ module Telnyx
180
189
  #
181
190
  # @param valid_digits [String] A list of all digits accepted as valid.
182
191
  #
183
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings] The settings associated with the voice selected
192
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
184
193
  #
185
194
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
186
195
 
@@ -261,8 +270,14 @@ module Telnyx
261
270
 
262
271
  variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
263
272
 
273
+ variant :azure, -> { Telnyx::AzureVoiceSettings }
274
+
275
+ variant :rime, -> { Telnyx::RimeVoiceSettings }
276
+
277
+ variant :resemble, -> { Telnyx::ResembleVoiceSettings }
278
+
264
279
  # @!method self.variants
265
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings)]
280
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings)]
266
281
  end
267
282
  end
268
283
  end
@@ -27,25 +27,34 @@ module Telnyx
27
27
  # the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
28
28
  # [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
29
29
  # for compatibility.
30
- # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
31
- # Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
32
- # Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
33
- # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
30
+ # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
31
+ # `Azure.en-US-BrianMultilingualNeural`,
32
+ # `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
33
+ # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery). Use
34
+ # `voice_settings` to configure custom deployments, regions, or API keys.
34
35
  # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
35
36
  # `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part
36
37
  # is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an
37
38
  # integration identifier secret in
38
- # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. Check
39
+ # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. See
40
+ # [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
41
+ # for details. Check
39
42
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
40
- # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
43
+ # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
44
+ # Use `voice_settings` to configure voice_speed and other synthesis parameters.
41
45
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
42
46
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
43
- # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Optional parameters:
44
- # `speed` (float, default 1.0), `vol` (float, default 1.0), `pitch` (integer,
45
- # default 0).
46
- # - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
47
- # `Resemble.Pro.my_voice`). Supported models: `Pro` (multilingual) and `Turbo`
48
- # (English only).
47
+ # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
48
+ # to configure speed, volume, pitch, and language_boost.
49
+ # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
50
+ # Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
51
+ # voice_speed.
52
+ # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
53
+ # `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
54
+ # `voice_settings` to configure precision, sample_rate, and format.
55
+ #
56
+ # For service_level basic, you may define the gender of the speaker (male or
57
+ # female).
49
58
  #
50
59
  # @return [String]
51
60
  required :voice, String
@@ -110,7 +119,7 @@ module Telnyx
110
119
  # @!attribute voice_settings
111
120
  # The settings associated with the voice selected
112
121
  #
113
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, nil]
122
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
114
123
  optional :voice_settings, union: -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings }
115
124
 
116
125
  # @!method initialize(payload:, voice:, client_state: nil, command_id: nil, language: nil, loop_: nil, payload_type: nil, service_level: nil, stop: nil, target_legs: nil, voice_settings: nil, request_options: {})
@@ -137,7 +146,7 @@ module Telnyx
137
146
  #
138
147
  # @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
139
148
  #
140
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings] The settings associated with the voice selected
149
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
141
150
  #
142
151
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
143
152
 
@@ -230,8 +239,14 @@ module Telnyx
230
239
 
231
240
  variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
232
241
 
242
+ variant :azure, -> { Telnyx::AzureVoiceSettings }
243
+
244
+ variant :rime, -> { Telnyx::RimeVoiceSettings }
245
+
246
+ variant :resemble, -> { Telnyx::ResembleVoiceSettings }
247
+
233
248
  # @!method self.variants
234
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings)]
249
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings)]
235
250
  end
236
251
  end
237
252
  end
@@ -81,7 +81,7 @@ module Telnyx
81
81
  # @!attribute voice_settings
82
82
  # The settings associated with the voice selected
83
83
  #
84
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, nil]
84
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
85
85
  optional :voice_settings, union: -> { Telnyx::Calls::ActionStartAIAssistantParams::VoiceSettings }
86
86
 
87
87
  # @!method initialize(assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
@@ -102,7 +102,7 @@ module Telnyx
102
102
  #
103
103
  # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
104
104
  #
105
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings] The settings associated with the voice selected
105
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
106
106
  #
107
107
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
108
108
 
@@ -153,8 +153,14 @@ module Telnyx
153
153
 
154
154
  variant :aws, -> { Telnyx::Calls::AwsVoiceSettings }
155
155
 
156
+ variant :azure, -> { Telnyx::AzureVoiceSettings }
157
+
158
+ variant :rime, -> { Telnyx::RimeVoiceSettings }
159
+
160
+ variant :resemble, -> { Telnyx::ResembleVoiceSettings }
161
+
156
162
  # @!method self.variants
157
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings)]
163
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings)]
158
164
  end
159
165
  end
160
166
  end
@@ -27,25 +27,34 @@ module Telnyx
27
27
  # the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the
28
28
  # [available voices](https://docs.aws.amazon.com/polly/latest/dg/available-voices.html)
29
29
  # for compatibility.
30
- # - **Azure:** Use `Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural,
31
- # Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural,
32
- # Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to
33
- # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery).)
30
+ # - **Azure:** Use `Azure.<VoiceId>` (e.g., `Azure.en-CA-ClaraNeural`,
31
+ # `Azure.en-US-BrianMultilingualNeural`,
32
+ # `Azure.en-US-Ava:DragonHDLatestNeural`). For a complete list of voices, go to
33
+ # [Azure Voice Gallery](https://speech.microsoft.com/portal/voicegallery). Use
34
+ # `voice_settings` to configure custom deployments, regions, or API keys.
34
35
  # - **ElevenLabs:** Use `ElevenLabs.<ModelId>.<VoiceId>` (e.g.,
35
36
  # `ElevenLabs.eleven_multilingual_v2.21m00Tcm4TlvDq8ikWAM`). The `ModelId` part
36
37
  # is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an
37
38
  # integration identifier secret in
38
- # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. Check
39
+ # `"voice_settings": {"api_key_ref": "<secret_identifier>"}`. See
40
+ # [integration secrets documentation](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
41
+ # for details. Check
39
42
  # [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
40
- # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>`
43
+ # - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
44
+ # Use `voice_settings` to configure voice_speed and other synthesis parameters.
41
45
  # - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
42
46
  # `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
43
- # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Optional parameters:
44
- # `speed` (float, default 1.0), `vol` (float, default 1.0), `pitch` (integer,
45
- # default 0).
46
- # - **Resemble:** Use `Resemble.<ModelId>.<VoiceId>` (e.g.,
47
- # `Resemble.Pro.my_voice`). Supported models: `Pro` (multilingual) and `Turbo`
48
- # (English only).
47
+ # `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
48
+ # to configure speed, volume, pitch, and language_boost.
49
+ # - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
50
+ # Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
51
+ # voice_speed.
52
+ # - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
53
+ # `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
54
+ # `voice_settings` to configure precision, sample_rate, and format.
55
+ #
56
+ # For service_level basic, you may define the gender of the speaker (male or
57
+ # female).
49
58
  #
50
59
  # @return [String]
51
60
  required :voice, String
@@ -89,7 +98,7 @@ module Telnyx
89
98
  # @!attribute voice_settings
90
99
  # The settings associated with the voice selected
91
100
  #
92
- # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, nil]
101
+ # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, nil]
93
102
  optional :voice_settings, union: -> { Telnyx::Conferences::ActionSpeakParams::VoiceSettings }
94
103
 
95
104
  # @!method initialize(payload:, voice:, call_control_ids: nil, command_id: nil, language: nil, payload_type: nil, region: nil, voice_settings: nil, request_options: {})
@@ -110,7 +119,7 @@ module Telnyx
110
119
  #
111
120
  # @param region [Symbol, Telnyx::Models::Conferences::ActionSpeakParams::Region] Region where the conference data is located. Defaults to the region defined in u
112
121
  #
113
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings] The settings associated with the voice selected
122
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
114
123
  #
115
124
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
116
125
 
@@ -193,8 +202,14 @@ module Telnyx
193
202
 
194
203
  variant :minimax, -> { Telnyx::MinimaxVoiceSettings }
195
204
 
205
+ variant :azure, -> { Telnyx::AzureVoiceSettings }
206
+
207
+ variant :rime, -> { Telnyx::RimeVoiceSettings }
208
+
209
+ variant :resemble, -> { Telnyx::ResembleVoiceSettings }
210
+
196
211
  # @!method self.variants
197
- # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings)]
212
+ # @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings)]
198
213
  end
199
214
  end
200
215
  end
@@ -0,0 +1,97 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class ResembleVoiceSettings < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute type
7
+ # Voice settings provider type
8
+ #
9
+ # @return [Symbol, Telnyx::Models::ResembleVoiceSettings::Type]
10
+ required :type, enum: -> { Telnyx::ResembleVoiceSettings::Type }
11
+
12
+ # @!attribute format_
13
+ # Output audio format.
14
+ #
15
+ # @return [Symbol, Telnyx::Models::ResembleVoiceSettings::Format, nil]
16
+ optional :format_, enum: -> { Telnyx::ResembleVoiceSettings::Format }, api_name: :format
17
+
18
+ # @!attribute precision
19
+ # Audio precision format.
20
+ #
21
+ # @return [Symbol, Telnyx::Models::ResembleVoiceSettings::Precision, nil]
22
+ optional :precision, enum: -> { Telnyx::ResembleVoiceSettings::Precision }
23
+
24
+ # @!attribute sample_rate
25
+ # Audio sample rate in Hz.
26
+ #
27
+ # @return [Symbol, Telnyx::Models::ResembleVoiceSettings::SampleRate, nil]
28
+ optional :sample_rate, enum: -> { Telnyx::ResembleVoiceSettings::SampleRate }
29
+
30
+ # @!method initialize(type:, format_: nil, precision: nil, sample_rate: nil)
31
+ # @param type [Symbol, Telnyx::Models::ResembleVoiceSettings::Type] Voice settings provider type
32
+ #
33
+ # @param format_ [Symbol, Telnyx::Models::ResembleVoiceSettings::Format] Output audio format.
34
+ #
35
+ # @param precision [Symbol, Telnyx::Models::ResembleVoiceSettings::Precision] Audio precision format.
36
+ #
37
+ # @param sample_rate [Symbol, Telnyx::Models::ResembleVoiceSettings::SampleRate] Audio sample rate in Hz.
38
+
39
+ # Voice settings provider type
40
+ #
41
+ # @see Telnyx::Models::ResembleVoiceSettings#type
42
+ module Type
43
+ extend Telnyx::Internal::Type::Enum
44
+
45
+ RESEMBLE = :resemble
46
+
47
+ # @!method self.values
48
+ # @return [Array<Symbol>]
49
+ end
50
+
51
+ # Output audio format.
52
+ #
53
+ # @see Telnyx::Models::ResembleVoiceSettings#format_
54
+ module Format
55
+ extend Telnyx::Internal::Type::Enum
56
+
57
+ WAV = :wav
58
+ MP3 = :mp3
59
+
60
+ # @!method self.values
61
+ # @return [Array<Symbol>]
62
+ end
63
+
64
+ # Audio precision format.
65
+ #
66
+ # @see Telnyx::Models::ResembleVoiceSettings#precision
67
+ module Precision
68
+ extend Telnyx::Internal::Type::Enum
69
+
70
+ PCM_16 = :PCM_16
71
+ PCM_24 = :PCM_24
72
+ PCM_32 = :PCM_32
73
+ MULAW = :MULAW
74
+
75
+ # @!method self.values
76
+ # @return [Array<Symbol>]
77
+ end
78
+
79
+ # Audio sample rate in Hz.
80
+ #
81
+ # @see Telnyx::Models::ResembleVoiceSettings#sample_rate
82
+ module SampleRate
83
+ extend Telnyx::Internal::Type::Enum
84
+
85
+ SAMPLE_RATE_8000 = :"8000"
86
+ SAMPLE_RATE_16000 = :"16000"
87
+ SAMPLE_RATE_22050 = :"22050"
88
+ SAMPLE_RATE_32000 = :"32000"
89
+ SAMPLE_RATE_44100 = :"44100"
90
+ SAMPLE_RATE_48000 = :"48000"
91
+
92
+ # @!method self.values
93
+ # @return [Array<Symbol>]
94
+ end
95
+ end
96
+ end
97
+ end
@@ -0,0 +1,36 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class RimeVoiceSettings < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute type
7
+ # Voice settings provider type
8
+ #
9
+ # @return [Symbol, Telnyx::Models::RimeVoiceSettings::Type]
10
+ required :type, enum: -> { Telnyx::RimeVoiceSettings::Type }
11
+
12
+ # @!attribute voice_speed
13
+ # Speech speed multiplier. Default is 1.0.
14
+ #
15
+ # @return [Float, nil]
16
+ optional :voice_speed, Float
17
+
18
+ # @!method initialize(type:, voice_speed: nil)
19
+ # @param type [Symbol, Telnyx::Models::RimeVoiceSettings::Type] Voice settings provider type
20
+ #
21
+ # @param voice_speed [Float] Speech speed multiplier. Default is 1.0.
22
+
23
+ # Voice settings provider type
24
+ #
25
+ # @see Telnyx::Models::RimeVoiceSettings#type
26
+ module Type
27
+ extend Telnyx::Internal::Type::Enum
28
+
29
+ RIME = :rime
30
+
31
+ # @!method self.values
32
+ # @return [Array<Symbol>]
33
+ end
34
+ end
35
+ end
36
+ end
data/lib/telnyx/models.rb CHANGED
@@ -125,6 +125,8 @@ module Telnyx
125
125
 
126
126
  AzureConfigurationData = Telnyx::Models::AzureConfigurationData
127
127
 
128
+ AzureVoiceSettings = Telnyx::Models::AzureVoiceSettings
129
+
128
130
  BalanceRetrieveParams = Telnyx::Models::BalanceRetrieveParams
129
131
 
130
132
  BillingGroup = Telnyx::Models::BillingGroup
@@ -1271,8 +1273,12 @@ module Telnyx
1271
1273
 
1272
1274
  RequirementTypeRetrieveParams = Telnyx::Models::RequirementTypeRetrieveParams
1273
1275
 
1276
+ ResembleVoiceSettings = Telnyx::Models::ResembleVoiceSettings
1277
+
1274
1278
  ReservedPhoneNumber = Telnyx::Models::ReservedPhoneNumber
1275
1279
 
1280
+ RimeVoiceSettings = Telnyx::Models::RimeVoiceSettings
1281
+
1276
1282
  Room = Telnyx::Models::Room
1277
1283
 
1278
1284
  RoomComposition = Telnyx::Models::RoomComposition