telnyx 5.112.0 → 5.113.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 (261) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
  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 -178
  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 -179
  17. data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
  18. data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
  19. data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
  20. data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
  21. data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
  22. data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
  23. data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
  24. data/lib/telnyx/models/ai_create_response_params.rb +4 -4
  25. data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
  26. data/lib/telnyx/models/call_conversation_ended.rb +13 -1
  27. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
  28. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
  29. data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
  30. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
  31. data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +169 -118
  32. data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
  33. data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
  34. data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
  35. data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
  36. data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
  37. data/lib/telnyx/models/fax.rb +7 -5
  38. data/lib/telnyx/models/fax_create_params.rb +7 -5
  39. data/lib/telnyx/models/fax_delivered.rb +3 -2
  40. data/lib/telnyx/models/fax_failed.rb +3 -2
  41. data/lib/telnyx/models/fax_media_processed.rb +3 -2
  42. data/lib/telnyx/models/fax_queued.rb +3 -2
  43. data/lib/telnyx/models/fax_sending_started.rb +3 -2
  44. data/lib/telnyx/models/model_metadata.rb +212 -0
  45. data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
  46. data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
  47. data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
  48. data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
  49. data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
  50. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
  51. data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
  52. data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
  53. data/lib/telnyx/models/uac_connection.rb +412 -0
  54. data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
  55. data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
  56. data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
  57. data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
  58. data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
  59. data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
  60. data/lib/telnyx/models/uac_external_settings.rb +101 -0
  61. data/lib/telnyx/models/uac_inbound.rb +210 -0
  62. data/lib/telnyx/models/uac_internal_settings.rb +25 -0
  63. data/lib/telnyx/models/uac_outbound.rb +131 -0
  64. data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
  65. data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
  66. data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
  67. data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
  68. data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
  69. data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
  70. data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
  71. data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
  72. data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
  73. data/lib/telnyx/models/xai_voice_settings.rb +36 -0
  74. data/lib/telnyx/models.rb +20 -0
  75. data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
  76. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  77. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  78. data/lib/telnyx/resources/ai/openai.rb +1 -1
  79. data/lib/telnyx/resources/ai.rb +3 -3
  80. data/lib/telnyx/resources/calls/actions.rb +15 -17
  81. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  82. data/lib/telnyx/resources/faxes.rb +13 -1
  83. data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
  84. data/lib/telnyx/resources/texml.rb +4 -2
  85. data/lib/telnyx/resources/uac_connections.rb +8 -8
  86. data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
  87. data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
  88. data/lib/telnyx/version.rb +1 -1
  89. data/lib/telnyx.rb +23 -4
  90. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
  91. data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
  92. data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
  93. data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
  94. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -352
  95. data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
  96. data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
  97. data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
  98. data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
  99. data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
  100. data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
  101. data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
  102. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -366
  103. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
  104. data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
  105. data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
  106. data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
  107. data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
  108. data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
  109. data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
  110. data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
  111. data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
  112. data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
  113. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
  114. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
  115. data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
  116. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
  117. data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +371 -254
  118. data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
  119. data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
  120. data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
  121. data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
  122. data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
  123. data/rbi/telnyx/models/fax.rbi +12 -8
  124. data/rbi/telnyx/models/fax_create_params.rbi +12 -8
  125. data/rbi/telnyx/models/fax_delivered.rbi +6 -4
  126. data/rbi/telnyx/models/fax_failed.rbi +6 -4
  127. data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
  128. data/rbi/telnyx/models/fax_queued.rbi +6 -4
  129. data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
  130. data/rbi/telnyx/models/model_metadata.rbi +272 -0
  131. data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
  132. data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
  133. data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
  134. data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
  135. data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
  136. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
  137. data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
  138. data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
  139. data/rbi/telnyx/models/uac_connection.rbi +684 -0
  140. data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
  141. data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
  142. data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
  143. data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
  144. data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
  145. data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
  146. data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
  147. data/rbi/telnyx/models/uac_inbound.rbi +410 -0
  148. data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
  149. data/rbi/telnyx/models/uac_outbound.rbi +224 -0
  150. data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
  151. data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
  152. data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
  153. data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
  154. data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
  155. data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
  156. data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
  157. data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
  158. data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
  159. data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
  160. data/rbi/telnyx/models.rbi +20 -0
  161. data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
  162. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
  163. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  164. data/rbi/telnyx/resources/ai/openai.rbi +1 -1
  165. data/rbi/telnyx/resources/ai.rbi +2 -2
  166. data/rbi/telnyx/resources/calls/actions.rbi +24 -24
  167. data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
  168. data/rbi/telnyx/resources/faxes.rbi +18 -4
  169. data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
  170. data/rbi/telnyx/resources/texml.rbi +7 -1
  171. data/rbi/telnyx/resources/uac_connections.rbi +7 -13
  172. data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
  173. data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
  174. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -149
  175. data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
  176. data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
  177. data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
  178. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -149
  179. data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
  180. data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
  181. data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
  182. data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
  183. data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
  184. data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
  185. data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
  186. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -152
  187. data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
  188. data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
  189. data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
  190. data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
  191. data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
  192. data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
  193. data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
  194. data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
  195. data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
  196. data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
  197. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
  198. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
  199. data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
  200. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
  201. data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +141 -102
  202. data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
  203. data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
  204. data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
  205. data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
  206. data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
  207. data/sig/telnyx/models/model_metadata.rbs +142 -0
  208. data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
  209. data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
  210. data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
  211. data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
  212. data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
  213. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
  214. data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
  215. data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
  216. data/sig/telnyx/models/uac_connection.rbs +338 -0
  217. data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
  218. data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
  219. data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
  220. data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
  221. data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
  222. data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
  223. data/sig/telnyx/models/uac_external_settings.rbs +73 -0
  224. data/sig/telnyx/models/uac_inbound.rbs +190 -0
  225. data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
  226. data/sig/telnyx/models/uac_outbound.rbs +113 -0
  227. data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
  228. data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
  229. data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
  230. data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
  231. data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
  232. data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
  233. data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
  234. data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
  235. data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
  236. data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
  237. data/sig/telnyx/models.rbs +20 -0
  238. data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
  239. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  240. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  241. data/sig/telnyx/resources/ai/openai.rbs +1 -1
  242. data/sig/telnyx/resources/ai.rbs +1 -1
  243. data/sig/telnyx/resources/calls/actions.rbs +2 -4
  244. data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
  245. data/sig/telnyx/resources/texml.rbs +1 -0
  246. data/sig/telnyx/resources/uac_connections.rbs +7 -7
  247. data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
  248. data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
  249. metadata +71 -14
  250. data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
  251. data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
  252. data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
  253. data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
  254. data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
  255. data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
  256. data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
  257. data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
  258. data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
  259. data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
  260. data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
  261. data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
