telnyx 5.98.0 → 5.100.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 (121) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/client.rb +5 -0
  5. data/lib/telnyx/models/ai/assistant_create_params.rb +9 -231
  6. data/lib/telnyx/models/ai/assistant_update_params.rb +9 -231
  7. data/lib/telnyx/models/ai/assistants/canary_deploy.rb +128 -7
  8. data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +131 -7
  9. data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -236
  10. data/lib/telnyx/models/ai/external_llm.rb +89 -0
  11. data/lib/telnyx/models/ai/external_llm_req.rb +89 -0
  12. data/lib/telnyx/models/ai/fallback_config.rb +37 -0
  13. data/lib/telnyx/models/ai/fallback_config_req.rb +37 -0
  14. data/lib/telnyx/models/ai/inference_embedding.rb +9 -234
  15. data/lib/telnyx/models/ai/post_conversation_settings.rb +30 -0
  16. data/lib/telnyx/models/ai/post_conversation_settings_req.rb +30 -0
  17. data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +26 -3
  18. data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +26 -3
  19. data/lib/telnyx/models/calls/action_speak_params.rb +26 -3
  20. data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +26 -3
  21. data/lib/telnyx/models/conferences/action_speak_params.rb +26 -3
  22. data/lib/telnyx/models/uac_connection_create_params.rb +738 -0
  23. data/lib/telnyx/models/uac_connection_create_response.rb +898 -0
  24. data/lib/telnyx/models/uac_connection_delete_params.rb +20 -0
  25. data/lib/telnyx/models/uac_connection_delete_response.rb +898 -0
  26. data/lib/telnyx/models/uac_connection_list_params.rb +143 -0
  27. data/lib/telnyx/models/uac_connection_list_response.rb +876 -0
  28. data/lib/telnyx/models/uac_connection_retrieve_params.rb +20 -0
  29. data/lib/telnyx/models/uac_connection_retrieve_response.rb +899 -0
  30. data/lib/telnyx/models/uac_connection_update_params.rb +740 -0
  31. data/lib/telnyx/models/uac_connection_update_response.rb +898 -0
  32. data/lib/telnyx/models/uac_connections/action_check_registration_status_params.rb +22 -0
  33. data/lib/telnyx/models/uac_connections/action_check_registration_status_response.rb +104 -0
  34. data/lib/telnyx/models.rb +12 -0
  35. data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +6 -10
  36. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
  37. data/lib/telnyx/resources/ai/assistants.rb +6 -6
  38. data/lib/telnyx/resources/calls/actions.rb +4 -4
  39. data/lib/telnyx/resources/conferences/actions.rb +1 -1
  40. data/lib/telnyx/resources/uac_connections/actions.rb +39 -0
  41. data/lib/telnyx/resources/uac_connections.rb +256 -0
  42. data/lib/telnyx/version.rb +1 -1
  43. data/lib/telnyx.rb +20 -1
  44. data/rbi/telnyx/client.rbi +4 -0
  45. data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -463
  46. data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -463
  47. data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +303 -10
  48. data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +309 -9
  49. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -469
  50. data/rbi/telnyx/models/ai/external_llm.rbi +161 -0
  51. data/rbi/telnyx/models/ai/external_llm_req.rbi +161 -0
  52. data/rbi/telnyx/models/ai/fallback_config.rbi +64 -0
  53. data/rbi/telnyx/models/ai/fallback_config_req.rbi +64 -0
  54. data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -460
  55. data/rbi/telnyx/models/ai/post_conversation_settings.rbi +45 -0
  56. data/rbi/telnyx/models/ai/post_conversation_settings_req.rbi +45 -0
  57. data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +50 -5
  58. data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +50 -5
  59. data/rbi/telnyx/models/calls/action_speak_params.rbi +50 -5
  60. data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +50 -5
  61. data/rbi/telnyx/models/conferences/action_speak_params.rbi +50 -5
  62. data/rbi/telnyx/models/uac_connection_create_params.rbi +1465 -0
  63. data/rbi/telnyx/models/uac_connection_create_response.rbi +1793 -0
  64. data/rbi/telnyx/models/uac_connection_delete_params.rbi +35 -0
  65. data/rbi/telnyx/models/uac_connection_delete_response.rbi +1793 -0
  66. data/rbi/telnyx/models/uac_connection_list_params.rbi +261 -0
  67. data/rbi/telnyx/models/uac_connection_list_response.rbi +1727 -0
  68. data/rbi/telnyx/models/uac_connection_retrieve_params.rbi +35 -0
  69. data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +1793 -0
  70. data/rbi/telnyx/models/uac_connection_update_params.rbi +1463 -0
  71. data/rbi/telnyx/models/uac_connection_update_response.rbi +1793 -0
  72. data/rbi/telnyx/models/uac_connections/action_check_registration_status_params.rbi +40 -0
  73. data/rbi/telnyx/models/uac_connections/action_check_registration_status_response.rbi +237 -0
  74. data/rbi/telnyx/models.rbi +12 -0
  75. data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +6 -14
  76. data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -5
  77. data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
  78. data/rbi/telnyx/resources/calls/actions.rbi +16 -4
  79. data/rbi/telnyx/resources/conferences/actions.rbi +4 -1
  80. data/rbi/telnyx/resources/uac_connections/actions.rbi +33 -0
  81. data/rbi/telnyx/resources/uac_connections.rbi +348 -0
  82. data/sig/telnyx/client.rbs +2 -0
  83. data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -205
  84. data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -205
  85. data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +113 -4
  86. data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +113 -8
  87. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -205
  88. data/sig/telnyx/models/ai/external_llm.rbs +75 -0
  89. data/sig/telnyx/models/ai/external_llm_req.rbs +75 -0
  90. data/sig/telnyx/models/ai/fallback_config.rbs +38 -0
  91. data/sig/telnyx/models/ai/fallback_config_req.rbs +40 -0
  92. data/sig/telnyx/models/ai/inference_embedding.rbs +17 -206
  93. data/sig/telnyx/models/ai/post_conversation_settings.rbs +17 -0
  94. data/sig/telnyx/models/ai/post_conversation_settings_req.rbs +17 -0
  95. data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +15 -0
  96. data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +15 -0
  97. data/sig/telnyx/models/calls/action_speak_params.rbs +15 -0
  98. data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +15 -0
  99. data/sig/telnyx/models/conferences/action_speak_params.rbs +15 -0
  100. data/sig/telnyx/models/uac_connection_create_params.rbs +609 -0
  101. data/sig/telnyx/models/uac_connection_create_response.rbs +741 -0
  102. data/sig/telnyx/models/uac_connection_delete_params.rbs +20 -0
  103. data/sig/telnyx/models/uac_connection_delete_response.rbs +741 -0
  104. data/sig/telnyx/models/uac_connection_list_params.rbs +112 -0
  105. data/sig/telnyx/models/uac_connection_list_response.rbs +722 -0
  106. data/sig/telnyx/models/uac_connection_retrieve_params.rbs +20 -0
  107. data/sig/telnyx/models/uac_connection_retrieve_response.rbs +741 -0
  108. data/sig/telnyx/models/uac_connection_update_params.rbs +615 -0
  109. data/sig/telnyx/models/uac_connection_update_response.rbs +741 -0
  110. data/sig/telnyx/models/uac_connections/action_check_registration_status_params.rbs +22 -0
  111. data/sig/telnyx/models/uac_connections/action_check_registration_status_response.rbs +117 -0
  112. data/sig/telnyx/models.rbs +12 -0
  113. data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
  114. data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
  115. data/sig/telnyx/resources/ai/assistants.rbs +6 -6
  116. data/sig/telnyx/resources/uac_connections/actions.rbs +14 -0
  117. data/sig/telnyx/resources/uac_connections.rbs +90 -0
  118. metadata +62 -5
  119. data/lib/telnyx/models/ai/assistants/version_config.rb +0 -30
  120. data/rbi/telnyx/models/ai/assistants/version_config.rbi +0 -45
  121. data/sig/telnyx/models/ai/assistants/version_config.rbs +0 -19
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module UacConnections
6
+ # @see Telnyx::Resources::UacConnections::Actions#check_registration_status
7
+ class ActionCheckRegistrationStatusParams < Telnyx::Internal::Type::BaseModel
8
+ extend Telnyx::Internal::Type::RequestParameters::Converter
9
+ include Telnyx::Internal::Type::RequestParameters
10
+
11
+ # @!attribute id
12
+ #
13
+ # @return [String]
14
+ required :id, String
15
+
16
+ # @!method initialize(id:, request_options: {})
17
+ # @param id [String]
18
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,104 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Models
5
+ module UacConnections
6
+ # @see Telnyx::Resources::UacConnections::Actions#check_registration_status
7
+ class ActionCheckRegistrationStatusResponse < Telnyx::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data, nil]
11
+ optional :data, -> { Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data }
12
+
13
+ # @!method initialize(data: nil)
14
+ # @param data [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data]
15
+
16
+ # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse#data
17
+ class Data < Telnyx::Internal::Type::BaseModel
18
+ # @!attribute ip_address
19
+ # The ip used during the SIP connection
20
+ #
21
+ # @return [String, nil]
22
+ optional :ip_address, String
23
+
24
+ # @!attribute last_registration
25
+ # ISO 8601 formatted date indicating when the resource was last updated.
26
+ #
27
+ # @return [String, nil]
28
+ optional :last_registration, String
29
+
30
+ # @!attribute port
31
+ # The port of the SIP connection
32
+ #
33
+ # @return [Integer, nil]
34
+ optional :port, Integer
35
+
36
+ # @!attribute record_type
37
+ # Identifies the type of the resource.
38
+ #
39
+ # @return [String, nil]
40
+ optional :record_type, String
41
+
42
+ # @!attribute sip_username
43
+ # The user name of the SIP connection
44
+ #
45
+ # @return [String, nil]
46
+ optional :sip_username, String
47
+
48
+ # @!attribute status
49
+ # The current registration status of your SIP connection
50
+ #
51
+ # @return [Symbol, Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status, nil]
52
+ optional :status,
53
+ enum: -> { Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status }
54
+
55
+ # @!attribute transport
56
+ # The protocol of the SIP connection
57
+ #
58
+ # @return [String, nil]
59
+ optional :transport, String
60
+
61
+ # @!attribute user_agent
62
+ # The user agent of the SIP connection
63
+ #
64
+ # @return [String, nil]
65
+ optional :user_agent, String
66
+
67
+ # @!method initialize(ip_address: nil, last_registration: nil, port: nil, record_type: nil, sip_username: nil, status: nil, transport: nil, user_agent: nil)
68
+ # @param ip_address [String] The ip used during the SIP connection
69
+ #
70
+ # @param last_registration [String] ISO 8601 formatted date indicating when the resource was last updated.
71
+ #
72
+ # @param port [Integer] The port of the SIP connection
73
+ #
74
+ # @param record_type [String] Identifies the type of the resource.
75
+ #
76
+ # @param sip_username [String] The user name of the SIP connection
77
+ #
78
+ # @param status [Symbol, Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status] The current registration status of your SIP connection
79
+ #
80
+ # @param transport [String] The protocol of the SIP connection
81
+ #
82
+ # @param user_agent [String] The user agent of the SIP connection
83
+
84
+ # The current registration status of your SIP connection
85
+ #
86
+ # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data#status
87
+ module Status
88
+ extend Telnyx::Internal::Type::Enum
89
+
90
+ NOT_APPLICABLE = :"Not Applicable"
91
+ NOT_REGISTERED = :"Not Registered"
92
+ FAILED = :Failed
93
+ EXPIRED = :Expired
94
+ REGISTERED = :Registered
95
+ UNREGISTERED = :Unregistered
96
+
97
+ # @!method self.values
98
+ # @return [Array<Symbol>]
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
data/lib/telnyx/models.rb CHANGED
@@ -1626,6 +1626,18 @@ module Telnyx
1626
1626
 
