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
@@ -77,8 +77,8 @@ module Telnyx
77
77
  # External SIP peer settings used by Telnyx when registering to your PBX and
78
78
  # routing outbound calls.
79
79
  #
80
- # @return [Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings, nil]
81
- optional :external_uac_settings, -> { Telnyx::UacConnectionUpdateParams::ExternalUacSettings }
80
+ # @return [Telnyx::Models::UacExternalSettings, nil]
81
+ optional :external_uac_settings, -> { Telnyx::UacExternalSettings }
82
82
 
83
83
  # @!attribute inbound
84
84
  # Inbound settings that can be supplied when creating or updating a UAC
@@ -91,8 +91,8 @@ module Telnyx
91
91
  # @!attribute internal_uac_settings
92
92
  # Internal Telnyx-side settings for a UAC connection.
93
93
  #
94
- # @return [Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings, nil]
95
- optional :internal_uac_settings, -> { Telnyx::UacConnectionUpdateParams::InternalUacSettings }
94
+ # @return [Telnyx::Models::UacInternalSettings, nil]
95
+ optional :internal_uac_settings, -> { Telnyx::UacInternalSettings }
96
96
 
97
97
  # @!attribute ios_push_credential_id
98
98
  # The uuid of the push credential for Ios
@@ -138,8 +138,8 @@ module Telnyx
138
138
 
139
139
  # @!attribute outbound
140
140
  #
141
- # @return [Telnyx::Models::UacConnectionUpdateParams::Outbound, nil]
142
- optional :outbound, -> { Telnyx::UacConnectionUpdateParams::Outbound }
141
+ # @return [Telnyx::Models::UacOutbound, nil]
142
+ optional :outbound, -> { Telnyx::UacOutbound }
143
143
 
144
144
  # @!attribute password
145
145
  # The password to be used as part of the credentials. Must be 8 to 128 characters
@@ -227,11 +227,11 @@ module Telnyx
227
227
  #
228
228
  # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
229
229
  #
230
- # @param external_uac_settings [Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
230
+ # @param external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
231
231
  #
232
232
  # @param inbound [Telnyx::Models::UacConnectionUpdateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
233
233
  #
234
- # @param internal_uac_settings [Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
234
+ # @param internal_uac_settings [Telnyx::Models::UacInternalSettings] Internal Telnyx-side settings for a UAC connection.
235
235
  #
236
236
  # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
237
237
  #
@@ -243,7 +243,7 @@ module Telnyx
243
243
  #
244
244
  # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
245
245
  #
246
- # @param outbound [Telnyx::Models::UacConnectionUpdateParams::Outbound]
246
+ # @param outbound [Telnyx::Models::UacOutbound]
247
247
  #
248
248
  # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
249
249
  #
@@ -265,105 +265,6 @@ module Telnyx
265
265
  #
266
266
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
267
267
 
268
- class ExternalUacSettings < Telnyx::Internal::Type::BaseModel
269
- # @!attribute auth_username
270
- # The authentication username used in SIP digest authentication. If not set, the
271
- # Username value will be used.
272
- #
273
- # @return [String, nil]
274
- optional :auth_username, String, nil?: true
275
-
276
- # @!attribute expiration_sec
277
- # The registration interval, in seconds, indicating how often the system refreshes
278
- # the SIP registration with the external SIP peer.
279
- #
280
- # @return [Integer, nil]
281
- optional :expiration_sec, Integer, nil?: true
282
-
283
- # @!attribute from_user
284
- # The user portion of the SIP From header used in outbound requests. This controls
285
- # the caller identity presented to the external SIP peer.
286
- #
287
- # @return [String, nil]
288
- optional :from_user, String, nil?: true
289
-
290
- # @!attribute outbound_proxy
291
- # An optional SIP proxy used to route outbound requests before reaching the
292
- # external SIP peer.
293
- #
294
- # @return [String, nil]
295
- optional :outbound_proxy, String, nil?: true
296
-
297
- # @!attribute password
298
- # The SIP password used for digest authentication with the external SIP peer.
299
- #
300
- # @return [String, nil]
301
- optional :password, String
302
-
303
- # @!attribute proxy
304
- # The SIP proxy address of the external SIP peer used for registrations and
305
- # outbound call routing.
306
- #
307
- # @return [String, nil]
308
- optional :proxy, String
309
-
310
- # @!attribute transport
311
- # The transport protocol used for SIP signaling when communicating with the
312
- # external SIP peer. One of UDP, TLS, or TCP.
313
- #
314
- # @return [Symbol, Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings::Transport, nil]
315
- optional :transport,
316
- enum: -> { Telnyx::UacConnectionUpdateParams::ExternalUacSettings::Transport },
317
- nil?: true
318
-
319
- # @!attribute username
320
- # The SIP username used to authenticate with the external SIP peer for
321
- # registrations and outbound calls. Must start with a letter or number and contain
322
- # only letters, numbers, hyphens, and underscores.
323
- #
324
- # @return [String, nil]
325
- optional :username, String
326
-
327
- # @!method initialize(auth_username: nil, expiration_sec: nil, from_user: nil, outbound_proxy: nil, password: nil, proxy: nil, transport: nil, username: nil)
328
- # Some parameter documentations has been truncated, see
329
- # {Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings} for more
330
- # details.
331
- #
332
- # External SIP peer settings used by Telnyx when registering to your PBX and
333
- # routing outbound calls.
334
- #
335
- # @param auth_username [String, nil] The authentication username used in SIP digest authentication. If not set, the U
336
- #
337
- # @param expiration_sec [Integer, nil] The registration interval, in seconds, indicating how often the system refreshes
338
- #
339
- # @param from_user [String, nil] The user portion of the SIP From header used in outbound requests. This controls
340
- #
341
- # @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
342
- #
343
- # @param password [String] The SIP password used for digest authentication with the external SIP peer.
344
- #
345
- # @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
346
- #
347
- # @param transport [Symbol, Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings::Transport, nil] The transport protocol used for SIP signaling when communicating with the extern
348
- #
349
- # @param username [String] The SIP username used to authenticate with the external SIP peer for registratio
350
-
351
- # The transport protocol used for SIP signaling when communicating with the
352
- # external SIP peer. One of UDP, TLS, or TCP.
353
- #
354
- # @see Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings#transport
355
- module Transport
356
- extend Telnyx::Internal::Type::Enum
357
-
358
- UDP = :UDP
359
- TLS = :TLS
360
- TCP = :TCP
361
-
362
- # @!method self.values
363
- # @return [Array<Symbol>]
364
- end
365
- end
366
-
367
268
  class Inbound < Telnyx::Internal::Type::BaseModel
368
269
  # @!attribute ani_number_format
369
270
  # This setting allows you to set the format with which the caller's number (ANI)
@@ -546,27 +447,6 @@ module Telnyx
546
447
  end
547
448
  end
548
449
 
549
- class InternalUacSettings < Telnyx::Internal::Type::BaseModel
550
- # @!attribute destination_uri
551
- # The SIP URI that Telnyx will call when handling an inbound request from the
552
- # external peer. Do not include a `sip:` prefix. The value must be in the format
553
- # `userinfo@<subdomain.>sip.telnyx.com` or
554
- # `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only
555
- # letters, digits, hyphens, and underscores.
556
- #
557
- # @return [String, nil]
558
- optional :destination_uri, String
559
-
560
- # @!method initialize(destination_uri: nil)
561
- # Some parameter documentations has been truncated, see
562
- # {Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings} for more
563
- # details.
564
- #
565
- # Internal Telnyx-side settings for a UAC connection.
566
- #
567
- # @param destination_uri [String] The SIP URI that Telnyx will call when handling an inbound request from the exte
568
- end
569
-
570
450
  # Controls when noise suppression is applied to calls. When set to 'inbound',
571
451
  # noise suppression is applied to incoming audio. When set to 'outbound', it's
572
452
  # applied to outgoing audio. When set to 'both', it's applied in both directions.
@@ -583,132 +463,6 @@ module Telnyx
583
463
  # @return [Array<Symbol>]
584
464
  end
585
465
 
