telnyx 5.80.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7d1f7a2b9815ac11e1e574e9f0ee7879f334c1dc3da1506db028f9dbbfceb751
4
- data.tar.gz: 97cc5671aca33817349f115ad8f0b1cbec7a130d0f0a828d1fa346536637e544
3
+ metadata.gz: 49e5ef74b7e9510226700fd28a6d794cee40f68a7252f25b82812dd092d44f50
4
+ data.tar.gz: 0c088808a8572881377bf3cc37e36221d4d462f7b2f970f7057ac86e34c8d6dd
5
5
  SHA512:
6
- metadata.gz: 8f43f17546b17f4e6730985a628b7c0ae6bd614a498cd2a1c3fbf4add5ec3c48c5bd01ca3daccc19bb7c9fc763707c631b29982c7d9e1b7f082d3eaf0162c60f
7
- data.tar.gz: b96de95e050310ad7eeefbeb035aa0bcf8268e2077f3c0ebd3e04a16fe5eaf8815d6643607a6febed1c1beb3c76eea3048c899d333cca77d9af76d7a43326719
6
+ metadata.gz: 5b33c7a0528baf04ad9909cbc03817ba0a5691c7e608b23b9e18f27c7b2950d8599b166892486d753292bc617c22a213902509d3160f6366b98eb4d76783bdf4
7
+ data.tar.gz: 8ce0ec0ac7b74fe6f81072cf2acb30859aee8c85299864a1f7585c0b22e5195eaf91a87d10f03f37ce6ee5db2bd13c9678b2ef99ea90b96aa9b72f7e5e7dc4eb
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 5.81.0 (2026-04-22)
4
+
5
+ Full Changelog: [v5.80.0...v5.81.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.80.0...v5.81.0)
6
+
7
+ ### Features
8
+
9
+ * MSG-6841: add missing whatsapp api docs ([be4e44d](https://github.com/team-telnyx/telnyx-ruby/commit/be4e44d5fa6813033cc2c93ba6ef5b3483d86717))
10
+
3
11
  ## 5.80.0 (2026-04-21)
4
12
 
5
13
  Full Changelog: [v5.79.0...v5.80.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.79.0...v5.80.0)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "telnyx", "~> 5.80.0"
27
+ gem "telnyx", "~> 5.81.0"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -65,7 +65,12 @@ module Telnyx
65
65
  # @return [String, nil]
66
66
  optional :webhook_url, String
67
67
 
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)
68
+ # @!attribute whatsapp
69
+ #
70
+ # @return [Telnyx::Models::VerifyProfile::Whatsapp, nil]
71
+ optional :whatsapp, -> { Telnyx::VerifyProfile::Whatsapp }
72
+
73
+ # @!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, whatsapp: nil)
69
74
  # @param id [String]
70
75
  #
71
76
  # @param call [Telnyx::Models::VerifyProfile::Call]
@@ -89,6 +94,8 @@ module Telnyx
89
94
  # @param webhook_failover_url [String]
90
95
  #
91
96
  # @param webhook_url [String]
97
+ #
98
+ # @param whatsapp [Telnyx::Models::VerifyProfile::Whatsapp]
92
99
 
93
100
  # @see Telnyx::Models::VerifyProfile#call
94
101
  class Call < Telnyx::Internal::Type::BaseModel
@@ -310,6 +317,85 @@ module Telnyx
310
317
  #
311
318
  # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
312
319
  end
320
+
321
+ # @see Telnyx::Models::VerifyProfile#whatsapp
322
+ class Whatsapp < Telnyx::Internal::Type::BaseModel
323
+ # @!attribute app_name
324
+ # The name that identifies the application requesting 2fa in the verification
325
+ # message.
326
+ #
327
+ # @return [String, nil]
328
+ optional :app_name, String
329
+
330
+ # @!attribute code_length
331
+ # The length of the verify code to generate.
332
+ #
333
+ # @return [Integer, nil]
334
+ optional :code_length, Integer
335
+
336
+ # @!attribute default_verification_timeout_secs
337
+ # For every request that is initiated via this Verify profile, this sets the
338
+ # number of seconds before a verification request code expires. Once the
339
+ # verification request expires, the user cannot use the code to verify their
340
+ # identity.
341
+ #
342
+ # @return [Integer, nil]
343
+ optional :default_verification_timeout_secs, Integer
344
+
345
+ # @!attribute messaging_template_id
346
+ # The message template identifier selected from /verify_profiles/templates
347
+ #
348
+ # @return [String, nil]
349
+ optional :messaging_template_id, String
350
+
351
+ # @!attribute sender_phone_number
352
+ # Phone number registered on the customer WABA to send OTPs from
353
+ #
354
+ # @return [String, nil]
355
+ optional :sender_phone_number, String, nil?: true
356
+
357
+ # @!attribute template_id
358
+ # Customer pre-approved authentication template name registered on Meta
359
+ #
360
+ # @return [String, nil]
361
+ optional :template_id, String, nil?: true
362
+
363
+ # @!attribute waba_id
364
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
365
+ #
366
+ # @return [String, nil]
367
+ optional :waba_id, String, nil?: true
368
+
369
+ # @!attribute whitelisted_destinations
370
+ # Enabled country destinations to send verification codes. The elements in the
371
+ # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
372
+ # destinations will be allowed. **Conditionally required:** this field must be
373
+ # provided when your organization is configured to require explicit whitelisted
374
+ # destinations; otherwise it is optional.
375
+ #
376
+ # @return [Array<String>, nil]
377
+ optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
378
+
379
+ # @!method initialize(app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
380
+ # Some parameter documentations has been truncated, see
381
+ # {Telnyx::Models::VerifyProfile::Whatsapp} for more details.
382
+ #
383
+ # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
384
+ #
385
+ # @param code_length [Integer] The length of the verify code to generate.
386
+ #
387
+ # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
388
+ #
389
+ # @param messaging_template_id [String] The message template identifier selected from /verify_profiles/templates
390
+ #
391
+ # @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
392
+ #
393
+ # @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
394
+ #
395
+ # @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
396
+ #
397
+ # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
398
+ end
313
399
  end
314
400
  end
315
401
  end
@@ -282,13 +282,6 @@ module Telnyx
282
282
  end
283
283
 
284
284
  class Whatsapp < Telnyx::Internal::Type::BaseModel
285
- # @!attribute app_name
286
- # The name that identifies the application requesting 2fa in the verification
287
- # message.
288
- #
289
- # @return [String, nil]
290
- optional :app_name, String
291
-
292
285
  # @!attribute default_verification_timeout_secs
293
286
  # For every request that is initiated via this Verify profile, this sets the
294
287
  # number of seconds before a verification request code expires. Once the
@@ -298,6 +291,24 @@ module Telnyx
298
291
  # @return [Integer, nil]
299
292
  optional :default_verification_timeout_secs, Integer
300
293
 
294
+ # @!attribute sender_phone_number
295
+ # Phone number registered on the customer WABA to send OTPs from
296
+ #
297
+ # @return [String, nil]
298
+ optional :sender_phone_number, String, nil?: true
299
+
300
+ # @!attribute template_id
301
+ # Customer pre-approved authentication template name registered on Meta
302
+ #
303
+ # @return [String, nil]
304
+ optional :template_id, String, nil?: true
305
+
306
+ # @!attribute waba_id
307
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
308
+ #
309
+ # @return [String, nil]
310
+ optional :waba_id, String, nil?: true
311
+
301
312
  # @!attribute whitelisted_destinations
302
313
  # Enabled country destinations to send verification codes. The elements in the
303
314
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
@@ -308,14 +319,18 @@ module Telnyx
308
319
  # @return [Array<String>, nil]
309
320
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
310
321
 
311
- # @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
322
+ # @!method initialize(default_verification_timeout_secs: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
312
323
  # Some parameter documentations has been truncated, see
313
324
  # {Telnyx::Models::VerifyProfileCreateParams::Whatsapp} for more details.
314
325
  #
315
- # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
316
- #
317
326
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
318
327
  #
328
+ # @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
329
+ #
330
+ # @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
331
+ #
332
+ # @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
333
+ #
319
334
  # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
320
335
  end
321
336
  end
@@ -288,13 +288,6 @@ module Telnyx
288
288
  end
289
289
 
290
290
  class Whatsapp < Telnyx::Internal::Type::BaseModel
291
- # @!attribute app_name
292
- # The name that identifies the application requesting 2fa in the verification
293
- # message.
294
- #
295
- # @return [String, nil]
296
- optional :app_name, String
297
-
298
291
  # @!attribute default_verification_timeout_secs
299
292
  # For every request that is initiated via this Verify profile, this sets the
300
293
  # number of seconds before a verification request code expires. Once the
@@ -304,6 +297,24 @@ module Telnyx
304
297
  # @return [Integer, nil]
305
298
  optional :default_verification_timeout_secs, Integer
306
299
 
300
+ # @!attribute sender_phone_number
301
+ # Phone number registered on the customer WABA to send OTPs from
302
+ #
303
+ # @return [String, nil]
304
+ optional :sender_phone_number, String, nil?: true
305
+
306
+ # @!attribute template_id
307
+ # Customer pre-approved authentication template name registered on Meta
308
+ #
309
+ # @return [String, nil]
310
+ optional :template_id, String, nil?: true
311
+
312
+ # @!attribute waba_id
313
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
314
+ #
315
+ # @return [String, nil]
316
+ optional :waba_id, String, nil?: true
317
+
307
318
  # @!attribute whitelisted_destinations
308
319
  # Enabled country destinations to send verification codes. The elements in the
309
320
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
@@ -314,14 +325,18 @@ module Telnyx
314
325
  # @return [Array<String>, nil]
315
326
  optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
316
327
 
317
- # @!method initialize(app_name: nil, default_verification_timeout_secs: nil, whitelisted_destinations: nil)
328
+ # @!method initialize(default_verification_timeout_secs: nil, sender_phone_number: nil, template_id: nil, waba_id: nil, whitelisted_destinations: nil)
318
329
  # Some parameter documentations has been truncated, see
319
330
  # {Telnyx::Models::VerifyProfileUpdateParams::Whatsapp} for more details.
320
331
  #
321
- # @param app_name [String] The name that identifies the application requesting 2fa in the verification mess
322
- #
323
332
  # @param default_verification_timeout_secs [Integer] For every request that is initiated via this Verify profile, this sets the numbe
324
333
  #
334
+ # @param sender_phone_number [String, nil] Phone number registered on the customer WABA to send OTPs from
335
+ #
336
+ # @param template_id [String, nil] Customer pre-approved authentication template name registered on Meta
337
+ #
338
+ # @param waba_id [String, nil] Customer Meta WABA ID for Bring-Your-Own-WABA sending
339
+ #
325
340
  # @param whitelisted_destinations [Array<String>] Enabled country destinations to send verification codes. The elements in the lis
326
341
  end
327
342
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.80.0"
4
+ VERSION = "5.81.0"
5
5
  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
  )
