telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/generic_pay_connector_config.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # Configuration for a generic connector. A config update replaces the complete
+    # object, not individual keys. Unknown config keys are discarded. Authentication
+    # credentials must be nonblank strings when required by the selected auth_type.
+    module GenericPayConnectorConfig
+      extend Telnyx::Internal::Type::Union
+
+      variant -> { Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault }
+
+      variant -> { Telnyx::GenericPayConnectorConfig::BearerAuthentication }
+
+      variant -> { Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication }
+
+      class BasicAuthenticationAlsoTheValidationDefault < Telnyx::Internal::Type::BaseModel
+        # @!attribute password
+        #   Basic password.
+        #
+        #   @return [String]
+        required :password, String
+
+        # @!attribute username
+        #   Basic username.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!attribute auth_type
+        #
+        #   @return [Symbol, Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType, nil]
+        optional :auth_type,
+                 enum: -> { Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType }
+
+        # @!attribute endpoint_url
+        #   HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        #   transit.
+        #
+        #   @return [String, nil]
+        optional :endpoint_url, String
+
+        # @!attribute timeout
+        #   Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        #   removed before storage. Not the IVR digit-gather timeout.
+        #
+        #   @return [Integer, nil]
+        optional :timeout, Integer, nil?: true
+
+        request_only do
+          # @!attribute token
+          #   Nonblank string required for bearer authentication. Write-only; omitted from
+          #   responses. Re-send when replacing a bearer-auth config.
+          #
+          #   @return [Object, nil]
+          optional :token, Telnyx::Internal::Type::Unknown
+        end
+
+        # @!method initialize(password:, username:, token: nil, auth_type: nil, endpoint_url: nil, timeout: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault}
+        #   for more details.
+        #
+        #   @param password [String] Basic password.
+        #
+        #   @param username [String] Basic username.
+        #
+        #   @param token [Object] Nonblank string required for bearer authentication. Write-only; omitted from res
+        #
+        #   @param auth_type [Symbol, Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType]
+        #
+        #   @param endpoint_url [String] HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in tr
+        #
+        #   @param timeout [Integer, nil] Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is remo
+
+        # @see Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault#auth_type
+        module AuthType
+          extend Telnyx::Internal::Type::Enum
+
+          BASIC = :basic
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class BearerAuthentication < Telnyx::Internal::Type::BaseModel
+        # @!attribute token
+        #   Processor bearer token.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute auth_type
+        #
+        #   @return [Symbol, :bearer]
+        required :auth_type, const: :bearer
+
+        # @!attribute endpoint_url
+        #   HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        #   transit.
+        #
+        #   @return [String, nil]
+        optional :endpoint_url, String
+
+        # @!attribute timeout
+        #   Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        #   removed before storage. Not the IVR digit-gather timeout.
+        #
+        #   @return [Integer, nil]
+        optional :timeout, Integer, nil?: true
+
+        # @!attribute username
+        #   Nonblank string required for basic authentication. Returned in connector
+        #   responses.
+        #
+        #   @return [Object, nil]
+        optional :username, Telnyx::Internal::Type::Unknown
+
+        request_only do
+          # @!attribute password
+          #   Nonblank string required for basic authentication. Write-only; omitted from
+          #   responses. Re-send when replacing a basic-auth config.
+          #
+          #   @return [Object, nil]
+          optional :password, Telnyx::Internal::Type::Unknown
+        end
+
+        # @!method initialize(token:, endpoint_url: nil, password: nil, timeout: nil, username: nil, auth_type: :bearer)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::GenericPayConnectorConfig::BearerAuthentication} for more
+        #   details.
+        #
+        #   @param token [String] Processor bearer token.
+        #
+        #   @param endpoint_url [String] HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in tr
+        #
+        #   @param password [Object] Nonblank string required for basic authentication. Write-only; omitted from resp
+        #
+        #   @param timeout [Integer, nil] Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is remo
+        #
+        #   @param username [Object] Nonblank string required for basic authentication. Returned in connector respons
+        #
+        #   @param auth_type [Symbol, :bearer]
+      end
+
+      class NoProcessorAuthentication < Telnyx::Internal::Type::BaseModel
+        # @!attribute auth_type
+        #
+        #   @return [Symbol, :none]
+        required :auth_type, const: :none
+
+        # @!attribute endpoint_url
+        #   HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        #   transit.
+        #
+        #   @return [String, nil]
+        optional :endpoint_url, String
+
+        # @!attribute timeout
+        #   Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        #   removed before storage. Not the IVR digit-gather timeout.
+        #
+        #   @return [Integer, nil]
+        optional :timeout, Integer, nil?: true
+
+        # @!attribute username
+        #   Nonblank string required for basic authentication. Returned in connector
+        #   responses.
+        #
+        #   @return [Object, nil]
+        optional :username, Telnyx::Internal::Type::Unknown
+
+        request_only do
+          # @!attribute token
+          #   Nonblank string required for bearer authentication. Write-only; omitted from
+          #   responses. Re-send when replacing a bearer-auth config.
+          #
+          #   @return [Object, nil]
+          optional :token, Telnyx::Internal::Type::Unknown
+
+          # @!attribute password
+          #   Nonblank string required for basic authentication. Write-only; omitted from
+          #   responses. Re-send when replacing a basic-auth config.
+          #
+          #   @return [Object, nil]
+          optional :password, Telnyx::Internal::Type::Unknown
+        end
+
+        # @!method initialize(token: nil, endpoint_url: nil, password: nil, timeout: nil, username: nil, auth_type: :none)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::GenericPayConnectorConfig::NoProcessorAuthentication} for more
+        #   details.
+        #
+        #   @param token [Object] Nonblank string required for bearer authentication. Write-only; omitted from res
+        #
+        #   @param endpoint_url [String] HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in tr
+        #
+        #   @param password [Object] Nonblank string required for basic authentication. Write-only; omitted from resp
+        #
+        #   @param timeout [Integer, nil] Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is remo
+        #
+        #   @param username [Object] Nonblank string required for basic authentication. Returned in connector respons
+        #
+        #   @param auth_type [Symbol, :none]
+      end
+
+      # @!method self.variants
+      #   @return [Array(Telnyx::Models::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault, Telnyx::Models::GenericPayConnectorConfig::BearerAuthentication, Telnyx::Models::GenericPayConnectorConfig::NoProcessorAuthentication)]
+    end
+  end
+end

data/lib/telnyx/models/inbound_fqdn.rb

@@ -106,8 +106,8 @@ module Telnyx
       #   in the same way a phone number is used, from a SIP endpoint. Example: the
       #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
       #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-      #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-      #   subdomain calls.
+      #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+      #   TLS transport.
       #
       #   @return [String, nil]
       optional :sip_subdomain, String, nil?: true

data/lib/telnyx/models/inbound_ip.rb

@@ -108,8 +108,8 @@ module Telnyx
       #   in the same way a phone number is used, from a SIP endpoint. Example: the
       #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
       #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-      #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-      #   subdomain calls.
+      #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+      #   TLS transport.
       #
       #   @return [String, nil]
       optional :sip_subdomain, String

data/lib/telnyx/models/ip_connection.rb

@@ -30,6 +30,18 @@ module Telnyx
       #   @return [String, nil]
       optional :android_push_credential_id, String, nil?: true
 
+      # @!attribute bridge_generate_comfort_noise_on_cn
+      #   Stores the connection preference for generating silent RTP toward the opposite
+      #   call leg when comfort-noise packets (CN, payload type 13) are received during
+      #   hold. Defaults to false and returns the saved value. Only JSON true and false
+      #   are accepted; null and non-boolean values are rejected. This preference is
+      #   independent of default_on_hold_comfort_noise_enabled and does not modify that
+      #   setting. This API provisions the preference; call-processing behavior is
+      #   implemented separately.
+      #
+      #   @return [Boolean, nil]
+      optional :bridge_generate_comfort_noise_on_cn, Telnyx::Internal::Type::Boolean
+
       # @!attribute call_cost_in_webhooks
       #   Specifies if call cost webhooks should be sent for this connection.
       #
