telnyx 5.167.0 → 5.168.0

data/rbi/telnyx/models/messaging_messaging_profile.rbi

@@ -39,6 +39,19 @@ module Telnyx
       sig { params(enabled: T::Boolean).void }
       attr_writer :enabled
 
+      # Telnyx product features the messaging customer can enable on the messaging
+      # profile. Keys map to individual feature flags; unknown keys are accepted and
+      # preserved for forward compatibility with rolling deployments.
+      sig { returns(T.nilable(Telnyx::MessagingProfileFeatures)) }
+      attr_reader :features
+
+      sig do
+        params(
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash)
+        ).void
+      end
+      attr_writer :features
+
       # DEPRECATED: health check url service checking
       sig { returns(T.nilable(String)) }
       attr_accessor :health_webhook_url
@@ -234,6 +247,7 @@ module Telnyx
           daily_spend_limit: String,
           daily_spend_limit_enabled: T::Boolean,
           enabled: T::Boolean,
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
           health_webhook_url: T.nilable(String),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
@@ -274,6 +288,10 @@ module Telnyx
         daily_spend_limit_enabled: nil,
         # Specifies whether the messaging profile is enabled or not.
         enabled: nil,
+        # Telnyx product features the messaging customer can enable on the messaging
+        # profile. Keys map to individual feature flags; unknown keys are accepted and
+        # preserved for forward compatibility with rolling deployments.
+        features: nil,
         # DEPRECATED: health check url service checking
         health_webhook_url: nil,
         # enables SMS fallback for MMS messages.
@@ -348,6 +366,7 @@ module Telnyx
             daily_spend_limit: String,
             daily_spend_limit_enabled: T::Boolean,
             enabled: T::Boolean,
+            features: T.nilable(Telnyx::MessagingProfileFeatures),
             health_webhook_url: T.nilable(String),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,

data/rbi/telnyx/models/messaging_profile_create_params.rbi

@@ -52,6 +52,19 @@ module Telnyx
       sig { params(enabled: T::Boolean).void }
       attr_writer :enabled
 
+      # Telnyx product features the messaging customer can enable on the messaging
+      # profile. Keys map to individual feature flags; unknown keys are accepted and
+      # preserved for forward compatibility with rolling deployments.
+      sig { returns(T.nilable(Telnyx::MessagingProfileFeatures)) }
+      attr_reader :features
+
+      sig do
+        params(
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash)
+        ).void
+      end
+      attr_writer :features
+
       # A URL to receive health check webhooks for numbers in this profile.
       sig { returns(T.nilable(String)) }
       attr_accessor :health_webhook_url
@@ -160,6 +173,7 @@ module Telnyx
           daily_spend_limit: String,
           daily_spend_limit_enabled: T::Boolean,
           enabled: T::Boolean,
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
           health_webhook_url: T.nilable(String),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
@@ -195,6 +209,10 @@ module Telnyx
         daily_spend_limit_enabled: nil,
         # Specifies whether the messaging profile is enabled or not.
         enabled: nil,
+        # Telnyx product features the messaging customer can enable on the messaging
+        # profile. Keys map to individual feature flags; unknown keys are accepted and
+        # preserved for forward compatibility with rolling deployments.
+        features: nil,
         # A URL to receive health check webhooks for numbers in this profile.
         health_webhook_url: nil,
         # enables SMS fallback for MMS messages.
@@ -245,6 +263,7 @@ module Telnyx
             daily_spend_limit: String,
             daily_spend_limit_enabled: T::Boolean,
             enabled: T::Boolean,
+            features: T.nilable(Telnyx::MessagingProfileFeatures),
             health_webhook_url: T.nilable(String),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,

