telnyx 5.74.0 → 5.76.0

data/rbi/telnyx/models/verify_profile.rbi

@@ -177,7 +177,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -208,7 +210,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -326,7 +330,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -360,7 +366,9 @@ module Telnyx
           sms_fallback: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -449,7 +457,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -484,7 +494,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end

data/rbi/telnyx/models/verify_profile_create_params.rbi

@@ -160,7 +160,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -191,7 +193,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -240,7 +244,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -265,7 +271,9 @@ module Telnyx
           default_verification_timeout_secs: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -333,7 +341,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -367,7 +377,9 @@ module Telnyx
           sms_fallback: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -436,7 +448,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -471,7 +485,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -521,7 +537,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -546,7 +564,9 @@ module Telnyx
           default_verification_timeout_secs: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end

data/rbi/telnyx/models/verify_profile_update_params.rbi

@@ -169,7 +169,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -200,7 +202,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -249,7 +253,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -274,7 +280,9 @@ module Telnyx
           default_verification_timeout_secs: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -342,7 +350,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -376,7 +386,9 @@ module Telnyx
           sms_fallback: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -445,7 +457,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -480,7 +494,9 @@ module Telnyx
           messaging_template_id: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end
@@ -530,7 +546,9 @@ module Telnyx
 
         # Enabled country destinations to send verification codes. The elements in the
         # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-        # destinations will be allowed.
+        # destinations will be allowed. **Conditionally required:** this field must be
+        # provided when your organization is configured to require explicit whitelisted
+        # destinations; otherwise it is optional.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :whitelisted_destinations
 
@@ -555,7 +573,9 @@ module Telnyx
           default_verification_timeout_secs: nil,
           # Enabled country destinations to send verification codes. The elements in the
           # list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
-          # destinations will be allowed.
+          # destinations will be allowed. **Conditionally required:** this field must be
+          # provided when your organization is configured to require explicit whitelisted
+          # destinations; otherwise it is optional.
           whitelisted_destinations: nil
         )
         end

data/rbi/telnyx/models.rbi

@@ -199,6 +199,12 @@ module Telnyx
 
   CallCostWebhookEvent = Telnyx::Models::CallCostWebhookEvent
 
+  CallDeepfakeDetectionErrorWebhookEvent =
+    Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent
+
+  CallDeepfakeDetectionResultWebhookEvent =
+    Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent
+
   CallDialParams = Telnyx::Models::CallDialParams
 
   CallDtmfReceived = Telnyx::Models::CallDtmfReceived

data/rbi/telnyx/resources/calls/actions.rbi

@@ -45,6 +45,9 @@ module Telnyx
         # **Expected Webhooks:**
         #
         # - `call.answered`
+        # - `call.deepfake_detection.result` if `deepfake_detection` was enabled
+        # - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
+        #   error occurred
         # - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url`
         #   was set
         #
@@ -58,6 +61,8 @@ module Telnyx
             client_state: String,
             command_id: String,
             custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
+            deepfake_detection:
+              Telnyx::Calls::ActionAnswerParams::DeepfakeDetection::OrHash,
             preferred_codecs:
               Telnyx::Calls::ActionAnswerParams::PreferredCodecs::OrSymbol,
             record: Telnyx::Calls::ActionAnswerParams::Record::OrSymbol,
@@ -120,6 +125,11 @@ module Telnyx
           command_id: nil,
           # Custom headers to be added to the SIP INVITE response.
           custom_headers: nil,
+          # Enables deepfake detection on the call. When enabled, audio from the remote
+          # party is streamed to a detection service that analyzes whether the voice is
+          # AI-generated. Results are delivered via the `call.deepfake_detection.result`
+          # webhook.
+          deepfake_detection: nil,
           # The list of comma-separated codecs in a preferred order for the forked media to
           # be received.
           preferred_codecs: nil,

data/rbi/telnyx/resources/calls.rbi

@@ -22,6 +22,9 @@ module Telnyx
       #   `answering_machine_detection=premium` was requested
       # - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
       #   was requested and a beep was detected
+      # - `call.deepfake_detection.result` if `deepfake_detection` was enabled
+      # - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
+      #   error occurred
       # - `streaming.started`, `streaming.stopped` or `streaming.failed` if `stream_url`
       #   was set
       #
@@ -45,6 +48,7 @@ module Telnyx
           command_id: String,
           conference_config: Telnyx::CallDialParams::ConferenceConfig::OrHash,
           custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
+          deepfake_detection: Telnyx::CallDialParams::DeepfakeDetection::OrHash,
           dialogflow_config: Telnyx::DialogflowConfig::OrHash,
           enable_dialogflow: T::Boolean,
           from_display_name: String,
@@ -163,6 +167,11 @@ module Telnyx
         conference_config: nil,
         # Custom headers to be added to the SIP INVITE.
         custom_headers: nil,
+        # Enables deepfake detection on the call. When enabled, audio from the remote
+        # party is streamed to a detection service that analyzes whether the voice is
+        # AI-generated. Results are delivered via the `call.deepfake_detection.result`
+        # webhook.
+        deepfake_detection: nil,
         dialogflow_config: nil,
         # Enables Dialogflow for the current call. The default value is false.
         enable_dialogflow: nil,

data/rbi/telnyx/resources/webhooks.rbi

@@ -14,6 +14,8 @@ module Telnyx
             Telnyx::CallConversationEndedWebhookEvent,
             Telnyx::CallConversationInsightsGeneratedWebhookEvent,
             Telnyx::CallCostWebhookEvent,
+            Telnyx::CallDeepfakeDetectionErrorWebhookEvent,
+            Telnyx::CallDeepfakeDetectionResultWebhookEvent,
             Telnyx::CallDtmfReceivedWebhookEvent,
             Telnyx::CallEnqueuedWebhookEvent,
             Telnyx::CallForkStartedWebhookEvent,
@@ -91,6 +93,8 @@ module Telnyx
             Telnyx::CallConversationEndedWebhookEvent,
             Telnyx::CallConversationInsightsGeneratedWebhookEvent,
             Telnyx::CallCostWebhookEvent,
+            Telnyx::CallDeepfakeDetectionErrorWebhookEvent,
+            Telnyx::CallDeepfakeDetectionResultWebhookEvent,
             Telnyx::CallDtmfReceivedWebhookEvent,
             Telnyx::CallEnqueuedWebhookEvent,
             Telnyx::CallForkStartedWebhookEvent,

data/sig/telnyx/models/call_deepfake_detection_error_webhook_event.rbs

@@ -0,0 +1,166 @@
+module Telnyx
+  module Models
+    type call_deepfake_detection_error_webhook_event =
+      { data: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data }
+
+    class CallDeepfakeDetectionErrorWebhookEvent < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data?
+
+      def data=: (
+        Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data
+      ) -> Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data
+
+      def initialize: (
+        ?data: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data
+      }
+
+      type data =
+        {
+          id: String,
+          event_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader event_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type?
+
+        def event_type=: (
+          Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type
+        ) -> Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type
+
+        attr_reader occurred_at: Time?
+
+        def occurred_at=: (Time) -> Time
+
+        attr_reader payload: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload?
+
+        def payload=: (
+          Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload
+        ) -> Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload
+
+        attr_reader record_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type?
+
+        def record_type=: (
+          Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type
+        ) -> Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type
+
+        def initialize: (
+          ?id: String,
+          ?event_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type,
+          ?occurred_at: Time,
+          ?payload: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload,
+          ?record_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          event_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type
+        }
+
+        type event_type = :"call.deepfake_detection.error"
+
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_DEEPFAKE_DETECTION_ERROR: :"call.deepfake_detection.error"
+
+          def self?.values: -> ::Array[Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::event_type]
+        end
+
+        type payload =
+          {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            client_state: String?,
+            connection_id: String,
+            error_message: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message
+          }
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          attr_reader call_control_id: String?
+
+          def call_control_id=: (String) -> String
+
+          attr_reader call_leg_id: String?
+
+          def call_leg_id=: (String) -> String
+
+          attr_reader call_session_id: String?
+
+          def call_session_id=: (String) -> String
+
+          attr_accessor client_state: String?
+
+          attr_reader connection_id: String?
+
+          def connection_id=: (String) -> String
+
+          attr_reader error_message: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message?
+
+          def error_message=: (
+            Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message
+          ) -> Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message
+
+          def initialize: (
+            ?call_control_id: String,
+            ?call_leg_id: String,
+            ?call_session_id: String,
+            ?client_state: String?,
+            ?connection_id: String,
+            ?error_message: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message
+          ) -> void
+
+          def to_hash: -> {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            client_state: String?,
+            connection_id: String,
+            error_message: Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message
+          }
+
+          type error_message =
+            :detection_timeout
+            | :rtp_timeout
+            | :dfd_connection_error
+            | :dfd_stream_error
+
+          module ErrorMessage
+            extend Telnyx::Internal::Type::Enum
+
+            DETECTION_TIMEOUT: :detection_timeout
+            RTP_TIMEOUT: :rtp_timeout
+            DFD_CONNECTION_ERROR: :dfd_connection_error
+            DFD_STREAM_ERROR: :dfd_stream_error
+
+            def self?.values: -> ::Array[Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::Payload::error_message]
+          end
+        end
+
+        type record_type = :event
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT: :event
+
+          def self?.values: -> ::Array[Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent::Data::record_type]
+        end
+      end
+    end
+  end
+end