telnyx 5.112.0 → 5.113.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b51efa53706aeda39911e05fb209f4af8cd52bd56c446ae66b8e7126187a21f
-  data.tar.gz: 6b5a248e77dfd947bc2731b9a4a2b041d89807fe3ad110eacc8a15dd33d61e5d
+  metadata.gz: 99fbf2a1571ce39b824564c7facf12fe91a1c46e8d684c239fa163e1b346892e
+  data.tar.gz: 23cfa6bbda065b16bf4acc6f1b646b1f743fb65d560fd448edc6cfb4197da4fa
 SHA512:
-  metadata.gz: c9a6cdb24c8704343b71f8f02fb361c9bce86a9381edef0caba5f7f933ec83f52eb32081e5ef97e819fa9df09ccc1b970f6994b740eb45bd68c1723069f45599
-  data.tar.gz: 5604d3f27731eb2fcb754029bc45fa7d69ab7d7408fc635301c864184da960e13a64234d8e95d8f7dd08eeeb71316616d5399510f4943d408d3c335265442004
+  metadata.gz: 58ab3a7d04069ae546e9c046e02184347faa31ff1c24475593343b901e6ca28be7921c04680f9c2ca9eda9c980e1beef2ed46f09353fd32360eba51fbcd2dce8
+  data.tar.gz: c25ca773a203ea0b695337ba4dc08a451c0ca5915ab17cd6e8d247866144990a59d5eaab177ee4689a49f93674d0ef01a6773c541c4d32de1b5a2c1d1afbcbc0

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 5.113.0 (2026-05-17)
+
+Full Changelog: [v5.112.0...v5.113.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.112.0...v5.113.0)
+
+### Features
+
+* Add Speechmatics transcription engine to Call Control API ([a2e9a35](https://github.com/team-telnyx/telnyx-ruby/commit/a2e9a3538bbb3c20ddbaf29cf7685c45a2dd12d0))
+* **api:** manual updates ([c04bcfc](https://github.com/team-telnyx/telnyx-ruby/commit/c04bcfcbe3536a42b8c29907f4fda054f864dea9))
+* Document PremiumCallScreening detection mode ([59e5cc4](https://github.com/team-telnyx/telnyx-ruby/commit/59e5cc49d695e85b9dd52b594ba312fd46103146))
+* Fix Conversation Relay expected webhook ([9207e59](https://github.com/team-telnyx/telnyx-ruby/commit/9207e59b39287b242995b437c2cde1f8dbaf7eb6))
+* Update Conversation Relay start parameters ([8b3d719](https://github.com/team-telnyx/telnyx-ruby/commit/8b3d71908a08b7773e80143521dd1bb8a7001872))
+
+
+### Documentation
+
+* add supported file formats to Send Fax endpoint ([b81adb8](https://github.com/team-telnyx/telnyx-ruby/commit/b81adb8bdf3c3b461e9149064347cfa222ab8c11))
+
 ## 5.112.0 (2026-05-14)
 
 Full Changelog: [v5.111.0...v5.112.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.111.0...v5.112.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.112.0"
+gem "telnyx", "~> 5.113.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/models/ai/assistant_create_params.rb

@@ -90,9 +90,8 @@ module Telnyx
         #   `/ai/integrations/connections`. Each item references a catalog integration by
         #   `integration_id`.
         #
-        #   @return [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>, nil]
-        optional :integrations,
-                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::Integration] }
+        #   @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
+        optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
 
         # @!attribute interruption_settings
         #   Settings for interruptions and how the assistant decides the user has finished
@@ -102,8 +101,8 @@ module Telnyx
         #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
         #   `eager_eot_threshold`).
         #
-        #   @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings, nil]
-        optional :interruption_settings, -> { Telnyx::AI::AssistantCreateParams::InterruptionSettings }
+        #   @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
+        optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
 
         # @!attribute llm_api_key_ref
         #   This is only needed when using third-party inference providers selected by
@@ -120,9 +119,8 @@ module Telnyx
         #   MCP servers attached to the assistant. Create MCP servers with
         #   `/ai/mcp_servers`, then reference them by `id` here.
         #
-        #   @return [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>, nil]
-        optional :mcp_servers,
-                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantCreateParams::McpServer] }
+        #   @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
+        optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
 
         # @!attribute messaging_settings
         #
@@ -229,13 +227,13 @@ module Telnyx
         #
         #   @param insight_settings [Telnyx::Models::AI::InsightSettings]
         #
-        #   @param integrations [Array<Telnyx::Models::AI::AssistantCreateParams::Integration>] Connected integrations attached to the assistant. The catalog of available integ
+        #   @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
         #
-        #   @param interruption_settings [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
+        #   @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
         #
         #   @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
         #
-        #   @param mcp_servers [Array<Telnyx::Models::AI::AssistantCreateParams::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
+        #   @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
         #
         #   @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
         #
@@ -262,173 +260,6 @@ module Telnyx
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
         #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
-
-        class Integration < Telnyx::Internal::Type::BaseModel
-          # @!attribute integration_id
-          #   Catalog integration ID to attach. This is the `id` from the integrations catalog
-          #   at `/ai/integrations` (the same value also appears as `integration_id` on
-          #   entries returned by `/ai/integrations/connections`). It is **not** the
-          #   connection-level `id` from `/ai/integrations/connections`.
-          #
-          #   @return [String]
-          required :integration_id, String
-
-          # @!attribute allowed_list
-          #   Optional per-assistant allowlist of integration tool names. When omitted or
-          #   empty, all tools allowed by the connected integration are available to the
-          #   assistant.
-          #
-          #   @return [Array<String>, nil]
-          optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(integration_id:, allowed_list: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::AssistantCreateParams::Integration} for more details.
-          #
-          #   Reference to a connected integration attached to an assistant. Discover
-          #   available integrations with `/ai/integrations` and connected integrations with
-          #   `/ai/integrations/connections`.
-          #
-          #   @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
-          #
-          #   @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
-        end
-
-        class InterruptionSettings < Telnyx::Internal::Type::BaseModel
-          # @!attribute disable_greeting_interruption
-          #   When true, disables user interruptions while the assistant greeting is playing.
-          #
-          #   @return [Boolean, nil]
-          optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
-
-          # @!attribute enable
-          #   Whether users can interrupt the assistant while it is speaking.
-          #
-          #   @return [Boolean, nil]
-          optional :enable, Telnyx::Internal::Type::Boolean
-
-          # @!attribute start_speaking_plan
-          #   Controls when the assistant starts speaking after the user stops. These
-          #   thresholds primarily apply to non turn-taking transcription models. For
-          #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
-          #   transcription end-of-turn settings under `transcription.settings` instead.
-          #
-          #   @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan, nil]
-          optional :start_speaking_plan,
-                   -> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan }
-
-          # @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings} for more
-          #   details.
-          #
-          #   Settings for interruptions and how the assistant decides the user has finished
-          #   speaking. These timings are most relevant when using non turn-taking
-          #   transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
-          #   behavior is controlled by the transcription end-of-turn settings under
-          #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
-          #   `eager_eot_threshold`).
-          #
-          #   @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
-          #
-          #   @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
-          #
-          #   @param start_speaking_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
-
-          # @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings#start_speaking_plan
-          class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
-            # @!attribute transcription_endpointing_plan
-            #   Endpointing thresholds used to decide when the user has finished speaking.
-            #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
-            #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
-            #   `eager_eot_threshold`.
-            #
-            #   @return [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
-            optional :transcription_endpointing_plan,
-                     -> { Telnyx::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
-
-            # @!attribute wait_seconds
-            #   Minimum seconds to wait before the assistant starts speaking.
-            #
-            #   @return [Float, nil]
-            optional :wait_seconds, Float
-
-            # @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan}
-            #   for more details.
-            #
-            #   Controls when the assistant starts speaking after the user stops. These
-            #   thresholds primarily apply to non turn-taking transcription models. For
-            #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
-            #   transcription end-of-turn settings under `transcription.settings` instead.
-            #
-            #   @param transcription_endpointing_plan [Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
-            #
-            #   @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
-
-            # @see Telnyx::Models::AI::AssistantCreateParams::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
-            class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
-              # @!attribute on_no_punctuation_seconds
-              #   Seconds to wait after the transcript ends without punctuation.
-              #
-              #   @return [Float, nil]
-              optional :on_no_punctuation_seconds, Float
-
-              # @!attribute on_number_seconds
-              #   Seconds to wait after the transcript ends with a number.
-              #
-              #   @return [Float, nil]
-              optional :on_number_seconds, Float
-
-              # @!attribute on_punctuation_seconds
-              #   Seconds to wait after the transcript ends with punctuation.
-              #
-              #   @return [Float, nil]
-              optional :on_punctuation_seconds, Float
-
-              # @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
-              #   Endpointing thresholds used to decide when the user has finished speaking.
-              #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
-              #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
-              #   `eager_eot_threshold`.
-              #
-              #   @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
-              #
-              #   @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
-              #
-              #   @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
-            end
-          end
-        end
-
-        class McpServer < Telnyx::Internal::Type::BaseModel
-          # @!attribute id
-          #   ID of the MCP server to attach. This must be the `id` of an MCP server returned
-          #   by the `/ai/mcp_servers` endpoints.
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute allowed_tools
-          #   Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
-          #   uses the MCP server's configured `allowed_tools`.
-          #
-          #   @return [Array<String>, nil]
-          optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(id:, allowed_tools: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::AssistantCreateParams::McpServer} for more details.
-          #
-          #   Reference to an MCP server attached to an assistant. Create and manage MCP
-          #   servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
-          #   ID.
-          #
-          #   @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
-          #
-          #   @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
-        end
       end
     end
   end

data/lib/telnyx/models/ai/assistant_integration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantIntegration < Telnyx::Internal::Type::BaseModel
+        # @!attribute integration_id
+        #   Catalog integration ID to attach. This is the `id` from the integrations catalog
+        #   at `/ai/integrations` (the same value also appears as `integration_id` on
+        #   entries returned by `/ai/integrations/connections`). It is **not** the
+        #   connection-level `id` from `/ai/integrations/connections`.
+        #
+        #   @return [String]
+        required :integration_id, String
+
+        # @!attribute allowed_list
+        #   Optional per-assistant allowlist of integration tool names. When omitted or
+        #   empty, all tools allowed by the connected integration are available to the
+        #   assistant.
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(integration_id:, allowed_list: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AssistantIntegration} for more details.
+        #
+        #   Reference to a connected integration attached to an assistant. Discover
+        #   available integrations with `/ai/integrations` and connected integrations with
+        #   `/ai/integrations/connections`.
+        #
+        #   @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
+        #
+        #   @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/assistant_mcp_server.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class AssistantMcpServer < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   ID of the MCP server to attach. This must be the `id` of an MCP server returned
+        #   by the `/ai/mcp_servers` endpoints.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute allowed_tools
+        #   Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+        #   uses the MCP server's configured `allowed_tools`.
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(id:, allowed_tools: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AssistantMcpServer} for more details.
+        #
+        #   Reference to an MCP server attached to an assistant. Create and manage MCP
+        #   servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
+        #   ID.
+        #
+        #   @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
+        #
+        #   @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/assistant_tool.rb

@@ -144,7 +144,7 @@ module Telnyx
             #   variable string like `{{ targets }}` where `targets` is returned by the dynamic
             #   variables webhook and resolves to an array of target objects at runtime.
             #
-            #   @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String]
+            #   @return [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String]
             required :targets, union: -> { Telnyx::AI::AssistantTool::Transfer::Transfer::Targets }
 
             # @!attribute custom_headers
@@ -184,7 +184,7 @@ module Telnyx
             #
             #   @param from [String] Number or SIP URI placing the call.
             #
-            #   @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String] The different possible targets of the transfer. The assistant will be able to ch
+            #   @param targets [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String] The different possible targets of the transfer. The assistant will be able to ch
             #
             #   @param custom_headers [Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::CustomHeader>] Custom headers to be added to the SIP INVITE for the transfer command.
             #
@@ -203,12 +203,12 @@ module Telnyx
             module Targets
               extend Telnyx::Internal::Type::Union
 
-              variant -> { Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0Array }
+              variant -> { Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsListArray }
 
               # A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
               variant String
 
-              class UnionMember0 < Telnyx::Internal::Type::BaseModel
+              class TargetsList < Telnyx::Internal::Type::BaseModel
                 # @!attribute to
                 #   The destination number or SIP URI of the call.
                 #
@@ -228,12 +228,12 @@ module Telnyx
               end
 
               # @!method self.variants
-              #   @return [Array(Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0>, String)]
+              #   @return [Array(Array<Telnyx::Models::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList>, String)]
 
               # @type [Telnyx::Internal::Type::Converter]
-              UnionMember0Array =
+              TargetsListArray =
                 Telnyx::Internal::Type::ArrayOf[-> {
-                  Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::UnionMember0
+                  Telnyx::AI::AssistantTool::Transfer::Transfer::Targets::TargetsList
                 }]
             end
 
@@ -545,7 +545,7 @@ module Telnyx
             #   omitted or null, the invite tool can still be configured and targets may be
             #   supplied dynamically at runtime.
             #
-            #   @return [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::UnionMember0>, String, nil]
+            #   @return [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String, nil]
             optional :targets, union: -> { Telnyx::AI::AssistantTool::Invite::Invite::Targets }, nil?: true
 
             # @!attribute voicemail_detection
@@ -563,7 +563,7 @@ module Telnyx
             #
             #   @param custom_headers [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::CustomHeader>] Custom headers to be added to the SIP INVITE for the invite command.
             #
-            #   @param targets [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::UnionMember0>, String, nil] The different possible targets of the invite. The assistant will be able to choo
+            #   @param targets [Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String, nil] The different possible targets of the invite. The assistant will be able to choo
             #
             #   @param voicemail_detection [Telnyx::Models::AI::AssistantTool::Invite::Invite::VoicemailDetection] Configuration for voicemail detection (AMD - Answering Machine Detection) on the
 
@@ -603,12 +603,12 @@ module Telnyx
             module Targets
               extend Telnyx::Internal::Type::Union
 
-              variant -> { Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::UnionMember0Array }
+              variant -> { Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsListArray }
 
               # A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
               variant String
 
-              class UnionMember0 < Telnyx::Internal::Type::BaseModel
+              class TargetsList < Telnyx::Internal::Type::BaseModel
                 # @!attribute to
                 #   The destination number or SIP URI of the call.
                 #
@@ -628,12 +628,12 @@ module Telnyx
               end
 
               # @!method self.variants
-              #   @return [Array(Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::UnionMember0>, String)]
+              #   @return [Array(Array<Telnyx::Models::AI::AssistantTool::Invite::Invite::Targets::TargetsList>, String)]
 
               # @type [Telnyx::Internal::Type::Converter]
-              UnionMember0Array =
+              TargetsListArray =
                 Telnyx::Internal::Type::ArrayOf[-> {
-                  Telnyx::AI::AssistantTool::Invite::Invite::Targets::UnionMember0
+                  Telnyx::AI::AssistantTool::Invite::Invite::Targets::TargetsList
                 }]
             end