telnyx 5.103.0 → 5.104.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 (214) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +9 -170
  5. data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
  6. data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
  7. data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
  8. data/lib/telnyx/models/ai/assistant_update_params.rb +9 -170
  9. data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
  10. data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
  11. data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
  12. data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
  13. data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
  14. data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
  15. data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
  16. data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -171
  17. data/lib/telnyx/models/ai/inference_embedding.rb +9 -169
  18. data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
  19. data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -31
  20. data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
  21. data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
  22. data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
  23. data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -31
  24. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
  25. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
  26. data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
  27. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
  28. data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
  29. data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
  30. data/lib/telnyx/models/calls/transcription_start_request.rb +5 -167
  31. data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
  32. data/lib/telnyx/models/model_metadata.rb +33 -0
  33. data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
  34. data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
  35. data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
  36. data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
  37. data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
  38. data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
  39. data/lib/telnyx/models/uac_connection.rb +412 -0
  40. data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
  41. data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
  42. data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
  43. data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
  44. data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
  45. data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
  46. data/lib/telnyx/models/uac_external_settings.rb +101 -0
  47. data/lib/telnyx/models/uac_inbound.rb +210 -0
  48. data/lib/telnyx/models/uac_internal_settings.rb +25 -0
  49. data/lib/telnyx/models/uac_outbound.rb +131 -0
  50. data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
  51. data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
  52. data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
  53. data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
  54. data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
  55. data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
  56. data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
  57. data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
  58. data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
  59. data/lib/telnyx/models/xai_voice_settings.rb +36 -0
  60. data/lib/telnyx/models.rb +20 -0
  61. data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
  62. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  63. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  64. data/lib/telnyx/resources/calls/actions.rb +5 -5
  65. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  66. data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
  67. data/lib/telnyx/resources/uac_connections.rb +8 -8
  68. data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
  69. data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
  70. data/lib/telnyx/version.rb +1 -1
  71. data/lib/telnyx.rb +22 -4
  72. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -341
  73. data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
  74. data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
  75. data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
  76. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -341
  77. data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
  78. data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
  79. data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
  80. data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
  81. data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
  82. data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
  83. data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
  84. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -355
  85. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -340
  86. data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
  87. data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -56
  88. data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
  89. data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
  90. data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
  91. data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -51
  92. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
  93. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
  94. data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
  95. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
  96. data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
  97. data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
  98. data/rbi/telnyx/models/calls/transcription_start_request.rbi +10 -480
  99. data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
  100. data/rbi/telnyx/models/model_metadata.rbi +44 -0
  101. data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
  102. data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
  103. data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
  104. data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
  105. data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
  106. data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
  107. data/rbi/telnyx/models/uac_connection.rbi +684 -0
  108. data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
  109. data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
  110. data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
  111. data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
  112. data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
  113. data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
  114. data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
  115. data/rbi/telnyx/models/uac_inbound.rbi +410 -0
  116. data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
  117. data/rbi/telnyx/models/uac_outbound.rbi +224 -0
  118. data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
  119. data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
  120. data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
  121. data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
  122. data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
  123. data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
  124. data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
  125. data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
  126. data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
  127. data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
  128. data/rbi/telnyx/models.rbi +20 -0
  129. data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
  130. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
  131. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  132. data/rbi/telnyx/resources/calls/actions.rbi +6 -6
  133. data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
  134. data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
  135. data/rbi/telnyx/resources/uac_connections.rbi +7 -13
  136. data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
  137. data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
  138. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -142
  139. data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
  140. data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
  141. data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
  142. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -142
  143. data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
  144. data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
  145. data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
  146. data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
  147. data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
  148. data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
  149. data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
  150. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -145
  151. data/sig/telnyx/models/ai/inference_embedding.rbs +18 -142
  152. data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
  153. data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -39
  154. data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
  155. data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
  156. data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
  157. data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -39
  158. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
  159. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
  160. data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
  161. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
  162. data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
  163. data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
  164. data/sig/telnyx/models/calls/transcription_start_request.rbs +2 -184
  165. data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
  166. data/sig/telnyx/models/model_metadata.rbs +32 -0
  167. data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
  168. data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
  169. data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
  170. data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
  171. data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
  172. data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
  173. data/sig/telnyx/models/uac_connection.rbs +338 -0
  174. data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
  175. data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
  176. data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
  177. data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
  178. data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
  179. data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
  180. data/sig/telnyx/models/uac_external_settings.rbs +73 -0
  181. data/sig/telnyx/models/uac_inbound.rbs +190 -0
  182. data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
  183. data/sig/telnyx/models/uac_outbound.rbs +113 -0
  184. data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
  185. data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
  186. data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
  187. data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
  188. data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
  189. data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
  190. data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
  191. data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
  192. data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
  193. data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
  194. data/sig/telnyx/models.rbs +20 -0
  195. data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
  196. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  197. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  198. data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
  199. data/sig/telnyx/resources/uac_connections.rbs +7 -7
  200. data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
  201. data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
  202. metadata +68 -14
  203. data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
  204. data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
  205. data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
  206. data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
  207. data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
  208. data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
  209. data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
  210. data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
  211. data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
  212. data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
  213. data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
  214. data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
