telnyx 5.104.0 → 5.105.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2154962c4e4f5afd97c711f82206b39e6850e15b9380af208f7b7ef3ae60fa7b
4
- data.tar.gz: '068f80cd9166458d035233bd8a77428c6df724341d9fdaf58b4dc229fdc9e5f0'
3
+ metadata.gz: 00c56398477600183f977eeff58815a2cc7aaa8c9698ff8f56b59b27590bdd35
4
+ data.tar.gz: c2d9c2b3c47e12c4360a49835a7dcc46e68113a83b83d19ee2ae6ee27fc1b86e
5
5
  SHA512:
6
- metadata.gz: d0a6a1b2d40ab8fc74e635912e6b9e8399ded26087a7c3fd7615257466c62846545e5d9eb03d49628fbce130382432d34cc64e636bafe9a318ba00a0f7effc58
7
- data.tar.gz: 962b77ba9d3e53c837a067298b335e291d4dba926eff6d3b4b89e5961bb400582363a546e9bed4d90489cb9a714abb84cfdc7845be01e9e933a036d4b9e4b4d1
6
+ metadata.gz: fce247576924b863af47b999bc829f893d9fd60dfc2678b6589eb6ae54f61ba447c1575516d324e8cdc2ff348bbb38be6e101ec74caa5f4d170f3b678d7d4a7d
7
+ data.tar.gz: 5a26d164a5e24c72e4d6d83e18ad6a0339ee98d3e5c09379021a24203130c4e5267cdf308030271005e02e3f6465e6213a3d13bdcbb39b80e2bf660ba6d3702d
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.105.0 (2026-05-08)
4
+
5
+ Full Changelog: [v5.104.0...v5.105.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.104.0...v5.105.0)
6
+
7
+ ### Features
8
+
9
+ * Document per-endpoint media encryption for call control ([3423cf7](https://github.com/team-telnyx/telnyx-ruby/commit/3423cf75cd3f3102fced8d3e69c794159211f0b1))
10
+
3
11
  ## 5.104.0 (2026-05-08)
4
12
 
5
13
  Full Changelog: [v5.103.1...v5.104.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.103.1...v5.104.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.104.0"
27
+ gem "telnyx", "~> 5.105.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -23,7 +23,11 @@ module Telnyx
23
23
 
24
24
  # @!attribute to
25
25
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
26
- # using an array of strings
26
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
27
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
28
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
29
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
30
+ # per-endpoint `secure` URI parameter.
27
31
  #
28
32
  # @return [String, Array<String>]
29
33
  required :to, union: -> { Telnyx::CallDialParams::To }
@@ -161,7 +165,11 @@ module Telnyx
161
165
  optional :link_to, String
162
166
 
163
167
  # @!attribute media_encryption
164
- # Defines whether media should be encrypted on the call.
168
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
169
+ # media encryption can also be requested per endpoint with the `secure` URI
170
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
171
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
172
+ # over the per-endpoint `secure` value.
165
173
  #
166
174
  # @return [Symbol, Telnyx::Models::CallDialParams::MediaEncryption, nil]
167
175
  optional :media_encryption, enum: -> { Telnyx::CallDialParams::MediaEncryption }
@@ -492,7 +500,7 @@ module Telnyx
492
500
  #
493
501
  # @param link_to [String] Use another call's control id for sharing the same call session id
494
502
  #
495
- # @param media_encryption [Symbol, Telnyx::Models::CallDialParams::MediaEncryption] Defines whether media should be encrypted on the call.
503
+ # @param media_encryption [Symbol, Telnyx::Models::CallDialParams::MediaEncryption] Defines whether media should be encrypted on the call. For SIP URI destinations,
496
504
  #
497
505
  # @param media_name [String] The media_name of a file to be played back to the callee when the call is answer
498
506
  #
@@ -578,7 +586,11 @@ module Telnyx
578
586
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
579
587
 
580
588
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
581
- # using an array of strings
589
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
590
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
591
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
592
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
593
+ # per-endpoint `secure` URI parameter.
582
594
  module To
583
595
  extend Telnyx::Internal::Type::Union
584
596
 
@@ -937,7 +949,11 @@ module Telnyx
937
949
  # @param timeout [Integer] Maximum time in seconds to wait for a detection result before timing out.
938
950
  end
939
951
 
940
- # Defines whether media should be encrypted on the call.
952
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
953
+ # media encryption can also be requested per endpoint with the `secure` URI
954
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
955
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
956
+ # over the per-endpoint `secure` value.
941
957
  module MediaEncryption
942
958
  extend Telnyx::Internal::Type::Enum
943
959
 
@@ -14,7 +14,11 @@ module Telnyx
14
14
  required :call_control_id, String
15
15
 
16
16
  # @!attribute to
17
- # The DID or SIP URI to dial out to.
17
+ # The DID or SIP URI to dial out to. For SIP URI destinations, append
18
+ # `;secure=true` or `;secure=srtp` to enable SRTP media encryption for that
19
+ # endpoint, or `;secure=dtls` to enable DTLS media encryption for that endpoint.
20
+ # If `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
21
+ # per-endpoint `secure` URI parameter.
18
22
  #
19
23
  # @return [String]
20
24
  required :to, String
@@ -95,7 +99,11 @@ module Telnyx
95
99
  optional :from_display_name, String
96
100
 
97
101
  # @!attribute media_encryption
98
- # Defines whether media should be encrypted on the new call leg.
102
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
103
+ # destinations, media encryption can also be requested per endpoint with the
104
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
105
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
106
+ # precedence over the per-endpoint `secure` value.
99
107
  #
100
108
  # @return [Symbol, Telnyx::Models::Calls::ActionTransferParams::MediaEncryption, nil]
101
109
  optional :media_encryption, enum: -> { Telnyx::Calls::ActionTransferParams::MediaEncryption }
@@ -306,7 +314,7 @@ module Telnyx
306
314
  #
307
315
  # @param call_control_id [String]
308
316
  #
309
- # @param to [String] The DID or SIP URI to dial out to.
317
+ # @param to [String] The DID or SIP URI to dial out to. For SIP URI destinations, append `;secure=tru
310
318
  #
311
319
  # @param answering_machine_detection [Symbol, Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetection] Enables Answering Machine Detection. When a call is answered, Telnyx runs real-t
312
320
  #
@@ -326,7 +334,7 @@ module Telnyx
326
334
  #
327
335
  # @param from_display_name [String] The `from_display_name` string to be used as the caller id name (SIP From Displa
328
336
  #
329
- # @param media_encryption [Symbol, Telnyx::Models::Calls::ActionTransferParams::MediaEncryption] Defines whether media should be encrypted on the new call leg.
337
+ # @param media_encryption [Symbol, Telnyx::Models::Calls::ActionTransferParams::MediaEncryption] Defines whether media should be encrypted on the new call leg. For SIP URI desti
330
338
  #
331
339
  # @param media_name [String] The media_name of a file to be played back when the transfer destination answers
332
340
  #
@@ -501,7 +509,11 @@ module Telnyx
501
509
  # @param total_analysis_time_millis [Integer] Maximum timeout threshold for overall detection.
502
510
  end
503
511
 
504
- # Defines whether media should be encrypted on the new call leg.
512
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
513
+ # destinations, media encryption can also be requested per endpoint with the
514
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
515
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
516
+ # precedence over the per-endpoint `secure` value.
505
517
  module MediaEncryption
506
518
  extend Telnyx::Internal::Type::Enum
507
519
 
@@ -1625,7 +1625,7 @@ module Telnyx
1625
1625
  #
1626
1626
  # @param call_control_id [String] Unique identifier and token for controlling the call
1627
1627
  #
1628
- # @param to [String] The DID or SIP URI to dial out to.
1628
+ # @param to [String] The DID or SIP URI to dial out to. For SIP URI destinations, append `;secure=tru
1629
1629
  #
1630
1630
  # @param answering_machine_detection [Symbol, Telnyx::Models::Calls::ActionTransferParams::AnsweringMachineDetection] Enables Answering Machine Detection. When a call is answered, Telnyx runs real-t
1631
1631
  #
@@ -1645,7 +1645,7 @@ module Telnyx
1645
1645
  #
1646
1646
  # @param from_display_name [String] The `from_display_name` string to be used as the caller id name (SIP From Displa
1647
1647
  #
1648
- # @param media_encryption [Symbol, Telnyx::Models::Calls::ActionTransferParams::MediaEncryption] Defines whether media should be encrypted on the new call leg.
1648
+ # @param media_encryption [Symbol, Telnyx::Models::Calls::ActionTransferParams::MediaEncryption] Defines whether media should be encrypted on the new call leg. For SIP URI desti
1649
1649
  #
1650
1650
  # @param media_name [String] The media_name of a file to be played back when the transfer destination answers
1651
1651
  #
@@ -75,7 +75,7 @@ module Telnyx
75
75
  #
76
76
  # @param link_to [String] Use another call's control id for sharing the same call session id
77
77
  #
78
- # @param media_encryption [Symbol, Telnyx::Models::CallDialParams::MediaEncryption] Defines whether media should be encrypted on the call.
78
+ # @param media_encryption [Symbol, Telnyx::Models::CallDialParams::MediaEncryption] Defines whether media should be encrypted on the call. For SIP URI destinations,
79
79
  #
80
80
  # @param media_name [String] The media_name of a file to be played back to the callee when the call is answer
81
81
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.104.0"
4
+ VERSION = "5.105.0"
5
5
  end
@@ -22,7 +22,11 @@ module Telnyx
22
22
  attr_accessor :from
23
23
 
24
24
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
25
- # using an array of strings
25
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
26
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
27
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
28
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
29
+ # per-endpoint `secure` URI parameter.
26
30
  sig { returns(Telnyx::CallDialParams::To::Variants) }
27
31
  attr_accessor :to
28
32
 
@@ -201,7 +205,11 @@ module Telnyx
201
205
  sig { params(link_to: String).void }
202
206
  attr_writer :link_to
203
207
 
204
- # Defines whether media should be encrypted on the call.
208
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
209
+ # media encryption can also be requested per endpoint with the `secure` URI
210
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
211
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
212
+ # over the per-endpoint `secure` value.
205
213
  sig do
206
214
  returns(T.nilable(Telnyx::CallDialParams::MediaEncryption::OrSymbol))
207
215
  end
@@ -711,7 +719,11 @@ module Telnyx
711
719
  # number). The number should be in +E164 format.
712
720
  from:,
713
721
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
714
- # using an array of strings
722
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
723
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
724
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
725
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
726
+ # per-endpoint `secure` URI parameter.
715
727
  to:,
716
728
  # Enables Answering Machine Detection. Telnyx offers Premium and Standard
717
729
  # detections. With Premium detection, when a call is answered, Telnyx runs
@@ -780,7 +792,11 @@ module Telnyx
780
792
  from_display_name: nil,
781
793
  # Use another call's control id for sharing the same call session id
782
794
  link_to: nil,
783
- # Defines whether media should be encrypted on the call.
795
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
796
+ # media encryption can also be requested per endpoint with the `secure` URI
797
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
798
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
799
+ # over the per-endpoint `secure` value.
784
800
  media_encryption: nil,
785
801
  # The media_name of a file to be played back to the callee when the call is
786
802
  # answered. The media_name must point to a file previously uploaded to
@@ -990,7 +1006,11 @@ module Telnyx
990
1006
  end
991
1007
 
992
1008
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
993
- # using an array of strings
1009
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
1010
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
1011
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
1012
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
1013
+ # per-endpoint `secure` URI parameter.
994
1014
  module To
995
1015
  extend Telnyx::Internal::Type::Union
996
1016
 
@@ -1637,7 +1657,11 @@ module Telnyx
1637
1657
  end
1638
1658
  end
1639
1659
 
1640
- # Defines whether media should be encrypted on the call.
1660
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
1661
+ # media encryption can also be requested per endpoint with the `secure` URI
1662
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
1663
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
1664
+ # over the per-endpoint `secure` value.
1641
1665
  module MediaEncryption
1642
1666
  extend Telnyx::Internal::Type::Enum
1643
1667
 
@@ -18,7 +18,11 @@ module Telnyx
18
18
  sig { returns(String) }
19
19
  attr_accessor :call_control_id
20
20
 
21
- # The DID or SIP URI to dial out to.
21
+ # The DID or SIP URI to dial out to. For SIP URI destinations, append
22
+ # `;secure=true` or `;secure=srtp` to enable SRTP media encryption for that
23
+ # endpoint, or `;secure=dtls` to enable DTLS media encryption for that endpoint.
24
+ # If `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
25
+ # per-endpoint `secure` URI parameter.
22
26
  sig { returns(String) }
23
27
  attr_accessor :to
24
28
 
@@ -128,7 +132,11 @@ module Telnyx
128
132
  sig { params(from_display_name: String).void }
129
133
  attr_writer :from_display_name
130
134
 
131
- # Defines whether media should be encrypted on the new call leg.
135
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
136
+ # destinations, media encryption can also be requested per endpoint with the
137
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
138
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
139
+ # precedence over the per-endpoint `secure` value.
132
140
  sig do
133
141
  returns(
134
142
  T.nilable(
@@ -559,7 +567,11 @@ module Telnyx
559
567
  end
560
568
  def self.new(
561
569
  call_control_id:,
562
- # The DID or SIP URI to dial out to.
570
+ # The DID or SIP URI to dial out to. For SIP URI destinations, append
571
+ # `;secure=true` or `;secure=srtp` to enable SRTP media encryption for that
572
+ # endpoint, or `;secure=dtls` to enable DTLS media encryption for that endpoint.
573
+ # If `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
574
+ # per-endpoint `secure` URI parameter.
563
575
  to:,
564
576
  # Enables Answering Machine Detection. When a call is answered, Telnyx runs
565
577
  # real-time detection to determine if it was picked up by a human or a machine and
@@ -598,7 +610,11 @@ module Telnyx
598
610
  # -\_~!.+ special characters. If ommited, the display name will be the same as the
599
611
  # number in the `from` field.
600
612
  from_display_name: nil,
601
- # Defines whether media should be encrypted on the new call leg.
613
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
614
+ # destinations, media encryption can also be requested per endpoint with the
615
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
616
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
617
+ # precedence over the per-endpoint `secure` value.
602
618
  media_encryption: nil,
603
619
  # The media_name of a file to be played back when the transfer destination answers
604
620
  # before bridging the call. The media_name must point to a file previously
@@ -970,7 +986,11 @@ module Telnyx
970
986
  end
971
987
  end
972
988
 
973
- # Defines whether media should be encrypted on the new call leg.
989
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
990
+ # destinations, media encryption can also be requested per endpoint with the
991
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
992
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
993
+ # precedence over the per-endpoint `secure` value.
974
994
  module MediaEncryption
975
995
  extend Telnyx::Internal::Type::Enum
976
996
 
@@ -2035,7 +2035,11 @@ module Telnyx
2035
2035
  def transfer(
2036
2036
  # Unique identifier and token for controlling the call
2037
2037
  call_control_id,
2038
- # The DID or SIP URI to dial out to.
2038
+ # The DID or SIP URI to dial out to. For SIP URI destinations, append
2039
+ # `;secure=true` or `;secure=srtp` to enable SRTP media encryption for that
2040
+ # endpoint, or `;secure=dtls` to enable DTLS media encryption for that endpoint.
2041
+ # If `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
2042
+ # per-endpoint `secure` URI parameter.
2039
2043
  to:,
2040
2044
  # Enables Answering Machine Detection. When a call is answered, Telnyx runs
2041
2045
  # real-time detection to determine if it was picked up by a human or a machine and
@@ -2074,7 +2078,11 @@ module Telnyx
2074
2078
  # -\_~!.+ special characters. If ommited, the display name will be the same as the
2075
2079
  # number in the `from` field.
2076
2080
  from_display_name: nil,
2077
- # Defines whether media should be encrypted on the new call leg.
2081
+ # Defines whether media should be encrypted on the new call leg. For SIP URI
2082
+ # destinations, media encryption can also be requested per endpoint with the
2083
+ # `secure` URI parameter: `;secure=true` or `;secure=srtp` enables SRTP, and
2084
+ # `;secure=dtls` enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes
2085
+ # precedence over the per-endpoint `secure` value.
2078
2086
  media_encryption: nil,
2079
2087
  # The media_name of a file to be played back when the transfer destination answers
2080
2088
  # before bridging the call. The media_name must point to a file previously
@@ -117,7 +117,11 @@ module Telnyx
117
117
  # number). The number should be in +E164 format.
118
118
  from:,
119
119
  # The DID or SIP URI to dial out to. Multiple DID or SIP URIs can be provided
120
- # using an array of strings
120
+ # using an array of strings. For SIP URI destinations, append `;secure=true` or
121
+ # `;secure=srtp` to enable SRTP media encryption for that endpoint, or
122
+ # `;secure=dtls` to enable DTLS media encryption for that endpoint. If
123
+ # `media_encryption` is set to `SRTP` or `DTLS`, it takes precedence over any
124
+ # per-endpoint `secure` URI parameter.
121
125
  to:,
122
126
  # Enables Answering Machine Detection. Telnyx offers Premium and Standard
123
127
  # detections. With Premium detection, when a call is answered, Telnyx runs
@@ -186,7 +190,11 @@ module Telnyx
186
190
  from_display_name: nil,
187
191
  # Use another call's control id for sharing the same call session id
188
192
  link_to: nil,
189
- # Defines whether media should be encrypted on the call.
193
+ # Defines whether media should be encrypted on the call. For SIP URI destinations,
194
+ # media encryption can also be requested per endpoint with the `secure` URI
195
+ # parameter: `;secure=true` or `;secure=srtp` enables SRTP, and `;secure=dtls`
196
+ # enables DTLS. This parameter, when set to `SRTP` or `DTLS`, takes precedence
197
+ # over the per-endpoint `secure` value.
190
198
  media_encryption: nil,
191
199
  # The media_name of a file to be played back to the callee when the call is
192
200
  # answered. The media_name must point to a file previously uploaded to
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.104.0
4
+ version: 5.105.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx