telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/models.rbi

@@ -73,6 +73,9 @@ module Telnyx
 
   ArtifactCompletedWebhookEvent = Telnyx::Models::ArtifactCompletedWebhookEvent
 
+  ArtifactDownloadRetrieveParams =
+    Telnyx::Models::ArtifactDownloadRetrieveParams
+
   ArtifactFailedWebhookEvent = Telnyx::Models::ArtifactFailedWebhookEvent
 
   AttachmentRequest = Telnyx::Models::AttachmentRequest
@@ -141,8 +144,23 @@ module Telnyx
   BotSignupResendMagicLinkParams =
     Telnyx::Models::BotSignupResendMagicLinkParams
 
+  BpoAuthorizationInput = Telnyx::Models::BpoAuthorizationInput
+
   BrandedCallingPaginationMeta = Telnyx::Models::BrandedCallingPaginationMeta
 
+  BrowserSessionCreateParams = Telnyx::Models::BrowserSessionCreateParams
+
+  BrowserSessionDeleteParams = Telnyx::Models::BrowserSessionDeleteParams
+
+  BrowserSessionListParams = Telnyx::Models::BrowserSessionListParams
+
+  BrowserSessionRetrieveArtifactParams =
+    Telnyx::Models::BrowserSessionRetrieveArtifactParams
+
+  BrowserSessionRetrieveParams = Telnyx::Models::BrowserSessionRetrieveParams
+
+  BrowserSessions = Telnyx::Models::BrowserSessions
+
   BulkMessagingSettingsUpdatePhoneNumbers =
     Telnyx::Models::BulkMessagingSettingsUpdatePhoneNumbers
 
@@ -170,6 +188,8 @@ module Telnyx
   CallAIGatherPartialResultsWebhookEvent =
     Telnyx::Models::CallAIGatherPartialResultsWebhookEvent
 
+  CallAnalyzedWebhookEvent = Telnyx::Models::CallAnalyzedWebhookEvent
+
   CallAnswered = Telnyx::Models::CallAnswered
 
   CallAnsweredWebhookEvent = Telnyx::Models::CallAnsweredWebhookEvent
@@ -206,6 +226,9 @@ module Telnyx
 
   CallControlRetrievalTool = Telnyx::Models::CallControlRetrievalTool
 
+  CallConversationCreatedWebhookEvent =
+    Telnyx::Models::CallConversationCreatedWebhookEvent
+
   CallConversationEnded = Telnyx::Models::CallConversationEnded
 
   CallConversationEndedWebhookEvent =
@@ -217,6 +240,9 @@ module Telnyx
   CallConversationInsightsGeneratedWebhookEvent =
     Telnyx::Models::CallConversationInsightsGeneratedWebhookEvent
 
+  CallConversationStartFailedWebhookEvent =
+    Telnyx::Models::CallConversationStartFailedWebhookEvent
+
   CallCostWebhookEvent = Telnyx::Models::CallCostWebhookEvent
 
   CallDeepfakeDetectionErrorWebhookEvent =
@@ -273,12 +299,18 @@ module Telnyx
   CallMachineGreetingEndedWebhookEvent =
     Telnyx::Models::CallMachineGreetingEndedWebhookEvent
 
+  CallMachinePremiumCallScreeningDetectedWebhookEvent =
+    Telnyx::Models::CallMachinePremiumCallScreeningDetectedWebhookEvent
+
   CallMachinePremiumDetectionEnded =
     Telnyx::Models::CallMachinePremiumDetectionEnded
 
   CallMachinePremiumDetectionEndedWebhookEvent =
     Telnyx::Models::CallMachinePremiumDetectionEndedWebhookEvent
 
+  CallMachinePremiumDetectionStartedWebhookEvent =
+    Telnyx::Models::CallMachinePremiumDetectionStartedWebhookEvent
+
   CallMachinePremiumGreetingEnded =
     Telnyx::Models::CallMachinePremiumGreetingEnded
 
@@ -403,6 +435,8 @@ module Telnyx
 
   Compute = Telnyx::Models::Compute
 
+  ComputeRetrieveParams = Telnyx::Models::ComputeRetrieveParams
+
   Conference = Telnyx::Models::Conference
 
   ConferenceCreated = Telnyx::Models::ConferenceCreated
