telnyx 5.173.0 → 5.174.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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +0 -4
  5. data/lib/telnyx/lib/access_token.rb +141 -0
  6. data/lib/telnyx/lib/telephony_credentials.rb +87 -0
  7. data/lib/telnyx/lib.rb +2 -0
  8. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings.rb +26 -0
  9. data/lib/telnyx/models/ai/memory/namespaces/namespace_settings_response.rb +3 -41
  10. data/lib/telnyx/models/ai/memory/namespaces/summary_settings.rb +33 -0
  11. data/lib/telnyx/models/ai/transcription_challenger.rb +148 -0
  12. data/lib/telnyx/models/ai/transcription_fallback_model.rb +78 -0
  13. data/lib/telnyx/models/ai/transcription_settings.rb +6 -219
  14. data/lib/telnyx/models/compute/funcs/func_log_export_config.rb +96 -0
  15. data/lib/telnyx/models/compute/funcs/func_log_export_config_response.rb +3 -89
  16. data/lib/telnyx/models/email_template_common.rb +5 -26
  17. data/lib/telnyx/models/email_template_create_params.rb +5 -26
  18. data/lib/telnyx/models/messaging_outbound_message_payload.rb +22 -1
  19. data/lib/telnyx/models/messaging_profile_features.rb +16 -1
  20. data/lib/telnyx/models/model_metadata.rb +10 -1
  21. data/lib/telnyx/models/outbound_message_payload.rb +22 -1
  22. data/lib/telnyx/models/phone_numbers/numbers_phone_numbers_job.rb +6 -50
  23. data/lib/telnyx/models/phone_numbers/phone_numbers_job.rb +6 -50
  24. data/lib/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rb +28 -0
  25. data/lib/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rb +28 -0
  26. data/lib/telnyx/models/update_email_template_request.rb +5 -26
  27. data/lib/telnyx/models/variable_schema_entry.rb +28 -0
  28. data/lib/telnyx/models/whatsapp/hosted_signup_create_response.rb +3 -83
  29. data/lib/telnyx/models/whatsapp/hosted_signup_retrieve_response.rb +3 -84
  30. data/lib/telnyx/models/whatsapp/phone_number_get_response.rb +3 -191
  31. data/lib/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rb +3 -192
  32. data/lib/telnyx/models/whatsapp/{hosted_signup_list_response.rb → whatsapp_hosted_signup.rb} +8 -6
  33. data/lib/telnyx/models/whatsapp/{phone_number_list_response.rb → whatsapp_phone_response.rb} +12 -12
  34. data/lib/telnyx/models.rb +2 -0
  35. data/lib/telnyx/resources/email_templates.rb +3 -3
  36. data/lib/telnyx/resources/portouts.rb +2 -1
  37. data/lib/telnyx/resources/whatsapp/business_accounts/phone_numbers.rb +2 -2
  38. data/lib/telnyx/resources/whatsapp/hosted_signups.rb +2 -2
  39. data/lib/telnyx/resources/whatsapp/phone_numbers.rb +2 -2
  40. data/lib/telnyx/version.rb +1 -1
  41. data/lib/telnyx.rb +10 -5
  42. data/rbi/telnyx/client.rbi +0 -3
  43. data/rbi/telnyx/lib/access_token.rbi +73 -0
  44. data/rbi/telnyx/lib/telephony_credentials.rbi +50 -0
  45. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings.rbi +58 -0
  46. data/rbi/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbi +4 -107
  47. data/rbi/telnyx/models/ai/memory/namespaces/summary_settings.rbi +51 -0
  48. data/rbi/telnyx/models/ai/transcription_challenger.rbi +318 -0
  49. data/rbi/telnyx/models/ai/transcription_fallback_model.rbi +171 -0
  50. data/rbi/telnyx/models/ai/transcription_settings.rbi +7 -531
  51. data/rbi/telnyx/models/compute/funcs/func_log_export_config.rbi +175 -0
  52. data/rbi/telnyx/models/compute/funcs/func_log_export_config_response.rbi +4 -176
  53. data/rbi/telnyx/models/email_template_common.rbi +3 -56
  54. data/rbi/telnyx/models/email_template_create_params.rbi +3 -59
  55. data/rbi/telnyx/models/messaging_outbound_message_payload.rbi +26 -0
  56. data/rbi/telnyx/models/messaging_profile_features.rbi +36 -5
  57. data/rbi/telnyx/models/model_metadata.rbi +13 -0
  58. data/rbi/telnyx/models/outbound_message_payload.rbi +26 -0
  59. data/rbi/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbi +8 -96
  60. data/rbi/telnyx/models/phone_numbers/phone_numbers_job.rbi +8 -94
  61. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbi +49 -0
  62. data/rbi/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbi +49 -0
  63. data/rbi/telnyx/models/update_email_template_request.rbi +3 -59
  64. data/rbi/telnyx/models/variable_schema_entry.rbi +40 -0
  65. data/rbi/telnyx/models/whatsapp/hosted_signup_create_response.rbi +6 -173
  66. data/rbi/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbi +6 -175
  67. data/rbi/telnyx/models/whatsapp/phone_number_get_response.rbi +4 -366
  68. data/rbi/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbi +6 -368
  69. data/rbi/telnyx/models/whatsapp/{hosted_signup_list_response.rbi → whatsapp_hosted_signup.rbi} +11 -12
  70. data/rbi/telnyx/models/whatsapp/{phone_number_list_response.rbi → whatsapp_phone_response.rbi} +23 -23
  71. data/rbi/telnyx/models.rbi +2 -0
  72. data/rbi/telnyx/resources/email_templates.rbi +3 -18
  73. data/rbi/telnyx/resources/portouts.rbi +2 -1
  74. data/rbi/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbi +1 -1
  75. data/rbi/telnyx/resources/whatsapp/hosted_signups.rbi +1 -1
  76. data/rbi/telnyx/resources/whatsapp/phone_numbers.rbi +1 -1
  77. data/sig/telnyx/client.rbs +0 -2
  78. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings.rbs +30 -0
  79. data/sig/telnyx/models/ai/memory/namespaces/namespace_settings_response.rbs +4 -37
  80. data/sig/telnyx/models/ai/memory/namespaces/summary_settings.rbs +19 -0
  81. data/sig/telnyx/models/ai/transcription_challenger.rbs +98 -0
  82. data/sig/telnyx/models/ai/transcription_fallback_model.rbs +63 -0
  83. data/sig/telnyx/models/ai/transcription_settings.rbs +8 -159
  84. data/sig/telnyx/models/compute/funcs/func_log_export_config.rbs +96 -0
  85. data/sig/telnyx/models/compute/funcs/func_log_export_config_response.rbs +6 -95
  86. data/sig/telnyx/models/email_template_common.rbs +4 -18
  87. data/sig/telnyx/models/email_template_create_params.rbs +4 -18
  88. data/sig/telnyx/models/messaging_outbound_message_payload.rbs +10 -0
  89. data/sig/telnyx/models/messaging_profile_features.rbs +14 -3
  90. data/sig/telnyx/models/model_metadata.rbs +7 -0
  91. data/sig/telnyx/models/outbound_message_payload.rbs +10 -0
  92. data/sig/telnyx/models/phone_numbers/numbers_phone_numbers_job.rbs +12 -44
  93. data/sig/telnyx/models/phone_numbers/phone_numbers_job.rbs +12 -44
  94. data/sig/telnyx/models/phone_numbers/phone_numbers_job_pending_operation.rbs +24 -0
  95. data/sig/telnyx/models/phone_numbers/phone_numbers_job_successful_operation.rbs +24 -0
  96. data/sig/telnyx/models/update_email_template_request.rbs +4 -18
  97. data/sig/telnyx/models/variable_schema_entry.rbs +17 -0
  98. data/sig/telnyx/models/whatsapp/hosted_signup_create_response.rbs +6 -90
  99. data/sig/telnyx/models/whatsapp/hosted_signup_retrieve_response.rbs +6 -90
  100. data/sig/telnyx/models/whatsapp/phone_number_get_response.rbs +6 -185
  101. data/sig/telnyx/models/whatsapp/phone_number_retrieve_phone_number_response.rbs +4 -189
  102. data/sig/telnyx/models/whatsapp/{hosted_signup_list_response.rbs → whatsapp_hosted_signup.rbs} +11 -9
  103. data/sig/telnyx/models/whatsapp/{phone_number_list_response.rbs → whatsapp_phone_response.rbs} +13 -11
  104. data/sig/telnyx/models.rbs +2 -0
  105. data/sig/telnyx/resources/email_templates.rbs +3 -3
  106. data/sig/telnyx/resources/whatsapp/business_accounts/phone_numbers.rbs +1 -1
  107. data/sig/telnyx/resources/whatsapp/hosted_signups.rbs +1 -1
  108. data/sig/telnyx/resources/whatsapp/phone_numbers.rbs +1 -1
  109. metadata +36 -17
  110. data/lib/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rb +0 -198
  111. data/lib/telnyx/resources/tts_integrations/actions.rb +0 -16
  112. data/lib/telnyx/resources/tts_integrations.rb +0 -18
  113. data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi +0 -358
  114. data/rbi/telnyx/resources/tts_integrations/actions.rbi +0 -14
  115. data/rbi/telnyx/resources/tts_integrations.rbi +0 -15
  116. data/sig/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbs +0 -186
  117. data/sig/telnyx/resources/tts_integrations/actions.rbs +0 -9
  118. data/sig/telnyx/resources/tts_integrations.rbs +0 -9
