telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/models/meeting_session.rbi

@@ -37,7 +37,8 @@ module Telnyx
       sig { returns(T.nilable(Time)) }
       attr_accessor :assistant_state_changed_at
 
-      # 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.
       sig { returns(T.nilable(Telnyx::MeetingSession::Avatar)) }
       attr_reader :avatar
 
@@ -46,7 +47,10 @@ module Telnyx
       end
       attr_writer :avatar
 
-      # 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.
       sig do
         returns(T.nilable(Telnyx::MeetingSession::AvatarState::TaggedSymbol))
       end
@@ -172,9 +176,13 @@ module Telnyx
         assistant_state:,
         # Timestamp of the last assistant state change, or null.
         assistant_state_changed_at:,
-        # 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.
         avatar:,
-        # 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.
         avatar_state:,
         # Timestamp of the last avatar state change, or null.
         avatar_state_changed_at:,
@@ -386,28 +394,58 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :avatar_id
 
+        # Identifier of the avatar's background.
+        sig { returns(String) }
+        attr_accessor :background_id
+
+        # Avatar rendering model, for example `foxtrot-1`.
+        sig { returns(String) }
+        attr_accessor :model
+
         # Avatar provider identifier.
         sig { returns(Symbol) }
         attr_accessor :provider
 
-        # 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.
         sig do
-          params(avatar_id: String, provider: Symbol).returns(T.attached_class)
+          params(
+            avatar_id: String,
+            background_id: String,
+            model: String,
+            provider: Symbol
+          ).returns(T.attached_class)
         end
         def self.new(
           # Identifier of the avatar.
           avatar_id:,
+          # Identifier of the avatar's background.
+          background_id:,
+          # Avatar rendering model, for example `foxtrot-1`.
+          model:,
           # Avatar provider identifier.
-          provider: :anam
+          provider: :telnyx
         )
         end
 
-        sig { override.returns({ avatar_id: String, provider: Symbol }) }
+        sig do
+          override.returns(
+            {
+              avatar_id: String,
+              background_id: String,
+              model: String,
+              provider: Symbol
+            }
+          )
+        end
         def to_hash
         end
       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.
       module AvatarState
         extend Telnyx::Internal::Type::Enum
 

data/rbi/telnyx/models/meeting_session_create_params.rbi

@@ -29,15 +29,6 @@ module Telnyx
       end
       attr_writer :assistant
 
-      # Request options for attaching a bring-your-own-key avatar to the session.
-      sig { returns(T.nilable(Telnyx::MeetingSessionCreateParams::Avatar)) }
-      attr_reader :avatar
-
-      sig do
-        params(avatar: Telnyx::MeetingSessionCreateParams::Avatar::OrHash).void
-      end
-      attr_writer :avatar
-
       # When enabled, a human participant `speech_on` event interrupts and stops the
       # current bot audio; it does not bypass admission or initiate speech. Assistant
       # sessions reject `barge_in: true`.
@@ -123,6 +114,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`.
       sig { returns(T.nilable(String)) }
       attr_reader :speak_on_enter
 
@@ -158,7 +150,6 @@ module Telnyx
         params(
           meeting_url: String,
           assistant: Telnyx::MeetingSessionCreateParams::Assistant::OrHash,
-          avatar: Telnyx::MeetingSessionCreateParams::Avatar::OrHash,
           barge_in: T::Boolean,
           bot_name: String,
           camera_image:
@@ -185,8 +176,6 @@ module Telnyx
         # connection, caller ID and loopback SIP URI previously required here have been
         # removed and are now rejected as unknown fields.
         assistant: nil,
-        # Request options for attaching a bring-your-own-key avatar to the session.
-        avatar: nil,
         # When enabled, a human participant `speech_on` event interrupts and stops the
         # current bot audio; it does not bypass admission or initiate speech. Assistant
         # sessions reject `barge_in: true`.
@@ -220,6 +209,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`.
         speak_on_enter: nil,
         # If true, generate a summary artifact when the session ends.
         summarize_on_end: nil,
@@ -240,7 +230,6 @@ module Telnyx
           {
             meeting_url: String,
             assistant: Telnyx::MeetingSessionCreateParams::Assistant,
-            avatar: Telnyx::MeetingSessionCreateParams::Avatar,
             barge_in: T::Boolean,
             bot_name: String,
             camera_image:
@@ -299,6 +288,22 @@ module Telnyx
         end
         attr_writer :audio_gate
 
+        # 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`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :avatar
+
+        sig { params(avatar: T::Boolean).void }
+        attr_writer :avatar
+
         # Per-conversation values for the
         # [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
         # Assistant's instructions, greeting, or tools. Delivered before the Assistant's
@@ -335,6 +340,7 @@ module Telnyx
             id: String,
             audio_gate:
               Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol,
+            avatar: T::Boolean,
             dynamic_variables: T::Hash[Symbol, String],
             leave_on_end: T::Boolean
           ).returns(T.attached_class)