@@ -72,8 +72,8 @@ module Telnyx
72
72
  # External SIP peer settings used by Telnyx when registering to your PBX and
73
73
  # routing outbound calls.
74
74
  #
75
- # @return [Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings, nil]
76
- optional :external_uac_settings, -> { Telnyx::UacConnectionCreateParams::ExternalUacSettings }
75
+ # @return [Telnyx::Models::UacExternalSettings, nil]
76
+ optional :external_uac_settings, -> { Telnyx::UacExternalSettings }
77
77
 
78
78
  # @!attribute inbound
79
79
  # Inbound settings that can be supplied when creating or updating a UAC
@@ -86,8 +86,8 @@ module Telnyx
86
86
  # @!attribute internal_uac_settings
87
87
  # Internal Telnyx-side settings for a UAC connection.
88
88
  #
89
- # @return [Telnyx::Models::UacConnectionCreateParams::InternalUacSettings, nil]
90
- optional :internal_uac_settings, -> { Telnyx::UacConnectionCreateParams::InternalUacSettings }
89
+ # @return [Telnyx::Models::UacInternalSettings, nil]
90
+ optional :internal_uac_settings, -> { Telnyx::UacInternalSettings }
91
91
 
92
92
  # @!attribute ios_push_credential_id
93
93
  # The uuid of the push credential for Ios
@@ -133,8 +133,8 @@ module Telnyx
133
133
 
134
134
  # @!attribute outbound
135
135
  #
136
- # @return [Telnyx::Models::UacConnectionCreateParams::Outbound, nil]
137
- optional :outbound, -> { Telnyx::UacConnectionCreateParams::Outbound }
136
+ # @return [Telnyx::Models::UacOutbound, nil]
137
+ optional :outbound, -> { Telnyx::UacOutbound }
138
138
 
139
139
  # @!attribute password
140
140
  # The password to be used as part of the credentials. Must be 8 to 128 characters
@@ -222,11 +222,11 @@ module Telnyx
222
222
  #
223
223
  # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
224
224
  #
225
- # @param external_uac_settings [Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
225
+ # @param external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
226
226
  #
227
227
  # @param inbound [Telnyx::Models::UacConnectionCreateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
228
228
  #
229
- # @param internal_uac_settings [Telnyx::Models::UacConnectionCreateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
229
+ # @param internal_uac_settings [Telnyx::Models::UacInternalSettings] Internal Telnyx-side settings for a UAC connection.
230
230
  #
231
231
  # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
232
232
  #
@@ -238,7 +238,7 @@ module Telnyx
238
238
  #
239
239
  # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
240
240
  #
