telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/models/ai/memory/namespaces/profile_preview_response.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfilePreviewResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data
+              )
+            end
+            attr_reader :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data::OrHash
+              ).void
+            end
+            attr_writer :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # The summary this profile would carry under the candidate note. Null when nothing
+              # was generated -- the same signal `GET /summary` uses for a profile with no card
+              # yet.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :text
+
+              sig do
+                params(profile_id: String, text: T.nilable(String)).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                profile_id:,
+                # The summary this profile would carry under the candidate note. Null when nothing
+                # was generated -- the same signal `GET /summary` uses for a profile with no card
+                # yet.
+                text:
+              )
+              end
+
+              sig do
+                override.returns(
+                  { profile_id: String, text: T.nilable(String) }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/pay_tool_params.rbi

@@ -14,6 +14,15 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :connector_name
 
+        # Custom key/value parameters forwarded to the pay connector as `parameters` in
+        # the processor request. String values may use `{{dynamic_variable}}` templating,
+        # resolved per call.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :connector_parameters
+
+        sig { params(connector_parameters: T::Hash[Symbol, T.anything]).void }
+        attr_writer :connector_parameters
+
         # Default currency for payments processed by this tool.
         sig { returns(T.nilable(String)) }
         attr_reader :currency
@@ -21,7 +30,9 @@ module Telnyx
         sig { params(currency: String).void }
         attr_writer :currency
 
-        # Optional description of the pay tool that will be passed to the assistant.
+        # Description of the pay tool shown to the assistant so it knows when to call the
+        # tool. Not sent to the payment connector — the per-call `description` argument
+        # the assistant passes is what reaches the processor.
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
@@ -32,24 +43,57 @@ module Telnyx
         sig { params(payment_method: String).void }
         attr_writer :payment_method
 
+        # Restricts accepted card numbers to the listed card types. When the caller enters
+        # a card number that does not match one of the listed types, Pay treats the input
+        # as invalid and re-prompts for the card number.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
+            )
+          )
+        end
+        attr_reader :valid_card_types
+
+        sig do
+          params(
+            valid_card_types:
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
+          ).void
+        end
+        attr_writer :valid_card_types
+
         sig do
           params(
             connector_name: String,
+            connector_parameters: T::Hash[Symbol, T.anything],
             currency: String,
             description: T.nilable(String),
-            payment_method: String
+            payment_method: String,
+            valid_card_types:
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
           ).returns(T.attached_class)
         end
         def self.new(
           # The name of the pay connector configured in the Telnyx API. Must reference an
           # existing pay connector for this organization.
           connector_name:,
+          # Custom key/value parameters forwarded to the pay connector as `parameters` in
+          # the processor request. String values may use `{{dynamic_variable}}` templating,
+          # resolved per call.
+          connector_parameters: nil,
           # Default currency for payments processed by this tool.
           currency: nil,
-          # Optional description of the pay tool that will be passed to the assistant.
+          # Description of the pay tool shown to the assistant so it knows when to call the
+          # tool. Not sent to the payment connector — the per-call `description` argument
+          # the assistant passes is what reaches the processor.
           description: nil,
           # Default payment method for payments processed by this tool.
-          payment_method: nil
+          payment_method: nil,
+          # Restricts accepted card numbers to the listed card types. When the caller enters
+          # a card number that does not match one of the listed types, Pay treats the input
+          # as invalid and re-prompts for the card number.
+          valid_card_types: nil
         )
         end
 
@@ -57,14 +101,72 @@ module Telnyx
           override.returns(
             {
               connector_name: String,
+              connector_parameters: T::Hash[Symbol, T.anything],
               currency: String,
               description: T.nilable(String),
-              payment_method: String
+              payment_method: String,
+              valid_card_types:
+                T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
             }
           )
         end
         def to_hash
         end