@@ -15,8 +15,8 @@ module Telnyx
15
15
  # A second speech-to-text model that transcribes alongside `transcription.model`,
16
16
  # and the rule that decides which transcript the assistant uses.
17
17
  #
18
- # @return [Telnyx::Models::AI::TranscriptionSettings::Challenger, nil]
19
- optional :challenger, -> { Telnyx::AI::TranscriptionSettings::Challenger }, nil?: true
18
+ # @return [Telnyx::Models::AI::TranscriptionChallenger, nil]
19
+ optional :challenger, -> { Telnyx::AI::TranscriptionChallenger }, nil?: true
20
20
 
21
21
  # @!attribute fallback_models
22
22
  # Up to 3 streaming models that take over transcription, in this order, when the
@@ -28,9 +28,9 @@ module Telnyx
28
28
  # Can't be combined with `challenger`, the language booster; to replace a stored
29
29
  # language booster, send `challenger: null` in the same request.
30
30
  #
31
- # @return [Array<Telnyx::Models::AI::TranscriptionSettings::FallbackModel>, nil]
31
+ # @return [Array<Telnyx::Models::AI::TranscriptionFallbackModel>, nil]
32
32
  optional :fallback_models,
33
- -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::TranscriptionSettings::FallbackModel] },
33
+ -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::TranscriptionFallbackModel] },
34
34
  nil?: true
