telnyx 5.167.0 → 5.169.0

data/lib/telnyx/models/x402/credit_account/payment_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module X402
+      module CreditAccount
+        # @see Telnyx::Resources::X402::CreditAccount::Payments#list
+        class PaymentListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute page_number
+          #   The page number to load.
+          #
+          #   @return [Integer, nil]
+          optional :page_number, Integer
+
+          # @!attribute page_size
+          #   The size of the page.
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!method initialize(page_number: nil, page_size: nil, request_options: {})
+          #   @param page_number [Integer] The page number to load.
+          #
+          #   @param page_size [Integer] The size of the page.
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/x402/credit_account/payment_retrieve_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module X402
+      module CreditAccount
+        # @see Telnyx::Resources::X402::CreditAccount::Payments#retrieve
+        class PaymentRetrieveParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:, request_options: {})
+          #   @param id [String]
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/x402/credit_account/payment_retrieve_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module X402
+      module CreditAccount
+        # @see Telnyx::Resources::X402::CreditAccount::Payments#retrieve
+        class PaymentRetrieveResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #   An x402 payment transaction.
+          #
+          #   @return [Telnyx::Models::X402::CreditAccount::X402TransactionRecord, nil]
+          optional :data, -> { Telnyx::X402::CreditAccount::X402TransactionRecord }
+
+          # @!method initialize(data: nil)
+          #   @param data [Telnyx::Models::X402::CreditAccount::X402TransactionRecord] An x402 payment transaction.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/x402/credit_account/x402_transaction_record.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module X402
+      module CreditAccount
+        # @see Telnyx::Resources::X402::CreditAccount::Payments#list
+        class X402TransactionRecord < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Unique transaction identifier.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute amount
+          #   The transaction amount in the specified currency.
+          #
+          #   @return [String, nil]
+          optional :amount, String
+
+          # @!attribute created_at
+          #   ISO 8601 timestamp when the transaction was created.
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute currency
+          #   The currency of the transaction amount (e.g. USD).
+          #
+          #   @return [String, nil]
+          optional :currency, String
+
+          # @!attribute quote_id
+          #   The original quote ID associated with this transaction.
+          #
+          #   @return [String, nil]
+          optional :quote_id, String
+
+          # @!attribute record_type
+          #
+          #   @return [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::RecordType, nil]
+          optional :record_type, enum: -> { Telnyx::X402::CreditAccount::X402TransactionRecord::RecordType }
+
+          # @!attribute status
+          #   The settlement status of the transaction. x402 transactions are created after
+          #   successful on-chain settlement, so the status is `settled`.
+          #
+          #   @return [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::Status, nil]
+          optional :status, enum: -> { Telnyx::X402::CreditAccount::X402TransactionRecord::Status }
+
+          # @!attribute tx_hash
+          #   The on-chain transaction hash, if available.
+          #
+          #   @return [String, nil]
+          optional :tx_hash, String, nil?: true
+
+          # @!attribute updated_at
+          #   ISO 8601 timestamp when the transaction was last updated.
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time
+
+          # @!method initialize(id: nil, amount: nil, created_at: nil, currency: nil, quote_id: nil, record_type: nil, status: nil, tx_hash: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::X402::CreditAccount::X402TransactionRecord} for more details.
+          #
+          #   An x402 payment transaction.
+          #
+          #   @param id [String] Unique transaction identifier.
+          #
+          #   @param amount [String] The transaction amount in the specified currency.
+          #
+          #   @param created_at [Time] ISO 8601 timestamp when the transaction was created.
+          #
+          #   @param currency [String] The currency of the transaction amount (e.g. USD).
+          #
+          #   @param quote_id [String] The original quote ID associated with this transaction.
+          #
+          #   @param record_type [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::RecordType]
+          #
+          #   @param status [Symbol, Telnyx::Models::X402::CreditAccount::X402TransactionRecord::Status] The settlement status of the transaction. x402 transactions are created after su
+          #
+          #   @param tx_hash [String, nil] The on-chain transaction hash, if available.
+          #
+          #   @param updated_at [Time] ISO 8601 timestamp when the transaction was last updated.
+
+          # @see Telnyx::Models::X402::CreditAccount::X402TransactionRecord#record_type
+          module RecordType
+            extend Telnyx::Internal::Type::Enum
+
+            X402_TRANSACTION = :x402_transaction
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # The settlement status of the transaction. x402 transactions are created after
+          # successful on-chain settlement, so the status is `settled`.
+          #
+          # @see Telnyx::Models::X402::CreditAccount::X402TransactionRecord#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SETTLED = :settled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models.rb

