telnyx 5.158.0 → 5.160.0

data/lib/telnyx/resources/ai/tools.rb

@@ -5,20 +5,32 @@ module Telnyx
     class AI
       # Configure AI assistant specifications
       class Tools
-        # Create Tool
+        # Create a new custom AI tool that can be attached to AI assistants.
         #
-        # @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
+        # @overload create(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, update_dynamic_variables: nil, webhook: nil, request_options: {})
         #
         # @param display_name [String]
+        #
         # @param type [String]
+        #
         # @param client_side_tool [Hash{Symbol=>Object}]
+        #
         # @param function [Hash{Symbol=>Object}]
+        #
         # @param handoff [Hash{Symbol=>Object}]
+        #
         # @param invite [Hash{Symbol=>Object}]
+        #
         # @param pay [Telnyx::Models::AI::PayToolParams]
+        #
         # @param retrieval [Hash{Symbol=>Object}]
+        #
         # @param timeout_ms [Integer]
+        #
+        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
+        #
         # @param webhook [Hash{Symbol=>Object}]
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::AI::SharedToolResponse]
@@ -35,7 +47,7 @@ module Telnyx
           )
         end
 
-        # Get Tool
+        # Retrieve the details of a specific AI tool.
         #
         # @overload retrieve(tool_id, request_options: {})
         #
@@ -55,9 +67,9 @@ module Telnyx
           )
         end
 
-        # Update Tool
+        # Update the configuration of an existing AI tool.
         #
-        # @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
+        # @overload update(tool_id, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, update_dynamic_variables: nil, webhook: nil, request_options: {})
         #
         # @param tool_id [String] Unique identifier of the tool.
         #
@@ -79,6 +91,8 @@ module Telnyx
         #
         # @param type [String]
         #
+        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
+        #
         # @param webhook [Hash{Symbol=>Object}]
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -97,7 +111,7 @@ module Telnyx
           )
         end
 
-        # List Tools
+        # Retrieve a list of the custom AI tools configured on your account.
         #
         # @overload list(filter_name: nil, filter_type: nil, page_number: nil, page_size: nil, request_options: {})
         #
@@ -132,7 +146,7 @@ module Telnyx
           )
         end
 
-        # Delete Tool
+        # Delete a custom AI tool.
         #
         # @overload delete(tool_id, request_options: {})
         #

data/lib/telnyx/resources/ai.rb

@@ -17,6 +17,11 @@ module Telnyx
       # @return [Telnyx::Resources::AI::Clusters]
       attr_reader :clusters
 
+      # Create and manage logical collections of your Telnyx data, tune retrieval
+      # settings, manage sources, and run collection-scoped semantic search.
+      # @return [Telnyx::Resources::AI::Collections]
+      attr_reader :collections
+
       # Manage historical AI assistant conversations
       # @return [Telnyx::Resources::AI::Conversations]
       attr_reader :conversations
@@ -94,13 +99,11 @@ module Telnyx
       #
       # **Examples:**
       #
-      # ```
-      # GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10
-      # GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5
-      # GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z
-      # GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU
-      # GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en
-      # ```
+      # - `GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10`
+      # - `GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5`
+      # - `GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z`
+      # - `GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU`
+      # - `GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en`
       #
       # @overload retrieve_conversation_histories(q:, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
       #
@@ -203,6 +206,7 @@ module Telnyx
         @audio = Telnyx::Resources::AI::Audio.new(client: client)
         @chat = Telnyx::Resources::AI::Chat.new(client: client)
         @clusters = Telnyx::Resources::AI::Clusters.new(client: client)
+        @collections = Telnyx::Resources::AI::Collections.new(client: client)
         @conversations = Telnyx::Resources::AI::Conversations.new(client: client)
         @embeddings = Telnyx::Resources::AI::Embeddings.new(client: client)
         @fine_tuning = Telnyx::Resources::AI::FineTuning.new(client: client)

data/lib/telnyx/resources/available_phone_number_blocks.rb

