telnyx 5.31.0 → 5.32.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 (78) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/call_dial_params.rb +10 -1
  5. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +12 -4
  6. data/lib/telnyx/models/calls/action_speak_params.rb +30 -1
  7. data/lib/telnyx/models/calls/action_start_streaming_params.rb +38 -1
  8. data/lib/telnyx/models/calls/action_transfer_params.rb +67 -1
  9. data/lib/telnyx/models/calls/deepgram_nova2_config.rb +19 -1
  10. data/lib/telnyx/models/calls/deepgram_nova3_config.rb +19 -1
  11. data/lib/telnyx/models/conference_retrieve_participant_params.rb +20 -0
  12. data/lib/telnyx/models/conference_retrieve_participant_response.rb +138 -0
  13. data/lib/telnyx/models/conference_update_participant_params.rb +63 -0
  14. data/lib/telnyx/models/conference_update_participant_response.rb +138 -0
  15. data/lib/telnyx/models/conferences/action_end_params.rb +28 -0
  16. data/lib/telnyx/models/conferences/action_end_response.rb +18 -0
  17. data/lib/telnyx/models/conferences/action_gather_using_audio_params.rb +152 -0
  18. data/lib/telnyx/models/conferences/action_gather_using_audio_response.rb +18 -0
  19. data/lib/telnyx/models/conferences/action_send_dtmf_params.rb +55 -0
  20. data/lib/telnyx/models/conferences/action_send_dtmf_response.rb +18 -0
  21. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +20 -1
  22. data/lib/telnyx/models.rb +4 -0
  23. data/lib/telnyx/resources/calls/actions.rb +23 -5
  24. data/lib/telnyx/resources/calls.rb +3 -1
  25. data/lib/telnyx/resources/conferences/actions.rb +118 -0
  26. data/lib/telnyx/resources/conferences.rb +64 -0
  27. data/lib/telnyx/resources/texml/accounts/calls.rb +5 -1
  28. data/lib/telnyx/version.rb +1 -1
  29. data/lib/telnyx.rb +10 -0
  30. data/rbi/telnyx/models/call_dial_params.rbi +13 -0
  31. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +15 -4
  32. data/rbi/telnyx/models/calls/action_speak_params.rbi +70 -0
  33. data/rbi/telnyx/models/calls/action_start_streaming_params.rbi +82 -0
  34. data/rbi/telnyx/models/calls/action_transfer_params.rbi +161 -0
  35. data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi +29 -3
  36. data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi +29 -3
  37. data/rbi/telnyx/models/conference_retrieve_participant_params.rbi +38 -0
  38. data/rbi/telnyx/models/conference_retrieve_participant_response.rbi +270 -0
  39. data/rbi/telnyx/models/conference_update_participant_params.rbi +139 -0
  40. data/rbi/telnyx/models/conference_update_participant_response.rbi +270 -0
  41. data/rbi/telnyx/models/conferences/action_end_params.rbi +50 -0
  42. data/rbi/telnyx/models/conferences/action_end_response.rbi +43 -0
  43. data/rbi/telnyx/models/conferences/action_gather_using_audio_params.rbi +223 -0
  44. data/rbi/telnyx/models/conferences/action_gather_using_audio_response.rbi +43 -0
  45. data/rbi/telnyx/models/conferences/action_send_dtmf_params.rbi +87 -0
  46. data/rbi/telnyx/models/conferences/action_send_dtmf_response.rbi +43 -0
  47. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +28 -0
  48. data/rbi/telnyx/models.rbi +6 -0
  49. data/rbi/telnyx/resources/calls/actions.rbi +45 -2
  50. data/rbi/telnyx/resources/calls.rbi +4 -0
  51. data/rbi/telnyx/resources/conferences/actions.rbi +114 -0
  52. data/rbi/telnyx/resources/conferences.rbi +46 -0
  53. data/rbi/telnyx/resources/texml/accounts/calls.rbi +9 -0
  54. data/sig/telnyx/models/call_dial_params.rbs +7 -0
  55. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +7 -0
  56. data/sig/telnyx/models/calls/action_speak_params.rbs +30 -0
  57. data/sig/telnyx/models/calls/action_start_streaming_params.rbs +32 -0
  58. data/sig/telnyx/models/calls/action_transfer_params.rbs +56 -1
  59. data/sig/telnyx/models/calls/deepgram_nova2_config.rbs +17 -3
  60. data/sig/telnyx/models/calls/deepgram_nova3_config.rbs +17 -3
  61. data/sig/telnyx/models/conference_retrieve_participant_params.rbs +20 -0
  62. data/sig/telnyx/models/conference_retrieve_participant_response.rbs +139 -0
  63. data/sig/telnyx/models/conference_update_participant_params.rbs +62 -0
  64. data/sig/telnyx/models/conference_update_participant_response.rbs +139 -0
  65. data/sig/telnyx/models/conferences/action_end_params.rbs +27 -0
  66. data/sig/telnyx/models/conferences/action_end_response.rbs +22 -0
  67. data/sig/telnyx/models/conferences/action_gather_using_audio_params.rbs +133 -0
  68. data/sig/telnyx/models/conferences/action_gather_using_audio_response.rbs +22 -0
  69. data/sig/telnyx/models/conferences/action_send_dtmf_params.rbs +49 -0
  70. data/sig/telnyx/models/conferences/action_send_dtmf_response.rbs +22 -0
  71. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +14 -0
  72. data/sig/telnyx/models.rbs +4 -0
  73. data/sig/telnyx/resources/calls/actions.rbs +9 -0
  74. data/sig/telnyx/resources/calls.rbs +1 -0
  75. data/sig/telnyx/resources/conferences/actions.rbs +36 -0
  76. data/sig/telnyx/resources/conferences.rbs +15 -0
  77. data/sig/telnyx/resources/texml/accounts/calls.rbs +2 -0
  78. metadata +32 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 667a925cbae4fac53620336ba314569face085fbb7a5d4d8835d24deea241330