35
35
 
36
36
  # @!attribute language
@@ -114,9 +114,9 @@ module Telnyx
114
114
  #
115
115
  # @param api_key_ref [String] Integration secret identifier for the transcription provider API key. Currently
116
116
  #
117
- # @param challenger [Telnyx::Models::AI::TranscriptionSettings::Challenger, nil] A second speech-to-text model that transcribes alongside `transcription.model`,
117
+ # @param challenger [Telnyx::Models::AI::TranscriptionChallenger, nil] A second speech-to-text model that transcribes alongside `transcription.model`,
118
118
  #
119
- # @param fallback_models [Array<Telnyx::Models::AI::TranscriptionSettings::FallbackModel>, nil] Up to 3 streaming models that take over transcription, in this order, when the m
119
+ # @param fallback_models [Array<Telnyx::Models::AI::TranscriptionFallbackModel>, nil] Up to 3 streaming models that take over transcription, in this order, when the m
120
120
  #
121
121
  # @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, su
122
122
  #
@@ -126,219 +126,6 @@ module Telnyx
126
126
  #
127
127
  # @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig]
128
128
 
129
- # @see Telnyx::Models::AI::TranscriptionSettings#challenger
130
- class Challenger < Telnyx::Internal::Type::BaseModel
131
- # @!attribute model
132
- # The language booster's model. It must be the same kind of model as
133
- # `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
134
- # `deepgram/nova-2`, `assemblyai/universal-3-6-pro` or its legacy aliases
135
- # `assemblyai/universal-3-5-pro` and `assemblyai/universal-streaming`,
136
- # `xai/grok-stt`, `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`,
137
- # `reson8/turns`) or both non-streaming (`azure/fast`, `nvidia/parakeet-v3`,
138
- # `omi-health/omi-med-stt-v1`, `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
139
- # `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
140
- # `transcription.model` on a different `language`.
141
- #
142
- # @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Model]
143
- required :model, enum: -> { Telnyx::AI::TranscriptionSettings::Challenger::Model }
144
-
145
- # @!attribute language
146
- # The language this model transcribes. Omit it or set it to `null` to use the
147
- # language of `transcription.model`. The request is rejected when this model
148
- # doesn't support the language it would run. It is also rejected when it would run
149
- # the same model on the same language as `transcription.model`.
150
- #
151
- # @return [String, nil]
152
- optional :language, String, nil?: true
153
-
154
- # @!attribute rule
155
- # How the assistant picks the transcript it uses. The models are compared on how
156
- # complete and confident their transcripts are, not on language, so the rules work
157
- # best when both models understand the callers' language.
158
- #
159
- # - `best_turn` (default): both models transcribe the whole call. Each turn uses
160
- # the language booster's transcript only when it scores higher than the
161
- # transcript of `transcription.model` (clearly higher with non-streaming
162
- # models). With streaming models, `transcription.model` also decides when each
163
- # turn ends. Available for every pair.
164
- # - `best_engine`: both models transcribe the first turns, then the call continues
165
- # alone on the model whose transcripts scored higher. If neither clearly leads,
166
- # `transcription.model` continues. Streaming models only.
167
- # - `merge_words`: both models transcribe each utterance and their words are
168
- # merged, keeping Arabic and English spoken in the same sentence. Available only
169
- # for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
170
- # the language that applies to `telnyx/basira` (its own, or that of
171
- # `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
172
- # `multi`, or `auto`.
173
- #
174
- # @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Rule, nil]
175
- optional :rule, enum: -> { Telnyx::AI::TranscriptionSettings::Challenger::Rule }
176
-
177
- # @!attribute settings
178
- # Settings for the language booster, with the same fields and limits as
179
- # `transcription.settings`. Fields that don't apply to this model's provider are
180
- # dropped, and the provider's defaults fill in the rest. Omit it or set it to
181
- # `null` to use the settings of `transcription.model` where they apply to this
182
- # model.
183
- #
184
- # @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
185
- optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }, nil?: true
186
-
187
- # @!method initialize(model:, language: nil, rule: nil, settings: nil)
188
- # Some parameter documentations has been truncated, see
189
- # {Telnyx::Models::AI::TranscriptionSettings::Challenger} for more details.
190
- #
191
- # A second speech-to-text model that transcribes alongside `transcription.model`,
192
- # and the rule that decides which transcript the assistant uses.
193
- #
194
- # @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Model] The language booster's model. It must be the same kind of model as `transcriptio
195
- #
196
- # @param language [String, nil] The language this model transcribes. Omit it or set it to `null` to use the lang
197
- #
198
- # @param rule [Symbol, Telnyx::Models::AI::TranscriptionSettings::Challenger::Rule] How the assistant picks the transcript it uses. The models are compared on how c
199
- #
200
- # @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig, nil] Settings for the language booster, with the same fields and limits as `transcrip
201
-
202
- # The language booster's model. It must be the same kind of model as
203
- # `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
204
- # `deepgram/nova-2`, `assemblyai/universal-3-6-pro` or its legacy aliases
205
- # `assemblyai/universal-3-5-pro` and `assemblyai/universal-streaming`,
206
- # `xai/grok-stt`, `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`,
207
- # `reson8/turns`) or both non-streaming (`azure/fast`, `nvidia/parakeet-v3`,
208
- # `omi-health/omi-med-stt-v1`, `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
209
- # `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
210
- # `transcription.model` on a different `language`.
211
- #
212
- # @see Telnyx::Models::AI::TranscriptionSettings::Challenger#model
213
- module Model
214
- extend Telnyx::Internal::Type::Enum
215
-
216
- DEEPGRAM_FLUX = :"deepgram/flux"
217
- DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
218
- DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
219
- AZURE_FAST = :"azure/fast"
220
- ASSEMBLYAI_UNIVERSAL_3_6_PRO = :"assemblyai/universal-3-6-pro"
221
- ASSEMBLYAI_UNIVERSAL_3_5_PRO = :"assemblyai/universal-3-5-pro"
222
- ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
223
- XAI_GROK_STT = :"xai/grok-stt"
224
- SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
225
- SONIOX_STT_RT_V5 = :"soniox/stt-rt-v5"
226
- NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
227
- OMI_HEALTH_OMI_MED_STT_V1 = :"omi-health/omi-med-stt-v1"
228
- HUMAIN_REALTIME = :"humain/realtime"
229
- RESON8_TURNS = :"reson8/turns"
230
- COHERE_AR_STT = :"cohere/ar-stt"
231
- TELNYX_BASIRA = :"telnyx/basira"
232
- DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
233
- OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
234
-
235
- # @!method self.values
236
- # @return [Array<Symbol>]
237
- end
238
-
239
- # How the assistant picks the transcript it uses. The models are compared on how
240
- # complete and confident their transcripts are, not on language, so the rules work
241
- # best when both models understand the callers' language.
242
- #
243
- # - `best_turn` (default): both models transcribe the whole call. Each turn uses
244
- # the language booster's transcript only when it scores higher than the
245
- # transcript of `transcription.model` (clearly higher with non-streaming
246
- # models). With streaming models, `transcription.model` also decides when each
247
- # turn ends. Available for every pair.
248
- # - `best_engine`: both models transcribe the first turns, then the call continues
249
- # alone on the model whose transcripts scored higher. If neither clearly leads,
250
- # `transcription.model` continues. Streaming models only.
251
- # - `merge_words`: both models transcribe each utterance and their words are
252
- # merged, keeping Arabic and English spoken in the same sentence. Available only
253
- # for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
254
- # the language that applies to `telnyx/basira` (its own, or that of
255
- # `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
256
- # `multi`, or `auto`.
257
- #
258
- # @see Telnyx::Models::AI::TranscriptionSettings::Challenger#rule
259
- module Rule
260
- extend Telnyx::Internal::Type::Enum
261
-
262
- BEST_TURN = :best_turn
263
- BEST_ENGINE = :best_engine
264
- MERGE_WORDS = :merge_words
265
-
266
- # @!method self.values
267
- # @return [Array<Symbol>]
268
- end
269
- end
270
-
271
- class FallbackModel < Telnyx::Internal::Type::BaseModel
272
- # @!attribute model
273
- # The fallback model. It must be a streaming model other than
274
- # `transcription.model` and the other fallbacks: `deepgram/flux`,
275
- # `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-6-pro` (or its
276
- # legacy aliases `assemblyai/universal-3-5-pro` and
277
- # `assemblyai/universal-streaming`), `xai/grok-stt`, `soniox/stt-rt-v4`,
278
- # `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
279
- #
280
- # @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::FallbackModel::Model]
281
- required :model, enum: -> { Telnyx::AI::TranscriptionSettings::FallbackModel::Model }
282
-
283
- # @!attribute language
284
- # The language the fallback transcribes. Omit it or set it to `null` to use the
285
- # language of `transcription.model`. The request is rejected when the fallback
286
- # model doesn't support the language it would run.
287
- #
288
- # @return [String, nil]
289
- optional :language, String, nil?: true
290
-
291
- # @!attribute settings
292
- # Settings for the fallback, with the same fields and limits as
293
- # `transcription.settings`. Fields that don't apply to this model's provider are
294
- # dropped, and the provider's defaults fill in the rest. Omit it or set it to
295
- # `null` to use the settings of `transcription.model` where they apply to this
296
- # model.
297
- #
298
- # @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
299
- optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }, nil?: true
300
-
301
- # @!method initialize(model:, language: nil, settings: nil)
302
- # Some parameter documentations has been truncated, see
303
- # {Telnyx::Models::AI::TranscriptionSettings::FallbackModel} for more details.
304
- #
305
- # A streaming speech-to-text model that takes over transcription when the model in
306
- # use fails.
307
- #
308
- # @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::FallbackModel::Model] The fallback model. It must be a streaming model other than `transcription.model
309
- #
310
- # @param language [String, nil] The language the fallback transcribes. Omit it or set it to `null` to use the la
311
- #
312
- # @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig, nil] Settings for the fallback, with the same fields and limits as `transcription.set
313
-
314
- # The fallback model. It must be a streaming model other than
315
- # `transcription.model` and the other fallbacks: `deepgram/flux`,
316
- # `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-6-pro` (or its
317
- # legacy aliases `assemblyai/universal-3-5-pro` and
318
- # `assemblyai/universal-streaming`), `xai/grok-stt`, `soniox/stt-rt-v4`,
319
- # `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
320
- #
321
- # @see Telnyx::Models::AI::TranscriptionSettings::FallbackModel#model
322
- module Model
323
- extend Telnyx::Internal::Type::Enum
324
-
325
- DEEPGRAM_FLUX = :"deepgram/flux"
326
- DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
327
- DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
328
- ASSEMBLYAI_UNIVERSAL_3_6_PRO = :"assemblyai/universal-3-6-pro"
329
- ASSEMBLYAI_UNIVERSAL_3_5_PRO = :"assemblyai/universal-3-5-pro"
330
- ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
331
- XAI_GROK_STT = :"xai/grok-stt"
332
- SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
333
- SONIOX_STT_RT_V5 = :"soniox/stt-rt-v5"
334
- HUMAIN_REALTIME = :"humain/realtime"
335
- RESON8_TURNS = :"reson8/turns"
336
-
337
- # @!method self.values
338
- # @return [Array<Symbol>]
339
- end
340
- end
341
-
342
129
  # The speech to text model to be used by the voice assistant. All Deepgram models
