telnyx 5.84.0 → 5.86.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 +17 -0
- data/README.md +1 -1
- data/lib/telnyx/client.rb +15 -1
- data/lib/telnyx/models/ai/transcription_settings.rb +32 -13
- data/lib/telnyx/models/ai/transcription_settings_config.rb +30 -1
- data/lib/telnyx/models/verify_profile.rb +17 -71
- data/lib/telnyx/models/verify_profile_create_params.rb +25 -69
- data/lib/telnyx/models/verify_profile_update_params.rb +23 -111
- data/lib/telnyx/resources/verify_profiles.rb +17 -6
- data/lib/telnyx/version.rb +1 -1
- data/rbi/telnyx/models/ai/transcription_settings.rbi +51 -16
- data/rbi/telnyx/models/ai/transcription_settings_config.rbi +43 -0
- data/rbi/telnyx/models/verify_profile.rbi +22 -115
- data/rbi/telnyx/models/verify_profile_create_params.rbi +22 -118
- data/rbi/telnyx/models/verify_profile_update_params.rbi +20 -205
- data/rbi/telnyx/resources/verify_profiles.rbi +12 -6
- data/sig/telnyx/models/ai/transcription_settings.rbs +11 -0
- data/sig/telnyx/models/ai/transcription_settings_config.rbs +21 -0
- data/sig/telnyx/models/verify_profile.rbs +14 -61
- data/sig/telnyx/models/verify_profile_create_params.rbs +14 -63
- data/sig/telnyx/models/verify_profile_update_params.rbs +12 -103
- data/sig/telnyx/resources/verify_profiles.rbs +4 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 58f14afb44760134bc518d5f2fd19404bd2a28c981ba0f7b81ddf51c547c41ac
|
|
4
|
+
data.tar.gz: ba86eec94a309b3a7d4e1427da30e77a4b6ecec181618ea26d4d5d948f07a89e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7553900c258c350fd8c90bcfd8466293bd66b3897ee236ece1ae92f94b71ae64fe1e4c5ee5996c45377fa57334f5c071b775ea7c5b750cc88524d1fc8906e359
|
|
7
|
+
data.tar.gz: f4e3e68cea49f93617ac8f50c3a3110a4da031a72dcc0b1ff7c4008072920695d18ee9f82185138fec0afe12cee8123c1821bda9bf842cafef443eebcb28ca87
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.86.0 (2026-04-28)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.85.0...v5.86.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.85.0...v5.86.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* Fix CreateVerifyProfileRequest to match messaging-2fa schema ([e64fe7b](https://github.com/team-telnyx/telnyx-ruby/commit/e64fe7bc0d090d86080445a4dbe149a216a09895))
|
|
10
|
+
* Update assistant transcription settings spec ([172cab5](https://github.com/team-telnyx/telnyx-ruby/commit/172cab549f428deb1fe9432bf91a1fa7fa9a9956))
|
|
11
|
+
|
|
12
|
+
## 5.85.0 (2026-04-27)
|
|
13
|
+
|
|
14
|
+
Full Changelog: [v5.84.0...v5.85.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.84.0...v5.85.0)
|
|
15
|
+
|
|
16
|
+
### Features
|
|
17
|
+
|
|
18
|
+
* support setting headers via env ([2a11578](https://github.com/team-telnyx/telnyx-ruby/commit/2a115784f4f9d877a679db44a49a5c6ce05ac0f4))
|
|
19
|
+
|
|
3
20
|
## 5.84.0 (2026-04-24)
|
|
4
21
|
|
|
5
22
|
Full Changelog: [v5.83.0...v5.84.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.83.0...v5.84.0)
|
data/README.md
CHANGED
data/lib/telnyx/client.rb
CHANGED
|
@@ -740,6 +740,19 @@ module Telnyx
|
|
|
740
740
|
|
|
741
741
|
base_url ||= "https://api.telnyx.com/v2"
|
|
742
742
|
|
|
743
|
+
headers = {}
|
|
744
|
+
custom_headers_env = ENV["TELNYX_CUSTOM_HEADERS"]
|
|
745
|
+
unless custom_headers_env.nil?
|
|
746
|
+
parsed = {}
|
|
747
|
+
custom_headers_env.split("\n").each do |line|
|
|
748
|
+
colon = line.index(":")
|
|
749
|
+
unless colon.nil?
|
|
750
|
+
parsed[line[0...colon].strip] = line[(colon + 1)..].strip
|
|
751
|
+
end
|
|
752
|
+
end
|
|
753
|
+
headers = parsed.merge(headers)
|
|
754
|
+
end
|
|
755
|
+
|
|
743
756
|
@api_key = api_key&.to_s
|
|
744
757
|
@client_id = client_id&.to_s
|
|
745
758
|
@client_secret = client_secret&.to_s
|
|
@@ -750,7 +763,8 @@ module Telnyx
|
|
|
750
763
|
timeout: timeout,
|
|
751
764
|
max_retries: max_retries,
|
|
752
765
|
initial_retry_delay: initial_retry_delay,
|
|
753
|
-
max_retry_delay: max_retry_delay
|
|
766
|
+
max_retry_delay: max_retry_delay,
|
|
767
|
+
headers: headers
|
|
754
768
|
)
|
|
755
769
|
|
|
756
770
|
@legacy = Telnyx::Resources::Legacy.new(client: self)
|
|
@@ -4,27 +4,38 @@ module Telnyx
|
|
|
4
4
|
module Models
|
|
5
5
|
module AI
|
|
6
6
|
class TranscriptionSettings < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute api_key_ref
|
|
8
|
+
# Integration secret identifier for the transcription provider API key. Currently
|
|
9
|
+
# used for Azure transcription regions that require a customer-provided API key.
|
|
10
|
+
#
|
|
11
|
+
# @return [String, nil]
|
|
12
|
+
optional :api_key_ref, String
|
|
13
|
+
|
|
7
14
|
# @!attribute language
|
|
8
|
-
# The language of the audio to be transcribed. If not set,
|
|
15
|
+
# The language of the audio to be transcribed. If not set, or if set to `auto`,
|
|
9
16
|
# the model will automatically detect the language.
|
|
10
17
|
#
|
|
11
18
|
# @return [String, nil]
|
|
12
19
|
optional :language, String
|
|
13
20
|
|
|
14
21
|
# @!attribute model
|
|
15
|
-
# The speech to text model to be used by the voice assistant. All
|
|
16
|
-
#
|
|
22
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
23
|
+
# are run on-premise.
|
|
17
24
|
#
|
|
18
25
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
19
|
-
# - `deepgram/nova-3` is
|
|
20
|
-
#
|
|
26
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
27
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
28
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
29
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
30
|
+
# configurable turn detection.
|
|
31
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
21
32
|
#
|
|
22
33
|
# @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
|
|
23
34
|
optional :model, enum: -> { Telnyx::AI::TranscriptionSettings::Model }
|
|
24
35
|
|
|
25
36
|
# @!attribute region
|
|
26
37
|
# Region on third party cloud providers (currently Azure) if using one of their
|
|
27
|
-
# models
|
|
38
|
+
# models. Some regions require `api_key_ref`.
|
|
28
39
|
#
|
|
29
40
|
# @return [String, nil]
|
|
30
41
|
optional :region, String
|
|
@@ -34,24 +45,30 @@ module Telnyx
|
|
|
34
45
|
# @return [Telnyx::Models::AI::TranscriptionSettingsConfig, nil]
|
|
35
46
|
optional :settings, -> { Telnyx::AI::TranscriptionSettingsConfig }
|
|
36
47
|
|
|
37
|
-
# @!method initialize(language: nil, model: nil, region: nil, settings: nil)
|
|
48
|
+
# @!method initialize(api_key_ref: nil, language: nil, model: nil, region: nil, settings: nil)
|
|
38
49
|
# Some parameter documentations has been truncated, see
|
|
39
50
|
# {Telnyx::Models::AI::TranscriptionSettings} for more details.
|
|
40
51
|
#
|
|
41
|
-
# @param
|
|
52
|
+
# @param api_key_ref [String] Integration secret identifier for the transcription provider API key. Currently
|
|
53
|
+
#
|
|
54
|
+
# @param language [String] The language of the audio to be transcribed. If not set, or if set to `auto`, th
|
|
42
55
|
#
|
|
43
|
-
# @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All
|
|
56
|
+
# @param model [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model] The speech to text model to be used by the voice assistant. All Deepgram models
|
|
44
57
|
#
|
|
45
58
|
# @param region [String] Region on third party cloud providers (currently Azure) if using one of their mo
|
|
46
59
|
#
|
|
47
60
|
# @param settings [Telnyx::Models::AI::TranscriptionSettingsConfig]
|
|
48
61
|
|
|
49
|
-
# The speech to text model to be used by the voice assistant. All
|
|
50
|
-
#
|
|
62
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
63
|
+
# are run on-premise.
|
|
51
64
|
#
|
|
52
65
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
53
|
-
# - `deepgram/nova-3` is
|
|
54
|
-
#
|
|
66
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
67
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
68
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
69
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
70
|
+
# configurable turn detection.
|
|
71
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
55
72
|
#
|
|
56
73
|
# @see Telnyx::Models::AI::TranscriptionSettings#model
|
|
57
74
|
module Model
|
|
@@ -61,6 +78,8 @@ module Telnyx
|
|
|
61
78
|
DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
|
|
62
79
|
DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
|
|
63
80
|
AZURE_FAST = :"azure/fast"
|
|
81
|
+
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
82
|
+
XAI_GROK_STT = :"xai/grok-stt"
|
|
64
83
|
DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
|
|
65
84
|
OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
|
|
66
85
|
|
|
@@ -12,6 +12,14 @@ module Telnyx
|
|
|
12
12
|
# @return [Float, nil]
|
|
13
13
|
optional :eager_eot_threshold, Float
|
|
14
14
|
|
|
15
|
+
# @!attribute end_of_turn_confidence_threshold
|
|
16
|
+
# Available only for assemblyai/universal-streaming. Confidence level required to
|
|
17
|
+
# trigger an end of turn. Higher values require more certainty before ending a
|
|
18
|
+
# turn.
|
|
19
|
+
#
|
|
20
|
+
# @return [Float, nil]
|
|
21
|
+
optional :end_of_turn_confidence_threshold, Float
|
|
22
|
+
|
|
15
23
|
# @!attribute eot_threshold
|
|
16
24
|
# Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
17
25
|
# Higher values = more reliable turn detection but slightly increased latency.
|
|
@@ -34,6 +42,21 @@ module Telnyx
|
|
|
34
42
|
# @return [String, nil]
|
|
35
43
|
optional :keyterm, String
|
|
36
44
|
|
|
45
|
+
# @!attribute max_turn_silence
|
|
46
|
+
# Available only for assemblyai/universal-streaming. Maximum duration of silence
|
|
47
|
+
# in milliseconds before forcing an end of turn.
|
|
48
|
+
#
|
|
49
|
+
# @return [Integer, nil]
|
|
50
|
+
optional :max_turn_silence, Integer
|
|
51
|
+
|
|
52
|
+
# @!attribute min_turn_silence
|
|
53
|
+
# Available only for assemblyai/universal-streaming. Minimum duration of silence
|
|
54
|
+
# in milliseconds before a turn can end. Must be less than or equal to
|
|
55
|
+
# max_turn_silence.
|
|
56
|
+
#
|
|
57
|
+
# @return [Integer, nil]
|
|
58
|
+
optional :min_turn_silence, Integer
|
|
59
|
+
|
|
37
60
|
# @!attribute numerals
|
|
38
61
|
#
|
|
39
62
|
# @return [Boolean, nil]
|
|
@@ -44,18 +67,24 @@ module Telnyx
|
|
|
44
67
|
# @return [Boolean, nil]
|
|
45
68
|
optional :smart_format, Telnyx::Internal::Type::Boolean
|
|
46
69
|
|
|
47
|
-
# @!method initialize(eager_eot_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, keyterm: nil, numerals: nil, smart_format: nil)
|
|
70
|
+
# @!method initialize(eager_eot_threshold: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, keyterm: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil)
|
|
48
71
|
# Some parameter documentations has been truncated, see
|
|
49
72
|
# {Telnyx::Models::AI::TranscriptionSettingsConfig} for more details.
|
|
50
73
|
#
|
|
51
74
|
# @param eager_eot_threshold [Float] Available only for deepgram/flux. Confidence threshold for eager end of turn det
|
|
52
75
|
#
|
|
76
|
+
# @param end_of_turn_confidence_threshold [Float] Available only for assemblyai/universal-streaming. Confidence level required to
|
|
77
|
+
#
|
|
53
78
|
# @param eot_threshold [Float] Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
54
79
|
#
|
|
55
80
|
# @param eot_timeout_ms [Integer] Available only for deepgram/flux. Maximum milliseconds of silence before forcing
|
|
56
81
|
#
|
|
57
82
|
# @param keyterm [String] Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
|
|
58
83
|
#
|
|
84
|
+
# @param max_turn_silence [Integer] Available only for assemblyai/universal-streaming. Maximum duration of silence i
|
|
85
|
+
#
|
|
86
|
+
# @param min_turn_silence [Integer] Available only for assemblyai/universal-streaming. Minimum duration of silence i
|
|
87
|
+
#
|
|
59
88
|
# @param numerals [Boolean]
|
|
60
89
|
#
|
|
61
90
|
# @param smart_format [Boolean]
|
|
@@ -19,6 +19,18 @@ module Telnyx
|
|
|
19
19
|
# @return [String, nil]
|
|
20
20
|
optional :created_at, String
|
|
21
21
|
|
|
22
|
+
# @!attribute daily_spend_limit
|
|
23
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
24
|
+
#
|
|
25
|
+
# @return [Float, nil]
|
|
26
|
+
optional :daily_spend_limit, Float
|
|
27
|
+
|
|
28
|
+
# @!attribute daily_spend_limit_enabled
|
|
29
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
30
|
+
#
|
|
31
|
+
# @return [Boolean, nil]
|
|
32
|
+
optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean
|
|
33
|
+
|
|
22
34
|
# @!attribute flashcall
|
|
23
35
|
#
|
|
24
36
|
# @return [Telnyx::Models::VerifyProfile::Flashcall, nil]
|
|
@@ -34,11 +46,6 @@ module Telnyx
|
|
|
34
46
|
# @return [String, nil]
|
|
35
47
|
optional :name, String
|
|
36
48
|
|
|
37
|
-
# @!attribute rcs
|
|
38
|
-
#
|
|
39
|
-
# @return [Telnyx::Models::VerifyProfile::Rcs, nil]
|
|
40
|
-
optional :rcs, -> { Telnyx::VerifyProfile::Rcs }
|
|
41
|
-
|
|
42
49
|
# @!attribute record_type
|
|
43
50
|
# The possible verification profile record types.
|
|
44
51
|
#
|
|
@@ -70,21 +77,23 @@ module Telnyx
|
|
|
70
77
|
# @return [Telnyx::Models::VerifyProfile::Whatsapp, nil]
|
|
71
78
|
optional :whatsapp, -> { Telnyx::VerifyProfile::Whatsapp }
|
|
72
79
|
|
|
73
|
-
# @!method initialize(id: nil, call: nil, created_at: nil,
|
|
80
|
+
# @!method initialize(id: nil, call: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, flashcall: nil, language: nil, name: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil)
|
|
74
81
|
# @param id [String]
|
|
75
82
|
#
|
|
76
83
|
# @param call [Telnyx::Models::VerifyProfile::Call]
|
|
77
84
|
#
|
|
78
85
|
# @param created_at [String]
|
|
79
86
|
#
|
|
87
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
88
|
+
#
|
|
89
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
90
|
+
#
|
|
80
91
|
# @param flashcall [Telnyx::Models::VerifyProfile::Flashcall]
|
|
81
92
|
#
|
|
82
93
|
# @param language [String]
|
|
83
94
|
#
|
|
84
95
|
# @param name [String]
|
|
85
96
|
#
|
|
86
|
-
# @param rcs [Telnyx::Models::VerifyProfile::Rcs]
|
|
87
|
-
#
|
|
88
97
|
# @param record_type [Symbol, Telnyx::Models::VerifyProfile::RecordType] The possible verification profile record types.
|
|
89
98
|
#
|
|
90
99
|
# @param sms [Telnyx::Models::VerifyProfile::SMS]
|
|
@@ -179,69 +188,6 @@ module Telnyx
|
|
|
179
188
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
180
189
|
end
|
|
181
190
|
|
|
182
|
-
# @see Telnyx::Models::VerifyProfile#rcs
|
|
183
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
184
|
-
# @!attribute app_name
|
|
185
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
186
|
-
# message.
|
|
187
|
-
#
|
|
188
|
-
# @return [String, nil]
|
|
189
|
-
optional :app_name, String
|
|
190
|
-
|
|
191
|
-
# @!attribute code_length
|
|
192
|
-
# The length of the verify code to generate.
|
|
193
|
-
#
|
|
194
|
-
# @return [Integer, nil]
|
|
195
|
-
optional :code_length, Integer
|
|
196
|
-
|
|
197
|
-
# @!attribute default_verification_timeout_secs
|
|
198
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
199
|
-
# number of seconds before a verification request code expires. Once the
|
|
200
|
-
# verification request expires, the user cannot use the code to verify their
|
|
201
|
-
# identity.
|
|
202
|
-
#
|
|
203
|
-
# @return [Integer, nil]
|
|
204
|
-
optional :default_verification_timeout_secs, Integer
|
|
205
|
-
|
|
206
|
-
# @!attribute messaging_template_id
|
|
207
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
208
|
-
#
|
|
209
|
-
# @return [String, nil]
|
|
210
|
-
optional :messaging_template_id, String
|
|
211
|
-
|
|
212
|
-
# @!attribute sms_fallback
|
|
213
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
214
|
-
#
|
|
215
|
-
# @return [Boolean, nil]
|
|
216
|
-
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
217
|
-
|
|
218
|
-
# @!attribute whitelisted_destinations
|
|
219
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
220
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
221
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
222
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
223
|
-
# destinations; otherwise it is optional.
|
|
224
|
-
#
|
|
225
|
-
# @return [Array<String>, nil]
|
|
226
|
-
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
227
|
-
|
|
228
|
-
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
229
|
-
# Some parameter documentations has been truncated, see
|
|
230
|
-
# {Telnyx::Models::VerifyProfile::Rcs} for more details.
|
|
231
|
-
#
|
|
232
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
233
|
-
#
|
|
234
|
-
# @param code_length [Integer] The length of the verify code to generate.
|
|
235
|
-
#
|
|
236
|
-
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
237
|
-
#
|
|
238
|
-
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
239
|
-
#
|
|
240
|
-
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
241
|
-
#
|
|
242
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
243
|
-
end
|
|
244
|
-
|
|
245
191
|
# The possible verification profile record types.
|
|
246
192
|
#
|
|
247
193
|
# @see Telnyx::Models::VerifyProfile#record_type
|
|
@@ -17,6 +17,18 @@ module Telnyx
|
|
|
17
17
|
# @return [Telnyx::Models::VerifyProfileCreateParams::Call, nil]
|
|
18
18
|
optional :call, -> { Telnyx::VerifyProfileCreateParams::Call }
|
|
19
19
|
|
|
20
|
+
# @!attribute daily_spend_limit
|
|
21
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
22
|
+
#
|
|
23
|
+
# @return [Float, nil]
|
|
24
|
+
optional :daily_spend_limit, Float
|
|
25
|
+
|
|
26
|
+
# @!attribute daily_spend_limit_enabled
|
|
27
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
28
|
+
#
|
|
29
|
+
# @return [Boolean, nil]
|
|
30
|
+
optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean
|
|
31
|
+
|
|
20
32
|
# @!attribute flashcall
|
|
21
33
|
#
|
|
22
34
|
# @return [Telnyx::Models::VerifyProfileCreateParams::Flashcall, nil]
|
|
@@ -27,11 +39,6 @@ module Telnyx
|
|
|
27
39
|
# @return [String, nil]
|
|
28
40
|
optional :language, String
|
|
29
41
|
|
|
30
|
-
# @!attribute rcs
|
|
31
|
-
#
|
|
32
|
-
# @return [Telnyx::Models::VerifyProfileCreateParams::Rcs, nil]
|
|
33
|
-
optional :rcs, -> { Telnyx::VerifyProfileCreateParams::Rcs }
|
|
34
|
-
|
|
35
42
|
# @!attribute sms
|
|
36
43
|
#
|
|
37
44
|
# @return [Telnyx::Models::VerifyProfileCreateParams::SMS, nil]
|
|
@@ -52,16 +59,27 @@ module Telnyx
|
|
|
52
59
|
# @return [Telnyx::Models::VerifyProfileCreateParams::Whatsapp, nil]
|
|
53
60
|
optional :whatsapp, -> { Telnyx::VerifyProfileCreateParams::Whatsapp }
|
|
54
61
|
|
|
55
|
-
# @!method initialize(name:, call: nil,
|
|
62
|
+
# @!method initialize(name:, call: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, flashcall: nil, language: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil, request_options: {})
|
|
56
63
|
# @param name [String]
|
|
64
|
+
#
|
|
57
65
|
# @param call [Telnyx::Models::VerifyProfileCreateParams::Call]
|
|
66
|
+
#
|
|
67
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
68
|
+
#
|
|
69
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
70
|
+
#
|
|
58
71
|
# @param flashcall [Telnyx::Models::VerifyProfileCreateParams::Flashcall]
|
|
72
|
+
#
|
|
59
73
|
# @param language [String]
|
|
60
|
-
#
|
|
74
|
+
#
|
|
61
75
|
# @param sms [Telnyx::Models::VerifyProfileCreateParams::SMS]
|
|
76
|
+
#
|
|
62
77
|
# @param webhook_failover_url [String]
|
|
78
|
+
#
|
|
63
79
|
# @param webhook_url [String]
|
|
80
|
+
#
|
|
64
81
|
# @param whatsapp [Telnyx::Models::VerifyProfileCreateParams::Whatsapp]
|
|
82
|
+
#
|
|
65
83
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
66
84
|
|
|
67
85
|
class Call < Telnyx::Internal::Type::BaseModel
|
|
@@ -156,68 +174,6 @@ module Telnyx
|
|
|
156
174
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
157
175
|
end
|
|
158
176
|
|
|
159
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
160
|
-
# @!attribute app_name
|
|
161
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
162
|
-
# message.
|
|
163
|
-
#
|
|
164
|
-
# @return [String, nil]
|
|
165
|
-
optional :app_name, String
|
|
166
|
-
|
|
167
|
-
# @!attribute code_length
|
|
168
|
-
# The length of the verify code to generate.
|
|
169
|
-
#
|
|
170
|
-
# @return [Integer, nil]
|
|
171
|
-
optional :code_length, Integer
|
|
172
|
-
|
|
173
|
-
# @!attribute default_verification_timeout_secs
|
|
174
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
175
|
-
# number of seconds before a verification request code expires. Once the
|
|
176
|
-
# verification request expires, the user cannot use the code to verify their
|
|
177
|
-
# identity.
|
|
178
|
-
#
|
|
179
|
-
# @return [Integer, nil]
|
|
180
|
-
optional :default_verification_timeout_secs, Integer
|
|
181
|
-
|
|
182
|
-
# @!attribute messaging_template_id
|
|
183
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
184
|
-
#
|
|
185
|
-
# @return [String, nil]
|
|
186
|
-
optional :messaging_template_id, String
|
|
187
|
-
|
|
188
|
-
# @!attribute sms_fallback
|
|
189
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
190
|
-
#
|
|
191
|
-
# @return [Boolean, nil]
|
|
192
|
-
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
193
|
-
|
|
194
|
-
# @!attribute whitelisted_destinations
|
|
195
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
196
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
197
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
198
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
199
|
-
# destinations; otherwise it is optional.
|
|
200
|
-
#
|
|
201
|
-
# @return [Array<String>, nil]
|
|
202
|
-
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
203
|
-
|
|
204
|
-
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
205
|
-
# Some parameter documentations has been truncated, see
|
|
206
|
-
# {Telnyx::Models::VerifyProfileCreateParams::Rcs} for more details.
|
|
207
|
-
#
|
|
208
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
209
|
-
#
|
|
210
|
-
# @param code_length [Integer] The length of the verify code to generate.
|
|
211
|
-
#
|
|
212
|
-
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
213
|
-
#
|
|
214
|
-
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
215
|
-
#
|
|
216
|
-
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
217
|
-
#
|
|
218
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
219
|
-
end
|
|
220
|
-
|
|
221
177
|
class SMS < Telnyx::Internal::Type::BaseModel
|
|
222
178
|
# @!attribute alpha_sender
|
|
223
179
|
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
@@ -17,10 +17,17 @@ module Telnyx
|
|
|
17
17
|
# @return [Telnyx::Models::VerifyProfileUpdateParams::Call, nil]
|
|
18
18
|
optional :call, -> { Telnyx::VerifyProfileUpdateParams::Call }
|
|
19
19
|
|
|
20
|
-
# @!attribute
|
|
20
|
+
# @!attribute daily_spend_limit
|
|
21
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
21
22
|
#
|
|
22
|
-
# @return [
|
|
23
|
-
optional :
|
|
23
|
+
# @return [Float, nil]
|
|
24
|
+
optional :daily_spend_limit, Float
|
|
25
|
+
|
|
26
|
+
# @!attribute daily_spend_limit_enabled
|
|
27
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
28
|
+
#
|
|
29
|
+
# @return [Boolean, nil]
|
|
30
|
+
optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean
|
|
24
31
|
|
|
25
32
|
# @!attribute language
|
|
26
33
|
#
|
|
@@ -32,11 +39,6 @@ module Telnyx
|
|
|
32
39
|
# @return [String, nil]
|
|
33
40
|
optional :name, String
|
|
34
41
|
|
|
35
|
-
# @!attribute rcs
|
|
36
|
-
#
|
|
37
|
-
# @return [Telnyx::Models::VerifyProfileUpdateParams::Rcs, nil]
|
|
38
|
-
optional :rcs, -> { Telnyx::VerifyProfileUpdateParams::Rcs }
|
|
39
|
-
|
|
40
42
|
# @!attribute sms
|
|
41
43
|
#
|
|
42
44
|
# @return [Telnyx::Models::VerifyProfileUpdateParams::SMS, nil]
|
|
@@ -57,17 +59,27 @@ module Telnyx
|
|
|
57
59
|
# @return [Telnyx::Models::VerifyProfileUpdateParams::Whatsapp, nil]
|
|
58
60
|
optional :whatsapp, -> { Telnyx::VerifyProfileUpdateParams::Whatsapp }
|
|
59
61
|
|
|
60
|
-
# @!method initialize(verify_profile_id:, call: nil,
|
|
62
|
+
# @!method initialize(verify_profile_id:, call: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, language: nil, name: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, whatsapp: nil, request_options: {})
|
|
61
63
|
# @param verify_profile_id [String]
|
|
64
|
+
#
|
|
62
65
|
# @param call [Telnyx::Models::VerifyProfileUpdateParams::Call]
|
|
63
|
-
#
|
|
66
|
+
#
|
|
67
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
68
|
+
#
|
|
69
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
70
|
+
#
|
|
64
71
|
# @param language [String]
|
|
72
|
+
#
|
|
65
73
|
# @param name [String]
|
|
66
|
-
#
|
|
74
|
+
#
|
|
67
75
|
# @param sms [Telnyx::Models::VerifyProfileUpdateParams::SMS]
|
|
76
|
+
#
|
|
68
77
|
# @param webhook_failover_url [String]
|
|
78
|
+
#
|
|
69
79
|
# @param webhook_url [String]
|
|
80
|
+
#
|
|
70
81
|
# @param whatsapp [Telnyx::Models::VerifyProfileUpdateParams::Whatsapp]
|
|
82
|
+
#
|
|
71
83
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
72
84
|
|
|
73
85
|
class Call < Telnyx::Internal::Type::BaseModel
|
|
@@ -124,106 +136,6 @@ module Telnyx
|
|
|
124
136
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
125
137
|
end
|
|
126
138
|
|
|
127
|
-
class Flashcall < Telnyx::Internal::Type::BaseModel
|
|
128
|
-
# @!attribute app_name
|
|
129
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
130
|
-
# message.
|
|
131
|
-
#
|
|
132
|
-
# @return [String, nil]
|
|
133
|
-
optional :app_name, String
|
|
134
|
-
|
|
135
|
-
# @!attribute default_verification_timeout_secs
|
|
136
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
137
|
-
# number of seconds before a verification request code expires. Once the
|
|
138
|
-
# verification request expires, the user cannot use the code to verify their
|
|
139
|
-
# identity.
|
|
140
|
-
#
|
|
141
|
-
# @return [Integer, nil]
|
|
142
|
-
optional :default_verification_timeout_secs, Integer
|
|
143
|
-
|
|
144
|
-
# @!attribute whitelisted_destinations
|
|
145
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
146
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
147
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
148
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
149
|
-
# destinations; otherwise it is optional.
|
|
150
|
-
#
|
|
151
|
-
# @return [Array<String>, nil]
|
|
152
|
-
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
153
|
-
|
|
154
|
-
# @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
|
|
155
|
-
# Some parameter documentations has been truncated, see
|
|
156
|
-
# {Telnyx::Models::VerifyProfileUpdateParams::Flashcall} for more details.
|
|
157
|
-
#
|
|
158
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
159
|
-
#
|
|
160
|
-
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
161
|
-
#
|
|
162
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
163
|
-
end
|
|
164
|
-
|
|
165
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
166
|
-
# @!attribute app_name
|
|
167
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
168
|
-
# message.
|
|
169
|
-
#
|
|
170
|
-
# @return [String, nil]
|
|
171
|
-
optional :app_name, String
|
|
172
|
-
|
|
173
|
-
# @!attribute code_length
|
|
174
|
-
# The length of the verify code to generate.
|
|
175
|
-
#
|
|
176
|
-
# @return [Integer, nil]
|
|
177
|
-
optional :code_length, Integer
|
|
178
|
-
|
|
179
|
-
# @!attribute default_verification_timeout_secs
|
|
180
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
181
|
-
# number of seconds before a verification request code expires. Once the
|
|
182
|
-
# verification request expires, the user cannot use the code to verify their
|
|
183
|
-
# identity.
|
|
184
|
-
#
|
|
185
|
-
# @return [Integer, nil]
|
|
186
|
-
optional :default_verification_timeout_secs, Integer
|
|
187
|
-
|
|
188
|
-
# @!attribute messaging_template_id
|
|
189
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
190
|
-
#
|
|
191
|
-
# @return [String, nil]
|
|
192
|
-
optional :messaging_template_id, String
|
|
193
|
-
|
|
194
|
-
# @!attribute sms_fallback
|
|
195
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
196
|
-
#
|
|
197
|
-
# @return [Boolean, nil]
|
|
198
|
-
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
199
|
-
|
|
200
|
-
# @!attribute whitelisted_destinations
|
|
201
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
202
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
203
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
204
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
205
|
-
# destinations; otherwise it is optional.
|
|
206
|
-
#
|
|
207
|
-
# @return [Array<String>, nil]
|
|
208
|
-
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
209
|
-
|
|
210
|
-
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
211
|
-
# Some parameter documentations has been truncated, see
|
|
212
|
-
# {Telnyx::Models::VerifyProfileUpdateParams::Rcs} for more details.
|
|
213
|
-
#
|
|
214
|
-
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
215
|
-
#
|
|
216
|
-
# @param code_length [Integer] The length of the verify code to generate.
|
|
217
|
-
#
|
|
218
|
-
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
219
|
-
#
|
|
220
|
-
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
221
|
-
#
|
|
222
|
-
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
223
|
-
#
|
|
224
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
225
|
-
end
|
|
226
|
-
|
|
227
139
|
class SMS < Telnyx::Internal::Type::BaseModel
|
|
228
140
|
# @!attribute alpha_sender
|
|
229
141
|
# The alphanumeric sender ID to use when sending to destinations that require an
|