241
- # @param outbound [Telnyx::Models::UacConnectionCreateParams::Outbound]
241
+ # @param outbound [Telnyx::Models::UacOutbound]
242
242
  #
243
243
  # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
244
244
  #
@@ -260,105 +260,6 @@ module Telnyx
260
260
  #
261
261
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
262
262
 
263
- class ExternalUacSettings < Telnyx::Internal::Type::BaseModel
264
- # @!attribute auth_username
265
- # The authentication username used in SIP digest authentication. If not set, the
266
- # Username value will be used.
267
- #
268
- # @return [String, nil]
269
- optional :auth_username, String, nil?: true
270
-
271
- # @!attribute expiration_sec
272
- # The registration interval, in seconds, indicating how often the system refreshes
273
- # the SIP registration with the external SIP peer.
274
- #
275
- # @return [Integer, nil]
276
- optional :expiration_sec, Integer, nil?: true
277
-
278
- # @!attribute from_user
279
- # The user portion of the SIP From header used in outbound requests. This controls
280
- # the caller identity presented to the external SIP peer.
281
- #
282
- # @return [String, nil]
283
- optional :from_user, String, nil?: true
284
-
285
- # @!attribute outbound_proxy
286
- # An optional SIP proxy used to route outbound requests before reaching the
287
- # external SIP peer.
288
- #
289
- # @return [String, nil]
290
- optional :outbound_proxy, String, nil?: true
291
-
292
- # @!attribute password
293
- # The SIP password used for digest authentication with the external SIP peer.
294
- #
295
- # @return [String, nil]
296
- optional :password, String
297
-
298
- # @!attribute proxy
299
- # The SIP proxy address of the external SIP peer used for registrations and
300
- # outbound call routing.
301
- #
302
- # @return [String, nil]
303
- optional :proxy, String
304
-
305
- # @!attribute transport
306
- # The transport protocol used for SIP signaling when communicating with the
307
- # external SIP peer. One of UDP, TLS, or TCP.
308
- #
309
- # @return [Symbol, Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings::Transport, nil]
310
- optional :transport,
311
- enum: -> { Telnyx::UacConnectionCreateParams::ExternalUacSettings::Transport },
312
- nil?: true
313
-
314
- # @!attribute username
315
- # The SIP username used to authenticate with the external SIP peer for
316
- # registrations and outbound calls. Must start with a letter or number and contain
317
- # only letters, numbers, hyphens, and underscores.
318
- #
319
- # @return [String, nil]
320
- optional :username, String
321
-
322
- # @!method initialize(auth_username: nil, expiration_sec: nil, from_user: nil, outbound_proxy: nil, password: nil, proxy: nil, transport: nil, username: nil)
323
- # Some parameter documentations has been truncated, see
324
- # {Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings} for more
325
- # details.
326
- #
327
- # External SIP peer settings used by Telnyx when registering to your PBX and
328
- # routing outbound calls.
329
- #
330
- # @param auth_username [String, nil] The authentication username used in SIP digest authentication. If not set, the U
331
- #
332
- # @param expiration_sec [Integer, nil] The registration interval, in seconds, indicating how often the system refreshes
333
- #
334
- # @param from_user [String, nil] The user portion of the SIP From header used in outbound requests. This controls
335
- #
336
- # @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
337
- #
338
- # @param password [String] The SIP password used for digest authentication with the external SIP peer.
339
- #
340
- # @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
341
- #
342
- # @param transport [Symbol, Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings::Transport, nil] The transport protocol used for SIP signaling when communicating with the extern
343
- #
344
- # @param username [String] The SIP username used to authenticate with the external SIP peer for registratio
345
-
346
- # The transport protocol used for SIP signaling when communicating with the
347
- # external SIP peer. One of UDP, TLS, or TCP.
348
- #
349
- # @see Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings#transport
350
- module Transport
351
- extend Telnyx::Internal::Type::Enum
352
-
353
- UDP = :UDP
354
- TLS = :TLS
355
- TCP = :TCP
356
-
357
- # @!method self.values
358
- # @return [Array<Symbol>]
359
- end
360
- end
361
-
362
263
  class Inbound < Telnyx::Internal::Type::BaseModel