343
130
  # are run on-premise.
344
131
  #
@@ -0,0 +1,96 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module Compute
6
+ module Funcs
7
+ class FuncLogExportConfig < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute id
9
+ # Configuration record ID
10
+ #
11
+ # @return [String, nil]
12
+ optional :id, String
13
+
14
+ # @!attribute created_at
15
+ #
16
+ # @return [Time, nil]
17
+ optional :created_at, Time
18
+
19
+ # @!attribute enabled
20
+ # Whether export is enabled for this function
21
+ #
22
+ # @return [Boolean, nil]
23
+ optional :enabled, Telnyx::Internal::Type::Boolean
24
+
25
+ # @!attribute endpoint
26
+ # HTTPS OTLP endpoint URL logs are pushed to
27
+ #
28
+ # @return [String, nil]
29
+ optional :endpoint, String
30
+
31
+ # @!attribute func_id
32
+ # Function ID this configuration belongs to
33
+ #
34
+ # @return [String, nil]
35
+ optional :func_id, String
36
+
37
+ # @!attribute invocation_export_enabled
38
+ # Whether invocation records (one per HTTP request) are exported
39
+ #
40
+ # @return [Boolean, nil]
41
+ optional :invocation_export_enabled, Telnyx::Internal::Type::Boolean
42
+
43
+ # @!attribute record_type
44
+ #
45
+ # @return [Symbol, Telnyx::Models::Compute::Funcs::FuncLogExportConfig::RecordType, nil]
46
+ optional :record_type, enum: -> { Telnyx::Compute::Funcs::FuncLogExportConfig::RecordType }
47
+
48
+ # @!attribute runtime_export_enabled
49
+ # Whether runtime logs (function stdout/stderr) are exported
50
+ #
51
+ # @return [Boolean, nil]
52
+ optional :runtime_export_enabled, Telnyx::Internal::Type::Boolean
53
+
54
+ # @!attribute updated_at
55
+ #
56
+ # @return [Time, nil]
57
+ optional :updated_at, Time
58
+
59
+ # @!method initialize(id: nil, created_at: nil, enabled: nil, endpoint: nil, func_id: nil, invocation_export_enabled: nil, record_type: nil, runtime_export_enabled: nil, updated_at: nil)
60
+ # Metadata-only view of a function's log export destination. Header values are
61
+ # write-only (encrypted server-side) and never appear in any response.
62
+ #
63
+ # @param id [String] Configuration record ID
64
+ #
65
+ # @param created_at [Time]
66
+ #
67
+ # @param enabled [Boolean] Whether export is enabled for this function
68
+ #
69
+ # @param endpoint [String] HTTPS OTLP endpoint URL logs are pushed to
70
+ #
71
+ # @param func_id [String] Function ID this configuration belongs to
72
+ #
73
+ # @param invocation_export_enabled [Boolean] Whether invocation records (one per HTTP request) are exported
74
+ #
75
+ # @param record_type [Symbol, Telnyx::Models::Compute::Funcs::FuncLogExportConfig::RecordType]
76
+ #
77
+ # @param runtime_export_enabled [Boolean] Whether runtime logs (function stdout/stderr) are exported
78
+ #
79
+ # @param updated_at [Time]
80
+
81
+ # @see Telnyx::Models::Compute::Funcs::FuncLogExportConfig#record_type
82
+ module RecordType
83
+ extend Telnyx::Internal::Type::Enum
84
+
85
+ COMPUTE_FUNC_LOG_EXPORT_CONFIG = :compute_func_log_export_config
86
+
87
+ # @!method self.values
88
+ # @return [Array<Symbol>]
89
+ end
90
+ end
91
+ end
92
+
93
+ FuncLogExportConfig = Funcs::FuncLogExportConfig
94
+ end
95
+ end
96
+ end
@@ -10,100 +10,14 @@ module Telnyx
10
10
  # Metadata-only view of a function's log export destination. Header values are
