telnyx 5.162.0 → 5.164.0

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

@@ -16,7 +16,8 @@ module Telnyx
         # @return [Telnyx::Resources::AI::Missions::Tools]
         attr_reader :tools
 
-        # Create a new mission definition
+        # Creates a new mission definition from the provided configuration and returns the
+        # created mission. Execute the mission by starting runs against it.
         #
         # @overload create(name:, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, request_options: {})
         #
@@ -62,7 +63,9 @@ module Telnyx
           )
         end
 
-        # List all missions for the organization
+        # Returns a paginated list of all mission definitions in your organization.
+        # Missions describe a goal and the tools, knowledge bases, and MCP servers agents
+        # may use to accomplish it.
         #
         # @overload list(page_number: nil, page_size: nil, request_options: {})
         #
@@ -88,7 +91,8 @@ module Telnyx
           )
         end
 
-        # Clone an existing mission
+        # Creates a copy of the specified mission as a new mission definition, so you can
+        # iterate on its configuration without modifying the original.
         #
         # @overload clone_mission(mission_id, request_options: {})
         #
@@ -108,7 +112,8 @@ module Telnyx
           )
         end
 
-        # Delete a mission
+        # Permanently deletes the specified mission definition and returns no content on
+        # success.
         #
         # @overload delete_mission(mission_id, request_options: {})
         #
@@ -128,7 +133,9 @@ module Telnyx
           )
         end
 
-        # List recent events across all missions
+        # Returns a paginated list of recent events across every mission in your
+        # organization, optionally filtered by event type. Useful for building activity
+        # feeds or monitoring dashboards.
         #
         # @overload list_events(page_number: nil, page_size: nil, type: nil, request_options: {})
         #
@@ -156,7 +163,8 @@ module Telnyx
           )
         end
 
-        # Update a mission definition
+        # Replaces the specified mission's definition with the provided configuration and
+        # returns the updated mission.
         #
         # @overload update_mission(mission_id, description: nil, execution_mode: nil, instructions: nil, metadata: nil, model: nil, name: nil, request_options: {})
         #

data/lib/telnyx/resources/ai/openai/chat.rb

@@ -13,7 +13,7 @@ module Telnyx
           # and may be used with the OpenAI JS or Python SDK by setting the base URL to
           # `https://api.telnyx.com/v2/ai/openai`.
           #
-          # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, model: nil, n: nil, presence_penalty: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
+          # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, response_format: nil, seed: nil, service_tier: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
           #
           # @param messages [Array<Telnyx::Models::AI::ChatCompletionRequest::Message>] A list of the previous chat messages for context.
           #
@@ -47,6 +47,8 @@ module Telnyx
           #
           # @param presence_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
           #
+          # @param reasoning_effort [Symbol, Telnyx::Models::AI::ChatCompletionRequest::ReasoningEffort] Controls the reasoning effort for models that support it. When set, the model sp
+          #
           # @param response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
           #
           # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su

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

@@ -43,7 +43,7 @@ module Telnyx
         # tag the conversation's source, channel, or user) and later filter by it when
         # listing conversations.
         #
-        # @overload create_response(conversation: nil, input: nil, instructions: nil, model: nil, service_tier: nil, stream: nil, request_options: {})
+        # @overload create_response(conversation: nil, input: nil, instructions: nil, model: nil, reasoning: nil, service_tier: nil, stream: nil, request_options: {})
         #
         # @param conversation [String] Optional Telnyx Conversation ID from `POST /ai/conversations`. When provided, Te
         #
@@ -53,6 +53,8 @@ module Telnyx
         #
         # @param model [String] Model identifier to use for the response, for example `zai-org/GLM-5.1-FP8` or a
         #
+        # @param reasoning [Telnyx::Models::AI::OpenAICreateResponseParams::Reasoning]
+        #
         # @param service_tier [String] The service tier to use for this request. Supported values vary by model; use `G
         #
         # @param stream [Boolean] Set to `true` to stream Server-Sent Events, matching OpenAI's Responses streamin

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

@@ -5,31 +5,36 @@ module Telnyx
     class AI
       # Configure AI assistant specifications
       class Tools
+        # Some parameter documentations has been truncated, see
+        # {Telnyx::Models::AI::ToolCreateParams} for more details.
+        #
         # 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, update_dynamic_variables: 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, idempotency_key: nil, request_options: {})
         #
-        # @param display_name [String]
+        # @param display_name [String] Body param
         #
-        # @param type [String]
+        # @param type [String] Body param
         #
