telnyx 5.171.0 → 5.174.0

data/rbi/telnyx/models/ai/avatar.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias { T.any(Telnyx::AI::Avatar, Telnyx::Internal::AnyHash) }
+
+        # Stable identifier returned by the Avatars API. Discover available stock IDs with
+        # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        # authenticated organization. The service validates that the selected avatar is
+        # available.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether the avatar is provided by Telnyx or was uploaded by the authenticated
+        # organization.
+        sig { returns(Telnyx::AI::AvatarType::TaggedSymbol) }
+        attr_accessor :avatar_type
+
+        # Indicates that avatar rendering runs on Telnyx-operated infrastructure.
+        sig { returns(T::Boolean) }
+        attr_accessor :hosted
+
+        # HTTPS image URL suitable for an avatar selection thumbnail. If the URL expires,
+        # list or retrieve the avatar again to refresh it.
+        sig { returns(String) }
+        attr_accessor :image_url
+
+        # Customer-facing avatar name.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Avatar provider. The first release supports Telnyx avatars.
+        sig { returns(Symbol) }
+        attr_accessor :provider
+
+        # MIME type of a custom avatar image.
+        sig do
+          returns(T.nilable(Telnyx::AI::Avatar::ContentType::TaggedSymbol))
+        end
+        attr_reader :content_type
+
+        sig do
+          params(content_type: Telnyx::AI::Avatar::ContentType::OrSymbol).void
+        end
+        attr_writer :content_type
+
+        # Time when the custom avatar was created.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Decoded height of a custom avatar image.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :height_px
+
+        sig { params(height_px: Integer).void }
+        attr_writer :height_px
+
+        # Expiration time of `image_url`. Omitted when the URL does not expire.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :image_url_expires_at
+
+        sig { params(image_url_expires_at: Time).void }
+        attr_writer :image_url_expires_at
+
+        # Size of a custom avatar image in bytes.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :size_bytes
+
+        sig { params(size_bytes: Integer).void }
+        attr_writer :size_bytes
+
+        # Time when the custom avatar was last updated.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        # Decoded width of a custom avatar image.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :width_px
+
+        sig { params(width_px: Integer).void }
+        attr_writer :width_px
+
+        # Optional recommended Telnyx text-to-speech voice for this avatar. An omitted
+        # field or empty string means no recommendation is available. Custom avatars have
+        # no suggested voice. It is informational and selecting the avatar does not
+        # automatically change the AI Assistant's configured voice.
+        sig { returns(T.nilable(String)) }
+        attr_reader :suggested_voice_id
+
+        sig { params(suggested_voice_id: String).void }
+        attr_writer :suggested_voice_id
+
+        sig do
+          params(
+            id: String,
+            avatar_type: Telnyx::AI::AvatarType::OrSymbol,
+            image_url: String,
+            name: String,
+            content_type: Telnyx::AI::Avatar::ContentType::OrSymbol,
+            created_at: Time,
+            height_px: Integer,
+            image_url_expires_at: Time,
+            size_bytes: Integer,
+            suggested_voice_id: String,
+            updated_at: Time,
+            width_px: Integer,
+            hosted: T::Boolean,
+            provider: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Stable identifier returned by the Avatars API. Discover available stock IDs with
+          # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+          # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+          # authenticated organization. The service validates that the selected avatar is
+          # available.
+          id:,
+          # Whether the avatar is provided by Telnyx or was uploaded by the authenticated
+          # organization.
+          avatar_type:,
+          # HTTPS image URL suitable for an avatar selection thumbnail. If the URL expires,
+          # list or retrieve the avatar again to refresh it.
+          image_url:,
+          # Customer-facing avatar name.
+          name:,
+          # MIME type of a custom avatar image.
+          content_type: nil,
+          # Time when the custom avatar was created.
+          created_at: nil,
+          # Decoded height of a custom avatar image.
+          height_px: nil,
+          # Expiration time of `image_url`. Omitted when the URL does not expire.
+          image_url_expires_at: nil,
+          # Size of a custom avatar image in bytes.
+          size_bytes: nil,
+          # Optional recommended Telnyx text-to-speech voice for this avatar. An omitted
+          # field or empty string means no recommendation is available. Custom avatars have
+          # no suggested voice. It is informational and selecting the avatar does not
+          # automatically change the AI Assistant's configured voice.
+          suggested_voice_id: nil,
+          # Time when the custom avatar was last updated.
+          updated_at: nil,
+          # Decoded width of a custom avatar image.
+          width_px: nil,
+          # Indicates that avatar rendering runs on Telnyx-operated infrastructure.
+          hosted: true,
+          # Avatar provider. The first release supports Telnyx avatars.
+          provider: :telnyx
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              avatar_type: Telnyx::AI::AvatarType::TaggedSymbol,
+              hosted: T::Boolean,
+              image_url: String,
+              name: String,
+              provider: Symbol,
+              content_type: Telnyx::AI::Avatar::ContentType::TaggedSymbol,
+              created_at: Time,
+              height_px: Integer,
+              image_url_expires_at: Time,
+              size_bytes: Integer,
+              suggested_voice_id: String,
+              updated_at: Time,
+              width_px: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # MIME type of a custom avatar image.
+        module ContentType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::Avatar::ContentType) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IMAGE_JPEG =
+            T.let(:"image/jpeg", Telnyx::AI::Avatar::ContentType::TaggedSymbol)
+          IMAGE_PNG =
+            T.let(:"image/png", Telnyx::AI::Avatar::ContentType::TaggedSymbol)
+          IMAGE_WEBP =
+            T.let(:"image/webp", Telnyx::AI::Avatar::ContentType::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::Avatar::ContentType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_create_params.rbi

@@ -0,0 +1,53 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        # JPEG, PNG, or WebP image file. The maximum file size is 10 MiB.
+        sig { returns(Telnyx::Internal::FileInput) }
+        attr_accessor :image_file
+
+        # Customer-facing name of the custom avatar.
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            image_file: Telnyx::Internal::FileInput,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # JPEG, PNG, or WebP image file. The maximum file size is 10 MiB.
+          image_file:,
+          # Customer-facing name of the custom avatar.
+          name:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              image_file: Telnyx::Internal::FileInput,
+              name: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_id.rbi

@@ -0,0 +1,9 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      AvatarID = T.type_alias { String }
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_list_params.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Return only stock or custom avatars.
+        sig { returns(T.nilable(Telnyx::AI::AvatarType::OrSymbol)) }
+        attr_reader :filter_avatar_type
+
+        sig do
+          params(filter_avatar_type: Telnyx::AI::AvatarType::OrSymbol).void
+        end
+        attr_writer :filter_avatar_type
+
+        # Return the avatar with this exact ID.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_id
+
+        sig { params(filter_id: String).void }
+        attr_writer :filter_id
+
+        # Return avatars whose names contain this value, using case-insensitive matching.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_name
+
+        sig { params(filter_name: String).void }
+        attr_writer :filter_name
+
+        # Page number to retrieve, starting at 1.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Number of avatars to return per page.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            filter_avatar_type: Telnyx::AI::AvatarType::OrSymbol,
+            filter_id: String,
+            filter_name: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Return only stock or custom avatars.
+          filter_avatar_type: nil,
+          # Return the avatar with this exact ID.
+          filter_id: nil,
+          # Return avatars whose names contain this value, using case-insensitive matching.
+          filter_name: nil,
+          # Page number to retrieve, starting at 1.
+          page_number: nil,
+          # Number of avatars to return per page.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              filter_avatar_type: Telnyx::AI::AvatarType::OrSymbol,
+              filter_id: String,
+              filter_name: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_response.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarResponse, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(Telnyx::AI::Avatar) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::AI::Avatar::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::AI::Avatar::OrHash).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: Telnyx::AI::Avatar }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_retrieve_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarRetrieveParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Stable identifier returned by the Avatars API. Discover available stock IDs with
+        # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        # authenticated organization. The service validates that the selected avatar is
+        # available.
+        sig { returns(String) }
+        attr_accessor :avatar_id
+
+        sig do
+          params(
+            avatar_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Stable identifier returned by the Avatars API. Discover available stock IDs with
+          # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+          # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+          # authenticated organization. The service validates that the selected avatar is
+          # available.
+          avatar_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            { avatar_id: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_settings_request.rbi

@@ -9,8 +9,8 @@ module Telnyx
             T.any(Telnyx::AI::AvatarSettingsRequest, Telnyx::Internal::AnyHash)
           end
 
-        # The Telnyx avatar to render.
-        sig { returns(Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol) }
+        # The Telnyx stock avatar or organization-owned custom avatar to render.
+        sig { returns(String) }
         attr_accessor :avatar_id
 
         # The background to render.
@@ -28,11 +28,13 @@ module Telnyx
         sig { returns(Symbol) }
         attr_accessor :provider
 
-        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
-        # catalog supports six avatars and office, studio, or reception backgrounds.
+        # **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: Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol,
+            avatar_id: String,
             background_id:
               Telnyx::AI::AvatarSettingsRequest::BackgroundID::OrSymbol,
             model: Telnyx::AI::AvatarSettingsRequest::Model::OrSymbol,
@@ -40,7 +42,7 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
-          # The Telnyx avatar to render.
+          # The Telnyx stock avatar or organization-owned custom avatar to render.
           avatar_id:,
           # The background to render.
           background_id:,
@@ -55,7 +57,7 @@ module Telnyx
         sig do
           override.returns(
             {
-              avatar_id: Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol,
+              avatar_id: String,
               background_id:
                 Telnyx::AI::AvatarSettingsRequest::BackgroundID::OrSymbol,
               model: Telnyx::AI::AvatarSettingsRequest::Model::OrSymbol,
@@ -66,58 +68,6 @@ module Telnyx
         def to_hash
         end
 
-        # The Telnyx avatar to render.
-        module AvatarID
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, Telnyx::AI::AvatarSettingsRequest::AvatarID)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ELENA =
-            T.let(
-              :elena,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-          BEN =
-            T.let(
-              :ben,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-          JORDAN =
-            T.let(
-              :jordan,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-          LIN =
-            T.let(
-              :lin,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-          AVERY =
-            T.let(
-              :avery,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-          RAPHAEL =
-            T.let(
-              :raphael,
-              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # The background to render.
         module BackgroundID
           extend Telnyx::Internal::Type::Enum
@@ -143,6 +93,11 @@ module Telnyx
               :reception,
               Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
             )
+          ILLUSTRATED_WORKSPACE =
+            T.let(
+              :illustrated_workspace,
+              Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/ai/avatar_type.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      # Whether the avatar is provided by Telnyx or was uploaded by the authenticated
+      # organization.
+      module AvatarType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Telnyx::AI::AvatarType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STOCK = T.let(:stock, Telnyx::AI::AvatarType::TaggedSymbol)
+        CUSTOM = T.let(:custom, Telnyx::AI::AvatarType::TaggedSymbol)
+
+        sig { override.returns(T::Array[Telnyx::AI::AvatarType::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/avatar_update_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarUpdateParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Stable identifier returned by the Avatars API. Discover available stock IDs with
+        # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        # authenticated organization. The service validates that the selected avatar is
+        # available.
+        sig { returns(String) }
+        attr_accessor :avatar_id
+
+        # New customer-facing name of the custom avatar.
+        sig { returns(String) }
+        attr_accessor :name
+
+        sig do
+          params(
+            avatar_id: String,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Stable identifier returned by the Avatars API. Discover available stock IDs with
+          # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+          # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+          # authenticated organization. The service validates that the selected avatar is
+          # available.
+          avatar_id:,
+          # New customer-facing name of the custom avatar.
+          name:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              avatar_id: String,
+              name: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/flow_node.rbi

@@ -117,6 +117,7 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                    Telnyx::AI::AssistantTool::Vision::OrHash,
                     Telnyx::AI::AssistantTool::Pay::OrHash,
                     Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )
@@ -194,6 +195,7 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                    Telnyx::AI::AssistantTool::Vision::OrHash,
                     Telnyx::AI::AssistantTool::Pay::OrHash,
                     Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )