telnyx 5.27.0 → 5.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac219cca9489be5d485de3357985d32d754ca4f58041926acbd9d30dabc09cd5
-  data.tar.gz: 7019be13066ffddf7631d940cc2499b27f35850f84d3d3d6ed6aecd3cba2692b
+  metadata.gz: a3f36777848b37d5f2c1ceb5ac85b6f6a55c6d9b9300e765c703851e3df47422
+  data.tar.gz: ce719e6d970c664cc37e95b937317b2fb105ec03f1669e6de06341c34f9c7a58
 SHA512:
-  metadata.gz: 01a3f0ee7ac62a9839e32361c34b27cdeb72e196e18f2af2b9c7251c47f221d669b55ccf413372ce7cead0b4c92ed312fcd25adbd3569080f054ece53d373479
-  data.tar.gz: a05cb89dbd90ddd314f4ce569d4754238e8a222998f76359c16b0401a7c60ef730be5757e6788b17668521114f5405383014742a679753f70c3b9fca3f14be0f
+  metadata.gz: b3456c24794f8441f4707f304028d1806d51bbccf07e01caf11e394791ff1c4e18668ff29f6e9967efcaf5c32636512c7cdf61cc834fda133d07315e4c7cb37a
+  data.tar.gz: ec2b7590543fa418d1a42dbcb45584dfa8c0996ca72edcd0d1344ce4baa464a39eac9b2bbd6ef131625946953496149fef50f1c485384410efcd7e20c86e2500

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.28.0 (2026-02-18)
+
+Full Changelog: [v5.27.0...v5.28.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.27.0...v5.28.0)
+
+### Features
+
+* **api:** manual updates ([7f22269](https://github.com/team-telnyx/telnyx-ruby/commit/7f222695996445e1abcceb3a81f601fa72542d05))
+
 ## 5.27.0 (2026-02-18)
 
 Full Changelog: [v5.26.0...v5.27.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.26.0...v5.27.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.27.0"
+gem "telnyx", "~> 5.28.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      # @see Telnyx::Resources::Messaging10dlc::Brand#get_sms_otp_by_reference
+      class BrandGetSMSOtpByReferenceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #   Filter by Brand ID for easier lookup in portal applications
+        #
+        #   @return [String, nil]
+        optional :brand_id, String
+
+        # @!method initialize(brand_id: nil, request_options: {})
+        #   @param brand_id [String] Filter by Brand ID for easier lookup in portal applications
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      # @see Telnyx::Resources::Messaging10dlc::Brand#get_sms_otp_by_reference
+      class BrandGetSMSOtpByReferenceResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute brand_id
+        #   The Brand ID associated with this OTP request
+        #
+        #   @return [String]
+        required :brand_id, String, api_name: :brandId
+
+        # @!attribute delivery_status
+        #   The current delivery status of the OTP SMS message. Common values include:
+        #   `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+        #
+        #   @return [String]
+        required :delivery_status, String, api_name: :deliveryStatus
+
+        # @!attribute mobile_phone
+        #   The mobile phone number where the OTP was sent, in E.164 format
+        #
+        #   @return [String]
+        required :mobile_phone, String, api_name: :mobilePhone
+
+        # @!attribute reference_id
+        #   The reference ID for this OTP request, used for status queries
+        #
+        #   @return [String]
+        required :reference_id, String, api_name: :referenceId
+
+        # @!attribute request_date
+        #   The timestamp when the OTP request was initiated
+        #
+        #   @return [Time]
+        required :request_date, Time, api_name: :requestDate
+
+        # @!attribute delivery_status_date
+        #   The timestamp when the delivery status was last updated
+        #
+        #   @return [Time, nil]
+        optional :delivery_status_date, Time, api_name: :deliveryStatusDate
+
+        # @!attribute delivery_status_details
+        #   Additional details about the delivery status
+        #
+        #   @return [String, nil]
+        optional :delivery_status_details, String, api_name: :deliveryStatusDetails
+
+        # @!attribute verify_date
+        #   The timestamp when the OTP was successfully verified (if applicable)
+        #
+        #   @return [Time, nil]
+        optional :verify_date, Time, api_name: :verifyDate
+
+        # @!method initialize(brand_id:, delivery_status:, mobile_phone:, reference_id:, request_date:, delivery_status_date: nil, delivery_status_details: nil, verify_date: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse} for more
+        #   details.
+        #
+        #   Status information for an SMS OTP sent during Sole Proprietor brand verification
+        #
+        #   @param brand_id [String] The Brand ID associated with this OTP request
+        #
+        #   @param delivery_status [String] The current delivery status of the OTP SMS message. Common values include: `DELI
+        #
+        #   @param mobile_phone [String] The mobile phone number where the OTP was sent, in E.164 format
+        #
+        #   @param reference_id [String] The reference ID for this OTP request, used for status queries
+        #
+        #   @param request_date [Time] The timestamp when the OTP request was initiated
+        #
+        #   @param delivery_status_date [Time] The timestamp when the delivery status was last updated
+        #
+        #   @param delivery_status_details [String] Additional details about the delivery status
+        #
+        #   @param verify_date [Time] The timestamp when the OTP was successfully verified (if applicable)
+      end
+    end
+  end
+end

data/lib/telnyx/resources/messaging_10dlc/brand.rb

@@ -275,6 +275,41 @@ module Telnyx
           )
         end
 
+        # Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand
+        # verification.
+        #
+        # This endpoint allows you to check the delivery and verification status of an OTP
+        # sent during the Sole Proprietor brand verification process. You can query by
+        # either:
+        #
+        # - `referenceId` - The reference ID returned when the OTP was initially triggered
+        # - `brandId` - Query parameter for portal users to look up OTP status by Brand ID
+        #
+        # The response includes delivery status, verification dates, and detailed delivery
+        # information.
+        #
+        # @overload get_sms_otp_by_reference(reference_id, brand_id: nil, request_options: {})
+        #
+        # @param reference_id [String] The reference ID returned when the OTP was initially triggered
+        #
+        # @param brand_id [String] Filter by Brand ID for easier lookup in portal applications
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse]
+        #
+        # @see Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceParams
+        def get_sms_otp_by_reference(reference_id, params = {})
+          parsed, options = Telnyx::Messaging10dlc::BrandGetSMSOtpByReferenceParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: ["10dlc/brand/smsOtp/%1$s", reference_id],
+            query: parsed.transform_keys(brand_id: "brandId"),
+            model: Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse,
+            options: options
+          )
+        end
+
         # Resend brand 2FA email
         #
         # @overload resend_2fa_email(brand_id, request_options: {})

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.27.0"
+  VERSION = "5.28.0"
 end