-        # @param client_side_tool [Hash{Symbol=>Object}]
+        # @param client_side_tool [Hash{Symbol=>Object}] Body param
         #
-        # @param function [Hash{Symbol=>Object}]
+        # @param function [Hash{Symbol=>Object}] Body param
         #
-        # @param handoff [Hash{Symbol=>Object}]
+        # @param handoff [Hash{Symbol=>Object}] Body param
         #
-        # @param invite [Hash{Symbol=>Object}]
+        # @param invite [Hash{Symbol=>Object}] Body param
         #
-        # @param pay [Telnyx::Models::AI::PayToolParams]
+        # @param pay [Telnyx::Models::AI::PayToolParams] Body param
         #
-        # @param retrieval [Hash{Symbol=>Object}]
+        # @param retrieval [Hash{Symbol=>Object}] Body param
         #
-        # @param timeout_ms [Integer]
+        # @param timeout_ms [Integer] Body param
         #
-        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Configuration for an update_dynamic_variables tool.
+        # @param update_dynamic_variables [Telnyx::Models::AI::UpdateDynamicVariablesToolParams] Body param: Configuration for an update_dynamic_variables tool.
         #
-        # @param webhook [Hash{Symbol=>Object}]
+        # @param webhook [Hash{Symbol=>Object}] Body param
+        #
+        # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -38,10 +43,12 @@ module Telnyx
         # @see Telnyx::Models::AI::ToolCreateParams
         def create(params)
           parsed, options = Telnyx::AI::ToolCreateParams.dump_request(params)
+          header_params = {idempotency_key: "idempotency-key"}
           @client.request(
             method: :post,
             path: "ai/tools",
-            body: parsed,
+            headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+            body: parsed.except(*header_params.keys),
             model: Telnyx::AI::SharedToolResponse,
             options: options
           )
@@ -146,7 +153,7 @@ module Telnyx
           )
         end
 
-        # Delete a custom AI tool.
+        # Permanently deletes the specified custom AI tool from your account.
         #
         # @overload delete(tool_id, request_options: {})
         #

data/lib/telnyx/resources/ai.rb

@@ -52,6 +52,9 @@ module Telnyx
       # @return [Telnyx::Resources::AI::Anthropic]
       attr_reader :anthropic
 
+      # @return [Telnyx::Resources::AI::Knowledge]
+      attr_reader :knowledge
+
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AIRetrieveConversationHistoriesParams} for more details.
       #
@@ -135,7 +138,7 @@ module Telnyx
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Telnyx::Models::AIRetrieveConversationHistoriesResponse]
+      # @return [Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::AIRetrieveConversationHistoriesResponse>]
       #
       # @see Telnyx::Models::AIRetrieveConversationHistoriesParams
       def retrieve_conversation_histories(params)
@@ -156,11 +159,15 @@ module Telnyx
             page_number: "page[number]",
             page_size: "page[size]"
           ),
+          page: Telnyx::Internal::DefaultFlatPagination,
           model: Telnyx::Models::AIRetrieveConversationHistoriesResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::AISummarizeParams} for more details.
+      #
       # Generate a summary of a file's contents.
       #
       # Supports the following text formats:
@@ -173,13 +180,15 @@ module Telnyx
       # - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm
       # - Up to 100 MB
       #
-      # @overload summarize(bucket:, filename:, system_prompt: nil, request_options: {})
+      # @overload summarize(bucket:, filename:, system_prompt: nil, idempotency_key: nil, request_options: {})
+      #
+      # @param bucket [String] Body param: The name of the bucket that contains the file to be summarized.
       #
-      # @param bucket [String] The name of the bucket that contains the file to be summarized.
+      # @param filename [String] Body param: The name of the file to be summarized.
       #
-      # @param filename [String] The name of the file to be summarized.
+      # @param system_prompt [String] Body param: A system prompt to guide the summary generation.
       #
-      # @param system_prompt [String] A system prompt to guide the summary generation.
+      # @param idempotency_key [String] Header param: Optional opaque, unquoted key for safely retrying the same logical
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -188,10 +197,12 @@ module Telnyx
       # @see Telnyx::Models::AISummarizeParams
       def summarize(params)
         parsed, options = Telnyx::AISummarizeParams.dump_request(params)
+        header_params = {idempotency_key: "idempotency-key"}
         @client.request(
           method: :post,
           path: "ai/summarize",
-          body: parsed,
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
           model: Telnyx::Models::AISummarizeResponse,
           options: options
         )
