telnyx 5.69.0 → 5.71.0

data/lib/telnyx/models/voice_clone_create_from_design_params.rb

@@ -34,8 +34,8 @@ module Telnyx
       # @!attribute provider
       #   Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
       #
-      #   @return [Symbol, Telnyx::Models::VoiceCloneCreateParams::Provider, nil]
-      optional :provider, enum: -> { Telnyx::VoiceCloneCreateParams::Provider }
+      #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromDesignParams::Provider, nil]
+      optional :provider, enum: -> { Telnyx::VoiceCloneCreateFromDesignParams::Provider }
 
       # @!method initialize(gender:, language:, name:, voice_design_id:, provider: nil, request_options: {})
       #   @param gender [Symbol, Telnyx::Models::VoiceCloneCreateParams::Gender] Gender of the voice clone.
@@ -46,7 +46,7 @@ module Telnyx
       #
       #   @param voice_design_id [String] UUID of the source voice design to clone.
       #
-      #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateParams::Provider] Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
+      #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateFromDesignParams::Provider] Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/telnyx/models/voice_clone_create_from_upload_params.rb

@@ -7,92 +7,392 @@ module Telnyx
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!attribute audio_file
-      #   Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
-      #   For best quality, provide 5–10 seconds of clear, uninterrupted speech. Maximum
-      #   size: 5MB for Telnyx, 20MB for Minimax.
+      # @!attribute upload_params
+      #   Multipart form data for creating a voice clone from a direct audio upload.
+      #   Maximum file size: 5MB for Telnyx, 20MB for Minimax.
       #
-      #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
-      required :audio_file, Telnyx::Internal::Type::FileInput
+      #   @return [Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone]
+      required :upload_params, union: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams }
 
-      # @!attribute language
-      #   ISO 639-1 language code (e.g. `en`, `fr`) or `auto` for automatic detection.
+      # @!method initialize(upload_params:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::VoiceCloneCreateFromUploadParams} for more details.
       #
-      #   @return [String]
-      required :language, String
-
-      # @!attribute name
-      #   Name for the voice clone.
+      #   @param upload_params [Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone] Multipart form data for creating a voice clone from a direct audio upload. Maxim
       #
-      #   @return [String]
-      required :name, String
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-      # @!attribute gender
-      #   Gender of the voice clone.
-      #
-      #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Gender, nil]
-      optional :gender, enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::Gender }
+      # Multipart form data for creating a voice clone from a direct audio upload.
+      # Maximum file size: 5MB for Telnyx, 20MB for Minimax.
+      module UploadParams
+        extend Telnyx::Internal::Type::Union
 
-      # @!attribute label
-      #   Optional custom label describing the voice style. If omitted, falls back to the
-      #   source design's prompt text.
-      #
-      #   @return [String, nil]
-      optional :label, String
+        # Upload-based voice clone using the Telnyx Qwen3TTS model (default).
+        variant -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone }
 
-      # @!attribute provider
-      #   Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
-      #
-      #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Provider, nil]
-      optional :provider, enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::Provider }
+        # Upload-based voice clone using the Telnyx Ultra model.
+        variant -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone }
 
-      # @!attribute ref_text
-      #   Optional transcript of the audio file. Providing this improves clone quality.
-      #
-      #   @return [String, nil]
-      optional :ref_text, String
+        # Upload-based voice clone using the Minimax provider.
+        variant -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone }
 
-      # @!method initialize(audio_file:, language:, name:, gender: nil, label: nil, provider: nil, ref_text: nil, request_options: {})
-      #   Some parameter documentations has been truncated, see
-      #   {Telnyx::Models::VoiceCloneCreateFromUploadParams} for more details.
-      #
-      #   @param audio_file [Pathname, StringIO, IO, String, Telnyx::FilePart] Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
-      #
-      #   @param language [String] ISO 639-1 language code (e.g. `en`, `fr`) or `auto` for automatic detection.
-      #
-      #   @param name [String] Name for the voice clone.
-      #
-      #   @param gender [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Gender] Gender of the voice clone.
-      #
-      #   @param label [String] Optional custom label describing the voice style. If omitted, falls back to the
-      #
-      #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::Provider] Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
-      #
-      #   @param ref_text [String] Optional transcript of the audio file. Providing this improves clone quality.
-      #
-      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        class TelnyxQwen3TtsClone < Telnyx::Internal::Type::BaseModel
+          # @!attribute audio_file
+          #   Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #   For best quality, provide 5–10 seconds of clear, uninterrupted speech. Maximum
+          #   size: 5MB.
+          #
+          #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
+          required :audio_file, Telnyx::Internal::Type::FileInput
 