1627
1627
  TransportProtocol = Telnyx::Models::TransportProtocol
1628
1628
 
1629
+ UacConnectionCreateParams = Telnyx::Models::UacConnectionCreateParams
1630
+
1631
+ UacConnectionDeleteParams = Telnyx::Models::UacConnectionDeleteParams
1632
+
1633
+ UacConnectionListParams = Telnyx::Models::UacConnectionListParams
1634
+
1635
+ UacConnectionRetrieveParams = Telnyx::Models::UacConnectionRetrieveParams
1636
+
1637
+ UacConnections = Telnyx::Models::UacConnections
1638
+
1639
+ UacConnectionUpdateParams = Telnyx::Models::UacConnectionUpdateParams
1640
+
1629
1641
  UnsafeUnwrapWebhookEvent = Telnyx::Models::UnsafeUnwrapWebhookEvent
1630
1642
 
1631
1643
  UnwrapWebhookEvent = Telnyx::Models::UnwrapWebhookEvent
@@ -11,18 +11,16 @@ module Telnyx
11
11
  # Creates a new canary deploy configuration with multiple version IDs and their
12
12
  # traffic percentages for A/B testing or gradual rollouts of assistant versions.
13
13
  #
14
- # @overload create(assistant_id, versions:, request_options: {})
14
+ # @overload create(assistant_id, rules: nil, request_options: {})
15
15
  #
