telnyx 5.166.0 → 5.168.0

data/lib/telnyx/models/messaging_messaging_profile.rb

@@ -0,0 +1,284 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MessagingProfiles#list
+    class MessagingMessagingProfile < Telnyx::Internal::Type::BaseModel
+      # @!attribute ai_assistant_id
+      #   The AI assistant ID associated with this messaging profile.
+      #
+      #   @return [String, nil]
+      optional :ai_assistant_id, String, nil?: true
+
+      # @!attribute alpha_sender
+      #   The alphanumeric sender ID to use when sending to destinations that require an
+      #   alphanumeric sender ID.
+      #
+      #   @return [String, nil]
+      optional :alpha_sender, String, nil?: true
+
+      # @!attribute daily_spend_limit
+      #   The maximum amount of money (in USD) that can be spent by this profile before
+      #   midnight UTC.
+      #
+      #   @return [String, nil]
+      optional :daily_spend_limit, String
+
+      # @!attribute daily_spend_limit_enabled
+      #   Whether to enforce the value configured by `daily_spend_limit`.
+      #
+      #   @return [Boolean, nil]
+      optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute enabled
+      #   Specifies whether the messaging profile is enabled or not.
+      #
+      #   @return [Boolean, nil]
+      optional :enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute features
+      #   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.
+      #
+      #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
+      optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
+
+      # @!attribute health_webhook_url
+      #   DEPRECATED: health check url service checking
+      #
+      #   @return [String, nil]
+      optional :health_webhook_url, String, nil?: true
+
+      # @!attribute mms_fall_back_to_sms
+      #   enables SMS fallback for MMS messages.
+      #
+      #   @return [Boolean, nil]
+      optional :mms_fall_back_to_sms, Telnyx::Internal::Type::Boolean
+
+      # @!attribute mms_transcoding
+      #   enables automated resizing of MMS media.
+      #
+      #   @return [Boolean, nil]
+      optional :mms_transcoding, Telnyx::Internal::Type::Boolean
+
+      # @!attribute mobile_only
+      #   Send messages only to mobile phone numbers.
+      #
+      #   @return [Boolean, nil]
+      optional :mobile_only, Telnyx::Internal::Type::Boolean
+
+      # @!attribute name
+      #   A user friendly name for the messaging profile.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute number_pool_settings
+      #   Number Pool allows you to send messages from a pool of numbers of different
+      #   types, assigning weights to each type. The pool consists of all the long code
+      #   and toll free numbers assigned to the messaging profile.
+      #
+      #   To disable this feature, set the object field to `null`.
+      #
+      #   @return [Telnyx::Models::NumberPoolSettings, nil]
+      optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
+
+      # @!attribute organization_id
+      #   The organization that owns this messaging profile.
+      #
+      #   @return [String, nil]
+      optional :organization_id, String
+
+      # @!attribute redaction_enabled
+      #   Indicates whether message content redaction is enabled for this profile. When
+      #   enabled, message text, MMS media, and the counterparty phone number are redacted
+      #   in message records and reporting. Requires organization activation — contact
+      #   support to enable. The field is only present in responses for organizations with
+      #   redaction access.
+      #
+      #   @return [Boolean, nil]
+      optional :redaction_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute redaction_level
+      #   Determines how much information is redacted for privacy or compliance purposes.
+      #   Level 1: message records and reporting are redacted, but inbound webhook
+      #   payloads are not. Level 2 (default): message records, reporting, and inbound
+      #   webhook payloads are all redacted.
+      #
+      #   @return [Integer, nil]
+      optional :redaction_level, Integer
+
+      # @!attribute resource_group_id
+      #   The resource group ID associated with this messaging profile.
+      #
+      #   @return [String, nil]
+      optional :resource_group_id, String, nil?: true
+
+      # @!attribute smart_encoding
+      #   Enables automatic character encoding optimization for SMS messages. When
+      #   enabled, the system automatically selects the most efficient encoding (GSM-7 or
+      #   UCS-2) based on message content to maximize character limits and minimize costs.
+      #
+      #   @return [Boolean, nil]
+      optional :smart_encoding, Telnyx::Internal::Type::Boolean
+
+      # @!attribute url_shortener_settings
+      #   The URL shortener feature allows automatic replacement of URLs that were
+      #   generated using a public URL shortener service. Some examples include bit.do,
+      #   bit.ly, goo.gl, ht.ly, is.gd, ow.ly, rebrand.ly, t.co, tiny.cc, and tinyurl.com.
+      #   Such URLs are replaced with with links generated by Telnyx. The use of custom
+      #   links can improve branding and message deliverability.
+      #
+      #   To disable this feature, set the object field to `null`.
+      #
+      #   @return [Telnyx::Models::URLShortenerSettings, nil]
+      optional :url_shortener_settings, -> { Telnyx::URLShortenerSettings }, nil?: true
+
+      # @!attribute v1_secret
+      #   Secret used to authenticate with v1 endpoints.
+      #
+      #   @return [String, nil]
+      optional :v1_secret, String
+
+      # @!attribute webhook_api_version
+      #   Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
+      #   2010-04-01 format.
+      #
+      #   @return [Symbol, Telnyx::Models::MessagingMessagingProfile::WebhookAPIVersion, nil]
+      optional :webhook_api_version, enum: -> { Telnyx::MessagingMessagingProfile::WebhookAPIVersion }
+
+      # @!attribute webhook_failover_url
+      #   The failover URL where webhooks related to this messaging profile will be sent
+      #   if sending to the primary URL fails.
+      #
+      #   @return [String, nil]
+      optional :webhook_failover_url, String, nil?: true
+
+      # @!attribute webhook_url
+      #   The URL where webhooks related to this messaging profile will be sent.
+      #
+      #   @return [String, nil]
+      optional :webhook_url, String, nil?: true
+
+      # @!attribute whitelisted_destinations
+      #   Destinations to which the messaging profile is allowed to send. The elements in
+      #   the list must be valid ISO 3166-1 alpha-2 country codes. If set to `["*"]`, all
+      #   destinations will be allowed.
+      #
+      #   @return [Array<String>, nil]
+      optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
+
+      response_only do
+        # @!attribute id
+        #   Identifies the type of resource.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date indicating when the resource was created.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute record_type
+        #   Identifies the type of the resource.
+        #
+        #   @return [Symbol, Telnyx::Models::MessagingMessagingProfile::RecordType, nil]
+        optional :record_type, enum: -> { Telnyx::MessagingMessagingProfile::RecordType }
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date indicating when the resource was updated.
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+      end
+
+      # @!method initialize(id: nil, ai_assistant_id: nil, alpha_sender: nil, created_at: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, organization_id: nil, record_type: nil, redaction_enabled: nil, redaction_level: nil, resource_group_id: nil, smart_encoding: nil, updated_at: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MessagingMessagingProfile} for more details.
+      #
+      #   @param id [String] Identifies the type of resource.
+      #
+      #   @param ai_assistant_id [String, nil] The AI assistant ID associated with this messaging profile.
+      #
+      #   @param alpha_sender [String, nil] The alphanumeric sender ID to use when sending to destinations that require an a
+      #
+      #   @param created_at [Time] ISO 8601 formatted date indicating when the resource was created.
+      #
+      #   @param daily_spend_limit [String] The maximum amount of money (in USD) that can be spent by this profile before mi
+      #
+      #   @param daily_spend_limit_enabled [Boolean] Whether to enforce the value configured by `daily_spend_limit`.
+      #
+      #   @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
+      #
+      #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
+      #
+      #   @param health_webhook_url [String, nil] DEPRECATED: health check url service checking
+      #
+      #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
+      #
+      #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.
+      #
+      #   @param mobile_only [Boolean] Send messages only to mobile phone numbers.
+      #
+      #   @param name [String] A user friendly name for the messaging profile.
+      #
+      #   @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
+      #
+      #   @param organization_id [String] The organization that owns this messaging profile.
+      #
+      #   @param record_type [Symbol, Telnyx::Models::MessagingMessagingProfile::RecordType] Identifies the type of the resource.
+      #
+      #   @param redaction_enabled [Boolean] Indicates whether message content redaction is enabled for this profile. When en
+      #
+      #   @param redaction_level [Integer] Determines how much information is redacted for privacy or compliance purposes.
+      #
+      #   @param resource_group_id [String, nil] The resource group ID associated with this messaging profile.
+      #
+      #   @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
+      #
+      #   @param updated_at [Time] ISO 8601 formatted date indicating when the resource was updated.
+      #
+      #   @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat
+      #
+      #   @param v1_secret [String] Secret used to authenticate with v1 endpoints.
+      #
+      #   @param webhook_api_version [Symbol, Telnyx::Models::MessagingMessagingProfile::WebhookAPIVersion] Determines which webhook format will be used, Telnyx API v1, v2, or a legacy 201
+      #
+      #   @param webhook_failover_url [String, nil] The failover URL where webhooks related to this messaging profile will be sent i
+      #
+      #   @param webhook_url [String, nil] The URL where webhooks related to this messaging profile will be sent.
+      #
+      #   @param whitelisted_destinations [Array<String>] Destinations to which the messaging profile is allowed to send. The elements in
+
+      # Identifies the type of the resource.
+      #
+      # @see Telnyx::Models::MessagingMessagingProfile#record_type
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        MESSAGING_PROFILE = :messaging_profile
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Determines which webhook format will be used, Telnyx API v1, v2, or a legacy
+      # 2010-04-01 format.
+      #
+      # @see Telnyx::Models::MessagingMessagingProfile#webhook_api_version
+      module WebhookAPIVersion
+        extend Telnyx::Internal::Type::Enum
+
+        V1 = :"1"
+        V2 = :"2"
+        V2010_04_01 = :"2010-04-01"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/messaging_profile.rb