@@ -78,8 +90,8 @@ module Telnyx
       optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
 
       # @!attribute encrypted_media
-      #   Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      #   TLS.
+      #   Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      #   transport protocol is TLS.
       #
       #   @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
       optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
@@ -192,7 +204,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :webhook_timeout_secs, Integer, nil?: true
 
-      # @!method initialize(id: nil, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, created_at: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, record_type: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, updated_at: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil)
+      # @!method initialize(id: nil, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, created_at: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, record_type: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, updated_at: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::IPConnection} for more details.
       #
@@ -204,6 +216,8 @@ module Telnyx
       #
       #   @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      #   @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       #   @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       #   @param connection_name [String]
@@ -218,7 +232,7 @@ module Telnyx
       #
       #   @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       #   @param inbound [Telnyx::Models::InboundIP]
       #

data/lib/telnyx/models/ip_connection_create_params.rb

@@ -27,6 +27,18 @@ module Telnyx
       #   @return [String, nil]
       optional :android_push_credential_id, String, nil?: true
 
+      # @!attribute bridge_generate_comfort_noise_on_cn
+      #   Stores the connection preference for generating silent RTP toward the opposite
+      #   call leg when comfort-noise packets (CN, payload type 13) are received during
+      #   hold. Optional; defaults to false when omitted on creation. Only JSON true and
+      #   false are accepted; null and non-boolean values are rejected. This preference is
+      #   independent of default_on_hold_comfort_noise_enabled and does not modify that
+      #   setting. This API provisions the preference; call-processing behavior is
+      #   implemented separately.
+      #
+      #   @return [Boolean, nil]
+      optional :bridge_generate_comfort_noise_on_cn, Telnyx::Internal::Type::Boolean
+
       # @!attribute call_cost_in_webhooks
       #   Specifies if call cost webhooks should be sent for this connection.
       #
@@ -61,8 +73,8 @@ module Telnyx
       optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
 
       # @!attribute encrypted_media
-      #   Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      #   TLS.
+      #   Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      #   transport protocol is TLS.
       #
       #   @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
       optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
@@ -163,7 +175,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :webhook_timeout_secs, Integer, nil?: true
 
-      # @!method initialize(active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @!method initialize(active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::IPConnectionCreateParams} for more details.
       #
@@ -173,6 +185,8 @@ module Telnyx
       #
       #   @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      #   @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       #   @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       #   @param connection_name [String]
@@ -183,7 +197,7 @@ module Telnyx
       #
       #   @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       #   @param inbound [Telnyx::Models::IPConnectionCreateParams::Inbound]
       #
@@ -298,8 +312,8 @@ module Telnyx
         #   in the same way a phone number is used, from a SIP endpoint. Example: the
         #   subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         #   the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        #   alphanumeric value. Please note TLS encrypted calls are not allowed for
-        #   subdomain calls.
+        #   alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        #   TLS transport.
         #
         #   @return [String, nil]
         optional :sip_subdomain, String

data/lib/telnyx/models/ip_connection_update_params.rb

@@ -32,6 +32,18 @@ module Telnyx
       #   @return [String, nil]
       optional :android_push_credential_id, String, nil?: true
 
+      # @!attribute bridge_generate_comfort_noise_on_cn
+      #   Stores the connection preference for generating silent RTP toward the opposite
+      #   call leg when comfort-noise packets (CN, payload type 13) are received during
+      #   hold. Optional; omitting this field preserves the saved value. Only JSON true
+      #   and false are accepted; null and non-boolean values are rejected. This
+      #   preference is independent of default_on_hold_comfort_noise_enabled and does not
+      #   modify that setting. This API provisions the preference; call-processing
+      #   behavior is implemented separately.
+      #
+      #   @return [Boolean, nil]
+      optional :bridge_generate_comfort_noise_on_cn, Telnyx::Internal::Type::Boolean
+
       # @!attribute call_cost_in_webhooks
       #   Specifies if call cost webhooks should be sent for this connection.
       #