@@ -7,7 +7,9 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AvailablePhoneNumberBlockListParams} for more details.
       #
-      # List available phone number blocks
+      # Searches the Telnyx inventory for available contiguous phone-number blocks.
+      # Results can be filtered by locality, country, national destination code, and
+      # number type.
       #
       # @overload list(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/available_phone_numbers.rb

@@ -7,7 +7,10 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AvailablePhoneNumberListParams} for more details.
       #
-      # List available phone numbers
+      # Searches the Telnyx inventory for available phone numbers. Filters support
+      # number patterns, location, number type, features, reservability, and other
+      # inventory constraints; the response includes matching numbers and search
+      # metadata.
       #
       # @overload list(filter: nil, request_options: {})
       #

data/lib/telnyx/resources/balance.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing operations
     class Balance
-      # Get user balance details
+      # Retrieve the current balance, available credit, and credit limit for your
+      # account.
       #
       # @overload retrieve(request_options: {})
       #

data/lib/telnyx/resources/billing_groups.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Billing groups operations
     class BillingGroups
-      # Create a billing group
+      # Create a new billing group, which can be used to organize resources for billing
+      # purposes.
       #
       # @overload create(name: nil, request_options: {})
       #
@@ -26,7 +27,7 @@ module Telnyx
         )
       end
 
-      # Get a billing group
+      # Retrieve the details of a specific billing group.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -46,7 +47,7 @@ module Telnyx
         )
       end
 
-      # Update a billing group
+      # Update the properties of an existing billing group.
       #
       # @overload update(id, name: nil, request_options: {})
       #
@@ -70,7 +71,7 @@ module Telnyx
         )
       end
 
-      # List all billing groups
+      # Retrieve a paginated list of billing groups on your account.
       #
       # @overload list(page_number: nil, page_size: nil, request_options: {})
       #
@@ -94,7 +95,7 @@ module Telnyx
         )
       end
 
-      # Delete a billing group
+      # Delete a billing group from your account.
       #
       # @overload delete(id, request_options: {})
       #

data/lib/telnyx/resources/calls/actions.rb

@@ -10,7 +10,7 @@ module Telnyx
         #
         # Add messages to the conversation started by an AI assistant on the call.
         #
-        # @overload add_ai_assistant_messages(call_control_id, client_state: nil, command_id: nil, messages: nil, request_options: {})
+        # @overload add_ai_assistant_messages(call_control_id, client_state: nil, command_id: nil, messages: nil, trigger_response: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -20,6 +20,8 @@ module Telnyx
         #
         # @param messages [Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>] The messages to add to the conversation.
         #