@@ -526,14 +526,6 @@ module Telnyx
526
526
  )
527
527
  end
528
528
 
529
- # The name that identifies the application requesting 2fa in the verification
530
- # message.
531
- sig { returns(T.nilable(String)) }
532
- attr_reader :app_name
533
-
534
- sig { params(app_name: String).void }
535
- attr_writer :app_name
536
-
537
529
  # For every request that is initiated via this Verify profile, this sets the
538
530
  # number of seconds before a verification request code expires. Once the
539
531
  # verification request expires, the user cannot use the code to verify their
@@ -544,6 +536,18 @@ module Telnyx
544
536
  sig { params(default_verification_timeout_secs: Integer).void }
545
537
  attr_writer :default_verification_timeout_secs
546
538
 
539
+ # Phone number registered on the customer WABA to send OTPs from
540
+ sig { returns(T.nilable(String)) }
541
+ attr_accessor :sender_phone_number
542
+
543
+ # Customer pre-approved authentication template name registered on Meta
544
+ sig { returns(T.nilable(String)) }
545
+ attr_accessor :template_id
546
+
547
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
548
+ sig { returns(T.nilable(String)) }
549
+ attr_accessor :waba_id
550
+
547
551
  # Enabled country destinations to send verification codes. The elements in the
548
552
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
549
553
  # destinations will be allowed. **Conditionally required:** this field must be
