telnyx 5.123.0 → 5.124.0

data/rbi/telnyx/models/sip_registration_status_retrieve_response.rbi

@@ -0,0 +1,343 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class SipRegistrationStatusRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      # Identifier of the UAC connection.
+      sig { returns(T.nilable(String)) }
+      attr_reader :connection_id
+
+      sig { params(connection_id: String).void }
+      attr_writer :connection_id
+
+      # Human-readable connection name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :connection_name
+
+      sig { params(connection_name: String).void }
+      attr_writer :connection_name
+
+      # The credential type that was looked up.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :credential_type
+
+      sig do
+        params(
+          credential_type:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::OrSymbol
+        ).void
+      end
+      attr_writer :credential_type
+
+      # SIP username used for the registration.
+      sig { returns(T.nilable(String)) }
+      attr_reader :credential_username
+
+      sig { params(credential_username: String).void }
+      attr_writer :credential_username
+
+      # SIP response from the last registration attempt.
+      sig { returns(T.nilable(String)) }
+      attr_reader :last_registration_response
+
+      sig { params(last_registration_response: String).void }
+      attr_writer :last_registration_response
+
+      # True if the endpoint is currently registered.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :registered
+
+      sig { params(registered: T::Boolean).void }
+      attr_writer :registered
+
+      # Detailed registration information reported by the registrar.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails
+          )
+        )
+      end
+      attr_reader :sip_registration_details
+
+      sig do
+        params(
+          sip_registration_details:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails::OrHash
+        ).void
+      end
+      attr_writer :sip_registration_details
+
+      # Human-readable registration status derived from the registrar state.
+      sig do
+        returns(
+          T.nilable(
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        )
+      end
+      attr_reader :sip_registration_status
+
+      sig do
+        params(
+          sip_registration_status:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::OrSymbol
+        ).void
+      end
+      attr_writer :sip_registration_status
+
+      sig do
+        params(
+          connection_id: String,
+          connection_name: String,
+          credential_type:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::OrSymbol,
+          credential_username: String,
+          last_registration_response: String,
+          registered: T::Boolean,
+          sip_registration_details:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails::OrHash,
+          sip_registration_status:
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Identifier of the UAC connection.
+        connection_id: nil,
+        # Human-readable connection name.
+        connection_name: nil,
+        # The credential type that was looked up.
+        credential_type: nil,
+        # SIP username used for the registration.
+        credential_username: nil,
+        # SIP response from the last registration attempt.
+        last_registration_response: nil,
+        # True if the endpoint is currently registered.
+        registered: nil,
+        # Detailed registration information reported by the registrar.
+        sip_registration_details: nil,
+        # Human-readable registration status derived from the registrar state.
+        sip_registration_status: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            connection_id: String,
+            connection_name: String,
+            credential_type:
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol,
+            credential_username: String,
+            last_registration_response: String,
+            registered: T::Boolean,
+            sip_registration_details:
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails,
+            sip_registration_status:
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The credential type that was looked up.
+      module CredentialType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UAC_EXTERNAL_CREDENTIAL =
+          T.let(
+            :uac_external_credential,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::CredentialType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class SipRegistrationDetails < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Number of authentication retries on the last attempt.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :auth_retries
+
+        sig { params(auth_retries: Integer).void }
+        attr_writer :auth_retries
+
+        # Unix timestamp when the current registration expires.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :expires
+
+        sig { params(expires: Integer).void }
+        attr_writer :expires
+
+        # Count of consecutive registration failures.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :failures
+
+        sig { params(failures: Integer).void }
+        attr_writer :failures
+
+        # Unix timestamp of the next scheduled registration action.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :next_action_at
+
+        sig { params(next_action_at: Integer).void }
+        attr_writer :next_action_at
+
+        # SIP URI user@host of the registered contact.
+        sig { returns(T.nilable(String)) }
+        attr_reader :sip_uri_user_host
+
+        sig { params(sip_uri_user_host: String).void }
+        attr_writer :sip_uri_user_host
+
+        # Registration uptime reported by the registrar.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :uptime
+
+        sig { params(uptime: Integer).void }
+        attr_writer :uptime
+
+        # Detailed registration information reported by the registrar.
+        sig do
+          params(
+            auth_retries: Integer,
+            expires: Integer,
+            failures: Integer,
+            next_action_at: Integer,
+            sip_uri_user_host: String,
+            uptime: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Number of authentication retries on the last attempt.
+          auth_retries: nil,
+          # Unix timestamp when the current registration expires.
+          expires: nil,
+          # Count of consecutive registration failures.
+          failures: nil,
+          # Unix timestamp of the next scheduled registration action.
+          next_action_at: nil,
+          # SIP URI user@host of the registered contact.
+          sip_uri_user_host: nil,
+          # Registration uptime reported by the registrar.
+          uptime: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              auth_retries: Integer,
+              expires: Integer,
+              failures: Integer,
+              next_action_at: Integer,
+              sip_uri_user_host: String,
+              uptime: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # Human-readable registration status derived from the registrar state.
+      module SipRegistrationStatus
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNREGISTERING =
+          T.let(
+            :unregistering,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        CONNECTION_DISABLED =
+          T.let(
+            :connection_disabled,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        STANDBY =
+          T.let(
+            :standby,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        TRYING =
+          T.let(
+            :trying,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        REGISTERED =
+          T.let(
+            :registered,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+        UNKNOWN =
+          T.let(
+            :unknown,
+            Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi

@@ -33,7 +33,12 @@ module Telnyx
       end
       attr_writer :provider
 
-      # Filter to entries that support the given service type.
+      # Filter to entries that support the given service type. For backward
+      # compatibility with the values that briefly shipped before the product-aligned
+      # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+      # `ai_assistant_transcription` are silently accepted and normalized to
+      # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+      # emits the canonical (post-rename) values.
       sig do
         returns(
           T.nilable(
@@ -66,7 +71,12 @@ module Telnyx
         # models currently registered for any service type will return an empty `data`
         # array rather than an error.
         provider: nil,
-        # Filter to entries that support the given service type.
+        # Filter to entries that support the given service type. For backward
+        # compatibility with the values that briefly shipped before the product-aligned
+        # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+        # `ai_assistant_transcription` are silently accepted and normalized to
+        # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+        # emits the canonical (post-rename) values.
         service_type: nil,
         request_options: {}
       )
@@ -157,7 +167,12 @@ module Telnyx
         end
       end
 
-      # Filter to entries that support the given service type.
+      # Filter to entries that support the given service type. For backward
+      # compatibility with the values that briefly shipped before the product-aligned
+      # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
+      # `ai_assistant_transcription` are silently accepted and normalized to
+      # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
+      # emits the canonical (post-rename) values.
       module ServiceType
         extend Telnyx::Internal::Type::Enum
 
@@ -172,14 +187,19 @@ module Telnyx
             :streaming,
             Telnyx::SpeechToTextListProvidersParams::ServiceType::TaggedSymbol
           )
-        FILE_TRANSCRIPTION =
+        FILE_BASED =
           T.let(
-            :file_transcription,
+            :file_based,
             Telnyx::SpeechToTextListProvidersParams::ServiceType::TaggedSymbol
           )
-        IN_CALL_TRANSCRIPTION =
+        IN_CALL =
           T.let(
-            :in_call_transcription,
+            :in_call,
+            Telnyx::SpeechToTextListProvidersParams::ServiceType::TaggedSymbol
+          )
+        AI_ASSISTANT =
+          T.let(
+            :ai_assistant,
             Telnyx::SpeechToTextListProvidersParams::ServiceType::TaggedSymbol
           )
 

data/rbi/telnyx/models/speech_to_text_list_providers_response.rbi

@@ -62,11 +62,6 @@ module Telnyx
             )
           end
 
-        # Languages this (provider, model) accepts, in the provider's native code format.
-        # `auto` indicates the provider performs language detection.
-        sig { returns(T::Array[String]) }
-        attr_accessor :languages
-
         # Provider-scoped model name.
         sig { returns(String) }
         attr_accessor :model
@@ -75,37 +70,38 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :provider
 
-        # Service surfaces this (provider, model) supports.
+        # Service surfaces this (provider, model) supports. When the request filters by
+        # `service_type`, only the matching nested entry is returned for each matching
+        # model.
         sig do
           returns(
             T::Array[
-              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
+              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType
             ]
           )
         end
         attr_accessor :service_types
 
-        # A (provider, model) tuple along with its supported service types and languages.
+        # A (provider, model) tuple along with the service surfaces it supports. Each
+        # entry in `service_types` describes one surface and the languages accepted on it.
         sig do
           params(
-            languages: T::Array[String],
             model: String,
             provider: String,
             service_types:
               T::Array[
-                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::OrSymbol
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::OrHash
               ]
           ).returns(T.attached_class)
         end
         def self.new(
-          # Languages this (provider, model) accepts, in the provider's native code format.
-          # `auto` indicates the provider performs language detection.
-          languages:,
           # Provider-scoped model name.
           model:,
           # STT provider name.
           provider:,
-          # Service surfaces this (provider, model) supports.
+          # Service surfaces this (provider, model) supports. When the request filters by
+          # `service_type`, only the matching nested entry is returned for each matching
+          # model.
           service_types:
         )
         end
@@ -113,12 +109,11 @@ module Telnyx
         sig do
           override.returns(
             {
-              languages: T::Array[String],
               model: String,
               provider: String,
               service_types:
                 T::Array[
-                  Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
+                  Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType
                 ]
             }
           )
@@ -126,43 +121,112 @@ module Telnyx
         def to_hash
         end
 
-        # Service surface a model is available on.
-        module ServiceType
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
+        class ServiceType < Telnyx::Internal::Type::BaseModel
+          OrHash =
             T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType
+              T.any(
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType,
+                Telnyx::Internal::AnyHash
               )
             end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          STREAMING =
-            T.let(
-              :streaming,
-              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
-            )
-          FILE_TRANSCRIPTION =
-            T.let(
-              :file_transcription,
-              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
-            )
-          IN_CALL_TRANSCRIPTION =
-            T.let(
-              :in_call_transcription,
-              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
+          # Languages accepted on this service surface, in the provider's native code
+          # format. `auto` indicates the provider performs language detection.
+          sig { returns(T::Array[String]) }
+          attr_accessor :languages
+
+          # Service surface a model is available on. `ai_assistant` is the STT surface
+          # configured via Call Control voice-assistant transcription; it covers both
+          # live-streaming and non-streaming/batch models (matching the
+          # `TranscriptionConfig.model` enum on `call-control` voice assistants).
+          sig do
+            returns(
+              Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
             )
+          end
+          attr_accessor :type
+
+          # A supported service surface for a given (provider, model), along with the
+          # language codes accepted on that surface. Language support can differ per surface
+          # — for example, a model may accept a narrower language set for streaming than for
+          # file transcription.
+          sig do
+            params(
+              languages: T::Array[String],
+              type:
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Languages accepted on this service surface, in the provider's native code
+            # format. `auto` indicates the provider performs language detection.
+            languages:,
+            # Service surface a model is available on. `ai_assistant` is the STT surface
+            # configured via Call Control voice-assistant transcription; it covers both
+            # live-streaming and non-streaming/batch models (matching the
+            # `TranscriptionConfig.model` enum on `call-control` voice assistants).
+            type:
+          )
+          end
 
           sig do
             override.returns(
-              T::Array[
-                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::TaggedSymbol
-              ]
+              {
+                languages: T::Array[String],
+                type:
+                  Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+              }
             )
           end
-          def self.values
+          def to_hash
+          end
+
+          # Service surface a model is available on. `ai_assistant` is the STT surface
+          # configured via Call Control voice-assistant transcription; it covers both
+          # live-streaming and non-streaming/batch models (matching the
+          # `TranscriptionConfig.model` enum on `call-control` voice assistants).
+          module Type
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            STREAMING =
+              T.let(
+                :streaming,
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+              )
+            FILE_BASED =
+              T.let(
+                :file_based,
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+              )
+            IN_CALL =
+              T.let(
+                :in_call,
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+              )
+            AI_ASSISTANT =
+              T.let(
+                :ai_assistant,
+                Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
           end
         end
       end