@@ -157,6 +157,14 @@ module Telnyx
 
   BookAppointmentToolParams = Telnyx::Models::BookAppointmentToolParams
 
+  BotChallengeCreateParams = Telnyx::Models::BotChallengeCreateParams
+
+  BotSessionListParams = Telnyx::Models::BotSessionListParams
+
+  BotSignupCreateParams = Telnyx::Models::BotSignupCreateParams
+
+  BotSignupResendMagicLinkParams = Telnyx::Models::BotSignupResendMagicLinkParams
+
   BrandedCallingPaginationMeta = Telnyx::Models::BrandedCallingPaginationMeta
 
   BulkMessagingSettingsUpdatePhoneNumbers = Telnyx::Models::BulkMessagingSettingsUpdatePhoneNumbers
@@ -386,6 +394,8 @@ module Telnyx
 
   CommentRetrieveParams = Telnyx::Models::CommentRetrieveParams
 
+  Compute = Telnyx::Models::Compute
+
   Conference = Telnyx::Models::Conference
 
   ConferenceCreated = Telnyx::Models::ConferenceCreated
@@ -475,6 +485,8 @@ module Telnyx
 
   ConnectionNoiseSuppressionDetails = Telnyx::Models::ConnectionNoiseSuppressionDetails
 
+  ConnectionRetrieveCountParams = Telnyx::Models::ConnectionRetrieveCountParams
+
   ConnectionRetrieveParams = Telnyx::Models::ConnectionRetrieveParams
 
   ConnectionRtcpSettings = Telnyx::Models::ConnectionRtcpSettings
@@ -1022,6 +1034,8 @@ module Telnyx
 
   ListRetrieveByZoneParams = Telnyx::Models::ListRetrieveByZoneParams
 
+  MachinePaymentAccountCreditParams = Telnyx::Models::MachinePaymentAccountCreditParams
+
   ManagedAccount = Telnyx::Models::ManagedAccount
 
   ManagedAccountBalance = Telnyx::Models::ManagedAccountBalance
@@ -1149,6 +1163,8 @@ module Telnyx
 
   MessagingHostedNumberUpdateParams = Telnyx::Models::MessagingHostedNumberUpdateParams
 
+  MessagingInboundMessage = Telnyx::Models::MessagingInboundMessage
+
   MessagingInboundMessagePayload = Telnyx::Models::MessagingInboundMessagePayload
 
   MessagingMessagingProfile = Telnyx::Models::MessagingMessagingProfile
@@ -1173,6 +1189,8 @@ module Telnyx
 
   MessagingProfileDeleteParams = Telnyx::Models::MessagingProfileDeleteParams
 
+  MessagingProfileFeatures = Telnyx::Models::MessagingProfileFeatures
+
   MessagingProfileListAlphanumericSenderIDsParams =
     Telnyx::Models::MessagingProfileListAlphanumericSenderIDsParams
 
@@ -1264,6 +1282,8 @@ module Telnyx
 
   NetworkUpdateParams = Telnyx::Models::NetworkUpdateParams
 
+  NoiseSuppressionEngineListParams = Telnyx::Models::NoiseSuppressionEngineListParams
+
   NotificationChannel = Telnyx::Models::NotificationChannel
 
   NotificationChannelCreateParams = Telnyx::Models::NotificationChannelCreateParams
@@ -1882,6 +1902,8 @@ module Telnyx
 
   SubNumberOrderUpdateRequirementGroupParams = Telnyx::Models::SubNumberOrderUpdateRequirementGroupParams
 
+  SuccessResponse = Telnyx::Models::SuccessResponse
+
   SuppressedRecipient = Telnyx::Models::SuppressedRecipient
 
   TelephonyCredential = Telnyx::Models::TelephonyCredential
