telnyx 5.162.0 → 5.164.0

data/lib/telnyx/models/stream_server_event.rb

@@ -1,200 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # Union of all server-to-client WebSocket events for TTS streaming.
-    module StreamServerEvent
-      extend Telnyx::Internal::Type::Union
-
-      discriminator :type
-
-      # Server-to-client frame containing a base64-encoded audio chunk.
-      variant :audio_chunk, -> { Telnyx::Models::StreamServerEvent::AudioChunk }
-
-      # Server-to-client frame indicating synthesis is complete for the current text.
-      variant :final, -> { Telnyx::Models::StreamServerEvent::FinalFrameEvent }
-
-      # Server-to-client frame indicating an error during synthesis. The connection is closed shortly after.
-      variant :error, -> { Telnyx::Models::StreamServerEvent::Error }
-
-      class AudioChunk < Telnyx::Internal::Type::BaseModel
-        # @!attribute audio
-        #   Base64-encoded audio data. May be `null` for providers that use
-        #   `drop_concatenated_audio` mode (Telnyx Natural/NaturalHD, Rime, Minimax, MurfAI,
-        #   Resemble) — in that case only streamed chunks carry audio.
-        #
-        #   @return [String, nil]
-        optional :audio, String, nil?: true
-
-        # @!attribute cached
-        #   Whether this audio was served from cache.
-        #
-        #   @return [Boolean, nil]
-        optional :cached, Telnyx::Internal::Type::Boolean
-
-        # @!attribute is_final
-        #   Always `false` for audio chunk frames.
-        #
-        #   @return [Boolean, nil]
-        optional :is_final, Telnyx::Internal::Type::Boolean, api_name: :isFinal
-
-        # @!attribute text
-        #   The text segment that this audio chunk corresponds to.
-        #
-        #   @return [String, nil]
-        optional :text, String, nil?: true
-
-        # @!attribute time_to_first_audio_frame_ms
-        #   Milliseconds from the start-of-speech request to the first audio frame. Only
-        #   present on the first audio chunk of a synthesis request.
-        #
-        #   @return [Integer, nil]
-        optional :time_to_first_audio_frame_ms, Integer, api_name: :timeToFirstAudioFrameMs
-
-        # @!attribute type
-        #   Frame type identifier.
-        #
-        #   @return [Symbol, Telnyx::Models::StreamServerEvent::AudioChunk::Type, nil]
-        optional :type, enum: -> { Telnyx::Models::StreamServerEvent::AudioChunk::Type }
-
-        # @!method initialize(audio: nil, cached: nil, is_final: nil, text: nil, time_to_first_audio_frame_ms: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::StreamServerEvent::AudioChunk} for more details.
-        #
-        #   Server-to-client frame containing a base64-encoded audio chunk.
-        #
-        #   @param audio [String, nil] Base64-encoded audio data. May be `null` for providers that use `drop_concatenat
-        #
-        #   @param cached [Boolean] Whether this audio was served from cache.
-        #
-        #   @param is_final [Boolean] Always `false` for audio chunk frames.
-        #
-        #   @param text [String, nil] The text segment that this audio chunk corresponds to.
-        #
-        #   @param time_to_first_audio_frame_ms [Integer] Milliseconds from the start-of-speech request to the first audio frame. Only pre
-        #
-        #   @param type [Symbol, Telnyx::Models::StreamServerEvent::AudioChunk::Type] Frame type identifier.
-
-        # Frame type identifier.
-        #
-        # @see Telnyx::Models::StreamServerEvent::AudioChunk#type
-        module Type
-          extend Telnyx::Internal::Type::Enum
-
-          AUDIO_CHUNK = :audio_chunk
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      class FinalFrameEvent < Telnyx::Internal::Type::BaseModel
-        # @!attribute audio
-        #   Always `null` for the final frame.
-        #
-        #   @return [nil]
-        optional :audio, NilClass
-
-        # @!attribute is_final
-        #   Always `true`.
-        #
-        #   @return [Boolean, Telnyx::Models::StreamServerEvent::FinalFrameEvent::IsFinal, nil]
-        optional :is_final,
-                 enum: -> { Telnyx::Models::StreamServerEvent::FinalFrameEvent::IsFinal },
-                 api_name: :isFinal
-
-        # @!attribute text
-        #   Empty string.
-        #
-        #   @return [String, nil]
-        optional :text, String
-
-        # @!attribute time_to_first_audio_frame_ms
-        #   Present if this was the first response frame.
-        #
-        #   @return [Integer, nil]
-        optional :time_to_first_audio_frame_ms, Integer, api_name: :timeToFirstAudioFrameMs
-
-        # @!attribute type
-        #   Frame type identifier.
-        #
-        #   @return [Symbol, Telnyx::Models::StreamServerEvent::FinalFrameEvent::Type, nil]
-        optional :type, enum: -> { Telnyx::Models::StreamServerEvent::FinalFrameEvent::Type }
-
-        # @!method initialize(audio: nil, is_final: nil, text: nil, time_to_first_audio_frame_ms: nil, type: nil)
-        #   Server-to-client frame indicating synthesis is complete for the current text.
-        #
-        #   @param audio [nil] Always `null` for the final frame.
-        #
-        #   @param is_final [Boolean, Telnyx::Models::StreamServerEvent::FinalFrameEvent::IsFinal] Always `true`.
-        #
-        #   @param text [String] Empty string.
-        #
-        #   @param time_to_first_audio_frame_ms [Integer] Present if this was the first response frame.
-        #
-        #   @param type [Symbol, Telnyx::Models::StreamServerEvent::FinalFrameEvent::Type] Frame type identifier.
-
-        # Always `true`.
-        #
-        # @see Telnyx::Models::StreamServerEvent::FinalFrameEvent#is_final
-        module IsFinal
-          extend Telnyx::Internal::Type::Enum
-
-          TRUE = true
-
-          # @!method self.values
-          #   @return [Array<Boolean>]
-        end
-
-        # Frame type identifier.
-        #
-        # @see Telnyx::Models::StreamServerEvent::FinalFrameEvent#type
-        module Type
-          extend Telnyx::Internal::Type::Enum
-
-          FINAL = :final
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      class Error < Telnyx::Internal::Type::BaseModel
-        # @!attribute error
-        #   Error message describing what went wrong.
-        #
-        #   @return [String, nil]
-        optional :error, String
-
-        # @!attribute type
-        #   Frame type identifier.
-        #
-        #   @return [Symbol, Telnyx::Models::StreamServerEvent::Error::Type, nil]
-        optional :type, enum: -> { Telnyx::Models::StreamServerEvent::Error::Type }
-
-        # @!method initialize(error: nil, type: nil)
-        #   Server-to-client frame indicating an error during synthesis. The connection is
-        #   closed shortly after.
-        #
-        #   @param error [String] Error message describing what went wrong.
-        #
-        #   @param type [Symbol, Telnyx::Models::StreamServerEvent::Error::Type] Frame type identifier.
-
-        # Frame type identifier.
-        #
-        # @see Telnyx::Models::StreamServerEvent::Error#type
-        module Type
-          extend Telnyx::Internal::Type::Enum
-
-          ERROR = :error
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
-      # @!method self.variants
-      #   @return [Array(Telnyx::Models::StreamServerEvent::AudioChunk, Telnyx::Models::StreamServerEvent::FinalFrameEvent, Telnyx::Models::StreamServerEvent::Error)]
-    end
-  end
-end

