telnyx 5.26.0 → 5.28.0

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.26.0"
+  VERSION = "5.28.0"
 end

data/lib/telnyx.rb

@@ -62,6 +62,7 @@ require_relative "telnyx/internal/default_pagination_for_messaging_tollfree"
 require_relative "telnyx/internal/default_pagination_for_queues"
 require_relative "telnyx/internal/per_page_pagination"
 require_relative "telnyx/internal/per_page_pagination_v2"
+require_relative "telnyx/models/record"
 require_relative "telnyx/models/advanced_order"
 require_relative "telnyx/models/ai/assistants/canary_deploy"
 require_relative "telnyx/models/ai/assistants/update_assistant"
@@ -89,7 +90,6 @@ require_relative "telnyx/models/sim_card"
 require_relative "telnyx/models/storage/migration_params"
 require_relative "telnyx/models/storage/migration_source_params"
 require_relative "telnyx/models/texml/accounts/update_call"
-require_relative "telnyx/models/network_interface_region"
 require_relative "telnyx/models/wireguard_peer_patch"
 require_relative "telnyx/models/access_ip_address_create_params"
 require_relative "telnyx/models/access_ip_address_delete_params"
@@ -278,11 +278,11 @@ require_relative "telnyx/models/ai/mission_clone_mission_params"
 require_relative "telnyx/models/ai/mission_clone_mission_response"
 require_relative "telnyx/models/ai/mission_create_params"
 require_relative "telnyx/models/ai/mission_create_response"
+require_relative "telnyx/models/ai/mission_data"
 require_relative "telnyx/models/ai/mission_delete_mission_params"
 require_relative "telnyx/models/ai/mission_list_events_params"
 require_relative "telnyx/models/ai/mission_list_events_response"
 require_relative "telnyx/models/ai/mission_list_params"
-require_relative "telnyx/models/ai/mission_list_response"
 require_relative "telnyx/models/ai/mission_retrieve_params"
 require_relative "telnyx/models/ai/mission_retrieve_response"
 require_relative "telnyx/models/ai/missions/knowledge_base_create_knowledge_base_params"
@@ -303,14 +303,13 @@ require_relative "telnyx/models/ai/missions/mcp_server_list_mcp_servers_params"
 require_relative "telnyx/models/ai/missions/mcp_server_list_mcp_servers_response"
 require_relative "telnyx/models/ai/missions/mcp_server_update_mcp_server_params"
 require_relative "telnyx/models/ai/missions/mcp_server_update_mcp_server_response"
+require_relative "telnyx/models/ai/missions/mission_run_data"
 require_relative "telnyx/models/ai/missions/run_cancel_run_params"
 require_relative "telnyx/models/ai/missions/run_cancel_run_response"
 require_relative "telnyx/models/ai/missions/run_create_params"
 require_relative "telnyx/models/ai/missions/run_create_response"
 require_relative "telnyx/models/ai/missions/run_list_params"
-require_relative "telnyx/models/ai/missions/run_list_response"
 require_relative "telnyx/models/ai/missions/run_list_runs_params"
-require_relative "telnyx/models/ai/missions/run_list_runs_response"
 require_relative "telnyx/models/ai/missions/run_pause_run_params"
 require_relative "telnyx/models/ai/missions/run_pause_run_response"
 require_relative "telnyx/models/ai/missions/run_resume_run_params"
@@ -331,6 +330,7 @@ require_relative "telnyx/models/ai/missions/runs/plan_get_step_details_params"
 require_relative "telnyx/models/ai/missions/runs/plan_get_step_details_response"
 require_relative "telnyx/models/ai/missions/runs/plan_retrieve_params"
 require_relative "telnyx/models/ai/missions/runs/plan_retrieve_response"
+require_relative "telnyx/models/ai/missions/runs/plan_step_data"
 require_relative "telnyx/models/ai/missions/runs/plan_update_step_params"
 require_relative "telnyx/models/ai/missions/runs/plan_update_step_response"
 require_relative "telnyx/models/ai/missions/runs/telnyx_agent_link_params"
@@ -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"
@@ -1225,6 +1227,7 @@ require_relative "telnyx/models/messaging_tollfree/verification/volume"
 require_relative "telnyx/models/messaging_url_domain_list_params"
 require_relative "telnyx/models/messaging_url_domain_list_response"
 require_relative "telnyx/models/metadata"