@@ -557,20 +561,25 @@ module Telnyx
557
561
 
558
562
  sig do
559
563
  params(
560
- app_name: String,
561
564
  default_verification_timeout_secs: Integer,
565
+ sender_phone_number: T.nilable(String),
566
+ template_id: T.nilable(String),
567
+ waba_id: T.nilable(String),
562
568
  whitelisted_destinations: T::Array[String]
563
569
  ).returns(T.attached_class)
564
570
  end
565
571
  def self.new(
566
- # The name that identifies the application requesting 2fa in the verification
567
- # message.
568
- app_name: nil,
569
572
  # For every request that is initiated via this Verify profile, this sets the
570
573
  # number of seconds before a verification request code expires. Once the
571
574
  # verification request expires, the user cannot use the code to verify their
572
575
  # identity.
573
576
  default_verification_timeout_secs: nil,
577
+ # Phone number registered on the customer WABA to send OTPs from
578
+ sender_phone_number: nil,
579
+ # Customer pre-approved authentication template name registered on Meta
580
+ template_id: nil,
581
+ # Customer Meta WABA ID for Bring-Your-Own-WABA sending
582
+ waba_id: nil,
574
583
  # Enabled country destinations to send verification codes. The elements in the
575
584
  # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
576
585
  # destinations will be allowed. **Conditionally required:** this field must be
@@ -583,8 +592,10 @@ module Telnyx
583
592
  sig do
584
593
  override.returns(
585
594
  {
586
- app_name: String,
587
595
  default_verification_timeout_secs: Integer,
596
+ sender_phone_number: T.nilable(String),
597
+ template_id: T.nilable(String),
598
+ waba_id: T.nilable(String),
588
599
  whitelisted_destinations: T::Array[String]
589
600
  }
590
601
  )
@@ -13,7 +13,8 @@ module Telnyx
13
13
  sms: Telnyx::VerifyProfile::SMS,
14
14
  updated_at: String,
15
15
  webhook_failover_url: String,
16
- webhook_url: String
16
+ webhook_url: String,
17
+ whatsapp: Telnyx::VerifyProfile::Whatsapp
17
18
  }