+        # @param trigger_response [Boolean] When `true`, the injected messages immediately trigger an assistant response/tur
+        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::Calls::ActionAddAIAssistantMessagesResponse]
@@ -634,6 +636,85 @@ module Telnyx
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::Calls::ActionPayParams} for more details.
+        #
+        # Collect payment details from the caller using DTMF and either charge or tokenize
+        # the payment method through a configured Pay connector. Pay pauses active call
+        # recordings while sensitive payment details are collected.
+        #
+        # When `payment_token` is supplied, the DTMF collection steps are skipped and the
+        # existing token is sent to the connector.
+        #
+        # **Expected Webhooks:**
+        #
+        # - `call.payment.progress`
+        # - `call.payment.completed`
+        #
+        # **Test mode card numbers:** `4111111111111111` (Visa), `5555555555554444`
+        # (Mastercard), `378282246310005` (American Express), `6011111111111117`
+        # (Discover), `3065930009020004` (Diners Club), `3566002020360505` (JCB),
+        # `6200000000000005` (UnionPay), and `6771798021000008` (Maestro). Test-mode
+        # connectors reject other card numbers before contacting the configured processor.
+        # The UnionPay and Maestro numbers are accepted for processor testing, but Pay
+        # currently does not emit a card type for them.
+        #
+        # @overload pay(call_control_id, amount: nil, client_state: nil, command_id: nil, connector_name: nil, currency: nil, description: nil, inter_digit_timeout_millis: nil, language: nil, max_attempts: nil, metadata: nil, parameters: nil, payment_method: nil, payment_token: nil, prompts: nil, service_level: nil, timeout_millis: nil, transaction_type: nil, voice: nil, request_options: {})
+        #
+        # @param call_control_id [String] Unique identifier and token for controlling the call
+        #
+        # @param amount [Float] Amount to charge. Required when `transaction_type` is `charge`.
+        #
+        # @param client_state [String] Base64-encoded state included in subsequent webhooks.
+        #
+        # @param command_id [String] Idempotency key for the command. Telnyx ignores a duplicate command with the sam
+        #
+        # @param connector_name [String] Name of the Pay connector used to process the transaction.
+        #
+        # @param currency [Symbol, Telnyx::Models::Calls::ActionPayParams::Currency] Currency used for the transaction. Pay currently supports USD only.
+        #
+        # @param description [String] Optional description forwarded with the payment transaction.
+        #
+        # @param inter_digit_timeout_millis [Integer] Time in milliseconds to wait between consecutive DTMF digits.
+        #
+        # @param language [String] Language used for payment prompts.
+        #
+        # @param max_attempts [Integer] Maximum number of attempts for each payment collection step.
+        #
+        # @param metadata [Hash{Symbol=>Object}] Metadata forwarded to the Pay connector.
+        #
+        # @param parameters [Hash{Symbol=>Object}] Additional parameters forwarded to the Pay connector.
+        #
+        # @param payment_method [Symbol, Telnyx::Models::Calls::ActionPayParams::PaymentMethod] Payment method to collect.
+        #
+        # @param payment_token [String] Existing payment token. When supplied, payment-detail collection is skipped.
+        #
+        # @param prompts [Telnyx::Models::Calls::ActionPayParams::Prompts] Custom text-to-speech prompts keyed by payment collection step.
+        #
+        # @param service_level [String] Speech synthesis service level used for payment prompts. Pay defaults to `premiu
+        #
+        # @param timeout_millis [Integer] Time in milliseconds to wait for DTMF input for each collection step.
+        #
+        # @param transaction_type [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType] Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is absen
+        #
+        # @param voice [String] Voice used for payment prompts. Accepts `male`, `female`, or a provider voice in
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::Calls::ActionPayResponse]
+        #
+        # @see Telnyx::Models::Calls::ActionPayParams
+        def pay(call_control_id, params = {})
+          parsed, options = Telnyx::Calls::ActionPayParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["calls/%1$s/actions/pay", call_control_id],
+            body: parsed,
+            model: Telnyx::Models::Calls::ActionPayResponse,
+            options: options
+          )
+        end
+
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionReferParams} for more details.
         #
@@ -890,7 +971,7 @@ module Telnyx
         # - `call.conversation.ended`
         # - `call.conversation_insights.generated`
         #
-        # @overload start_ai_assistant(call_control_id, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
+        # @overload start_ai_assistant(call_control_id, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -912,10 +993,6 @@ module Telnyx
         #
         # @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
         #
-        # @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
-        #
-        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
-        #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Telnyx::Models::Calls::ActionStartAIAssistantResponse]
@@ -1060,7 +1137,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStartNoiseSuppressionParams} for more details.
         #
-        # Noise Suppression Start (BETA)
+        # Start noise suppression on an active call to reduce background noise. This
+        # feature is currently in beta.
         #
         # @overload start_noise_suppression(call_control_id, client_state: nil, command_id: nil, direction: nil, noise_suppression_engine: nil, noise_suppression_engine_config: nil, request_options: {})
         #
@@ -1339,7 +1417,7 @@ module Telnyx
         #
         # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
         #
-        # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
+        # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Humain, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngineConfig::Reson8, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
         #
         # @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
         #
@@ -1488,7 +1566,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStopNoiseSuppressionParams} for more details.
         #
-        # Noise Suppression Stop (BETA)
+        # Stop noise suppression previously started on an active call. This feature is
+        # currently in beta.
         #
         # @overload stop_noise_suppression(call_control_id, client_state: nil, command_id: nil, request_options: {})
         #
@@ -1733,7 +1812,7 @@ module Telnyx
         # - `call.machine.premium.greeting.ended` if `answering_machine_detection=premium`
         #   was requested and a beep was detected
         #
-        # @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
+        # @overload transfer(call_control_id, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, audio_url: nil, client_state: nil, command_id: nil, custom_headers: nil, early_media: nil, from: nil, from_display_name: nil, media_encryption: nil, media_name: nil, mute_dtmf: nil, park_after_unbridge: nil, preferred_codecs: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, route_to_mobile: nil, send_digits_on_answer: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, target_leg_client_state: nil, time_limit_secs: nil, timeout_secs: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -1785,6 +1864,8 @@ module Telnyx
         #
         # @param record_trim [Symbol, Telnyx::Models::Calls::ActionTransferParams::RecordTrim] When set to `trim-silence`, silence will be removed from the beginning and end o
         #
+        # @param route_to_mobile [Boolean] When set to true, routes the call directly to the mobile device associated with
+        #
         # @param send_digits_on_answer [String] DTMF digits to send automatically after the transfer destination answers. Useful
         #
         # @param sip_auth_password [String] SIP Authentication password used for SIP challenges.

data/lib/telnyx/resources/calls.rb

@@ -35,7 +35,7 @@ module Telnyx
       # When the `record` parameter is set to `record-from-answer`, the response will
       # include a `recording_id` field.
       #
-      # @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, retry_on_timeout: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
+      # @overload dial(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, retry_on_timeout: nil, route_to_mobile: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
       #
       # @param connection_id [String] The ID of the Call Control App (formerly ID of the connection) to be used when d
       #
@@ -107,6 +107,8 @@ module Telnyx
       #
       # @param retry_on_timeout [Boolean] Whether to keep trying the remaining routing paths (e.g. alternate providers/gat
       #
+      # @param route_to_mobile [Boolean] When set to true, routes the call directly to the mobile device associated with
+      #
       # @param send_digits_on_answer [String] DTMF digits to send automatically after the called party answers. Useful for rea
       #
       # @param send_silence_when_idle [Boolean] Generate silence RTP packets when no transmission available.

data/lib/telnyx/resources/comments.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Number orders
     class Comments
-      # Create a comment
+      # Creates a comment associated with a supported number-order record. The response
+      # contains the created comment.
       #
       # @overload create(body: nil, comment_record_id: nil, comment_record_type: nil, request_options: {})
       #
@@ -27,7 +28,8 @@ module Telnyx
         )
       end
 
-      # Retrieve a comment
+      # Returns the comment identified by `id`, including its associated record and
+      # comment metadata.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -50,7 +52,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::CommentListParams} for more details.
       #
-      # Retrieve all comments
+      # Returns comments associated with number-order records. Results can be filtered
+      # by record type and record ID and include pagination metadata.
       #
       # @overload list(filter: nil, request_options: {})
       #
@@ -73,7 +76,8 @@ module Telnyx
         )
       end
 
-      # Mark a comment as read
+      # Marks the specified comment as read. The response contains the updated read
+      # state for the comment.
       #
       # @overload mark_as_read(id, request_options: {})
       #

data/lib/telnyx/resources/credential_connections.rb

@@ -106,7 +106,7 @@ module Telnyx
       #
       # Updates settings of an existing credential connection.
       #
-      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
+      # @overload update(id, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: nil, connection_name: nil, conversation_persistence: nil, default_on_hold_comfort_noise_enabled: nil, dtmf_type: nil, encode_contact_header_enabled: nil, encrypted_media: nil, inbound: nil, ios_push_credential_id: nil, jitter_buffer: nil, noise_suppression: nil, noise_suppression_details: nil, onnet_t38_passthrough_enabled: nil, outbound: nil, password: nil, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, user_name: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
       # @param id [String] Identifies the resource.
       #