11
11
  # write-only (encrypted server-side) and never appear in any response.
12
12
  #
13
- # @return [Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse::Data, nil]
14
- optional :data, -> { Telnyx::Compute::Funcs::FuncLogExportConfigResponse::Data }
13
+ # @return [Telnyx::Models::Compute::Funcs::FuncLogExportConfig, nil]
14
+ optional :data, -> { Telnyx::Compute::Funcs::FuncLogExportConfig }
15
15
 
16
16
  # @!method initialize(data: nil)
17
17
  # Some parameter documentations has been truncated, see
18
18
  # {Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse} for more details.
19
19
  #
20
- # @param data [Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse::Data] Metadata-only view of a function's log export destination. Header values are wri
21
-
22
- # @see Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse#data
23
- class Data < Telnyx::Internal::Type::BaseModel
24
- # @!attribute id
25
- # Configuration record ID
26
- #
27
- # @return [String, nil]
28
- optional :id, String
29
-
30
- # @!attribute created_at
31
- #
32
- # @return [Time, nil]
33
- optional :created_at, Time
34
-
35
- # @!attribute enabled
36
- # Whether export is enabled for this function
37
- #
38
- # @return [Boolean, nil]
39
- optional :enabled, Telnyx::Internal::Type::Boolean
40
-
41
- # @!attribute endpoint
42
- # HTTPS OTLP endpoint URL logs are pushed to
43
- #
44
- # @return [String, nil]
45
- optional :endpoint, String
46
-
47
- # @!attribute func_id
48
- # Function ID this configuration belongs to
49
- #
50
- # @return [String, nil]
51
- optional :func_id, String
52
-
53
- # @!attribute invocation_export_enabled
54
- # Whether invocation records (one per HTTP request) are exported
55
- #
56
- # @return [Boolean, nil]
57
- optional :invocation_export_enabled, Telnyx::Internal::Type::Boolean
58
-
59
- # @!attribute record_type
60
- #
61
- # @return [Symbol, Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse::Data::RecordType, nil]
62
- optional :record_type, enum: -> { Telnyx::Compute::Funcs::FuncLogExportConfigResponse::Data::RecordType }
63
-
64
- # @!attribute runtime_export_enabled
65
- # Whether runtime logs (function stdout/stderr) are exported
66
- #
67
- # @return [Boolean, nil]
68
- optional :runtime_export_enabled, Telnyx::Internal::Type::Boolean
69
-
70
- # @!attribute updated_at
71
- #
72
- # @return [Time, nil]
73
- optional :updated_at, Time
74
-
75
- # @!method initialize(id: nil, created_at: nil, enabled: nil, endpoint: nil, func_id: nil, invocation_export_enabled: nil, record_type: nil, runtime_export_enabled: nil, updated_at: nil)
76
- # Metadata-only view of a function's log export destination. Header values are
77
- # write-only (encrypted server-side) and never appear in any response.
78
- #
79
- # @param id [String] Configuration record ID
80
- #
81
- # @param created_at [Time]
82
- #
83
- # @param enabled [Boolean] Whether export is enabled for this function
84
- #
85
- # @param endpoint [String] HTTPS OTLP endpoint URL logs are pushed to
86
- #
87
- # @param func_id [String] Function ID this configuration belongs to
88
- #
89
- # @param invocation_export_enabled [Boolean] Whether invocation records (one per HTTP request) are exported
90
- #
91
- # @param record_type [Symbol, Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse::Data::RecordType]
92
- #
93
- # @param runtime_export_enabled [Boolean] Whether runtime logs (function stdout/stderr) are exported
94
- #
95
- # @param updated_at [Time]
96
-
97
- # @see Telnyx::Models::Compute::Funcs::FuncLogExportConfigResponse::Data#record_type
98
- module RecordType
99
- extend Telnyx::Internal::Type::Enum
100
-
101
- COMPUTE_FUNC_LOG_EXPORT_CONFIG = :compute_func_log_export_config
102
-
103
- # @!method self.values
104
- # @return [Array<Symbol>]
105
- end
106
- end
20
+ # @param data [Telnyx::Models::Compute::Funcs::FuncLogExportConfig] Metadata-only view of a function's log export destination. Header values are wri
107
21
  end