16
16
  # @param assistant_id [String]
17
- #
18
- # @param versions [Array<Telnyx::Models::AI::Assistants::VersionConfig>] List of version configurations
19
- #
17
+ # @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>]
20
18
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
21
19
  #
22
20
  # @return [Telnyx::Models::AI::Assistants::CanaryDeployResponse]
23
21
  #
24
22
  # @see Telnyx::Models::AI::Assistants::CanaryDeployCreateParams
25
- def create(assistant_id, params)
23
+ def create(assistant_id, params = {})
26
24
  parsed, options = Telnyx::AI::Assistants::CanaryDeployCreateParams.dump_request(params)
27
25
  @client.request(
28
26
  method: :post,
@@ -61,18 +59,16 @@ module Telnyx
61
59
  # percentages. All old versions and percentages are replaces by new ones from this
62
60
  # request.
63
61
  #
64
- # @overload update(assistant_id, versions:, request_options: {})
62
+ # @overload update(assistant_id, rules: nil, request_options: {})
65
63
  #
66
64
  # @param assistant_id [String]
67
- #
68
- # @param versions [Array<Telnyx::Models::AI::Assistants::VersionConfig>] List of version configurations
69
- #
65
+ # @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>]
70
66
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
71
67
  #
72
68
  # @return [Telnyx::Models::AI::Assistants::CanaryDeployResponse]
73
69
  #
74
70
  # @see Telnyx::Models::AI::Assistants::CanaryDeployUpdateParams
75
- def update(assistant_id, params)
71
+ def update(assistant_id, params = {})
76
72
  parsed, options = Telnyx::AI::Assistants::CanaryDeployUpdateParams.dump_request(params)
77
73
  @client.request(
78
74
  method: :put,
@@ -59,9 +59,9 @@ module Telnyx
59
59
  #
60
60
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>] Body param
61
61
  #
62
- # @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm] Body param
62
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq] Body param
63
63
  #