+require_relative "telnyx/models/minimax_voice_settings"
 require_relative "telnyx/models/mobile_network_operator_list_params"
 require_relative "telnyx/models/mobile_network_operator_list_response"
 require_relative "telnyx/models/mobile_phone_number"
@@ -1258,6 +1261,7 @@ require_relative "telnyx/models/network_create_params"
 require_relative "telnyx/models/network_create_response"
 require_relative "telnyx/models/network_delete_params"
 require_relative "telnyx/models/network_delete_response"
+require_relative "telnyx/models/network_interface_region"
 require_relative "telnyx/models/network_list_interfaces_params"
 require_relative "telnyx/models/network_list_interfaces_response"
 require_relative "telnyx/models/network_list_params"

data/rbi/telnyx/models/ai/mission_create_response.rbi

@@ -12,164 +12,23 @@ module Telnyx
             )
           end
 
-        sig { returns(Telnyx::Models::AI::MissionCreateResponse::Data) }
+        sig { returns(Telnyx::AI::MissionData) }
         attr_reader :data
 
-        sig do
-          params(
-            data: Telnyx::Models::AI::MissionCreateResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: Telnyx::AI::MissionData::OrHash).void }
         attr_writer :data
 
         sig do
-          params(
-            data: Telnyx::Models::AI::MissionCreateResponse::Data::OrHash
-          ).returns(T.attached_class)
+          params(data: Telnyx::AI::MissionData::OrHash).returns(
+            T.attached_class
+          )
         end
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: Telnyx::Models::AI::MissionCreateResponse::Data }
-          )
-        end
+        sig { override.returns({ data: Telnyx::AI::MissionData }) }
         def to_hash
         end
-
-        class Data < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::Models::AI::MissionCreateResponse::Data,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig do
-            returns(
-              Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::TaggedSymbol
-            )
-          end
-          attr_accessor :execution_mode
-
-          sig { returns(String) }
-          attr_accessor :mission_id
-
-          sig { returns(String) }
-          attr_accessor :name
-
-          sig { returns(Time) }
-          attr_accessor :updated_at
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :description
-
-          sig { params(description: String).void }
-          attr_writer :description
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :instructions
-
-          sig { params(instructions: String).void }
-          attr_writer :instructions
-
-          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-          attr_reader :metadata
-
-          sig { params(metadata: T::Hash[Symbol, T.anything]).void }
-          attr_writer :metadata
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :model
-
-          sig { params(model: String).void }
-          attr_writer :model
-
-          sig do
-            params(
-              created_at: Time,
-              execution_mode:
-                Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::OrSymbol,
-              mission_id: String,
-              name: String,
-              updated_at: Time,
-              description: String,
-              instructions: String,
-              metadata: T::Hash[Symbol, T.anything],
-              model: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            created_at:,
-            execution_mode:,
-            mission_id:,
-            name:,
-            updated_at:,
-            description: nil,
-            instructions: nil,
-            metadata: nil,
-            model: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                created_at: Time,
-                execution_mode:
-                  Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::TaggedSymbol,
-                mission_id: String,
-                name: String,
-                updated_at: Time,
-                description: String,
-                instructions: String,
-                metadata: T::Hash[Symbol, T.anything],
-                model: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module ExecutionMode
-            extend Telnyx::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            EXTERNAL =
-              T.let(
-                :external,
-                Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::TaggedSymbol
-              )
-            MANAGED =
-              T.let(
-                :managed,
-                Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Telnyx::Models::AI::MissionCreateResponse::Data::ExecutionMode::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
       end
     end
   end

data/rbi/telnyx/models/ai/{mission_list_response.rbi → mission_data.rbi}

@@ -3,23 +3,16 @@
 module Telnyx
   module Models
     module AI
-      class MissionListResponse < Telnyx::Internal::Type::BaseModel
+      class MissionData < Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(
-              Telnyx::Models::AI::MissionListResponse,
-              Telnyx::Internal::AnyHash
-            )
+            T.any(Telnyx::AI::MissionData, Telnyx::Internal::AnyHash)
           end
 
         sig { returns(Time) }
         attr_accessor :created_at
 
-        sig do
-          returns(
-            Telnyx::Models::AI::MissionListResponse::ExecutionMode::TaggedSymbol
-          )
-        end
+        sig { returns(Telnyx::AI::MissionData::ExecutionMode::TaggedSymbol) }
         attr_accessor :execution_mode
 
         sig { returns(String) }
@@ -58,8 +51,7 @@ module Telnyx
         sig do
           params(
             created_at: Time,
-            execution_mode:
-              Telnyx::Models::AI::MissionListResponse::ExecutionMode::OrSymbol,
+            execution_mode: Telnyx::AI::MissionData::ExecutionMode::OrSymbol,
             mission_id: String,
             name: String,
             updated_at: Time,
@@ -87,7 +79,7 @@ module Telnyx
             {
               created_at: Time,
               execution_mode:
-                Telnyx::Models::AI::MissionListResponse::ExecutionMode::TaggedSymbol,
+                Telnyx::AI::MissionData::ExecutionMode::TaggedSymbol,
               mission_id: String,
               name: String,
               updated_at: Time,
@@ -106,29 +98,24 @@ module Telnyx
 
           TaggedSymbol =
             T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::Models::AI::MissionListResponse::ExecutionMode
-              )
+              T.all(Symbol, Telnyx::AI::MissionData::ExecutionMode)
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           EXTERNAL =
             T.let(
               :external,
-              Telnyx::Models::AI::MissionListResponse::ExecutionMode::TaggedSymbol
+              Telnyx::AI::MissionData::ExecutionMode::TaggedSymbol
             )
           MANAGED =
             T.let(
               :managed,
-              Telnyx::Models::AI::MissionListResponse::ExecutionMode::TaggedSymbol
+              Telnyx::AI::MissionData::ExecutionMode::TaggedSymbol
             )
 
           sig do
             override.returns(
-              T::Array[
-                Telnyx::Models::AI::MissionListResponse::ExecutionMode::TaggedSymbol
-              ]
+              T::Array[Telnyx::AI::MissionData::ExecutionMode::TaggedSymbol]
             )
           end
           def self.values

data/rbi/telnyx/models/ai/mission_retrieve_response.rbi

@@ -12,164 +12,23 @@ module Telnyx
             )
           end
 
-        sig { returns(Telnyx::Models::AI::MissionRetrieveResponse::Data) }
+        sig { returns(Telnyx::AI::MissionData) }
         attr_reader :data
 
-        sig do
-          params(
-            data: Telnyx::Models::AI::MissionRetrieveResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: Telnyx::AI::MissionData::OrHash).void }
         attr_writer :data
 
         sig do
-          params(
-            data: Telnyx::Models::AI::MissionRetrieveResponse::Data::OrHash
-          ).returns(T.attached_class)
+          params(data: Telnyx::AI::MissionData::OrHash).returns(
+            T.attached_class
+          )
         end
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: Telnyx::Models::AI::MissionRetrieveResponse::Data }
-          )
-        end
+        sig { override.returns({ data: Telnyx::AI::MissionData }) }
         def to_hash
         end