@@ -2161,6 +2183,8 @@ module Telnyx
 
   Whatsapp = Telnyx::Models::Whatsapp
 
+  WhatsappAccountUpdate = Telnyx::Models::WhatsappAccountUpdate
+
   WhatsappContact = Telnyx::Models::WhatsappContact
 
   WhatsappInteractive = Telnyx::Models::WhatsappInteractive
@@ -2171,6 +2195,8 @@ module Telnyx
 
   WhatsappMessageContent = Telnyx::Models::WhatsappMessageContent
 
+  WhatsappMessageEcho = Telnyx::Models::WhatsappMessageEcho
+
   WhatsappMessageTemplateDeleteParams = Telnyx::Models::WhatsappMessageTemplateDeleteParams
 
   WhatsappMessageTemplateRetrieveParams = Telnyx::Models::WhatsappMessageTemplateRetrieveParams

data/lib/telnyx/resources/ai/assistants/versions.rb

@@ -43,12 +43,14 @@ module Telnyx
           # Updates the configuration of a specific assistant version. Can not update main
           # version
           #
-          # @overload update(version_id, assistant_id:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+          # @overload update(version_id, assistant_id:, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
           #
           # @param version_id [String] Path param: Unique identifier of the version.
           #
           # @param assistant_id [String] Path param: Unique identifier of the assistant.
           #
+          # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] Body param: A2A agents this assistant can delegate to. Tools are not stored here
+          #
           # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Body param: Conversation flow as supplied by API clients (create / update).
           #
           # @param description [String] Body param
@@ -97,7 +99,7 @@ module Telnyx
           #
           # @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
           #
-          # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
+          # @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
           #
           # @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
           #

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

@@ -39,12 +39,14 @@ module Telnyx
         # Creates a new AI assistant from the provided configuration, including its model,
         # instructions, and attached tools, and returns the created assistant.
         #
-        # @overload create(instructions:, name:, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
+        # @overload create(instructions:, name:, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, idempotency_key: nil, request_options: {})
         #
         # @param instructions [String] Body param: System instructions for the assistant. These may be templated with [
         #
         # @param name [String] Body param
         #
+        # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] Body param: A2A agents this assistant can delegate to. Tools are not stored here
+        #
         # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Body param: Conversation flow as supplied by API clients (create / update).
         #
         # @param description [String] Body param
@@ -89,7 +91,7 @@ module Telnyx
         #
         # @param tool_ids [Array<String>] Body param: IDs of shared tools to attach to the assistant. New integrations sho
         #
-        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
+        # @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Body param: Deprecated for new integrations. Inline tool definitions available t
         #
         # @param transcription [Telnyx::Models::AI::TranscriptionSettings] Body param
         #
@@ -155,10 +157,12 @@ module Telnyx
         # assistant. The request can also control how the change is promoted across
         # assistant versions.
         #
-        # @overload update(assistant_id, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+        # @overload update(assistant_id, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil, request_options: {})
         #
         # @param assistant_id [String] Unique identifier of the assistant.
         #
+        # @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] A2A agents this assistant can delegate to. Tools are not stored here: at the sta
+        #
         # @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Conversation flow as supplied by API clients (create / update).
         #
         # @param description [String]
@@ -209,7 +213,7 @@ module Telnyx
         #
         # @param tool_ids [Array<String>] IDs of shared tools to attach to the assistant. New integrations should prefer `
         #
-        # @param tools [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
+        # @param tools [Array<Telnyx::Models::AI::AssistantTool::Function, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::AssistantTool::ClientSideTool, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::AssistantTool::Hangup, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn, Telnyx::Models::AI::AssistantTool::Pay, Telnyx::Models::AI::AssistantTool::UpdateDynamicVariables>] Deprecated for new integrations. Inline tool definitions available to the assist
         #
         # @param transcription [Telnyx::Models::AI::TranscriptionSettings]
         #

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

@@ -19,9 +19,9 @@ module Telnyx
         #
         # @param file_url [String] Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg
         #
-        # @param language [String] The language of the audio to be transcribed. For `deepgram/nova-3`, only English
+        # @param language [String] The language of the audio to be transcribed. `deepgram/nova-3` supports ~49 lang
         #