@@ -601,6 +635,8 @@ module Telnyx
 
   DetailRecordListParams = Telnyx::Models::DetailRecordListParams
 
+  DialMetricListParams = Telnyx::Models::DialMetricListParams
+
   DialogflowConfig = Telnyx::Models::DialogflowConfig
 
   DialogflowConnectionCreateParams =
@@ -621,6 +657,8 @@ module Telnyx
 
   DirAPI = Telnyx::Models::DirAPI
 
+  DirBpoLoaParams = Telnyx::Models::DirBpoLoaParams
+
   DirDeleteParams = Telnyx::Models::DirDeleteParams
 
   DirList = Telnyx::Models::DirList
@@ -634,6 +672,9 @@ module Telnyx
 
   DirNewLoaParams = Telnyx::Models::DirNewLoaParams
 
+  DirRetrieveBpoAuthorizationsParams =
+    Telnyx::Models::DirRetrieveBpoAuthorizationsParams
+
   DirRetrieveParams = Telnyx::Models::DirRetrieveParams
 
   DirStatus = Telnyx::Models::DirStatus
@@ -709,6 +750,8 @@ module Telnyx
   DynamicEmergencyEndpointRetrieveParams =
     Telnyx::Models::DynamicEmergencyEndpointRetrieveParams
 
+  Email = Telnyx::Models::Email
+
   EmailAddressInput = Telnyx::Models::EmailAddressInput
 
   EmailBlock = Telnyx::Models::EmailBlock
@@ -812,6 +855,8 @@ module Telnyx
 
   EmailTemplate = Telnyx::Models::EmailTemplate
 
+  EmailTemplateCommon = Telnyx::Models::EmailTemplateCommon
+
   EmailTemplateCreateParams = Telnyx::Models::EmailTemplateCreateParams
 
   EmailTemplateDeleteParams = Telnyx::Models::EmailTemplateDeleteParams
@@ -974,6 +1019,8 @@ module Telnyx
 
   GcsConfigurationData = Telnyx::Models::GcsConfigurationData
 
+  GenericPayConnectorConfig = Telnyx::Models::GenericPayConnectorConfig
+
   GlobalIP = Telnyx::Models::GlobalIP
 
   GlobalIPAllowedPortListParams = Telnyx::Models::GlobalIPAllowedPortListParams
@@ -1132,6 +1179,8 @@ module Telnyx
 
   ListRetrieveByZoneParams = Telnyx::Models::ListRetrieveByZoneParams
 
+  LlmTokenGateway = Telnyx::Models::LlmTokenGateway
+
   MachinePaymentAccountCreditParams =
     Telnyx::Models::MachinePaymentAccountCreditParams
 
@@ -1187,9 +1236,6 @@ module Telnyx
 
   MeetingSessionRetrieveParams = Telnyx::Models::MeetingSessionRetrieveParams
 
-  MeetingSessionRetrieveRecordingsParams =
-    Telnyx::Models::MeetingSessionRetrieveRecordingsParams
-
   MeetingSessionRetrieveTranscriptParams =
     Telnyx::Models::MeetingSessionRetrieveTranscriptParams
 
@@ -1341,6 +1387,8 @@ module Telnyx
 
   MinimaxVoiceSettings = Telnyx::Models::MinimaxVoiceSettings
 
+  Mm7Metadata = Telnyx::Models::Mm7Metadata
+
   MobileNetworkOperatorListParams =
     Telnyx::Models::MobileNetworkOperatorListParams
 
@@ -1390,6 +1438,8 @@ module Telnyx
 
   MonthDetail = Telnyx::Models::MonthDetail
 
+  NetappsCursorPaginationMeta = Telnyx::Models::NetappsCursorPaginationMeta
+
   NetappsLocation = Telnyx::Models::NetappsLocation
 
   NetappsLocation17904fcfbc = Telnyx::Models::NetappsLocation17904fcfbc
@@ -1412,6 +1462,16 @@ module Telnyx
 
   NetworkRetrieveParams = Telnyx::Models::NetworkRetrieveParams
 