@@ -2,7 +2,6 @@
 
 module Telnyx
   module Models
-    # @see Telnyx::Resources::MessagingProfiles#list
     class MessagingProfile < Telnyx::Internal::Type::BaseModel
       # @!attribute ai_assistant_id
       #   The AI assistant ID associated with this messaging profile.

data/lib/telnyx/models/messaging_profile_create_params.rb

@@ -53,6 +53,14 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute features
+      #   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.
+      #
+      #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
+      optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
+
       # @!attribute health_webhook_url
       #   A URL to receive health check webhooks for numbers in this profile.
       #
@@ -133,7 +141,7 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String, nil?: true
 
-      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(name:, whitelisted_destinations:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, health_webhook_url: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, number_pool_settings: nil, resource_group_id: nil, smart_encoding: nil, url_shortener_settings: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileCreateParams} for more details.
       #
@@ -151,6 +159,8 @@ module Telnyx
       #
       #   @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
       #
+      #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
+      #
       #   @param health_webhook_url [String, nil] A URL to receive health check webhooks for numbers in this profile.
       #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.

data/lib/telnyx/models/messaging_profile_create_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class MessagingProfileCreateResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::MessagingProfile, nil]
-      optional :data, -> { Telnyx::MessagingProfile }
+      #   @return [Telnyx::Models::MessagingMessagingProfile, nil]
+      optional :data, -> { Telnyx::MessagingMessagingProfile }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::MessagingProfile]
+      #   @param data [Telnyx::Models::MessagingMessagingProfile]
     end
   end
 end