-        # @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with `deepgram/
+        # @param model_config [Hash{Symbol=>Object}] Additional model-specific configuration parameters. Only allowed with the `deepg
         #
         # @param response_format [Symbol, Telnyx::Models::AI::AudioTranscribeParams::ResponseFormat] The format of the transcript output. Use `verbose_json` to take advantage of tim
         #

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, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: 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, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, mode: nil, model: nil, n: nil, presence_penalty: nil, reasoning_effort: nil, region: 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.
           #
@@ -27,12 +27,6 @@ module Telnyx
           #
           # @param frequency_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
           #
-          # @param guided_choice [Array<String>] If specified, the output will be exactly one of the choices.
-          #
-          # @param guided_json [Hash{Symbol=>Object}] Must be a valid JSON schema. If specified, the output will follow the JSON schem
-          #
-          # @param guided_regex [String] If specified, the output will follow the regex pattern.
-          #
           # @param length_penalty [Float] This is used with `use_beam_search` to prefer shorter or longer completions.
           #
           # @param logprobs [Boolean] Whether to return log probabilities of the output tokens or not. If true, return
@@ -53,7 +47,7 @@ module Telnyx
           #
           # @param region [Symbol, Telnyx::Models::AI::ChatCompletionRequest::Region] Optional data-residency region the request should be served from, using the same
           #
-          # @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 response_format [Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatText, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonObject, Telnyx::Models::AI::ChatCompletionRequest::ResponseFormat::ResponseFormatJsonSchemaParam] Controls the format of the model output. `json_object` guarantees valid JSON out
           #
           # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
           #

data/lib/telnyx/resources/ai/typesafe/v1.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class Typesafe
+        # Beta API for evaluating shared context with typed questions and structured
+        # answers. Telnyx manages model selection.
+        class V1
+          # **Beta API.** Telnyx controls model selection.
+          #
+          # Evaluate shared context using named choice, noul (yes/no), and score questions.
+          # Returns TypeSafe System One-compatible answer shapes, an opaque compatibility
+          # identifier, and token usage. See the
+          # [decision model guide](https://developers.telnyx.com/docs/inference/decision-models)
+          # for examples and compatibility limits.
+          #
+          # The supported request subset requires instructions for every question, string
+          # descriptions for criteria (or null for choice descriptions), 1–64 questions, and
+          # 2–64 options for choice and score questions. The SDK-supplied model value is
+          # ignored and cannot select a model. Other unknown fields are rejected. The
+          # endpoint is synchronous and does not stream.
+          #
+          # Use the TypeSafe Python SDK with base_url set to
+          # https://api.telnyx.com/v2/ai/typesafe and a Telnyx API key. The SDK appends
+          # /v1/systemone. Compatibility covers this operation and the documented request
+          # subset; it does not include TypeSafe model listing. Scores describe relative
+          # preference, not calibrated correctness.
+          #
+          # @overload systemone(questions:, state:, request_options: {})
+          #
+          # @param questions [Hash{Symbol=>Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Choice, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Noul, Telnyx::Models::AI::Typesafe::V1SystemoneParams::Question::Score}] Between 1 and 64 named questions. Each key identifies the corresponding answer.
+          #
+          # @param state [String, Hash{Symbol=>Object}, Array<Object>] Shared context evaluated by every question.
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Telnyx::Models::AI::Typesafe::V1SystemoneResponse]
+          #
+          # @see Telnyx::Models::AI::Typesafe::V1SystemoneParams
+          def systemone(params)
+            parsed, options = Telnyx::AI::Typesafe::V1SystemoneParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "ai/typesafe/v1/systemone",
+              body: parsed,
+              model: Telnyx::Models::AI::Typesafe::V1SystemoneResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class Typesafe
+        # Beta API for evaluating shared context with typed questions and structured
+        # answers. Telnyx manages model selection.
+        # @return [Telnyx::Resources::AI::Typesafe::V1]
+        attr_reader :v1
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+          @v1 = Telnyx::Resources::AI::Typesafe::V1.new(client: client)
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai.rb

@@ -55,6 +55,9 @@ module Telnyx
       # @return [Telnyx::Resources::AI::Knowledge]
       attr_reader :knowledge
 