@@ -74,8 +86,8 @@ module Telnyx
       optional :encode_contact_header_enabled, Telnyx::Internal::Type::Boolean
 
       # @!attribute encrypted_media
-      #   Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      #   TLS.
+      #   Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      #   transport protocol is TLS.
       #
       #   @return [Symbol, Telnyx::Models::EncryptedMedia, nil]
       optional :encrypted_media, enum: -> { Telnyx::EncryptedMedia }, nil?: true
@@ -176,7 +188,7 @@ module Telnyx
       #   @return [Integer, nil]
       optional :webhook_timeout_secs, Integer, nil?: true
 
-      # @!method initialize(id:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @!method initialize(id:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, bridge_generate_comfort_noise_on_cn: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, rtcp_settings: nil, tags: nil, transport_protocol: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::IPConnectionUpdateParams} for more details.
       #
@@ -188,6 +200,8 @@ module Telnyx
       #
       #   @param android_push_credential_id [String, nil] The uuid of the push credential for Android
       #
+      #   @param bridge_generate_comfort_noise_on_cn [Boolean] Stores the connection preference for generating silent RTP toward the opposite c
+      #
       #   @param call_cost_in_webhooks [Boolean] Specifies if call cost webhooks should be sent for this connection.
       #
       #   @param connection_name [String]
@@ -200,7 +214,7 @@ module Telnyx
       #
       #   @param encode_contact_header_enabled [Boolean] Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scen
       #
-      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TL
+      #   @param encrypted_media [Symbol, Telnyx::Models::EncryptedMedia, nil] Enable use of SRTP for encryption. Can only be set when the SIP signaling transp
       #
       #   @param inbound [Telnyx::Models::InboundIP]
       #

data/lib/telnyx/models/meeting_session.rb

@@ -34,13 +34,17 @@ module Telnyx
       required :assistant_state_changed_at, Time, nil?: true
 
       # @!attribute avatar
-      #   Avatar configuration if an avatar is attached, otherwise null.
+      #   The assistant's avatar, captured from its `avatar_settings` when the session was
+      #   created. For display only; later changes to the assistant do not update it.
       #
       #   @return [Telnyx::Models::MeetingSession::Avatar, nil]
       required :avatar, -> { Telnyx::MeetingSession::Avatar }, nil?: true
 
       # @!attribute avatar_state
-      #   Current state of the avatar connection, or null if no avatar is attached.
+      #   Current state of the avatar, or null if the session has no avatar. `starting`
+      #   until the avatar's video is playing, then `connected`; `degraded` when the
+      #   session has fallen back to voice-only (the `avatar.degraded` event carries the
+      #   reason); `disconnected` when the avatar has ended.
       #
       #   @return [Symbol, Telnyx::Models::MeetingSession::AvatarState, nil]
       required :avatar_state, enum: -> { Telnyx::MeetingSession::AvatarState }, nil?: true
@@ -170,9 +174,9 @@ module Telnyx
       #
       #   @param assistant_state_changed_at [Time, nil] Timestamp of the last assistant state change, or null.
       #
-      #   @param avatar [Telnyx::Models::MeetingSession::Avatar, nil] Avatar configuration if an avatar is attached, otherwise null.
+      #   @param avatar [Telnyx::Models::MeetingSession::Avatar, nil] The assistant's avatar, captured from its `avatar_settings` when the session was
       #
-      #   @param avatar_state [Symbol, Telnyx::Models::MeetingSession::AvatarState, nil] Current state of the avatar connection, or null if no avatar is attached.
+      #   @param avatar_state [Symbol, Telnyx::Models::MeetingSession::AvatarState, nil] Current state of the avatar, or null if the session has no avatar. `starting` un
       #
       #   @param avatar_state_changed_at [Time, nil] Timestamp of the last avatar state change, or null.
       #
@@ -286,21 +290,41 @@ module Telnyx
         #   @return [String]
         required :avatar_id, String
 
