telnyx 5.99.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +5 -0
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +128 -7
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +131 -7
- data/lib/telnyx/models/uac_connection_create_params.rb +738 -0
- data/lib/telnyx/models/uac_connection_create_response.rb +898 -0
- data/lib/telnyx/models/uac_connection_delete_params.rb +20 -0
- data/lib/telnyx/models/uac_connection_delete_response.rb +898 -0
- data/lib/telnyx/models/uac_connection_list_params.rb +143 -0
- data/lib/telnyx/models/uac_connection_list_response.rb +876 -0
- data/lib/telnyx/models/uac_connection_retrieve_params.rb +20 -0
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +899 -0
- data/lib/telnyx/models/uac_connection_update_params.rb +740 -0
- data/lib/telnyx/models/uac_connection_update_response.rb +898 -0
- data/lib/telnyx/models/uac_connections/action_check_registration_status_params.rb +22 -0
- data/lib/telnyx/models/uac_connections/action_check_registration_status_response.rb +104 -0
- data/lib/telnyx/models.rb +12 -0
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +6 -10
- data/lib/telnyx/resources/uac_connections/actions.rb +39 -0
- data/lib/telnyx/resources/uac_connections.rb +256 -0
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +14 -1
- data/rbi/telnyx/client.rbi +4 -0
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +303 -10
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +309 -9
- data/rbi/telnyx/models/uac_connection_create_params.rbi +1465 -0
- data/rbi/telnyx/models/uac_connection_create_response.rbi +1793 -0
- data/rbi/telnyx/models/uac_connection_delete_params.rbi +35 -0
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +1793 -0
- data/rbi/telnyx/models/uac_connection_list_params.rbi +261 -0
- data/rbi/telnyx/models/uac_connection_list_response.rbi +1727 -0
- data/rbi/telnyx/models/uac_connection_retrieve_params.rbi +35 -0
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +1793 -0
- data/rbi/telnyx/models/uac_connection_update_params.rbi +1463 -0
- data/rbi/telnyx/models/uac_connection_update_response.rbi +1793 -0
- data/rbi/telnyx/models/uac_connections/action_check_registration_status_params.rbi +40 -0
- data/rbi/telnyx/models/uac_connections/action_check_registration_status_response.rbi +237 -0
- data/rbi/telnyx/models.rbi +12 -0
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +6 -14
- data/rbi/telnyx/resources/uac_connections/actions.rbi +33 -0
- data/rbi/telnyx/resources/uac_connections.rbi +348 -0
- data/sig/telnyx/client.rbs +2 -0
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +113 -4
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +113 -8
- data/sig/telnyx/models/uac_connection_create_params.rbs +609 -0
- data/sig/telnyx/models/uac_connection_create_response.rbs +741 -0
- data/sig/telnyx/models/uac_connection_delete_params.rbs +20 -0
- data/sig/telnyx/models/uac_connection_delete_response.rbs +741 -0
- data/sig/telnyx/models/uac_connection_list_params.rbs +112 -0
- data/sig/telnyx/models/uac_connection_list_response.rbs +722 -0
- data/sig/telnyx/models/uac_connection_retrieve_params.rbs +20 -0
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +741 -0
- data/sig/telnyx/models/uac_connection_update_params.rbs +615 -0
- data/sig/telnyx/models/uac_connection_update_response.rbs +741 -0
- data/sig/telnyx/models/uac_connections/action_check_registration_status_params.rbs +22 -0
- data/sig/telnyx/models/uac_connections/action_check_registration_status_response.rbs +117 -0
- data/sig/telnyx/models.rbs +12 -0
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/uac_connections/actions.rbs +14 -0
- data/sig/telnyx/resources/uac_connections.rbs +90 -0
- metadata +44 -5
- data/lib/telnyx/models/ai/assistants/version_config.rb +0 -30
- data/rbi/telnyx/models/ai/assistants/version_config.rbi +0 -45
- 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,
|
|
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,
|
|
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,
|
|
@@ -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
|
data/lib/telnyx/version.rb
CHANGED
data/lib/telnyx.rb
CHANGED
|
@@ -185,7 +185,6 @@ require_relative "telnyx/models/ai/assistants/tool_remove_params"
|
|
|
185
185
|
require_relative "telnyx/models/ai/assistants/tool_remove_response"
|
|
186
186
|
require_relative "telnyx/models/ai/assistants/tool_test_params"
|
|
187
187
|
require_relative "telnyx/models/ai/assistants/tool_test_response"
|
|
188
|
-
require_relative "telnyx/models/ai/assistants/version_config"
|
|
189
188
|
require_relative "telnyx/models/ai/assistants/version_delete_params"
|
|
190
189
|
require_relative "telnyx/models/ai/assistants/version_list_params"
|
|
191
190
|
require_relative "telnyx/models/ai/assistants/version_promote_params"
|
|
@@ -2201,6 +2200,18 @@ require_relative "telnyx/models/traffic_type"
|
|
|
2201
2200
|
require_relative "telnyx/models/transcription"
|
|
2202
2201
|
require_relative "telnyx/models/transcription_webhook_event"
|
|
2203
2202
|
require_relative "telnyx/models/transport_protocol"
|
|
2203
|
+
require_relative "telnyx/models/uac_connection_create_params"
|
|
2204
|
+
require_relative "telnyx/models/uac_connection_create_response"
|
|
2205
|
+
require_relative "telnyx/models/uac_connection_delete_params"
|
|
2206
|
+
require_relative "telnyx/models/uac_connection_delete_response"
|
|
2207
|
+
require_relative "telnyx/models/uac_connection_list_params"
|
|
2208
|
+
require_relative "telnyx/models/uac_connection_list_response"
|
|
2209
|
+
require_relative "telnyx/models/uac_connection_retrieve_params"
|
|
2210
|
+
require_relative "telnyx/models/uac_connection_retrieve_response"
|
|
2211
|
+
require_relative "telnyx/models/uac_connections/action_check_registration_status_params"
|
|
2212
|
+
require_relative "telnyx/models/uac_connections/action_check_registration_status_response"
|
|
2213
|
+
require_relative "telnyx/models/uac_connection_update_params"
|
|
2214
|
+
require_relative "telnyx/models/uac_connection_update_response"
|
|
2204
2215
|
require_relative "telnyx/models/unsafe_unwrap_webhook_event"
|
|
2205
2216
|
require_relative "telnyx/models/unwrap_webhook_event"
|
|
2206
2217
|
require_relative "telnyx/models/update_regulatory_requirement"
|
|
@@ -2679,6 +2690,8 @@ require_relative "telnyx/resources/texml/accounts/transcriptions/json"
|
|
|
2679
2690
|
require_relative "telnyx/resources/texml_applications"
|
|
2680
2691
|
require_relative "telnyx/resources/text_to_speech"
|
|
2681
2692
|
require_relative "telnyx/resources/traffic_policy_profiles"
|
|
2693
|
+
require_relative "telnyx/resources/uac_connections"
|
|
2694
|
+
require_relative "telnyx/resources/uac_connections/actions"
|
|
2682
2695
|
require_relative "telnyx/resources/usage_reports"
|
|
2683
2696
|
require_relative "telnyx/resources/user_addresses"
|
|
2684
2697
|
require_relative "telnyx/resources/user_tags"
|
data/rbi/telnyx/client.rbi
CHANGED
|
@@ -654,6 +654,10 @@ module Telnyx
|
|
|
654
654
|
sig { returns(Telnyx::Resources::PronunciationDicts) }
|
|
655
655
|
attr_reader :pronunciation_dicts
|
|
656
656
|
|
|
657
|
+
# UAC connection operations
|
|
658
|
+
sig { returns(Telnyx::Resources::UacConnections) }
|
|
659
|
+
attr_reader :uac_connections
|
|
660
|
+
|
|
657
661
|
# @api private
|
|
658
662
|
sig { override.returns(T::Hash[String, String]) }
|
|
659
663
|
private def auth_headers
|