data/rbi/telnyx/models/messaging_profile_features.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class MessagingProfileFeatures < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::MessagingProfileFeatures, Telnyx::Internal::AnyHash)
+        end
+
+      # Enables AI detection of inbound opt-out messages that do not follow the standard
+      # STOP/UNSTOP/HELP opt-out keyword pattern. When enabled, the messaging platform
+      # applies an AI model to identify non-standard opt-out requests (e.g.
+      # natural-language phrases) and treats them as opt-outs.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :ai_opt_out_detection_enabled
+
+      sig { params(ai_opt_out_detection_enabled: T::Boolean).void }
+      attr_writer :ai_opt_out_detection_enabled
+
+      # Telnyx product features the messaging customer can enable on the messaging
+      # profile. Keys map to individual feature flags; unknown keys are accepted and
+      # preserved for forward compatibility with rolling deployments.
+      sig do
+        params(ai_opt_out_detection_enabled: T::Boolean).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Enables AI detection of inbound opt-out messages that do not follow the standard
+        # STOP/UNSTOP/HELP opt-out keyword pattern. When enabled, the messaging platform
+        # applies an AI model to identify non-standard opt-out requests (e.g.
+        # natural-language phrases) and treats them as opt-outs.
+        ai_opt_out_detection_enabled: nil
+      )
+      end
+
+      sig { override.returns({ ai_opt_out_detection_enabled: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/messaging_profile_update_params.rbi

@@ -45,6 +45,19 @@ module Telnyx
       sig { params(enabled: T::Boolean).void }
       attr_writer :enabled
 
+      # Telnyx product features the messaging customer can enable on the messaging
+      # profile. Keys map to individual feature flags; unknown keys are accepted and
+      # preserved for forward compatibility with rolling deployments.
+      sig { returns(T.nilable(Telnyx::MessagingProfileFeatures)) }
+      attr_reader :features
+
+      sig do
+        params(
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash)
+        ).void
+      end
+      attr_writer :features
+
       # enables SMS fallback for MMS messages.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :mms_fall_back_to_sms
@@ -188,6 +201,7 @@ module Telnyx
           daily_spend_limit: String,
           daily_spend_limit_enabled: T::Boolean,
           enabled: T::Boolean,
+          features: T.nilable(Telnyx::MessagingProfileFeatures::OrHash),
           mms_fall_back_to_sms: T::Boolean,
           mms_transcoding: T::Boolean,
           mobile_only: T::Boolean,
@@ -221,6 +235,10 @@ module Telnyx
         daily_spend_limit_enabled: nil,
         # Specifies whether the messaging profile is enabled or not.
         enabled: nil,
+        # Telnyx product features the messaging customer can enable on the messaging
+        # profile. Keys map to individual feature flags; unknown keys are accepted and
+        # preserved for forward compatibility with rolling deployments.
+        features: nil,
         # enables SMS fallback for MMS messages.
         mms_fall_back_to_sms: nil,
         # enables automated resizing of MMS media.
@@ -285,6 +303,7 @@ module Telnyx
             daily_spend_limit: String,
             daily_spend_limit_enabled: T::Boolean,
             enabled: T::Boolean,
+            features: T.nilable(Telnyx::MessagingProfileFeatures),
             mms_fall_back_to_sms: T::Boolean,
             mms_transcoding: T::Boolean,
             mobile_only: T::Boolean,

data/rbi/telnyx/models/uac_connection.rbi

@@ -217,7 +217,10 @@ module Telnyx
       attr_writer :outbound
 
       # The password to be used as part of the credentials. Must be 8 to 128 characters
-      # long.
+      # long. For primary accounts created on or after September 8, 2026, this password
+      # is returned as `********`. The password is returned in full on create, and on
+      # update only when that update changed the password. Accounts created before
+      # September 8, 2026 are unaffected.
       sig { returns(T.nilable(String)) }
       attr_reader :password
 
@@ -440,7 +443,10 @@ module Telnyx
         onnet_t38_passthrough_enabled: nil,
         outbound: nil,
         # The password to be used as part of the credentials. Must be 8 to 128 characters
-        # long.
+        # long. For primary accounts created on or after September 8, 2026, this password
+        # is returned as `********`. The password is returned in full on create, and on
+        # update only when that update changed the password. Accounts created before
+        # September 8, 2026 are unaffected.
         password: nil,
         # Identifies the type of the resource.
         record_type: nil,

data/rbi/telnyx/models/uac_external_settings.rbi

@@ -28,7 +28,11 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :outbound_proxy
 
-      # The SIP password used for digest authentication with the external SIP peer.
+      # The SIP password used for digest authentication with the external SIP peer. For
+      # primary accounts created on or after September 8, 2026, this password is
+      # returned as `********`. The password is returned in full on create, and on
+      # update only when that update changed the password. Accounts created before
+      # September 8, 2026 are unaffected.
       sig { returns(T.nilable(String)) }
       attr_reader :password
 
@@ -93,7 +97,11 @@ module Telnyx
         # An optional SIP proxy used to route outbound requests before reaching the
         # external SIP peer.
         outbound_proxy: nil,
-        # The SIP password used for digest authentication with the external SIP peer.
+        # The SIP password used for digest authentication with the external SIP peer. For
+        # primary accounts created on or after September 8, 2026, this password is
+        # returned as `********`. The password is returned in full on create, and on
+        # update only when that update changed the password. Accounts created before
+        # September 8, 2026 are unaffected.
         password: nil,
         # The SIP proxy address of the external SIP peer used for registrations and
         # outbound call routing.

data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi

@@ -80,7 +80,9 @@ module Telnyx
             Telnyx::ReplacedLinkClickWebhookEvent,
             Telnyx::SessionStatusChangedWebhookEvent,
             Telnyx::TranscriptCompletedWebhookEvent,
-            Telnyx::TranscriptionWebhookEvent
+            Telnyx::TranscriptionWebhookEvent,
+            Telnyx::WhatsappAccountUpdate,
+            Telnyx::WhatsappMessageEcho
           )
         end
 

data/rbi/telnyx/models/unwrap_webhook_event.rbi

@@ -80,7 +80,9 @@ module Telnyx
             Telnyx::ReplacedLinkClickWebhookEvent,
             Telnyx::SessionStatusChangedWebhookEvent,
             Telnyx::TranscriptCompletedWebhookEvent,
-            Telnyx::TranscriptionWebhookEvent
+            Telnyx::TranscriptionWebhookEvent,
+            Telnyx::WhatsappAccountUpdate,
+            Telnyx::WhatsappMessageEcho
           )
         end
 