363
264
  # @!attribute ani_number_format
364
265
  # This setting allows you to set the format with which the caller's number (ANI)
@@ -541,27 +442,6 @@ module Telnyx
541
442
  end
542
443
  end
543
444
 
544
- class InternalUacSettings < Telnyx::Internal::Type::BaseModel
545
- # @!attribute destination_uri
546
- # The SIP URI that Telnyx will call when handling an inbound request from the
547
- # external peer. Do not include a `sip:` prefix. The value must be in the format
548
- # `userinfo@[subdomain.]sip.telnyx.com` or
549
- # `userinfo@[subdomain.]sipdev.telnyx.com`; the userinfo portion may contain only
550
- # letters, digits, hyphens, and underscores.
551
- #
552
- # @return [String, nil]
553
- optional :destination_uri, String
554
-
555
- # @!method initialize(destination_uri: nil)
556
- # Some parameter documentations has been truncated, see
557
- # {Telnyx::Models::UacConnectionCreateParams::InternalUacSettings} for more
558
- # details.
559
- #
560
- # Internal Telnyx-side settings for a UAC connection.
561
- #
562
- # @param destination_uri [String] The SIP URI that Telnyx will call when handling an inbound request from the exte
563
- end
564
-
565
445
  # Controls when noise suppression is applied to calls. When set to 'inbound',
566
446
  # noise suppression is applied to incoming audio. When set to 'outbound', it's
567
447
  # applied to outgoing audio. When set to 'both', it's applied in both directions.
@@ -578,132 +458,6 @@ module Telnyx
578
458
  # @return [Array<Symbol>]
579
459
  end
580
460
 
581
- class Outbound < Telnyx::Internal::Type::BaseModel
582
- # @!attribute ani_override
583
- # Set a phone number as the ani_override value to override caller id number on
584
- # outbound calls.
585
- #
586
- # @return [String, nil]
587
- optional :ani_override, String
588
-
589
- # @!attribute ani_override_type
590
- # Specifies when we apply your ani_override setting. Only applies when
591
- # ani_override is not blank.
592
- #
593
- # @return [Symbol, Telnyx::Models::UacConnectionCreateParams::Outbound::AniOverrideType, nil]
594
- optional :ani_override_type, enum: -> { Telnyx::UacConnectionCreateParams::Outbound::AniOverrideType }
595
-
596
- # @!attribute call_parking_enabled
597
- # Forces all SIP calls originated on this connection to be "parked" instead of
598
- # "bridged" to the destination specified on the URI. Parked calls will return
599
- # ringback to the caller and will await for a Call Control command to define which
600
- # action will be taken next.
601
- #
602
- # @return [Boolean, nil]
603
- optional :call_parking_enabled, Telnyx::Internal::Type::Boolean, nil?: true
604
-
605
- # @!attribute channel_limit
606
- # When set, this will limit the total number of outbound calls to phone numbers
607
- # associated with this connection.
608
- #
609
- # @return [Integer, nil]
610
- optional :channel_limit, Integer
611
-
612
- # @!attribute generate_ringback_tone
613
- # Generate ringback tone through 183 session progress message with early media.
614
- #
615
- # @return [Boolean, nil]
616
- optional :generate_ringback_tone, Telnyx::Internal::Type::Boolean
617
-
618
- # @!attribute instant_ringback_enabled
619
- # When set, ringback will not wait for indication before sending ringback tone to
620
- # calling party.
621
- #
622
- # @return [Boolean, nil]
623
- optional :instant_ringback_enabled, Telnyx::Internal::Type::Boolean
624
-
625
- # @!attribute localization
626
- # A 2-character country code specifying the country whose national dialing rules
627
- # should be used. For example, if set to `US` then any US number can be dialed
628
- # without preprending +1 to the number. When left blank, Telnyx will try US and GB
629
- # dialing rules, in that order, by default.
630
- #
631
- # @return [String, nil]
632
- optional :localization, String
633
-
634
- # @!attribute outbound_voice_profile_id
635
- # Identifies the associated outbound voice profile.
636
- #
637
- # @return [String, nil]
638
- optional :outbound_voice_profile_id, String
639
-
640
- # @!attribute t38_reinvite_source
641
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
642
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
643
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
644
- # expected to send the t.38 reinvite.
645
- #
646
- # @return [Symbol, Telnyx::Models::UacConnectionCreateParams::Outbound::T38ReinviteSource, nil]
647
- optional :t38_reinvite_source, enum: -> { Telnyx::UacConnectionCreateParams::Outbound::T38ReinviteSource }
648
-
649
- # @!method initialize(ani_override: nil, ani_override_type: nil, call_parking_enabled: nil, channel_limit: nil, generate_ringback_tone: nil, instant_ringback_enabled: nil, localization: nil, outbound_voice_profile_id: nil, t38_reinvite_source: nil)
650
- # Some parameter documentations has been truncated, see
651
- # {Telnyx::Models::UacConnectionCreateParams::Outbound} for more details.
652
- #
653
- # @param ani_override [String] Set a phone number as the ani_override value to override caller id number on out
654
- #
655
- # @param ani_override_type [Symbol, Telnyx::Models::UacConnectionCreateParams::Outbound::AniOverrideType] Specifies when we apply your ani_override setting. Only applies when ani_overrid
656
- #
657
- # @param call_parking_enabled [Boolean, nil] Forces all SIP calls originated on this connection to be "parked" instead of "br
658
- #
659
- # @param channel_limit [Integer] When set, this will limit the total number of outbound calls to phone numbers as
660
- #
661
- # @param generate_ringback_tone [Boolean] Generate ringback tone through 183 session progress message with early media.
662
- #
663
- # @param instant_ringback_enabled [Boolean] When set, ringback will not wait for indication before sending ringback tone to
664
- #
665
- # @param localization [String] A 2-character country code specifying the country whose national dialing rules s
666
- #
667
- # @param outbound_voice_profile_id [String] Identifies the associated outbound voice profile.
668
- #
669
- # @param t38_reinvite_source [Symbol, Telnyx::Models::UacConnectionCreateParams::Outbound::T38ReinviteSource] This setting only affects connections with Fax-type Outbound Voice Profiles. The
670
-
671
- # Specifies when we apply your ani_override setting. Only applies when
672
- # ani_override is not blank.
673
- #
674
- # @see Telnyx::Models::UacConnectionCreateParams::Outbound#ani_override_type
675
- module AniOverrideType
676
- extend Telnyx::Internal::Type::Enum
677
-
678
- ALWAYS = :always
679
- NORMAL = :normal
680
- EMERGENCY = :emergency
681
-
682
- # @!method self.values
683
- # @return [Array<Symbol>]
684
- end
685
-
686
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
687
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
688
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
689
- # expected to send the t.38 reinvite.
690
- #
691
- # @see Telnyx::Models::UacConnectionCreateParams::Outbound#t38_reinvite_source
692
- module T38ReinviteSource
693
- extend Telnyx::Internal::Type::Enum
694
-
695
- TELNYX = :telnyx
696
- CUSTOMER = :customer
697
- DISABLED = :disabled
698
- PASSTHRU = :passthru
699
- CALLER_PASSTHRU = :"caller-passthru"
700
- CALLEE_PASSTHRU = :"callee-passthru"
701
-
702
- # @!method self.values
703
- # @return [Array<Symbol>]
704
- end
705
- end
706
-
707
461
  # This feature enables inbound SIP URI calls to your Credential Auth Connection.
708
462
  # If enabled for all (unrestricted) then anyone who calls the SIP URI
709
463
  # <your-username>@telnyx.com will be connected to your Connection. You can also