telnyx 5.79.0 → 5.81.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.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -1
  4. data/lib/telnyx/models/ai/assistant_create_params.rb +38 -1
  5. data/lib/telnyx/models/ai/assistant_update_params.rb +38 -1
  6. data/lib/telnyx/models/ai/assistants/update_assistant.rb +40 -1
  7. data/lib/telnyx/models/ai/inference_embedding.rb +39 -1
  8. data/lib/telnyx/models/verify_profile.rb +87 -1
  9. data/lib/telnyx/models/verify_profile_create_params.rb +25 -10
  10. data/lib/telnyx/models/verify_profile_update_params.rb +25 -10
  11. data/lib/telnyx/resources/ai/assistants/versions.rb +3 -1
  12. data/lib/telnyx/resources/ai/assistants.rb +6 -2
  13. data/lib/telnyx/version.rb +1 -1
  14. data/rbi/telnyx/models/ai/assistant_create_params.rbi +72 -0
  15. data/rbi/telnyx/models/ai/assistant_update_params.rbi +72 -0
  16. data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +72 -0
  17. data/rbi/telnyx/models/ai/inference_embedding.rbi +70 -0
  18. data/rbi/telnyx/models/verify_profile.rbi +131 -3
  19. data/rbi/telnyx/models/verify_profile_create_params.rbi +24 -13
  20. data/rbi/telnyx/models/verify_profile_update_params.rbi +24 -13
  21. data/rbi/telnyx/resources/ai/assistants/versions.rbi +9 -0
  22. data/rbi/telnyx/resources/ai/assistants.rbi +18 -0
  23. data/sig/telnyx/models/ai/assistant_create_params.rbs +21 -0
  24. data/sig/telnyx/models/ai/assistant_update_params.rbs +21 -0
  25. data/sig/telnyx/models/ai/assistants/update_assistant.rbs +21 -0
  26. data/sig/telnyx/models/ai/inference_embedding.rbs +21 -0
  27. data/sig/telnyx/models/verify_profile.rbs +74 -3
  28. data/sig/telnyx/models/verify_profile_create_params.rbs +15 -7
  29. data/sig/telnyx/models/verify_profile_update_params.rbs +15 -7
  30. data/sig/telnyx/resources/ai/assistants/versions.rbs +1 -0
  31. data/sig/telnyx/resources/ai/assistants.rbs +2 -0
  32. metadata +2 -2
@@ -110,6 +110,29 @@ module Telnyx
110
110
  end
111
111
  attr_writer :observability_settings
112
112
 
113
+ # Configuration for post-conversation processing. When enabled, the assistant
114
+ # receives one additional LLM turn after the conversation ends, allowing it to
115
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
116
+ # can execute multiple parallel or sequential tools during this phase.
117
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
118
+ # post-conversation. Beta feature.
119
+ sig do
120
+ returns(
121
+ T.nilable(
122
+ Telnyx::AI::AssistantCreateParams::PostConversationSettings
123
+ )
124
+ )
125
+ end
126
+ attr_reader :post_conversation_settings
127
+
128
+ sig do
129
+ params(
130
+ post_conversation_settings:
131
+ Telnyx::AI::AssistantCreateParams::PostConversationSettings::OrHash
132
+ ).void
133
+ end
134
+ attr_writer :post_conversation_settings
135
+
113
136
  sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
114
137
  attr_reader :privacy_settings
115
138
 
@@ -212,6 +235,8 @@ module Telnyx
212
235
  llm_api_key_ref: String,
213
236
  messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
214
237
  observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
238
+ post_conversation_settings:
239
+ Telnyx::AI::AssistantCreateParams::PostConversationSettings::OrHash,
215
240
  privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
216
241
  telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
217
242
  tool_ids: T::Array[String],
@@ -270,6 +295,13 @@ module Telnyx
270
295
  llm_api_key_ref: nil,
271
296
  messaging_settings: nil,
272
297
  observability_settings: nil,