data/rbi/telnyx/models/whatsapp/business_accounts/phone_number_list_response.rbi

@@ -19,6 +19,17 @@ module Telnyx
           sig { params(calling_enabled: T::Boolean).void }
           attr_writer :calling_enabled
 
+          # Current lifecycle state for a coexistence number. This is null for a standard
+          # Cloud API number.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :coexistence_state
+
           sig { returns(T.nilable(Time)) }
           attr_reader :created_at
 
@@ -37,6 +48,14 @@ module Telnyx
           sig { params(enabled: T::Boolean).void }
           attr_writer :enabled
 
+          # Indicates whether the number is connected to both the WhatsApp Business app and
+          # Cloud API through WhatsApp Coexistence.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_on_biz_app
+
+          sig { params(is_on_biz_app: T::Boolean).void }
+          attr_writer :is_on_biz_app
+
           # Phone number in E164 format
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number
@@ -70,6 +89,32 @@ module Telnyx
           sig { params(status: String).void }
           attr_writer :status
 
+          # Deadline for initiating the current coexistence synchronization cycle. This is
+          # null when no deadline applies.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :sync_deadline
+
+          # Synchronization progress. This object is returned only while a coexistence
+          # number is synchronizing.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress
+              )
+            )
+          end
+          attr_reader :sync_progress
+
+          sig do
+            params(
+              sync_progress:
+                T.nilable(
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress::OrHash
+                )
+            ).void
+          end
+          attr_writer :sync_progress
+
           # User ID
           sig { returns(T.nilable(String)) }
           attr_reader :user_id
