telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/ai/websocket_settings.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class WebsocketSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::WebsocketSettings, Telnyx::Internal::AnyHash)
+          end
+
+        # Integration secret identifier whose value Telnyx sends as an
+        # `Authorization: Bearer <value>` header on the upgrade request. Resolved on every
+        # connection attempt, so a rotated secret is picked up by the next reconnect.
+        sig { returns(T.nilable(String)) }
+        attr_reader :auth_ref
+
+        sig { params(auth_ref: String).void }
+        attr_writer :auth_ref
+
+        # Whether Telnyx opens a WebSocket to `url` for each of this assistant's
+        # conversations. Defaults to `false`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enabled
+
+        sig { params(enabled: T::Boolean).void }
+        attr_writer :enabled
+
+        # The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
+        # `true`. Must be externally reachable — localhost, private IP ranges and `.local`
+        # domains are rejected.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        # 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.
+        sig do
+          params(auth_ref: String, enabled: T::Boolean, url: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Integration secret identifier whose value Telnyx sends as an
+          # `Authorization: Bearer <value>` header on the upgrade request. Resolved on every
+          # connection attempt, so a rotated secret is picked up by the next reconnect.
+          auth_ref: nil,
+          # Whether Telnyx opens a WebSocket to `url` for each of this assistant's
+          # conversations. Defaults to `false`.
+          enabled: nil,
+          # The `ws://` or `wss://` endpoint Telnyx connects to. Required when `enabled` is
+          # `true`. Must be externally reachable — localhost, private IP ranges and `.local`
+          # domains are rejected.
+          url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { auth_ref: String, enabled: T::Boolean, url: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/billing_contact.rbi

@@ -8,16 +8,23 @@ module Telnyx
           T.any(Telnyx::BillingContact, Telnyx::Internal::AnyHash)
         end
 
+      # The email address of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :email
 
+      # The first name of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :first_name
 
+      # The last name of the person Telnyx should contact about billing for this
+      # account.
       sig { returns(String) }
       attr_accessor :last_name
 
-      # E.164 format with leading `+`.
+      # The phone number of the billing contact, in E.164 format, for example
+      # +12125551234.
       sig { returns(String) }
       attr_accessor :phone_number
 
@@ -30,10 +37,17 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
+        # The email address of the person Telnyx should contact about billing for this
+        # account.
         email:,
+        # The first name of the person Telnyx should contact about billing for this
+        # account.
         first_name:,
+        # The last name of the person Telnyx should contact about billing for this
+        # account.
         last_name:,
-        # E.164 format with leading `+`.
+        # The phone number of the billing contact, in E.164 format, for example
+        # +12125551234.
         phone_number:
       )
       end

data/rbi/telnyx/models/bpo_authorization_input.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class BpoAuthorizationInput < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::BpoAuthorizationInput, Telnyx::Internal::AnyHash)
+        end
+
+      # Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+      # organization to authorize for this DIR.
+      sig { returns(String) }
+      attr_accessor :bpo_enterprise_id
+
+      # Id of the signed Letter of Authorization document (uploaded via the Telnyx
+      # Documents API) in which the Brand Owner authorizes this BPO.
+      sig { returns(String) }
+      attr_accessor :loa_document_id
+
+      # One authorization to include when creating or updating a DIR: an approved BPO
+      # (Business Process Outsourcer) account plus the signed Letter of Authorization
+      # the Brand Owner granted it.
+      sig do
+        params(bpo_enterprise_id: String, loa_document_id: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Enterprise id of an approved BPO (Business Process Outsourcer) account on your
+        # organization to authorize for this DIR.
+        bpo_enterprise_id:,
+        # Id of the signed Letter of Authorization document (uploaded via the Telnyx
+        # Documents API) in which the Brand Owner authorizes this BPO.
+        loa_document_id:
+      )
+      end
+
+      sig do
+        override.returns({ bpo_enterprise_id: String, loa_document_id: String })
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_assistant_request.rbi

@@ -169,15 +169,32 @@ module Telnyx
       end
       attr_writer :tools
 