108
22
  end
109
23
 
@@ -58,9 +58,11 @@ module Telnyx
58
58
  # Structured variable requirements, or `null` when the template uses only the
59
59
  # legacy `variables` array.
60
60
  #
61
- # @return [Hash{Symbol=>Telnyx::Models::EmailTemplateCommon::VariableSchema}, nil]
61
+ # @return [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil]
62
62
  required :variable_schema,
63
- -> { Telnyx::Internal::Type::HashOf[Telnyx::EmailTemplateCommon::VariableSchema] },
63
+ -> {
64
+ Telnyx::Internal::Type::HashOf[Telnyx::VariableSchemaEntry]
65
+ },
64
66
  nil?: true
65
67
 
66
68
  # @!attribute variables
@@ -100,7 +102,7 @@ module Telnyx
100
102
  #
101
103
  # @param updated_at [Time]
102
104
  #
103
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplateCommon::VariableSchema}, nil] Structured variable requirements, or `null` when the template uses only the lega
105
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Structured variable requirements, or `null` when the template uses only the lega
104
106
  #
105
107
  # @param variables [Array<String>] Persisted variable names. In `explicit` mode this array preserves the exact prov
106
108
  #
@@ -116,29 +118,6 @@ module Telnyx
116
118
  # @return [Array<Symbol>]