+
+        module ValidCardType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::PayToolParams::ValidCardType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VISA =
+            T.let(:visa, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          MASTERCARD =
+            T.let(
+              :mastercard,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          AMEX =
+            T.let(:amex, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          MAESTRO =
+            T.let(
+              :maestro,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          DISCOVER =
+            T.let(
+              :discover,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          OPTIMA =
+            T.let(
+              :optima,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          JCB =
+            T.let(:jcb, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          DINERS_CLUB =
+            T.let(
+              :"diners-club",
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          ENROUTE =
+            T.let(
+              :enroute,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/ai/privacy_settings.rbi

@@ -39,10 +39,49 @@ module Telnyx
         sig { params(in_transit_data_locality: T::Boolean).void }
         attr_writer :in_transit_data_locality
 
+        # Controls redaction of personally identifiable information (PII) from the
+        # conversation history that is stored for this assistant. `disabled` (default)
+        # stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+        # placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+        # written: message content (user, assistant, and tool-result messages) and
+        # tool-call arguments are redacted when written to conversation history, so the
+        # stored transcript, its read-back via the history API, and any insights generated
+        # from the stored messages contain the placeholders instead of the PII; response
+        # bodies returned by webhook tools are redacted too, as stored in the webhook logs
+        # — a per-conversation record separate from the transcript. In the Mission Control
+        # Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+        # corresponds to `redact`. Redaction runs when the stored copy is written, after
+        # the LLM has generated its reply: the live conversation is not redacted, the
+        # assistant's tools keep receiving the full (unredacted) values during the call,
+        # and the LLM still sees full content in its context window. Call recordings
+        # (including any recording layout configured under telephony settings) and the
+        # payloads of messages/webhooks delivered during the call are never redacted by
+        # this setting. The set of detected PII types (names, street addresses, phone
+        # numbers, email addresses, government identifiers like SSN and driver's license
+        # numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+        # other identifiers unique to a person) is fixed by Telnyx and cannot be
+        # configured or extended per assistant. Assistants with `redact` cannot be used
+        # for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+        # voice and web chat are unaffected.
+        sig do
+          returns(
+            T.nilable(Telnyx::AI::PrivacySettings::PiiRedaction::OrSymbol)
+          )
+        end
+        attr_reader :pii_redaction
+
+        sig do
+          params(
+            pii_redaction: Telnyx::AI::PrivacySettings::PiiRedaction::OrSymbol
+          ).void
+        end
+        attr_writer :pii_redaction
+
         sig do
           params(
             data_retention: T::Boolean,
-            in_transit_data_locality: T::Boolean
+            in_transit_data_locality: T::Boolean,
+            pii_redaction: Telnyx::AI::PrivacySettings::PiiRedaction::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
@@ -65,17 +104,99 @@ module Telnyx
           # request entering the platform in another region is rejected rather than
           # forwarded, because forwarding it would already have moved the content across the
           # border. Defaults to false.
-          in_transit_data_locality: nil
+          in_transit_data_locality: nil,
+          # Controls redaction of personally identifiable information (PII) from the
+          # conversation history that is stored for this assistant. `disabled` (default)
+          # stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+          # placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+          # written: message content (user, assistant, and tool-result messages) and
+          # tool-call arguments are redacted when written to conversation history, so the
+          # stored transcript, its read-back via the history API, and any insights generated
+          # from the stored messages contain the placeholders instead of the PII; response
+          # bodies returned by webhook tools are redacted too, as stored in the webhook logs
+          # — a per-conversation record separate from the transcript. In the Mission Control
+          # Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+          # corresponds to `redact`. Redaction runs when the stored copy is written, after
+          # the LLM has generated its reply: the live conversation is not redacted, the
+          # assistant's tools keep receiving the full (unredacted) values during the call,
+          # and the LLM still sees full content in its context window. Call recordings
+          # (including any recording layout configured under telephony settings) and the
+          # payloads of messages/webhooks delivered during the call are never redacted by
+          # this setting. The set of detected PII types (names, street addresses, phone
+          # numbers, email addresses, government identifiers like SSN and driver's license
+          # numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+          # other identifiers unique to a person) is fixed by Telnyx and cannot be
+          # configured or extended per assistant. Assistants with `redact` cannot be used
+          # for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+          # voice and web chat are unaffected.
+          pii_redaction: nil
         )
         end
 
         sig do
           override.returns(
-            { data_retention: T::Boolean, in_transit_data_locality: T::Boolean }
+            {
+              data_retention: T::Boolean,
+              in_transit_data_locality: T::Boolean,
+              pii_redaction: Telnyx::AI::PrivacySettings::PiiRedaction::OrSymbol
+            }
           )
         end
         def to_hash
         end
+
+        # Controls redaction of personally identifiable information (PII) from the
+        # conversation history that is stored for this assistant. `disabled` (default)
+        # stores content as-is. `redact` replaces detected PII with `<PII:type/>`
+        # placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
+        # written: message content (user, assistant, and tool-result messages) and
+        # tool-call arguments are redacted when written to conversation history, so the
+        # stored transcript, its read-back via the history API, and any insights generated
+        # from the stored messages contain the placeholders instead of the PII; response
+        # bodies returned by webhook tools are redacted too, as stored in the webhook logs
+        # — a per-conversation record separate from the transcript. In the Mission Control
+        # Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
+        # corresponds to `redact`. Redaction runs when the stored copy is written, after
+        # the LLM has generated its reply: the live conversation is not redacted, the
+        # assistant's tools keep receiving the full (unredacted) values during the call,
+        # and the LLM still sees full content in its context window. Call recordings
+        # (including any recording layout configured under telephony settings) and the
+        # payloads of messages/webhooks delivered during the call are never redacted by
+        # this setting. The set of detected PII types (names, street addresses, phone
+        # numbers, email addresses, government identifiers like SSN and driver's license
+        # numbers, credit card and bank account numbers, IP addresses, dates of birth, and
+        # other identifiers unique to a person) is fixed by Telnyx and cannot be
+        # configured or extended per assistant. Assistants with `redact` cannot be used
+        # for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
+        # voice and web chat are unaffected.
+        module PiiRedaction
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::PrivacySettings::PiiRedaction)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          DISABLED =
+            T.let(
+              :disabled,
+              Telnyx::AI::PrivacySettings::PiiRedaction::TaggedSymbol
+            )
+          REDACT =
+            T.let(
+              :redact,
+              Telnyx::AI::PrivacySettings::PiiRedaction::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::PrivacySettings::PiiRedaction::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/ai/telephony_settings.rbi

@@ -9,6 +9,18 @@ module Telnyx
             T.any(Telnyx::AI::TelephonySettings, Telnyx::Internal::AnyHash)
           end
 
+        # When enabled, the `messages` array of the `call.conversation.ended` webhook
+        # contains the full conversation history in order: user and assistant turns,
+        # assistant tool calls (`tool_calls`), tool results (`role: tool` with
+        # `tool_call_id`), and informational `system` and `developer` entries. The
+        # assistant's instructions are never included. When disabled, `messages` contains
+        # only user and assistant text turns.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :conversation_ended_full_history
+
+        sig { params(conversation_ended_full_history: T::Boolean).void }
+        attr_writer :conversation_ended_full_history
+
         # Default Texml App used for voice calls with your assistant. This will be created
         # automatically on assistant creation.
         sig { returns(T.nilable(String)) }
@@ -114,9 +126,16 @@ module Telnyx
         attr_writer :supports_unauthenticated_web_calls
 
         # Maximum duration in seconds for the AI assistant to participate on the call.
-        # When this limit is reached the assistant will be stopped. This limit does not
-        # apply to portions of a call without an active assistant (for instance, a call
-        # transferred to a human representative).
+        # When this limit is reached the assistant will be stopped. Stopping the assistant
+        # does not itself hang up the call, and what happens next depends on how the
+        # assistant is running. On Call Control (ai_assistant_start) the call leg stays
+        # connected and continues to be billed until it is hung up (for example with the
+        # Hangup call command) or until the call ends for another reason. On TeXML, the
+        # assistant's `<Connect><AIAssistant>` instruction ends; in the default TeXML
+        # setup for assistants no instructions follow it, so the call is hung up. Your
+        # application receives a call.conversation.ended webhook when the assistant stops.
+        # This limit does not apply to portions of a call without an active assistant (for
+        # instance, a call transferred to a human representative).
         sig { returns(T.nilable(Integer)) }
         attr_reader :time_limit_secs
 
@@ -133,9 +152,16 @@ module Telnyx
         attr_writer :user_idle_reply_secs
 
         # Maximum duration in seconds of end user silence on the call. When this limit is
-        # reached the assistant will be stopped. This limit does not apply to portions of
-        # a call without an active assistant (for instance, a call transferred to a human
-        # representative).
+        # reached the assistant will be stopped. Stopping the assistant does not itself
+        # hang up the call, and what happens next depends on how the assistant is running.
+        # On Call Control (ai_assistant_start) the call leg stays connected and continues
+        # to be billed until it is hung up (for example with the Hangup call command) or
+        # until the call ends for another reason. On TeXML, the assistant's
+        # `<Connect><AIAssistant>` instruction ends; in the default TeXML setup for
+        # assistants no instructions follow it, so the call is hung up. Your application
+        # receives a call.conversation.ended webhook when the assistant stops. This limit
+        # does not apply to portions of a call without an active assistant (for instance,
+        # a call transferred to a human representative).
         sig { returns(T.nilable(Integer)) }
         attr_reader :user_idle_timeout_secs
 
@@ -163,6 +189,7 @@ module Telnyx
 
         sig do
           params(
+            conversation_ended_full_history: T::Boolean,
             default_texml_app_id: String,
             disable_dtmf: T::Boolean,
             fallback_destination: String,
@@ -182,6 +209,13 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # When enabled, the `messages` array of the `call.conversation.ended` webhook
+          # contains the full conversation history in order: user and assistant turns,
+          # assistant tool calls (`tool_calls`), tool results (`role: tool` with
+          # `tool_call_id`), and informational `system` and `developer` entries. The
+          # assistant's instructions are never included. When disabled, `messages` contains
+          # only user and assistant text turns.
+          conversation_ended_full_history: nil,
           # Default Texml App used for voice calls with your assistant. This will be created
           # automatically on assistant creation.
           default_texml_app_id: nil,
@@ -222,18 +256,32 @@ module Telnyx
           # work with assistants that have telephony enabled.
           supports_unauthenticated_web_calls: nil,
           # Maximum duration in seconds for the AI assistant to participate on the call.
-          # When this limit is reached the assistant will be stopped. This limit does not
-          # apply to portions of a call without an active assistant (for instance, a call
-          # transferred to a human representative).
+          # When this limit is reached the assistant will be stopped. Stopping the assistant
+          # does not itself hang up the call, and what happens next depends on how the
+          # assistant is running. On Call Control (ai_assistant_start) the call leg stays
+          # connected and continues to be billed until it is hung up (for example with the
+          # Hangup call command) or until the call ends for another reason. On TeXML, the
+          # assistant's `<Connect><AIAssistant>` instruction ends; in the default TeXML
+          # setup for assistants no instructions follow it, so the call is hung up. Your
+          # application receives a call.conversation.ended webhook when the assistant stops.
+          # This limit does not apply to portions of a call without an active assistant (for
+          # instance, a call transferred to a human representative).
           time_limit_secs: nil,
           # Duration in seconds of end user silence before the assistant checks in on the
           # user. When this limit is reached the assistant will prompt the user to respond.
           # This is distinct from user_idle_timeout_secs which stops the assistant entirely.
           user_idle_reply_secs: nil,
           # Maximum duration in seconds of end user silence on the call. When this limit is
-          # reached the assistant will be stopped. This limit does not apply to portions of
-          # a call without an active assistant (for instance, a call transferred to a human
-          # representative).
+          # reached the assistant will be stopped. Stopping the assistant does not itself
+          # hang up the call, and what happens next depends on how the assistant is running.
+          # On Call Control (ai_assistant_start) the call leg stays connected and continues
+          # to be billed until it is hung up (for example with the Hangup call command) or
+          # until the call ends for another reason. On TeXML, the assistant's
+          # `<Connect><AIAssistant>` instruction ends; in the default TeXML setup for
+          # assistants no instructions follow it, so the call is hung up. Your application
+          # receives a call.conversation.ended webhook when the assistant stops. This limit
+          # does not apply to portions of a call without an active assistant (for instance,
+          # a call transferred to a human representative).
           user_idle_timeout_secs: nil,
           # Configuration for voicemail detection (AMD - Answering Machine Detection) on
           # outgoing calls. These settings only apply if AMD is enabled on the Dial command.
@@ -248,6 +296,7 @@ module Telnyx
         sig do
           override.returns(
             {
+              conversation_ended_full_history: T::Boolean,
               default_texml_app_id: String,
               disable_dtmf: T::Boolean,
               fallback_destination: String,

data/rbi/telnyx/models/ai/telnyx_avatar_settings.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class TelnyxAvatarSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::TelnyxAvatarSettings, Telnyx::Internal::AnyHash)
+          end
+
+        # The Telnyx stock avatar or organization-owned custom avatar to render.
+        sig { returns(String) }
+        attr_accessor :avatar_id
+
+        # The background to render.
+        sig do
+          returns(Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol)
+        end
+        attr_accessor :background_id
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        sig { returns(Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol) }
+        attr_accessor :model
+
+        # Selects the Telnyx open-source avatar provider.
+        sig { returns(Symbol) }
+        attr_accessor :provider
+
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+        # avatar or an organization-owned custom avatar returned by the Avatars API.
+        # Discover the available stock catalog with GET /v2/ai/avatars and
+        # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+        sig do
+          params(
+            avatar_id: String,
+            background_id:
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::OrSymbol,
+            model: Telnyx::AI::TelnyxAvatarSettings::Model::OrSymbol,
+            provider: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Telnyx stock avatar or organization-owned custom avatar to render.
+          avatar_id:,
+          # The background to render.
+          background_id:,
+          # Required avatar model identifier, separate from `avatar_id`. The supported value
+          # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+          model:,
+          # Selects the Telnyx open-source avatar provider.
+          provider: :telnyx
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              avatar_id: String,
+              background_id:
+                Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol,
+              model: Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol,
+              provider: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The background to render.
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::TelnyxAvatarSettings::BackgroundID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OFFICE =
+            T.let(
+              :office,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+          STUDIO =
+            T.let(
+              :studio,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+          RECEPTION =
+            T.let(
+              :reception,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+          ILLUSTRATED_WORKSPACE =
+            T.let(
+              :illustrated_workspace,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        module Model
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::TelnyxAvatarSettings::Model)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FOXTROT_1 =
+            T.let(
+              :"foxtrot-1",
+              Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end