+  NetworkRoute = Telnyx::Models::NetworkRoute
+
+  NetworkRouteCreateParams = Telnyx::Models::NetworkRouteCreateParams
+
+  NetworkRouteDeleteParams = Telnyx::Models::NetworkRouteDeleteParams
+
+  NetworkRouteListParams = Telnyx::Models::NetworkRouteListParams
+
+  NetworkRouteRetrieveParams = Telnyx::Models::NetworkRouteRetrieveParams
+
   Networks = Telnyx::Models::Networks
 
   NetworkUpdateParams = Telnyx::Models::NetworkUpdateParams
@@ -1513,6 +1573,15 @@ module Telnyx
 
   NumberPoolSettings = Telnyx::Models::NumberPoolSettings
 
+  NumberReputationExternalVerificationStatusChangedWebhookEvent =
+    Telnyx::Models::NumberReputationExternalVerificationStatusChangedWebhookEvent
+
+  NumberReputationNumberFlaggedWebhookEvent =
+    Telnyx::Models::NumberReputationNumberFlaggedWebhookEvent
+
+  NumberReputationNumberRemovedWebhookEvent =
+    Telnyx::Models::NumberReputationNumberRemovedWebhookEvent
+
   NumberReputationPaginationMeta =
     Telnyx::Models::NumberReputationPaginationMeta
 
@@ -1527,6 +1596,8 @@ module Telnyx
 
   NumberReservations = Telnyx::Models::NumberReservations
 
+  NumbersError73c9788e53 = Telnyx::Models::NumbersError73c9788e53
+
   NumbersFeatureCreateParams = Telnyx::Models::NumbersFeatureCreateParams
 
   NumbersPhoneNumberDetailed = Telnyx::Models::NumbersPhoneNumberDetailed
@@ -1615,6 +1686,20 @@ module Telnyx
 
   PaginationMetaOAuth = Telnyx::Models::PaginationMetaOAuth
 
+  PayConnector = Telnyx::Models::PayConnector
+
+  PayConnectorCreateParams = Telnyx::Models::PayConnectorCreateParams
+
+  PayConnectorDeleteParams = Telnyx::Models::PayConnectorDeleteParams
+
+  PayConnectorListParams = Telnyx::Models::PayConnectorListParams
+
+  PayConnectorResponse = Telnyx::Models::PayConnectorResponse
+
+  PayConnectorRetrieveParams = Telnyx::Models::PayConnectorRetrieveParams
+
+  PayConnectorUpdateParams = Telnyx::Models::PayConnectorUpdateParams
+
   Payment = Telnyx::Models::Payment
 
   PaymentCreateStoredPaymentTransactionParams =
@@ -1823,9 +1908,6 @@ module Telnyx
 
   Record = Telnyx::Models::Record
 
-  RecordingAvailableWebhookEvent =
-    Telnyx::Models::RecordingAvailableWebhookEvent
-
   RecordingDeleteParams = Telnyx::Models::RecordingDeleteParams
 
   RecordingListParams = Telnyx::Models::RecordingListParams
@@ -1948,6 +2030,8 @@ module Telnyx
 
   ServicePlan = Telnyx::Models::ServicePlan
 
+  Session = Telnyx::Models::Session
+
   SessionAnalysis = Telnyx::Models::SessionAnalysis
 
   SessionAnalysisRetrieveParams = Telnyx::Models::SessionAnalysisRetrieveParams
@@ -1968,6 +2052,8 @@ module Telnyx
 
   ShortCodeUpdateParams = Telnyx::Models::ShortCodeUpdateParams
 
+  SignaturePayload = Telnyx::Models::SignaturePayload
+
   SimCard = Telnyx::Models::SimCard
 
   SimCardActionsSummary = Telnyx::Models::SimCardActionsSummary
@@ -2050,6 +2136,9 @@ module Telnyx
 
   SiprecConnectorUpdateParams = Telnyx::Models::SiprecConnectorUpdateParams
 
+  SipRegistrationStatusListParams =
+    Telnyx::Models::SipRegistrationStatusListParams
+
   SoundModifications = Telnyx::Models::SoundModifications
 
   SpeechToTextListProvidersParams =
@@ -2058,6 +2147,22 @@ module Telnyx
   SpeechToTextRetrieveTranscriptionParams =
     Telnyx::Models::SpeechToTextRetrieveTranscriptionParams
 