data/lib/telnyx/models/messaging_profile_delete_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class MessagingProfileDeleteResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::MessagingProfile, nil]
-      optional :data, -> { Telnyx::MessagingProfile }
+      #   @return [Telnyx::Models::MessagingMessagingProfile, nil]
+      optional :data, -> { Telnyx::MessagingMessagingProfile }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::MessagingProfile]
+      #   @param data [Telnyx::Models::MessagingMessagingProfile]
     end
   end
 end

data/lib/telnyx/models/messaging_profile_features.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class MessagingProfileFeatures < Telnyx::Internal::Type::BaseModel
+      # @!attribute ai_opt_out_detection_enabled
+      #   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.
+      #
+      #   @return [Boolean, nil]
+      optional :ai_opt_out_detection_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!method initialize(ai_opt_out_detection_enabled: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MessagingProfileFeatures} for more details.
+      #
+      #   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.
+      #
+      #   @param ai_opt_out_detection_enabled [Boolean] Enables AI detection of inbound opt-out messages that do not follow the standard
+    end
+  end
+end

data/lib/telnyx/models/messaging_profile_retrieve_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class MessagingProfileRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::MessagingProfile, nil]
-      optional :data, -> { Telnyx::MessagingProfile }
+      #   @return [Telnyx::Models::MessagingMessagingProfile, nil]
+      optional :data, -> { Telnyx::MessagingMessagingProfile }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::MessagingProfile]
+      #   @param data [Telnyx::Models::MessagingMessagingProfile]
     end
   end
 end