@@ -216,6 +227,7 @@ module Telnyx
         @openai = Telnyx::Resources::AI::OpenAI.new(client: client)
         @tools = Telnyx::Resources::AI::Tools.new(client: client)
         @anthropic = Telnyx::Resources::AI::Anthropic.new(client: client)
+        @knowledge = Telnyx::Resources::AI::Knowledge.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/authentication_providers.rb

@@ -6,7 +6,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AuthenticationProviderCreateParams} for more details.
       #
-      # Creates an authentication provider.
+      # Creates a new authentication provider for single sign-on, configured from the
+      # provided identity provider details, and returns the created resource.
       #
       # @overload create(name:, settings:, short_name:, active: nil, settings_url: nil, request_options: {})
       #

data/lib/telnyx/resources/bundle_pricing/billing_bundles.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     class BundlePricing
       class BillingBundles
-        # Get a single bundle by ID.
+        # Returns the details of a single billing bundle by its ID, so you can inspect its
+        # contents before purchasing a user bundle.
         #
         # @overload retrieve(bundle_id, authorization_bearer: nil, request_options: {})
         #
@@ -31,7 +32,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::BundlePricing::BillingBundleListParams} for more details.
         #
-        # Get all allowed bundles.
+        # Returns a paginated list of the billing bundles available to your account, with
+        # support for filtering.
         #
         # @overload list(filter: nil, page_number: nil, page_size: nil, authorization_bearer: nil, request_options: {})
         #

data/lib/telnyx/resources/bundle_pricing/user_bundles.rb

@@ -35,7 +35,7 @@ module Telnyx
           )
         end
 
-        # Retrieves a user bundle by its ID.
+        # Returns the details of a single user bundle on your account by its ID.
         #
         # @overload retrieve(user_bundle_id, authorization_bearer: nil, request_options: {})
         #
@@ -62,7 +62,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::BundlePricing::UserBundleListParams} for more details.
         #
-        # Get a paginated list of user bundles.
+        # Returns a paginated list of the bundles active on your account, with support for
+        # filtering.
         #
         # @overload list(filter: nil, page_number: nil, page_size: nil, authorization_bearer: nil, request_options: {})
         #
@@ -94,7 +95,8 @@ module Telnyx
           )
         end
 
-        # Deactivates a user bundle by its ID.
+        # Deactivates the specified user bundle on your account and returns the
+        # deactivated bundle.
         #
         # @overload deactivate(user_bundle_id, authorization_bearer: nil, request_options: {})
         #

data/lib/telnyx/resources/call_control_applications.rb

@@ -7,7 +7,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::CallControlApplicationCreateParams} for more details.
       #
-      # Create a call control application.
+      # Creates a call control application, which defines the webhook endpoints and
+      # settings used to control calls on associated connections.
       #
       # @overload create(application_name:, webhook_event_url:, active: nil, anchorsite_override: nil, call_cost_in_webhooks: nil, dtmf_type: nil, first_command_timeout: nil, first_command_timeout_secs: nil, inbound: nil, outbound: nil, redact_dtmf_debug_logging: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_timeout_secs: nil, request_options: {})
       #
@@ -163,7 +164,8 @@ module Telnyx
         )
       end
 
-      # Deletes a call control application.
+      # Permanently deletes the specified call control application and its webhook
+      # configuration.
       #
       # @overload delete(id, request_options: {})
       #

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

@@ -216,7 +216,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionEnqueueParams} for more details.
         #
-        # Put the call in a queue.
+        # Places the call into a queue, where it waits until it is removed or bridged to
+        # another leg. Queue behavior is configured through the request body.
         #
         # @overload enqueue(call_control_id, queue_name:, client_state: nil, command_id: nil, keep_after_hangup: nil, max_size: nil, max_wait_time_secs: nil, request_options: {})
         #
@@ -351,7 +352,7 @@ module Telnyx
         #
         # @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 voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -484,7 +485,7 @@ module Telnyx
         #
         # @param valid_digits [String] A list of all digits accepted as valid.
         #
-        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -575,7 +576,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionLeaveQueueParams} for more details.
         #
-        # Removes the call from a queue.
+        # Removes the call from the queue it is currently waiting in. The call remains
+        # active and can be directed with further call commands.
         #
         # @overload leave_queue(call_control_id, client_state: nil, command_id: nil, request_options: {})
         #
@@ -659,7 +661,7 @@ module Telnyx
         # 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: {})
+        # @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, valid_card_types: nil, voice: nil, request_options: {})
         #
         # @param call_control_id [String] Unique identifier and token for controlling the call
         #
