telnyx 5.57.0 → 5.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 405dd494aa7f3dce98edc03fcd27140bf280f9e589cef656377fb179aedd101a
-  data.tar.gz: b42ea24ca45dce09795e9aacef2ffef3a0ba674fde951e75c1fd97b1457a1eaf
+  metadata.gz: ff2a9579527d16c495311572f44f61609005becc0eb8062bfa342bb97be43ba2
+  data.tar.gz: 8bd424965e38f9c82c70d083f59addc00b99fc85707b431f5628a4e38e12391c
 SHA512:
-  metadata.gz: 3ed6c00bf55e08d8b2d8226788360ae0ebe31249685cba99bceb689699f17cbee40a4bc51813a041b8d2df823ce7c040644937336f6cd26a89272f9d2bd5eb34
-  data.tar.gz: faceb2a68cd7b636bf4cbd1b5dffe630109fd5171941ffaf2b395ee84f019507d4eb80bb40a3be392b131983ca99e9debaa8c6759e5d185ff1851c5ea5fa371d
+  metadata.gz: f2775eb95017b5dc9ea81d5e7b69284e6f74ed2ddb342c5235f6b33c2218086406584586ec63b8ebffe6d748a0b3306f66b84333080795bc3d839b941f82b00d
+  data.tar.gz: ecdac5540274b2dd4acfbf37a09f9954d3f86417a115d950dcea0010dfcec163cfbde3417f71d4a81aa113d7be697f2de66d0d22bb9dc84deb151c81a9ede0c6

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 5.59.0 (2026-03-19)
+
+Full Changelog: [v5.58.0...v5.59.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.58.0...v5.59.0)
+
+### Features
+
+* **api:** manual updates ([8105361](https://github.com/team-telnyx/telnyx-ruby/commit/81053613aee31cb01061ad1e55c4997d727ff9e8))
+* **api:** manual updates ([bd1eab5](https://github.com/team-telnyx/telnyx-ruby/commit/bd1eab5de098d98d53fc00aefc35dbe825fcd825))
+* TELAPPS-5668: Add call.cost webhook event documentation ([ad13577](https://github.com/team-telnyx/telnyx-ruby/commit/ad1357775aeffb088773216f099dc0ba7ac667e9))
+* **wireless:** add traffic policy profiles endpoints to OpenAPI spec ([9d09743](https://github.com/team-telnyx/telnyx-ruby/commit/9d09743b1ddd22f8a9c296fc19636a0b07137554))
+
+
+### Documentation
+
+* **tts:** Add Telnyx.Ultra model documentation ([fd748f2](https://github.com/team-telnyx/telnyx-ruby/commit/fd748f289da493776d1c1e35322abd2333e0b650))
+
+## 5.58.0 (2026-03-18)
+
+Full Changelog: [v5.57.0...v5.58.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.57.0...v5.58.0)
+
+### Features
+
+* **api:** manual updates ([75da4c3](https://github.com/team-telnyx/telnyx-ruby/commit/75da4c3c4172940b59f4bde26f7cf3f8e7530236))
+
 ## 5.57.0 (2026-03-18)
 
 Full Changelog: [v5.56.0...v5.57.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.56.0...v5.57.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "telnyx", "~> 5.57.0"
+gem "telnyx", "~> 5.59.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/client.rb

@@ -620,12 +620,15 @@ module Telnyx
     # @return [Telnyx::Resources::SessionAnalysis]
     attr_reader :session_analysis
 
+    # Traffic Policy Profiles operations
+    # @return [Telnyx::Resources::TrafficPolicyProfiles]
+    attr_reader :traffic_policy_profiles
+
     # @return [Telnyx::Resources::Whatsapp]
     attr_reader :whatsapp
 
-    # Manage Whatsapp message templates
-    # @return [Telnyx::Resources::WhatsappMessageTemplates]
-    attr_reader :whatsapp_message_templates
+    # @return [Telnyx::Resources::X402]
+    attr_reader :x402
 
     # Capture and manage voice identities as clones for use in text-to-speech
     # synthesis.
@@ -636,13 +639,6 @@ module Telnyx
     # @return [Telnyx::Resources::VoiceDesigns]
     attr_reader :voice_designs
 
-    # @return [Telnyx::Resources::X402]
-    attr_reader :x402
-
-    # Speech to text command operations
-    # @return [Telnyx::Resources::SpeechToText]
-    attr_reader :speech_to_text
-
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -891,12 +887,11 @@ module Telnyx
       @alphanumeric_sender_ids = Telnyx::Resources::AlphanumericSenderIDs.new(client: self)
       @messaging_profile_metrics = Telnyx::Resources::MessagingProfileMetrics.new(client: self)
       @session_analysis = Telnyx::Resources::SessionAnalysis.new(client: self)
+      @traffic_policy_profiles = Telnyx::Resources::TrafficPolicyProfiles.new(client: self)
       @whatsapp = Telnyx::Resources::Whatsapp.new(client: self)
-      @whatsapp_message_templates = Telnyx::Resources::WhatsappMessageTemplates.new(client: self)
+      @x402 = Telnyx::Resources::X402.new(client: self)
       @voice_clones = Telnyx::Resources::VoiceClones.new(client: self)
       @voice_designs = Telnyx::Resources::VoiceDesigns.new(client: self)
-      @x402 = Telnyx::Resources::X402.new(client: self)
-      @speech_to_text = Telnyx::Resources::SpeechToText.new(client: self)
     end
   end
 end

data/lib/telnyx/models/ai/assistants/{tag_remove_params.rb → tag_create_params.rb}

@@ -4,8 +4,8 @@ module Telnyx
   module Models
     module AI
       module Assistants
-        # @see Telnyx::Resources::AI::Assistants::Tags#remove
-        class TagRemoveParams < Telnyx::Internal::Type::BaseModel
+        # @see Telnyx::Resources::AI::Assistants::Tags#create
+        class TagCreateParams < Telnyx::Internal::Type::BaseModel
           extend Telnyx::Internal::Type::RequestParameters::Converter
           include Telnyx::Internal::Type::RequestParameters
 

data/lib/telnyx/models/ai/assistants/{tag_remove_response.rb → tag_create_response.rb}

@@ -4,8 +4,8 @@ module Telnyx
   module Models
     module AI
       module Assistants
-        # @see Telnyx::Resources::AI::Assistants::Tags#remove
-        class TagRemoveResponse < Telnyx::Internal::Type::BaseModel
+        # @see Telnyx::Resources::AI::Assistants::Tags#create
+        class TagCreateResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute tags
           #
           #   @return [Array<String>]

data/lib/telnyx/models/ai/assistants/{tag_add_params.rb → tag_delete_params.rb}

@@ -4,8 +4,8 @@ module Telnyx
   module Models
     module AI
       module Assistants
-        # @see Telnyx::Resources::AI::Assistants::Tags#add
-        class TagAddParams < Telnyx::Internal::Type::BaseModel
+        # @see Telnyx::Resources::AI::Assistants::Tags#delete
+        class TagDeleteParams < Telnyx::Internal::Type::BaseModel
           extend Telnyx::Internal::Type::RequestParameters::Converter
           include Telnyx::Internal::Type::RequestParameters
 

data/lib/telnyx/models/ai/assistants/{tag_add_response.rb → tag_delete_response.rb}

@@ -4,8 +4,8 @@ module Telnyx
   module Models
     module AI
       module Assistants
-        # @see Telnyx::Resources::AI::Assistants::Tags#add
-        class TagAddResponse < Telnyx::Internal::Type::BaseModel
+        # @see Telnyx::Resources::AI::Assistants::Tags#delete
+        class TagDeleteResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute tags
           #
           #   @return [Array<String>]

data/lib/telnyx/models/porting/loa_configuration_preview_0_params.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module Porting
+      # @see Telnyx::Resources::Porting::LoaConfigurations#preview_0
+      class LoaConfigurationPreview0Params < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute address
+        #   The address of the company.
+        #
+        #   @return [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Address]
+        required :address, -> { Telnyx::Porting::LoaConfigurationPreview0Params::Address }
+
+        # @!attribute company_name
+        #   The name of the company
+        #
+        #   @return [String]
+        required :company_name, String
+
+        # @!attribute contact
+        #   The contact information of the company.
+        #
+        #   @return [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Contact]
+        required :contact, -> { Telnyx::Porting::LoaConfigurationPreview0Params::Contact }
+
+        # @!attribute logo
+        #   The logo of the LOA configuration
+        #
+        #   @return [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Logo]
+        required :logo, -> { Telnyx::Porting::LoaConfigurationPreview0Params::Logo }
+
+        # @!attribute name
+        #   The name of the LOA configuration
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(address:, company_name:, contact:, logo:, name:, request_options: {})
+        #   @param address [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Address] The address of the company.
+        #
+        #   @param company_name [String] The name of the company
+        #
+        #   @param contact [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Contact] The contact information of the company.
+        #
+        #   @param logo [Telnyx::Models::Porting::LoaConfigurationPreview0Params::Logo] The logo of the LOA configuration
+        #
+        #   @param name [String] The name of the LOA configuration
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        class Address < Telnyx::Internal::Type::BaseModel
+          # @!attribute city
+          #   The locality of the company
+          #
+          #   @return [String]
+          required :city, String
+
+          # @!attribute country_code
+          #   The country code of the company
+          #
+          #   @return [String]
+          required :country_code, String
+
+          # @!attribute state
+          #   The administrative area of the company
+          #
+          #   @return [String]
+          required :state, String
+
+          # @!attribute street_address
+          #   The street address of the company
+          #
+          #   @return [String]
+          required :street_address, String
+
+          # @!attribute zip_code
+          #   The postal code of the company
+          #
+          #   @return [String]
+          required :zip_code, String
+
+          # @!attribute extended_address
+          #   The extended address of the company
+          #
+          #   @return [String, nil]
+          optional :extended_address, String
+
+          # @!method initialize(city:, country_code:, state:, street_address:, zip_code:, extended_address: nil)
+          #   The address of the company.
+          #
+          #   @param city [String] The locality of the company
+          #
+          #   @param country_code [String] The country code of the company
+          #
+          #   @param state [String] The administrative area of the company
+          #
+          #   @param street_address [String] The street address of the company
+          #
+          #   @param zip_code [String] The postal code of the company
+          #
+          #   @param extended_address [String] The extended address of the company
+        end
+
+        class Contact < Telnyx::Internal::Type::BaseModel
+          # @!attribute email
+          #   The email address of the contact
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute phone_number
+          #   The phone number of the contact
+          #
+          #   @return [String]
+          required :phone_number, String
+
+          # @!method initialize(email:, phone_number:)
+          #   The contact information of the company.
+          #
+          #   @param email [String] The email address of the contact
+          #
+          #   @param phone_number [String] The phone number of the contact
+        end
+
+        class Logo < Telnyx::Internal::Type::BaseModel
+          # @!attribute document_id
+          #   The document identification
+          #
+          #   @return [String]
+          required :document_id, String
+
+          # @!method initialize(document_id:)
+          #   The logo of the LOA configuration
+          #
+          #   @param document_id [String] The document identification
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/stream_client_event.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class StreamClientEvent < Telnyx::Internal::Type::BaseModel
+      # @!attribute text
+      #   Text to convert to speech. Send `" "` (single space) as an initial handshake
+      #   with optional `voice_settings`. Subsequent messages contain the actual text to
+      #   synthesize.
+      #
+      #   @return [String]
+      required :text, String
+
+      # @!attribute force
+      #   When `true`, stops the current synthesis worker and starts a new one. Used to
+      #   interrupt speech mid-stream and begin synthesizing new text.
+      #
+      #   @return [Boolean, nil]
+      optional :force, Telnyx::Internal::Type::Boolean
+
+      # @!attribute voice_settings
+      #   Provider-specific voice settings sent with the initial handshake. Contents vary
+      #   by provider — e.g. `{"speed": 1.2}` for Minimax, `{"voice_speed": 1.5}` for
+      #   Telnyx.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :voice_settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!method initialize(text:, force: nil, voice_settings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::StreamClientEvent} for more details.
+      #
+      #   Client-to-server frame containing text to synthesize.
+      #
+      #   @param text [String] Text to convert to speech. Send `" "` (single space) as an initial handshake wit
+      #
+      #   @param force [Boolean] When `true`, stops the current synthesis worker and starts a new one. Used to in
+      #
+      #   @param voice_settings [Hash{Symbol=>Object}] Provider-specific voice settings sent with the initial handshake. Contents vary
+    end
+  end
+end

data/lib/telnyx/models/stream_server_event.rb

@@ -0,0 +1,200 @@
+# 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