586
- class Outbound < Telnyx::Internal::Type::BaseModel
587
- # @!attribute ani_override
588
- # Set a phone number as the ani_override value to override caller id number on
589
- # outbound calls.
590
- #
591
- # @return [String, nil]
592
- optional :ani_override, String
593
-
594
- # @!attribute ani_override_type
595
- # Specifies when we apply your ani_override setting. Only applies when
596
- # ani_override is not blank.
597
- #
598
- # @return [Symbol, Telnyx::Models::UacConnectionUpdateParams::Outbound::AniOverrideType, nil]
599
- optional :ani_override_type, enum: -> { Telnyx::UacConnectionUpdateParams::Outbound::AniOverrideType }
600
-
601
- # @!attribute call_parking_enabled
602
- # Forces all SIP calls originated on this connection to be "parked" instead of
603
- # "bridged" to the destination specified on the URI. Parked calls will return
604
- # ringback to the caller and will await for a Call Control command to define which
605
- # action will be taken next.
606
- #
607
- # @return [Boolean, nil]
608
- optional :call_parking_enabled, Telnyx::Internal::Type::Boolean, nil?: true
609
-
610
- # @!attribute channel_limit
611
- # When set, this will limit the total number of outbound calls to phone numbers
612
- # associated with this connection.
613
- #
614
- # @return [Integer, nil]
615
- optional :channel_limit, Integer
616
-
617
- # @!attribute generate_ringback_tone
618
- # Generate ringback tone through 183 session progress message with early media.
619
- #
620
- # @return [Boolean, nil]
621
- optional :generate_ringback_tone, Telnyx::Internal::Type::Boolean
622
-
623
- # @!attribute instant_ringback_enabled
624
- # When set, ringback will not wait for indication before sending ringback tone to
625
- # calling party.
626
- #
627
- # @return [Boolean, nil]
628
- optional :instant_ringback_enabled, Telnyx::Internal::Type::Boolean
629
-
630
- # @!attribute localization
631
- # A 2-character country code specifying the country whose national dialing rules
632
- # should be used. For example, if set to `US` then any US number can be dialed
633
- # without preprending +1 to the number. When left blank, Telnyx will try US and GB
634
- # dialing rules, in that order, by default.
635
- #
636
- # @return [String, nil]
637
- optional :localization, String
638
-
639
- # @!attribute outbound_voice_profile_id
640
- # Identifies the associated outbound voice profile.
641
- #
642
- # @return [String, nil]
643
- optional :outbound_voice_profile_id, String
644
-
645
- # @!attribute t38_reinvite_source
646
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
647
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
648
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
649
- # expected to send the t.38 reinvite.
650
- #
651
- # @return [Symbol, Telnyx::Models::UacConnectionUpdateParams::Outbound::T38ReinviteSource, nil]
652
- optional :t38_reinvite_source, enum: -> { Telnyx::UacConnectionUpdateParams::Outbound::T38ReinviteSource }
653
-
654
- # @!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)
655
- # Some parameter documentations has been truncated, see
656
- # {Telnyx::Models::UacConnectionUpdateParams::Outbound} for more details.
657
- #
658
- # @param ani_override [String] Set a phone number as the ani_override value to override caller id number on out
659
- #
660
- # @param ani_override_type [Symbol, Telnyx::Models::UacConnectionUpdateParams::Outbound::AniOverrideType] Specifies when we apply your ani_override setting. Only applies when ani_overrid
661
- #
662
- # @param call_parking_enabled [Boolean, nil] Forces all SIP calls originated on this connection to be "parked" instead of "br
663
- #
664
- # @param channel_limit [Integer] When set, this will limit the total number of outbound calls to phone numbers as
665
- #
666
- # @param generate_ringback_tone [Boolean] Generate ringback tone through 183 session progress message with early media.
667
- #
668
- # @param instant_ringback_enabled [Boolean] When set, ringback will not wait for indication before sending ringback tone to
669
- #
670
- # @param localization [String] A 2-character country code specifying the country whose national dialing rules s
671
- #
672
- # @param outbound_voice_profile_id [String] Identifies the associated outbound voice profile.
673
- #
674
- # @param t38_reinvite_source [Symbol, Telnyx::Models::UacConnectionUpdateParams::Outbound::T38ReinviteSource] This setting only affects connections with Fax-type Outbound Voice Profiles. The
675
-
676
- # Specifies when we apply your ani_override setting. Only applies when
677
- # ani_override is not blank.
678
- #
679
- # @see Telnyx::Models::UacConnectionUpdateParams::Outbound#ani_override_type
680
- module AniOverrideType
681
- extend Telnyx::Internal::Type::Enum
682
-
683
- ALWAYS = :always
684
- NORMAL = :normal
685
- EMERGENCY = :emergency
686
-
687
- # @!method self.values
688
- # @return [Array<Symbol>]
689
- end
690
-
691
- # This setting only affects connections with Fax-type Outbound Voice Profiles. The
692
- # setting dictates whether or not Telnyx sends a t.38 reinvite.<br/><br/> By
693
- # default, Telnyx will send the re-invite. If set to `customer`, the caller is
694
- # expected to send the t.38 reinvite.
695
- #
696
- # @see Telnyx::Models::UacConnectionUpdateParams::Outbound#t38_reinvite_source
697
- module T38ReinviteSource
698
- extend Telnyx::Internal::Type::Enum
699
-
700
- TELNYX = :telnyx
701
- CUSTOMER = :customer
702
- DISABLED = :disabled
703
- PASSTHRU = :passthru
704
- CALLER_PASSTHRU = :"caller-passthru"
705
- CALLEE_PASSTHRU = :"callee-passthru"
706
-
707
- # @!method self.values
708
- # @return [Array<Symbol>]
709
- end
710
- end
711
-
712
466
  # This feature enables inbound SIP URI calls to your Credential Auth Connection.
713
467
  # If enabled for all (unrestricted) then anyone who calls the SIP URI
714
468
  # <your-username>@telnyx.com will be connected to your Connection. You can also