298
+ # Configuration for post-conversation processing. When enabled, the assistant
299
+ # receives one additional LLM turn after the conversation ends, allowing it to
300
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
301
+ # can execute multiple parallel or sequential tools during this phase.
302
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
303
+ # post-conversation. Beta feature.
304
+ post_conversation_settings: nil,
273
305
  privacy_settings: nil,
274
306
  telephony_settings: nil,
275
307
  tool_ids: nil,
@@ -299,6 +331,8 @@ module Telnyx
299
331
  llm_api_key_ref: String,
300
332
  messaging_settings: Telnyx::AI::MessagingSettings,
301
333
  observability_settings: Telnyx::AI::ObservabilityReq,
334
+ post_conversation_settings:
335
+ Telnyx::AI::AssistantCreateParams::PostConversationSettings,
302
336
  privacy_settings: Telnyx::AI::PrivacySettings,
303
337
  telephony_settings: Telnyx::AI::TelephonySettings,
304
338
  tool_ids: T::Array[String],
@@ -326,6 +360,44 @@ module Telnyx
326
360
  end
327
361
  def to_hash
328
362
  end
363
+
364
+ class PostConversationSettings < Telnyx::Internal::Type::BaseModel
365
+ OrHash =
366
+ T.type_alias do
367
+ T.any(
368
+ Telnyx::AI::AssistantCreateParams::PostConversationSettings,
369
+ Telnyx::Internal::AnyHash
370
+ )
371
+ end
372
+
373
+ # Whether post-conversation processing is enabled. When true, the assistant will
374
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
375
+ # to false.
376
+ sig { returns(T.nilable(T::Boolean)) }
377
+ attr_reader :enabled
378
+
379
+ sig { params(enabled: T::Boolean).void }
380
+ attr_writer :enabled
381
+
382
+ # Configuration for post-conversation processing. When enabled, the assistant
383
+ # receives one additional LLM turn after the conversation ends, allowing it to
384
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
385
+ # can execute multiple parallel or sequential tools during this phase.
386
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
387
+ # post-conversation. Beta feature.
388
+ sig { params(enabled: T::Boolean).returns(T.attached_class) }
389
+ def self.new(
390
+ # Whether post-conversation processing is enabled. When true, the assistant will
391
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
392
+ # to false.
393
+ enabled: nil
394
+ )
395
+ end
396
+
397
+ sig { override.returns({ enabled: T::Boolean }) }
398
+ def to_hash
399
+ end
400
+ end
329
401
  end
330
402
  end
331
403
  end
@@ -122,6 +122,29 @@ module Telnyx
122
122
  end
123
123
  attr_writer :observability_settings
124
124
 
125
+ # Configuration for post-conversation processing. When enabled, the assistant
126
+ # receives one additional LLM turn after the conversation ends, allowing it to
127
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
128
+ # can execute multiple parallel or sequential tools during this phase.
129
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
130
+ # post-conversation. Beta feature.
131
+ sig do
132
+ returns(
133
+ T.nilable(
134
+ Telnyx::AI::AssistantUpdateParams::PostConversationSettings
135
+ )
136
+ )
137
+ end
138
+ attr_reader :post_conversation_settings
139
+
140
+ sig do
141
+ params(
142
+ post_conversation_settings:
143
+ Telnyx::AI::AssistantUpdateParams::PostConversationSettings::OrHash
144
+ ).void
145
+ end
146
+ attr_writer :post_conversation_settings
147
+
125
148
  sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
126
149
  attr_reader :privacy_settings
127
150
 
@@ -233,6 +256,8 @@ module Telnyx
233
256
  model: String,
234
257
  name: String,
235
258
  observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
259
+ post_conversation_settings:
260
+ Telnyx::AI::AssistantUpdateParams::PostConversationSettings::OrHash,
236
261
  privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
237
262
  promote_to_main: T::Boolean,
238
263
  telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
@@ -293,6 +318,13 @@ module Telnyx
293
318
  model: nil,
294
319
  name: nil,
295
320
  observability_settings: nil,
