telnyx 5.111.0 → 5.112.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +178 -9
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +178 -9
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +123 -3
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +125 -3
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +179 -9
- data/lib/telnyx/models/ai/inference_embedding.rb +177 -9
- data/lib/telnyx/models/ai/openai_list_models_response.rb +210 -3
- data/lib/telnyx/models/ai/transfer_tool.rb +9 -7
- data/lib/telnyx/models/ai_retrieve_models_response.rb +210 -3
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +23 -4
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_speak_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +23 -4
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +491 -0
- data/lib/telnyx/models/calls/action_start_conversation_relay_response.rb +37 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_params.rb +44 -0
- data/lib/telnyx/models/calls/action_stop_conversation_relay_response.rb +18 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +167 -5
- data/lib/telnyx/models/conferences/action_speak_params.rb +23 -4
- data/lib/telnyx/models/network_list_interfaces_response.rb +2 -112
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +8 -3
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +10 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +8 -3
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection_create_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_create_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_delete_response.rb +878 -3
- data/lib/telnyx/models/uac_connection_list_response.rb +876 -0
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +879 -3
- data/lib/telnyx/models/uac_connection_update_params.rb +255 -9
- data/lib/telnyx/models/uac_connection_update_response.rb +878 -3
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +10 -0
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +8 -3
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_create_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +8 -3
- data/lib/telnyx/models/wireguard_interface_list_response.rb +10 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +8 -3
- data/lib/telnyx/models.rb +0 -20
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/calls/actions.rb +101 -5
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +8 -22
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +352 -12
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +352 -12
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +290 -4
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +301 -3
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +366 -12
- data/rbi/telnyx/models/ai/inference_embedding.rbi +351 -12
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +315 -3
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +310 -3
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +41 -5
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +1075 -0
- data/rbi/telnyx/models/calls/action_start_conversation_relay_response.rbi +95 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_params.rbi +72 -0
- data/rbi/telnyx/models/calls/action_stop_conversation_relay_response.rbi +39 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +480 -10
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +41 -5
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +4 -181
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +38 -6
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +23 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection_create_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_create_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_list_response.rbi +1727 -0
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +1756 -4
- data/rbi/telnyx/models/uac_connection_update_params.rbi +516 -12
- data/rbi/telnyx/models/uac_connection_update_response.rbi +1756 -4
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +36 -6
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +23 -0
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +38 -6
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +36 -6
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +23 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +36 -6
- data/rbi/telnyx/models.rbi +0 -20
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +4 -2
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +9 -3
- data/rbi/telnyx/resources/ai/assistants.rbi +10 -6
- data/rbi/telnyx/resources/calls/actions.rbi +152 -6
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/uac_connections.rbi +13 -7
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +149 -18
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +149 -18
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +113 -6
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +109 -4
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +152 -18
- data/sig/telnyx/models/ai/inference_embedding.rbs +149 -18
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +149 -4
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +149 -4
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +15 -1
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +416 -0
- data/sig/telnyx/models/calls/action_start_conversation_relay_response.rbs +45 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_params.rbs +38 -0
- data/sig/telnyx/models/calls/action_stop_conversation_relay_response.rbs +20 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +184 -2
- data/sig/telnyx/models/conferences/action_speak_params.rbs +15 -1
- data/sig/telnyx/models/network_list_interfaces_response.rbs +4 -106
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +18 -6
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +11 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection_create_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_create_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_delete_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_list_response.rbs +722 -0
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +731 -5
- data/sig/telnyx/models/uac_connection_update_params.rbs +211 -17
- data/sig/telnyx/models/uac_connection_update_response.rbs +731 -5
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +11 -0
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +18 -6
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +18 -6
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +11 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +18 -6
- data/sig/telnyx/models.rbs +0 -20
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/calls/actions.rbs +29 -0
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +26 -68
- data/lib/telnyx/models/ai/assistant_integration.rb +0 -38
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +0 -35
- data/lib/telnyx/models/ai/assistants/clause.rb +0 -54
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +0 -27
- data/lib/telnyx/models/ai/assistants/rule_input.rb +0 -40
- data/lib/telnyx/models/ai/assistants/rule_output.rb +0 -40
- data/lib/telnyx/models/ai/assistants/serve.rb +0 -33
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +0 -47
- data/lib/telnyx/models/ai/start_speaking_plan.rb +0 -37
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +0 -39
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +0 -64
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +0 -108
- data/lib/telnyx/models/model_metadata.rb +0 -212
- data/lib/telnyx/models/public_internet_gateway_read.rb +0 -83
- data/lib/telnyx/models/uac_connection.rb +0 -412
- data/lib/telnyx/models/uac_external_settings.rb +0 -101
- data/lib/telnyx/models/uac_inbound.rb +0 -210
- data/lib/telnyx/models/uac_internal_settings.rb +0 -25
- data/lib/telnyx/models/uac_outbound.rb +0 -131
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +0 -212
- data/lib/telnyx/models/wireguard_interface_read.rb +0 -136
- data/lib/telnyx/models/xai_voice_settings.rb +0 -36
- data/rbi/telnyx/models/ai/assistant_integration.rbi +0 -60
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +0 -51
- data/rbi/telnyx/models/ai/assistants/clause.rbi +0 -91
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +0 -36
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +0 -73
- data/rbi/telnyx/models/ai/assistants/serve.rbi +0 -61
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +0 -83
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +0 -70
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +0 -71
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +0 -155
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +0 -329
- data/rbi/telnyx/models/model_metadata.rbi +0 -272
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +0 -128
- data/rbi/telnyx/models/uac_connection.rbi +0 -684
- data/rbi/telnyx/models/uac_external_settings.rbi +0 -146
- data/rbi/telnyx/models/uac_inbound.rbi +0 -410
- data/rbi/telnyx/models/uac_internal_settings.rbi +0 -39
- data/rbi/telnyx/models/uac_outbound.rbi +0 -224
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +0 -345
- data/rbi/telnyx/models/wireguard_interface_read.rbi +0 -213
- data/rbi/telnyx/models/xai_voice_settings.rbi +0 -64
- data/sig/telnyx/models/ai/assistant_integration.rbs +0 -26
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/clause.rbs +0 -46
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +0 -19
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +0 -33
- data/sig/telnyx/models/ai/assistants/serve.rbs +0 -35
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +0 -40
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +0 -33
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +0 -38
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +0 -62
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +0 -130
- data/sig/telnyx/models/model_metadata.rbs +0 -142
- data/sig/telnyx/models/public_internet_gateway_read.rbs +0 -80
- data/sig/telnyx/models/uac_connection.rbs +0 -338
- data/sig/telnyx/models/uac_external_settings.rbs +0 -73
- data/sig/telnyx/models/uac_inbound.rbs +0 -190
- data/sig/telnyx/models/uac_internal_settings.rbs +0 -15
- data/sig/telnyx/models/uac_outbound.rbs +0 -113
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +0 -190
- data/sig/telnyx/models/wireguard_interface_read.rbs +0 -127
- data/sig/telnyx/models/xai_voice_settings.rbs +0 -34
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
# @see Telnyx::Resources::PublicInternetGateways#list
|
|
6
|
-
class PublicInternetGatewayRead < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute name
|
|
8
|
-
# A user specified name for the interface.
|
|
9
|
-
#
|
|
10
|
-
# @return [String, nil]
|
|
11
|
-
optional :name, String
|
|
12
|
-
|
|
13
|
-
# @!attribute network_id
|
|
14
|
-
# The id of the network associated with the interface.
|
|
15
|
-
#
|
|
16
|
-
# @return [String, nil]
|
|
17
|
-
optional :network_id, String
|
|
18
|
-
|
|
19
|
-
# @!attribute region_code
|
|
20
|
-
# The region interface is deployed to.
|
|
21
|
-
#
|
|
22
|
-
# @return [String, nil]
|
|
23
|
-
optional :region_code, String
|
|
24
|
-
|
|
25
|
-
response_only do
|
|
26
|
-
# @!attribute id
|
|
27
|
-
# Identifies the resource.
|
|
28
|
-
#
|
|
29
|
-
# @return [String, nil]
|
|
30
|
-
optional :id, String
|
|
31
|
-
|
|
32
|
-
# @!attribute created_at
|
|
33
|
-
# ISO 8601 formatted date-time indicating when the resource was created.
|
|
34
|
-
#
|
|
35
|
-
# @return [String, nil]
|
|
36
|
-
optional :created_at, String
|
|
37
|
-
|
|
38
|
-
# @!attribute public_ip
|
|
39
|
-
# The publically accessible ip for this interface.
|
|
40
|
-
#
|
|
41
|
-
# @return [String, nil]
|
|
42
|
-
optional :public_ip, String
|
|
43
|
-
|
|
44
|
-
# @!attribute record_type
|
|
45
|
-
# Identifies the type of the resource.
|
|
46
|
-
#
|
|
47
|
-
# @return [String, nil]
|
|
48
|
-
optional :record_type, String
|
|
49
|
-
|
|
50
|
-
# @!attribute status
|
|
51
|
-
# The current status of the interface deployment.
|
|
52
|
-
#
|
|
53
|
-
# @return [Symbol, Telnyx::Models::InterfaceStatus, nil]
|
|
54
|
-
optional :status, enum: -> { Telnyx::InterfaceStatus }
|
|
55
|
-
|
|
56
|
-
# @!attribute updated_at
|
|
57
|
-
# ISO 8601 formatted date-time indicating when the resource was updated.
|
|
58
|
-
#
|
|
59
|
-
# @return [String, nil]
|
|
60
|
-
optional :updated_at, String
|
|
61
|
-
end
|
|
62
|
-
|
|
63
|
-
# @!method initialize(id: nil, created_at: nil, name: nil, network_id: nil, public_ip: nil, record_type: nil, region_code: nil, status: nil, updated_at: nil)
|
|
64
|
-
# @param id [String] Identifies the resource.
|
|
65
|
-
#
|
|
66
|
-
# @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
|
|
67
|
-
#
|
|
68
|
-
# @param name [String] A user specified name for the interface.
|
|
69
|
-
#
|
|
70
|
-
# @param network_id [String] The id of the network associated with the interface.
|
|
71
|
-
#
|
|
72
|
-
# @param public_ip [String] The publically accessible ip for this interface.
|
|
73
|
-
#
|
|
74
|
-
# @param record_type [String] Identifies the type of the resource.
|
|
75
|
-
#
|
|
76
|
-
# @param region_code [String] The region interface is deployed to.
|
|
77
|
-
#
|
|
78
|
-
# @param status [Symbol, Telnyx::Models::InterfaceStatus] The current status of the interface deployment.
|
|
79
|
-
#
|
|
80
|
-
# @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was updated.
|
|
81
|
-
end
|
|
82
|
-
end
|
|
83
|
-
end
|
|
@@ -1,412 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
# @see Telnyx::Resources::UacConnections#list
|
|
6
|
-
class UacConnection < Telnyx::Internal::Type::BaseModel
|
|
7
|
-
# @!attribute id
|
|
8
|
-
# Identifies the type of resource.
|
|
9
|
-
#
|
|
10
|
-
# @return [String, nil]
|
|
11
|
-
optional :id, String
|
|
12
|
-
|
|
13
|
-
# @!attribute active
|
|
14
|
-
# Defaults to true
|
|
15
|
-
#
|
|
16
|
-
# @return [Boolean, nil]
|
|
17
|
-
optional :active, Telnyx::Internal::Type::Boolean
|
|
18
|
-
|
|
19
|
-
# @!attribute anchorsite_override
|
|
20
|
-
# `Latency` directs Telnyx to route media through the site with the lowest
|
|
21
|
-
# round-trip time to the user's connection. Telnyx calculates this time using ICMP
|
|
22
|
-
# ping messages. This can be disabled by specifying a site to handle all media.
|
|
23
|
-
#
|
|
24
|
-
# @return [Symbol, Telnyx::Models::AnchorsiteOverride, nil]
|
|
25
|
-
optional :anchorsite_override, enum: -> { Telnyx::AnchorsiteOverride }
|
|
26
|
-
|
|
27
|
-
# @!attribute android_push_credential_id
|
|
28
|
-
# The uuid of the push credential for Android
|
|
29
|
-
#
|
|
30
|
-
# @return [String, nil]
|
|
31
|
-
optional :android_push_credential_id, String, nil?: true
|
|
32
|
-
|
|
33
|
-
# @!attribute authentication
|
|
34
|
-
# The authentication strategy used by this connection.
|
|
35
|
-
#
|
|
36
|
-
# @return [Symbol, Telnyx::Models::UacConnection::Authentication, nil]
|
|
37
|
-
optional :authentication, enum: -> { Telnyx::UacConnection::Authentication }
|
|
38
|
-
|
|
39
|
-
# @!attribute call_cost_in_webhooks
|
|
40
|
-
# Specifies if call cost webhooks should be sent for this connection.
|
|
41
|
-
#
|
|
42
|
-
# @return [Boolean, nil]
|
|
43
|
-
optional :call_cost_in_webhooks, Telnyx::Internal::Type::Boolean
|
|
44
|
-
|
|
45
|
-
# @!attribute connection_name
|
|
46
|
-
#
|
|
47
|
-
# @return [String, nil]
|
|
48
|
-
optional :connection_name, String
|
|
49
|
-
|
|
50
|
-
# @!attribute created_at
|
|
51
|
-
# ISO-8601 formatted date indicating when the resource was created.
|
|
52
|
-
#
|
|
53
|
-
# @return [String, nil]
|
|
54
|
-
optional :created_at, String
|
|
55
|
-
|
|
56
|
-
# @!attribute default_on_hold_comfort_noise_enabled
|
|
57
|
-
# When enabled, Telnyx will generate comfort noise when you place the call on
|
|
58
|
-
# hold. If disabled, you will need to generate comfort noise or on hold music to
|
|
59
|
-
# avoid RTP timeout.
|
|
60
|
-
#
|
|
61
|
-
# @return [Boolean, nil]
|
|
62
|
-
optional :default_on_hold_comfort_noise_enabled, Telnyx::Internal::Type::Boolean
|
|
63
|
-
|
|
64
|
-
# @!attribute dtmf_type
|
|
65
|
-
# Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
|
|
66
|
-
# digits sent to Telnyx will be accepted in all formats.
|
|
67
|
-
#
|
|
68
|
-
# @return [Symbol, Telnyx::Models::DtmfType, nil]
|
|
69
|
-
optional :dtmf_type, enum: -> { Telnyx::DtmfType }
|
|
70
|
-
|
|
71
|
-
# @!attribute encode_contact_header_enabled
|
|
72
|
-
# Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
|
|
73
|
-
# scenarios.
|
|
74
|
-
#
|
|
75
|
-
# @return [Boolean, nil]
|
|
76
|
-
optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
|
|
77
|
-
|
|
78
|
-
# @!attribute encrypted_media
|
|
79
|
-
# Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
|
|
80
|
-
# TLS.
|
|
81
|
-
#
|
|
82
|
-
# @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
|
|
83
|
-
optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
|
|
84
|
-
|
|
85
|
-
# @!attribute external_uac_settings
|
|
86
|
-
# External SIP peer settings used by Telnyx when registering to your PBX and
|
|
87
|
-
# routing outbound calls.
|
|
88
|
-
#
|
|
89
|
-
# @return [Telnyx::Models::UacExternalSettings, nil]
|
|
90
|
-
optional :external_uac_settings, -> { Telnyx::UacExternalSettings }
|
|
91
|
-
|
|
92
|
-
# @!attribute fqdn
|
|
93
|
-
# The Telnyx-managed FQDN generated for the UAC connection.
|
|
94
|
-
#
|
|
95
|
-
# @return [String, nil]
|
|
96
|
-
optional :fqdn, String
|
|
97
|
-
|
|
98
|
-
# @!attribute fqdn_outbound_authentication
|
|
99
|
-
# The fixed outbound authentication mode used by UAC FQDN records.
|
|
100
|
-
#
|
|
101
|
-
# @return [Symbol, Telnyx::Models::UacConnection::FqdnOutboundAuthentication, nil]
|
|
102
|
-
optional :fqdn_outbound_authentication, enum: -> { Telnyx::UacConnection::FqdnOutboundAuthentication }
|
|
103
|
-
|
|
104
|
-
# @!attribute fqdns
|
|
105
|
-
# FQDN records managed automatically by the UAC connection lifecycle.
|
|
106
|
-
#
|
|
107
|
-
# @return [Array<Telnyx::Models::Fqdn>, nil]
|
|
108
|
-
optional :fqdns, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Fqdn] }
|
|
109
|
-
|
|
110
|
-
# @!attribute inbound
|
|
111
|
-
#
|
|
112
|
-
# @return [Telnyx::Models::UacInbound, nil]
|
|
113
|
-
optional :inbound, -> { Telnyx::UacInbound }
|
|
114
|
-
|
|
115
|
-
# @!attribute internal_uac_settings
|
|
116
|
-
# Internal Telnyx-side settings for a UAC connection.
|
|
117
|
-
#
|
|
118
|
-
# @return [Telnyx::Models::UacInternalSettings, nil]
|
|
119
|
-
optional :internal_uac_settings, -> { Telnyx::UacInternalSettings }
|
|
120
|
-
|
|
121
|
-
# @!attribute ios_push_credential_id
|
|
122
|
-
# The uuid of the push credential for Ios
|
|
123
|
-
#
|
|
124
|
-
# @return [String, nil]
|
|
125
|
-
optional :ios_push_credential_id, String, nil?: true
|
|
126
|
-
|
|
127
|
-
# @!attribute jitter_buffer
|
|
128
|
-
# Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams
|
|
129
|
-
# of SIP Trunking calls. The feature is off unless enabled. You may define min and
|
|
130
|
-
# max values in msec for customized buffering behaviors. Larger values add latency
|
|
131
|
-
# but tolerate more jitter, while smaller values reduce latency but are more
|
|
132
|
-
# sensitive to jitter and reordering.
|
|
133
|
-
#
|
|
134
|
-
# @return [Telnyx::Models::ConnectionJitterBuffer, nil]
|
|
135
|
-
optional :jitter_buffer, -> { Telnyx::ConnectionJitterBuffer }
|
|
136
|
-
|
|
137
|
-
# @!attribute noise_suppression
|
|
138
|
-
# Controls when noise suppression is applied to calls. When set to 'inbound',
|
|
139
|
-
# noise suppression is applied to incoming audio. When set to 'outbound', it's
|
|
140
|
-
# applied to outgoing audio. When set to 'both', it's applied in both directions.
|
|
141
|
-
# When set to 'disabled', noise suppression is turned off.
|
|
142
|
-
#
|
|
143
|
-
# @return [Symbol, Telnyx::Models::UacConnection::NoiseSuppression, nil]
|
|
144
|
-
optional :noise_suppression, enum: -> { Telnyx::UacConnection::NoiseSuppression }
|
|
145
|
-
|
|
146
|
-
# @!attribute noise_suppression_details
|
|
147
|
-
# Configuration options for noise suppression. These settings are stored
|
|
148
|
-
# regardless of the noise_suppression value, but only take effect when
|
|
149
|
-
# noise_suppression is not 'disabled'. If you disable noise suppression and later
|
|
150
|
-
# re-enable it, the previously configured settings will be used.
|
|
151
|
-
#
|
|
152
|
-
# @return [Telnyx::Models::ConnectionNoiseSuppressionDetails, nil]
|
|
153
|
-
optional :noise_suppression_details, -> { Telnyx::ConnectionNoiseSuppressionDetails }
|
|
154
|
-
|
|
155
|
-
# @!attribute onnet_t38_passthrough_enabled
|
|
156
|
-
# Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
|
|
157
|
-
# if both are on the Telnyx network. If this is disabled, Telnyx will be able to
|
|
158
|
-
# use T38 on just one leg of the call depending on each leg's settings.
|
|
159
|
-
#
|
|
160
|
-
# @return [Boolean, nil]
|
|
161
|
-
optional :onnet_t38_passthrough_enabled, Telnyx::Internal::Type::Boolean
|
|
162
|
-
|
|
163
|
-
# @!attribute outbound
|
|
164
|
-
#
|
|
165
|
-
# @return [Telnyx::Models::UacOutbound, nil]
|
|
166
|
-
optional :outbound, -> { Telnyx::UacOutbound }
|
|
167
|
-
|
|
168
|
-
# @!attribute password
|
|
169
|
-
# The password to be used as part of the credentials. Must be 8 to 128 characters
|
|
170
|
-
# long.
|
|
171
|
-
#
|
|
172
|
-
# @return [String, nil]
|
|
173
|
-
optional :password, String
|
|
174
|
-
|
|
175
|
-
# @!attribute record_type
|
|
176
|
-
# Identifies the type of the resource.
|
|
177
|
-
#
|
|
178
|
-
# @return [String, nil]
|
|
179
|
-
optional :record_type, String
|
|
180
|
-
|
|
181
|
-
# @!attribute registration_status
|
|
182
|
-
# The most recently known SIP registration status for this UAC connection.
|
|
183
|
-
#
|
|
184
|
-
# @return [String, nil]
|
|
185
|
-
optional :registration_status, String, nil?: true
|
|
186
|
-
|
|
187
|
-
# @!attribute registration_status_updated_at
|
|
188
|
-
# ISO 8601 formatted date indicating when the registration status was last
|
|
189
|
-
# updated.
|
|
190
|
-
#
|
|
191
|
-
# @return [String, nil]
|
|
192
|
-
optional :registration_status_updated_at, String, nil?: true
|
|
193
|
-
|
|
194
|
-
# @!attribute rtcp_settings
|
|
195
|
-
#
|
|
196
|
-
# @return [Telnyx::Models::ConnectionRtcpSettings, nil]
|
|
197
|
-
optional :rtcp_settings, -> { Telnyx::ConnectionRtcpSettings }
|
|
198
|
-
|
|
199
|
-
# @!attribute sip_uri_calling_preference
|
|
200
|
-
# This feature enables inbound SIP URI calls to your Credential Auth Connection.
|
|
201
|
-
# If enabled for all (unrestricted) then anyone who calls the SIP URI
|
|
202
|
-
# <your-username>@telnyx.com will be connected to your Connection. You can also
|
|
203
|
-
# choose to allow only calls that are originated on any Connections under your
|
|
204
|
-
# account (internal).
|
|
205
|
-
#
|
|
206
|
-
# @return [Symbol, Telnyx::Models::UacConnection::SipUriCallingPreference, nil]
|
|
207
|
-
optional :sip_uri_calling_preference, enum: -> { Telnyx::UacConnection::SipUriCallingPreference }
|
|
208
|
-
|
|
209
|
-
# @!attribute tags
|
|
210
|
-
# Tags associated with the connection.
|
|
211
|
-
#
|
|
212
|
-
# @return [Array<String>, nil]
|
|
213
|
-
optional :tags, Telnyx::Internal::Type::ArrayOf[String]
|
|
214
|
-
|
|
215
|
-
# @!attribute updated_at
|
|
216
|
-
# ISO-8601 formatted date indicating when the resource was updated.
|
|
217
|
-
#
|
|
218
|
-
# @return [String, nil]
|
|
219
|
-
optional :updated_at, String
|
|
220
|
-
|
|
221
|
-
# @!attribute user_name
|
|
222
|
-
# The user name to be used as part of the credentials. Must be 4-32 characters
|
|
223
|
-
# long and alphanumeric values only (no spaces or special characters). At least
|
|
224
|
-
# one of the first 5 characters must be a letter.
|
|
225
|
-
#
|
|
226
|
-
# @return [String, nil]
|
|
227
|
-
optional :user_name, String
|
|
228
|
-
|
|
229
|
-
# @!attribute webhook_api_version
|
|
230
|
-
# Determines which webhook format will be used, Telnyx API v1 or v2.
|
|
231
|
-
#
|
|
232
|
-
# @return [Symbol, Telnyx::Models::UacConnection::WebhookAPIVersion, nil]
|
|
233
|
-
optional :webhook_api_version, enum: -> { Telnyx::UacConnection::WebhookAPIVersion }
|
|
234
|
-
|
|
235
|
-
# @!attribute webhook_event_failover_url
|
|
236
|
-
# The failover URL where webhooks related to this connection will be sent if
|
|
237
|
-
# sending to the primary URL fails. Must include a scheme, such as 'https'.
|
|
238
|
-
#
|
|
239
|
-
# @return [String, nil]
|
|
240
|
-
optional :webhook_event_failover_url, String, nil?: true
|
|
241
|
-
|
|
242
|
-
# @!attribute webhook_event_url
|
|
243
|
-
# The URL where webhooks related to this connection will be sent. Must include a
|
|
244
|
-
# scheme, such as 'https'.
|
|
245
|
-
#
|
|
246
|
-
# @return [String, nil]
|
|
247
|
-
optional :webhook_event_url, String
|
|
248
|
-
|
|
249
|
-
# @!attribute webhook_timeout_secs
|
|
250
|
-
# Specifies how many seconds to wait before timing out a webhook.
|
|
251
|
-
#
|
|
252
|
-
# @return [Integer, nil]
|
|
253
|
-
optional :webhook_timeout_secs, Integer, nil?: true
|
|
254
|
-
|
|
255
|
-
# @!method initialize(id: nil, active: nil, anchorsite_override: nil, android_push_credential_id: nil, authentication: nil, call_cost_in_webhooks: nil, connection_name: nil, created_at: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, external_uac_settings: nil, fqdn: nil, fqdn_outbound_authentication: nil, fqdns: 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, record_type: nil, registration_status: nil, registration_status_updated_at: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, updated_at: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil)
|
|
256
|
-
# Some parameter documentations has been truncated, see
|
|
257
|
-
# {Telnyx::Models::UacConnection} for more details.
|
|
258
|
-
#
|
|
259
|
-
# A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite
|
|
260
|
-
# of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your
|
|
261
|
-
# PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the
|
|
262
|
-
# registration.
|
|
263
|
-
#
|
|
264
|
-
# @param id [String] Identifies the type of resource.
|
|
265
|
-
#
|
|
266
|
-
# @param active [Boolean] Defaults to true
|
|
267
|
-
#
|
|
268
|
-
# @param anchorsite_override [Symbol, Telnyx::Models::AnchorsiteOverride] `Latency` directs Telnyx to route media through the site with the lowest round-t
|
|
269
|
-
#
|
|
270
|
-
# @param android_push_credential_id [String, nil] The uuid of the push credential for Android
|
|
271
|
-
#
|
|
272
|
-
# @param authentication [Symbol, Telnyx::Models::UacConnection::Authentication] The authentication strategy used by this connection.
|
|
273
|
-
#
|
|
274
|
-
# @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
|
|
275
|
-
#
|
|
276
|
-
# @param connection_name [String]
|
|
277
|
-
#
|
|
278
|
-
# @param created_at [String] ISO-8601 formatted date indicating when the resource was created.
|
|
279
|
-
#
|
|
280
|
-
# @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
|
|
281
|
-
#
|
|
282
|
-
# @param dtmf_type [Symbol, Telnyx::Models::DtmfType] Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF
|
|
283
|
-
#
|
|
284
|
-
# @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
|
|
285
|
-
#
|
|
286
|
-
# @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
|
|
287
|
-
#
|
|
288
|
-
# @param external_uac_settings [Telnyx::Models::UacExternalSettings] External SIP peer settings used by Telnyx when registering to your PBX and routi
|
|
289
|
-
#
|
|
290
|
-
# @param fqdn [String] The Telnyx-managed FQDN generated for the UAC connection.
|
|
291
|
-
#
|
|
292
|
-
# @param fqdn_outbound_authentication [Symbol, Telnyx::Models::UacConnection::FqdnOutboundAuthentication] The fixed outbound authentication mode used by UAC FQDN records.
|
|
293
|
-
#
|
|
294
|
-
# @param fqdns [Array<Telnyx::Models::Fqdn>] FQDN records managed automatically by the UAC connection lifecycle.
|
|
295
|
-
#
|
|
296
|
-
# @param inbound [Telnyx::Models::UacInbound]
|
|
297
|
-
#
|
|
298
|
-
# @param internal_uac_settings [Telnyx::Models::UacInternalSettings] Internal Telnyx-side settings for a UAC connection.
|
|
299
|
-
#
|
|
300
|
-
# @param ios_push_credential_id [String, nil] The uuid of the push credential for Ios
|
|
301
|
-
#
|
|
302
|
-
# @param jitter_buffer [Telnyx::Models::ConnectionJitterBuffer] Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams o
|
|
303
|
-
#
|
|
304
|
-
# @param noise_suppression [Symbol, Telnyx::Models::UacConnection::NoiseSuppression] Controls when noise suppression is applied to calls. When set to 'inbound', nois
|
|
305
|
-
#
|
|
306
|
-
# @param noise_suppression_details [Telnyx::Models::ConnectionNoiseSuppressionDetails] Configuration options for noise suppression. These settings are stored regardles
|
|
307
|
-
#
|
|
308
|
-
# @param onnet_t38_passthrough_enabled [Boolean] Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly
|
|
309
|
-
#
|
|
310
|
-
# @param outbound [Telnyx::Models::UacOutbound]
|
|
311
|
-
#
|
|
312
|
-
# @param password [String] The password to be used as part of the credentials. Must be 8 to 128 characters
|
|
313
|
-
#
|
|
314
|
-
# @param record_type [String] Identifies the type of the resource.
|
|
315
|
-
#
|
|
316
|
-
# @param registration_status [String, nil] The most recently known SIP registration status for this UAC connection.
|
|
317
|
-
#
|
|
318
|
-
# @param registration_status_updated_at [String, nil] ISO 8601 formatted date indicating when the registration status was last updated
|
|
319
|
-
#
|
|
320
|
-
# @param rtcp_settings [Telnyx::Models::ConnectionRtcpSettings]
|
|
321
|
-
#
|
|
322
|
-
# @param sip_uri_calling_preference [Symbol, Telnyx::Models::UacConnection::SipUriCallingPreference] This feature enables inbound SIP URI calls to your Credential Auth Connection. I
|
|
323
|
-
#
|
|
324
|
-
# @param tags [Array<String>] Tags associated with the connection.
|
|
325
|
-
#
|
|
326
|
-
# @param updated_at [String] ISO-8601 formatted date indicating when the resource was updated.
|
|
327
|
-
#
|
|
328
|
-
# @param user_name [String] The user name to be used as part of the credentials. Must be 4-32 characters lon
|
|
329
|
-
#
|
|
330
|
-
# @param webhook_api_version [Symbol, Telnyx::Models::UacConnection::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1 or v2.
|
|
331
|
-
#
|
|
332
|
-
# @param webhook_event_failover_url [String, nil] The failover URL where webhooks related to this connection will be sent if sendi
|
|
333
|
-
#
|
|
334
|
-
# @param webhook_event_url [String] The URL where webhooks related to this connection will be sent. Must include a s
|
|
335
|
-
#
|
|
336
|
-
# @param webhook_timeout_secs [Integer, nil] Specifies how many seconds to wait before timing out a webhook.
|
|
337
|
-
|
|
338
|
-
# The authentication strategy used by this connection.
|
|
339
|
-
#
|
|
340
|
-
# @see Telnyx::Models::UacConnection#authentication
|
|
341
|
-
module Authentication
|
|
342
|
-
extend Telnyx::Internal::Type::Enum
|
|
343
|
-
|
|
344
|
-
UAC_AUTHENTICATION = :"uac-authentication"
|
|
345
|
-
|
|
346
|
-
# @!method self.values
|
|
347
|
-
# @return [Array<Symbol>]
|
|
348
|
-
end
|
|
349
|
-
|
|
350
|
-
# The fixed outbound authentication mode used by UAC FQDN records.
|
|
351
|
-
#
|
|
352
|
-
# @see Telnyx::Models::UacConnection#fqdn_outbound_authentication
|
|
353
|
-
module FqdnOutboundAuthentication
|
|
354
|
-
extend Telnyx::Internal::Type::Enum
|
|
355
|
-
|
|
356
|
-
CREDENTIAL_AUTHENTICATION = :"credential-authentication"
|
|
357
|
-
|
|
358
|
-
# @!method self.values
|
|
359
|
-
# @return [Array<Symbol>]
|
|
360
|
-
end
|
|
361
|
-
|
|
362
|
-
# Controls when noise suppression is applied to calls. When set to 'inbound',
|
|
363
|
-
# noise suppression is applied to incoming audio. When set to 'outbound', it's
|
|
364
|
-
# applied to outgoing audio. When set to 'both', it's applied in both directions.
|
|
365
|
-
# When set to 'disabled', noise suppression is turned off.
|
|
366
|
-
#
|
|
367
|
-
# @see Telnyx::Models::UacConnection#noise_suppression
|
|
368
|
-
module NoiseSuppression
|
|
369
|
-
extend Telnyx::Internal::Type::Enum
|
|
370
|
-
|
|
371
|
-
INBOUND = :inbound
|
|
372
|
-
OUTBOUND = :outbound
|
|
373
|
-
BOTH = :both
|
|
374
|
-
DISABLED = :disabled
|
|
375
|
-
|
|
376
|
-
# @!method self.values
|
|
377
|
-
# @return [Array<Symbol>]
|
|
378
|
-
end
|
|
379
|
-
|
|
380
|
-
# This feature enables inbound SIP URI calls to your Credential Auth Connection.
|
|
381
|
-
# If enabled for all (unrestricted) then anyone who calls the SIP URI
|
|
382
|
-
# <your-username>@telnyx.com will be connected to your Connection. You can also
|
|
383
|
-
# choose to allow only calls that are originated on any Connections under your
|
|
384
|
-
# account (internal).
|
|
385
|
-
#
|
|
386
|
-
# @see Telnyx::Models::UacConnection#sip_uri_calling_preference
|
|
387
|
-
module SipUriCallingPreference
|
|
388
|
-
extend Telnyx::Internal::Type::Enum
|
|
389
|
-
|
|
390
|
-
DISABLED = :disabled
|
|
391
|
-
UNRESTRICTED = :unrestricted
|
|
392
|
-
INTERNAL = :internal
|
|
393
|
-
|
|
394
|
-
# @!method self.values
|
|
395
|
-
# @return [Array<Symbol>]
|
|
396
|
-
end
|
|
397
|
-
|
|
398
|
-
# Determines which webhook format will be used, Telnyx API v1 or v2.
|
|
399
|
-
#
|
|
400
|
-
# @see Telnyx::Models::UacConnection#webhook_api_version
|
|
401
|
-
module WebhookAPIVersion
|
|
402
|
-
extend Telnyx::Internal::Type::Enum
|
|
403
|
-
|
|
404
|
-
V1 = :"1"
|
|
405
|
-
V2 = :"2"
|
|
406
|
-
|
|
407
|
-
# @!method self.values
|
|
408
|
-
# @return [Array<Symbol>]
|
|
409
|
-
end
|
|
410
|
-
end
|
|
411
|
-
end
|
|
412
|
-
end
|
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Telnyx
|
|
4
|
-
module Models
|
|
5
|
-
class UacExternalSettings < Telnyx::Internal::Type::BaseModel
|
|
6
|
-
# @!attribute auth_username
|
|
7
|
-
# The authentication username used in SIP digest authentication. If not set, the
|
|
8
|
-
# Username value will be used.
|
|
9
|
-
#
|
|
10
|
-
# @return [String, nil]
|
|
11
|
-
optional :auth_username, String, nil?: true
|
|
12
|
-
|
|
13
|
-
# @!attribute expiration_sec
|
|
14
|
-
# The registration interval, in seconds, indicating how often the system refreshes
|
|
15
|
-
# the SIP registration with the external SIP peer.
|
|
16
|
-
#
|
|
17
|
-
# @return [Integer, nil]
|
|
18
|
-
optional :expiration_sec, Integer, nil?: true
|
|
19
|
-
|
|
20
|
-
# @!attribute from_user
|
|
21
|
-
# The user portion of the SIP From header used in outbound requests. This controls
|
|
22
|
-
# the caller identity presented to the external SIP peer.
|
|
23
|
-
#
|
|
24
|
-
# @return [String, nil]
|
|
25
|
-
optional :from_user, String, nil?: true
|
|
26
|
-
|
|
27
|
-
# @!attribute outbound_proxy
|
|
28
|
-
# An optional SIP proxy used to route outbound requests before reaching the
|
|
29
|
-
# external SIP peer.
|
|
30
|
-
#
|
|
31
|
-
# @return [String, nil]
|
|
32
|
-
optional :outbound_proxy, String, nil?: true
|
|
33
|
-
|
|
34
|
-
# @!attribute password
|
|
35
|
-
# The SIP password used for digest authentication with the external SIP peer.
|
|
36
|
-
#
|
|
37
|
-
# @return [String, nil]
|
|
38
|
-
optional :password, String
|
|
39
|
-
|
|
40
|
-
# @!attribute proxy
|
|
41
|
-
# The SIP proxy address of the external SIP peer used for registrations and
|
|
42
|
-
# outbound call routing.
|
|
43
|
-
#
|
|
44
|
-
# @return [String, nil]
|
|
45
|
-
optional :proxy, String
|
|
46
|
-
|
|
47
|
-
# @!attribute transport
|
|
48
|
-
# The transport protocol used for SIP signaling when communicating with the
|
|
49
|
-
# external SIP peer. One of UDP, TLS, or TCP.
|
|
50
|
-
#
|
|
51
|
-
# @return [Symbol, Telnyx::Models::UacExternalSettings::Transport, nil]
|
|
52
|
-
optional :transport, enum: -> { Telnyx::UacExternalSettings::Transport }, nil?: true
|
|
53
|
-
|
|
54
|
-
# @!attribute username
|
|
55
|
-
# The SIP username used to authenticate with the external SIP peer for
|
|
56
|
-
# registrations and outbound calls. Must start with a letter or number and contain
|
|
57
|
-
# only letters, numbers, hyphens, and underscores.
|
|
58
|
-
#
|
|
59
|
-
# @return [String, nil]
|
|
60
|
-
optional :username, String
|
|
61
|
-
|
|
62
|
-
# @!method initialize(auth_username: nil, expiration_sec: nil, from_user: nil, outbound_proxy: nil, password: nil, proxy: nil, transport: nil, username: nil)
|
|
63
|
-
# Some parameter documentations has been truncated, see
|
|
64
|
-
# {Telnyx::Models::UacExternalSettings} for more details.
|
|
65
|
-
#
|
|
66
|
-
# External SIP peer settings used by Telnyx when registering to your PBX and
|
|
67
|
-
# routing outbound calls.
|
|
68
|
-
#
|
|
69
|
-
# @param auth_username [String, nil] The authentication username used in SIP digest authentication. If not set, the U
|
|
70
|
-
#
|
|
71
|
-
# @param expiration_sec [Integer, nil] The registration interval, in seconds, indicating how often the system refreshes
|
|
72
|
-
#
|
|
73
|
-
# @param from_user [String, nil] The user portion of the SIP From header used in outbound requests. This controls
|
|
74
|
-
#
|
|
75
|
-
# @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
|
|
76
|
-
#
|
|
77
|
-
# @param password [String] The SIP password used for digest authentication with the external SIP peer.
|
|
78
|
-
#
|
|
79
|
-
# @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
|
|
80
|
-
#
|
|
81
|
-
# @param transport [Symbol, Telnyx::Models::UacExternalSettings::Transport, nil] The transport protocol used for SIP signaling when communicating with the extern
|
|
82
|
-
#
|
|
83
|
-
# @param username [String] The SIP username used to authenticate with the external SIP peer for registratio
|
|
84
|
-
|
|
85
|
-
# The transport protocol used for SIP signaling when communicating with the
|
|
86
|
-
# external SIP peer. One of UDP, TLS, or TCP.
|
|
87
|
-
#
|
|
88
|
-
# @see Telnyx::Models::UacExternalSettings#transport
|
|
89
|
-
module Transport
|
|
90
|
-
extend Telnyx::Internal::Type::Enum
|
|
91
|
-
|
|
92
|
-
UDP = :UDP
|
|
93
|
-
TLS = :TLS
|
|
94
|
-
TCP = :TCP
|
|
95
|
-
|
|
96
|
-
# @!method self.values
|
|
97
|
-
# @return [Array<Symbol>]
|
|
98
|
-
end
|
|
99
|
-
end
|
|
100
|
-
end
|
|
101
|
-
end
|