117
119
  end
118
120
 
119
- class VariableSchema < Telnyx::Internal::Type::BaseModel
120
- # @!attribute required
121
- # Whether the variable must be supplied when strict variable validation is
122
- # enabled.
123
- #
124
- # @return [Boolean]
125
- required :required, Telnyx::Internal::Type::Boolean
126
-
127
- # @!attribute default
128
- # Default value for an optional variable. Rejected when `required` is `true`.
129
- #
130
- # @return [String, nil]
131
- optional :default, String
132
-
133
- # @!method initialize(required:, default: nil)
134
- # Some parameter documentations has been truncated, see
135
- # {Telnyx::Models::EmailTemplateCommon::VariableSchema} for more details.
136
- #
137
- # @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
138
- #
139
- # @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
140
- end
141
-
142
121
  # `automatic` when variable names are derived from template content; `explicit`
143
122
  # when `variables` is the exact manually managed array.
144
123
  #
@@ -64,9 +64,11 @@ module Telnyx
64
64
  # such as `false` and `0` pass (they are present, not empty). Optional variables
65
65
  # fall back to their `default` when absent.
66
66
  #
67
- # @return [Hash{Symbol=>Telnyx::Models::EmailTemplateCreateParams::VariableSchema}, nil]
67
+ # @return [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil]
68
68
  optional :variable_schema,
69
- -> { Telnyx::Internal::Type::HashOf[Telnyx::EmailTemplateCreateParams::VariableSchema] },
69
+ -> {
70
+ Telnyx::Internal::Type::HashOf[Telnyx::VariableSchemaEntry]
71
+ },
70
72
  nil?: true
71
73
 
72
74
  # @!attribute variables
@@ -109,7 +111,7 @@ module Telnyx
109
111
  #
110
112
  # @param text_body [String, nil] Liquid template text body.
111
113
  #
112
- # @param variable_schema [Hash{Symbol=>Telnyx::Models::EmailTemplateCreateParams::VariableSchema}, nil] Structured variable requirements. Required variables cannot define defaults; inv
114
+ # @param variable_schema [Hash{Symbol=>Telnyx::Models::VariableSchemaEntry}, nil] Structured variable requirements. Required variables cannot define defaults; inv
113
115
  #
114
116
  # @param variables [Array<String>, nil] Persisted variable names. In `automatic` mode a non-null array is rejected; in `
115
117
  #
@@ -119,29 +121,6 @@ module Telnyx
119
121
  #
120
122
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
121
123
 
122
- class VariableSchema < Telnyx::Internal::Type::BaseModel
123
- # @!attribute required
124
- # Whether the variable must be supplied when strict variable validation is
125
- # enabled.
126
- #
127
- # @return [Boolean]
128
- required :required, Telnyx::Internal::Type::Boolean
129
-
130
- # @!attribute default
131
- # Default value for an optional variable. Rejected when `required` is `true`.
132
- #
133
- # @return [String, nil]
134
- optional :default, String
135
-
136
- # @!method initialize(required:, default: nil)
137
- # Some parameter documentations has been truncated, see
138
- # {Telnyx::Models::EmailTemplateCreateParams::VariableSchema} for more details.
139
- #
140
- # @param required [Boolean] Whether the variable must be supplied when strict variable validation is enabled
141
- #
142
- # @param default [String] Default value for an optional variable. Rejected when `required` is `true`.
143
- end
144
-
145
124
  # Controls how `variables` is maintained. If both fields are omitted (or
146
125
  # `variables` is null), the template uses `automatic` mode and extracts variable
147
126
  # names from the effective subject, HTML body, and text body. A non-null
@@ -21,6 +21,14 @@ module Telnyx
21
21
  # @return [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>, nil]
22
22
  optional :cc, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MessagingOutboundMessagePayload::Cc] }
23
23
 