321
+ # Configuration for post-conversation processing. When enabled, the assistant
322
+ # receives one additional LLM turn after the conversation ends, allowing it to
323
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
324
+ # can execute multiple parallel or sequential tools during this phase.
325
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
326
+ # post-conversation. Beta feature.
327
+ post_conversation_settings: nil,
296
328
  privacy_settings: nil,
297
329
  # Indicates whether the assistant should be promoted to the main version. Defaults
298
330
  # to true.
@@ -326,6 +358,8 @@ module Telnyx
326
358
  model: String,
327
359
  name: String,
328
360
  observability_settings: Telnyx::AI::ObservabilityReq,
361
+ post_conversation_settings:
362
+ Telnyx::AI::AssistantUpdateParams::PostConversationSettings,
329
363
  privacy_settings: Telnyx::AI::PrivacySettings,
330
364
  promote_to_main: T::Boolean,
331
365
  telephony_settings: Telnyx::AI::TelephonySettings,
@@ -354,6 +388,44 @@ module Telnyx
354
388
  end
355
389
  def to_hash
356
390
  end
391
+
392
+ class PostConversationSettings < Telnyx::Internal::Type::BaseModel
393
+ OrHash =
394
+ T.type_alias do
395
+ T.any(
396
+ Telnyx::AI::AssistantUpdateParams::PostConversationSettings,
397
+ Telnyx::Internal::AnyHash
398
+ )
399
+ end
400
+
401
+ # Whether post-conversation processing is enabled. When true, the assistant will
402
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
403
+ # to false.
404
+ sig { returns(T.nilable(T::Boolean)) }
405
+ attr_reader :enabled
406
+
407
+ sig { params(enabled: T::Boolean).void }
408
+ attr_writer :enabled
409
+
410
+ # Configuration for post-conversation processing. When enabled, the assistant
411
+ # receives one additional LLM turn after the conversation ends, allowing it to
412
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
413
+ # can execute multiple parallel or sequential tools during this phase.
414
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
415
+ # post-conversation. Beta feature.
416
+ sig { params(enabled: T::Boolean).returns(T.attached_class) }
417
+ def self.new(
418
+ # Whether post-conversation processing is enabled. When true, the assistant will
419
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
420
+ # to false.
421
+ enabled: nil
422
+ )
423
+ end
424
+
425
+ sig { override.returns({ enabled: T::Boolean }) }
426
+ def to_hash
427
+ end
428
+ end
357
429
  end
358
430
  end
359
431
  end
@@ -124,6 +124,29 @@ module Telnyx
124
124
  end
125
125
  attr_writer :observability_settings
126
126
 
127
+ # Configuration for post-conversation processing. When enabled, the assistant
128
+ # receives one additional LLM turn after the conversation ends, allowing it to
129
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
130
+ # can execute multiple parallel or sequential tools during this phase.
131
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
132
+ # post-conversation. Beta feature.
133
+ sig do
134
+ returns(
135
+ T.nilable(
136
+ Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings
137
+ )
138
+ )
139
+ end
140
+ attr_reader :post_conversation_settings
141
+
142
+ sig do
143
+ params(
144
+ post_conversation_settings:
145
+ Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings::OrHash
146
+ ).void
147
+ end
148
+ attr_writer :post_conversation_settings
149
+
127
150
  sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
128
151
  attr_reader :privacy_settings
129
152
 
@@ -232,6 +255,8 @@ module Telnyx
232
255
  model: String,
233
256
  name: String,
234
257
  observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
258
+ post_conversation_settings:
259
+ Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings::OrHash,
235
260
  privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
236
261
  telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
237
262
  tool_ids: T::Array[String],
@@ -289,6 +314,13 @@ module Telnyx
289
314
  model: nil,
290
315
  name: nil,
291
316
  observability_settings: nil,
317
+ # Configuration for post-conversation processing. When enabled, the assistant
318
+ # receives one additional LLM turn after the conversation ends, allowing it to
319
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
320
+ # can execute multiple parallel or sequential tools during this phase.
321
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
322
+ # post-conversation. Beta feature.
323
+ post_conversation_settings: nil,
292
324
  privacy_settings: nil,