+  SpendLimit = Telnyx::Models::SpendLimit
+
+  SpendLimitBlock = Telnyx::Models::SpendLimitBlock
+
+  SpendLimitCreateParams = Telnyx::Models::SpendLimitCreateParams
+
+  SpendLimitDeleteParams = Telnyx::Models::SpendLimitDeleteParams
+
+  SpendLimitListParams = Telnyx::Models::SpendLimitListParams
+
+  SpendLimitPeriod = Telnyx::Models::SpendLimitPeriod
+
+  SpendLimitResponse = Telnyx::Models::SpendLimitResponse
+
+  SpendLimitUpdateParams = Telnyx::Models::SpendLimitUpdateParams
+
   Storage = Telnyx::Models::Storage
 
   StorageListMigrationSourceCoverageParams =
@@ -2110,6 +2215,23 @@ module Telnyx
 
   SuppressedRecipient = Telnyx::Models::SuppressedRecipient
 
+  TailscaleSubnetRouter = Telnyx::Models::TailscaleSubnetRouter
+
+  TailscaleSubnetRouterCreateParams =
+    Telnyx::Models::TailscaleSubnetRouterCreateParams
+
+  TailscaleSubnetRouterDeleteParams =
+    Telnyx::Models::TailscaleSubnetRouterDeleteParams
+
+  TailscaleSubnetRouterListParams =
+    Telnyx::Models::TailscaleSubnetRouterListParams
+
+  TailscaleSubnetRouterRetrieveParams =
+    Telnyx::Models::TailscaleSubnetRouterRetrieveParams
+
+  TailscaleSubnetRouterUpdateParams =
+    Telnyx::Models::TailscaleSubnetRouterUpdateParams
+
   TelephonyCredential = Telnyx::Models::TelephonyCredential
 
   TelephonyCredentialCreateParams =
@@ -2199,6 +2321,20 @@ module Telnyx
 
   TransportProtocol = Telnyx::Models::TransportProtocol
 
+  Tunnel = Telnyx::Models::Tunnel
+
+  TunnelCreateParams = Telnyx::Models::TunnelCreateParams
+
+  TunnelDeleteParams = Telnyx::Models::TunnelDeleteParams
+
+  TunnelListParams = Telnyx::Models::TunnelListParams
+
+  TunnelRetrieveParams = Telnyx::Models::TunnelRetrieveParams
+
+  Tunnels = Telnyx::Models::Tunnels
+
+  TunnelWithToken = Telnyx::Models::TunnelWithToken
+
   UacConnection = Telnyx::Models::UacConnection
 
   UacConnectionCreateParams = Telnyx::Models::UacConnectionCreateParams
@@ -2447,6 +2583,8 @@ module Telnyx
 
   WhatsappTemplateData = Telnyx::Models::WhatsappTemplateData
 
+  WhatsappWabaAddedWebhookEvent = Telnyx::Models::WhatsappWabaAddedWebhookEvent
+
   WireguardInterface = Telnyx::Models::WireguardInterface
 
   WireguardInterfaceCreateParams =

data/rbi/telnyx/resources/addresses.rbi

@@ -31,6 +31,18 @@ module Telnyx
       # Creates a new address on your account from the provided details, for use with
       # services that require a physical address such as emergency calling and
       # regulatory compliance.
+      #
+      # By default, the new record is validated for emergency use at creation time. If
+      # the address fails validation, no record is created and the request is rejected
+      # with a 422 response; the `errors` array includes a suggested value for each
+      # offending field when one is available.
+      #
+      # Set `validate_address` to `false` to skip validation at creation, for example
+      # when the address was already validated with the Validate an address action. The
+      # record is then created without emergency validation: if it is not valid it will
+      # not be able to be used for emergency services (such as a phone number's
+      # emergency address), and because address records cannot be updated, a new record
+      # has to be created to correct it.
       sig do
         params(
           business_name: String,
@@ -94,7 +106,11 @@ module Telnyx
         # have used the `/addresses/actions/validate` endpoint to validate the address
         # separately prior to creation. If an address is not validated for emergency use
         # upon creation and it is not valid, it will not be able to be used for emergency
-        # services.
+        # services. In an address record, this flag indicates whether emergency validation
+        # was performed at creation: `true` means the record passed emergency validation
+        # before it was created; `false` means validation was skipped during this creation
+        # request, and the address may have been validated separately. This flag is not a
+        # current validity status; emergency use still requires a valid address.
         validate_address: nil,
         request_options: {}
       )

