telnyx 5.36.1 → 5.36.2
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 +9 -0
- data/README.md +1 -1
- data/lib/telnyx/models/messaging_tollfree/verification/request_list_params.rb +9 -1
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb +38 -0
- data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rb +63 -0
- data/lib/telnyx/models/messaging_tollfree/verification/tf_verification_request.rb +9 -9
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_egress.rb +8 -8
- data/lib/telnyx/models/messaging_tollfree/verification/verification_request_status.rb +8 -8
- data/lib/telnyx/models/verify_profile.rb +79 -2
- data/lib/telnyx/models/verify_profile_create_params.rb +83 -8
- data/lib/telnyx/models/verify_profile_update_params.rb +77 -2
- data/lib/telnyx/resources/messaging_tollfree/verification/requests.rb +43 -7
- data/lib/telnyx/resources/verify_profiles.rb +5 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +2 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_list_params.rbi +11 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbi +58 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbi +123 -0
- data/rbi/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbi +8 -8
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbi +9 -6
- data/rbi/telnyx/models/messaging_tollfree/verification/verification_request_status.rbi +9 -6
- data/rbi/telnyx/models/verify_profile.rbi +131 -4
- data/rbi/telnyx/models/verify_profile_create_params.rbi +143 -13
- data/rbi/telnyx/models/verify_profile_update_params.rbi +127 -0
- data/rbi/telnyx/resources/messaging_tollfree/verification/requests.rbi +33 -6
- data/rbi/telnyx/resources/verify_profiles.rbi +4 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_list_params.rbs +7 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rbs +32 -0
- data/sig/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rbs +56 -0
- data/sig/telnyx/models/messaging_tollfree/verification/tf_verification_request.rbs +5 -5
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_egress.rbs +7 -5
- data/sig/telnyx/models/messaging_tollfree/verification/verification_request_status.rbs +7 -5
- data/sig/telnyx/models/verify_profile.rbs +75 -3
- data/sig/telnyx/models/verify_profile_create_params.rbs +80 -8
- data/sig/telnyx/models/verify_profile_update_params.rbs +70 -0
- data/sig/telnyx/resources/messaging_tollfree/verification/requests.rbs +10 -2
- data/sig/telnyx/resources/verify_profiles.rbs +2 -0
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e6221c73d69952ad108e379de434a4659f47fa2c1b9d21dd796031306e5eecf5
|
|
4
|
+
data.tar.gz: 9be8455d4ea24bd3bd59b0e721a545186f45f9065433607fb75c987013bf97c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 60c9e02af827c8b2eff0782967495790b779ed17cc2c3d5ecc40646ce92b74df6e6d725e4a5b04d3c62aacf143d4d6b6ba940c0119b1c2db015bcaf4da42bc91
|
|
7
|
+
data.tar.gz: c266e9ed7e235a2615f49df99b06f48606328f01fe103a3f94dff1a204d3a2f221fc571a8209d706adc45fedb7458ff0a5fbfaffd12f31b950e44d6632b88e08
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 5.36.2 (2026-02-22)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v5.36.1...v5.36.2](https://github.com/team-telnyx/telnyx-ruby/compare/v5.36.1...v5.36.2)
|
|
6
|
+
|
|
7
|
+
### Bug Fixes
|
|
8
|
+
|
|
9
|
+
* OAS drift — toll-free-verification.json (messaging-tf-verify) ([007a611](https://github.com/team-telnyx/telnyx-ruby/commit/007a611caacedb05b551225b7a0a7f914e3f9ea2))
|
|
10
|
+
* OAS drift — verify.json (messaging-2fa) ([83d03f2](https://github.com/team-telnyx/telnyx-ruby/commit/83d03f27f765c32eca8fbccad436e1da2b88a163))
|
|
11
|
+
|
|
3
12
|
## 5.36.1 (2026-02-21)
|
|
4
13
|
|
|
5
14
|
Full Changelog: [v5.36.0...v5.36.1](https://github.com/team-telnyx/telnyx-ruby/compare/v5.36.0...v5.36.1)
|
data/README.md
CHANGED
|
@@ -22,6 +22,12 @@ module Telnyx
|
|
|
22
22
|
# @return [Integer]
|
|
23
23
|
required :page_size, Integer
|
|
24
24
|
|
|
25
|
+
# @!attribute business_name
|
|
26
|
+
# Filter verification requests by business name
|
|
27
|
+
#
|
|
28
|
+
# @return [String, nil]
|
|
29
|
+
optional :business_name, String
|
|
30
|
+
|
|
25
31
|
# @!attribute date_end
|
|
26
32
|
#
|
|
27
33
|
# @return [Time, nil]
|
|
@@ -43,7 +49,7 @@ module Telnyx
|
|
|
43
49
|
# @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus, nil]
|
|
44
50
|
optional :status, enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus }
|
|
45
51
|
|
|
46
|
-
# @!method initialize(page:, page_size:, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
52
|
+
# @!method initialize(page:, page_size:, business_name: nil, date_end: nil, date_start: nil, phone_number: nil, status: nil, request_options: {})
|
|
47
53
|
# Some parameter documentations has been truncated, see
|
|
48
54
|
# {Telnyx::Models::MessagingTollfree::Verification::RequestListParams} for more
|
|
49
55
|
# details.
|
|
@@ -52,6 +58,8 @@ module Telnyx
|
|
|
52
58
|
#
|
|
53
59
|
# @param page_size [Integer]
|
|
54
60
|
#
|
|
61
|
+
# @param business_name [String] Filter verification requests by business name
|
|
62
|
+
#
|
|
55
63
|
# @param date_end [Time]
|
|
56
64
|
#
|
|
57
65
|
# @param date_start [Time]
|
data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_params.rb
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module MessagingTollfree
|
|
6
|
+
module Verification
|
|
7
|
+
# @see Telnyx::Resources::MessagingTollfree::Verification::Requests#retrieve_status_history
|
|
8
|
+
class RequestRetrieveStatusHistoryParams < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
extend Telnyx::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include Telnyx::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
# @!attribute page_number
|
|
13
|
+
#
|
|
14
|
+
# @return [Integer]
|
|
15
|
+
required :page_number, Integer
|
|
16
|
+
|
|
17
|
+
# @!attribute page_size
|
|
18
|
+
# Request this many records per page. This value is automatically clamped if the
|
|
19
|
+
# provided value is too large.
|
|
20
|
+
#
|
|
21
|
+
# @return [Integer]
|
|
22
|
+
required :page_size, Integer
|
|
23
|
+
|
|
24
|
+
# @!method initialize(page_number:, page_size:, request_options: {})
|
|
25
|
+
# Some parameter documentations has been truncated, see
|
|
26
|
+
# {Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryParams}
|
|
27
|
+
# for more details.
|
|
28
|
+
#
|
|
29
|
+
# @param page_number [Integer]
|
|
30
|
+
#
|
|
31
|
+
# @param page_size [Integer] Request this many records per page. This value is automatically clamped if the p
|
|
32
|
+
#
|
|
33
|
+
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
data/lib/telnyx/models/messaging_tollfree/verification/request_retrieve_status_history_response.rb
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module MessagingTollfree
|
|
6
|
+
module Verification
|
|
7
|
+
# @see Telnyx::Resources::MessagingTollfree::Verification::Requests#retrieve_status_history
|
|
8
|
+
class RequestRetrieveStatusHistoryResponse < Telnyx::Internal::Type::BaseModel
|
|
9
|
+
# @!attribute records
|
|
10
|
+
# The records yielded by this request
|
|
11
|
+
#
|
|
12
|
+
# @return [Array<Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record>]
|
|
13
|
+
required :records,
|
|
14
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record] }
|
|
15
|
+
|
|
16
|
+
# @!attribute total_records
|
|
17
|
+
# The total amount of records for these query parameters
|
|
18
|
+
#
|
|
19
|
+
# @return [Integer]
|
|
20
|
+
required :total_records, Integer
|
|
21
|
+
|
|
22
|
+
# @!method initialize(records:, total_records:)
|
|
23
|
+
# A paginated response
|
|
24
|
+
#
|
|
25
|
+
# @param records [Array<Telnyx::Models::MessagingTollfree::Verification::RequestRetrieveStatusHistoryResponse::Record>] The records yielded by this request
|
|
26
|
+
#
|
|
27
|
+
# @param total_records [Integer] The total amount of records for these query parameters
|
|
28
|
+
|
|
29
|
+
class Record < Telnyx::Internal::Type::BaseModel
|
|
30
|
+
# @!attribute updated_at
|
|
31
|
+
# The timestamp at which this status change occurred
|
|
32
|
+
#
|
|
33
|
+
# @return [Time]
|
|
34
|
+
required :updated_at, Time, api_name: :updatedAt
|
|
35
|
+
|
|
36
|
+
# @!attribute verification_status
|
|
37
|
+
# Tollfree verification status
|
|
38
|
+
#
|
|
39
|
+
# @return [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus]
|
|
40
|
+
required :verification_status,
|
|
41
|
+
enum: -> { Telnyx::MessagingTollfree::Verification::TfVerificationStatus },
|
|
42
|
+
api_name: :verificationStatus
|
|
43
|
+
|
|
44
|
+
# @!attribute reason
|
|
45
|
+
# An explanation of why this request has its current status.
|
|
46
|
+
#
|
|
47
|
+
# @return [String, nil]
|
|
48
|
+
optional :reason, String, nil?: true
|
|
49
|
+
|
|
50
|
+
# @!method initialize(updated_at:, verification_status:, reason: nil)
|
|
51
|
+
# A single entry in the verification request status history
|
|
52
|
+
#
|
|
53
|
+
# @param updated_at [Time] The timestamp at which this status change occurred
|
|
54
|
+
#
|
|
55
|
+
# @param verification_status [Symbol, Telnyx::Models::MessagingTollfree::Verification::TfVerificationStatus] Tollfree verification status
|
|
56
|
+
#
|
|
57
|
+
# @param reason [String, nil] An explanation of why this request has its current status.
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
@@ -74,12 +74,6 @@ module Telnyx
|
|
|
74
74
|
# @return [String]
|
|
75
75
|
required :corporate_website, String, api_name: :corporateWebsite
|
|
76
76
|
|
|
77
|
-
# @!attribute isv_reseller
|
|
78
|
-
# ISV name
|
|
79
|
-
#
|
|
80
|
-
# @return [String]
|
|
81
|
-
required :isv_reseller, String, api_name: :isvReseller
|
|
82
|
-
|
|
83
77
|
# @!attribute message_volume
|
|
84
78
|
# Message Volume Enums
|
|
85
79
|
#
|
|
@@ -199,6 +193,12 @@ module Telnyx
|
|
|
199
193
|
# @return [String, nil]
|
|
200
194
|
optional :help_message_response, String, api_name: :helpMessageResponse, nil?: true
|
|
201
195
|
|
|
196
|
+
# @!attribute isv_reseller
|
|
197
|
+
# ISV name
|
|
198
|
+
#
|
|
199
|
+
# @return [String, nil]
|
|
200
|
+
optional :isv_reseller, String, api_name: :isvReseller, nil?: true
|
|
201
|
+
|
|
202
202
|
# @!attribute opt_in_confirmation_response
|
|
203
203
|
# Message sent to users confirming their opt-in to receive messages
|
|
204
204
|
#
|
|
@@ -231,7 +231,7 @@ module Telnyx
|
|
|
231
231
|
# @return [String, nil]
|
|
232
232
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
233
233
|
|
|
234
|
-
# @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:,
|
|
234
|
+
# @!method initialize(additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, webhook_url: nil)
|
|
235
235
|
# Some parameter documentations has been truncated, see
|
|
236
236
|
# {Telnyx::Models::MessagingTollfree::Verification::TfVerificationRequest} for
|
|
237
237
|
# more details.
|
|
@@ -260,8 +260,6 @@ module Telnyx
|
|
|
260
260
|
#
|
|
261
261
|
# @param corporate_website [String] A URL, including the scheme, pointing to the corporate website
|
|
262
262
|
#
|
|
263
|
-
# @param isv_reseller [String] ISV name
|
|
264
|
-
#
|
|
265
263
|
# @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
|
|
266
264
|
#
|
|
267
265
|
# @param opt_in_workflow [String] Human-readable description of how end users will opt into receiving messages fro
|
|
@@ -294,6 +292,8 @@ module Telnyx
|
|
|
294
292
|
#
|
|
295
293
|
# @param help_message_response [String, nil] The message returned when users text 'HELP'
|
|
296
294
|
#
|
|
295
|
+
# @param isv_reseller [String, nil] ISV name
|
|
296
|
+
#
|
|
297
297
|
# @param opt_in_confirmation_response [String, nil] Message sent to users confirming their opt-in to receive messages
|
|
298
298
|
#
|
|
299
299
|
# @param opt_in_keywords [String, nil] Keywords used to collect and process consumer opt-ins
|
|
@@ -66,11 +66,6 @@ module Telnyx
|
|
|
66
66
|
# @return [String]
|
|
67
67
|
required :corporate_website, String, api_name: :corporateWebsite
|
|
68
68
|
|
|
69
|
-
# @!attribute isv_reseller
|
|
70
|
-
#
|
|
71
|
-
# @return [String]
|
|
72
|
-
required :isv_reseller, String, api_name: :isvReseller
|
|
73
|
-
|
|
74
69
|
# @!attribute message_volume
|
|
75
70
|
# Message Volume Enums
|
|
76
71
|
#
|
|
@@ -176,6 +171,11 @@ module Telnyx
|
|
|
176
171
|
# @return [String, nil]
|
|
177
172
|
optional :help_message_response, String, api_name: :helpMessageResponse
|
|
178
173
|
|
|
174
|
+
# @!attribute isv_reseller
|
|
175
|
+
#
|
|
176
|
+
# @return [String, nil]
|
|
177
|
+
optional :isv_reseller, String, api_name: :isvReseller
|
|
178
|
+
|
|
179
179
|
# @!attribute opt_in_confirmation_response
|
|
180
180
|
#
|
|
181
181
|
# @return [String, nil]
|
|
@@ -209,7 +209,7 @@ module Telnyx
|
|
|
209
209
|
# @return [String, nil]
|
|
210
210
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
211
211
|
|
|
212
|
-
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:,
|
|
212
|
+
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_request_id:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, terms_and_condition_url: nil, verification_status: nil, webhook_url: nil)
|
|
213
213
|
# Some parameter documentations has been truncated, see
|
|
214
214
|
# {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestEgress} for
|
|
215
215
|
# more details.
|
|
@@ -240,8 +240,6 @@ module Telnyx
|
|
|
240
240
|
#
|
|
241
241
|
# @param corporate_website [String]
|
|
242
242
|
#
|
|
243
|
-
# @param isv_reseller [String]
|
|
244
|
-
#
|
|
245
243
|
# @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
|
|
246
244
|
#
|
|
247
245
|
# @param opt_in_workflow [String]
|
|
@@ -276,6 +274,8 @@ module Telnyx
|
|
|
276
274
|
#
|
|
277
275
|
# @param help_message_response [String]
|
|
278
276
|
#
|
|
277
|
+
# @param isv_reseller [String]
|
|
278
|
+
#
|
|
279
279
|
# @param opt_in_confirmation_response [String]
|
|
280
280
|
#
|
|
281
281
|
# @param opt_in_keywords [String]
|
|
@@ -66,11 +66,6 @@ module Telnyx
|
|
|
66
66
|
# @return [String]
|
|
67
67
|
required :corporate_website, String, api_name: :corporateWebsite
|
|
68
68
|
|
|
69
|
-
# @!attribute isv_reseller
|
|
70
|
-
#
|
|
71
|
-
# @return [String]
|
|
72
|
-
required :isv_reseller, String, api_name: :isvReseller
|
|
73
|
-
|
|
74
69
|
# @!attribute message_volume
|
|
75
70
|
# Message Volume Enums
|
|
76
71
|
#
|
|
@@ -184,6 +179,11 @@ module Telnyx
|
|
|
184
179
|
# @return [String, nil]
|
|
185
180
|
optional :help_message_response, String, api_name: :helpMessageResponse
|
|
186
181
|
|
|
182
|
+
# @!attribute isv_reseller
|
|
183
|
+
#
|
|
184
|
+
# @return [String, nil]
|
|
185
|
+
optional :isv_reseller, String, api_name: :isvReseller
|
|
186
|
+
|
|
187
187
|
# @!attribute opt_in_confirmation_response
|
|
188
188
|
#
|
|
189
189
|
# @return [String, nil]
|
|
@@ -219,7 +219,7 @@ module Telnyx
|
|
|
219
219
|
# @return [String, nil]
|
|
220
220
|
optional :webhook_url, String, api_name: :webhookUrl
|
|
221
221
|
|
|
222
|
-
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:,
|
|
222
|
+
# @!method initialize(id:, additional_information:, business_addr1:, business_city:, business_contact_email:, business_contact_first_name:, business_contact_last_name:, business_contact_phone:, business_name:, business_state:, business_zip:, corporate_website:, message_volume:, opt_in_workflow:, opt_in_workflow_image_urls:, phone_numbers:, production_message_content:, use_case:, use_case_summary:, verification_status:, age_gated_content: nil, business_addr2: nil, business_registration_country: nil, business_registration_number: nil, business_registration_type: nil, campaign_verify_authorization_token: nil, created_at: nil, doing_business_as: nil, entity_type: nil, help_message_response: nil, isv_reseller: nil, opt_in_confirmation_response: nil, opt_in_keywords: nil, privacy_policy_url: nil, reason: nil, terms_and_condition_url: nil, updated_at: nil, webhook_url: nil)
|
|
223
223
|
# Some parameter documentations has been truncated, see
|
|
224
224
|
# {Telnyx::Models::MessagingTollfree::Verification::VerificationRequestStatus} for
|
|
225
225
|
# more details.
|
|
@@ -250,8 +250,6 @@ module Telnyx
|
|
|
250
250
|
#
|
|
251
251
|
# @param corporate_website [String]
|
|
252
252
|
#
|
|
253
|
-
# @param isv_reseller [String]
|
|
254
|
-
#
|
|
255
253
|
# @param message_volume [Symbol, Telnyx::Models::MessagingTollfree::Verification::Volume] Message Volume Enums
|
|
256
254
|
#
|
|
257
255
|
# @param opt_in_workflow [String]
|
|
@@ -288,6 +286,8 @@ module Telnyx
|
|
|
288
286
|
#
|
|
289
287
|
# @param help_message_response [String]
|
|
290
288
|
#
|
|
289
|
+
# @param isv_reseller [String]
|
|
290
|
+
#
|
|
291
291
|
# @param opt_in_confirmation_response [String]
|
|
292
292
|
#
|
|
293
293
|
# @param opt_in_keywords [String]
|
|
@@ -34,6 +34,11 @@ module Telnyx
|
|
|
34
34
|
# @return [String, nil]
|
|
35
35
|
optional :name, String
|
|
36
36
|
|
|
37
|
+
# @!attribute rcs
|
|
38
|
+
#
|
|
39
|
+
# @return [Telnyx::Models::VerifyProfile::Rcs, nil]
|
|
40
|
+
optional :rcs, -> { Telnyx::VerifyProfile::Rcs }
|
|
41
|
+
|
|
37
42
|
# @!attribute record_type
|
|
38
43
|
# The possible verification profile record types.
|
|
39
44
|
#
|
|
@@ -60,7 +65,7 @@ module Telnyx
|
|
|
60
65
|
# @return [String, nil]
|
|
61
66
|
optional :webhook_url, String
|
|
62
67
|
|
|
63
|
-
# @!method initialize(id: nil, call: nil, created_at: nil, flashcall: nil, language: nil, name: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
68
|
+
# @!method initialize(id: nil, call: nil, created_at: nil, flashcall: nil, language: nil, name: nil, rcs: nil, record_type: nil, sms: nil, updated_at: nil, webhook_failover_url: nil, webhook_url: nil)
|
|
64
69
|
# @param id [String]
|
|
65
70
|
#
|
|
66
71
|
# @param call [Telnyx::Models::VerifyProfile::Call]
|
|
@@ -73,6 +78,8 @@ module Telnyx
|
|
|
73
78
|
#
|
|
74
79
|
# @param name [String]
|
|
75
80
|
#
|
|
81
|
+
# @param rcs [Telnyx::Models::VerifyProfile::Rcs]
|
|
82
|
+
#
|
|
76
83
|
# @param record_type [Symbol, Telnyx::Models::VerifyProfile::RecordType] The possible verification profile record types.
|
|
77
84
|
#
|
|
78
85
|
# @param sms [Telnyx::Models::VerifyProfile::SMS]
|
|
@@ -138,6 +145,13 @@ module Telnyx
|
|
|
138
145
|
|
|
139
146
|
# @see Telnyx::Models::VerifyProfile#flashcall
|
|
140
147
|
class Flashcall < Telnyx::Internal::Type::BaseModel
|
|
148
|
+
# @!attribute app_name
|
|
149
|
+
# The name that identifies the application requesting 2fa in the verification
|
|
150
|
+
# message.
|
|
151
|
+
#
|
|
152
|
+
# @return [String, nil]
|
|
153
|
+
optional :app_name, String
|
|
154
|
+
|
|
141
155
|
# @!attribute default_verification_timeout_secs
|
|
142
156
|
# For every request that is initiated via this Verify profile, this sets the
|
|
143
157
|
# number of seconds before a verification request code expires. Once the
|
|
@@ -147,11 +161,74 @@ module Telnyx
|
|
|
147
161
|
# @return [Integer, nil]
|
|
148
162
|
optional :default_verification_timeout_secs, Integer
|
|
149
163
|
|
|
150
|
-
# @!method initialize(default_verification_timeout_secs: nil)
|
|
164
|
+
# @!method initialize(app_name: nil, default_verification_timeout_secs: nil)
|
|
151
165
|
# Some parameter documentations has been truncated, see
|
|
152
166
|
# {Telnyx::Models::VerifyProfile::Flashcall} for more details.
|
|
153
167
|
#
|
|
168
|
+
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
169
|
+
#
|
|
170
|
+
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
# @see Telnyx::Models::VerifyProfile#rcs
|
|
174
|
+
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
175
|
+
# @!attribute app_name
|
|
176
|
+
# The name that identifies the application requesting 2fa in the verification
|
|
177
|
+
# message.
|
|
178
|
+
#
|
|
179
|
+
# @return [String, nil]
|
|
180
|
+
optional :app_name, String
|
|
181
|
+
|
|
182
|
+
# @!attribute code_length
|
|
183
|
+
# The length of the verify code to generate.
|
|
184
|
+
#
|
|
185
|
+
# @return [Integer, nil]
|
|
186
|
+
optional :code_length, Integer
|
|
187
|
+
|
|
188
|
+
# @!attribute default_verification_timeout_secs
|
|
189
|
+
# For every request that is initiated via this Verify profile, this sets the
|
|
190
|
+
# number of seconds before a verification request code expires. Once the
|
|
191
|
+
# verification request expires, the user cannot use the code to verify their
|
|
192
|
+
# identity.
|
|
193
|
+
#
|
|
194
|
+
# @return [Integer, nil]
|
|
195
|
+
optional :default_verification_timeout_secs, Integer
|
|
196
|
+
|
|
197
|
+
# @!attribute messaging_template_id
|
|
198
|
+
# The message template identifier selected from /verify_profiles/templates
|
|
199
|
+
#
|
|
200
|
+
# @return [String, nil]
|
|
201
|
+
optional :messaging_template_id, String
|
|
202
|
+
|
|
203
|
+
# @!attribute sms_fallback
|
|
204
|
+
# Enable SMS fallback when RCS delivery fails.
|
|
205
|
+
#
|
|
206
|
+
# @return [Boolean, nil]
|
|
207
|
+
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
208
|
+
|
|
209
|
+
# @!attribute whitelisted_destinations
|
|
210
|
+
# Enabled country destinations to send verification codes. The elements in the
|
|
211
|
+
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
212
|
+
# destinations will be allowed.
|
|
213
|
+
#
|
|
214
|
+
# @return [Array<String>, nil]
|
|
215
|
+
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
216
|
+
|
|
217
|
+
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
218
|
+
# Some parameter documentations has been truncated, see
|
|
219
|
+
# {Telnyx::Models::VerifyProfile::Rcs} for more details.
|
|
220
|
+
#
|
|
221
|
+
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
222
|
+
#
|
|
223
|
+
# @param code_length [Integer] The length of the verify code to generate.
|
|
224
|
+
#
|
|
154
225
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
226
|
+
#
|
|
227
|
+
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
228
|
+
#
|
|
229
|
+
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
230
|
+
#
|
|
231
|
+
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
155
232
|
end
|
|
156
233
|
|
|
157
234
|
# The possible verification profile record types.
|
|
@@ -27,6 +27,11 @@ module Telnyx
|
|
|
27
27
|
# @return [String, nil]
|
|
28
28
|
optional :language, String
|
|
29
29
|
|
|
30
|
+
# @!attribute rcs
|
|
31
|
+
#
|
|
32
|
+
# @return [Telnyx::Models::VerifyProfileCreateParams::Rcs, nil]
|
|
33
|
+
optional :rcs, -> { Telnyx::VerifyProfileCreateParams::Rcs }
|
|
34
|
+
|
|
30
35
|
# @!attribute sms
|
|
31
36
|
#
|
|
32
37
|
# @return [Telnyx::Models::VerifyProfileCreateParams::SMS, nil]
|
|
@@ -42,11 +47,12 @@ module Telnyx
|
|
|
42
47
|
# @return [String, nil]
|
|
43
48
|
optional :webhook_url, String
|
|
44
49
|
|
|
45
|
-
# @!method initialize(name:, call: nil, flashcall: nil, language: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
50
|
+
# @!method initialize(name:, call: nil, flashcall: nil, language: nil, rcs: nil, sms: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
|
|
46
51
|
# @param name [String]
|
|
47
52
|
# @param call [Telnyx::Models::VerifyProfileCreateParams::Call]
|
|
48
53
|
# @param flashcall [Telnyx::Models::VerifyProfileCreateParams::Flashcall]
|
|
49
54
|
# @param language [String]
|
|
55
|
+
# @param rcs [Telnyx::Models::VerifyProfileCreateParams::Rcs]
|
|
50
56
|
# @param sms [Telnyx::Models::VerifyProfileCreateParams::SMS]
|
|
51
57
|
# @param webhook_failover_url [String]
|
|
52
58
|
# @param webhook_url [String]
|
|
@@ -105,6 +111,13 @@ module Telnyx
|
|
|
105
111
|
end
|
|
106
112
|
|
|
107
113
|
class Flashcall < Telnyx::Internal::Type::BaseModel
|
|
114
|
+
# @!attribute app_name
|
|
115
|
+
# The name that identifies the application requesting 2fa in the verification
|
|
116
|
+
# message.
|
|
117
|
+
#
|
|
118
|
+
# @return [String, nil]
|
|
119
|
+
optional :app_name, String
|
|
120
|
+
|
|
108
121
|
# @!attribute default_verification_timeout_secs
|
|
109
122
|
# For every request that is initiated via this Verify profile, this sets the
|
|
110
123
|
# number of seconds before a verification request code expires. Once the
|
|
@@ -122,24 +135,78 @@ module Telnyx
|
|
|
122
135
|
# @return [Array<String>, nil]
|
|
123
136
|
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
124
137
|
|
|
125
|
-
# @!method initialize(default_verification_timeout_secs: nil, whitelisted_destinations: nil)
|
|
138
|
+
# @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
|
|
126
139
|
# Some parameter documentations has been truncated, see
|
|
127
140
|
# {Telnyx::Models::VerifyProfileCreateParams::Flashcall} for more details.
|
|
128
141
|
#
|
|
142
|
+
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
143
|
+
#
|
|
129
144
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
130
145
|
#
|
|
131
146
|
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
132
147
|
end
|
|
133
148
|
|
|
134
|
-
class
|
|
149
|
+
class Rcs < Telnyx::Internal::Type::BaseModel
|
|
150
|
+
# @!attribute app_name
|
|
151
|
+
# The name that identifies the application requesting 2fa in the verification
|
|
152
|
+
# message.
|
|
153
|
+
#
|
|
154
|
+
# @return [String, nil]
|
|
155
|
+
optional :app_name, String
|
|
156
|
+
|
|
157
|
+
# @!attribute code_length
|
|
158
|
+
# The length of the verify code to generate.
|
|
159
|
+
#
|
|
160
|
+
# @return [Integer, nil]
|
|
161
|
+
optional :code_length, Integer
|
|
162
|
+
|
|
163
|
+
# @!attribute default_verification_timeout_secs
|
|
164
|
+
# For every request that is initiated via this Verify profile, this sets the
|
|
165
|
+
# number of seconds before a verification request code expires. Once the
|
|
166
|
+
# verification request expires, the user cannot use the code to verify their
|
|
167
|
+
# identity.
|
|
168
|
+
#
|
|
169
|
+
# @return [Integer, nil]
|
|
170
|
+
optional :default_verification_timeout_secs, Integer
|
|
171
|
+
|
|
172
|
+
# @!attribute messaging_template_id
|
|
173
|
+
# The message template identifier selected from /verify_profiles/templates
|
|
174
|
+
#
|
|
175
|
+
# @return [String, nil]
|
|
176
|
+
optional :messaging_template_id, String
|
|
177
|
+
|
|
178
|
+
# @!attribute sms_fallback
|
|
179
|
+
# Enable SMS fallback when RCS delivery fails.
|
|
180
|
+
#
|
|
181
|
+
# @return [Boolean, nil]
|
|
182
|
+
optional :sms_fallback, Telnyx::Internal::Type::Boolean
|
|
183
|
+
|
|
135
184
|
# @!attribute whitelisted_destinations
|
|
136
185
|
# Enabled country destinations to send verification codes. The elements in the
|
|
137
186
|
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
138
187
|
# destinations will be allowed.
|
|
139
188
|
#
|
|
140
|
-
# @return [Array<String
|
|
141
|
-
|
|
189
|
+
# @return [Array<String>, nil]
|
|
190
|
+
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
142
191
|
|
|
192
|
+
# @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sms_fallback: nil, whitelisted_destinations: nil)
|
|
193
|
+
# Some parameter documentations has been truncated, see
|
|
194
|
+
# {Telnyx::Models::VerifyProfileCreateParams::Rcs} for more details.
|
|
195
|
+
#
|
|
196
|
+
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
197
|
+
#
|
|
198
|
+
# @param code_length [Integer] The length of the verify code to generate.
|
|
199
|
+
#
|
|
200
|
+
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
201
|
+
#
|
|
202
|
+
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
203
|
+
#
|
|
204
|
+
# @param sms_fallback [Boolean] Enable SMS fallback when RCS delivery fails.
|
|
205
|
+
#
|
|
206
|
+
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
class SMS < Telnyx::Internal::Type::BaseModel
|
|
143
210
|
# @!attribute alpha_sender
|
|
144
211
|
# The alphanumeric sender ID to use when sending to destinations that require an
|
|
145
212
|
# alphanumeric sender ID.
|
|
@@ -175,12 +242,18 @@ module Telnyx
|
|
|
175
242
|
# @return [String, nil]
|
|
176
243
|
optional :messaging_template_id, String
|
|
177
244
|
|
|
178
|
-
# @!
|
|
245
|
+
# @!attribute whitelisted_destinations
|
|
246
|
+
# Enabled country destinations to send verification codes. The elements in the
|
|
247
|
+
# list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
|
|
248
|
+
# destinations will be allowed.
|
|
249
|
+
#
|
|
250
|
+
# @return [Array<String>, nil]
|
|
251
|
+
optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
|
|
252
|
+
|
|
253
|
+
# @!method initialize(alpha_sender: nil, app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, whitelisted_destinations: nil)
|
|
179
254
|
# Some parameter documentations has been truncated, see
|
|
180
255
|
# {Telnyx::Models::VerifyProfileCreateParams::SMS} for more details.
|
|
181
256
|
#
|
|
182
|
-
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
183
|
-
#
|
|
184
257
|
# @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
|
|
185
258
|
#
|
|
186
259
|
# @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
|
|
@@ -190,6 +263,8 @@ module Telnyx
|
|
|
190
263
|
# @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
|
|
191
264
|
#
|
|
192
265
|
# @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
|
|
266
|
+
#
|
|
267
|
+
# @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
|
|
193
268
|
end
|
|
194
269
|
end
|
|
195
270
|
end
|