data/lib/telnyx/models/messaging_profile_update_params.rb

@@ -44,6 +44,14 @@ module Telnyx
       #   @return [Boolean, nil]
       optional :enabled, Telnyx::Internal::Type::Boolean
 
+      # @!attribute features
+      #   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.
+      #
+      #   @return [Telnyx::Models::MessagingProfileFeatures, nil]
+      optional :features, -> { Telnyx::MessagingProfileFeatures }, nil?: true
+
       # @!attribute mms_fall_back_to_sms
       #   enables SMS fallback for MMS messages.
       #
@@ -78,6 +86,23 @@ module Telnyx
       #   @return [Telnyx::Models::NumberPoolSettings, nil]
       optional :number_pool_settings, -> { Telnyx::NumberPoolSettings }, nil?: true
 
+      # @!attribute redaction_enabled
+      #   Set to true to enable message content redaction on this profile, or false to
+      #   disable it. Ignored if the organization is not on the redaction allowlist. See
+      #   the [Message Redaction guide](/docs/messaging/messages/message-redaction) for
+      #   what is redacted.
+      #
+      #   @return [Boolean, nil]
+      optional :redaction_enabled, Telnyx::Internal::Type::Boolean
+
+      # @!attribute redaction_level
+      #   The redaction level to apply when redaction is enabled. 1: redact message
+      #   records and reporting only. 2 (default): also redact inbound webhook payloads.
+      #   See the [Message Redaction guide](/docs/messaging/messages/message-redaction).
+      #
+      #   @return [Integer, nil]
+      optional :redaction_level, Integer
+
       # @!attribute smart_encoding
       #   Enables automatic character encoding optimization for SMS messages. When
       #   enabled, the system automatically selects the most efficient encoding (GSM-7 or
@@ -134,7 +159,7 @@ module Telnyx
       #   @return [Array<String>, nil]
       optional :whitelisted_destinations, Telnyx::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
+      # @!method initialize(messaging_profile_id:, ai_assistant_id: nil, alpha_sender: nil, daily_spend_limit: nil, daily_spend_limit_enabled: nil, enabled: nil, features: nil, mms_fall_back_to_sms: nil, mms_transcoding: nil, mobile_only: nil, name: nil, number_pool_settings: nil, redaction_enabled: nil, redaction_level: nil, smart_encoding: nil, url_shortener_settings: nil, v1_secret: nil, webhook_api_version: nil, webhook_failover_url: nil, webhook_url: nil, whitelisted_destinations: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessagingProfileUpdateParams} for more details.
       #
@@ -150,6 +175,8 @@ module Telnyx
       #
       #   @param enabled [Boolean] Specifies whether the messaging profile is enabled or not.
       #
+      #   @param features [Telnyx::Models::MessagingProfileFeatures, nil] Telnyx product features the messaging customer can enable on the messaging profi
+      #
       #   @param mms_fall_back_to_sms [Boolean] enables SMS fallback for MMS messages.
       #
       #   @param mms_transcoding [Boolean] enables automated resizing of MMS media.
@@ -160,6 +187,10 @@ module Telnyx
       #
       #   @param number_pool_settings [Telnyx::Models::NumberPoolSettings, nil] Number Pool allows you to send messages from a pool of numbers of different type
       #
+      #   @param redaction_enabled [Boolean] Set to true to enable message content redaction on this profile, or false to dis
+      #
+      #   @param redaction_level [Integer] The redaction level to apply when redaction is enabled. 1: redact message record
+      #
       #   @param smart_encoding [Boolean] Enables automatic character encoding optimization for SMS messages. When enabled
       #
       #   @param url_shortener_settings [Telnyx::Models::URLShortenerSettings, nil] The URL shortener feature allows automatic replacement of URLs that were generat

data/lib/telnyx/models/messaging_profile_update_response.rb

@@ -6,11 +6,11 @@ module Telnyx
     class MessagingProfileUpdateResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::MessagingProfile, nil]
-      optional :data, -> { Telnyx::MessagingProfile }
+      #   @return [Telnyx::Models::MessagingMessagingProfile, nil]
+      optional :data, -> { Telnyx::MessagingMessagingProfile }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::MessagingProfile]
+      #   @param data [Telnyx::Models::MessagingMessagingProfile]
     end
   end
 end

data/lib/telnyx/models/messaging_profiles/action_regenerate_secret_response.rb

@@ -7,11 +7,11 @@ module Telnyx
       class ActionRegenerateSecretResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Telnyx::Models::MessagingProfile, nil]
-        optional :data, -> { Telnyx::MessagingProfile }
+        #   @return [Telnyx::Models::MessagingMessagingProfile, nil]
+        optional :data, -> { Telnyx::MessagingMessagingProfile }
 
         # @!method initialize(data: nil)
-        #   @param data [Telnyx::Models::MessagingProfile]
+        #   @param data [Telnyx::Models::MessagingMessagingProfile]
       end
     end
   end

data/lib/telnyx/models/uac_connection.rb

@@ -167,7 +167,10 @@ module Telnyx
 
       # @!attribute password
       #   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.
       #
       #   @return [String, nil]
       optional :password, String

data/lib/telnyx/models/uac_external_settings.rb

@@ -32,7 +32,11 @@ module Telnyx
       optional :outbound_proxy, String, nil?: true
 
       # @!attribute password
-      #   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.
       #
       #   @return [String, nil]
       optional :password, String
@@ -81,7 +85,7 @@ module Telnyx
       #
       #   @param outbound_proxy [String, nil] An optional SIP proxy used to route outbound requests before reaching the extern
       #
-      #   @param password [String] The SIP password used for digest authentication with the external SIP peer.
+      #   @param password [String] The SIP password used for digest authentication with the external SIP peer. For
       #
       #   @param proxy [String] The SIP proxy address of the external SIP peer used for registrations and outbou
       #

data/lib/telnyx/models/unsafe_unwrap_webhook_event.rb

@@ -151,8 +151,12 @@ module Telnyx
 
       variant -> { Telnyx::TranscriptionWebhookEvent }
 
+      variant -> { Telnyx::WhatsappAccountUpdate }
+
+      variant -> { Telnyx::WhatsappMessageEcho }
+
       # @!method self.variants
-      #   @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
+      #   @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho)]
     end
   end
 end

data/lib/telnyx/models/unwrap_webhook_event.rb

@@ -151,8 +151,12 @@ module Telnyx
 
       variant -> { Telnyx::TranscriptionWebhookEvent }
 
+      variant -> { Telnyx::WhatsappAccountUpdate }
+
+      variant -> { Telnyx::WhatsappMessageEcho }
+
       # @!method self.variants