@@ -349,6 +355,17 @@ module Telnyx
           # removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
           # multiply the per-minute cost by the number of participants.
           audio_gate: nil,
+          # 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`.
+          avatar: nil,
           # Per-conversation values for the
           # [dynamic variables](/docs/inference/ai-assistants/dynamic-variables) used in the
           # Assistant's instructions, greeting, or tools. Delivered before the Assistant's
@@ -375,6 +392,7 @@ module Telnyx
               id: String,
               audio_gate:
                 Telnyx::MeetingSessionCreateParams::Assistant::AudioGate::OrSymbol,
+              avatar: T::Boolean,
               dynamic_variables: T::Hash[Symbol, String],
               leave_on_end: T::Boolean
             }
@@ -424,54 +442,6 @@ module Telnyx
         end
       end
 
-      class Avatar < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::MeetingSessionCreateParams::Avatar,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Identifier of the avatar to use.
-        sig { returns(String) }
-        attr_accessor :avatar_id
-
-        # Avatar provider identifier. Currently only "anam" is supported.
-        sig { returns(Symbol) }
-        attr_accessor :provider
-
-        # Bring-your-own-key API key for the avatar provider. The key is never stored or
-        # returned by the API.
-        sig { returns(String) }
-        attr_accessor :api_key
-
-        # Request options for attaching a bring-your-own-key avatar to the session.
-        sig do
-          params(api_key: String, avatar_id: String, provider: Symbol).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Bring-your-own-key API key for the avatar provider. The key is never stored or
-          # returned by the API.
-          api_key:,
-          # Identifier of the avatar to use.
-          avatar_id:,
-          # Avatar provider identifier. Currently only "anam" is supported.
-          provider: :anam
-        )
-        end
-
-        sig do
-          override.returns(
-            { api_key: String, avatar_id: String, provider: Symbol }
-          )
-        end
-        def to_hash
-        end
-      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/rbi/telnyx/models/message_send_group_mms_params.rbi

@@ -64,6 +64,12 @@ module Telnyx
       sig { params(webhook_url: String).void }
       attr_writer :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           from: String,
@@ -74,6 +80,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: String,
           webhook_url: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -97,6 +104,7 @@ module Telnyx
         webhook_failover_url: nil,
         # The URL where webhooks related to this message will be sent.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -112,6 +120,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: String,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/message_send_long_code_params.rbi

@@ -106,6 +106,12 @@ module Telnyx
       sig { params(webhook_url: String).void }
       attr_writer :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           from: String,
@@ -119,6 +125,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: String,
           webhook_url: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -157,6 +164,7 @@ module Telnyx
         webhook_failover_url: nil,
         # The URL where webhooks related to this message will be sent.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -175,6 +183,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: String,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/message_send_number_pool_params.rbi

@@ -106,6 +106,12 @@ module Telnyx
       sig { params(webhook_url: String).void }
       attr_writer :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           messaging_profile_id: String,
@@ -119,6 +125,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: String,
           webhook_url: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -157,6 +164,7 @@ module Telnyx
         webhook_failover_url: nil,
         # The URL where webhooks related to this message will be sent.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -175,6 +183,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: String,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/message_send_params.rbi

@@ -117,6 +117,12 @@ module Telnyx
       sig { params(webhook_url: String).void }
       attr_writer :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           to: String,
@@ -132,6 +138,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: String,
           webhook_url: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -181,6 +188,7 @@ module Telnyx
         webhook_failover_url: nil,
         # The URL where webhooks related to this message will be sent.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -201,6 +209,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: String,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/message_send_short_code_params.rbi

@@ -106,6 +106,12 @@ module Telnyx
       sig { params(webhook_url: String).void }
       attr_writer :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           from: String,
@@ -119,6 +125,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: String,
           webhook_url: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -157,6 +164,7 @@ module Telnyx
         webhook_failover_url: nil,
         # The URL where webhooks related to this message will be sent.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -175,6 +183,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: String,
             webhook_url: String,
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )

data/rbi/telnyx/models/message_send_with_alphanumeric_sender_params.rbi

@@ -45,6 +45,12 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :webhook_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           from: String,
@@ -54,6 +60,7 @@ module Telnyx
           use_profile_webhooks: T::Boolean,
           webhook_failover_url: T.nilable(String),
           webhook_url: T.nilable(String),
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -72,6 +79,7 @@ module Telnyx
         webhook_failover_url: nil,
         # Callback URL for delivery status updates.
         webhook_url: nil,
+        idempotency_key: nil,
         request_options: {}
       )
       end
@@ -86,6 +94,7 @@ module Telnyx
             use_profile_webhooks: T::Boolean,
             webhook_failover_url: T.nilable(String),
             webhook_url: T.nilable(String),
+            idempotency_key: String,
             request_options: Telnyx::RequestOptions
           }
         )