data/lib/telnyx/models/text_to_speech_stream_params.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::TextToSpeech#stream
-    class TextToSpeechStreamParams < Telnyx::Internal::Type::BaseModel
-      extend Telnyx::Internal::Type::RequestParameters::Converter
-      include Telnyx::Internal::Type::RequestParameters
-
-      # @!method initialize(request_options: {})
-      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/telnyx/models/transcribe_server_event.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # Union of all server-to-client WebSocket events for STT streaming.
-    module TranscribeServerEvent
-      extend Telnyx::Internal::Type::Union
-
-      discriminator :type
-
-      # Server-to-client frame containing a transcription result.
-      variant :transcript, -> { Telnyx::Models::TranscribeServerEvent::Transcript }
-
-      # Server-to-client frame indicating an error during transcription. The connection may be closed shortly after.
-      variant :error, -> { Telnyx::Models::TranscribeServerEvent::Error }
-
-      class Transcript < Telnyx::Internal::Type::BaseModel
-        # @!attribute transcript
-        #   The transcribed text from the audio.
-        #
-        #   @return [String]
-        required :transcript, String
-
-        # @!attribute type
-        #   Frame type identifier.
-        #
-        #   @return [Symbol, :transcript]
-        required :type, const: :transcript
-
-        # @!attribute confidence
-        #   Confidence score of the transcription, ranging from 0 to 1.
-        #
-        #   @return [Float, nil]
-        optional :confidence, Float
-
-        # @!attribute is_final
-        #   Whether this is a final transcription result. When `false`, this is an interim
-        #   result that may be refined.
-        #
-        #   @return [Boolean, nil]
-        optional :is_final, Telnyx::Internal::Type::Boolean
-
-        # @!method initialize(transcript:, confidence: nil, is_final: nil, type: :transcript)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::TranscribeServerEvent::Transcript} for more details.
-        #
-        #   Server-to-client frame containing a transcription result.
-        #
-        #   @param transcript [String] The transcribed text from the audio.
-        #
-        #   @param confidence [Float] Confidence score of the transcription, ranging from 0 to 1.
-        #
-        #   @param is_final [Boolean] Whether this is a final transcription result. When `false`, this is an interim r
-        #
-        #   @param type [Symbol, :transcript] Frame type identifier.
-      end
-
-      class Error < Telnyx::Internal::Type::BaseModel
-        # @!attribute error
-        #   Error message describing what went wrong.
-        #
-        #   @return [String]
-        required :error, String
-
-        # @!attribute type
-        #   Frame type identifier.
-        #
-        #   @return [Symbol, :error]
-        required :type, const: :error
-
-        # @!method initialize(error:, type: :error)
-        #   Server-to-client frame indicating an error during transcription. The connection
-        #   may be closed shortly after.
-        #
-        #   @param error [String] Error message describing what went wrong.
-        #
-        #   @param type [Symbol, :error] Frame type identifier.
-      end
-
-      # @!method self.variants
-      #   @return [Array(Telnyx::Models::TranscribeServerEvent::Transcript, Telnyx::Models::TranscribeServerEvent::Error)]
-    end
-  end
-end

data/lib/telnyx/models/wireless_blocklist_delete_response.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    # @see Telnyx::Resources::WirelessBlocklists#delete
-    class WirelessBlocklistDeleteResponse < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Telnyx::Models::WirelessBlocklist, nil]
-      optional :data, -> { Telnyx::WirelessBlocklist }
-
-      # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::WirelessBlocklist]
-    end
-  end
-end

data/rbi/telnyx/models/ai/collection_retrieve_documents_params.rbi

@@ -1,195 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class CollectionRetrieveDocumentsParams < Telnyx::Internal::Type::BaseModel
-        extend Telnyx::Internal::Type::RequestParameters::Converter
-        include Telnyx::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::AI::CollectionRetrieveDocumentsParams,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :slug
-
-        # Field filters applied before ranking, using `filter[field][operator]=value`.
-        # Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
-        # Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
-        # `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
-        # `filter[record_id][eq]=rec_123`.
-        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
-        attr_reader :filter
-
-        sig { params(filter: T::Hash[Symbol, T.anything]).void }
-        attr_writer :filter
-
-        # Page number to return (1-based). Defaults to 1.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :page_number
-
-        sig { params(page_number: Integer).void }
-        attr_writer :page_number
-
-        # Number of results per page. Defaults to 20.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :page_size
-
-        sig { params(page_size: Integer).void }
-        attr_writer :page_size
-
-        # Natural-language search query. When provided, the text is matched against the
-        # collection's document chunks using the collection's `retrieval_type` (vector or
-        # hybrid). When omitted, documents are returned as a plain catalog listing.
-        sig { returns(T.nilable(String)) }
-        attr_reader :query
-
-        sig { params(query: String).void }
-        attr_writer :query
-
-        # Override the collection's configured retrieval strategy for this request. Echoed
-        # back in `meta.retrieval_type`.
-        sig do
-          returns(
-            T.nilable(
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::OrSymbol
-            )
-          )
-        end
-        attr_reader :retrieval_type
-
-        sig do
-          params(
-            retrieval_type:
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::OrSymbol
-          ).void
-        end
-        attr_writer :retrieval_type
-
-        # Comma-separated list of source types to restrict the search to. When omitted,
-        # all of the collection's sources are searched.
-        sig { returns(T.nilable(String)) }
-        attr_reader :sources
-
-        sig { params(sources: String).void }
-        attr_writer :sources
-
-        # Maximum number of ranked results to consider. When omitted, the collection's
-        # configured `top_k` setting is used.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :top_k
-
-        sig { params(top_k: Integer).void }
-        attr_writer :top_k
-
-        sig do
-          params(
-            slug: String,
-            filter: T::Hash[Symbol, T.anything],
-            page_number: Integer,
-            page_size: Integer,
-            query: String,
-            retrieval_type:
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::OrSymbol,
-            sources: String,
-            top_k: Integer,
-            request_options: Telnyx::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          slug:,
-          # Field filters applied before ranking, using `filter[field][operator]=value`.
-          # Supported operators: `eq` (default), `in`, `gte`, `gt`, `lte`, `lt`, `contains`.
-          # Known fields: `record_type`, `record_id`, `user_id`, `record_created_at`,
-          # `ingested_at`; any other name resolves to a `metadata.<field>` filter. Example:
-          # `filter[record_id][eq]=rec_123`.
-          filter: nil,
-          # Page number to return (1-based). Defaults to 1.
-          page_number: nil,
-          # Number of results per page. Defaults to 20.
-          page_size: nil,
-          # Natural-language search query. When provided, the text is matched against the
-          # collection's document chunks using the collection's `retrieval_type` (vector or
-          # hybrid). When omitted, documents are returned as a plain catalog listing.
-          query: nil,
-          # Override the collection's configured retrieval strategy for this request. Echoed
-          # back in `meta.retrieval_type`.
-          retrieval_type: nil,
-          # Comma-separated list of source types to restrict the search to. When omitted,
-          # all of the collection's sources are searched.
-          sources: nil,
-          # Maximum number of ranked results to consider. When omitted, the collection's
-          # configured `top_k` setting is used.
-          top_k: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              slug: String,
-              filter: T::Hash[Symbol, T.anything],
-              page_number: Integer,
-              page_size: Integer,
-              query: String,
-              retrieval_type:
-                Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::OrSymbol,
-              sources: String,
-              top_k: Integer,
-              request_options: Telnyx::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Override the collection's configured retrieval strategy for this request. Echoed
-        # back in `meta.retrieval_type`.
-        module RetrievalType
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          VECTOR =
-            T.let(
-              :vector,
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::TaggedSymbol
-            )
-          HYBRID =
-            T.let(
-              :hybrid,
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::TaggedSymbol
-            )
-          KEYWORD =
-            T.let(
-              :keyword,
-              Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::AI::CollectionRetrieveDocumentsParams::RetrievalType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end