24
+ # @!attribute child_message_id
25
+ # Identifies the next chunk when server-side SMS chunking
26
+ # (`auto_chunk_long_messages` on the messaging profile) split this message. Always
27
+ # present; null on non-chunked messages and on the final chunk.
28
+ #
29
+ # @return [String, nil]
30
+ optional :child_message_id, String, nil?: true
31
+
24
32
  # @!attribute completed_at
25
33
  # ISO 8601 formatted date indicating when the message was finalized.
26
34
  #
@@ -86,6 +94,15 @@ module Telnyx
86
94
  # @return [String, nil]
87
95
  optional :organization_id, String
88
96
 
97
+ # @!attribute parent_message_id
98
+ # Identifies the original request's message when server-side SMS chunking
99
+ # (`auto_chunk_long_messages` on the messaging profile) split it into chunks. The
100
+ # first chunk's ID is the original request's message ID. Always present; null when
101
+ # this message is not part of a chunked send.
102
+ #
103
+ # @return [String, nil]
104
+ optional :parent_message_id, String, nil?: true
105
+
89
106
  # @!attribute parts
90
107
  # Number of parts into which the message's body must be split.
91
108
  #
@@ -210,7 +227,7 @@ module Telnyx
210
227
  # @return [String, nil]
211
228
  optional :webhook_url, String, nil?: true
212
229
 
213
- # @!method initialize(id: nil, body: nil, cc: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, template_id: nil, template_name: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
230
+ # @!method initialize(id: nil, body: nil, cc: nil, child_message_id: nil, completed_at: nil, cost: nil, cost_breakdown: nil, direction: nil, encoding: nil, errors: nil, from: nil, media: nil, messaging_profile_id: nil, num_chars: nil, organization_id: nil, parent_message_id: nil, parts: nil, received_at: nil, record_type: nil, sent_at: nil, smart_encoding_applied: nil, subject: nil, tags: nil, tcr_campaign_billable: nil, tcr_campaign_id: nil, tcr_campaign_registered: nil, template_id: nil, template_name: nil, text: nil, to: nil, type: nil, valid_until: nil, wait_seconds: nil, webhook_failover_url: nil, webhook_url: nil)
214
231
  # Some parameter documentations has been truncated, see
215
232
  # {Telnyx::Models::MessagingOutboundMessagePayload} for more details.
216
233
  #
@@ -220,6 +237,8 @@ module Telnyx
220
237
  #
221
238
  # @param cc [Array<Telnyx::Models::MessagingOutboundMessagePayload::Cc>]
222
239
  #
240
+ # @param child_message_id [String, nil] Identifies the next chunk when server-side SMS chunking (`auto_chunk_long_messag
241
+ #
223
242
  # @param completed_at [Time, nil] ISO 8601 formatted date indicating when the message was finalized.
224
243
  #
225
244
  # @param cost [Telnyx::Models::MessagingOutboundMessagePayload::Cost, nil]
@@ -242,6 +261,8 @@ module Telnyx
242
261
  #
243
262
  # @param organization_id [String] The id of the organization the messaging profile belongs to.
244
263
  #
264
+ # @param parent_message_id [String, nil] Identifies the original request's message when server-side SMS chunking (`auto_c
265
+ #
245
266
  # @param parts [Integer] Number of parts into which the message's body must be split.
246
267
  #
247
268
  # @param received_at [Time] ISO 8601 formatted date indicating when the message request was received.
@@ -12,7 +12,20 @@ module Telnyx
12
12
  # @return [Boolean, nil]
13
13
  optional :ai_opt_out_detection_enabled, Telnyx::Internal::Type::Boolean
14
14
 
15
- # @!method initialize(ai_opt_out_detection_enabled: nil)
15
+ # @!attribute auto_chunk_long_messages
16
+ # Enables server-side chunking of outbound SMS. When enabled, an outbound message
17
+ # that exceeds the maximum number of segments allowed for its destination (10
18
+ # segments by default; some aggregators accept up to 25) is automatically split
19
+ # into multiple child messages, each within the segment limit, and sent
20
+ # sequentially in order. Splitting is encoding-aware: GSM-7 bodies split at
21
+ # 153-character boundaries and UCS-2 bodies at 134-byte (67-character) boundaries.
22
+ # When disabled (the default), messages exceeding the segment limit are rejected
23
+ # with an error.
24
+ #
25
+ # @return [Boolean, nil]
26
+ optional :auto_chunk_long_messages, Telnyx::Internal::Type::Boolean
27
+
28
+ # @!method initialize(ai_opt_out_detection_enabled: nil, auto_chunk_long_messages: nil)
16
29
  # Some parameter documentations has been truncated, see
17
30
  # {Telnyx::Models::MessagingProfileFeatures} for more details.
18
31
  #
@@ -21,6 +34,8 @@ module Telnyx
21
34
  # preserved for forward compatibility with rolling deployments.
22
35
  #
23
36
  # @param ai_opt_out_detection_enabled [Boolean] Enables AI detection of inbound opt-out messages that do not follow the standard
37
+ #
38
+ # @param auto_chunk_long_messages [Boolean] Enables server-side chunking of outbound SMS. When enabled, an outbound message
24
39
  end
25
40
  end
26
41
  end