+        # @!attribute background_id
+        #   Identifier of the avatar's background.
+        #
+        #   @return [String]
+        required :background_id, String
+
+        # @!attribute model
+        #   Avatar rendering model, for example `foxtrot-1`.
+        #
+        #   @return [String]
+        required :model, String
+
         # @!attribute provider
         #   Avatar provider identifier.
         #
-        #   @return [Symbol, :anam]
-        required :provider, const: :anam
+        #   @return [Symbol, :telnyx]
+        required :provider, const: :telnyx
 
-        # @!method initialize(avatar_id:, provider: :anam)
-        #   Avatar configuration if an avatar is attached, otherwise null.
+        # @!method initialize(avatar_id:, background_id:, model:, provider: :telnyx)
+        #   The assistant's avatar, captured from its `avatar_settings` when the session was
+        #   created. For display only; later changes to the assistant do not update it.
         #
         #   @param avatar_id [String] Identifier of the avatar.
         #
-        #   @param provider [Symbol, :anam] Avatar provider identifier.
+        #   @param background_id [String] Identifier of the avatar's background.
+        #
+        #   @param model [String] Avatar rendering model, for example `foxtrot-1`.
+        #
+        #   @param provider [Symbol, :telnyx] Avatar provider identifier.
       end
 
-      # Current state of the avatar connection, or null if no avatar is attached.
+      # Current state of the avatar, or null if the session has no avatar. `starting`
+      # until the avatar's video is playing, then `connected`; `degraded` when the
+      # session has fallen back to voice-only (the `avatar.degraded` event carries the
+      # reason); `disconnected` when the avatar has ended.
       #
       # @see Telnyx::Models::MeetingSession#avatar_state
       module AvatarState

data/lib/telnyx/models/meeting_session_create_params.rb

@@ -22,12 +22,6 @@ module Telnyx
       #   @return [Telnyx::Models::MeetingSessionCreateParams::Assistant, nil]
       optional :assistant, -> { Telnyx::MeetingSessionCreateParams::Assistant }
 
-      # @!attribute avatar
-      #   Request options for attaching a bring-your-own-key avatar to the session.
-      #
-      #   @return [Telnyx::Models::MeetingSessionCreateParams::Avatar, nil]
-      optional :avatar, -> { Telnyx::MeetingSessionCreateParams::Avatar }
-
       # @!attribute barge_in
       #   When enabled, a human participant `speech_on` event interrupts and stops the
       #   current bot audio; it does not bypass admission or initiate speech. Assistant
@@ -90,6 +84,7 @@ module Telnyx
       #   is attached**: the value is accepted and echoed back on the session, but the
       #   assistant owns the voice and the line is never delivered, with no event
       #   reporting the omission. Use `chat_on_enter` to announce an assistant-backed bot.
+      #   Rejected with 400 `invalid_request` when `assistant.avatar` is `true`.
       #
       #   @return [String, nil]
       optional :speak_on_enter, String
@@ -116,7 +111,7 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String
 
-      # @!method initialize(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, chat_on_enter: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
+      # @!method initialize(meeting_url:, assistant: nil, barge_in: nil, bot_name: nil, camera_image: nil, chat_on_enter: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MeetingSessionCreateParams} for more details.
       #
@@ -124,8 +119,6 @@ module Telnyx
       #
       #   @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Attach a Telnyx AI Assistant to the session. Supply the Assistant's ID; the Meet
       #
-      #   @param avatar [Telnyx::Models::MeetingSessionCreateParams::Avatar] Request options for attaching a bring-your-own-key avatar to the session.
-      #
       #   @param barge_in [Boolean] When enabled, a human participant `speech_on` event interrupts and stops the cur
       #
       #   @param bot_name [String] Display name for the bot in the meeting. Defaults to "Meeting Bot".
@@ -169,6 +162,21 @@ module Telnyx
         #   @return [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate, nil]
         optional :audio_gate, enum: -> { Telnyx::MeetingSessionCreateParams::Assistant::AudioGate }
 