data/lib/telnyx.rb

@@ -1095,6 +1095,8 @@ require_relative "telnyx/models/messaging_10dlc/brand_create_params"
 require_relative "telnyx/models/messaging_10dlc/brand_delete_params"
 require_relative "telnyx/models/messaging_10dlc/brand_get_feedback_params"
 require_relative "telnyx/models/messaging_10dlc/brand_get_feedback_response"
+require_relative "telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params"
+require_relative "telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response"
 require_relative "telnyx/models/messaging_10dlc/brand_identity_status"
 require_relative "telnyx/models/messaging_10dlc/brand_list_params"
 require_relative "telnyx/models/messaging_10dlc/brand_list_response"

data/rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      class BrandGetSMSOtpByReferenceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Messaging10dlc::BrandGetSMSOtpByReferenceParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Filter by Brand ID for easier lookup in portal applications
+        sig { returns(T.nilable(String)) }
+        attr_reader :brand_id
+
+        sig { params(brand_id: String).void }
+        attr_writer :brand_id
+
+        sig do
+          params(
+            brand_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter by Brand ID for easier lookup in portal applications
+          brand_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { brand_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rbi

@@ -0,0 +1,110 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Messaging10dlc
+      class BrandGetSMSOtpByReferenceResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The Brand ID associated with this OTP request
+        sig { returns(String) }
+        attr_accessor :brand_id
+
+        # The current delivery status of the OTP SMS message. Common values include:
+        # `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+        sig { returns(String) }
+        attr_accessor :delivery_status
+
+        # The mobile phone number where the OTP was sent, in E.164 format
+        sig { returns(String) }
+        attr_accessor :mobile_phone
+
+        # The reference ID for this OTP request, used for status queries
+        sig { returns(String) }
+        attr_accessor :reference_id
+
+        # The timestamp when the OTP request was initiated
+        sig { returns(Time) }
+        attr_accessor :request_date
+
+        # The timestamp when the delivery status was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :delivery_status_date
+
+        sig { params(delivery_status_date: Time).void }
+        attr_writer :delivery_status_date
+
+        # Additional details about the delivery status
+        sig { returns(T.nilable(String)) }
+        attr_reader :delivery_status_details
+
+        sig { params(delivery_status_details: String).void }
+        attr_writer :delivery_status_details
+
+        # The timestamp when the OTP was successfully verified (if applicable)
+        sig { returns(T.nilable(Time)) }
+        attr_reader :verify_date
+
+        sig { params(verify_date: Time).void }
+        attr_writer :verify_date
+
+        # Status information for an SMS OTP sent during Sole Proprietor brand verification
+        sig do
+          params(
+            brand_id: String,
+            delivery_status: String,
+            mobile_phone: String,
+            reference_id: String,
+            request_date: Time,
+            delivery_status_date: Time,
+            delivery_status_details: String,
+            verify_date: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Brand ID associated with this OTP request
+          brand_id:,
+          # The current delivery status of the OTP SMS message. Common values include:
+          # `DELIVERED_HANDSET`, `PENDING`, `FAILED`, `EXPIRED`
+          delivery_status:,
+          # The mobile phone number where the OTP was sent, in E.164 format
+          mobile_phone:,
+          # The reference ID for this OTP request, used for status queries
+          reference_id:,
+          # The timestamp when the OTP request was initiated
+          request_date:,
+          # The timestamp when the delivery status was last updated
+          delivery_status_date: nil,
+          # Additional details about the delivery status
+          delivery_status_details: nil,
+          # The timestamp when the OTP was successfully verified (if applicable)
+          verify_date: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              brand_id: String,
+              delivery_status: String,
+              mobile_phone: String,
+              reference_id: String,
+              request_date: Time,
+              delivery_status_date: Time,
+              delivery_status_details: String,
+              verify_date: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/messaging_10dlc/brand.rbi

@@ -273,6 +273,36 @@ module Telnyx
         def get_feedback(brand_id, request_options: {})
         end
 
+        # Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand
+        # verification.
+        #
+        # This endpoint allows you to check the delivery and verification status of an OTP
+        # sent during the Sole Proprietor brand verification process. You can query by
+        # either:
+        #
+        # - `referenceId` - The reference ID returned when the OTP was initially triggered
+        # - `brandId` - Query parameter for portal users to look up OTP status by Brand ID
+        #
+        # The response includes delivery status, verification dates, and detailed delivery
+        # information.
+        sig do
+          params(
+            reference_id: String,
+            brand_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse
+          )
+        end
+        def get_sms_otp_by_reference(
+          # The reference ID returned when the OTP was initially triggered
+          reference_id,
+          # Filter by Brand ID for easier lookup in portal applications
+          brand_id: nil,
+          request_options: {}
+        )
+        end
+
         # Resend brand 2FA email
         sig do
           params(

data/sig/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rbs

@@ -0,0 +1,27 @@
+module Telnyx
+  module Models
+    module Messaging10dlc
+      type brand_get_sms_otp_by_reference_params =
+        { brand_id: String } & Telnyx::Internal::Type::request_parameters
+
+      class BrandGetSMSOtpByReferenceParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_reader brand_id: String?
+
+        def brand_id=: (String) -> String
+
+        def initialize: (
+          ?brand_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rbs

@@ -0,0 +1,63 @@
+module Telnyx
+  module Models
+    module Messaging10dlc
+      type brand_get_sms_otp_by_reference_response =
+        {
+          brand_id: String,
+          delivery_status: String,
+          mobile_phone: String,
+          reference_id: String,
+          request_date: Time,
+          delivery_status_date: Time,
+          delivery_status_details: String,
+          verify_date: Time
+        }
+
+      class BrandGetSMSOtpByReferenceResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor brand_id: String
+
+        attr_accessor delivery_status: String
+
+        attr_accessor mobile_phone: String
+
+        attr_accessor reference_id: String
+
+        attr_accessor request_date: Time
+
+        attr_reader delivery_status_date: Time?
+
+        def delivery_status_date=: (Time) -> Time
+
+        attr_reader delivery_status_details: String?
+
+        def delivery_status_details=: (String) -> String
+
+        attr_reader verify_date: Time?
+
+        def verify_date=: (Time) -> Time
+
+        def initialize: (
+          brand_id: String,
+          delivery_status: String,
+          mobile_phone: String,
+          reference_id: String,
+          request_date: Time,
+          ?delivery_status_date: Time,
+          ?delivery_status_details: String,
+          ?verify_date: Time
+        ) -> void
+
+        def to_hash: -> {
+          brand_id: String,
+          delivery_status: String,
+          mobile_phone: String,
+          reference_id: String,
+          request_date: Time,
+          delivery_status_date: Time,
+          delivery_status_details: String,
+          verify_date: Time
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/resources/messaging_10dlc/brand.rbs

@@ -90,6 +90,12 @@ module Telnyx
           ?request_options: Telnyx::request_opts
         ) -> Telnyx::Models::Messaging10dlc::BrandGetFeedbackResponse
 
+        def get_sms_otp_by_reference: (
+          String reference_id,
+          ?brand_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> Telnyx::Models::Messaging10dlc::BrandGetSMSOtpByReferenceResponse
+
         def resend_2fa_email: (
           String brand_id,
           ?request_options: Telnyx::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 5.27.0
+  version: 5.28.0
 platform: ruby
 authors:
 - Telnyx
@@ -1095,6 +1095,8 @@ files:
 - lib/telnyx/models/messaging_10dlc/brand_delete_params.rb
 - lib/telnyx/models/messaging_10dlc/brand_get_feedback_params.rb
 - lib/telnyx/models/messaging_10dlc/brand_get_feedback_response.rb
+- lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rb
+- lib/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rb
 - lib/telnyx/models/messaging_10dlc/brand_identity_status.rb
 - lib/telnyx/models/messaging_10dlc/brand_list_params.rb
 - lib/telnyx/models/messaging_10dlc/brand_list_response.rb
@@ -3462,6 +3464,8 @@ files:
 - rbi/telnyx/models/messaging_10dlc/brand_delete_params.rbi
 - rbi/telnyx/models/messaging_10dlc/brand_get_feedback_params.rbi
 - rbi/telnyx/models/messaging_10dlc/brand_get_feedback_response.rbi
+- rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rbi
+- rbi/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rbi
 - rbi/telnyx/models/messaging_10dlc/brand_identity_status.rbi
 - rbi/telnyx/models/messaging_10dlc/brand_list_params.rbi
 - rbi/telnyx/models/messaging_10dlc/brand_list_response.rbi
@@ -5828,6 +5832,8 @@ files:
 - sig/telnyx/models/messaging_10dlc/brand_delete_params.rbs
 - sig/telnyx/models/messaging_10dlc/brand_get_feedback_params.rbs
 - sig/telnyx/models/messaging_10dlc/brand_get_feedback_response.rbs
+- sig/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_params.rbs
+- sig/telnyx/models/messaging_10dlc/brand_get_sms_otp_by_reference_response.rbs
 - sig/telnyx/models/messaging_10dlc/brand_identity_status.rbs
 - sig/telnyx/models/messaging_10dlc/brand_list_params.rbs
 - sig/telnyx/models/messaging_10dlc/brand_list_response.rbs