telnyx 5.82.0 → 5.84.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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/voice_settings.rb +5 -1
  5. data/lib/telnyx/models/call_hold_webhook_event.rb +147 -0
  6. data/lib/telnyx/models/call_unhold_webhook_event.rb +147 -0
  7. data/lib/telnyx/models/text_to_speech_generate_params.rb +96 -1
  8. data/lib/telnyx/models/text_to_speech_list_voices_params.rb +1 -0
  9. data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb +5 -1
  10. data/lib/telnyx/models/unwrap_webhook_event.rb +5 -1
  11. data/lib/telnyx/models.rb +4 -0
  12. data/lib/telnyx/resources/calls/actions.rb +1 -0
  13. data/lib/telnyx/resources/calls.rb +1 -0
  14. data/lib/telnyx/resources/text_to_speech.rb +4 -2
  15. data/lib/telnyx/resources/webhooks.rb +2 -2
  16. data/lib/telnyx/version.rb +1 -1
  17. data/lib/telnyx.rb +2 -0
  18. data/rbi/telnyx/models/ai/voice_settings.rbi +10 -2
  19. data/rbi/telnyx/models/call_hold_webhook_event.rbi +297 -0
  20. data/rbi/telnyx/models/call_unhold_webhook_event.rbi +304 -0
  21. data/rbi/telnyx/models/text_to_speech_generate_params.rbi +269 -0
  22. data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi +5 -0
  23. data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi +2 -0
  24. data/rbi/telnyx/models/unwrap_webhook_event.rbi +2 -0
  25. data/rbi/telnyx/models.rbi +4 -0
  26. data/rbi/telnyx/resources/calls/actions.rbi +1 -0
  27. data/rbi/telnyx/resources/calls.rbi +1 -0
  28. data/rbi/telnyx/resources/text_to_speech.rbi +4 -1
  29. data/rbi/telnyx/resources/webhooks.rbi +4 -0
  30. data/sig/telnyx/models/call_hold_webhook_event.rbs +151 -0
  31. data/sig/telnyx/models/call_unhold_webhook_event.rbs +152 -0
  32. data/sig/telnyx/models/text_to_speech_generate_params.rbs +104 -2
  33. data/sig/telnyx/models/text_to_speech_list_voices_params.rbs +9 -1
  34. data/sig/telnyx/models/unsafe_unwrap_webhook_event.rbs +2 -0
  35. data/sig/telnyx/models/unwrap_webhook_event.rbs +2 -0
  36. data/sig/telnyx/models.rbs +4 -0
  37. data/sig/telnyx/resources/text_to_speech.rbs +1 -0
  38. data/sig/telnyx/resources/webhooks.rbs +4 -0
  39. metadata +8 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 86dd19a54da99721d7ba89203195968a2078948f620f40ad94d2cc65f3e70529
4
- data.tar.gz: 160bbed7d53c401607159acbb5f4214915632653c3fb251e085cbb9911e36331
3
+ metadata.gz: 93f033c0af93b2ca2defc0d2de7d6354ce841a8a3aa9c2eb6fbc49301a65a159
4
+ data.tar.gz: '0029f02da8b9f2e0c2e92b356c77cabdca92b5afc75e7e9ba11ca8bcab13b39d'
5
5
  SHA512:
6
- metadata.gz: 80f96b099e224c16ca297255a8627901bcf4b47cbbc731a8a0f64b995c4206744e27ddd7c65617058f0bd64b925d85fbde45053db4f21e130c93a0ced44cf256
7
- data.tar.gz: 5211feb2ce70e880ea9dee6dac47cf6ef7f4b041721ab30f87cdbc2af0f274bd9e8671ec2ca5e69945111386b7d59b8adcd0ac34d9653a92ff96a1e331d8cf4b
6
+ metadata.gz: a237debb471c155835ea0f46045d9a86c5052c3844bf7cac17cbcefd6f814e4c815b0e6b3fca3b239c11236be1ed35c0244564a4a366d2ea2bba602f71c99111
7
+ data.tar.gz: a0ef70271ffc0b4c66b48445e98ab7df7a9f3b3f99db41a2a8c3189f20c1e869b035d631bed892835543c58e249ca28e6a4f675ea9c1b86cbca1cac29e84109b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.84.0 (2026-04-24)
4
+
5
+ Full Changelog: [v5.83.0...v5.84.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.83.0...v5.84.0)
6
+
7
+ ### Features
8
+
9
+ * Add call.hold and call.unhold webhook event documentation ([7dbc6b0](https://github.com/team-telnyx/telnyx-ruby/commit/7dbc6b099b5193a72a0faadbbfc6cd7e87ea34eb))
10
+
11
+
12
+ ### Documentation
13
+
14
+ * document dynamic variable support for voice_settings.voice ([b72a45a](https://github.com/team-telnyx/telnyx-ruby/commit/b72a45a9d7eb19fbbe2138f6dd1cf623256066aa))
15
+
16
+ ## 5.83.0 (2026-04-23)
17
+
18
+ Full Changelog: [v5.82.0...v5.83.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.82.0...v5.83.0)
19
+
20
+ ### Features
21
+
22
+ * Add xAI provider to standalone STT and TTS specs ([f46ab80](https://github.com/team-telnyx/telnyx-ruby/commit/f46ab80c6f17a19e1c7aa4120b7690e671d6bb77))
23
+
24
+
25
+ ### Chores
26
+
27
+ * **internal:** more robust bootstrap script ([9f0d291](https://github.com/team-telnyx/telnyx-ruby/commit/9f0d291b8ef718abf05007a0c36402540a320fcd))
28
+
3
29
  ## 5.82.0 (2026-04-22)
4
30
 
5
31
  Full Changelog: [v5.81.0...v5.82.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.81.0...v5.82.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.82.0"
27
+ gem "telnyx", "~> 5.84.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -11,7 +11,11 @@ module Telnyx
11
11
  # key as an integration secret under the `api_key_ref` field. See
12
12
  # [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
13
13
  # for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
14
- # Telnyx.KokoroTTS.af_heart)
14
+ # Telnyx.KokoroTTS.af_heart). The voice portion of the identifier supports
15
+ # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
16
+ # using mustache syntax (e.g. `Telnyx.Ultra.{{voice_id}}`). The variable is
17
+ # resolved at call time from your dynamic variables webhook, allowing you to
18
+ # select the voice dynamically per call.
15
19
  #
16
20
  # @return [String]
17
21
  required :voice, String
@@ -0,0 +1,147 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class CallHoldWebhookEvent < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute data
7
+ #
8
+ # @return [Telnyx::Models::CallHoldWebhookEvent::Data, nil]
9
+ optional :data, -> { Telnyx::CallHoldWebhookEvent::Data }
10
+
11
+ # @!method initialize(data: nil)
12
+ # @param data [Telnyx::Models::CallHoldWebhookEvent::Data]
13
+
14
+ # @see Telnyx::Models::CallHoldWebhookEvent#data
15
+ class Data < Telnyx::Internal::Type::BaseModel
16
+ # @!attribute id
17
+ # Identifies the type of resource.
18
+ #
19
+ # @return [String, nil]
20
+ optional :id, String
21
+
22
+ # @!attribute event_type
23
+ # The type of event being delivered.
24
+ #
25
+ # @return [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::EventType, nil]
26
+ optional :event_type, enum: -> { Telnyx::CallHoldWebhookEvent::Data::EventType }
27
+
28
+ # @!attribute occurred_at
29
+ # ISO 8601 datetime of when the event occurred.
30
+ #
31
+ # @return [Time, nil]
32
+ optional :occurred_at, Time
33
+
34
+ # @!attribute payload
35
+ #
36
+ # @return [Telnyx::Models::CallHoldWebhookEvent::Data::Payload, nil]
37
+ optional :payload, -> { Telnyx::CallHoldWebhookEvent::Data::Payload }
38
+
39
+ # @!attribute record_type
40
+ # Identifies the type of the resource.
41
+ #
42
+ # @return [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::RecordType, nil]
43
+ optional :record_type, enum: -> { Telnyx::CallHoldWebhookEvent::Data::RecordType }
44
+
45
+ # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
46
+ # @param id [String] Identifies the type of resource.
47
+ #
48
+ # @param event_type [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::EventType] The type of event being delivered.
49
+ #
50
+ # @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
51
+ #
52
+ # @param payload [Telnyx::Models::CallHoldWebhookEvent::Data::Payload]
53
+ #
54
+ # @param record_type [Symbol, Telnyx::Models::CallHoldWebhookEvent::Data::RecordType] Identifies the type of the resource.
55
+
56
+ # The type of event being delivered.
57
+ #
58
+ # @see Telnyx::Models::CallHoldWebhookEvent::Data#event_type
59
+ module EventType
60
+ extend Telnyx::Internal::Type::Enum
61
+
62
+ CALL_HOLD = :"call.hold"
63
+
64
+ # @!method self.values
65
+ # @return [Array<Symbol>]
66
+ end
67
+
68
+ # @see Telnyx::Models::CallHoldWebhookEvent::Data#payload
69
+ class Payload < Telnyx::Internal::Type::BaseModel
70
+ # @!attribute call_control_id
71
+ # Call ID used to issue commands via Call Control API.
72
+ #
73
+ # @return [String, nil]
74
+ optional :call_control_id, String
75
+
76
+ # @!attribute call_leg_id
77
+ # ID that is unique to the call and can be used to correlate webhook events.
78
+ #
79
+ # @return [String, nil]
80
+ optional :call_leg_id, String
81
+
82
+ # @!attribute call_session_id
83
+ # ID that is unique to the call session and can be used to correlate webhook
84
+ # events. Call session is a group of related call legs that logically belong to
85
+ # the same phone call, e.g. an inbound and outbound leg of a transferred call.
86
+ #
87
+ # @return [String, nil]
88
+ optional :call_session_id, String
89
+
90
+ # @!attribute client_state
91
+ # State received from a command.
92
+ #
93
+ # @return [String, nil]
94
+ optional :client_state, String
95
+
96
+ # @!attribute connection_id
97
+ # Call Control App ID (formerly Telnyx connection ID) used in the call.
98
+ #
99
+ # @return [String, nil]
100
+ optional :connection_id, String
101
+
102
+ # @!attribute from
103
+ # Number or SIP URI placing the call.
104
+ #
105
+ # @return [String, nil]
106
+ optional :from, String
107
+
108
+ # @!attribute to
109
+ # Destination number or SIP URI of the call.
110
+ #
111
+ # @return [String, nil]
112
+ optional :to, String
113
+
114
+ # @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, to: nil)
115
+ # Some parameter documentations has been truncated, see
116
+ # {Telnyx::Models::CallHoldWebhookEvent::Data::Payload} for more details.
117
+ #
118
+ # @param call_control_id [String] Call ID used to issue commands via Call Control API.
119
+ #
120
+ # @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
121
+ #
122
+ # @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
123
+ #
124
+ # @param client_state [String] State received from a command.
125
+ #
126
+ # @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
127
+ #
128
+ # @param from [String] Number or SIP URI placing the call.
129
+ #
130
+ # @param to [String] Destination number or SIP URI of the call.
131
+ end
132
+
133
+ # Identifies the type of the resource.
134
+ #
135
+ # @see Telnyx::Models::CallHoldWebhookEvent::Data#record_type
136
+ module RecordType
137
+ extend Telnyx::Internal::Type::Enum
138
+
139
+ EVENT = :event
140
+
141
+ # @!method self.values
142
+ # @return [Array<Symbol>]
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
@@ -0,0 +1,147 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ class CallUnholdWebhookEvent < Telnyx::Internal::Type::BaseModel
6
+ # @!attribute data
7
+ #
8
+ # @return [Telnyx::Models::CallUnholdWebhookEvent::Data, nil]
9
+ optional :data, -> { Telnyx::CallUnholdWebhookEvent::Data }
10
+
11
+ # @!method initialize(data: nil)
12
+ # @param data [Telnyx::Models::CallUnholdWebhookEvent::Data]
13
+
14
+ # @see Telnyx::Models::CallUnholdWebhookEvent#data
15
+ class Data < Telnyx::Internal::Type::BaseModel
16
+ # @!attribute id
17
+ # Identifies the type of resource.
18
+ #
19
+ # @return [String, nil]
20
+ optional :id, String
21
+
22
+ # @!attribute event_type
23
+ # The type of event being delivered.
24
+ #
25
+ # @return [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::EventType, nil]
26
+ optional :event_type, enum: -> { Telnyx::CallUnholdWebhookEvent::Data::EventType }
27
+
28
+ # @!attribute occurred_at
29
+ # ISO 8601 datetime of when the event occurred.
30
+ #
31
+ # @return [Time, nil]
32
+ optional :occurred_at, Time
33
+
34
+ # @!attribute payload
35
+ #
36
+ # @return [Telnyx::Models::CallUnholdWebhookEvent::Data::Payload, nil]
37
+ optional :payload, -> { Telnyx::CallUnholdWebhookEvent::Data::Payload }
38
+
39
+ # @!attribute record_type
40
+ # Identifies the type of the resource.
41
+ #
42
+ # @return [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::RecordType, nil]
43
+ optional :record_type, enum: -> { Telnyx::CallUnholdWebhookEvent::Data::RecordType }
44
+
45
+ # @!method initialize(id: nil, event_type: nil, occurred_at: nil, payload: nil, record_type: nil)
46
+ # @param id [String] Identifies the type of resource.
47
+ #
48
+ # @param event_type [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::EventType] The type of event being delivered.
49
+ #
50
+ # @param occurred_at [Time] ISO 8601 datetime of when the event occurred.
51
+ #
52
+ # @param payload [Telnyx::Models::CallUnholdWebhookEvent::Data::Payload]
53
+ #
54
+ # @param record_type [Symbol, Telnyx::Models::CallUnholdWebhookEvent::Data::RecordType] Identifies the type of the resource.
55
+
56
+ # The type of event being delivered.
57
+ #
58
+ # @see Telnyx::Models::CallUnholdWebhookEvent::Data#event_type
59
+ module EventType
60
+ extend Telnyx::Internal::Type::Enum
61
+
62
+ CALL_UNHOLD = :"call.unhold"
63
+
64
+ # @!method self.values
65
+ # @return [Array<Symbol>]
66
+ end
67
+
68
+ # @see Telnyx::Models::CallUnholdWebhookEvent::Data#payload
69
+ class Payload < Telnyx::Internal::Type::BaseModel
70
+ # @!attribute call_control_id
71
+ # Call ID used to issue commands via Call Control API.
72
+ #
73
+ # @return [String, nil]
74
+ optional :call_control_id, String
75
+
76
+ # @!attribute call_leg_id
77
+ # ID that is unique to the call and can be used to correlate webhook events.
78
+ #
79
+ # @return [String, nil]
80
+ optional :call_leg_id, String
81
+
82
+ # @!attribute call_session_id
83
+ # ID that is unique to the call session and can be used to correlate webhook
84
+ # events. Call session is a group of related call legs that logically belong to
85
+ # the same phone call, e.g. an inbound and outbound leg of a transferred call.
86
+ #
87
+ # @return [String, nil]
88
+ optional :call_session_id, String
89
+
90
+ # @!attribute client_state
91
+ # State received from a command.
92
+ #
93
+ # @return [String, nil]
94
+ optional :client_state, String
95
+
96
+ # @!attribute connection_id
97
+ # Call Control App ID (formerly Telnyx connection ID) used in the call.
98
+ #
99
+ # @return [String, nil]
100
+ optional :connection_id, String
101
+
102
+ # @!attribute from
103
+ # Number or SIP URI placing the call.
104
+ #
105
+ # @return [String, nil]
106
+ optional :from, String
107
+
108
+ # @!attribute to
109
+ # Destination number or SIP URI of the call.
110
+ #
111
+ # @return [String, nil]
112
+ optional :to, String
113
+
114
+ # @!method initialize(call_control_id: nil, call_leg_id: nil, call_session_id: nil, client_state: nil, connection_id: nil, from: nil, to: nil)
115
+ # Some parameter documentations has been truncated, see
116
+ # {Telnyx::Models::CallUnholdWebhookEvent::Data::Payload} for more details.
117
+ #
118
+ # @param call_control_id [String] Call ID used to issue commands via Call Control API.
119
+ #
120
+ # @param call_leg_id [String] ID that is unique to the call and can be used to correlate webhook events.
121
+ #
122
+ # @param call_session_id [String] ID that is unique to the call session and can be used to correlate webhook event
123
+ #
124
+ # @param client_state [String] State received from a command.
125
+ #
126
+ # @param connection_id [String] Call Control App ID (formerly Telnyx connection ID) used in the call.
127
+ #
128
+ # @param from [String] Number or SIP URI placing the call.
129
+ #
130
+ # @param to [String] Destination number or SIP URI of the call.
131
+ end
132
+
133
+ # Identifies the type of the resource.
134
+ #
135
+ # @see Telnyx::Models::CallUnholdWebhookEvent::Data#record_type
136
+ module RecordType
137
+ extend Telnyx::Internal::Type::Enum
138
+
139
+ EVENT = :event
140
+
141
+ # @!method self.values
142
+ # @return [Array<Symbol>]
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
@@ -106,7 +106,13 @@ module Telnyx
106
106
  # @return [Hash{Symbol=>Object}, nil]
107
107
  optional :voice_settings, ::Telnyx::Internal::Type::HashOf[::Telnyx::Internal::Type::Unknown]
108
108
 
109
- # @!method initialize(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, request_options: {})
109
+ # @!attribute xai
110
+ # xAI provider-specific parameters.
111
+ #
112
+ # @return [::Telnyx::Models::TextToSpeechGenerateParams::Xai, nil]
113
+ optional :xai, -> { ::Telnyx::TextToSpeechGenerateParams::Xai }
114
+
115
+ # @!method initialize(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, xai: nil, request_options: {})
110
116
  # Some parameter documentations has been truncated, see
111
117
  # {::Telnyx::Models::TextToSpeechGenerateParams} for more details.
112
118
  #
@@ -140,6 +146,8 @@ module Telnyx
140
146
  #
141
147
  # @param voice_settings [Hash{Symbol=>Object}] Provider-specific voice settings. Contents vary by provider — see provider-speci
142
148
  #
149
+ # @param xai [::Telnyx::Models::TextToSpeechGenerateParams::Xai] xAI provider-specific parameters.
150
+ #
143
151
  # @param request_options [::Telnyx::RequestOptions, Hash{Symbol=>Object}]
144
152
 
145
153
  class Aws < ::Telnyx::Internal::Type::BaseModel
@@ -379,6 +387,7 @@ module Telnyx
379
387
  MINIMAX = :minimax
380
388
  RIME = :rime
381
389
  RESEMBLE = :resemble
390
+ XAI = :xai
382
391
 
383
392
  # @!method self.values
384
393
  # @return [Array<Symbol>]
@@ -538,6 +547,92 @@ module Telnyx
538
547
  # @!method self.values
539
548
  # @return [Array<Symbol>]
540
549
  end
550
+
551
+ class Xai < ::Telnyx::Internal::Type::BaseModel
552
+ # @!attribute voice_id
553
+ # xAI voice identifier.
554
+ #
555
+ # @return [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::VoiceID]
556
+ required :voice_id, enum: -> { ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID }
557
+
558
+ # @!attribute language
559
+ # Language code, or `auto` to detect.
560
+ #
561
+ # @return [String, nil]
562
+ optional :language, String
563
+
564
+ # @!attribute output_format
565
+ # Audio output format.
566
+ #
567
+ # @return [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::OutputFormat, nil]
568
+ optional :output_format, enum: -> { ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat }
569
+
570
+ # @!attribute sample_rate
571
+ # Audio sample rate in Hz.
572
+ #
573
+ # @return [Integer, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::SampleRate, nil]
574
+ optional :sample_rate, enum: -> { ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate }
575
+
576
+ # @!method initialize(voice_id:, language: nil, output_format: nil, sample_rate: nil)
577
+ # xAI provider-specific parameters.
578
+ #
579
+ # @param voice_id [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::VoiceID] xAI voice identifier.
580
+ #
581
+ # @param language [String] Language code, or `auto` to detect.
582
+ #
583
+ # @param output_format [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::OutputFormat] Audio output format.
584
+ #
585
+ # @param sample_rate [Integer, ::Telnyx::Models::TextToSpeechGenerateParams::Xai::SampleRate] Audio sample rate in Hz.
586
+
587
+ # xAI voice identifier.
588
+ #
589
+ # @see Telnyx::Models::TextToSpeechGenerateParams::Xai#voice_id
590
+ module VoiceID
591
+ extend ::Telnyx::Internal::Type::Enum
592
+
593
+ EVE = :eve
594
+ ARA = :ara
595
+ REX = :rex
596
+ SAL = :sal
597
+ LEO = :leo
598
+
599
+ # @!method self.values
600
+ # @return [Array<Symbol>]
601
+ end
602
+
603
+ # Audio output format.
604
+ #
605
+ # @see Telnyx::Models::TextToSpeechGenerateParams::Xai#output_format
606
+ module OutputFormat
607
+ extend ::Telnyx::Internal::Type::Enum
608
+
609
+ MP3 = :mp3
610
+ WAV = :wav
611
+ PCM = :pcm
612
+ MULAW = :mulaw
613
+ ALAW = :alaw
614
+
615
+ # @!method self.values
616
+ # @return [Array<Symbol>]
617
+ end
618
+
619
+ # Audio sample rate in Hz.
620
+ #
621
+ # @see Telnyx::Models::TextToSpeechGenerateParams::Xai#sample_rate
622
+ module SampleRate
623
+ extend ::Telnyx::Internal::Type::Enum
624
+
625
+ SAMPLE_RATE_8000 = 8000
626
+ SAMPLE_RATE_16000 = 16_000
627
+ SAMPLE_RATE_22050 = 22_050
628
+ SAMPLE_RATE_24000 = 24_000
629
+ SAMPLE_RATE_44100 = 44_100
630
+ SAMPLE_RATE_48000 = 48_000
631
+
632
+ # @!method self.values
633
+ # @return [Array<Integer>]
634
+ end
635
+ end
541
636
  end
542
637
  end
543
638
  end
@@ -37,6 +37,7 @@ module Telnyx
37
37
  MINIMAX = :minimax
38
38
  RIME = :rime
39
39
  RESEMBLE = :resemble
40
+ XAI = :xai
40
41
 
41
42
  # @!method self.values
42
43
  # @return [Array<Symbol>]
@@ -37,6 +37,8 @@ module Telnyx
37
37
 
38
38
  variant -> { Telnyx::CallHangupWebhookEvent }
39
39
 
40
+ variant -> { Telnyx::CallHoldWebhookEvent }
41
+
40
42
  variant -> { Telnyx::CallInitiatedWebhookEvent }
41
43
 
42
44
  variant -> { Telnyx::CallLeftQueueWebhookEvent }
@@ -81,6 +83,8 @@ module Telnyx
81
83
 
82
84
  variant -> { Telnyx::CallStreamingStoppedWebhookEvent }
83
85
 
86
+ variant -> { Telnyx::CallUnholdWebhookEvent }
87
+
84
88
  variant -> { Telnyx::CampaignStatusUpdate }
85
89
 
86
90
  variant -> { Telnyx::ConferenceCreatedWebhookEvent }
@@ -134,7 +138,7 @@ module Telnyx
134
138
  variant -> { Telnyx::TranscriptionWebhookEvent }
135
139
 
136
140
  # @!method self.variants
137
- # @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
141
+ # @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
138
142
  end
139
143
  end
140
144
  end
@@ -37,6 +37,8 @@ module Telnyx
37
37
 
38
38
  variant -> { Telnyx::CallHangupWebhookEvent }
39
39
 
40
+ variant -> { Telnyx::CallHoldWebhookEvent }
41
+
40
42
  variant -> { Telnyx::CallInitiatedWebhookEvent }
41
43
 
42
44
  variant -> { Telnyx::CallLeftQueueWebhookEvent }
@@ -81,6 +83,8 @@ module Telnyx
81
83
 
82
84
  variant -> { Telnyx::CallStreamingStoppedWebhookEvent }
83
85
 
86
+ variant -> { Telnyx::CallUnholdWebhookEvent }
87
+
84
88
  variant -> { Telnyx::CampaignStatusUpdate }
85
89
 
86
90
  variant -> { Telnyx::ConferenceCreatedWebhookEvent }
@@ -134,7 +138,7 @@ module Telnyx
134
138
  variant -> { Telnyx::TranscriptionWebhookEvent }
135
139
 
136
140
  # @!method self.variants
137
- # @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
141
+ # @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdate, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
138
142
  end
139
143
  end
140
144
  end
data/lib/telnyx/models.rb CHANGED
@@ -245,6 +245,8 @@ module Telnyx
245
245
 
246
246
  CallHangupWebhookEvent = Telnyx::Models::CallHangupWebhookEvent
247
247
 
248
+ CallHoldWebhookEvent = Telnyx::Models::CallHoldWebhookEvent
249
+
248
250
  CallInitiated = Telnyx::Models::CallInitiated
249
251
 
250
252
  CallInitiatedWebhookEvent = Telnyx::Models::CallInitiatedWebhookEvent
@@ -338,6 +340,8 @@ module Telnyx
338
340
 
339
341
  CallStreamingStoppedWebhookEvent = Telnyx::Models::CallStreamingStoppedWebhookEvent
340
342
 
343
+ CallUnholdWebhookEvent = Telnyx::Models::CallUnholdWebhookEvent
344
+
341
345
  CampaignStatusUpdate = Telnyx::Models::CampaignStatusUpdate
342
346
 
343
347
  ChannelZoneListParams = Telnyx::Models::ChannelZoneListParams
@@ -45,6 +45,7 @@ module Telnyx
45
45
  # **Expected Webhooks:**
46
46
  #
47
47
  # - `call.answered`
48
+ # - `call.hold` and `call.unhold` if the call is held/unheld
48
49
  # - `call.deepfake_detection.result` if `deepfake_detection` was enabled
49
50
  # - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
50
51
  # error occurred
@@ -18,6 +18,7 @@ module Telnyx
18
18
  #
19
19
  # - `call.initiated`
20
20
  # - `call.answered` or `call.hangup`
21
+ # - `call.hold` and `call.unhold` if the call is held/unheld
21
22
  # - `call.machine.detection.ended` if `answering_machine_detection` was requested
22
23
  # - `call.machine.greeting.ended` if `answering_machine_detection` was requested
23
24
  # to detect the end of machine greeting
@@ -20,13 +20,13 @@ module Telnyx
20
20
  # with provider-specific parameters.
21
21
  #
22
22
  # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
23
- # `resemble`.
23
+ # `resemble`, `xai`.
24
24
  #
25
25
  # The Telnyx `Ultra` model supports 44 languages with emotion control, speed
26
26
  # adjustment, and volume control. Use the `telnyx` provider-specific parameters to
27
27
  # configure these features.
28
28
  #
29
- # @overload generate(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, request_options: {})
29
+ # @overload generate(aws: nil, azure: nil, disable_cache: nil, elevenlabs: nil, language: nil, minimax: nil, output_type: nil, provider: nil, resemble: nil, rime: nil, telnyx: nil, text: nil, text_type: nil, voice: nil, voice_settings: nil, xai: nil, request_options: {})
30
30
  #
31
31
  # @param aws [::Telnyx::Models::TextToSpeechGenerateParams::Aws] AWS Polly provider-specific parameters.
32
32
  #
@@ -58,6 +58,8 @@ module Telnyx
58
58
  #
59
59
  # @param voice_settings [Hash{Symbol=>Object}] Provider-specific voice settings. Contents vary by provider — see provider-speci
60
60
  #
61
+ # @param xai [::Telnyx::Models::TextToSpeechGenerateParams::Xai] xAI provider-specific parameters.
62
+ #
61
63
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
62
64
  #
63
65
  # @return [Telnyx::Models::TextToSpeechGenerateResponse]