4
- data.tar.gz: 4875530316b9799fe27b54ab6652d063105355a0322cda85f20e3b094af662b4
3
+ metadata.gz: 3ae05814abf430e64f02a7cbadff7ba780597c729216171e62b24fae4e3bfe67
4
+ data.tar.gz: a89d9a80e6f5fdb7e855c1f167974a49201337020f3a6dab38a2619605767900
5
5
  SHA512:
6
- metadata.gz: 64ca21cf79eed60bc8c892a78982b199fa392d9dbc37e6a875411a4812f408836a2dce258afc3c3b45f0e795de21bd167047a81329b037eff4d0bea09476feb3
7
- data.tar.gz: 26e13b9ea4a74980c60b975b3156bf3f047b821fea8919f15a7970c5fc89879cb6e41fdbc0f85fec56f31973180fe03610b698df9a57b1439b4912993d3797f7
6
+ metadata.gz: 385536480c8ef2df4aee5d23645be823eb066e05c91b7aa1c60508b8f84bb05f16e92f5b76c1f51629a748bdf53e3ad72dfd81468a4a61f177a22322afa9119a
7
+ data.tar.gz: 854359436063daeb51d1dd539099f1d1fbed7ad183e5ed32c57ed3ae91b6bf988b1380d1fd5c214f460fed974c913671b07a41f6a38b0eb20c5fabe852aa1d29
data/CHANGELOG.md CHANGED
@@ -1,5 +1,27 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.32.0 (2026-02-19)
4
+
5
+ Full Changelog: [v5.31.0...v5.32.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.31.0...v5.32.0)
6
+
7
+ ### Features
8
+
9
+ * TELAPPS Add interim_results to deepgram config ([8956bf3](https://github.com/team-telnyx/telnyx-ruby/commit/8956bf35b3bbd377d8bd77d2f0331dcb7a09307b))
10
+
11
+
12
+ ### Chores
13
+
14
+ * **internal:** remove mock server code ([966d641](https://github.com/team-telnyx/telnyx-ruby/commit/966d641e11a6ad4a930c2b102831386c0a3de52e))
15
+ * **test:** update skip reason message ([8054691](https://github.com/team-telnyx/telnyx-ruby/commit/8054691cd25e858d070517c7427131d6e6fa498c))
16
+ * update mock server docs ([4695e7d](https://github.com/team-telnyx/telnyx-ruby/commit/4695e7d2a103ef6c80450ca1d38e1f04241f5067))
17
+
18
+
19
+ ### Documentation
20
+
21
+ * **call-control:** Add missing conference endpoints ([b54f876](https://github.com/team-telnyx/telnyx-ruby/commit/b54f87674679c06e809fc569a091cdc6930e1800))
22
+ * **call-control:** Add missing parameters to call control endpoints ([1cf2a4e](https://github.com/team-telnyx/telnyx-ruby/commit/1cf2a4e33051e01cb3124e20aa06975eeb63df33))
23
+ * **call-scripting:** add Timeout and TimeLimit to InitiateTexmlCall ([e2127cb](https://github.com/team-telnyx/telnyx-ruby/commit/e2127cb13f63a02074aba414b397ba64ece86081))
24
+
3
25
  ## 5.31.0 (2026-02-18)
4
26
 
5
27
  Full Changelog: [v5.30.0...v5.31.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.30.0...v5.31.0)
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.31.0"
27
+ gem "telnyx", "~> 5.32.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -273,6 +273,13 @@ module Telnyx
273
273
  # @return [Telnyx::Models::SoundModifications, nil]
274
274
  optional :sound_modifications, -> { Telnyx::SoundModifications }
275
275
 
276
+ # @!attribute stream_auth_token
277
+ # An authentication token to be sent as part of the WebSocket connection when
278
+ # using streaming. Maximum length is 4000 characters.
279
+ #
280
+ # @return [String, nil]
281
+ optional :stream_auth_token, String
282
+
276
283
  # @!attribute stream_bidirectional_codec
277
284
  # Indicates codec for bidirectional streaming RTP payloads. Used only with
278
285
  # stream_bidirectional_mode=rtp. Case sensitive.
@@ -385,7 +392,7 @@ module Telnyx
385
392
  # @return [Symbol, Telnyx::Models::CallDialParams::WebhookURLMethod, nil]
386
393
  optional :webhook_url_method, enum: -> { Telnyx::CallDialParams::WebhookURLMethod }
387
394
 
388
- # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
395
+ # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, custom_headers: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
389
396
  # Some parameter documentations has been truncated, see
390
397
  # {Telnyx::Models::CallDialParams} for more details.
391
398
  #
@@ -461,6 +468,8 @@ module Telnyx
461
468
  #
462
469
  # @param sound_modifications [Telnyx::Models::SoundModifications] Use this field to modify sound effects, for example adjust the pitch.
463
470
  #
471
+ # @param stream_auth_token [String] An authentication token to be sent as part of the WebSocket connection when usin
472
+ #
464
473
  # @param stream_bidirectional_codec [Symbol, Telnyx::Models::StreamBidirectionalCodec] Indicates codec for bidirectional streaming RTP payloads. Used only with
465
474
  # stream\_
466
475
  #
@@ -37,6 +37,13 @@ module Telnyx
37
37
  # @return [String, nil]
38
38
  optional :command_id, String
39
39
 
40
+ # @!attribute gather_ended_speech
41
+ # Text that will be played when the gathering has finished. There is a 3,000
42
+ # character limit.
43
+ #
44
+ # @return [String, nil]
45
+ optional :gather_ended_speech, String
46
+
40
47
  # @!attribute greeting
41
48
  # Text that will be played when the gathering starts, if none then nothing will be
42
49
  # played when the gathering starts. The greeting can be text for any voice or SSML
@@ -93,8 +100,7 @@ module Telnyx
93
100
  optional :transcription, -> { Telnyx::Calls::TranscriptionConfig }
94
101
 
95
102
  # @!attribute user_response_timeout_ms
96
- # The number of milliseconds to wait for a user response before the voice
97
- # assistant times out and check if the user is still there.
103
+ # The maximum time in milliseconds to wait for user response before timing out.
98
104
  #
99
105
  # @return [Integer, nil]
100
106
  optional :user_response_timeout_ms, Integer
@@ -132,7 +138,7 @@ module Telnyx
132
138
  # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, nil]
133
139
  optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }
134
140
 
135
- # @!method initialize(parameters:, assistant: nil, client_state: nil, command_id: 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: {})
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: {})
136
142
  # Some parameter documentations has been truncated, see
137
143
  # {Telnyx::Models::Calls::ActionGatherUsingAIParams} for more details.
138
144
  #
@@ -144,6 +150,8 @@ module Telnyx
144
150
  #
145
151
  # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
146
152
  #
153
+ # @param gather_ended_speech [String] Text that will be played when the gathering has finished. There is a 3,000 chara
154
+ #
147
155
  # @param greeting [String] Text that will be played when the gathering starts, if none then nothing will be
148
156
  #
149
157
  # @param interruption_settings [Telnyx::Models::Calls::InterruptionSettings] Settings for handling user interruptions during assistant speech
@@ -158,7 +166,7 @@ module Telnyx
158
166
  #
159
167
  # @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
160
168
  #
161
- # @param user_response_timeout_ms [Integer] The number of milliseconds to wait for a user response before the voice assistan
169
+ # @param user_response_timeout_ms [Integer] The maximum time in milliseconds to wait for user response before timing out.
162
170
  #
163
171
  # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
164
172
  #
@@ -71,6 +71,13 @@ module Telnyx
71
71
  # @return [Symbol, Telnyx::Models::Calls::ActionSpeakParams::Language, nil]
72
72
  optional :language, enum: -> { Telnyx::Calls::ActionSpeakParams::Language }
73
73
 
74
+ # @!attribute loop_
75
+ # The number of times to play the audio file. Use `infinity` to loop indefinitely.
76
+ # Defaults to 1.
77
+ #
78
+ # @return [String, Integer, nil]
79
+ optional :loop_, union: -> { Telnyx::Calls::Loopcount }, api_name: :loop
80
+
74
81
  # @!attribute payload_type
75
82
  # The type of the provided payload. The payload can either be plain text, or
76
83
  # Speech Synthesis Markup Language (SSML).
@@ -94,13 +101,19 @@ module Telnyx
94
101
  # @return [String, nil]
95
102
  optional :stop, String
96
103
 
104
+ # @!attribute target_legs
105
+ # Specifies which legs of the call should receive the spoken audio.
106
+ #
107
+ # @return [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs, nil]
108
+ optional :target_legs, enum: -> { Telnyx::Calls::ActionSpeakParams::TargetLegs }
109
+
97
110
  # @!attribute voice_settings
98
111
  # The settings associated with the voice selected
99
112
  #
100
113
  # @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, nil]
101
114
  optional :voice_settings, union: -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings }
102
115
 
103
- # @!method initialize(payload:, voice:, client_state: nil, command_id: nil, language: nil, payload_type: nil, service_level: nil, stop: nil, voice_settings: nil, request_options: {})
116
+ # @!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: {})
104
117
  # Some parameter documentations has been truncated, see
105
118
  # {Telnyx::Models::Calls::ActionSpeakParams} for more details.
106
119
  #
@@ -114,12 +127,16 @@ module Telnyx
114
127
  #
115
128
  # @param language [Symbol, Telnyx::Models::Calls::ActionSpeakParams::Language] The language you want spoken. This parameter is ignored when a `Polly.*` voice i
116
129
  #
130
+ # @param loop_ [String, Integer] The number of times to play the audio file. Use `infinity` to loop indefinitely.
131
+ #
117
132
  # @param payload_type [Symbol, Telnyx::Models::Calls::ActionSpeakParams::PayloadType] The type of the provided payload. The payload can either be plain text, or Speec
118
133
  #
119
134
  # @param service_level [Symbol, Telnyx::Models::Calls::ActionSpeakParams::ServiceLevel] This parameter impacts speech quality, language options and payload types. When
120
135
  #
121
136
  # @param stop [String] When specified, it stops the current audio being played. Specify `current` to st
122
137
  #
138
+ # @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
139
+ #
123
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
124
141
  #
125
142
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
@@ -187,6 +204,18 @@ module Telnyx
187
204
  # @return [Array<Symbol>]
188
205
  end
189
206
 
207
+ # Specifies which legs of the call should receive the spoken audio.
208
+ module TargetLegs
209
+ extend Telnyx::Internal::Type::Enum
210
+
211
+ SELF = :self
212
+ OPPOSITE = :opposite
213
+ BOTH = :both
214
+
215
+ # @!method self.values
216
+ # @return [Array<Symbol>]
217
+ end
218
+
190
219
  # The settings associated with the voice selected
191
220
  module VoiceSettings
192
221
  extend Telnyx::Internal::Type::Union
@@ -22,6 +22,13 @@ module Telnyx
22
22
  # @return [String, nil]
23
23
  optional :command_id, String
24
24
 
25
+ # @!attribute custom_parameters
26
+ # Custom parameters to be sent as part of the WebSocket connection.
27
+ #
28
+ # @return [Array<Telnyx::Models::Calls::ActionStartStreamingParams::CustomParameter>, nil]
29
+ optional :custom_parameters,
30
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartStreamingParams::CustomParameter] }
31
+
25
32
  # @!attribute dialogflow_config
26
33
  #
27
34
  # @return [Telnyx::Models::DialogflowConfig, nil]
@@ -33,6 +40,13 @@ module Telnyx
33
40
  # @return [Boolean, nil]
34
41
  optional :enable_dialogflow, Telnyx::Internal::Type::Boolean
35
42
 
43
+ # @!attribute stream_auth_token
44
+ # An authentication token to be sent as part of the WebSocket connection. Maximum
45
+ # length is 4000 characters.
46
+ #
47
+ # @return [String, nil]
48
+ optional :stream_auth_token, String
49
+
36
50
  # @!attribute stream_bidirectional_codec
37
51
  # Indicates codec for bidirectional streaming RTP payloads. Used only with
38
52
  # stream_bidirectional_mode=rtp. Case sensitive.
@@ -77,7 +91,7 @@ module Telnyx
77
91
  # @return [String, nil]
78
92
  optional :stream_url, String
79
93
 
80
- # @!method initialize(client_state: nil, command_id: nil, dialogflow_config: nil, enable_dialogflow: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, request_options: {})
94
+ # @!method initialize(client_state: nil, command_id: nil, custom_parameters: nil, dialogflow_config: nil, enable_dialogflow: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_track: nil, stream_url: nil, request_options: {})
81
95
  # Some parameter documentations has been truncated, see
82
96
  # {Telnyx::Models::Calls::ActionStartStreamingParams} for more details.
83
97
  #
@@ -85,10 +99,14 @@ module Telnyx
85
99
  #
86
100
  # @param command_id [String] Use this field to avoid duplicate commands. Telnyx will ignore any command with
87
101
  #
102
+ # @param custom_parameters [Array<Telnyx::Models::Calls::ActionStartStreamingParams::CustomParameter>] Custom parameters to be sent as part of the WebSocket connection.
103
+ #
88
104
  # @param dialogflow_config [Telnyx::Models::DialogflowConfig]
89
105
  #
90
106
  # @param enable_dialogflow [Boolean] Enables Dialogflow for the current call. The default value is false.
91
107
  #
108
+ # @param stream_auth_token [String] An authentication token to be sent as part of the WebSocket connection. Maximum
109
+ #
92
110
  # @param stream_bidirectional_codec [Symbol, Telnyx::Models::StreamBidirectionalCodec] Indicates codec for bidirectional streaming RTP payloads. Used only with
93
111
  # stream\_
94
112
  #
@@ -106,6 +124,25 @@ module Telnyx
106
124
  #
107
125
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
108
126
 
127
+ class CustomParameter < Telnyx::Internal::Type::BaseModel
128
+ # @!attribute name
129
+ # The name of the custom parameter.
130
+ #
131
+ # @return [String, nil]
132
+ optional :name, String
133
+
134
+ # @!attribute value
135
+ # The value of the custom parameter.
136
+ #
137
+ # @return [String, nil]
138
+ optional :value, String
139
+
140
+ # @!method initialize(name: nil, value: nil)
141
+ # @param name [String] The name of the custom parameter.
142
+ #
143
+ # @param value [String] The value of the custom parameter.
144
+ end
145
+
109
146
  # Specifies which track should be streamed.
110
147
  module StreamTrack
111
148
  extend Telnyx::Internal::Type::Enum
@@ -117,6 +117,14 @@ module Telnyx
117
117
  # @return [String, nil]
118
118
  optional :park_after_unbridge, String
119
119
 
120
+ # @!attribute preferred_codecs
121
+ # The list of comma-separated codecs in order of preference to be used during the
122
+ # call. The codecs supported are `G722`, `PCMU`, `PCMA`, `G729`, `OPUS`, `VP8`,
123
+ # `H264`, `AMR-WB`.
124
+ #
125
+ # @return [String, nil]
126
+ optional :preferred_codecs, String
127
+
120
128
  # @!attribute record
121
129
  # Start recording automatically after an event. Disabled by default.
122
130
  #
@@ -241,6 +249,15 @@ module Telnyx
241
249
  # @return [Integer, nil]
242
250
  optional :timeout_secs, Integer
243
251
 
252
+ # @!attribute webhook_retries_policies
253
+ # A map of event types to retry policies. Each retry policy contains an array of
254
+ # `retries_ms` specifying the delays between retry attempts in milliseconds.
255
+ # Maximum 5 retries, total delay cannot exceed 60 seconds.
256
+ #
257
+ # @return [Hash{Symbol=>Telnyx::Models::Calls::ActionTransferParams::WebhookRetriesPolicy}, nil]
258
+ optional :webhook_retries_policies,
259
+ -> { Telnyx::Internal::Type::HashOf[Telnyx::Calls::ActionTransferParams::WebhookRetriesPolicy] }
260
+
244
261
  # @!attribute webhook_url
245
262
  # Use this field to override the URL for which Telnyx will send subsequent
246
263
  # webhooks to for this call.
@@ -254,7 +271,21 @@ module Telnyx
254
271
  # @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLMethod, nil]
255
272
  optional :webhook_url_method, enum: -> { Telnyx::Calls::ActionTransferParams::WebhookURLMethod }
256
273
 
257
- # @!method initialize(to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_url: nil, webhook_url_method: nil, request_options: {})
274
+ # @!attribute webhook_urls
275
+ # A map of event types to webhook URLs. When an event of the specified type
276
+ # occurs, the webhook URL associated with that event type will be called instead
277
+ # of `webhook_url`. Events not mapped here will use the default `webhook_url`.
278
+ #
279
+ # @return [Hash{Symbol=>String}, nil]
280
+ optional :webhook_urls, Telnyx::Internal::Type::HashOf[String]
281
+
282
+ # @!attribute webhook_urls_method
283
+ # HTTP request method to invoke `webhook_urls`.
284
+ #
285
+ # @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLsMethod, nil]
286
+ optional :webhook_urls_method, enum: -> { Telnyx::Calls::ActionTransferParams::WebhookURLsMethod }
287
+
288
+ # @!method initialize(to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
258
289
  # Some parameter documentations has been truncated, see
259
290
  # {Telnyx::Models::Calls::ActionTransferParams} for more details.
260
291
  #
@@ -286,6 +317,8 @@ module Telnyx
286
317
  #
287
318
  # @param park_after_unbridge [String] Specifies behavior after the bridge ends (i.e. the opposite leg either hangs up
288
319
  #
320
+ # @param preferred_codecs [String] The list of comma-separated codecs in order of preference to be used during the
321
+ #
289
322
  # @param record [Symbol, Telnyx::Models::Calls::ActionTransferParams::Record] Start recording automatically after an event. Disabled by default.
290
323
  #
291
324
  # @param record_channels [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordChannels] Defines which channel should be recorded ('single' or 'dual') when `record` is s
@@ -320,10 +353,16 @@ module Telnyx
320
353
  #
321
354
  # @param timeout_secs [Integer] The number of seconds that Telnyx will wait for the call to be answered by the d
322
355
  #
356
+ # @param webhook_retries_policies [Hash{Symbol=>Telnyx::Models::Calls::ActionTransferParams::WebhookRetriesPolicy}] A map of event types to retry policies. Each retry policy contains an array of `
357
+ #
323
358
  # @param webhook_url [String] Use this field to override the URL for which Telnyx will send subsequent webhook
324
359
  #
325
360
  # @param webhook_url_method [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLMethod] HTTP request type used for `webhook_url`.
326
361
  #
362
+ # @param webhook_urls [Hash{Symbol=>String}] A map of event types to webhook URLs. When an event of the specified type occurs
363
+ #
364
+ # @param webhook_urls_method [Symbol, Telnyx::Models::Calls::ActionTransferParams::WebhookURLsMethod] HTTP request method to invoke `webhook_urls`.
365
+ #
327
366
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
328
367
 
329
368
  # Enables Answering Machine Detection. When a call is answered, Telnyx runs
@@ -551,6 +590,22 @@ module Telnyx
551
590
  # @return [Array<Symbol>]
552
591
  end
553
592
 
593
+ class WebhookRetriesPolicy < Telnyx::Internal::Type::BaseModel
594
+ # @!attribute retries_ms
595
+ # Array of delays in milliseconds between retry attempts. Total sum cannot exceed
596
+ # 60000ms.
597
+ #
598
+ # @return [Array<Integer>, nil]
599
+ optional :retries_ms, Telnyx::Internal::Type::ArrayOf[Integer]
600
+
601
+ # @!method initialize(retries_ms: nil)
602
+ # Some parameter documentations has been truncated, see
603
+ # {Telnyx::Models::Calls::ActionTransferParams::WebhookRetriesPolicy} for more
604
+ # details.
605
+ #
606
+ # @param retries_ms [Array<Integer>] Array of delays in milliseconds between retry attempts. Total sum cannot exceed
607
+ end
608
+
554
609
  # HTTP request type used for `webhook_url`.
555
610
  module WebhookURLMethod
556
611
  extend Telnyx::Internal::Type::Enum
@@ -561,6 +616,17 @@ module Telnyx
561
616
  # @!method self.values
562
617
  # @return [Array<Symbol>]
563
618
  end
619
+
620
+ # HTTP request method to invoke `webhook_urls`.
621
+ module WebhookURLsMethod
622
+ extend Telnyx::Internal::Type::Enum
623
+
624
+ POST = :POST
625
+ GET = :GET
626
+
627
+ # @!method self.values
628
+ # @return [Array<Symbol>]
629
+ end
564
630
  end
565
631
  end
566
632
  end
@@ -14,6 +14,13 @@ module Telnyx
14
14
  # @return [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::TranscriptionModel]
15
15
  required :transcription_model, enum: -> { Telnyx::Calls::DeepgramNova2Config::TranscriptionModel }
16
16
 
17
+ # @!attribute interim_results
18
+ # Whether to send also interim results. If set to false, only final results will
19
+ # be sent.
20
+ #
21
+ # @return [Boolean, nil]
22
+ optional :interim_results, Telnyx::Internal::Type::Boolean
23
+
17
24
  # @!attribute keywords_boosting
18
25
  # Keywords and their respective intensifiers (boosting values) to improve
19
26
  # transcription accuracy for specific words or phrases. The intensifier should be
@@ -28,7 +35,14 @@ module Telnyx
28
35
  # @return [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::Language, nil]
29
36
  optional :language, enum: -> { Telnyx::Calls::DeepgramNova2Config::Language }
30
37
 
31
- # @!method initialize(transcription_engine:, transcription_model:, keywords_boosting: nil, language: nil)
38
+ # @!attribute utterance_end_ms
39
+ # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
40
+ # to 5000 ms.
41
+ #
42
+ # @return [Integer, nil]
43
+ optional :utterance_end_ms, Integer
44
+
45
+ # @!method initialize(transcription_engine:, transcription_model:, interim_results: nil, keywords_boosting: nil, language: nil, utterance_end_ms: nil)
32
46
  # Some parameter documentations has been truncated, see
33
47
  # {Telnyx::Models::Calls::DeepgramNova2Config} for more details.
34
48
  #
@@ -36,9 +50,13 @@ module Telnyx
36
50
  #
37
51
  # @param transcription_model [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::TranscriptionModel]
38
52
  #
53
+ # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
54
+ #
39
55
  # @param keywords_boosting [Hash{Symbol=>Float}] Keywords and their respective intensifiers (boosting values) to improve transcri
40
56
  #
41
57
  # @param language [Symbol, Telnyx::Models::Calls::DeepgramNova2Config::Language] Language to use for speech recognition with nova-2 model
58
+ #
59
+ # @param utterance_end_ms [Integer] Number of milliseconds of silence to consider an utterance ended. Ranges from 0
42
60
 
43
61
  # @see Telnyx::Models::Calls::DeepgramNova2Config#transcription_engine
44
62
  module TranscriptionEngine
@@ -14,6 +14,13 @@ module Telnyx
14
14
  # @return [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::TranscriptionModel]
15
15
  required :transcription_model, enum: -> { Telnyx::Calls::DeepgramNova3Config::TranscriptionModel }
16
16
 
17
+ # @!attribute interim_results
18
+ # Whether to send also interim results. If set to false, only final results will
19
+ # be sent.
20
+ #
21
+ # @return [Boolean, nil]
22
+ optional :interim_results, Telnyx::Internal::Type::Boolean
23
+
17
24
  # @!attribute keywords_boosting
18
25
  # Keywords and their respective intensifiers (boosting values) to improve
19
26
  # transcription accuracy for specific words or phrases. The intensifier should be
@@ -28,7 +35,14 @@ module Telnyx
28
35
  # @return [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::Language, nil]
29
36
  optional :language, enum: -> { Telnyx::Calls::DeepgramNova3Config::Language }
30
37
 
31
- # @!method initialize(transcription_engine:, transcription_model:, keywords_boosting: nil, language: nil)
38
+ # @!attribute utterance_end_ms
39
+ # Number of milliseconds of silence to consider an utterance ended. Ranges from 0
40
+ # to 5000 ms.
41
+ #
42
+ # @return [Integer, nil]
43
+ optional :utterance_end_ms, Integer
44
+
45
+ # @!method initialize(transcription_engine:, transcription_model:, interim_results: nil, keywords_boosting: nil, language: nil, utterance_end_ms: nil)
32
46
  # Some parameter documentations has been truncated, see
33
47
  # {Telnyx::Models::Calls::DeepgramNova3Config} for more details.
34
48
  #
@@ -36,9 +50,13 @@ module Telnyx
36
50
  #
37
51
  # @param transcription_model [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::TranscriptionModel]
38
52
  #
53
+ # @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
54
+ #
39
55
  # @param keywords_boosting [Hash{Symbol=>Float}] Keywords and their respective intensifiers (boosting values) to improve transcri
40
56
  #
41
57
  # @param language [Symbol, Telnyx::Models::Calls::DeepgramNova3Config::Language] Language to use for speech recognition with nova-3 model
58
+ #
59
+ # @param utterance_end_ms [Integer] Number of milliseconds of silence to consider an utterance ended. Ranges from 0
42
60
 
43
61
  # @see Telnyx::Models::Calls::DeepgramNova3Config#transcription_engine
44
62
  module TranscriptionEngine
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Conferences#retrieve_participant
6
+ class ConferenceRetrieveParticipantParams < Telnyx::Internal::Type::BaseModel
7
+ extend Telnyx::Internal::Type::RequestParameters::Converter
8
+ include Telnyx::Internal::Type::RequestParameters
9
+
10
+ # @!attribute id
11
+ #
12
+ # @return [String]
13
+ required :id, String
14
+
15
+ # @!method initialize(id:, request_options: {})
16
+ # @param id [String]
17
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,138 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ # @see Telnyx::Resources::Conferences#retrieve_participant
6
+ class ConferenceRetrieveParticipantResponse < Telnyx::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ #
9
+ # @return [Telnyx::Models::ConferenceRetrieveParticipantResponse::Data, nil]
10
+ optional :data, -> { Telnyx::Models::ConferenceRetrieveParticipantResponse::Data }
11
+
12
+ # @!method initialize(data: nil)
13
+ # @param data [Telnyx::Models::ConferenceRetrieveParticipantResponse::Data]
14
+
15
+ # @see Telnyx::Models::ConferenceRetrieveParticipantResponse#data
16
+ class Data < Telnyx::Internal::Type::BaseModel
17
+ # @!attribute id
18
+ # Uniquely identifies the participant.
19
+ #
20
+ # @return [String, nil]
21
+ optional :id, String
22
+
23
+ # @!attribute call_control_id
24
+ # Unique identifier and token for controlling the participant's call leg.
25
+ #
26
+ # @return [String, nil]
27
+ optional :call_control_id, String
28
+
29
+ # @!attribute call_leg_id
30
+ # Unique identifier for the call leg.
31
+ #
32
+ # @return [String, nil]
33
+ optional :call_leg_id, String
34
+
35
+ # @!attribute conference_id
36
+ # Unique identifier for the conference.
37
+ #
38
+ # @return [String, nil]
39
+ optional :conference_id, String
40
+
41
+ # @!attribute created_at
42
+ # Timestamp when the participant joined.
43
+ #
44
+ # @return [Time, nil]
45
+ optional :created_at, Time
46
+
47
+ # @!attribute end_conference_on_exit
48
+ # Whether the conference ends when this participant exits.
49
+ #
50
+ # @return [Boolean, nil]
51
+ optional :end_conference_on_exit, Telnyx::Internal::Type::Boolean
52
+
53
+ # @!attribute label
54
+ # Label assigned to the participant when joining.
55
+ #
56
+ # @return [String, nil]
57
+ optional :label, String
58
+
59
+ # @!attribute muted
60
+ # Whether the participant is muted.
61
+ #
62
+ # @return [Boolean, nil]
63
+ optional :muted, Telnyx::Internal::Type::Boolean
64
+
65
+ # @!attribute on_hold
66
+ # Whether the participant is on hold.
67
+ #
68
+ # @return [Boolean, nil]
69
+ optional :on_hold, Telnyx::Internal::Type::Boolean
70
+
71
+ # @!attribute soft_end_conference_on_exit
72
+ # Whether the conference soft-ends when this participant exits.
73
+ #
74
+ # @return [Boolean, nil]
75
+ optional :soft_end_conference_on_exit, Telnyx::Internal::Type::Boolean
76
+
77
+ # @!attribute status
78
+ # Status of the participant.
79
+ #
80
+ # @return [Symbol, Telnyx::Models::ConferenceRetrieveParticipantResponse::Data::Status, nil]
81
+ optional :status, enum: -> { Telnyx::Models::ConferenceRetrieveParticipantResponse::Data::Status }
82
+
83
+ # @!attribute updated_at
84
+ # Timestamp when the participant was last updated.
85
+ #
86
+ # @return [Time, nil]
87
+ optional :updated_at, Time
88
+
89
+ # @!attribute whisper_call_control_ids
90
+ # List of call control IDs this participant is whispering to.
91
+ #
92
+ # @return [Array<String>, nil]
93
+ optional :whisper_call_control_ids, Telnyx::Internal::Type::ArrayOf[String]
94
+
95
+ # @!method initialize(id: nil, call_control_id: nil, call_leg_id: nil, conference_id: nil, created_at: nil, end_conference_on_exit: nil, label: nil, muted: nil, on_hold: nil, soft_end_conference_on_exit: nil, status: nil, updated_at: nil, whisper_call_control_ids: nil)
96
+ # @param id [String] Uniquely identifies the participant.
97
+ #
98
+ # @param call_control_id [String] Unique identifier and token for controlling the participant's call leg.
99
+ #
100
+ # @param call_leg_id [String] Unique identifier for the call leg.
101
+ #
102
+ # @param conference_id [String] Unique identifier for the conference.
103
+ #
104
+ # @param created_at [Time] Timestamp when the participant joined.
105
+ #
106
+ # @param end_conference_on_exit [Boolean] Whether the conference ends when this participant exits.
107
+ #
108
+ # @param label [String] Label assigned to the participant when joining.
109
+ #
110
+ # @param muted [Boolean] Whether the participant is muted.
111
+ #
112
+ # @param on_hold [Boolean] Whether the participant is on hold.
113
+ #
114
+ # @param soft_end_conference_on_exit [Boolean] Whether the conference soft-ends when this participant exits.
115
+ #
116
+ # @param status [Symbol, Telnyx::Models::ConferenceRetrieveParticipantResponse::Data::Status] Status of the participant.
117
+ #
118
+ # @param updated_at [Time] Timestamp when the participant was last updated.
119
+ #
120
+ # @param whisper_call_control_ids [Array<String>] List of call control IDs this participant is whispering to.
121
+
122
+ # Status of the participant.
123
+ #
124
+ # @see Telnyx::Models::ConferenceRetrieveParticipantResponse::Data#status
125
+ module Status
126
+ extend Telnyx::Internal::Type::Enum
127
+
128
+ JOINING = :joining
129
+ JOINED = :joined
130
+ LEFT = :left
131
+
132
+ # @!method self.values
133
+ # @return [Array<Symbol>]
134
+ end
135
+ end
136
+ end
137
+ end
138
+ end