telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/models/ai/audio_transcribe_params.rbi

@@ -20,6 +20,8 @@ module Telnyx
         # English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
         # `nvidia/parakeet-v3` is multilingual with automatic language detection;
         # `omi-health/omi-med-stt-v1` is a medical model, English only.
+        # `reson8/prerecorded` covers 10 languages, returns word timestamps, and labels
+        # speakers via `model_config`.
         sig { returns(Telnyx::AI::AudioTranscribeParams::Model::OrSymbol) }
         attr_accessor :model
 
@@ -52,7 +54,9 @@ module Telnyx
         # `openai/whisper-large-v3-turbo`, supports multiple languages.
         # `distil-whisper/distil-large-v2` does not support language parameter.
         # `nvidia/parakeet-v3` detects the language automatically;
-        # `omi-health/omi-med-stt-v1` is English only.
+        # `omi-health/omi-med-stt-v1` is English only. `reson8/prerecorded` accepts `nl`,
+        # `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es` and `sv` (regional variants are
+        # transcribed as the base language) and detects the language when it is omitted.
         sig { returns(T.nilable(String)) }
         attr_reader :language
 
@@ -60,10 +64,16 @@ module Telnyx
         attr_writer :language
 
         # Additional model-specific configuration parameters. Only allowed with the
-        # `deepgram/*` models. Can include Deepgram-specific options such as
-        # `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
-        # If `language` is provided both as a top-level parameter and in `model_config`,
-        # the top-level parameter takes precedence.
+        # `deepgram/*` models and `reson8/prerecorded`. Sent as a JSON string in multipart
+        # requests; for the `deepgram/*` models it is passed through to Deepgram as query
+        # parameters, while `reson8/prerecorded` accepts only `diarize` (speaker labels)
+        # and `max_speakers` (1 to 8). Any other model with `model_config` returns 400.
+        # Can include Deepgram-specific options such as `smart_format`, `punctuate`,
+        # `diarize` (speaker labels), `multichannel` (transcribe each channel
+        # independently; billed duration is file duration multiplied by the number of
+        # channels), `utterances`, `numerals`, and `language`. If `language` is provided
+        # both as a top-level parameter and in `model_config`, the top-level parameter
+        # takes precedence.
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :model_config
 
@@ -132,6 +142,8 @@ module Telnyx
           # English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
           # `nvidia/parakeet-v3` is multilingual with automatic language detection;
           # `omi-health/omi-med-stt-v1` is a medical model, English only.
+          # `reson8/prerecorded` covers 10 languages, returns word timestamps, and labels
+          # speakers via `model_config`.
           model:,
           # The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
           # mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
@@ -152,13 +164,21 @@ module Telnyx
           # `openai/whisper-large-v3-turbo`, supports multiple languages.
           # `distil-whisper/distil-large-v2` does not support language parameter.
           # `nvidia/parakeet-v3` detects the language automatically;
-          # `omi-health/omi-med-stt-v1` is English only.
+          # `omi-health/omi-med-stt-v1` is English only. `reson8/prerecorded` accepts `nl`,
+          # `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es` and `sv` (regional variants are
+          # transcribed as the base language) and detects the language when it is omitted.
           language: nil,
           # Additional model-specific configuration parameters. Only allowed with the
-          # `deepgram/*` models. Can include Deepgram-specific options such as
-          # `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
-          # If `language` is provided both as a top-level parameter and in `model_config`,
-          # the top-level parameter takes precedence.
+          # `deepgram/*` models and `reson8/prerecorded`. Sent as a JSON string in multipart
+          # requests; for the `deepgram/*` models it is passed through to Deepgram as query
+          # parameters, while `reson8/prerecorded` accepts only `diarize` (speaker labels)
+          # and `max_speakers` (1 to 8). Any other model with `model_config` returns 400.
+          # Can include Deepgram-specific options such as `smart_format`, `punctuate`,
+          # `diarize` (speaker labels), `multichannel` (transcribe each channel
+          # independently; billed duration is file duration multiplied by the number of
+          # channels), `utterances`, `numerals`, and `language`. If `language` is provided
+          # both as a top-level parameter and in `model_config`, the top-level parameter
+          # takes precedence.
           model_config: nil,
           # The format of the transcript output. Use `verbose_json` to take advantage of
           # timestamps.
@@ -198,6 +218,8 @@ module Telnyx
         # English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
         # `nvidia/parakeet-v3` is multilingual with automatic language detection;
         # `omi-health/omi-med-stt-v1` is a medical model, English only.