+      # Per-call speech-to-text configuration for the assistant. If omitted, the stored
+      # assistant transcription configuration is used. If supplied, this object replaces
+      # the stored transcription settings. This is separate from the top-level
+      # `transcription` boolean on answer and dial commands.
+      sig { returns(T.nilable(Telnyx::Calls::TranscriptionConfig)) }
+      attr_reader :transcription
+
+      sig do
+        params(transcription: Telnyx::Calls::TranscriptionConfig::OrHash).void
+      end
+      attr_writer :transcription
+
+      # Per-call voice configuration. Set the voice identifier in
+      # `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+      # replaces the stored voice settings.
       sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
       attr_reader :voice_settings
 
       sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
       attr_writer :voice_settings
 
-      # AI Assistant configuration. All fields except `id` are optional — the
-      # assistant's stored configuration will be used as fallback for any omitted
-      # fields.
+      # AI Assistant configuration and per-call overrides. All fields except `id` are
+      # optional. Omitted assistant fields use the stored configuration. Supplied
+      # `voice_settings` and `transcription` objects replace their stored objects rather
+      # than merging individual settings; include every setting you want to retain.
+      # `dynamic_variables` are merged, with request values taking precedence.
       sig do
         params(
           id: String,
@@ -207,6 +224,7 @@ module Telnyx
                 Telnyx::CallControlRetrievalTool::OrHash
               )
             ],
+          transcription: Telnyx::Calls::TranscriptionConfig::OrHash,
           voice_settings: Telnyx::AI::VoiceSettings::OrHash
         ).returns(T.attached_class)
       end
@@ -256,6 +274,14 @@ module Telnyx
         # Inline tool definitions available to the assistant (webhook, retrieval,
         # transfer, hangup, etc.). Overrides the assistant's stored tools if provided.
         tools: nil,
+        # Per-call speech-to-text configuration for the assistant. If omitted, the stored
+        # assistant transcription configuration is used. If supplied, this object replaces
+        # the stored transcription settings. This is separate from the top-level
+        # `transcription` boolean on answer and dial commands.
+        transcription: nil,
+        # Per-call voice configuration. Set the voice identifier in
+        # `voice_settings.voice`, not in `assistant.voice`. If supplied, this object
+        # replaces the stored voice settings.
         voice_settings: nil
       )
       end
@@ -290,6 +316,7 @@ module Telnyx
                   Telnyx::CallControlRetrievalTool
                 )
               ],
+            transcription: Telnyx::Calls::TranscriptionConfig,
             voice_settings: Telnyx::AI::VoiceSettings
           }
         )

data/rbi/telnyx/models/call_conversation_created_webhook_event.rbi