-
-        class Data < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::Models::AI::MissionRetrieveResponse::Data,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig do
-            returns(
-              Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::TaggedSymbol
-            )
-          end
-          attr_accessor :execution_mode
-
-          sig { returns(String) }
-          attr_accessor :mission_id
-
-          sig { returns(String) }
-          attr_accessor :name
-
-          sig { returns(Time) }
-          attr_accessor :updated_at
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :description
-
-          sig { params(description: String).void }
-          attr_writer :description
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :instructions
-
-          sig { params(instructions: String).void }
-          attr_writer :instructions
-
-          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-          attr_reader :metadata
-
-          sig { params(metadata: T::Hash[Symbol, T.anything]).void }
-          attr_writer :metadata
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :model
-
-          sig { params(model: String).void }
-          attr_writer :model
-
-          sig do
-            params(
-              created_at: Time,
-              execution_mode:
-                Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::OrSymbol,
-              mission_id: String,
-              name: String,
-              updated_at: Time,
-              description: String,
-              instructions: String,
-              metadata: T::Hash[Symbol, T.anything],
-              model: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            created_at:,
-            execution_mode:,
-            mission_id:,
-            name:,
-            updated_at:,
-            description: nil,
-            instructions: nil,
-            metadata: nil,
-            model: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                created_at: Time,
-                execution_mode:
-                  Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::TaggedSymbol,
-                mission_id: String,
-                name: String,
-                updated_at: Time,
-                description: String,
-                instructions: String,
-                metadata: T::Hash[Symbol, T.anything],
-                model: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          module ExecutionMode
-            extend Telnyx::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            EXTERNAL =
-              T.let(
-                :external,
-                Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::TaggedSymbol
-              )
-            MANAGED =
-              T.let(
-                :managed,
-                Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Telnyx::Models::AI::MissionRetrieveResponse::Data::ExecutionMode::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
       end
     end
   end