@@ -82,18 +82,11 @@ module Telnyx
82
82
 
83
83
  # External SIP peer settings used by Telnyx when registering to your PBX and
84
84
  # routing outbound calls.
85
- sig do
86
- returns(
87
- T.nilable(Telnyx::UacConnectionUpdateParams::ExternalUacSettings)
88
- )
89
- end
85
+ sig { returns(T.nilable(Telnyx::UacExternalSettings)) }
90
86
  attr_reader :external_uac_settings
91
87
 
92
88
  sig do
93
- params(
94
- external_uac_settings:
95
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::OrHash
96
- ).void
89
+ params(external_uac_settings: Telnyx::UacExternalSettings::OrHash).void
97
90
  end
98
91
  attr_writer :external_uac_settings
99
92
 
@@ -109,18 +102,11 @@ module Telnyx
109
102
  attr_writer :inbound
110
103
 
111
104
  # Internal Telnyx-side settings for a UAC connection.
112
- sig do
113
- returns(
114
- T.nilable(Telnyx::UacConnectionUpdateParams::InternalUacSettings)
115
- )
116
- end
105
+ sig { returns(T.nilable(Telnyx::UacInternalSettings)) }
117
106
  attr_reader :internal_uac_settings
118
107
 
119
108
  sig do
120
- params(
121
- internal_uac_settings:
122
- Telnyx::UacConnectionUpdateParams::InternalUacSettings::OrHash
123
- ).void
109
+ params(internal_uac_settings: Telnyx::UacInternalSettings::OrHash).void
124
110
  end
125
111
  attr_writer :internal_uac_settings
126
112
 
@@ -184,14 +170,10 @@ module Telnyx
184
170
  sig { params(onnet_t38_passthrough_enabled: T::Boolean).void }
185
171
  attr_writer :onnet_t38_passthrough_enabled
186
172
 
187
- sig { returns(T.nilable(Telnyx::UacConnectionUpdateParams::Outbound)) }
173
+ sig { returns(T.nilable(Telnyx::UacOutbound)) }
188
174
  attr_reader :outbound
189
175
 
190
- sig do
191
- params(
192
- outbound: Telnyx::UacConnectionUpdateParams::Outbound::OrHash
193
- ).void
194
- end
176
+ sig { params(outbound: Telnyx::UacOutbound::OrHash).void }
195
177
  attr_writer :outbound
196
178
 
197
179
  # The password to be used as part of the credentials. Must be 8 to 128 characters
@@ -292,11 +274,9 @@ module Telnyx
292
274
  dtmf_type: Telnyx::DtmfType::OrSymbol,
293
275
  encode_contact_header_enabled: T::Boolean,
294
276
  encrypted_media: T.nilable(Telnyx::EncryptedMedia::OrSymbol),
295
- external_uac_settings:
296
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::OrHash,
277
+ external_uac_settings: Telnyx::UacExternalSettings::OrHash,
297
278
  inbound: Telnyx::UacConnectionUpdateParams::Inbound::OrHash,
298
- internal_uac_settings:
299
- Telnyx::UacConnectionUpdateParams::InternalUacSettings::OrHash,
279
+ internal_uac_settings: Telnyx::UacInternalSettings::OrHash,
300
280
  ios_push_credential_id: T.nilable(String),
301
281
  jitter_buffer: Telnyx::ConnectionJitterBuffer::OrHash,
302
282
  noise_suppression:
@@ -304,7 +284,7 @@ module Telnyx
304
284
  noise_suppression_details:
305
285
  Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
306
286
  onnet_t38_passthrough_enabled: T::Boolean,
307
- outbound: Telnyx::UacConnectionUpdateParams::Outbound::OrHash,
287
+ outbound: Telnyx::UacOutbound::OrHash,
308
288
  password: String,
309
289
  rtcp_settings: Telnyx::ConnectionRtcpSettings::OrHash,
310
290
  sip_uri_calling_preference:
@@ -420,11 +400,9 @@ module Telnyx
420
400
  dtmf_type: Telnyx::DtmfType::OrSymbol,
421
401
  encode_contact_header_enabled: T::Boolean,
422
402
  encrypted_media: T.nilable(Telnyx::EncryptedMedia::OrSymbol),
423
- external_uac_settings:
424
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings,
403
+ external_uac_settings: Telnyx::UacExternalSettings,
425
404
  inbound: Telnyx::UacConnectionUpdateParams::Inbound,
426
- internal_uac_settings:
427
- Telnyx::UacConnectionUpdateParams::InternalUacSettings,
405
+ internal_uac_settings: Telnyx::UacInternalSettings,
428
406
  ios_push_credential_id: T.nilable(String),
429
407
  jitter_buffer: Telnyx::ConnectionJitterBuffer,
430
408
  noise_suppression:
@@ -432,7 +410,7 @@ module Telnyx
432
410
  noise_suppression_details:
433
411
  Telnyx::ConnectionNoiseSuppressionDetails,
434
412
  onnet_t38_passthrough_enabled: T::Boolean,
435
- outbound: Telnyx::UacConnectionUpdateParams::Outbound,
413
+ outbound: Telnyx::UacOutbound,
436
414
  password: String,
437
415
  rtcp_settings: Telnyx::ConnectionRtcpSettings,
438
416
  sip_uri_calling_preference:
@@ -451,177 +429,6 @@ module Telnyx
451
429
  def to_hash
452
430
  end
453
431
 
454
- class ExternalUacSettings < Telnyx::Internal::Type::BaseModel
455
- OrHash =
456
- T.type_alias do
457
- T.any(
458
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings,
459
- Telnyx::Internal::AnyHash
460
- )
461
- end
462
-
463
- # The authentication username used in SIP digest authentication. If not set, the
464
- # Username value will be used.
465
- sig { returns(T.nilable(String)) }
466
- attr_accessor :auth_username
467
-
468
- # The registration interval, in seconds, indicating how often the system refreshes
469
- # the SIP registration with the external SIP peer.
470
- sig { returns(T.nilable(Integer)) }
471
- attr_accessor :expiration_sec
472
-
473
- # The user portion of the SIP From header used in outbound requests. This controls
474
- # the caller identity presented to the external SIP peer.
475
- sig { returns(T.nilable(String)) }
476
- attr_accessor :from_user
477
-
478
- # An optional SIP proxy used to route outbound requests before reaching the
479
- # external SIP peer.
480
- sig { returns(T.nilable(String)) }
481
- attr_accessor :outbound_proxy
482
-
483
- # The SIP password used for digest authentication with the external SIP peer.
484
- sig { returns(T.nilable(String)) }
485
- attr_reader :password
486
-
487
- sig { params(password: String).void }
488
- attr_writer :password
489
-
490
- # The SIP proxy address of the external SIP peer used for registrations and
491
- # outbound call routing.
492
- sig { returns(T.nilable(String)) }
493
- attr_reader :proxy
494
-
495
- sig { params(proxy: String).void }
496
- attr_writer :proxy
497
-
498
- # The transport protocol used for SIP signaling when communicating with the
499
- # external SIP peer. One of UDP, TLS, or TCP.
500
- sig do
501
- returns(
502
- T.nilable(
503
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::OrSymbol
504
- )
505
- )
506
- end
507
- attr_accessor :transport
508
-
509
- # The SIP username used to authenticate with the external SIP peer for
510
- # registrations and outbound calls. Must start with a letter or number and contain
511
- # only letters, numbers, hyphens, and underscores.
512
- sig { returns(T.nilable(String)) }
513
- attr_reader :username
514
-
515
- sig { params(username: String).void }
516
- attr_writer :username
517
-
518
- # External SIP peer settings used by Telnyx when registering to your PBX and
519
- # routing outbound calls.
520
- sig do
521
- params(
522
- auth_username: T.nilable(String),
523
- expiration_sec: T.nilable(Integer),
524
- from_user: T.nilable(String),
525
- outbound_proxy: T.nilable(String),
526
- password: String,
527
- proxy: String,
528
- transport:
529
- T.nilable(
530
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::OrSymbol
531
- ),
532
- username: String
533
- ).returns(T.attached_class)
534
- end
535
- def self.new(
536
- # The authentication username used in SIP digest authentication. If not set, the
537
- # Username value will be used.
538
- auth_username: nil,
539
- # The registration interval, in seconds, indicating how often the system refreshes
540
- # the SIP registration with the external SIP peer.
541
- expiration_sec: nil,
542
- # The user portion of the SIP From header used in outbound requests. This controls
543
- # the caller identity presented to the external SIP peer.
544
- from_user: nil,
545
- # An optional SIP proxy used to route outbound requests before reaching the
546
- # external SIP peer.
547
- outbound_proxy: nil,
548
- # The SIP password used for digest authentication with the external SIP peer.
549
- password: nil,
550
- # The SIP proxy address of the external SIP peer used for registrations and
551
- # outbound call routing.
552
- proxy: nil,
553
- # The transport protocol used for SIP signaling when communicating with the
554
- # external SIP peer. One of UDP, TLS, or TCP.
555
- transport: nil,
556
- # The SIP username used to authenticate with the external SIP peer for
557
- # registrations and outbound calls. Must start with a letter or number and contain
558
- # only letters, numbers, hyphens, and underscores.
559
- username: nil
560
- )
561
- end
562
-
563
- sig do
564
- override.returns(
565
- {
566
- auth_username: T.nilable(String),
567
- expiration_sec: T.nilable(Integer),
568
- from_user: T.nilable(String),
569
- outbound_proxy: T.nilable(String),
570
- password: String,
571
- proxy: String,
572
- transport:
573
- T.nilable(
574
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::OrSymbol
575
- ),
576
- username: String
577
- }
578
- )
579
- end
580
- def to_hash
581
- end
582
-
583
- # The transport protocol used for SIP signaling when communicating with the
584
- # external SIP peer. One of UDP, TLS, or TCP.
585
- module Transport
586
- extend Telnyx::Internal::Type::Enum
587
-
588
- TaggedSymbol =
589
- T.type_alias do
590
- T.all(
591
- Symbol,
592
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport
593
- )
594
- end
595
- OrSymbol = T.type_alias { T.any(Symbol, String) }
596
-
597
- UDP =
598
- T.let(
599
- :UDP,
600
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::TaggedSymbol
601
- )
602
- TLS =
603
- T.let(
604
- :TLS,
605
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::TaggedSymbol
606
- )
607
- TCP =
608
- T.let(
609
- :TCP,
610
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::TaggedSymbol
611
- )
612
-
613
- sig do
614
- override.returns(
615
- T::Array[
616
- Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport::TaggedSymbol
617
- ]
618
- )
619
- end
620
- def self.values
621
- end
622
- end
623
- end
624
-
625
432
  class Inbound < Telnyx::Internal::Type::BaseModel