+        # `reson8/prerecorded` covers 10 languages, returns word timestamps, and labels
+        # speakers via `model_config`.
         module Model
           extend Telnyx::Internal::Type::Enum
 
@@ -247,6 +269,11 @@ module Telnyx
               :"omi-health/omi-med-stt-v1",
               Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
             )
+          RESON8_PRERECORDED =
+            T.let(
+              :"reson8/prerecorded",
+              Telnyx::AI::AudioTranscribeParams::Model::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/telnyx/models/ai/audio_transcribe_response.rbi

@@ -71,6 +71,9 @@ module Telnyx
         # return `text` and, depending on `model_config`, may include `words` with
         # per-word timestamps and speaker labels. The Parakeet models
         # (`nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`) return `text` only.
+        # `reson8/prerecorded` returns `text` and, in `verbose_json` mode, `duration` and
+        # `segments` with `words`; with `diarize`, one segment per speaker turn with
+        # speaker labels.
         sig do
           params(
             text: String,
@@ -140,8 +143,20 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :text
 
-          # Speaker indices heard in this segment. Returned by the `deepgram/*` models when
-          # `diarize` is enabled via `model_config`.
+          # Zero-indexed audio channel of this segment. Returned by the `deepgram/*` models
+          # when `multichannel` is enabled via `model_config` and the file has more than one
+          # channel. Segments from all channels are merged in one list ordered by start
+          # time.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :channel
+
+          sig { params(channel: Integer).void }
+          attr_writer :channel
+
+          # Speaker indices heard in this segment. Returned by the `deepgram/*` models and
+          # `reson8/prerecorded` when `diarize` is enabled via `model_config`. With
+          # `multichannel`, speakers are numbered per channel from 0, so identify a speaker
+          # by (`channel`, speaker).
           sig { returns(T.nilable(T::Array[Integer])) }
           attr_reader :speakers
 
@@ -149,7 +164,8 @@ module Telnyx
           attr_writer :speakers
 
           # Word-level timing detail for this segment. Returned by the `deepgram/*` models
-          # when word-level output is enabled via `model_config`.
+          # when word-level output is enabled via `model_config`, and by
+          # `reson8/prerecorded`.
           sig do
             returns(
               T.nilable(T::Array[Telnyx::AI::AudioTranscriptionResponseWord])
@@ -171,6 +187,7 @@ module Telnyx
               end_: Float,
               start: Float,
               text: String,
+              channel: Integer,
               speakers: T::Array[Integer],
               words:
                 T::Array[Telnyx::AI::AudioTranscriptionResponseWord::OrHash]
@@ -185,11 +202,19 @@ module Telnyx
             start:,
             # Text content of the segment.
             text:,
-            # Speaker indices heard in this segment. Returned by the `deepgram/*` models when
-            # `diarize` is enabled via `model_config`.
+            # Zero-indexed audio channel of this segment. Returned by the `deepgram/*` models
+            # when `multichannel` is enabled via `model_config` and the file has more than one
+            # channel. Segments from all channels are merged in one list ordered by start
+            # time.
+            channel: nil,
+            # Speaker indices heard in this segment. Returned by the `deepgram/*` models and
+            # `reson8/prerecorded` when `diarize` is enabled via `model_config`. With
+            # `multichannel`, speakers are numbered per channel from 0, so identify a speaker
+            # by (`channel`, speaker).
             speakers: nil,
             # Word-level timing detail for this segment. Returned by the `deepgram/*` models
-            # when word-level output is enabled via `model_config`.
+            # when word-level output is enabled via `model_config`, and by
+            # `reson8/prerecorded`.
             words: nil
           )
           end
@@ -201,6 +226,7 @@ module Telnyx
                 end_: Float,
                 start: Float,
                 text: String,
+                channel: Integer,
                 speakers: T::Array[Integer],
                 words: T::Array[Telnyx::AI::AudioTranscriptionResponseWord]
               }

data/rbi/telnyx/models/ai/audio_transcription_response_word.rbi

@@ -55,7 +55,7 @@ module Telnyx
         attr_writer :speaker_confidence
 
         # Word-level timing detail. Only present when using a `deepgram/*` model with
-        # `model_config` options that enable word timestamps.
+        # `model_config` options that enable word timestamps, or `reson8/prerecorded`.
         sig do
           params(
             end_: Float,

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