-      #   @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent)]
+      #   @return [Array(Telnyx::Models::CallAIGatherEndedWebhookEvent, Telnyx::Models::CallAIGatherMessageHistoryUpdatedWebhookEvent, Telnyx::Models::CallAIGatherPartialResultsWebhookEvent, Telnyx::Models::ArtifactCompletedWebhookEvent, Telnyx::Models::ArtifactFailedWebhookEvent, Telnyx::Models::CallAnsweredWebhookEvent, Telnyx::Models::CallBridgedWebhookEvent, Telnyx::Models::CallConversationEndedWebhookEvent, Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent, Telnyx::Models::CallCostWebhookEvent, Telnyx::Models::CallDeepfakeDetectionErrorWebhookEvent, Telnyx::Models::CallDeepfakeDetectionResultWebhookEvent, Telnyx::Models::CallDtmfReceivedWebhookEvent, Telnyx::Models::CallEnqueuedWebhookEvent, Telnyx::Models::CallForkStartedWebhookEvent, Telnyx::Models::CallForkStoppedWebhookEvent, Telnyx::Models::CallGatherEndedWebhookEvent, Telnyx::Models::CallHangupWebhookEvent, Telnyx::Models::CallHoldWebhookEvent, Telnyx::Models::CallInitiatedWebhookEvent, Telnyx::Models::CallLeftQueueWebhookEvent, Telnyx::Models::CallMachineDetectionEndedWebhookEvent, Telnyx::Models::CallMachineGreetingEndedWebhookEvent, Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent, Telnyx::Models::CallMachinePremiumGreetingEndedWebhookEvent, Telnyx::Models::CallPaymentCompletedWebhookEvent, Telnyx::Models::CallPaymentProgressWebhookEvent, Telnyx::Models::CallPlaybackEndedWebhookEvent, Telnyx::Models::CallPlaybackStartedWebhookEvent, Telnyx::Models::CallRecordingErrorWebhookEvent, Telnyx::Models::CallRecordingSavedWebhookEvent, Telnyx::Models::CallRecordingTranscriptionSavedWebhookEvent, Telnyx::Models::CallReferCompletedWebhookEvent, Telnyx::Models::CallReferFailedWebhookEvent, Telnyx::Models::CallReferStartedWebhookEvent, Telnyx::Models::CallSiprecFailedWebhookEvent, Telnyx::Models::CallSiprecStartedWebhookEvent, Telnyx::Models::CallSiprecStoppedWebhookEvent, Telnyx::Models::CallSpeakEndedWebhookEvent, Telnyx::Models::CallSpeakStartedWebhookEvent, Telnyx::Models::CallStreamingFailedWebhookEvent, Telnyx::Models::CallStreamingStartedWebhookEvent, Telnyx::Models::CallStreamingStoppedWebhookEvent, Telnyx::Models::CallUnholdWebhookEvent, Telnyx::Models::CampaignStatusUpdate, Telnyx::Models::ConferenceCreatedWebhookEvent, Telnyx::Models::ConferenceEndedWebhookEvent, Telnyx::Models::ConferenceFloorChanged, Telnyx::Models::ConferenceParticipantJoinedWebhookEvent, Telnyx::Models::ConferenceParticipantLeftWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackEndedWebhookEvent, Telnyx::Models::ConferenceParticipantPlaybackStartedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakEndedWebhookEvent, Telnyx::Models::ConferenceParticipantSpeakStartedWebhookEvent, Telnyx::Models::ConferencePlaybackEndedWebhookEvent, Telnyx::Models::ConferencePlaybackStartedWebhookEvent, Telnyx::Models::ConferenceRecordingSavedWebhookEvent, Telnyx::Models::ConferenceSpeakEndedWebhookEvent, Telnyx::Models::ConferenceSpeakStartedWebhookEvent, Telnyx::Models::DeliveryUpdateWebhookEvent, Telnyx::Models::FaxDelivered, Telnyx::Models::FaxFailed, Telnyx::Models::FaxMediaProcessed, Telnyx::Models::FaxQueued, Telnyx::Models::FaxSendingStarted, Telnyx::Models::HostedNumberOrderEventWebhookEvent, Telnyx::Models::InboundMessageWebhookEvent, Telnyx::Models::NumberOrderStatusUpdateWebhookEvent, Telnyx::Models::RecordingAvailableWebhookEvent, Telnyx::Models::ReplacedLinkClickWebhookEvent, Telnyx::Models::SessionStatusChangedWebhookEvent, Telnyx::Models::TranscriptCompletedWebhookEvent, Telnyx::Models::TranscriptionWebhookEvent, Telnyx::Models::WhatsappAccountUpdate, Telnyx::Models::WhatsappMessageEcho)]
     end
   end
 end