@@ -120,6 +120,8 @@ module Telnyx
       #
       # @param connection_name [String] A user-assigned name to help manage the connection.
       #
+      # @param conversation_persistence [Boolean] Whether conversation persistence is enabled for this connection. When enabled, c
+      #
       # @param default_on_hold_comfort_noise_enabled [Boolean] When enabled, Telnyx will generate comfort noise when you place the call on hold
       #
       # @param dtmf_type [Symbol, Telnyx::Models::DtmfType] Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF

data/lib/telnyx/resources/custom_storage_credentials.rb

@@ -15,7 +15,7 @@ module Telnyx
       #
       # @param backend [Symbol, Telnyx::Models::CustomStorageConfiguration::Backend]
       #
-      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::AzureConfigurationData]
+      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::CustomStorageConfiguration::Configuration::S3Generic, Telnyx::Models::AzureConfigurationData]
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -67,7 +67,7 @@ module Telnyx
       #
       # @param backend [Symbol, Telnyx::Models::CustomStorageConfiguration::Backend]
       #
-      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::AzureConfigurationData]
+      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::CustomStorageConfiguration::Configuration::S3Generic, Telnyx::Models::AzureConfigurationData]
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/dir/references.rb

@@ -16,15 +16,35 @@ module Telnyx
         # endpoint). Until it is, this returns `409` and no references are stored.
         #
         # The request body carries exactly two business references plus one financial
-        # reference. On success the references are stored and the response echoes them in
-        # the same shape as the GET. Submitting again converges on the already-stored
-        # references rather than erroring.
+        # reference. The first submission stores them and returns `201`. Resubmitting
+        # returns `200`: identical values are simply confirmed and nothing is written,
+        # while changed values replace those references.
+        #
+        # Replacing a reference is allowed only while the DIR itself is still editable,
+        # the same window in which a single reference may be updated; once the DIR has
+        # been submitted for vetting this returns `400`. A replaced reference's pending
+        # verification call is cancelled and its dial-in code stops working, and the
+        # replacement contact is emailed fresh scheduling details. References whose
+        # details did not change keep their existing call, code, and the notice already
+        # sent to them.
+        #
+        # The response always echoes the stored references in the same shape as the GET.
+        #
+        # Who qualifies: the two business references confirm the company's reputation and
+        # operations. Each should be a senior contact at an organization the business
+        # works with, such as a vendor, partner, or client: a C-suite executive (CEO, CFO,
+        # CTO, COO), an owner or founder as reflected in the company's corporate records,
+        # or a senior manager, director, or executive. The financial reference confirms
+        # the company pays its bills and should be a licensed certified public accountant
+        # (CPA) the company uses, a contact at a bank or financial institution that has a
+        # relationship with the company, or a reasonable alternative banking or financial
+        # reference.
         #
         # @overload create(dir_id, business_references:, financial_reference:, request_options: {})
         #
         # @param dir_id [String] The DIR id. Lowercase UUID.
         #
-        # @param business_references [Array<Telnyx::Models::Dir::ReferenceInput>] Exactly two business references.
+        # @param business_references [Array<Telnyx::Models::Dir::ReferenceInput>] Exactly two business references. Array order determines each one's slot: the fir
         #
         # @param financial_reference [Telnyx::Models::Dir::ReferenceInput] One reference supplied at submit. The reference type is implied by the field tha
         #
@@ -58,7 +78,7 @@ module Telnyx
         #
         # @overload update(slot, dir_id:, ref_type:, email: nil, full_name: nil, job_title: nil, organization: nil, phone_e164: nil, relationship_to_registrant: nil, timezone: nil, request_options: {})
         #
-        # @param slot [Integer] Path param: Reference slot. Business references use slots 0 and 1; the financial
+        # @param slot [Integer] Path param: Reference slot, counting from 1. Business references are slots 1 and
         #
         # @param dir_id [String] Path param: The DIR id. Lowercase UUID.
         #
@@ -104,10 +124,12 @@ module Telnyx
 
         # List the business and financial references submitted for a DIR.
         #