64
- # @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig] Body param
64
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq] Body param
65
65
  #
66
66
  # @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
67
67
  #
@@ -85,7 +85,7 @@ module Telnyx
85
85
  #
86
86
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq] Body param
87
87
  #
88
- # @param post_conversation_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings] Body param: Configuration for post-conversation processing. When enabled, the as
88
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Body param: Configuration for post-conversation processing. When enabled, the as
89
89
  #
90
90
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings] Body param
91
91
  #
@@ -50,9 +50,9 @@ module Telnyx
50
50
  #
51
51
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
52
52
  #
53
- # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
53
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
54
54
  #
55
- # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
55
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
56
56
  #
57
57
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
58
58
  #
@@ -72,7 +72,7 @@ module Telnyx
72
72
  #
73
73
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
74
74
  #
75
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
75
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
76
76
  #
77
77
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
78
78
  #
@@ -151,9 +151,9 @@ module Telnyx
151
151
  #
152
152
  # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
153
153
  #
154
- # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
154
+ # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
155
155
  #
156
- # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
156
+ # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
157
157
  #
158
158
  # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
159
159
  #
@@ -177,7 +177,7 @@ module Telnyx
177
177
  #
178
178
  # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
179
179
  #
180
- # @param post_conversation_settings [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
180
+ # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
181
181
  #
182
182
  # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
183
183
  #
@@ -347,7 +347,7 @@ module Telnyx
347
347
  #
348
348
  # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
349
349
  #
350
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
350
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingAIParams::VoiceSettings::Xai] The settings associated with the voice selected
351
351
  #
352
352
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
353
353
  #
@@ -480,7 +480,7 @@ module Telnyx
480
480
  #
481
481
  # @param valid_digits [String] A list of all digits accepted as valid.
482
482
  #
483
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld] The settings associated with the voice selected
483
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Xai] The settings associated with the voice selected
484
484
  #
485
485
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
486
486
  #
@@ -860,7 +860,7 @@ module Telnyx
860
860
  #
861
861
  # @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
862
862
  #
863
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld] The settings associated with the voice selected
863
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Xai] The settings associated with the voice selected
864
864
  #
865
865
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
866
866
  #
@@ -912,7 +912,7 @@ module Telnyx
912
912
  #
913
913
  # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
914
914
  #
915
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings] The settings associated with the voice selected
915
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionStartAIAssistantParams::VoiceSettings::Xai] The settings associated with the voice selected
916
916
  #
917
917
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
918
918
  #
@@ -520,7 +520,7 @@ module Telnyx
520
520
  #
521
521
  # @param region [Symbol, Telnyx::Models::Conferences::ActionSpeakParams::Region] Region where the conference data is located. Defaults to the region defined in u
522
522
  #
523
- # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld] The settings associated with the voice selected
523
+ # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::Conferences::ActionSpeakParams::VoiceSettings::Xai] The settings associated with the voice selected
524
524
  #
525
525
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
526
526
  #
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ class UacConnections
6
+ # UAC connection operations
7
+ class Actions
8
+ # Checks the registration status for a UAC connection (`registration_status`) as
9
+ # well as the timestamp for the last SIP registration event
10
+ # (`registration_status_updated_at`).
11
+ #
12
+ # @overload check_registration_status(id, request_options: {})
13
+ #
14
+ # @param id [String] Identifies the resource.
15
+ #
16
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
17
+ #
18
+ # @return [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse]
19
+ #
20
+ # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusParams
21
+ def check_registration_status(id, params = {})
22
+ @client.request(
23
+ method: :post,
24
+ path: ["uac_connections/%1$s/actions/check_registration_status", id],
25
+ model: Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse,
26
+ options: params[:request_options]
27
+ )
28
+ end
29
+
30
+ # @api private
31
+ #
32
+ # @param client [Telnyx::Client]
33
+ def initialize(client:)
34
+ @client = client
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
@@ -0,0 +1,256 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Telnyx
4
+ module Resources
5
+ # UAC connection operations
6
+ class UacConnections
7
+ # UAC connection operations
8
+ # @return [Telnyx::Resources::UacConnections::Actions]
9
+ attr_reader :actions
10
+
11
+ # Some parameter documentations has been truncated, see
12
+ # {Telnyx::Models::UacConnectionCreateParams} for more details.
13
+ #
14
+ # Creates a UAC connection. A UAC (User Agent Client) Connection registers Telnyx
15
+ # to your PBX — the opposite of a standard SIP trunk, where the PBX registers to
16
+ # Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you
17
+ # need Telnyx to maintain the registration.
18
+ #
19
+ # @overload create(connection_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
20
+ #
21
+ # @param connection_name [String] A user-assigned name to help manage the connection.
22
+ #
23
+ # @param active [Boolean] Defaults to true
24
+ #
25
+ # @param anchorsite_override [Symbol, Telnyx::Models::AnchorsiteOverride] `Latency` directs Telnyx to route media through the site with the lowest round-t
26
+ #
27
+ # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
28
+ #
29
+ # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
30
+ #
31
+ # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
32
+ #
33
+ # @param dtmf_type [Symbol, Telnyx::Models::DtmfType] Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
34
+ #
35
+ # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
36
+ #
37
+ # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
38
+ #
39
+ # @param external_uac_settings [Telnyx::Models::UacConnectionCreateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
40
+ #
41
+ # @param inbound [Telnyx::Models::UacConnectionCreateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
42
+ #
43
+ # @param internal_uac_settings [Telnyx::Models::UacConnectionCreateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
44
+ #
45
+ # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
46
+ #
47
+ # @param jitter_buffer [Telnyx::Models::ConnectionJitterBuffer] Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o
48
+ #
49
+ # @param noise_suppression [Symbol, Telnyx::Models::UacConnectionCreateParams::NoiseSuppression] Controls when noise suppression is applied to calls. When set to 'inbound', nois
50
+ #
51
+ # @param noise_suppression_details [Telnyx::Models::ConnectionNoiseSuppressionDetails] Configuration options for noise suppression. These settings are stored regardles
52
+ #
53
+ # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
54
+ #
55
+ # @param outbound [Telnyx::Models::UacConnectionCreateParams::Outbound]
56
+ #
57
+ # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
58
+ #
59
+ # @param rtcp_settings [Telnyx::Models::ConnectionRtcpSettings]
60
+ #
61
+ # @param sip_uri_calling_preference [Symbol, Telnyx::Models::UacConnectionCreateParams::SipUriCallingPreference] This feature enables inbound SIP URI calls to your Credential Auth Connection. I
62
+ #
63
+ # @param tags [Array<String>] Tags associated with the connection.
64
+ #
65
+ # @param user_name [String] The user name to be used as part of the credentials. Must be 4-32 characters lon
66
+ #
67
+ # @param webhook_api_version [Symbol, Telnyx::Models::UacConnectionCreateParams::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note -
68
+ #
69
+ # @param webhook_event_failover_url [String, nil] The failover URL where webhooks related to this connection will be sent if sendi
70
+ #
71
+ # @param webhook_event_url [String] The URL where webhooks related to this connection will be sent. Must include a s
72
+ #
73
+ # @param webhook_timeout_secs [Integer, nil] Specifies how many seconds to wait before timing out a webhook.
74
+ #
75
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
76
+ #
77
+ # @return [Telnyx::Models::UacConnectionCreateResponse]
78
+ #
79
+ # @see Telnyx::Models::UacConnectionCreateParams
80
+ def create(params)
81
+ parsed, options = Telnyx::UacConnectionCreateParams.dump_request(params)
82
+ @client.request(
83
+ method: :post,
84
+ path: "uac_connections",
85
+ body: parsed,
86
+ model: Telnyx::Models::UacConnectionCreateResponse,
87
+ options: options
88
+ )
89
+ end
90
+
91
+ # Retrieves the details of an existing UAC connection.
92
+ #
93
+ # @overload retrieve(id, request_options: {})
94
+ #
95
+ # @param id [String] Identifies the resource.
96
+ #
97
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
98
+ #
99
+ # @return [Telnyx::Models::UacConnectionRetrieveResponse]
100
+ #
101
+ # @see Telnyx::Models::UacConnectionRetrieveParams
102
+ def retrieve(id, params = {})
103
+ @client.request(
104
+ method: :get,
105
+ path: ["uac_connections/%1$s", id],
106
+ model: Telnyx::Models::UacConnectionRetrieveResponse,
107
+ options: params[:request_options]
108
+ )
109
+ end
110
+
111
+ # Some parameter documentations has been truncated, see
112
+ # {Telnyx::Models::UacConnectionUpdateParams} for more details.
113
+ #
114
+ # Updates settings of an existing UAC connection.
115
+ #
116
+ # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, external_uac_settings: nil, inbound: nil, internal_uac_settings: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
117
+ #
118
+ # @param id [String] Identifies the resource.
119
+ #
120
+ # @param active [Boolean] Defaults to true
121
+ #
122
+ # @param anchorsite_override [Symbol, Telnyx::Models::AnchorsiteOverride] `Latency` directs Telnyx to route media through the site with the lowest round-t
123
+ #
124
+ # @param android_push_credential_id [String, nil] The uuid of the push credential for Android
125
+ #
126
+ # @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
127
+ #
128
+ # @param connection_name [String] A user-assigned name to help manage the connection.
129
+ #
130
+ # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
131
+ #
132
+ # @param dtmf_type [Symbol, Telnyx::Models::DtmfType] Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
133
+ #
134
+ # @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
135
+ #
136
+ # @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
137
+ #
138
+ # @param external_uac_settings [Telnyx::Models::UacConnectionUpdateParams::ExternalUacSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
139
+ #
140
+ # @param inbound [Telnyx::Models::UacConnectionUpdateParams::Inbound] Inbound settings that can be supplied when creating or updating a UAC connection
141
+ #
142
+ # @param internal_uac_settings [Telnyx::Models::UacConnectionUpdateParams::InternalUacSettings] Internal Telnyx-side settings for a UAC connection.
143
+ #
144
+ # @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
145
+ #
146
+ # @param jitter_buffer [Telnyx::Models::ConnectionJitterBuffer] Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o
147
+ #
148
+ # @param noise_suppression [Symbol, Telnyx::Models::UacConnectionUpdateParams::NoiseSuppression] Controls when noise suppression is applied to calls. When set to 'inbound', nois
149
+ #
150
+ # @param noise_suppression_details [Telnyx::Models::ConnectionNoiseSuppressionDetails] Configuration options for noise suppression. These settings are stored regardles
151
+ #
152
+ # @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
153
+ #
154
+ # @param outbound [Telnyx::Models::UacConnectionUpdateParams::Outbound]
155
+ #
156
+ # @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
157
+ #
158
+ # @param rtcp_settings [Telnyx::Models::ConnectionRtcpSettings]
159
+ #
160
+ # @param sip_uri_calling_preference [Symbol, Telnyx::Models::UacConnectionUpdateParams::SipUriCallingPreference] This feature enables inbound SIP URI calls to your Credential Auth Connection. I
161
+ #
162
+ # @param tags [Array<String>] Tags associated with the connection.
163
+ #
164
+ # @param user_name [String] The user name to be used as part of the credentials. Must be 4-32 characters lon
165
+ #
166
+ # @param webhook_api_version [Symbol, Telnyx::Models::UacConnectionUpdateParams::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1 or v2.
167
+ #
168
+ # @param webhook_event_failover_url [String, nil] The failover URL where webhooks related to this connection will be sent if sendi
169
+ #
170
+ # @param webhook_event_url [String] The URL where webhooks related to this connection will be sent. Must include a s
171
+ #
172
+ # @param webhook_timeout_secs [Integer, nil] Specifies how many seconds to wait before timing out a webhook.
173
+ #
174
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
175
+ #
176
+ # @return [Telnyx::Models::UacConnectionUpdateResponse]
177
+ #
178
+ # @see Telnyx::Models::UacConnectionUpdateParams
179
+ def update(id, params = {})
180
+ parsed, options = Telnyx::UacConnectionUpdateParams.dump_request(params)
181
+ @client.request(
182
+ method: :patch,
183
+ path: ["uac_connections/%1$s", id],
184
+ body: parsed,
185
+ model: Telnyx::Models::UacConnectionUpdateResponse,
186
+ options: options
187
+ )
188
+ end
189
+
190
+ # Some parameter documentations has been truncated, see
191
+ # {Telnyx::Models::UacConnectionListParams} for more details.
192
+ #
193
+ # Returns a list of your UAC connections. A UAC (User Agent Client) Connection
194
+ # registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the
195
+ # PBX registers to Telnyx. Use UAC when your PBX doesn’t support outbound SIP
196
+ # registration or you need Telnyx to maintain the registration.
197
+ #
198
+ # @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
199
+ #
200
+ # @param filter [Telnyx::Models::UacConnectionListParams::Filter] Consolidated filter parameter (deepObject style). Originally:
201
+ # filter[connection\_
202
+ #
203
+ # @param page_number [Integer]
204
+ #
205
+ # @param page_size [Integer]
206
+ #
207
+ # @param sort [Symbol, Telnyx::Models::UacConnectionListParams::Sort] Specifies the sort order for results. By default sorting direction is ascending.
208
+ #
209
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
210
+ #
211
+ # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UacConnectionListResponse>]
212
+ #
213
+ # @see Telnyx::Models::UacConnectionListParams
214
+ def list(params = {})
215
+ parsed, options = Telnyx::UacConnectionListParams.dump_request(params)
216
+ query = Telnyx::Internal::Util.encode_query_params(parsed)
217
+ @client.request(
218
+ method: :get,
219
+ path: "uac_connections",
220
+ query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
221
+ page: Telnyx::Internal::DefaultFlatPagination,
222
+ model: Telnyx::Models::UacConnectionListResponse,
223
+ options: options
224
+ )
225
+ end
226
+
227
+ # Deletes an existing UAC connection.
228
+ #
229
+ # @overload delete(id, request_options: {})
230
+ #
231
+ # @param id [String] Identifies the resource.
232
+ #
233
+ # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
234
+ #
235
+ # @return [Telnyx::Models::UacConnectionDeleteResponse]
236
+ #
237
+ # @see Telnyx::Models::UacConnectionDeleteParams
238
+ def delete(id, params = {})
239
+ @client.request(
240
+ method: :delete,
241
+ path: ["uac_connections/%1$s", id],
242
+ model: Telnyx::Models::UacConnectionDeleteResponse,
243
+ options: params[:request_options]
244
+ )
245
+ end
246
+
247
+ # @api private
248
+ #
249
+ # @param client [Telnyx::Client]
250
+ def initialize(client:)
251
+ @client = client
252
+ @actions = Telnyx::Resources::UacConnections::Actions.new(client: client)
253
+ end
254
+ end
255
+ end
256
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.98.0"
4
+ VERSION = "5.100.0"
5
5
  end