293
325
  telephony_settings: nil,
294
326
  tool_ids: nil,
@@ -318,6 +350,8 @@ module Telnyx
318
350
  model: String,
319
351
  name: String,
320
352
  observability_settings: Telnyx::AI::ObservabilityReq,
353
+ post_conversation_settings:
354
+ Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings,
321
355
  privacy_settings: Telnyx::AI::PrivacySettings,
322
356
  telephony_settings: Telnyx::AI::TelephonySettings,
323
357
  tool_ids: T::Array[String],
@@ -344,6 +378,44 @@ module Telnyx
344
378
  end
345
379
  def to_hash
346
380
  end
381
+
382
+ class PostConversationSettings < Telnyx::Internal::Type::BaseModel
383
+ OrHash =
384
+ T.type_alias do
385
+ T.any(
386
+ Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings,
387
+ Telnyx::Internal::AnyHash
388
+ )
389
+ end
390
+
391
+ # Whether post-conversation processing is enabled. When true, the assistant will
392
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
393
+ # to false.
394
+ sig { returns(T.nilable(T::Boolean)) }
395
+ attr_reader :enabled
396
+
397
+ sig { params(enabled: T::Boolean).void }
398
+ attr_writer :enabled
399
+
400
+ # Configuration for post-conversation processing. When enabled, the assistant
401
+ # receives one additional LLM turn after the conversation ends, allowing it to
402
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
403
+ # can execute multiple parallel or sequential tools during this phase.
404
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
405
+ # post-conversation. Beta feature.
406
+ sig { params(enabled: T::Boolean).returns(T.attached_class) }
407
+ def self.new(
408
+ # Whether post-conversation processing is enabled. When true, the assistant will
409
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
410
+ # to false.
411
+ enabled: nil
412
+ )
413
+ end
414
+
415
+ sig { override.returns({ enabled: T::Boolean }) }
416
+ def to_hash
417
+ end
418
+ end
347
419
  end
348
420
  end
349
421
  end
@@ -119,6 +119,27 @@ module Telnyx
119
119
  end
120
120
  attr_writer :observability_settings
121
121
 
122
+ # Configuration for post-conversation processing. When enabled, the assistant
123
+ # receives one additional LLM turn after the conversation ends, allowing it to
124
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
125
+ # can execute multiple parallel or sequential tools during this phase.
126
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
127
+ # post-conversation. Beta feature.
128
+ sig do
129
+ returns(
130
+ T.nilable(Telnyx::AI::InferenceEmbedding::PostConversationSettings)
131
+ )
132
+ end
133
+ attr_reader :post_conversation_settings
134
+
135
+ sig do
136
+ params(
137
+ post_conversation_settings:
138
+ Telnyx::AI::InferenceEmbedding::PostConversationSettings::OrHash
139
+ ).void
140
+ end
141
+ attr_writer :post_conversation_settings
142
+
122
143
  sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
123
144
  attr_reader :privacy_settings
124
145
 
@@ -201,6 +222,8 @@ module Telnyx
201
222
  llm_api_key_ref: String,
202
223
  messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
203
224
  observability_settings: Telnyx::AI::Observability::OrHash,
225
+ post_conversation_settings:
226
+ Telnyx::AI::InferenceEmbedding::PostConversationSettings::OrHash,
204
227
  privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
205
228
  telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
206
229
  tools:
@@ -260,6 +283,13 @@ module Telnyx
260
283
  llm_api_key_ref: nil,
261
284
  messaging_settings: nil,
262
285
  observability_settings: nil,
286
+ # Configuration for post-conversation processing. When enabled, the assistant
287
+ # receives one additional LLM turn after the conversation ends, allowing it to
288
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
289
+ # can execute multiple parallel or sequential tools during this phase.
290
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
291
+ # post-conversation. Beta feature.
292
+ post_conversation_settings: nil,
263
293
  privacy_settings: nil,
