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
|
@@ -6,17 +6,28 @@ module Telnyx
|
|
|
6
6
|
class VerifyProfiles
|
|
7
7
|
# Creates a new Verify profile to associate verifications with.
|
|
8
8
|
#
|
|
9
|
-
# @overload create(name:, call: nil,
|
|
9
|
+
# @overload create(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: {})
|
|
10
10
|
#
|
|
11
11
|
# @param name [String]
|
|
12
|
+
#
|
|
12
13
|
# @param call [Telnyx::Models::VerifyProfileCreateParams::Call]
|
|
14
|
+
#
|
|
15
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
16
|
+
#
|
|
17
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
18
|
+
#
|
|
13
19
|
# @param flashcall [Telnyx::Models::VerifyProfileCreateParams::Flashcall]
|
|
20
|
+
#
|
|
14
21
|
# @param language [String]
|
|
15
|
-
#
|
|
22
|
+
#
|
|
16
23
|
# @param sms [Telnyx::Models::VerifyProfileCreateParams::SMS]
|
|
24
|
+
#
|
|
17
25
|
# @param webhook_failover_url [String]
|
|
26
|
+
#
|
|
18
27
|
# @param webhook_url [String]
|
|
28
|
+
#
|
|
19
29
|
# @param whatsapp [Telnyx::Models::VerifyProfileCreateParams::Whatsapp]
|
|
30
|
+
#
|
|
20
31
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
21
32
|
#
|
|
22
33
|
# @return [Telnyx::Models::VerifyProfileData]
|
|
@@ -55,20 +66,20 @@ module Telnyx
|
|
|
55
66
|
|
|
56
67
|
# Update Verify profile
|
|
57
68
|
#
|
|
58
|
-
# @overload update(verify_profile_id, call: nil,
|
|
69
|
+
# @overload update(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: {})
|
|
59
70
|
#
|
|
60
71
|
# @param verify_profile_id [String] The identifier of the Verify profile to update.
|
|
61
72
|
#
|
|
62
73
|
# @param call [Telnyx::Models::VerifyProfileUpdateParams::Call]
|
|
63
74
|
#
|
|
64
|
-
# @param
|
|
75
|
+
# @param daily_spend_limit [Float] The maximum daily spend allowed on this verify profile, in USD.
|
|
76
|
+
#
|
|
77
|
+
# @param daily_spend_limit_enabled [Boolean] Whether the daily spend limit is enforced for this verify profile.
|
|
65
78
|
#
|
|
66
79
|
# @param language [String]
|
|
67
80
|
#
|
|
68
81
|
# @param name [String]
|
|
69
82
|
#
|
|
70
|
-
# @param rcs [Telnyx::Models::VerifyProfileUpdateParams::Rcs]
|
|
71
|
-
#
|
|
72
83
|
# @param sms [Telnyx::Models::VerifyProfileUpdateParams::SMS]
|
|
73
84
|
#
|
|
74
85
|
# @param webhook_failover_url [String]
|
data/lib/telnyx/version.rb
CHANGED
|
@@ -9,7 +9,15 @@ module Telnyx
|
|
|
9
9
|
T.any(Telnyx::AI::TranscriptionSettings, Telnyx::Internal::AnyHash)
|
|
10
10
|
end
|
|
11
11
|
|
|
12
|
-
#
|
|
12
|
+
# Integration secret identifier for the transcription provider API key. Currently
|
|
13
|
+
# used for Azure transcription regions that require a customer-provided API key.
|
|
14
|
+
sig { returns(T.nilable(String)) }
|
|
15
|
+
attr_reader :api_key_ref
|
|
16
|
+
|
|
17
|
+
sig { params(api_key_ref: String).void }
|
|
18
|
+
attr_writer :api_key_ref
|
|
19
|
+
|
|
20
|
+
# The language of the audio to be transcribed. If not set, or if set to `auto`,
|
|
13
21
|
# the model will automatically detect the language.
|
|
14
22
|
sig { returns(T.nilable(String)) }
|
|
15
23
|
attr_reader :language
|
|
@@ -17,12 +25,16 @@ module Telnyx
|
|
|
17
25
|
sig { params(language: String).void }
|
|
18
26
|
attr_writer :language
|
|
19
27
|
|
|
20
|
-
# The speech to text model to be used by the voice assistant. All
|
|
21
|
-
#
|
|
28
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
29
|
+
# are run on-premise.
|
|
22
30
|
#
|
|
23
31
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
24
|
-
# - `deepgram/nova-3` is
|
|
25
|
-
#
|
|
32
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
33
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
34
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
35
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
36
|
+
# configurable turn detection.
|
|
37
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
26
38
|
sig do
|
|
27
39
|
returns(T.nilable(Telnyx::AI::TranscriptionSettings::Model::OrSymbol))
|
|
28
40
|
end
|
|
@@ -34,7 +46,7 @@ module Telnyx
|
|
|
34
46
|
attr_writer :model
|
|
35
47
|
|
|
36
48
|
# Region on third party cloud providers (currently Azure) if using one of their
|
|
37
|
-
# models
|
|
49
|
+
# models. Some regions require `api_key_ref`.
|
|
38
50
|
sig { returns(T.nilable(String)) }
|
|
39
51
|
attr_reader :region
|
|
40
52
|
|
|
@@ -51,6 +63,7 @@ module Telnyx
|
|
|
51
63
|
|
|
52
64
|
sig do
|
|
53
65
|
params(
|
|
66
|
+
api_key_ref: String,
|
|
54
67
|
language: String,
|
|
55
68
|
model: Telnyx::AI::TranscriptionSettings::Model::OrSymbol,
|
|
56
69
|
region: String,
|
|
@@ -58,18 +71,25 @@ module Telnyx
|
|
|
58
71
|
).returns(T.attached_class)
|
|
59
72
|
end
|
|
60
73
|
def self.new(
|
|
61
|
-
#
|
|
74
|
+
# Integration secret identifier for the transcription provider API key. Currently
|
|
75
|
+
# used for Azure transcription regions that require a customer-provided API key.
|
|
76
|
+
api_key_ref: nil,
|
|
77
|
+
# The language of the audio to be transcribed. If not set, or if set to `auto`,
|
|
62
78
|
# the model will automatically detect the language.
|
|
63
79
|
language: nil,
|
|
64
|
-
# The speech to text model to be used by the voice assistant. All
|
|
65
|
-
#
|
|
80
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
81
|
+
# are run on-premise.
|
|
66
82
|
#
|
|
67
83
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
68
|
-
# - `deepgram/nova-3` is
|
|
69
|
-
#
|
|
84
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
85
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
86
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
87
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
88
|
+
# configurable turn detection.
|
|
89
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
70
90
|
model: nil,
|
|
71
91
|
# Region on third party cloud providers (currently Azure) if using one of their
|
|
72
|
-
# models
|
|
92
|
+
# models. Some regions require `api_key_ref`.
|
|
73
93
|
region: nil,
|
|
74
94
|
settings: nil
|
|
75
95
|
)
|
|
@@ -78,6 +98,7 @@ module Telnyx
|
|
|
78
98
|
sig do
|
|
79
99
|
override.returns(
|
|
80
100
|
{
|
|
101
|
+
api_key_ref: String,
|
|
81
102
|
language: String,
|
|
82
103
|
model: Telnyx::AI::TranscriptionSettings::Model::OrSymbol,
|
|
83
104
|
region: String,
|
|
@@ -88,12 +109,16 @@ module Telnyx
|
|
|
88
109
|
def to_hash
|
|
89
110
|
end
|
|
90
111
|
|
|
91
|
-
# The speech to text model to be used by the voice assistant. All
|
|
92
|
-
#
|
|
112
|
+
# The speech to text model to be used by the voice assistant. All Deepgram models
|
|
113
|
+
# are run on-premise.
|
|
93
114
|
#
|
|
94
115
|
# - `deepgram/flux` is optimized for turn-taking but is English-only.
|
|
95
|
-
# - `deepgram/nova-3` is
|
|
96
|
-
#
|
|
116
|
+
# - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
117
|
+
# - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
118
|
+
# - `azure/fast` is a multilingual Azure transcription model.
|
|
119
|
+
# - `assemblyai/universal-streaming` is a multilingual streaming model with
|
|
120
|
+
# configurable turn detection.
|
|
121
|
+
# - `xai/grok-stt` is a multilingual Grok STT model.
|
|
97
122
|
module Model
|
|
98
123
|
extend Telnyx::Internal::Type::Enum
|
|
99
124
|
|
|
@@ -123,6 +148,16 @@ module Telnyx
|
|
|
123
148
|
:"azure/fast",
|
|
124
149
|
Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
|
|
125
150
|
)
|
|
151
|
+
ASSEMBLYAI_UNIVERSAL_STREAMING =
|
|
152
|
+
T.let(
|
|
153
|
+
:"assemblyai/universal-streaming",
|
|
154
|
+
Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
|
|
155
|
+
)
|
|
156
|
+
XAI_GROK_STT =
|
|
157
|
+
T.let(
|
|
158
|
+
:"xai/grok-stt",
|
|
159
|
+
Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
|
|
160
|
+
)
|
|
126
161
|
DISTIL_WHISPER_DISTIL_LARGE_V2 =
|
|
127
162
|
T.let(
|
|
128
163
|
:"distil-whisper/distil-large-v2",
|
|
@@ -21,6 +21,15 @@ module Telnyx
|
|
|
21
21
|
sig { params(eager_eot_threshold: Float).void }
|
|
22
22
|
attr_writer :eager_eot_threshold
|
|
23
23
|
|
|
24
|
+
# Available only for assemblyai/universal-streaming. Confidence level required to
|
|
25
|
+
# trigger an end of turn. Higher values require more certainty before ending a
|
|
26
|
+
# turn.
|
|
27
|
+
sig { returns(T.nilable(Float)) }
|
|
28
|
+
attr_reader :end_of_turn_confidence_threshold
|
|
29
|
+
|
|
30
|
+
sig { params(end_of_turn_confidence_threshold: Float).void }
|
|
31
|
+
attr_writer :end_of_turn_confidence_threshold
|
|
32
|
+
|
|
24
33
|
# Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
25
34
|
# Higher values = more reliable turn detection but slightly increased latency.
|
|
26
35
|
sig { returns(T.nilable(Float)) }
|
|
@@ -46,6 +55,23 @@ module Telnyx
|
|
|
46
55
|
sig { params(keyterm: String).void }
|
|
47
56
|
attr_writer :keyterm
|
|
48
57
|
|
|
58
|
+
# Available only for assemblyai/universal-streaming. Maximum duration of silence
|
|
59
|
+
# in milliseconds before forcing an end of turn.
|
|
60
|
+
sig { returns(T.nilable(Integer)) }
|
|
61
|
+
attr_reader :max_turn_silence
|
|
62
|
+
|
|
63
|
+
sig { params(max_turn_silence: Integer).void }
|
|
64
|
+
attr_writer :max_turn_silence
|
|
65
|
+
|
|
66
|
+
# Available only for assemblyai/universal-streaming. Minimum duration of silence
|
|
67
|
+
# in milliseconds before a turn can end. Must be less than or equal to
|
|
68
|
+
# max_turn_silence.
|
|
69
|
+
sig { returns(T.nilable(Integer)) }
|
|
70
|
+
attr_reader :min_turn_silence
|
|
71
|
+
|
|
72
|
+
sig { params(min_turn_silence: Integer).void }
|
|
73
|
+
attr_writer :min_turn_silence
|
|
74
|
+
|
|
49
75
|
sig { returns(T.nilable(T::Boolean)) }
|
|
50
76
|
attr_reader :numerals
|
|
51
77
|
|
|
@@ -61,9 +87,12 @@ module Telnyx
|
|
|
61
87
|
sig do
|
|
62
88
|
params(
|
|
63
89
|
eager_eot_threshold: Float,
|
|
90
|
+
end_of_turn_confidence_threshold: Float,
|
|
64
91
|
eot_threshold: Float,
|
|
65
92
|
eot_timeout_ms: Integer,
|
|
66
93
|
keyterm: String,
|
|
94
|
+
max_turn_silence: Integer,
|
|
95
|
+
min_turn_silence: Integer,
|
|
67
96
|
numerals: T::Boolean,
|
|
68
97
|
smart_format: T::Boolean
|
|
69
98
|
).returns(T.attached_class)
|
|
@@ -73,6 +102,10 @@ module Telnyx
|
|
|
73
102
|
# detection. Must be lower than or equal to eot_threshold. Setting this equal to
|
|
74
103
|
# eot_threshold effectively disables eager end of turn.
|
|
75
104
|
eager_eot_threshold: nil,
|
|
105
|
+
# Available only for assemblyai/universal-streaming. Confidence level required to
|
|
106
|
+
# trigger an end of turn. Higher values require more certainty before ending a
|
|
107
|
+
# turn.
|
|
108
|
+
end_of_turn_confidence_threshold: nil,
|
|
76
109
|
# Available only for deepgram/flux. Confidence required to trigger an end of turn.
|
|
77
110
|
# Higher values = more reliable turn detection but slightly increased latency.
|
|
78
111
|
eot_threshold: nil,
|
|
@@ -83,6 +116,13 @@ module Telnyx
|
|
|
83
116
|
# key terms to boost for recognition during transcription. Helps improve accuracy
|
|
84
117
|
# for domain-specific terminology, proper nouns, or uncommon words.
|
|
85
118
|
keyterm: nil,
|
|
119
|
+
# Available only for assemblyai/universal-streaming. Maximum duration of silence
|
|
120
|
+
# in milliseconds before forcing an end of turn.
|
|
121
|
+
max_turn_silence: nil,
|
|
122
|
+
# Available only for assemblyai/universal-streaming. Minimum duration of silence
|
|
123
|
+
# in milliseconds before a turn can end. Must be less than or equal to
|
|
124
|
+
# max_turn_silence.
|
|
125
|
+
min_turn_silence: nil,
|
|
86
126
|
numerals: nil,
|
|
87
127
|
smart_format: nil
|
|
88
128
|
)
|
|
@@ -92,9 +132,12 @@ module Telnyx
|
|
|
92
132
|
override.returns(
|
|
93
133
|
{
|
|
94
134
|
eager_eot_threshold: Float,
|
|
135
|
+
end_of_turn_confidence_threshold: Float,
|
|
95
136
|
eot_threshold: Float,
|
|
96
137
|
eot_timeout_ms: Integer,
|
|
97
138
|
keyterm: String,
|
|
139
|
+
max_turn_silence: Integer,
|
|
140
|
+
min_turn_silence: Integer,
|
|
98
141
|
numerals: T::Boolean,
|
|
99
142
|
smart_format: T::Boolean
|
|
100
143
|
}
|
|
@@ -24,6 +24,20 @@ module Telnyx
|
|
|
24
24
|
sig { params(created_at: String).void }
|
|
25
25
|
attr_writer :created_at
|
|
26
26
|
|
|
27
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
28
|
+
sig { returns(T.nilable(Float)) }
|
|
29
|
+
attr_reader :daily_spend_limit
|
|
30
|
+
|
|
31
|
+
sig { params(daily_spend_limit: Float).void }
|
|
32
|
+
attr_writer :daily_spend_limit
|
|
33
|
+
|
|
34
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
35
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
36
|
+
attr_reader :daily_spend_limit_enabled
|
|
37
|
+
|
|
38
|
+
sig { params(daily_spend_limit_enabled: T::Boolean).void }
|
|
39
|
+
attr_writer :daily_spend_limit_enabled
|
|
40
|
+
|
|
27
41
|
sig { returns(T.nilable(Telnyx::VerifyProfile::Flashcall)) }
|
|
28
42
|
attr_reader :flashcall
|
|
29
43
|
|
|
@@ -42,12 +56,6 @@ module Telnyx
|
|
|
42
56
|
sig { params(name: String).void }
|
|
43
57
|
attr_writer :name
|
|
44
58
|
|
|
45
|
-
sig { returns(T.nilable(Telnyx::VerifyProfile::Rcs)) }
|
|
46
|
-
attr_reader :rcs
|
|
47
|
-
|
|
48
|
-
sig { params(rcs: Telnyx::VerifyProfile::Rcs::OrHash).void }
|
|
49
|
-
attr_writer :rcs
|
|
50
|
-
|
|
51
59
|
# The possible verification profile record types.
|
|
52
60
|
sig do
|
|
53
61
|
returns(T.nilable(Telnyx::VerifyProfile::RecordType::TaggedSymbol))
|
|
@@ -94,10 +102,11 @@ module Telnyx
|
|
|
94
102
|
id: String,
|
|
95
103
|
call: Telnyx::VerifyProfile::Call::OrHash,
|
|
96
104
|
created_at: String,
|
|
105
|
+
daily_spend_limit: Float,
|
|
106
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
97
107
|
flashcall: Telnyx::VerifyProfile::Flashcall::OrHash,
|
|
98
108
|
language: String,
|
|
99
109
|
name: String,
|
|
100
|
-
rcs: Telnyx::VerifyProfile::Rcs::OrHash,
|
|
101
110
|
record_type: Telnyx::VerifyProfile::RecordType::OrSymbol,
|
|
102
111
|
sms: Telnyx::VerifyProfile::SMS::OrHash,
|
|
103
112
|
updated_at: String,
|
|
@@ -110,10 +119,13 @@ module Telnyx
|
|
|
110
119
|
id: nil,
|
|
111
120
|
call: nil,
|
|
112
121
|
created_at: nil,
|
|
122
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
123
|
+
daily_spend_limit: nil,
|
|
124
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
125
|
+
daily_spend_limit_enabled: nil,
|
|
113
126
|
flashcall: nil,
|
|
114
127
|
language: nil,
|
|
115
128
|
name: nil,
|
|
116
|
-
rcs: nil,
|
|
117
129
|
# The possible verification profile record types.
|
|
118
130
|
record_type: nil,
|
|
119
131
|
sms: nil,
|
|
@@ -130,10 +142,11 @@ module Telnyx
|
|
|
130
142
|
id: String,
|
|
131
143
|
call: Telnyx::VerifyProfile::Call,
|
|
132
144
|
created_at: String,
|
|
145
|
+
daily_spend_limit: Float,
|
|
146
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
133
147
|
flashcall: Telnyx::VerifyProfile::Flashcall,
|
|
134
148
|
language: String,
|
|
135
149
|
name: String,
|
|
136
|
-
rcs: Telnyx::VerifyProfile::Rcs,
|
|
137
150
|
record_type: Telnyx::VerifyProfile::RecordType::TaggedSymbol,
|
|
138
151
|
sms: Telnyx::VerifyProfile::SMS,
|
|
139
152
|
updated_at: String,
|
|
@@ -292,112 +305,6 @@ module Telnyx
|
|
|
292
305
|
end
|
|
293
306
|
end
|
|
294
307
|
|
|
295
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
296
|
-
OrHash =
|
|
297
|
-
T.type_alias do
|
|
298
|
-
T.any(Telnyx::VerifyProfile::Rcs, Telnyx::Internal::AnyHash)
|
|
299
|
-
end
|
|
300
|
-
|
|
301
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
302
|
-
# message.
|
|
303
|
-
sig { returns(T.nilable(String)) }
|
|
304
|
-
attr_reader :app_name
|
|
305
|
-
|
|
306
|
-
sig { params(app_name: String).void }
|
|
307
|
-
attr_writer :app_name
|
|
308
|
-
|
|
309
|
-
# The length of the verify code to generate.
|
|
310
|
-
sig { returns(T.nilable(Integer)) }
|
|
311
|
-
attr_reader :code_length
|
|
312
|
-
|
|
313
|
-
sig { params(code_length: Integer).void }
|
|
314
|
-
attr_writer :code_length
|
|
315
|
-
|
|
316
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
317
|
-
# number of seconds before a verification request code expires. Once the
|
|
318
|
-
# verification request expires, the user cannot use the code to verify their
|
|
319
|
-
# identity.
|
|
320
|
-
sig { returns(T.nilable(Integer)) }
|
|
321
|
-
attr_reader :default_verification_timeout_secs
|
|
322
|
-
|
|
323
|
-
sig { params(default_verification_timeout_secs: Integer).void }
|
|
324
|
-
attr_writer :default_verification_timeout_secs
|
|
325
|
-
|
|
326
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
327
|
-
sig { returns(T.nilable(String)) }
|
|
328
|
-
attr_reader :messaging_template_id
|
|
329
|
-
|
|
330
|
-
sig { params(messaging_template_id: String).void }
|
|
331
|
-
attr_writer :messaging_template_id
|
|
332
|
-
|
|
333
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
334
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
335
|
-
attr_reader :sms_fallback
|
|
336
|
-
|
|
337
|
-
sig { params(sms_fallback: T::Boolean).void }
|
|
338
|
-
attr_writer :sms_fallback
|
|
339
|
-
|
|
340
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
341
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
342
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
343
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
344
|
-
# destinations; otherwise it is optional.
|
|
345
|
-
sig { returns(T.nilable(T::Array[String])) }
|
|
346
|
-
attr_reader :whitelisted_destinations
|
|
347
|
-
|
|
348
|
-
sig { params(whitelisted_destinations: T::Array[String]).void }
|
|
349
|
-
attr_writer :whitelisted_destinations
|
|
350
|
-
|
|
351
|
-
sig do
|
|
352
|
-
params(
|
|
353
|
-
app_name: String,
|
|
354
|
-
code_length: Integer,
|
|
355
|
-
default_verification_timeout_secs: Integer,
|
|
356
|
-
messaging_template_id: String,
|
|
357
|
-
sms_fallback: T::Boolean,
|
|
358
|
-
whitelisted_destinations: T::Array[String]
|
|
359
|
-
).returns(T.attached_class)
|
|
360
|
-
end
|
|
361
|
-
def self.new(
|
|
362
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
363
|
-
# message.
|
|
364
|
-
app_name: nil,
|
|
365
|
-
# The length of the verify code to generate.
|
|
366
|
-
code_length: nil,
|
|
367
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
368
|
-
# number of seconds before a verification request code expires. Once the
|
|
369
|
-
# verification request expires, the user cannot use the code to verify their
|
|
370
|
-
# identity.
|
|
371
|
-
default_verification_timeout_secs: nil,
|
|
372
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
373
|
-
messaging_template_id: nil,
|
|
374
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
375
|
-
sms_fallback: nil,
|
|
376
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
377
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
378
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
379
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
380
|
-
# destinations; otherwise it is optional.
|
|
381
|
-
whitelisted_destinations: nil
|
|
382
|
-
)
|
|
383
|
-
end
|
|
384
|
-
|
|
385
|
-
sig do
|
|
386
|
-
override.returns(
|
|
387
|
-
{
|
|
388
|
-
app_name: String,
|
|
389
|
-
code_length: Integer,
|
|
390
|
-
default_verification_timeout_secs: Integer,
|
|
391
|
-
messaging_template_id: String,
|
|
392
|
-
sms_fallback: T::Boolean,
|
|
393
|
-
whitelisted_destinations: T::Array[String]
|
|
394
|
-
}
|
|
395
|
-
)
|
|
396
|
-
end
|
|
397
|
-
def to_hash
|
|
398
|
-
end
|
|
399
|
-
end
|
|
400
|
-
|
|
401
308
|
# The possible verification profile record types.
|
|
402
309
|
module RecordType
|
|
403
310
|
extend Telnyx::Internal::Type::Enum
|
|
@@ -20,6 +20,20 @@ module Telnyx
|
|
|
20
20
|
sig { params(call: Telnyx::VerifyProfileCreateParams::Call::OrHash).void }
|
|
21
21
|
attr_writer :call
|
|
22
22
|
|
|
23
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
24
|
+
sig { returns(T.nilable(Float)) }
|
|
25
|
+
attr_reader :daily_spend_limit
|
|
26
|
+
|
|
27
|
+
sig { params(daily_spend_limit: Float).void }
|
|
28
|
+
attr_writer :daily_spend_limit
|
|
29
|
+
|
|
30
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
31
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
32
|
+
attr_reader :daily_spend_limit_enabled
|
|
33
|
+
|
|
34
|
+
sig { params(daily_spend_limit_enabled: T::Boolean).void }
|
|
35
|
+
attr_writer :daily_spend_limit_enabled
|
|
36
|
+
|
|
23
37
|
sig { returns(T.nilable(Telnyx::VerifyProfileCreateParams::Flashcall)) }
|
|
24
38
|
attr_reader :flashcall
|
|
25
39
|
|
|
@@ -36,12 +50,6 @@ module Telnyx
|
|
|
36
50
|
sig { params(language: String).void }
|
|
37
51
|
attr_writer :language
|
|
38
52
|
|
|
39
|
-
sig { returns(T.nilable(Telnyx::VerifyProfileCreateParams::Rcs)) }
|
|
40
|
-
attr_reader :rcs
|
|
41
|
-
|
|
42
|
-
sig { params(rcs: Telnyx::VerifyProfileCreateParams::Rcs::OrHash).void }
|
|
43
|
-
attr_writer :rcs
|
|
44
|
-
|
|
45
53
|
sig { returns(T.nilable(Telnyx::VerifyProfileCreateParams::SMS)) }
|
|
46
54
|
attr_reader :sms
|
|
47
55
|
|
|
@@ -74,9 +82,10 @@ module Telnyx
|
|
|
74
82
|
params(
|
|
75
83
|
name: String,
|
|
76
84
|
call: Telnyx::VerifyProfileCreateParams::Call::OrHash,
|
|
85
|
+
daily_spend_limit: Float,
|
|
86
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
77
87
|
flashcall: Telnyx::VerifyProfileCreateParams::Flashcall::OrHash,
|
|
78
88
|
language: String,
|
|
79
|
-
rcs: Telnyx::VerifyProfileCreateParams::Rcs::OrHash,
|
|
80
89
|
sms: Telnyx::VerifyProfileCreateParams::SMS::OrHash,
|
|
81
90
|
webhook_failover_url: String,
|
|
82
91
|
webhook_url: String,
|
|
@@ -87,9 +96,12 @@ module Telnyx
|
|
|
87
96
|
def self.new(
|
|
88
97
|
name:,
|
|
89
98
|
call: nil,
|
|
99
|
+
# The maximum daily spend allowed on this verify profile, in USD.
|
|
100
|
+
daily_spend_limit: nil,
|
|
101
|
+
# Whether the daily spend limit is enforced for this verify profile.
|
|
102
|
+
daily_spend_limit_enabled: nil,
|
|
90
103
|
flashcall: nil,
|
|
91
104
|
language: nil,
|
|
92
|
-
rcs: nil,
|
|
93
105
|
sms: nil,
|
|
94
106
|
webhook_failover_url: nil,
|
|
95
107
|
webhook_url: nil,
|
|
@@ -103,9 +115,10 @@ module Telnyx
|
|
|
103
115
|
{
|
|
104
116
|
name: String,
|
|
105
117
|
call: Telnyx::VerifyProfileCreateParams::Call,
|
|
118
|
+
daily_spend_limit: Float,
|
|
119
|
+
daily_spend_limit_enabled: T::Boolean,
|
|
106
120
|
flashcall: Telnyx::VerifyProfileCreateParams::Flashcall,
|
|
107
121
|
language: String,
|
|
108
|
-
rcs: Telnyx::VerifyProfileCreateParams::Rcs,
|
|
109
122
|
sms: Telnyx::VerifyProfileCreateParams::SMS,
|
|
110
123
|
webhook_failover_url: String,
|
|
111
124
|
webhook_url: String,
|
|
@@ -291,115 +304,6 @@ module Telnyx
|
|
|
291
304
|
end
|
|
292
305
|
end
|
|
293
306
|
|
|
294
|
-
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
295
|
-
OrHash =
|
|
296
|
-
T.type_alias do
|
|
297
|
-
T.any(
|
|
298
|
-
Telnyx::VerifyProfileCreateParams::Rcs,
|
|
299
|
-
Telnyx::Internal::AnyHash
|
|
300
|
-
)
|
|
301
|
-
end
|
|
302
|
-
|
|
303
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
304
|
-
# message.
|
|
305
|
-
sig { returns(T.nilable(String)) }
|
|
306
|
-
attr_reader :app_name
|
|
307
|
-
|
|
308
|
-
sig { params(app_name: String).void }
|
|
309
|
-
attr_writer :app_name
|
|
310
|
-
|
|
311
|
-
# The length of the verify code to generate.
|
|
312
|
-
sig { returns(T.nilable(Integer)) }
|
|
313
|
-
attr_reader :code_length
|
|
314
|
-
|
|
315
|
-
sig { params(code_length: Integer).void }
|
|
316
|
-
attr_writer :code_length
|
|
317
|
-
|
|
318
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
319
|
-
# number of seconds before a verification request code expires. Once the
|
|
320
|
-
# verification request expires, the user cannot use the code to verify their
|
|
321
|
-
# identity.
|
|
322
|
-
sig { returns(T.nilable(Integer)) }
|
|
323
|
-
attr_reader :default_verification_timeout_secs
|
|
324
|
-
|
|
325
|
-
sig { params(default_verification_timeout_secs: Integer).void }
|
|
326
|
-
attr_writer :default_verification_timeout_secs
|
|
327
|
-
|
|
328
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
329
|
-
sig { returns(T.nilable(String)) }
|
|
330
|
-
attr_reader :messaging_template_id
|
|
331
|
-
|
|
332
|
-
sig { params(messaging_template_id: String).void }
|
|
333
|
-
attr_writer :messaging_template_id
|
|
334
|
-
|
|
335
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
336
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
337
|
-
attr_reader :sms_fallback
|
|
338
|
-
|
|
339
|
-
sig { params(sms_fallback: T::Boolean).void }
|
|
340
|
-
attr_writer :sms_fallback
|
|
341
|
-
|
|
342
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
343
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
344
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
345
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
346
|
-
# destinations; otherwise it is optional.
|
|
347
|
-
sig { returns(T.nilable(T::Array[String])) }
|
|
348
|
-
attr_reader :whitelisted_destinations
|
|
349
|
-
|
|
350
|
-
sig { params(whitelisted_destinations: T::Array[String]).void }
|
|
351
|
-
attr_writer :whitelisted_destinations
|
|
352
|
-
|
|
353
|
-
sig do
|
|
354
|
-
params(
|
|
355
|
-
app_name: String,
|
|
356
|
-
code_length: Integer,
|
|
357
|
-
default_verification_timeout_secs: Integer,
|
|
358
|
-
messaging_template_id: String,
|
|
359
|
-
sms_fallback: T::Boolean,
|
|
360
|
-
whitelisted_destinations: T::Array[String]
|
|
361
|
-
).returns(T.attached_class)
|
|
362
|
-
end
|
|
363
|
-
def self.new(
|
|
364
|
-
# The name that identifies the application requesting 2fa in the verification
|
|
365
|
-
# message.
|
|
366
|
-
app_name: nil,
|
|
367
|
-
# The length of the verify code to generate.
|
|
368
|
-
code_length: nil,
|
|
369
|
-
# For every request that is initiated via this Verify profile, this sets the
|
|
370
|
-
# number of seconds before a verification request code expires. Once the
|
|
371
|
-
# verification request expires, the user cannot use the code to verify their
|
|
372
|
-
# identity.
|
|
373
|
-
default_verification_timeout_secs: nil,
|
|
374
|
-
# The message template identifier selected from /verify_profiles/templates
|
|
375
|
-
messaging_template_id: nil,
|
|
376
|
-
# Enable SMS fallback when RCS delivery fails.
|
|
377
|
-
sms_fallback: nil,
|
|
378
|
-
# Enabled country destinations to send verification codes. The elements in the
|
|
379
|
-
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
380
|
-
# destinations will be allowed. **Conditionally required:** this field must be
|
|
381
|
-
# provided when your organization is configured to require explicit whitelisted
|
|
382
|
-
# destinations; otherwise it is optional.
|
|
383
|
-
whitelisted_destinations: nil
|
|
384
|
-
)
|
|
385
|
-
end
|
|
386
|
-
|
|
387
|
-
sig do
|
|
388
|
-
override.returns(
|
|
389
|
-
{
|
|
390
|
-
app_name: String,
|
|
391
|
-
code_length: Integer,
|
|
392
|
-
default_verification_timeout_secs: Integer,
|
|
393
|
-
messaging_template_id: String,
|
|
394
|
-
sms_fallback: T::Boolean,
|
|
395
|
-
whitelisted_destinations: T::Array[String]
|
|
396
|
-
}
|
|
397
|
-
)
|
|
398
|
-
end
|
|
399
|
-
def to_hash
|
|
400
|
-
end
|
|
401
|
-
end
|
|
402
|
-
|
|
403
307
|
class SMS < Telnyx::Internal::Type::BaseModel
|
|
404
308
|
OrHash =
|
|
405
309
|
T.type_alias do
|