@@ -0,0 +1,415 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class CallConversationCreatedWebhookEvent < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::CallConversationCreatedWebhookEvent,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # A conversation has been created for the call. Use the conversation ID to
+      # correlate subsequent conversation events.
+      sig do
+        returns(T.nilable(Telnyx::CallConversationCreatedWebhookEvent::Data))
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::CallConversationCreatedWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::CallConversationCreatedWebhookEvent::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A conversation has been created for the call. Use the conversation ID to
+        # correlate subsequent conversation events.
+        data: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::CallConversationCreatedWebhookEvent::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallConversationCreatedWebhookEvent::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the event.
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Timestamp when the event was created in the system.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # The type of event being delivered.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :event_type
+
+        sig do
+          params(
+            event_type:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::OrSymbol
+          ).void
+        end
+        attr_writer :event_type
+
+        # ISO 8601 datetime of when the event occurred.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :occurred_at
+
+        sig { params(occurred_at: Time).void }
+        attr_writer :occurred_at
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallConversationCreatedWebhookEvent::Data::Payload
+            )
+          )
+        end
+        attr_reader :payload
+
+        sig do
+          params(
+            payload:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::OrHash
+          ).void
+        end
+        attr_writer :payload
+
+        # Identifies the type of the resource.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :record_type
+
+        sig do
+          params(
+            record_type:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::OrSymbol
+          ).void
+        end
+        attr_writer :record_type
+
+        # A conversation has been created for the call. Use the conversation ID to
+        # correlate subsequent conversation events.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            event_type:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::OrSymbol,
+            occurred_at: Time,
+            payload:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::OrHash,
+            record_type:
+              Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the event.
+          id: nil,
+          # Timestamp when the event was created in the system.
+          created_at: nil,
+          # The type of event being delivered.
+          event_type: nil,
+          # ISO 8601 datetime of when the event occurred.
+          occurred_at: nil,
+          payload: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              event_type:
+                Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::TaggedSymbol,
+              occurred_at: Time,
+              payload:
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload,
+              record_type:
+                Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of event being delivered.
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallConversationCreatedWebhookEvent::Data::EventType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CALL_CONVERSATION_CREATED =
+            T.let(
+              :"call.conversation.created",
+              Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallConversationCreatedWebhookEvent::Data::EventType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Call ID used to issue commands via Call Control API.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_control_id
+
+          sig { params(call_control_id: String).void }
+          attr_writer :call_control_id
+
+          # ID that is unique to the call leg.
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_leg_id
+
+          sig { params(call_leg_id: String).void }
+          attr_writer :call_leg_id
+
+          # ID that is unique to the call session (group of related call legs).
+          sig { returns(T.nilable(String)) }
+          attr_reader :call_session_id
+
+          sig { params(call_session_id: String).void }
+          attr_writer :call_session_id
+
+          # The type of calling party connection.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :calling_party_type
+
+          sig do
+            params(
+              calling_party_type:
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::OrSymbol
+            ).void
+          end
+          attr_writer :calling_party_type
+
+          # Base64-encoded state received from a command.
+          sig { returns(T.nilable(String)) }
+          attr_reader :client_state
+
+          sig { params(client_state: String).void }
+          attr_writer :client_state
+
+          # Call Control App ID (formerly Telnyx connection ID) used in the call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :connection_id
+
+          sig { params(connection_id: String).void }
+          attr_writer :connection_id
+
+          # Unique identifier of the conversation created for this call.
+          sig { returns(T.nilable(String)) }
+          attr_reader :conversation_id
+
+          sig { params(conversation_id: String).void }
+          attr_writer :conversation_id
+
+          # The caller's number or identifier.
+          sig { returns(T.nilable(String)) }
+          attr_reader :from
+
+          sig { params(from: String).void }
+          attr_writer :from
+
+          # The callee's number or SIP address.
+          sig { returns(T.nilable(String)) }
+          attr_reader :to
+
+          sig { params(to: String).void }
+          attr_writer :to
+
+          sig do
+            params(
+              call_control_id: String,
+              call_leg_id: String,
+              call_session_id: String,
+              calling_party_type:
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::OrSymbol,
+              client_state: String,
+              connection_id: String,
+              conversation_id: String,
+              from: String,
+              to: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Call ID used to issue commands via Call Control API.
+            call_control_id: nil,
+            # ID that is unique to the call leg.
+            call_leg_id: nil,
+            # ID that is unique to the call session (group of related call legs).
+            call_session_id: nil,
+            # The type of calling party connection.
+            calling_party_type: nil,
+            # Base64-encoded state received from a command.
+            client_state: nil,
+            # Call Control App ID (formerly Telnyx connection ID) used in the call.
+            connection_id: nil,
+            # Unique identifier of the conversation created for this call.
+            conversation_id: nil,
+            # The caller's number or identifier.
+            from: nil,
+            # The callee's number or SIP address.
+            to: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_id: String,
+                call_leg_id: String,
+                call_session_id: String,
+                calling_party_type:
+                  Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::TaggedSymbol,
+                client_state: String,
+                connection_id: String,
+                conversation_id: String,
+                from: String,
+                to: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The type of calling party connection.
+          module CallingPartyType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PSTN =
+              T.let(
+                :pstn,
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::TaggedSymbol
+              )
+            SIP =
+              T.let(
+                :sip,
+                Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallConversationCreatedWebhookEvent::Data::Payload::CallingPartyType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # Identifies the type of the resource.
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVENT =
+            T.let(
+              :event,
+              Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallConversationCreatedWebhookEvent::Data::RecordType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end