264
294
  telephony_settings: nil,
265
295
  # The tools that the assistant can use. These may be templated with
@@ -291,6 +321,8 @@ module Telnyx
291
321
  llm_api_key_ref: String,
292
322
  messaging_settings: Telnyx::AI::MessagingSettings,
293
323
  observability_settings: Telnyx::AI::Observability,
324
+ post_conversation_settings:
325
+ Telnyx::AI::InferenceEmbedding::PostConversationSettings,
294
326
  privacy_settings: Telnyx::AI::PrivacySettings,
295
327
  telephony_settings: Telnyx::AI::TelephonySettings,
296
328
  tools: T::Array[Telnyx::AI::AssistantTool::Variants],
@@ -302,6 +334,44 @@ module Telnyx
302
334
  end
303
335
  def to_hash
304
336
  end
337
+
338
+ class PostConversationSettings < Telnyx::Internal::Type::BaseModel
339
+ OrHash =
340
+ T.type_alias do
341
+ T.any(
342
+ Telnyx::AI::InferenceEmbedding::PostConversationSettings,
343
+ Telnyx::Internal::AnyHash
344
+ )
345
+ end
346
+
347
+ # Whether post-conversation processing is enabled. When true, the assistant will
348
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
349
+ # to false.
350
+ sig { returns(T.nilable(T::Boolean)) }
351
+ attr_reader :enabled
352
+
353
+ sig { params(enabled: T::Boolean).void }
354
+ attr_writer :enabled
355
+
356
+ # Configuration for post-conversation processing. When enabled, the assistant
357
+ # receives one additional LLM turn after the conversation ends, allowing it to
358
+ # execute tool calls such as logging to a CRM or sending a summary. The assistant
359
+ # can execute multiple parallel or sequential tools during this phase.
360
+ # Telephony-control tools (e.g. hangup, transfer) are unavailable
361
+ # post-conversation. Beta feature.
362
+ sig { params(enabled: T::Boolean).returns(T.attached_class) }
363
+ def self.new(
364
+ # Whether post-conversation processing is enabled. When true, the assistant will
365
+ # be invoked after the conversation ends to perform any final tool calls. Defaults
366
+ # to false.
367
+ enabled: nil
368
+ )
369
+ end
370
+
371
+ sig { override.returns({ enabled: T::Boolean }) }
372
+ def to_hash
373
+ end
374
+ end
305
375
  end
306
376
  end
307
377
  end
@@ -83,6 +83,12 @@ module Telnyx
83
83
  sig { params(webhook_url: String).void }
84
84
  attr_writer :webhook_url
85
85
 
86
+ sig { returns(T.nilable(Telnyx::VerifyProfile::Whatsapp)) }
87
+ attr_reader :whatsapp
88
+
89
+ sig { params(whatsapp: Telnyx::VerifyProfile::Whatsapp::OrHash).void }
90
+ attr_writer :whatsapp
91
+
86
92
  sig do
87
93
  params(
88
94
  id: String,
@@ -96,7 +102,8 @@ module Telnyx
96
102
  sms: Telnyx::VerifyProfile::SMS::OrHash,
97
103
  updated_at: String,
98
104
  webhook_failover_url: String,
99
- webhook_url: String
105
+ webhook_url: String,
106
+ whatsapp: Telnyx::VerifyProfile::Whatsapp::OrHash
100
107
  ).returns(T.attached_class)
101
108
  end
102
109
  def self.new(
@@ -112,7 +119,8 @@ module Telnyx
112
119
  sms: nil,
113
120
  updated_at: nil,
114
121
  webhook_failover_url: nil,
115
- webhook_url: nil
122
+ webhook_url: nil,
123
+ whatsapp: nil
116
124
  )
117
125
  end
118
126
 
@@ -130,7 +138,8 @@ module Telnyx
130
138
  sms: Telnyx::VerifyProfile::SMS,
131
139
  updated_at: String,
132
140
  webhook_failover_url: String,