@@ -87,23 +132,39 @@ module Telnyx
           sig do
             params(
               calling_enabled: T::Boolean,
+              coexistence_state:
+                T.nilable(
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::OrSymbol
+                ),
               created_at: Time,
               display_name: String,
               enabled: T::Boolean,
+              is_on_biz_app: T::Boolean,
               phone_number: String,
               phone_number_id: String,
               quality_rating: String,
               record_type: String,
               status: String,
+              sync_deadline: T.nilable(Time),
+              sync_progress:
+                T.nilable(
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress::OrHash
+                ),
               user_id: String,
               waba_id: String
             ).returns(T.attached_class)
           end
           def self.new(
             calling_enabled: nil,
+            # Current lifecycle state for a coexistence number. This is null for a standard
+            # Cloud API number.
+            coexistence_state: nil,
             created_at: nil,
             display_name: nil,
             enabled: nil,
+            # Indicates whether the number is connected to both the WhatsApp Business app and
+            # Cloud API through WhatsApp Coexistence.
+            is_on_biz_app: nil,
             # Phone number in E164 format
             phone_number: nil,
             # Whatsapp phone number ID
@@ -112,6 +173,12 @@ module Telnyx
             quality_rating: nil,
             record_type: nil,
             status: nil,
+            # Deadline for initiating the current coexistence synchronization cycle. This is
+            # null when no deadline applies.
+            sync_deadline: nil,
+            # Synchronization progress. This object is returned only while a coexistence
+            # number is synchronizing.
+            sync_progress: nil,
             # User ID
             user_id: nil,
             # WABA ID of Whatsapp business account
@@ -123,14 +190,24 @@ module Telnyx
             override.returns(
               {
                 calling_enabled: T::Boolean,
+                coexistence_state:
+                  T.nilable(
+                    Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+                  ),
                 created_at: Time,
                 display_name: String,
                 enabled: T::Boolean,
+                is_on_biz_app: T::Boolean,
                 phone_number: String,
                 phone_number_id: String,
                 quality_rating: String,
                 record_type: String,
                 status: String,
+                sync_deadline: T.nilable(Time),
+                sync_progress:
+                  T.nilable(
+                    Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress
+                  ),
                 user_id: String,
                 waba_id: String
               }
@@ -138,6 +215,142 @@ module Telnyx
           end
           def to_hash
           end
+
+          # Current lifecycle state for a coexistence number. This is null for a standard
+          # Cloud API number.
+          module CoexistenceState
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PENDING_ONBOARDING =
+              T.let(
+                :pending_onboarding,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            SYNC_PENDING =
+              T.let(
+                :sync_pending,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            SYNCING =
+              T.let(
+                :syncing,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            SYNC_COMPLETE =
+              T.let(
+                :sync_complete,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            ACTIVE =
+              T.let(
+                :active,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            HISTORY_DECLINED =
+              T.let(
+                :history_declined,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            SYNC_DEADLINE_EXPIRED =
+              T.let(
+                :sync_deadline_expired,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            OFFBOARDED =
+              T.let(
+                :offboarded,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+            DISCONNECTED =
+              T.let(
+                :disconnected,
+                Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::CoexistenceState::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class SyncProgress < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Whatsapp::BusinessAccounts::PhoneNumberListResponse::SyncProgress,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :contacts_status
+
+            sig { params(contacts_status: String).void }
+            attr_writer :contacts_status
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :history_chunk_order
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :history_phase
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :history_progress
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :history_status
+
+            sig { params(history_status: String).void }
+            attr_writer :history_status
+
+            # Synchronization progress. This object is returned only while a coexistence
+            # number is synchronizing.
+            sig do
+              params(
+                contacts_status: String,
+                history_chunk_order: T.nilable(Integer),
+                history_phase: T.nilable(Integer),
+                history_progress: T.nilable(Integer),
+                history_status: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              contacts_status: nil,
+              history_chunk_order: nil,
+              history_phase: nil,
+              history_progress: nil,
+              history_status: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  contacts_status: String,
+                  history_chunk_order: T.nilable(Integer),
+                  history_phase: T.nilable(Integer),
+                  history_progress: T.nilable(Integer),
+                  history_status: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end