+        # @!attribute avatar
+        #   Beta. Show the avatar configured on the assistant (its `avatar_settings`; see
+        #   [AI Assistant avatars](/docs/inference/ai-assistants/avatars)) as the bot's
+        #   camera, lip-synced to the assistant's own speech. The request carries no avatar
+        #   ID or key: the assistant is read at creation and the request is rejected with
+        #   400 `invalid_request` if it has no Telnyx avatar configured. Supported on Google
+        #   Meet, Zoom, Microsoft Teams and Webex; other platforms return 422
+        #   `unsupported_capability`. REST-only. Not echoed back on `assistant`; the
+        #   session's top-level `avatar` and `avatar_state` fields report it instead. If the
+        #   avatar fails, the session continues voice-only and `avatar_state` becomes
+        #   `degraded`.
+        #
+        #   @return [Boolean, nil]
+        optional :avatar, Telnyx::Internal::Type::Boolean
+
         # @!attribute dynamic_variables
         #   Per-conversation values for the
         #   [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
@@ -194,7 +202,7 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :leave_on_end, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(id:, audio_gate: nil, dynamic_variables: nil, leave_on_end: nil)
+        # @!method initialize(id:, audio_gate: nil, avatar: nil, dynamic_variables: nil, leave_on_end: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::MeetingSessionCreateParams::Assistant} for more details.
         #
@@ -207,6 +215,8 @@ module Telnyx
         #
         #   @param audio_gate [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate] Audio gating strategy for the assistant call leg. `half_duplex` (default) sends
         #
+        #   @param avatar [Boolean] Beta. Show the avatar configured on the assistant (its `avatar_settings`; see [A
+        #
         #   @param dynamic_variables [Hash{Symbol=>String}] Per-conversation values for the [dynamic variables](/docs/inference/ai-assistant
         #
         #   @param leave_on_end [Boolean] Leave the meeting when the Assistant's conversation reaches a terminal state --
@@ -230,41 +240,6 @@ module Telnyx
         end
       end
 
-      class Avatar < Telnyx::Internal::Type::BaseModel
-        # @!attribute avatar_id
-        #   Identifier of the avatar to use.
-        #
-        #   @return [String]
-        required :avatar_id, String
-
-        # @!attribute provider
-        #   Avatar provider identifier. Currently only "anam" is supported.
-        #
-        #   @return [Symbol, :anam]
-        required :provider, const: :anam
-
-        request_only do
-          # @!attribute api_key
-          #   Bring-your-own-key API key for the avatar provider. The key is never stored or
-          #   returned by the API.
-          #
-          #   @return [String]
-          required :api_key, String
-        end
-
-        # @!method initialize(api_key:, avatar_id:, provider: :anam)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::MeetingSessionCreateParams::Avatar} for more details.
-        #
-        #   Request options for attaching a bring-your-own-key avatar to the session.
-        #
-        #   @param api_key [String] Bring-your-own-key API key for the avatar provider. The key is never stored or r
-        #
-        #   @param avatar_id [String] Identifier of the avatar to use.
-        #
-        #   @param provider [Symbol, :anam] Avatar provider identifier. Currently only "anam" is supported.
-      end
-
       # Write-only static camera-tile image for this session, not a native account or
       # participant profile photo. Supply exactly one JPEG source. When effective, the
       # image is used as the bot's static camera/video output; presentation varies by

data/lib/telnyx/models/message_send_group_mms_params.rb

@@ -58,7 +58,12 @@ module Telnyx
       #   @return [String, nil]
       optional :webhook_url, String
 
-      # @!method initialize(from:, to:, media_urls: nil, subject: nil, text: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(from:, to:, media_urls: nil, subject: nil, text: nil, use_profile_webhooks: nil, webhook_failover_url: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::MessageSendGroupMmsParams} for more details.
       #
@@ -78,6 +83,8 @@ module Telnyx
       #
       #   @param webhook_url [String] The URL where webhooks related to this message will be sent.
       #
+      #   @param idempotency_key [String]
+      #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
     end
   end