+      # @return [Telnyx::Resources::AI::Typesafe]
+      attr_reader :typesafe
+
       # Some parameter documentations has been truncated, see
       # {Telnyx::Models::AIRetrieveConversationHistoriesParams} for more details.
       #
@@ -228,6 +231,7 @@ module Telnyx
         @tools = Telnyx::Resources::AI::Tools.new(client: client)
         @anthropic = Telnyx::Resources::AI::Anthropic.new(client: client)
         @knowledge = Telnyx::Resources::AI::Knowledge.new(client: client)
+        @typesafe = Telnyx::Resources::AI::Typesafe.new(client: client)
       end
     end
   end

data/lib/telnyx/resources/bot_challenge.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA
+    # challenge designed to be easy for LLMs and hard for humans, registers an
+    # account, and signs in by consuming a magic link emailed to the account owner.
+    # All endpoints are public and unauthenticated; signup endpoints are additionally
+    # gated by the freemium feature flags and per-country availability.
+    class BotChallenge
+      # Generates a reverse-CAPTCHA challenge used to gate the bot signup flow. A random
+      # active problem is selected from the pool; math problems are returned obfuscated
+      # (case randomization, symbol injection, spacing noise) with an unobfuscated
+      # rounding instruction appended, while string and binary problems are returned
+      # as-is. The response contains a single-use nonce, the problem text, and the
+      # current terms-and-conditions and privacy-policy URLs, which must be echoed back
+      # on the signup request. Challenges expire after a short window (10 minutes by
+      # default) and can only be answered once. This endpoint is public and
+      # unauthenticated.
+      #
+      # @overload create(llm_model_name: nil, llm_parameter_count: nil, llm_quantization: nil, request_options: {})
+      #
+      # @param llm_model_name [String] Name of the LLM the client is using.
+      #
+      # @param llm_parameter_count [String] Parameter count of the client LLM.
+      #
+      # @param llm_quantization [String] Quantization of the client LLM.
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BotChallengeCreateResponse]
+      #
+      # @see Telnyx::Models::BotChallengeCreateParams
+      def create(params = {})
+        parsed, options = Telnyx::BotChallengeCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v2/bot_challenge",
+          body: parsed,
+          model: Telnyx::Models::BotChallengeCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/telnyx/resources/bot_sessions.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    # Agentic (bot) signup for Telnyx accounts. An AI agent solves a reverse-CAPTCHA
+    # challenge designed to be easy for LLMs and hard for humans, registers an
+    # account, and signs in by consuming a magic link emailed to the account owner.
+    # All endpoints are public and unauthenticated; signup endpoints are additionally
+    # gated by the freemium feature flags and per-country availability.
+    class BotSessions
+      # Some parameter documentations has been truncated, see
+      # {Telnyx::Models::BotSessionListParams} for more details.
+      #
+      # Consumes the one-time portal redirect (magic link) token emailed during bot
+      # signup and returns an API session. The token is a UUIDv7 that encodes its
+      # creation time; it expires after a configurable validity window (15 minutes by
+      # default) and is cleared on first use. Although the action creates a session, the
+      # route uses the GET verb because it is opened from an email link. On first use
+      # the account is also initialized. For bot signup (freemium) accounts the response
+      # is a minimal envelope containing only the `api_v2_token`; accounts that are
+      # permitted to use magic links but are not freemium accounts may instead receive
+      # an extended session payload when additional steps (such as two-factor
+      # authentication or identity verification) are required. This endpoint is public;
+      # the magic link token in the query string is the credential.
+      #
+      # @overload list(email:, portal_redirect_token:, request_options: {})
+      #
+      # @param email [String] Email address associated with the magic link token.
+      #
+      # @param portal_redirect_token [String] Single-use portal redirect (magic link) token, a UUIDv7 sent to the account owne
+      #
+      # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Telnyx::Models::BotSessionListResponse]
+      #
+      # @see Telnyx::Models::BotSessionListParams
+      def list(params)
+        parsed, options = Telnyx::BotSessionListParams.dump_request(params)
+        query = Telnyx::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "v2/bot_sessions",
+          query: query,
+          model: Telnyx::Models::BotSessionListResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Telnyx::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end