data/rbi/telnyx/resources/ai/assistants/deleted.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Assistants
+        # Configure AI assistant specifications
+        class Deleted
+          # List the organization's soft-deleted assistants in the Recently Deleted list.
+          #
+          # Each entry includes `deleted_at` and `permanently_deleted_at`, the point after
+          # which the assistant is erased automatically and can no longer be restored.
+          sig do
+            params(
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::Internal::DefaultFlatPagination[
+                Telnyx::AI::Assistants::DeletedAssistant
+              ]
+            )
+          end
+          def list(
+            # Page number to retrieve (1-based).
+            page_number: nil,
+            # Number of items to return per page.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          # Retrieve a soft-deleted assistant from the Recently Deleted list by
+          # `assistant_id`, including its `deleted_at` and `permanently_deleted_at`
+          # timestamps. This is a read-only view; the assistant cannot be modified while it
+          # remains deleted.
+          sig do
+            params(
+              assistant_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(Telnyx::AI::Assistants::DeletedAssistant)
+          end
+          def get(
+            # Unique identifier of the assistant.
+            assistant_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -33,7 +33,10 @@ module Telnyx
               version_id: String,
               assistant_id: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+              avatar_settings:
+                T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
               conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+              delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -74,6 +77,7 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                    Telnyx::AI::AssistantTool::Vision::OrHash,
                     Telnyx::AI::AssistantTool::Pay::OrHash,
                     Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )
@@ -82,6 +86,7 @@ module Telnyx
               version_name: String,
               voice_settings:
                 Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+              websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
               widget_settings: Telnyx::AI::WidgetSettings::OrHash,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::InferenceEmbedding)
@@ -102,12 +107,25 @@ module Telnyx
             # to leave the assistant's agents unchanged; send an empty array to remove them
             # all.
             a2a_agents: nil,
+            # Body param: **Beta:** Configuration for the Telnyx open-source avatar provider.
+            # Use a stock avatar or an organization-owned custom avatar returned by the
+            # Avatars API. Discover the available stock catalog with GET /v2/ai/avatars and
+            # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+            avatar_settings: nil,
             # Body param: Conversation flow as supplied by API clients (create / update).
             #
             # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
             # unique node/edge IDs, that `start_node_id` references a real node, and that
             # every edge's endpoints reference real nodes.
             conversation_flow: nil,
+            # Body param: Splits the conversation between a frontend model that talks to the
+            # caller and a backend model that does the work. On the GPT-Live route the
+            # frontend model cannot call tools at all — when it needs something done it raises
+            # a delegation and waits. On the chat completion route the frontend keeps a single
+            # `delegate` tool that returns immediately, so the conversation carries on while
+            # the backend works. Either way the backend's answer is spoken as commentary or
+            # kept as silent context, depending on `speak_results`. Beta feature.
+            delegation_settings: nil,
             # Body param
             description: nil,
             # Body param: Map of dynamic variables and their default values
@@ -217,6 +235,12 @@ module Telnyx
             version_name: nil,
             # Body param
             voice_settings: nil,
+            # Body param: Streams conversation and telephony events to a WebSocket server you
+            # host, and accepts messages injected back into the conversation. Telnyx opens the
+            # connection as a client, once per conversation. Delivery is best effort
+            # throughout: while the connection is down events are dropped rather than queued,
+            # and no socket failure is ever allowed to affect the call. Beta feature.
+            websocket_settings: nil,
             # Body param: Configuration settings for the assistant's web widget.
             widget_settings: nil,
             request_options: {}
@@ -224,7 +248,10 @@ module Telnyx
           end
 
           # Retrieves all versions of a specific assistant with complete configuration and
-          # metadata
+          # metadata. An assistant keeps at most 10 versions, including the main version.
+          # When an update takes it past that limit, the oldest versions are permanently
+          # deleted. The main version and any version referenced by a traffic distribution
+          # rule are never deleted this way.
           sig do
             params(
               assistant_id: String,