133
- webhook_url: String
141
+ webhook_url: String,
142
+ whatsapp: Telnyx::VerifyProfile::Whatsapp
134
143
  }
135
144
  )
136
145
  end
@@ -516,6 +525,125 @@ module Telnyx
516
525
  def to_hash
517
526
  end
518
527
  end
528
+
529
+ class Whatsapp < Telnyx::Internal::Type::BaseModel
530
+ OrHash =
531
+ T.type_alias do
532
+ T.any(Telnyx::VerifyProfile::Whatsapp, Telnyx::Internal::AnyHash)
533
+ end
534
+
535
+ # The name that identifies the application requesting 2fa in the verification
536
+ # message.
537
+ sig { returns(T.nilable(String)) }
538
+ attr_reader :app_name
539
+
540
+ sig { params(app_name: String).void }
541
+ attr_writer :app_name
542
+
543
+ # The length of the verify code to generate.
544
+ sig { returns(T.nilable(Integer)) }
545
+ attr_reader :code_length
546
+
547
+ sig { params(code_length: Integer).void }
548
+ attr_writer :code_length
549
+
550
+ # For every request that is initiated via this Verify profile, this sets the
551
+ # number of seconds before a verification request code expires. Once the
552
+ # verification request expires, the user cannot use the code to verify their
553
+ # identity.
554
+ sig { returns(T.nilable(Integer)) }
555
+ attr_reader :default_verification_timeout_secs
556
+
557
+ sig { params(default_verification_timeout_secs: Integer).void }
558
+ attr_writer :default_verification_timeout_secs
559
+
560
+ # The message template identifier selected from /verify_profiles/templates
561
+ sig { returns(T.nilable(String)) }
562
+ attr_reader :messaging_template_id
563
+
564
+ sig { params(messaging_template_id: String).void }
565
+ attr_writer :messaging_template_id
566
+
567
+ # Phone number registered on the customer WABA to send OTPs from
568
+ sig { returns(T.nilable(String)) }
569
+ attr_accessor :sender_phone_number
570
+
571
+ # Customer pre-approved authentication template name registered on Meta
572
+ sig { returns(T.nilable(String)) }
573
+ attr_accessor :template_id
574
+
575
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
576
+ sig { returns(T.nilable(String)) }
577
+ attr_accessor :waba_id
578
+
579
+ # Enabled country destinations to send verification codes. The elements in the
580
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
581
+ # destinations will be allowed. **Conditionally required:** this field must be
582
+ # provided when your organization is configured to require explicit whitelisted
583
+ # destinations; otherwise it is optional.
584
+ sig { returns(T.nilable(T::Array[String])) }
585
+ attr_reader :whitelisted_destinations
586
+
587
+ sig { params(whitelisted_destinations: T::Array[String]).void }
588
+ attr_writer :whitelisted_destinations
589
+
590
+ sig do
591
+ params(
592
+ app_name: String,
593
+ code_length: Integer,
594
+ default_verification_timeout_secs: Integer,
595
+ messaging_template_id: String,
596
+ sender_phone_number: T.nilable(String),
597
+ template_id: T.nilable(String),
598
+ waba_id: T.nilable(String),
599
+ whitelisted_destinations: T::Array[String]
600
+ ).returns(T.attached_class)
601
+ end
602
+ def self.new(
603
+ # The name that identifies the application requesting 2fa in the verification
604
+ # message.
605
+ app_name: nil,
606
+ # The length of the verify code to generate.
607
+ code_length: nil,
608
+ # For every request that is initiated via this Verify profile, this sets the
609
+ # number of seconds before a verification request code expires. Once the
610
+ # verification request expires, the user cannot use the code to verify their
611
+ # identity.
612
+ default_verification_timeout_secs: nil,
613
+ # The message template identifier selected from /verify_profiles/templates
614
+ messaging_template_id: nil,
615
+ # Phone number registered on the customer WABA to send OTPs from
616
+ sender_phone_number: nil,
617
+ # Customer pre-approved authentication template name registered on Meta
618
+ template_id: nil,
619
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
620
+ waba_id: nil,
621
+ # Enabled country destinations to send verification codes. The elements in the
622
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
623
+ # destinations will be allowed. **Conditionally required:** this field must be
624
+ # provided when your organization is configured to require explicit whitelisted
625
+ # destinations; otherwise it is optional.
626
+ whitelisted_destinations: nil
627
+ )
628
+ end
629
+
630
+ sig do
631
+ override.returns(
632
+ {
633
+ app_name: String,
634
+ code_length: Integer,
635
+ default_verification_timeout_secs: Integer,
636
+ messaging_template_id: String,
637
+ sender_phone_number: T.nilable(String),
638
+ template_id: T.nilable(String),
639
+ waba_id: T.nilable(String),
640
+ whitelisted_destinations: T::Array[String]
641
+ }
642
+ )
643
+ end
644
+ def to_hash
645
+ end
646
+ end
519
647
  end