-      # Gender of the voice clone.
-      module Gender
-        extend Telnyx::Internal::Type::Enum
+          # @!attribute gender
+          #   Gender of the voice clone.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Gender]
+          required :gender,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Gender }
 
-        MALE = :male
-        FEMALE = :female
-        NEUTRAL = :neutral
+          # @!attribute language
+          #   ISO 639-1 language code from the Qwen language set.
+          #
+          #   @return [String]
+          required :language, String
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+          # @!attribute name
+          #   Name for the voice clone.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute provider
+          #   Voice synthesis provider. Must be `telnyx`.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Provider]
+          required :provider,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Provider }
+
+          # @!attribute label
+          #   Optional custom label describing the voice style.
+          #
+          #   @return [String, nil]
+          optional :label, String
+
+          # @!attribute model_id
+          #   TTS model identifier. Nullable/omittable — defaults to Qwen3TTS.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::ModelID, nil]
+          optional :model_id,
+                   enum: -> {
+                     Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::ModelID
+                   },
+                   nil?: true
+
+          # @!attribute ref_text
+          #   Optional transcript of the audio file. Providing this improves clone quality.
+          #
+          #   @return [String, nil]
+          optional :ref_text, String
+
+          # @!method initialize(audio_file:, gender:, language:, name:, provider:, label: nil, model_id: nil, ref_text: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone}
+          #   for more details.
+          #
+          #   Upload-based voice clone using the Telnyx Qwen3TTS model (default).
+          #
+          #   @param audio_file [Pathname, StringIO, IO, String, Telnyx::FilePart] Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #
+          #   @param gender [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Gender] Gender of the voice clone.
+          #
+          #   @param language [String] ISO 639-1 language code from the Qwen language set.
+          #
+          #   @param name [String] Name for the voice clone.
+          #
+          #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::Provider] Voice synthesis provider. Must be `telnyx`.
+          #
+          #   @param label [String] Optional custom label describing the voice style.
+          #
+          #   @param model_id [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone::ModelID, nil] TTS model identifier. Nullable/omittable — defaults to Qwen3TTS.
+          #
+          #   @param ref_text [String] Optional transcript of the audio file. Providing this improves clone quality.
+
+          # Gender of the voice clone.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone#gender
+          module Gender
+            extend Telnyx::Internal::Type::Enum
+
+            MALE = :male
+            FEMALE = :female
+            NEUTRAL = :neutral
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Voice synthesis provider. Must be `telnyx`.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone#provider
+          module Provider
+            extend Telnyx::Internal::Type::Enum
+
+            TELNYX = :telnyx
+            MINIMAX = :minimax
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # TTS model identifier. Nullable/omittable — defaults to Qwen3TTS.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone#model_id
+          module ModelID
+            extend Telnyx::Internal::Type::Enum
+
+            QWEN3_TTS = :Qwen3TTS
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class TelnyxUltraClone < Telnyx::Internal::Type::BaseModel
+          # @!attribute audio_file
+          #   Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #   For best quality, provide 5–10 seconds of clear, uninterrupted speech. Maximum
+          #   size: 5MB.
+          #
+          #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
+          required :audio_file, Telnyx::Internal::Type::FileInput
+
+          # @!attribute gender
+          #   Gender of the voice clone.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Gender]
+          required :gender,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Gender }
+
+          # @!attribute language
+          #   ISO 639-1 language code from the Ultra language set (40 languages).
+          #
+          #   @return [String]
+          required :language, String
+
+          # @!attribute model_id
+          #   TTS model identifier. Must be `Ultra`.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::ModelID]
+          required :model_id,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::ModelID }
+
+          # @!attribute name
+          #   Name for the voice clone.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute provider
+          #   Voice synthesis provider. Must be `telnyx`.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Provider]
+          required :provider,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Provider }
+
+          # @!attribute label
+          #   Optional custom label describing the voice style.
+          #
+          #   @return [String, nil]
+          optional :label, String
+
+          # @!attribute ref_text
+          #   Optional transcript of the audio file. Providing this improves clone quality.
+          #
+          #   @return [String, nil]
+          optional :ref_text, String
+
+          # @!method initialize(audio_file:, gender:, language:, model_id:, name:, provider:, label: nil, ref_text: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone}
+          #   for more details.
+          #
+          #   Upload-based voice clone using the Telnyx Ultra model.
+          #
+          #   @param audio_file [Pathname, StringIO, IO, String, Telnyx::FilePart] Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #
+          #   @param gender [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Gender] Gender of the voice clone.
+          #
+          #   @param language [String] ISO 639-1 language code from the Ultra language set (40 languages).
+          #
+          #   @param model_id [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::ModelID] TTS model identifier. Must be `Ultra`.
+          #
+          #   @param name [String] Name for the voice clone.
+          #
+          #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone::Provider] Voice synthesis provider. Must be `telnyx`.
+          #
+          #   @param label [String] Optional custom label describing the voice style.
+          #
+          #   @param ref_text [String] Optional transcript of the audio file. Providing this improves clone quality.
+
+          # Gender of the voice clone.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone#gender
+          module Gender
+            extend Telnyx::Internal::Type::Enum
+
+            MALE = :male
+            FEMALE = :female
+            NEUTRAL = :neutral
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # TTS model identifier. Must be `Ultra`.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone#model_id
+          module ModelID
+            extend Telnyx::Internal::Type::Enum
+
+            ULTRA = :Ultra
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Voice synthesis provider. Must be `telnyx`.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone#provider
+          module Provider
+            extend Telnyx::Internal::Type::Enum
+
+            TELNYX = :telnyx
+            MINIMAX = :minimax
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class MinimaxClone < Telnyx::Internal::Type::BaseModel
+          # @!attribute audio_file
+          #   Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #   For best quality, provide 5–10 seconds of clear, uninterrupted speech. Maximum
+          #   size: 20MB.
+          #
+          #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
+          required :audio_file, Telnyx::Internal::Type::FileInput
+
+          # @!attribute gender
+          #   Gender of the voice clone.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Gender]
+          required :gender,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Gender }
+
+          # @!attribute language
+          #   ISO 639-1 language code from the Minimax language set.
+          #
+          #   @return [String]
+          required :language, String
+
+          # @!attribute name
+          #   Name for the voice clone.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute provider
+          #   Voice synthesis provider. Must be `minimax`.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Provider]
+          required :provider,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Provider }
+
+          # @!attribute label
+          #   Optional custom label describing the voice style.
+          #
+          #   @return [String, nil]
+          optional :label, String
+
+          # @!attribute model_id
+          #   TTS model identifier. Nullable — defaults to speech-2.8-turbo.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::ModelID, nil]
+          optional :model_id,
+                   enum: -> { Telnyx::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::ModelID },
+                   nil?: true
+
+          # @!attribute ref_text
+          #   Optional transcript of the audio file. Providing this improves clone quality.
+          #
+          #   @return [String, nil]
+          optional :ref_text, String
+
+          # @!method initialize(audio_file:, gender:, language:, name:, provider:, label: nil, model_id: nil, ref_text: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone}
+          #   for more details.
+          #
+          #   Upload-based voice clone using the Minimax provider.
+          #
+          #   @param audio_file [Pathname, StringIO, IO, String, Telnyx::FilePart] Audio file to clone the voice from. Supported formats: WAV, MP3, FLAC, OGG, M4A.
+          #
+          #   @param gender [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Gender] Gender of the voice clone.
+          #
+          #   @param language [String] ISO 639-1 language code from the Minimax language set.
+          #
+          #   @param name [String] Name for the voice clone.
+          #
+          #   @param provider [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::Provider] Voice synthesis provider. Must be `minimax`.
+          #
+          #   @param label [String] Optional custom label describing the voice style.
+          #
+          #   @param model_id [Symbol, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone::ModelID, nil] TTS model identifier. Nullable — defaults to speech-2.8-turbo.
+          #
+          #   @param ref_text [String] Optional transcript of the audio file. Providing this improves clone quality.
+
+          # Gender of the voice clone.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone#gender
+          module Gender
+            extend Telnyx::Internal::Type::Enum
+
+            MALE = :male
+            FEMALE = :female
+            NEUTRAL = :neutral
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Voice synthesis provider. Must be `minimax`.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone#provider
+          module Provider
+            extend Telnyx::Internal::Type::Enum
+
+            TELNYX = :telnyx
+            MINIMAX = :minimax
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # TTS model identifier. Nullable — defaults to speech-2.8-turbo.
+          #
+          # @see Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone#model_id
+          module ModelID
+            extend Telnyx::Internal::Type::Enum
 
-      # Voice synthesis provider. Case-insensitive. Defaults to `telnyx`.
-      module Provider
-        extend Telnyx::Internal::Type::Enum
+            SPEECH_2_8_TURBO = :"speech-2.8-turbo"
 
-        TELNYX = :telnyx
-        MINIMAX = :minimax
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
 
-        # @!method self.values
-        #   @return [Array<Symbol>]
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxQwen3TtsClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::TelnyxUltraClone, Telnyx::Models::VoiceCloneCreateFromUploadParams::UploadParams::MinimaxClone)]
       end
     end
   end