18
19
 
19
20
  class VerifyProfile < Telnyx::Internal::Type::BaseModel
@@ -69,6 +70,12 @@ module Telnyx
69
70
 
70
71
  def webhook_url=: (String) -> String
71
72
 
73
+ attr_reader whatsapp: Telnyx::VerifyProfile::Whatsapp?
74
+
75
+ def whatsapp=: (
76
+ Telnyx::VerifyProfile::Whatsapp
77
+ ) -> Telnyx::VerifyProfile::Whatsapp
78
+
72
79
  def initialize: (
73
80
  ?id: String,
74
81
  ?call: Telnyx::VerifyProfile::Call,
@@ -81,7 +88,8 @@ module Telnyx
81
88
  ?sms: Telnyx::VerifyProfile::SMS,
82
89
  ?updated_at: String,
83
90
  ?webhook_failover_url: String,
84
- ?webhook_url: String
91
+ ?webhook_url: String,
92
+ ?whatsapp: Telnyx::VerifyProfile::Whatsapp
85
93
  ) -> void
86
94
 
87
95
  def to_hash: -> {
@@ -96,7 +104,8 @@ module Telnyx
96
104
  sms: Telnyx::VerifyProfile::SMS,
97
105
  updated_at: String,
98
106
  webhook_failover_url: String,
99
- webhook_url: String
107
+ webhook_url: String,
108
+ whatsapp: Telnyx::VerifyProfile::Whatsapp
100
109
  }
101
110
 
102
111
  type call =
@@ -284,6 +293,68 @@ module Telnyx
284
293
  whitelisted_destinations: ::Array[String]
285
294
  }
286
295
  end
296
+
297
+ type whatsapp =
298
+ {
299
+ app_name: String,
300
+ code_length: Integer,
301
+ default_verification_timeout_secs: Integer,
302
+ messaging_template_id: String,
303
+ sender_phone_number: String?,
304
+ template_id: String?,
305
+ waba_id: String?,
306
+ whitelisted_destinations: ::Array[String]
307
+ }
308
+
309
+ class Whatsapp < Telnyx::Internal::Type::BaseModel
310
+ attr_reader app_name: String?
311
+
312
+ def app_name=: (String) -> String
313
+
314
+ attr_reader code_length: Integer?
315
+
316
+ def code_length=: (Integer) -> Integer
317
+
318
+ attr_reader default_verification_timeout_secs: Integer?
319
+
320
+ def default_verification_timeout_secs=: (Integer) -> Integer
321
+
322
+ attr_reader messaging_template_id: String?
323
+
324
+ def messaging_template_id=: (String) -> String
325
+
326
+ attr_accessor sender_phone_number: String?
327
+
328
+ attr_accessor template_id: String?
329
+
330
+ attr_accessor waba_id: String?
331
+
332
+ attr_reader whitelisted_destinations: ::Array[String]?
333
+
334
+ def whitelisted_destinations=: (::Array[String]) -> ::Array[String]
335
+
336
+ def initialize: (
337
+ ?app_name: String,
338
+ ?code_length: Integer,
339
+ ?default_verification_timeout_secs: Integer,
340
+ ?messaging_template_id: String,
341
+ ?sender_phone_number: String?,
342
+ ?template_id: String?,
343
+ ?waba_id: String?,
344
+ ?whitelisted_destinations: ::Array[String]
345
+ ) -> void
346
+
347
+ def to_hash: -> {
348
+ app_name: String,
349
+ code_length: Integer,
350
+ default_verification_timeout_secs: Integer,
351
+ messaging_template_id: String,
352
+ sender_phone_number: String?,
353
+ template_id: String?,
354
+ waba_id: String?,
355
+ whitelisted_destinations: ::Array[String]
356
+ }
357
+ end
287
358
  end
288
359
  end
289
360
  end
@@ -276,33 +276,41 @@ module Telnyx
276
276
 
277
277
  type whatsapp =
278
278
  {
279
- app_name: String,
280
279
  default_verification_timeout_secs: Integer,
280
+ sender_phone_number: String?,
281
+ template_id: String?,
282
+ waba_id: String?,
281
283
  whitelisted_destinations: ::Array[String]
282
284
  }
283
285
 
284
286
  class Whatsapp < Telnyx::Internal::Type::BaseModel
285
- attr_reader app_name: String?
286
-
287
- def app_name=: (String) -> String
288
-
289
287
  attr_reader default_verification_timeout_secs: Integer?
290
288
 
291
289
  def default_verification_timeout_secs=: (Integer) -> Integer
292
290
 
291
+ attr_accessor sender_phone_number: String?
292
+
293
+ attr_accessor template_id: String?
294
+
295
+ attr_accessor waba_id: String?
296
+
293
297
  attr_reader whitelisted_destinations: ::Array[String]?
294
298
 
295
299
  def whitelisted_destinations=: (::Array[String]) -> ::Array[String]
296
300
 
297
301
  def initialize: (
298
- ?app_name: String,
299
302
  ?default_verification_timeout_secs: Integer,
303
+ ?sender_phone_number: String?,
304
+ ?template_id: String?,
305
+ ?waba_id: String?,
300
306
  ?whitelisted_destinations: ::Array[String]
301
307
  ) -> void
302
308
 
303
309
  def to_hash: -> {
304
- app_name: String,
305
310
  default_verification_timeout_secs: Integer,
311
+ sender_phone_number: String?,
312
+ template_id: String?,
313
+ waba_id: String?,
306
314
  whitelisted_destinations: ::Array[String]
307
315
  }
308
316
  end
@@ -283,33 +283,41 @@ module Telnyx
283
283
 
284
284
  type whatsapp =
285
285
  {
286
- app_name: String,
287
286
  default_verification_timeout_secs: Integer,
287
+ sender_phone_number: String?,
288
+ template_id: String?,
289
+ waba_id: String?,
288
290
  whitelisted_destinations: ::Array[String]
289
291
  }
290
292
 
291
293
  class Whatsapp < Telnyx::Internal::Type::BaseModel
292
- attr_reader app_name: String?
293
-
294
- def app_name=: (String) -> String
295
-
296
294
  attr_reader default_verification_timeout_secs: Integer?
297
295
 
298
296
  def default_verification_timeout_secs=: (Integer) -> Integer
299
297
 
298
+ attr_accessor sender_phone_number: String?
299
+
300
+ attr_accessor template_id: String?
301
+
302
+ attr_accessor waba_id: String?
303
+
300
304
  attr_reader whitelisted_destinations: ::Array[String]?
301
305
 
302
306
  def whitelisted_destinations=: (::Array[String]) -> ::Array[String]
303
307
 
304
308
  def initialize: (
305
- ?app_name: String,
306
309
  ?default_verification_timeout_secs: Integer,
310
+ ?sender_phone_number: String?,
311
+ ?template_id: String?,
312
+ ?waba_id: String?,
307
313
  ?whitelisted_destinations: ::Array[String]
308
314
  ) -> void
309
315
 
310
316
  def to_hash: -> {
311
- app_name: String,
312
317
  default_verification_timeout_secs: Integer,
318
+ sender_phone_number: String?,
319
+ template_id: String?,
320
+ waba_id: String?,
313
321
  whitelisted_destinations: ::Array[String]
314
322
  }
315
323
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: telnyx
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.80.0
4
+ version: 5.81.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Telnyx
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-04-21 00:00:00.000000000 Z
11
+ date: 2026-04-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi