telnyx 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f827032c51307653bb703bbdcaf18c67dd2616d9d406af7d8424f36d572d46ea
-  data.tar.gz: 5d73b33d70182d9554f6b94173d97577e2ad9ec97b8b390fd5866525d97b5283
+  metadata.gz: 1d7930fc7b48b6545e1871b9931bcb1fce7661f52b8ba959f19871be335d75a4
+  data.tar.gz: 6d62bbab0f6da6c323c9a46d66eaf3781275d145332121fbe1c99fd5ab64c84b
 SHA512:
-  metadata.gz: cbf0a9bcdae44022f3b94948b5034153f252c2cda758392da4570a41e3955984c3fe4693b50e1af79c29f9367141fcb0e78bfc0ed8e21e233642e414f731d9b4
-  data.tar.gz: 1cb5a174cfe88597524b4743e16bf644e748c6a2ecc3d47ef65c61814f086464fda2dc29fc5c88dc2ecca2bbdb8c69e8cb7777198594e157fb5b845660364785
+  metadata.gz: 9d7d007e45900de8273dec5b5e9ee215fcacfc551ec2564b425c8c942d3cc8149de5a0253159dc2917d99f0cc1f15ab702faf4906acf047d5a3b2eed00cffe95
+  data.tar.gz: 4bebdbccc0fc17cf8bbf38c84900312b1cd0598d19cd8caa5cb2d4da7754eaec910e3bb459552e2eee76a87166ae8ad3c40132fa6c3b2524c8dd503d62a5317d

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## 5.2.0 (2026-01-22)
+
+Full Changelog: [v5.1.0...v5.2.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.1.0...v5.2.0)
+
+### Features
+
+* **api:** manual updates ([03e0903](https://github.com/team-telnyx/telnyx-ruby/commit/03e0903a5ee879e38eebd81885956728a4506a84))
+
+## 5.1.0 (2026-01-22)
+
+Full Changelog: [v5.0.0...v5.1.0](https://github.com/team-telnyx/telnyx-ruby/compare/v5.0.0...v5.1.0)
+
+### Features
+
+* Add AI Assistant spec updates for FE tickets ([80b0583](https://github.com/team-telnyx/telnyx-ruby/commit/80b05831a12d362f5a84164f50814158d5d7c925))
+* Add Post /v2/calls/:call_control_id/actions/ai_assistant_add_messages ([8acb311](https://github.com/team-telnyx/telnyx-ruby/commit/8acb311d61248c2c30c4217fd0849e0fa9942b4c))
+* Add widget_settings to AI Assistant and import_ids to ImportAssistant… ([e929796](https://github.com/team-telnyx/telnyx-ruby/commit/e929796431b12a5903b6bfee564dcbe2ac6d3870))
+* **api:** fix default pagination by correctly using nested params ([3dda244](https://github.com/team-telnyx/telnyx-ruby/commit/3dda2443cc36885712872db57d1162d9496014ab))
+* **api:** manual updates ([c92c83a](https://github.com/team-telnyx/telnyx-ruby/commit/c92c83ad09b5ff5baccd02523eec7580acf5fa39))
+* Deploy dev/mc vady wip ([e1a1d64](https://github.com/team-telnyx/telnyx-ruby/commit/e1a1d64640c80c78817f973b9d9296d3c557b9ee))
+* fix links ([a15ee78](https://github.com/team-telnyx/telnyx-ruby/commit/a15ee783cd9eecb3f0b6bbe2508179430f8860ea))
+* fix-external-connection-link ([9a8b302](https://github.com/team-telnyx/telnyx-ruby/commit/9a8b30277f6bf0b4da26c6f2f31e433574a3a0f4))
+* fix-redocly-lint-issues ([9dc1212](https://github.com/team-telnyx/telnyx-ruby/commit/9dc1212679047dcedb14fe14dd4ec541e50002e4))
+* jira-engdesk-48800 add organizations-related docs to the external api… ([099ca64](https://github.com/team-telnyx/telnyx-ruby/commit/099ca6447d362d9a0441370262b8f930ac02fb8b))
+* MSG-6148: adding the new campaignVerifyAuthorizationToken field and missing GET OTP endpoint ([17f13ce](https://github.com/team-telnyx/telnyx-ruby/commit/17f13ce8be76bd68d2bf834f221c082a04bd29b5))
+* MSG-6228: MSG-6228: Add smart_encoding option for SMS character encoding optimization ([efa6530](https://github.com/team-telnyx/telnyx-ruby/commit/efa6530165d00916ba68643ba30a2ff48bf83465))
+* TELAPPS Add GET /texml/Accounts/{account_sid}/Queues endpoint ([2f7d693](https://github.com/team-telnyx/telnyx-ruby/commit/2f7d6930b98d44cc3b02c8168a5585c502e1cc7e))
+* TELAPPS-5507: Add Krisp engine description for noise suppression ([3fe5e71](https://github.com/team-telnyx/telnyx-ruby/commit/3fe5e71c68a8f43e55f966e5df691ad015892be6))
+* TELAPPS-ENGDESK-47967 Add black_threshold parameter to send_fax request ([e6152a2](https://github.com/team-telnyx/telnyx-ruby/commit/e6152a25c31010e0b6b9af02d98228e3d1d79c30))
+* TELAPPS-ENGDESK-48790 Remove duplicated webhooks ([11dbee7](https://github.com/team-telnyx/telnyx-ruby/commit/11dbee7731fab28f02d2375da256a78cb1db39b3))
+* Update voicemail_detection description with AMD enablement info ([0d8eef6](https://github.com/team-telnyx/telnyx-ruby/commit/0d8eef61fd3debe1a578fa81db5bd1fb2fe8c784))
+
+
+### Bug Fixes
+
+* **client:** remove duplicate -require_relative imports ([fd31509](https://github.com/team-telnyx/telnyx-ruby/commit/fd31509ee0064f599cf90c47508fb73a847b34c7))
+* correct broken link to List SIM Card Actions endpoint in SIM car… ([11e98c5](https://github.com/team-telnyx/telnyx-ruby/commit/11e98c566659d431c2e667b02698c0f325b46fce))
+* **internal:** increase timeout for linting in ci ([b33ad1f](https://github.com/team-telnyx/telnyx-ruby/commit/b33ad1f0272f15b84f99221f85e00f2225c512d2))
+* update broken MDR report link in GetMessage endpoint ([9f3c6df](https://github.com/team-telnyx/telnyx-ruby/commit/9f3c6df9d02eff35967f5a22eb43e4b1195b0c50))
+
+
+### Chores
+
+* fix typo in descriptions ([5cd205d](https://github.com/team-telnyx/telnyx-ruby/commit/5cd205d01f84ca4429e5ddd20ef09a5c3c7708e5))
+* **internal:** update `actions/checkout` version ([1825922](https://github.com/team-telnyx/telnyx-ruby/commit/1825922bb5de09c2f47df83d1ff47ba94cd4dc16))
+
 ## 5.0.0 (2026-01-09)
 
 Full Changelog: [v4.4.0...v5.0.0](https://github.com/team-telnyx/telnyx-ruby/compare/v4.4.0...v5.0.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.0.0"
+gem "telnyx", "~> 5.2.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/telnyx/client.rb

@@ -477,6 +477,9 @@ module Telnyx
     # @return [Telnyx::Resources::SpeechToText]
     attr_reader :speech_to_text
 
+    # @return [Telnyx::Resources::Organizations]
+    attr_reader :organizations
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -728,6 +731,7 @@ module Telnyx
       @mobile_voice_connections = Telnyx::Resources::MobileVoiceConnections.new(client: self)
       @messaging_10dlc = Telnyx::Resources::Messaging10dlc.new(client: self)
       @speech_to_text = Telnyx::Resources::SpeechToText.new(client: self)
+      @organizations = Telnyx::Resources::Organizations.new(client: self)
     end
   end
 end

data/lib/telnyx/internal/type/union.rb

@@ -8,7 +8,7 @@ module Telnyx
       # @example
       #   # `assistant_tool` is a `Telnyx::AI::AssistantTool`
       #   case assistant_tool
-      #   when Telnyx::AI::WebhookTool
+      #   when Telnyx::AI::AssistantTool::Webhook
       #     puts(assistant_tool.type)
       #   when Telnyx::AI::RetrievalTool
       #     puts(assistant_tool.retrieval)

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

@@ -29,7 +29,7 @@ module Telnyx
         # @!attribute tools
         #   The tools that the voice assistant can use.
         #
-        #   @return [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::RetrievalTool>, nil]
+        #   @return [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval>, nil]
         optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::Assistant::Tool] }
 
         # @!method initialize(instructions: nil, model: nil, openai_api_key_ref: nil, tools: nil)
@@ -44,7 +44,7 @@ module Telnyx
         #
         #   @param openai_api_key_ref [String] This is necessary only if the model selected is from OpenAI. You would pass the
         #
-        #   @param tools [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::RetrievalTool>] The tools that the voice assistant can use.
+        #   @param tools [Array<Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval>] The tools that the voice assistant can use.
 
         module Tool
           extend Telnyx::Internal::Type::Union
@@ -61,7 +61,7 @@ module Telnyx
 
           variant :transfer, -> { Telnyx::AI::TransferTool }
 
-          variant :retrieval, -> { Telnyx::AI::RetrievalTool }
+          variant :retrieval, -> { Telnyx::AI::Assistant::Tool::Retrieval }
 
           class BookAppointment < Telnyx::Internal::Type::BaseModel
             # @!attribute book_appointment
@@ -171,8 +171,43 @@ module Telnyx
             end
           end
 
+          class Retrieval < Telnyx::Internal::Type::BaseModel
+            # @!attribute retrieval
+            #
+            #   @return [Telnyx::Models::AI::Assistant::Tool::Retrieval::Retrieval]
+            required :retrieval, -> { Telnyx::AI::Assistant::Tool::Retrieval::Retrieval }
+
+            # @!attribute type
+            #
+            #   @return [Symbol, :retrieval]
+            required :type, const: :retrieval
+
+            # @!method initialize(retrieval:, type: :retrieval)
+            #   @param retrieval [Telnyx::Models::AI::Assistant::Tool::Retrieval::Retrieval]
+            #   @param type [Symbol, :retrieval]
+
+            # @see Telnyx::Models::AI::Assistant::Tool::Retrieval#retrieval
+            class Retrieval < Telnyx::Internal::Type::BaseModel
+              # @!attribute bucket_ids
+              #
+              #   @return [Array<String>]
+              required :bucket_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute max_num_results
+              #   The maximum number of results to retrieve as context for the language model.
+              #
+              #   @return [Integer, nil]
+              optional :max_num_results, Integer
+
+              # @!method initialize(bucket_ids:, max_num_results: nil)
+              #   @param bucket_ids [Array<String>]
+              #
+              #   @param max_num_results [Integer] The maximum number of results to retrieve as context for the language model.
+            end
+          end
+
           # @!method self.variants
-          #   @return [Array(Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::RetrievalTool)]
+          #   @return [Array(Telnyx::Models::AI::Assistant::Tool::BookAppointment, Telnyx::Models::AI::Assistant::Tool::CheckAvailability, Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::Assistant::Tool::Retrieval)]
         end
       end
     end

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

@@ -17,7 +17,7 @@ module Telnyx
 
         # @!attribute model
         #   ID of the model to use. You can use the
-        #   [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
+        #   [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
         #   to see all of your available models,
         #
         #   @return [String]
@@ -56,7 +56,10 @@ module Telnyx
         # @!attribute greeting
         #   Text that the assistant will use to start the conversation. This may be
         #   templated with
-        #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
+        #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
+        #   Use an empty string to have the assistant wait for the user to speak first. Use
+        #   the special value `<assistant-speaks-first-with-model-generated-message>` to
+        #   have the assistant generate the greeting based on the system instructions.
         #
         #   @return [String, nil]
         optional :greeting, String
@@ -69,7 +72,7 @@ module Telnyx
         # @!attribute llm_api_key_ref
         #   This is only needed when using third-party inference providers. The `identifier`
         #   for an integration secret
-        #   [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+        #   [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
         #   that refers to your LLM provider's API key. Warning: Free plans are unlikely to
         #   work with this integration.
         #
@@ -95,7 +98,7 @@ module Telnyx
         #   The tools that the assistant can use. These may be templated with
         #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
         #
-        #   @return [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
+        #   @return [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>, nil]
         optional :tools, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }
 
         # @!attribute transcription
@@ -108,7 +111,13 @@ module Telnyx
         #   @return [Telnyx::Models::AI::VoiceSettings, nil]
         optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
 
-        # @!method initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, request_options: {})
+        # @!attribute widget_settings
+        #   Configuration settings for the assistant's web widget.
+        #
+        #   @return [Telnyx::Models::AI::WidgetSettings, nil]
+        optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
+
+        # @!method initialize(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, privacy_settings: nil, telephony_settings: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AssistantCreateParams} for more details.
         #
@@ -138,12 +147,14 @@ module Telnyx
         #
         #   @param telephony_settings [Telnyx::Models::AI::TelephonySettings]
         #
-        #   @param tools [Array<Telnyx::Models::AI::WebhookTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::TransferTool, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
+        #   @param tools [Array<Telnyx::Models::AI::AssistantTool::Webhook, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage>] The tools that the assistant can use. These may be templated with [dynamic varia
         #
         #   @param transcription [Telnyx::Models::AI::TranscriptionSettings]
         #
         #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
         #
+        #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

@@ -22,7 +22,14 @@ module Telnyx
         #   @return [Symbol, Telnyx::Models::AI::AssistantImportsParams::Provider]
         required :provider, enum: -> { Telnyx::AI::AssistantImportsParams::Provider }
 
-        # @!method initialize(api_key_ref:, provider:, request_options: {})
+        # @!attribute import_ids
+        #   Optional list of assistant IDs to import from the external provider. If not
+        #   provided, all assistants will be imported.
+        #
+        #   @return [Array<String>, nil]
+        optional :import_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(api_key_ref:, provider:, import_ids: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::AssistantImportsParams} for more details.
         #
@@ -30,6 +37,8 @@ module Telnyx
         #
         #   @param provider [Symbol, Telnyx::Models::AI::AssistantImportsParams::Provider] The external provider to import assistants from.
         #
+        #   @param import_ids [Array<String>] Optional list of assistant IDs to import from the external provider. If not prov
+        #
         #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
         # The external provider to import assistants from.