626
433
  OrHash =
627
434
  T.type_alias do
@@ -1027,43 +834,6 @@ module Telnyx
1027
834
  end
1028
835
  end
1029
836
 
1030
- class InternalUacSettings < Telnyx::Internal::Type::BaseModel
1031
- OrHash =
1032
- T.type_alias do
1033
- T.any(
1034
- Telnyx::UacConnectionUpdateParams::InternalUacSettings,
1035
- Telnyx::Internal::AnyHash
1036
- )
1037
- end
1038
-
1039
- # The SIP URI that Telnyx will call when handling an inbound request from the
1040
- # external peer. Do not include a `sip:` prefix. The value must be in the format
1041
- # `userinfo@<subdomain.>sip.telnyx.com` or
1042
- # `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1043
- # letters, digits, hyphens, and underscores.
1044
- sig { returns(T.nilable(String)) }
1045
- attr_reader :destination_uri
1046
-
1047
- sig { params(destination_uri: String).void }
1048
- attr_writer :destination_uri
1049
-
1050
- # Internal Telnyx-side settings for a UAC connection.
1051
- sig { params(destination_uri: String).returns(T.attached_class) }
1052
- def self.new(
1053
- # The SIP URI that Telnyx will call when handling an inbound request from the
1054
- # external peer. Do not include a `sip:` prefix. The value must be in the format
1055
- # `userinfo@<subdomain.>sip.telnyx.com` or
1056
- # `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
1057
- # letters, digits, hyphens, and underscores.
1058
- destination_uri: nil
1059
- )
1060
- end
1061
-
1062
- sig { override.returns({ destination_uri: String }) }
1063
- def to_hash
1064
- end
1065
- end
1066
-
1067
837
  # Controls when noise suppression is applied to calls. When set to 'inbound',
1068
838
  # noise suppression is applied to incoming audio. When set to 'outbound', it's
1069
839
  # applied to outgoing audio. When set to 'both', it's applied in both directions.
@@ -1109,280 +879,6 @@ module Telnyx
1109
879
  end
1110
880
  end
1111
881
 
1112
- class Outbound < Telnyx::Internal::Type::BaseModel
1113
- OrHash =
1114
- T.type_alias do
1115
- T.any(
1116
- Telnyx::UacConnectionUpdateParams::Outbound,
1117
- Telnyx::Internal::AnyHash
1118
- )
1119
- end
1120
-
1121
- # Set a phone number as the ani_override value to override caller id number on
1122
- # outbound calls.
1123
- sig { returns(T.nilable(String)) }
1124
- attr_reader :ani_override
1125
-
1126
- sig { params(ani_override: String).void }
1127
- attr_writer :ani_override
1128
-
1129
- # Specifies when we apply your ani_override setting. Only applies when
1130
- # ani_override is not blank.
1131
- sig do
1132
- returns(
1133
- T.nilable(
1134
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::OrSymbol
1135
- )
1136
- )
1137
- end
1138
- attr_reader :ani_override_type
1139
-
1140
- sig do
1141
- params(
1142
- ani_override_type:
1143
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::OrSymbol
1144
- ).void
1145
- end
1146
- attr_writer :ani_override_type
1147
-
1148
- # Forces all SIP calls originated on this connection to be "parked" instead of
1149
- # "bridged" to the destination specified on the URI. Parked calls will return
1150
- # ringback to the caller and will await for a Call Control command to define which
1151
- # action will be taken next.
1152
- sig { returns(T.nilable(T::Boolean)) }
1153
- attr_accessor :call_parking_enabled
1154
-
1155
- # When set, this will limit the total number of outbound calls to phone numbers
1156
- # associated with this connection.
1157
- sig { returns(T.nilable(Integer)) }
1158
- attr_reader :channel_limit
1159
-
1160
- sig { params(channel_limit: Integer).void }
1161
- attr_writer :channel_limit
1162
-
1163
- # Generate ringback tone through 183 session progress message with early media.
1164
- sig { returns(T.nilable(T::Boolean)) }
1165
- attr_reader :generate_ringback_tone
1166
-
1167
- sig { params(generate_ringback_tone: T::Boolean).void }
1168
- attr_writer :generate_ringback_tone
1169
-
1170
- # When set, ringback will not wait for indication before sending ringback tone to
1171
- # calling party.
1172
- sig { returns(T.nilable(T::Boolean)) }
1173
- attr_reader :instant_ringback_enabled
1174
-
1175
- sig { params(instant_ringback_enabled: T::Boolean).void }
1176
- attr_writer :instant_ringback_enabled
1177
-
1178
- # A 2-character country code specifying the country whose national dialing rules
1179
- # should be used. For example, if set to `US` then any US number can be dialed
1180
- # without preprending +1 to the number. When left blank, Telnyx will try US and GB
1181
- # dialing rules, in that order, by default.
1182
- sig { returns(T.nilable(String)) }
1183
- attr_reader :localization
1184
-
1185
- sig { params(localization: String).void }
1186
- attr_writer :localization
1187
-
1188
- # Identifies the associated outbound voice profile.
1189
- sig { returns(T.nilable(String)) }
1190
- attr_reader :outbound_voice_profile_id
1191
-
1192
- sig { params(outbound_voice_profile_id: String).void }
1193
- attr_writer :outbound_voice_profile_id
1194
-
1195
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
1196
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1197
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
1198
- # expected to send the t.38 reinvite.
1199
- sig do
1200
- returns(
1201
- T.nilable(
1202
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::OrSymbol
1203
- )
1204
- )
1205
- end
1206
- attr_reader :t38_reinvite_source
1207
-
1208
- sig do
1209
- params(
1210
- t38_reinvite_source:
1211
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::OrSymbol
1212
- ).void
1213
- end
1214
- attr_writer :t38_reinvite_source
1215
-
1216
- sig do
1217
- params(
1218
- ani_override: String,
1219
- ani_override_type:
1220
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::OrSymbol,
1221
- call_parking_enabled: T.nilable(T::Boolean),
1222
- channel_limit: Integer,
1223
- generate_ringback_tone: T::Boolean,
1224
- instant_ringback_enabled: T::Boolean,
1225
- localization: String,
1226
- outbound_voice_profile_id: String,
1227
- t38_reinvite_source:
1228
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::OrSymbol
1229
- ).returns(T.attached_class)
1230
- end
1231
- def self.new(
1232
- # Set a phone number as the ani_override value to override caller id number on
1233
- # outbound calls.
1234
- ani_override: nil,
1235
- # Specifies when we apply your ani_override setting. Only applies when
1236
- # ani_override is not blank.
1237
- ani_override_type: nil,
1238
- # Forces all SIP calls originated on this connection to be "parked" instead of
1239
- # "bridged" to the destination specified on the URI. Parked calls will return
1240
- # ringback to the caller and will await for a Call Control command to define which
1241
- # action will be taken next.
1242
- call_parking_enabled: nil,
1243
- # When set, this will limit the total number of outbound calls to phone numbers
1244
- # associated with this connection.
1245
- channel_limit: nil,
1246
- # Generate ringback tone through 183 session progress message with early media.
1247
- generate_ringback_tone: nil,
1248
- # When set, ringback will not wait for indication before sending ringback tone to
1249
- # calling party.
1250
- instant_ringback_enabled: nil,
1251
- # A 2-character country code specifying the country whose national dialing rules
1252
- # should be used. For example, if set to `US` then any US number can be dialed
1253
- # without preprending +1 to the number. When left blank, Telnyx will try US and GB
1254
- # dialing rules, in that order, by default.
1255
- localization: nil,
1256
- # Identifies the associated outbound voice profile.
1257
- outbound_voice_profile_id: nil,
1258
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
1259
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1260
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
1261
- # expected to send the t.38 reinvite.
1262
- t38_reinvite_source: nil
1263
- )
1264
- end
1265
-
1266
- sig do
1267
- override.returns(
1268
- {
1269
- ani_override: String,
1270
- ani_override_type:
1271
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::OrSymbol,
1272
- call_parking_enabled: T.nilable(T::Boolean),
1273
- channel_limit: Integer,
1274
- generate_ringback_tone: T::Boolean,
1275
- instant_ringback_enabled: T::Boolean,
1276
- localization: String,
1277
- outbound_voice_profile_id: String,
1278
- t38_reinvite_source:
1279
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::OrSymbol
1280
- }
1281
- )
1282
- end
1283
- def to_hash
1284
- end
1285
-
1286
- # Specifies when we apply your ani_override setting. Only applies when
1287
- # ani_override is not blank.
1288
- module AniOverrideType
1289
- extend Telnyx::Internal::Type::Enum
1290
-
1291
- TaggedSymbol =
1292
- T.type_alias do
1293
- T.all(
1294
- Symbol,
1295
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType
1296
- )
1297
- end
1298
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1299
-
1300
- ALWAYS =
1301
- T.let(
1302
- :always,
1303
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::TaggedSymbol
1304
- )
1305
- NORMAL =
1306
- T.let(
1307
- :normal,
1308
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::TaggedSymbol
1309
- )
1310
- EMERGENCY =
1311
- T.let(
1312
- :emergency,
1313
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::TaggedSymbol
1314
- )
1315
-
1316
- sig do
1317
- override.returns(
1318
- T::Array[
1319
- Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType::TaggedSymbol
1320
- ]
1321
- )
1322
- end
1323
- def self.values
1324
- end
1325
- end
1326
-
1327
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
1328
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
1329
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
1330
- # expected to send the t.38 reinvite.
1331
- module T38ReinviteSource
1332
- extend Telnyx::Internal::Type::Enum
1333
-
1334
- TaggedSymbol =
1335
- T.type_alias do
1336
- T.all(
1337
- Symbol,
1338
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource
1339
- )
1340
- end
1341
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1342
-
1343
- TELNYX =
1344
- T.let(
1345
- :telnyx,
1346
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1347
- )
1348
- CUSTOMER =
1349
- T.let(
1350
- :customer,
1351
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1352
- )
1353
- DISABLED =
1354
- T.let(
1355
- :disabled,
1356
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1357
- )
1358
- PASSTHRU =
1359
- T.let(
1360
- :passthru,
1361
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1362
- )
1363
- CALLER_PASSTHRU =
1364
- T.let(
1365
- :"caller-passthru",
1366
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1367
- )
1368
- CALLEE_PASSTHRU =
1369
- T.let(
1370
- :"callee-passthru",
1371
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1372
- )
1373
-
1374
- sig do
1375
- override.returns(
1376
- T::Array[
1377
- Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource::TaggedSymbol
1378
- ]
1379
- )
1380
- end
1381
- def self.values
1382
- end
1383
- end
1384
- end
1385
-
1386
882
  # This feature enables inbound SIP URI calls to your Credential Auth Connection.
1387
883
  # If enabled for all (unrestricted) then anyone who calls the SIP URI
1388
884
  # <your-username>@telnyx.com will be connected to your Connection. You can also