@@ -697,6 +699,8 @@ module Telnyx
         #
         # @param transaction_type [Symbol, Telnyx::Models::Calls::ActionPayParams::TransactionType] Transaction to perform. If omitted, Pay infers `tokenize` when `amount` is absen
         #
+        # @param valid_card_types [Array<Symbol, Telnyx::Models::Calls::ActionPayParams::ValidCardType>] Restricts accepted card numbers to the listed card types. When the caller enters
+        #
         # @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]
@@ -943,7 +947,7 @@ module Telnyx
         #
         # @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
         #
-        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -989,7 +993,7 @@ module Telnyx
         #
         # @param participants [Array<Telnyx::Models::Calls::AIAssistantJoinParticipant>] A list of participants to add to the conversation when it starts.
         #
-        # @param send_message_history_updates [Boolean] When `true`, a webhook is sent each time the conversation message history is upd
+        # @param send_message_history_updates [Boolean] When `true`, a `call.ai_gather.message_history_updated` webhook carrying the ful
         #
         # @param transcription [Telnyx::Models::Calls::TranscriptionConfig] The settings associated with speech to text for the voice assistant. This is onl
         #
@@ -1072,7 +1076,7 @@ module Telnyx
         #
         # @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::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -1417,7 +1421,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::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_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::TranscriptionEngineHumainConfig, Telnyx::Models::Calls::TranscriptionEngineReson8Config, Telnyx::Models::Calls::TranscriptionEngineCohereConfig, 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
         #
@@ -1440,7 +1444,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStopAIAssistantParams} for more details.
         #
-        # Stop an AI assistant on the call.
+        # Stops the AI assistant currently engaged on the call. The call remains active
+        # and can continue with other call control commands.
         #
         # @overload stop_ai_assistant(call_control_id, client_state: nil, command_id: nil, request_options: {})
         #
@@ -1736,7 +1741,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionStopTranscriptionParams} for more details.
         #
-        # Stop real-time transcription.
+        # Stops real-time transcription on the call. Transcription webhooks cease once the
+        # command takes effect; the call itself is unaffected.
         #
         # @overload stop_transcription(call_control_id, client_state: nil, command_id: nil, request_options: {})
         #
@@ -1915,7 +1921,9 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Calls::ActionUpdateClientStateParams} for more details.
         #
-        # Updates client state
+        # Updates the client state associated with the call. Client state is an opaque
+        # value echoed back in subsequent webhooks for the call, letting you correlate
+        # events with your application's state.
         #
         # @overload update_client_state(call_control_id, client_state:, request_options: {})
         #

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

@@ -102,7 +102,7 @@ module Telnyx
         #
         # @param stop_playback_on_dtmf [Boolean] Whether to stop the audio playback when a DTMF digit is received.
         #
-        # @param terminating_digit [String] Digit that terminates gathering.
+        # @param terminating_digit [String] Digit that terminates gathering. Set to an empty string to disable the terminati
         #
         # @param timeout_millis [Integer] Duration in milliseconds to wait for input before timing out.
         #
@@ -323,7 +323,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Conferences::ActionRecordPauseParams} for more details.
         #
-        # Pause conference recording.
+        # Pauses the active recording of the specified conference. Resume it later with
+        # the record_resume action.
         #
         # @overload record_pause(id, command_id: nil, recording_id: nil, region: nil, request_options: {})
         #
@@ -354,7 +355,8 @@ module Telnyx
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::Conferences::ActionRecordResumeParams} for more details.
         #
-        # Resume conference recording.
+        # Resumes a previously paused recording of the specified conference, continuing
+        # capture from the point it was paused.
         #
         # @overload record_resume(id, command_id: nil, recording_id: nil, region: nil, request_options: {})
         #
@@ -520,7 +522,7 @@ module Telnyx
         #
         # @param region [Symbol, Telnyx::Models::Conferences::ConferenceRegion] Region where the conference data is located. Defaults to the region defined in u
         #
-        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
+        # @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::InworldVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
         #
         # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/telnyx/resources/conferences.rb

@@ -68,7 +68,7 @@ module Telnyx
         )
       end
 
-      # Retrieve an existing conference
+      # Returns the details of an existing conference, including its current status.
       #
       # @overload retrieve(id, region: nil, request_options: {})
       #
@@ -132,7 +132,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::ConferenceListParticipantsParams} for more details.
       #
-      # Lists conference participants
+      # Returns a paginated list of participants in the specified conference, with
+      # support for filtering.
       #
       # @overload list_participants(conference_id, filter: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
       #

data/lib/telnyx/resources/country_coverage.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Country Coverage
     class CountryCoverage
-      # Get country coverage
+      # Returns Telnyx service coverage information for every country, including which
+      # number types and features are available in each.
       #
       # @overload retrieve(request_options: {})
       #
@@ -22,7 +23,8 @@ module Telnyx
         )
       end
 
-      # Get coverage for a specific country
+      # Returns Telnyx service coverage information for the specified country, including
+      # available number types and features.
       #
       # @overload retrieve_country(country_code, request_options: {})
       #

data/lib/telnyx/resources/credential_connections.rb

@@ -11,7 +11,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::CredentialConnectionCreateParams} for more details.
       #
-      # Creates a credential connection.
+      # Creates a new credential-based SIP connection. Credential connections
+      # authenticate with a username and password rather than by IP address.
       #
       # @overload create(connection_name:, password:, user_name:, active: nil, anchorsite_override: nil, android_push_credential_id: nil, call_cost_in_webhooks: 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, rtcp_settings: nil, sip_uri_calling_preference: nil, tags: nil, webhook_api_version: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {})
       #

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::CustomStorageConfiguration::Configuration::S3Generic, Telnyx::Models::AzureConfigurationData]
+      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::S3GenericConfigurationData, 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::CustomStorageConfiguration::Configuration::S3Generic, Telnyx::Models::AzureConfigurationData]
+      # @param configuration [Telnyx::Models::GcsConfigurationData, Telnyx::Models::S3ConfigurationData, Telnyx::Models::S3GenericConfigurationData, Telnyx::Models::AzureConfigurationData]
       #
       # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/telnyx/resources/customer_service_records.rb

@@ -30,7 +30,8 @@ module Telnyx
         )
       end
 
-      # Get a specific customer service record.
+      # Returns the details of a single customer service record (CSR) request, including
+      # its status and any retrieved record data.
       #
       # @overload retrieve(customer_service_record_id, request_options: {})
       #
@@ -53,7 +54,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::CustomerServiceRecordListParams} for more details.
       #
-      # List customer service records.
+      # Returns a paginated list of your customer service record (CSR) requests, with
+      # support for filtering and sorting.
       #
       # @overload list(filter: nil, page_number: nil, page_size: nil, sort: nil, request_options: {})
       #

data/lib/telnyx/resources/dialogflow_connections.rb

@@ -64,7 +64,8 @@ module Telnyx
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::DialogflowConnectionUpdateParams} for more details.
       #
-      # Updates a stored Dialogflow Connection.
+      # Updates the stored Dialogflow connection for the specified connection and
+      # returns the updated configuration.
       #
       # @overload update(connection_id, service_account:, conversation_profile_id: nil, dialogflow_api: nil, environment: nil, location: nil, request_options: {})
       #
@@ -96,7 +97,7 @@ module Telnyx
         )
       end
 
-      # Deletes a stored Dialogflow Connection.
+      # Deletes the stored Dialogflow connection for the specified connection.
       #
       # @overload delete(connection_id, request_options: {})
       #

data/lib/telnyx/resources/documents.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Documents
     class Documents
-      # Retrieve a document.
+      # Returns the details of a single document on your account, including its
+      # metadata.
       #
       # @overload retrieve(id, request_options: {})
       #
@@ -24,7 +25,7 @@ module Telnyx
         )
       end
 
-      # Update a document.
+      # Updates the specified document's attributes and returns the updated document.
       #
       # @overload update(document_id, customer_reference: nil, filename: nil, request_options: {})
       #
@@ -105,7 +106,7 @@ module Telnyx
         )
       end
 
-      # Download a document.
+      # Downloads the raw file content of the specified document as originally uploaded.
       #
       # @overload download(id, request_options: {})
       #

data/lib/telnyx/resources/dynamic_emergency_addresses.rb

@@ -4,7 +4,8 @@ module Telnyx
   module Resources
     # Dynamic emergency address operations
     class DynamicEmergencyAddresses
-      # Creates a dynamic emergency address.
+      # Creates a dynamic emergency address, the validated physical location used when
+      # provisioning dynamic emergency endpoints.
       #
       # @overload create(administrative_area:, country_code:, house_number:, locality:, postal_code:, street_name:, extended_address: nil, house_suffix: nil, street_post_directional: nil, street_pre_directional: nil, street_suffix: nil, request_options: {})
       #