-        # Returns the two business references (slots 0 and 1) followed by the single
-        # financial reference. Each entry carries only the customer-supplied details
-        # (name, title, organization, relationship, phone, email, timezone). Returns an
-        # empty list when no references were submitted.
+        # Returns the two business references (slots 1 and 2) followed by the single
+        # financial reference. Each entry carries its `ref_type` and `slot`, which
+        # together address the reference when updating it, alongside the details supplied
+        # when it was submitted (name, title, organization, relationship, phone, email,
+        # timezone). No internal identifiers are exposed. Returns an empty list when no
+        # references were submitted.
         #
         # @overload list(dir_id, request_options: {})
         #

data/lib/telnyx/resources/dir.rb

@@ -288,8 +288,9 @@ module Telnyx
       # numbers flip back to `submitted`. When re-submitting from `verified`, the
       # existing registration stays live throughout the new vetting cycle.
       #
-      # Returns `400` from `submitted`/`in_review`/`permanently_rejected`. Returns `409`
-      # if the DIR has an unresolved infringement claim.
+      # Returns `400` from `submitted`/`in_review`/`permanently_rejected`. Returns `400`
+      # if the DIR's business and financial references have not been submitted. Returns
+      # `409` if the DIR has an unresolved infringement claim.
       #
       # @overload submit(dir_id, request_options: {})
       #

data/lib/telnyx/resources/email_blocks/import.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class EmailBlocks
+      # Async CSV import of competitor suppression lists.
+      class Import
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::EmailBlocks::ImportCreateParams} for more details.
+        #
+        # Accepts `multipart/form-data` with a `file` field (the CSV) and an optional
+        # `block_ttl_days` (integer >0, default 30). Validates:
+        #
+        # - content ≤ 25 MiB, else `413`
+        # - row count ≤ 250 000, else `413`
+        # - header-only / all-blank / undetectable provider → `400` Returns `202` with the
+        #   import record (status `pending`); an Oban worker (`EmailBlockImportWorker`,
+        #   max_attempts 3) transitions `pending → processing → completed | failed`.
+        #   `block_ttl_days` applies only to imported `manual_block` rows; other reasons
+        #   get `expires_at: nil`. Provider is auto-detected from the CSV header
+        #   (`sendgrid` / `mailgun` / `ses` / `generic`).
+        #
+        # @overload create(file:, block_ttl_days: nil, request_options: {})
+        #
+        # @param file [Pathname, StringIO, IO, String, Telnyx::FilePart] The CSV file (Plug.Upload). Missing/non-upload → 400.
+        #
+        # @param block_ttl_days [Integer] TTL for imported `manual_block` rows; other reasons get `expires_at: null`. Inva
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailBlocks::EmailBlockImportResponse]
+        #
+        # @see Telnyx::Models::EmailBlocks::ImportCreateParams
+        def create(params)
+          parsed, options = Telnyx::EmailBlocks::ImportCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "email_blocks/import",
+            headers: {"content-type" => "multipart/form-data"},
+            body: parsed,
+            model: Telnyx::EmailBlocks::EmailBlockImportResponse,
+            options: options
+          )
+        end
+
+        # Account-scoped fetch (cross-account → 404; malformed UUID → 404). Nullable
+        # fields are omitted until terminal: `provider`/`completed_at` when nil;
+        # `processed_rows`/`created_count`/`existing_count`/ `skipped_count`/`error_count`
+        # only when `status == completed`; `errors` only when non-empty; `failure_reason`
+        # only on terminal failure.
+        #
+        # @overload retrieve(id, request_options: {})
+        #
+        # @param id [String] Resource UUID. Malformed UUIDs are treated as not-found (not 400).
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::EmailBlocks::EmailBlockImportResponse]
+        #
+        # @see Telnyx::Models::EmailBlocks::ImportRetrieveParams
+        def retrieve(id, params = {})
+          @client.request(
+            method: :get,
+            path: ["email_blocks/import/%1$s", id],
+            model: Telnyx::EmailBlocks::EmailBlockImportResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end