telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/bot_challenge_create_response.rbi

@@ -0,0 +1,169 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BotChallengeCreateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::BotChallengeCreateResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::Models::BotChallengeCreateResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::BotChallengeCreateResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::BotChallengeCreateResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::BotChallengeCreateResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::BotChallengeCreateResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Type of challenge.
+        sig do
+          returns(
+            Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol
+          )
+        end
+        attr_accessor :challenge_type
+
+        # Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
+        # signup request.
+        sig { returns(String) }
+        attr_accessor :nonce
+
+        # Current privacy-policy URL. Echo this back on the signup request.
+        sig { returns(String) }
+        attr_accessor :privacy_policy_url
+
+        # Problem text to solve. Math problems are obfuscated and end with an unobfuscated
+        # rounding instruction; string and binary problems are returned as-is.
+        sig { returns(String) }
+        attr_accessor :problem
+
+        # Current terms-and-conditions URL. Echo this back on the signup request.
+        sig { returns(String) }
+        attr_accessor :terms_and_conditions_url
+
+        # Decimal places expected in the answer. Present only for math challenges.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :precision
+
+        sig { params(precision: Integer).void }
+        attr_writer :precision
+
+        sig do
+          params(
+            challenge_type:
+              Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::OrSymbol,
+            nonce: String,
+            privacy_policy_url: String,
+            problem: String,
+            terms_and_conditions_url: String,
+            precision: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Type of challenge.
+          challenge_type:,
+          # Single-use challenge identifier. Submit it as `bot_challenge_nonce` on the
+          # signup request.
+          nonce:,
+          # Current privacy-policy URL. Echo this back on the signup request.
+          privacy_policy_url:,
+          # Problem text to solve. Math problems are obfuscated and end with an unobfuscated
+          # rounding instruction; string and binary problems are returned as-is.
+          problem:,
+          # Current terms-and-conditions URL. Echo this back on the signup request.
+          terms_and_conditions_url:,
+          # Decimal places expected in the answer. Present only for math challenges.
+          precision: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              challenge_type:
+                Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol,
+              nonce: String,
+              privacy_policy_url: String,
+              problem: String,
+              terms_and_conditions_url: String,
+              precision: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Type of challenge.
+        module ChallengeType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MATH =
+            T.let(
+              :math,
+              Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol
+            )
+          STRING =
+            T.let(
+              :string,
+              Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol
+            )
+          BINARY =
+            T.let(
+              :binary,
+              Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::BotChallengeCreateResponse::Data::ChallengeType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/bot_session_list_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BotSessionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::BotSessionListParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Email address associated with the magic link token.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # Single-use portal redirect (magic link) token, a UUIDv7 sent to the account
+      # owner's email.
+      sig { returns(String) }
+      attr_accessor :portal_redirect_token
+
+      sig do
+        params(
+          email: String,
+          portal_redirect_token: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address associated with the magic link token.
+        email:,
+        # Single-use portal redirect (magic link) token, a UUIDv7 sent to the account
+        # owner's email.
+        portal_redirect_token:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            email: String,
+            portal_redirect_token: String,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/bot_session_list_response.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BotSessionListResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::BotSessionListResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::Models::BotSessionListResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Telnyx::Models::BotSessionListResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::BotSessionListResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns({ data: Telnyx::Models::BotSessionListResponse::Data })
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::BotSessionListResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # API v2 session token for the signed-in user. Use it as a bearer token on
+        # authenticated endpoints.
+        sig { returns(String) }
+        attr_accessor :api_v2_token
+
+        sig { params(api_v2_token: String).returns(T.attached_class) }
+        def self.new(
+          # API v2 session token for the signed-in user. Use it as a bearer token on
+          # authenticated endpoints.
+          api_v2_token:
+        )
+        end
+
+        sig { override.returns({ api_v2_token: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/bot_signup_create_params.rbi

@@ -0,0 +1,179 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BotSignupCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::BotSignupCreateParams, Telnyx::Internal::AnyHash)
+        end
+
+      # Answer to the issued bot challenge.
+      sig { returns(String) }
+      attr_accessor :bot_challenge_answer
+
+      # Nonce from a previously issued bot challenge.
+      sig { returns(String) }
+      attr_accessor :bot_challenge_nonce
+
+      # Must exactly match the privacy-policy URL returned by the challenge endpoint.
+      sig { returns(String) }
+      attr_accessor :privacy_policy_url
+
+      # Must exactly match the terms-and-conditions URL returned by the challenge
+      # endpoint.
+      sig { returns(String) }
+      attr_accessor :terms_and_conditions_url
+
+      # Must be true to accept the terms of service.
+      sig { returns(Telnyx::BotSignupCreateParams::TermsOfService::OrBoolean) }
+      attr_accessor :terms_of_service
+
+      # Email address for the new account. The magic link is sent here. May only be
+      # omitted when placeholder-email registration is enabled server-side.
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
+      sig { returns(T.nilable(String)) }
+      attr_reader :terms_and_conditions_eu_url
+
+      sig { params(terms_and_conditions_eu_url: String).void }
+      attr_writer :terms_and_conditions_eu_url
+
+      # EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
+      sig do
+        returns(
+          T.nilable(Telnyx::BotSignupCreateParams::TermsOfServiceEu::OrBoolean)
+        )
+      end
+      attr_reader :terms_of_service_eu
+
+      sig do
+        params(
+          terms_of_service_eu:
+            Telnyx::BotSignupCreateParams::TermsOfServiceEu::OrBoolean
+        ).void
+      end
+      attr_writer :terms_of_service_eu
+
+      sig do
+        params(
+          bot_challenge_answer: String,
+          bot_challenge_nonce: String,
+          privacy_policy_url: String,
+          terms_and_conditions_url: String,
+          terms_of_service:
+            Telnyx::BotSignupCreateParams::TermsOfService::OrBoolean,
+          email: String,
+          terms_and_conditions_eu_url: String,
+          terms_of_service_eu:
+            Telnyx::BotSignupCreateParams::TermsOfServiceEu::OrBoolean,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Answer to the issued bot challenge.
+        bot_challenge_answer:,
+        # Nonce from a previously issued bot challenge.
+        bot_challenge_nonce:,
+        # Must exactly match the privacy-policy URL returned by the challenge endpoint.
+        privacy_policy_url:,
+        # Must exactly match the terms-and-conditions URL returned by the challenge
+        # endpoint.
+        terms_and_conditions_url:,
+        # Must be true to accept the terms of service.
+        terms_of_service:,
+        # Email address for the new account. The magic link is sent here. May only be
+        # omitted when placeholder-email registration is enabled server-side.
+        email: nil,
+        # EU terms-and-conditions URL. Required when EU consent enforcement is enabled.
+        terms_and_conditions_eu_url: nil,
+        # EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
+        terms_of_service_eu: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            bot_challenge_answer: String,
+            bot_challenge_nonce: String,
+            privacy_policy_url: String,
+            terms_and_conditions_url: String,
+            terms_of_service:
+              Telnyx::BotSignupCreateParams::TermsOfService::OrBoolean,
+            email: String,
+            terms_and_conditions_eu_url: String,
+            terms_of_service_eu:
+              Telnyx::BotSignupCreateParams::TermsOfServiceEu::OrBoolean,
+            request_options: Telnyx::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Must be true to accept the terms of service.
+      module TermsOfService
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, Telnyx::BotSignupCreateParams::TermsOfService)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            Telnyx::BotSignupCreateParams::TermsOfService::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::BotSignupCreateParams::TermsOfService::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # EU terms-of-service acceptance. Required when EU consent enforcement is enabled.
+      module TermsOfServiceEu
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedBoolean =
+          T.type_alias do
+            T.all(T::Boolean, Telnyx::BotSignupCreateParams::TermsOfServiceEu)
+          end
+        OrBoolean = T.type_alias { T::Boolean }
+
+        TRUE =
+          T.let(
+            true,
+            Telnyx::BotSignupCreateParams::TermsOfServiceEu::TaggedBoolean
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::BotSignupCreateParams::TermsOfServiceEu::TaggedBoolean
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/bot_signup_resend_magic_link_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BotSignupResendMagicLinkParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::BotSignupResendMagicLinkParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Email address of the bot signup account to resend the magic link to.
+      sig { returns(String) }
+      attr_accessor :email
+
+      sig do
+        params(
+          email: String,
+          request_options: Telnyx::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address of the bot signup account to resend the magic link to.
+        email:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { email: String, request_options: Telnyx::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_dial_params.rbi

@@ -202,11 +202,12 @@ module Telnyx
       sig { params(dialogflow_config: Telnyx::DialogflowConfig::OrHash).void }
       attr_writer :dialogflow_config
 
-      # The number the inbound call being transferred was originally received on, in
-      # +E164 format. Supplying it lets an unverified non-Telnyx `from` be used as the
-      # caller id, provided that number is still on an active inbound call to this
-      # `diversion` number for your account. The `diversion` number itself must be one
-      # you own or have verified.
+      # The `to` number of an active inbound call, in +E164 format. Telnyx checks
+      # whether there is currently an active inbound call where `to` matches this
+      # `diversion` value and `from` matches the `from` number supplied for this
+      # request. If such a call exists, the `from` number is treated as verified (since
+      # it is already on an active inbound call to you) and can be used as the caller id
+      # for this outbound call.
       sig { returns(T.nilable(String)) }
       attr_reader :diversion
 
@@ -869,11 +870,12 @@ module Telnyx
         # webhook.
         deepfake_detection: nil,
         dialogflow_config: nil,
-        # The number the inbound call being transferred was originally received on, in
-        # +E164 format. Supplying it lets an unverified non-Telnyx `from` be used as the
-        # caller id, provided that number is still on an active inbound call to this
-        # `diversion` number for your account. The `diversion` number itself must be one
-        # you own or have verified.
+        # The `to` number of an active inbound call, in +E164 format. Telnyx checks
+        # whether there is currently an active inbound call where `to` matches this
+        # `diversion` value and `from` matches the `from` number supplied for this
+        # request. If such a call exists, the `from` number is treated as verified (since
+        # it is already on an active inbound call to you) and can be used as the caller id
+        # for this outbound call.
         diversion: nil,
         # Enables Dialogflow for the current call. The default value is false.
         enable_dialogflow: nil,
@@ -1256,6 +1258,66 @@ module Telnyx
         end
         attr_writer :beep_detection_profile
 
+        # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+        # Only used when beep detection is active.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :beep_max_frequency_hz
+
+        sig { params(beep_max_frequency_hz: Integer).void }
+        attr_writer :beep_max_frequency_hz
+
+        # Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+        # it above 480 excludes North American ringback (440 + 480 Hz), which can
+        # otherwise be reported as a beep when the `freq_only` profile is in use. Only
+        # used when beep detection is active.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :beep_min_frequency_hz
+
+        sig { params(beep_min_frequency_hz: Integer).void }
+        attr_writer :beep_min_frequency_hz
+
+        # Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+        # rejects brief tones such as call-progress blips. Only used when beep detection
+        # is active.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :beep_min_tone_duration_millis
+
+        sig { params(beep_min_tone_duration_millis: Integer).void }
+        attr_writer :beep_min_tone_duration_millis
+
+        # When enabled, a candidate beep must pass an additional spectral check before it
+        # is reported. Only used when beep detection is active.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :beep_spectral_confirmation
+
+        sig { params(beep_spectral_confirmation: T::Boolean).void }
+        attr_writer :beep_spectral_confirmation
+
+        # Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+        # Raising it rejects mixed tones such as ringback, which combines two frequencies.
+        # Only used when beep detection is active.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :beep_spectral_min_purity
+
+        sig { params(beep_spectral_min_purity: Float).void }
+        attr_writer :beep_spectral_min_purity
+
+        # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+        # used when beep detection is active.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :beep_spectral_reject_fax_cng
+
+        sig { params(beep_spectral_reject_fax_cng: T::Boolean).void }
+        attr_writer :beep_spectral_reject_fax_cng
+
+        # Length of the spectral confirmation window, in milliseconds. Only used when beep
+        # detection is active.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :beep_spectral_window_millis
+
+        sig { params(beep_spectral_window_millis: Integer).void }
+        attr_writer :beep_spectral_window_millis
+
         # Maximum threshold for silence between words.
         sig { returns(T.nilable(Integer)) }
         attr_reader :between_words_silence_millis
@@ -1331,6 +1393,13 @@ module Telnyx
             after_greeting_silence_millis: Integer,
             beep_detection_profile:
               Telnyx::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile::OrSymbol,
+            beep_max_frequency_hz: Integer,
+            beep_min_frequency_hz: Integer,
+            beep_min_tone_duration_millis: Integer,
+            beep_spectral_confirmation: T::Boolean,
+            beep_spectral_min_purity: Float,
+            beep_spectral_reject_fax_cng: T::Boolean,
+            beep_spectral_window_millis: Integer,
             between_words_silence_millis: Integer,
             greeting_duration_millis: Integer,
             greeting_silence_duration_millis: Integer,
@@ -1350,6 +1419,31 @@ module Telnyx
           # frequency detectors to agree. `freq_only` uses the frequency detector alone, for
           # beeps whose volume is too unsteady for the default profile.
           beep_detection_profile: nil,
+          # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+          # Only used when beep detection is active.
+          beep_max_frequency_hz: nil,
+          # Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+          # it above 480 excludes North American ringback (440 + 480 Hz), which can
+          # otherwise be reported as a beep when the `freq_only` profile is in use. Only
+          # used when beep detection is active.
+          beep_min_frequency_hz: nil,
+          # Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+          # rejects brief tones such as call-progress blips. Only used when beep detection
+          # is active.
+          beep_min_tone_duration_millis: nil,
+          # When enabled, a candidate beep must pass an additional spectral check before it
+          # is reported. Only used when beep detection is active.
+          beep_spectral_confirmation: nil,
+          # Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+          # Raising it rejects mixed tones such as ringback, which combines two frequencies.
+          # Only used when beep detection is active.
+          beep_spectral_min_purity: nil,
+          # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+          # used when beep detection is active.
+          beep_spectral_reject_fax_cng: nil,
+          # Length of the spectral confirmation window, in milliseconds. Only used when beep
+          # detection is active.
+          beep_spectral_window_millis: nil,
           # Maximum threshold for silence between words.
           between_words_silence_millis: nil,
           # Maximum threshold of a human greeting. If greeting longer than this value,
@@ -1380,6 +1474,13 @@ module Telnyx
               after_greeting_silence_millis: Integer,
               beep_detection_profile:
                 Telnyx::CallDialParams::AnsweringMachineDetectionConfig::BeepDetectionProfile::OrSymbol,
+              beep_max_frequency_hz: Integer,
+              beep_min_frequency_hz: Integer,
+              beep_min_tone_duration_millis: Integer,
+              beep_spectral_confirmation: T::Boolean,
+              beep_spectral_min_purity: Float,
+              beep_spectral_reject_fax_cng: T::Boolean,
+              beep_spectral_window_millis: Integer,
               between_words_silence_millis: Integer,
               greeting_duration_millis: Integer,
               greeting_silence_duration_millis: Integer,