520
648
  end
521
649
  end
@@ -517,14 +517,6 @@ module Telnyx
517
517
  )
518
518
  end
519
519
 
520
- # The name that identifies the application requesting 2fa in the verification
521
- # message.
522
- sig { returns(T.nilable(String)) }
523
- attr_reader :app_name
524
-
525
- sig { params(app_name: String).void }
526
- attr_writer :app_name
527
-
528
520
  # For every request that is initiated via this Verify profile, this sets the
529
521
  # number of seconds before a verification request code expires. Once the
530
522
  # verification request expires, the user cannot use the code to verify their
@@ -535,6 +527,18 @@ module Telnyx
535
527
  sig { params(default_verification_timeout_secs: Integer).void }
536
528
  attr_writer :default_verification_timeout_secs
537
529
 
530
+ # Phone number registered on the customer WABA to send OTPs from
531
+ sig { returns(T.nilable(String)) }
532
+ attr_accessor :sender_phone_number
533
+
534
+ # Customer pre-approved authentication template name registered on Meta
535
+ sig { returns(T.nilable(String)) }
536
+ attr_accessor :template_id
537
+
538
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
539
+ sig { returns(T.nilable(String)) }
540
+ attr_accessor :waba_id
541
+
538
542
  # Enabled country destinations to send verification codes. The elements in the
539
543
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
540
544
  # destinations will be allowed. **Conditionally required:** this field must be
@@ -548,20 +552,25 @@ module Telnyx
548
552
 
549
553
  sig do
550
554
  params(
551
- app_name: String,
552
555
  default_verification_timeout_secs: Integer,
556
+ sender_phone_number: T.nilable(String),
557
+ template_id: T.nilable(String),
558
+ waba_id: T.nilable(String),
553
559
  whitelisted_destinations: T::Array[String]
554
560
  ).returns(T.attached_class)
555
561
  end
556
562
  def self.new(
557
- # The name that identifies the application requesting 2fa in the verification
558
- # message.
559
- app_name: nil,
560
563
  # For every request that is initiated via this Verify profile, this sets the
561
564
  # number of seconds before a verification request code expires. Once the
562
565
  # verification request expires, the user cannot use the code to verify their
563
566
  # identity.
564
567
  default_verification_timeout_secs: nil,
568
+ # Phone number registered on the customer WABA to send OTPs from
569
+ sender_phone_number: nil,
570
+ # Customer pre-approved authentication template name registered on Meta
571
+ template_id: nil,
572
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
573
+ waba_id: nil,
565
574
  # Enabled country destinations to send verification codes. The elements in the
566
575
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
567
576
  # destinations will be allowed. **Conditionally required:** this field must be
@@ -574,8 +583,10 @@ module Telnyx
574
583
  sig do
575
584
  override.returns(
576
585
  {
577
- app_name: String,
578
586
  default_verification_timeout_secs: Integer,
587
+ sender_phone_number: T.nilable(String),
588
+ template_id: T.nilable(String),
589
+ waba_id: T.nilable(String),
579
590
  whitelisted_destinations: T::Array[String]
580
591
  }
581
592
  )