telnyx 5.68.2 → 5.70.0

data/rbi/telnyx/models/ai/audio_transcribe_response.rbi

@@ -16,16 +16,18 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :text
 
-        # The duration of the audio file in seconds. This is only included if
-        # `response_format` is set to `verbose_json`.
+        # The duration of the audio file in seconds. Returned by
+        # `distil-whisper/distil-large-v2` and `deepgram/nova-3` when `response_format` is
+        # `verbose_json`. Not returned by `openai/whisper-large-v3-turbo`.
         sig { returns(T.nilable(Float)) }
         attr_reader :duration
 
         sig { params(duration: Float).void }
         attr_writer :duration
 
-        # Segments of the transcribed text and their corresponding details. This is only
-        # included if `response_format` is set to `verbose_json`.
+        # Segments of the transcribed text and their corresponding details. Returned by
+        # `distil-whisper/distil-large-v2` when `response_format` is `verbose_json`. Not
+        # returned by `openai/whisper-large-v3-turbo`.
         sig do
           returns(
             T.nilable(
@@ -45,6 +47,32 @@ module Telnyx
         end
         attr_writer :segments
 
+        # Word-level timestamps and optional speaker labels. Only returned by
+        # `deepgram/nova-3` when word-level output is enabled via `model_config`.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
+            )
+          )
+        end
+        attr_reader :words
+
+        sig do
+          params(
+            words:
+              T::Array[
+                Telnyx::Models::AI::AudioTranscribeResponse::Word::OrHash
+              ]
+          ).void
+        end
+        attr_writer :words
+
+        # Response fields vary by model. `distil-whisper/distil-large-v2` returns `text`,
+        # `duration`, and `segments` in `verbose_json` mode.
+        # `openai/whisper-large-v3-turbo` returns `text` only. `deepgram/nova-3` returns
+        # `text` and, depending on `model_config`, may include `words` with per-word
+        # timestamps and speaker labels.
         sig do
           params(
             text: String,
@@ -52,18 +80,27 @@ module Telnyx
             segments:
               T::Array[
                 Telnyx::Models::AI::AudioTranscribeResponse::Segment::OrHash
+              ],
+            words:
+              T::Array[
+                Telnyx::Models::AI::AudioTranscribeResponse::Word::OrHash
               ]
           ).returns(T.attached_class)
         end
         def self.new(
           # The transcribed text for the audio file.
           text:,
-          # The duration of the audio file in seconds. This is only included if
-          # `response_format` is set to `verbose_json`.
+          # The duration of the audio file in seconds. Returned by
+          # `distil-whisper/distil-large-v2` and `deepgram/nova-3` when `response_format` is
+          # `verbose_json`. Not returned by `openai/whisper-large-v3-turbo`.
           duration: nil,
-          # Segments of the transcribed text and their corresponding details. This is only
-          # included if `response_format` is set to `verbose_json`.
-          segments: nil
+          # Segments of the transcribed text and their corresponding details. Returned by
+          # `distil-whisper/distil-large-v2` when `response_format` is `verbose_json`. Not
+          # returned by `openai/whisper-large-v3-turbo`.
+          segments: nil,
+          # Word-level timestamps and optional speaker labels. Only returned by
+          # `deepgram/nova-3` when word-level output is enabled via `model_config`.
+          words: nil
         )
         end
 
@@ -73,7 +110,8 @@ module Telnyx
               text: String,
               duration: Float,
               segments:
-                T::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment]
+                T::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment],
+              words: T::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
             }
           )
         end
@@ -130,6 +168,81 @@ module Telnyx
           def to_hash
           end
         end
+
+        class Word < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::AI::AudioTranscribeResponse::Word,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # End time of the word in seconds.
+          sig { returns(Float) }
+          attr_accessor :end_
+
+          # Start time of the word in seconds.
+          sig { returns(Float) }
+          attr_accessor :start
+
+          # The transcribed word.
+          sig { returns(String) }
+          attr_accessor :word
+
+          # Confidence score for the word (0.0 to 1.0).
+          sig { returns(T.nilable(Float)) }
+          attr_reader :confidence
+
+          sig { params(confidence: Float).void }
+          attr_writer :confidence
+
+          # Speaker index. Only present when diarization is enabled via `model_config`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :speaker
+
+          sig { params(speaker: Integer).void }
+          attr_writer :speaker
+
+          # Word-level timing detail. Only present when using `deepgram/nova-3` with
+          # `model_config` options that enable word timestamps.
+          sig do
+            params(
+              end_: Float,
+              start: Float,
+              word: String,
+              confidence: Float,
+              speaker: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # End time of the word in seconds.
+            end_:,
+            # Start time of the word in seconds.
+            start:,
+            # The transcribed word.
+            word:,
+            # Confidence score for the word (0.0 to 1.0).
+            confidence: nil,
+            # Speaker index. Only present when diarization is enabled via `model_config`.
+            speaker: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                end_: Float,
+                start: Float,
+                word: String,
+                confidence: Float,
+                speaker: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/ai/conversation_add_message_params.rbi

@@ -160,12 +160,12 @@ module Telnyx
                 Integer,
                 T::Boolean,
                 T::Array[
-                  Telnyx::AI::ConversationAddMessageParams::Metadata::UnionMember3::Variants
+                  Telnyx::AI::ConversationAddMessageParams::Metadata::MetadataArrayValue::Variants
                 ]
               )
             end
 
-          module UnionMember3
+          module MetadataArrayValue
             extend Telnyx::Internal::Type::Union
 
             Variants = T.type_alias { T.any(String, Integer, T::Boolean) }
@@ -173,7 +173,7 @@ module Telnyx
             sig do
               override.returns(
                 T::Array[
-                  Telnyx::AI::ConversationAddMessageParams::Metadata::UnionMember3::Variants
+                  Telnyx::AI::ConversationAddMessageParams::Metadata::MetadataArrayValue::Variants
                 ]
               )
             end
@@ -191,11 +191,11 @@ module Telnyx
           def self.variants
           end
 
-          UnionMember3Array =
+          MetadataArrayValueArray =
             T.let(
               Telnyx::Internal::Type::ArrayOf[
                 union:
-                  Telnyx::AI::ConversationAddMessageParams::Metadata::UnionMember3
+                  Telnyx::AI::ConversationAddMessageParams::Metadata::MetadataArrayValue
               ],
               Telnyx::Internal::Type::Converter
             )

data/rbi/telnyx/models/ai/inference_embedding.rbi

@@ -111,6 +111,14 @@ module Telnyx
         end
         attr_writer :messaging_settings
 
+        sig { returns(T.nilable(Telnyx::AI::Observability)) }
+        attr_reader :observability_settings
+
+        sig do
+          params(observability_settings: Telnyx::AI::Observability::OrHash).void
+        end
+        attr_writer :observability_settings
+
         sig { returns(T.nilable(Telnyx::AI::PrivacySettings)) }
         attr_reader :privacy_settings
 
@@ -192,6 +200,7 @@ module Telnyx
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
             llm_api_key_ref: String,
             messaging_settings: Telnyx::AI::MessagingSettings::OrHash,
+            observability_settings: Telnyx::AI::Observability::OrHash,
             privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
             telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
             tools:
@@ -250,6 +259,7 @@ module Telnyx
           # work with this integration.
           llm_api_key_ref: nil,
           messaging_settings: nil,
+          observability_settings: nil,
           privacy_settings: nil,
           telephony_settings: nil,
           # The tools that the assistant can use. These may be templated with
@@ -280,6 +290,7 @@ module Telnyx
               insight_settings: Telnyx::AI::InsightSettings,
               llm_api_key_ref: String,
               messaging_settings: Telnyx::AI::MessagingSettings,
+              observability_settings: Telnyx::AI::Observability,
               privacy_settings: Telnyx::AI::PrivacySettings,
               telephony_settings: Telnyx::AI::TelephonySettings,
               tools: T::Array[Telnyx::AI::AssistantTool::Variants],

data/rbi/telnyx/models/ai/observability.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class Observability < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::Observability, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :host
+
+        sig { params(host: String).void }
+        attr_writer :host
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :public_key_ref
+
+        sig { params(public_key_ref: String).void }
+        attr_writer :public_key_ref
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret_key_ref
+
+        sig { params(secret_key_ref: String).void }
+        attr_writer :secret_key_ref
+
+        sig do
+          returns(T.nilable(Telnyx::AI::Observability::Status::TaggedSymbol))
+        end
+        attr_reader :status
+
+        sig { params(status: Telnyx::AI::Observability::Status::OrSymbol).void }
+        attr_writer :status
+
+        sig do
+          params(
+            host: String,
+            public_key_ref: String,
+            secret_key_ref: String,
+            status: Telnyx::AI::Observability::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          host: nil,
+          public_key_ref: nil,
+          secret_key_ref: nil,
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              host: String,
+              public_key_ref: String,
+              secret_key_ref: String,
+              status: Telnyx::AI::Observability::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::Observability::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ENABLED =
+            T.let(:enabled, Telnyx::AI::Observability::Status::TaggedSymbol)
+          DISABLED =
+            T.let(:disabled, Telnyx::AI::Observability::Status::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::Observability::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/observability_req.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ObservabilityReq < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::ObservabilityReq, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :host
+
+        sig { params(host: String).void }
+        attr_writer :host
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :public_key_ref
+
+        sig { params(public_key_ref: String).void }
+        attr_writer :public_key_ref
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :secret_key_ref
+
+        sig { params(secret_key_ref: String).void }
+        attr_writer :secret_key_ref
+
+        sig do
+          returns(T.nilable(Telnyx::AI::ObservabilityReq::Status::OrSymbol))
+        end
+        attr_reader :status
+
+        sig do
+          params(status: Telnyx::AI::ObservabilityReq::Status::OrSymbol).void
+        end
+        attr_writer :status
+
+        sig do
+          params(
+            host: String,
+            public_key_ref: String,
+            secret_key_ref: String,
+            status: Telnyx::AI::ObservabilityReq::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          host: nil,
+          public_key_ref: nil,
+          secret_key_ref: nil,
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              host: String,
+              public_key_ref: String,
+              secret_key_ref: String,
+              status: Telnyx::AI::ObservabilityReq::Status::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias { T.all(Symbol, Telnyx::AI::ObservabilityReq::Status) }
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ENABLED =
+            T.let(:enabled, Telnyx::AI::ObservabilityReq::Status::TaggedSymbol)
+          DISABLED =
+            T.let(:disabled, Telnyx::AI::ObservabilityReq::Status::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::ObservabilityReq::Status::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/telephony_settings.rbi

@@ -345,6 +345,14 @@ module Telnyx
           end
           attr_writer :channels
 
+          # Whether call recording is enabled. When set to false, calls will not be recorded
+          # regardless of other recording configuration.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :enabled
+
+          sig { params(enabled: T::Boolean).void }
+          attr_writer :enabled
+
           # The format of the recording file.
           sig do
             returns(
@@ -368,6 +376,7 @@ module Telnyx
             params(
               channels:
                 Telnyx::AI::TelephonySettings::RecordingSettings::Channels::OrSymbol,
+              enabled: T::Boolean,
               file_format:
                 Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol
             ).returns(T.attached_class)
@@ -375,6 +384,9 @@ module Telnyx
           def self.new(
             # The number of channels for the recording. 'single' for mono, 'dual' for stereo.
             channels: nil,
+            # Whether call recording is enabled. When set to false, calls will not be recorded
+            # regardless of other recording configuration.
+            enabled: nil,
             # The format of the recording file.
             file_format: nil
           )
@@ -385,6 +397,7 @@ module Telnyx
               {
                 channels:
                   Telnyx::AI::TelephonySettings::RecordingSettings::Channels::OrSymbol,
+                enabled: T::Boolean,
                 file_format:
                   Telnyx::AI::TelephonySettings::RecordingSettings::Format::OrSymbol
               }

data/rbi/telnyx/models/call_dial_params.rbi

@@ -224,6 +224,15 @@ module Telnyx
       sig { params(prevent_double_bridge: T::Boolean).void }
       attr_writer :prevent_double_bridge
 
+      # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+      # information (name and number) will be hidden from the called party. When set to
+      # `none` or omitted, caller ID will be shown normally.
+      sig { returns(T.nilable(Telnyx::CallDialParams::Privacy::OrSymbol)) }
+      attr_reader :privacy
+
+      sig { params(privacy: Telnyx::CallDialParams::Privacy::OrSymbol).void }
+      attr_writer :privacy
+
       # Start recording automatically after an event. Disabled by default.
       sig { returns(T.nilable(Telnyx::CallDialParams::Record::OrSymbol)) }
       attr_reader :record
@@ -570,6 +579,7 @@ module Telnyx
           park_after_unbridge: String,
           preferred_codecs: String,
           prevent_double_bridge: T::Boolean,
+          privacy: Telnyx::CallDialParams::Privacy::OrSymbol,
           record: Telnyx::CallDialParams::Record::OrSymbol,
           record_channels: Telnyx::CallDialParams::RecordChannels::OrSymbol,
           record_custom_file_name: String,
@@ -694,6 +704,10 @@ module Telnyx
         # Prevents bridging and hangs up the call if the target is already bridged.
         # Disabled by default.
         prevent_double_bridge: nil,
+        # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+        # information (name and number) will be hidden from the called party. When set to
+        # `none` or omitted, caller ID will be shown normally.
+        privacy: nil,
         # Start recording automatically after an event. Disabled by default.
         record: nil,
         # Defines which channel should be recorded ('single' or 'dual') when `record` is
@@ -818,6 +832,7 @@ module Telnyx
             park_after_unbridge: String,
             preferred_codecs: String,
             prevent_double_bridge: T::Boolean,
+            privacy: Telnyx::CallDialParams::Privacy::OrSymbol,
             record: Telnyx::CallDialParams::Record::OrSymbol,
             record_channels: Telnyx::CallDialParams::RecordChannels::OrSymbol,
             record_custom_file_name: String,
@@ -1479,6 +1494,28 @@ module Telnyx
         end
       end
 
+      # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+      # information (name and number) will be hidden from the called party. When set to
+      # `none` or omitted, caller ID will be shown normally.
+      module Privacy
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::CallDialParams::Privacy) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ID = T.let(:id, Telnyx::CallDialParams::Privacy::TaggedSymbol)
+        NONE = T.let(:none, Telnyx::CallDialParams::Privacy::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::CallDialParams::Privacy::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Start recording automatically after an event. Disabled by default.
       module Record
         extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/calls/action_transfer_params.rbi

@@ -188,6 +188,23 @@ module Telnyx
         sig { params(preferred_codecs: String).void }
         attr_writer :preferred_codecs
 
+        # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+        # information (name and number) will be hidden from the called party. When set to
+        # `none` or omitted, caller ID will be shown normally.
+        sig do
+          returns(
+            T.nilable(Telnyx::Calls::ActionTransferParams::Privacy::OrSymbol)
+          )
+        end
+        attr_reader :privacy
+
+        sig do
+          params(
+            privacy: Telnyx::Calls::ActionTransferParams::Privacy::OrSymbol
+          ).void
+        end
+        attr_writer :privacy
+
         # Start recording automatically after an event. Disabled by default.
         sig do
           returns(
@@ -500,6 +517,7 @@ module Telnyx
             mute_dtmf: Telnyx::Calls::ActionTransferParams::MuteDtmf::OrSymbol,
             park_after_unbridge: String,
             preferred_codecs: String,
+            privacy: Telnyx::Calls::ActionTransferParams::Privacy::OrSymbol,
             record: Telnyx::Calls::ActionTransferParams::Record::OrSymbol,
             record_channels:
               Telnyx::Calls::ActionTransferParams::RecordChannels::OrSymbol,
@@ -594,6 +612,10 @@ module Telnyx
           # call. The codecs supported are `G722`, `PCMU`, `PCMA`, `G729`, `OPUS`, `VP8`,
           # `H264`, `AMR-WB`.
           preferred_codecs: nil,
+          # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+          # information (name and number) will be hidden from the called party. When set to
+          # `none` or omitted, caller ID will be shown normally.
+          privacy: nil,
           # Start recording automatically after an event. Disabled by default.
           record: nil,
           # Defines which channel should be recorded ('single' or 'dual') when `record` is
@@ -692,6 +714,7 @@ module Telnyx
                 Telnyx::Calls::ActionTransferParams::MuteDtmf::OrSymbol,
               park_after_unbridge: String,
               preferred_codecs: String,
+              privacy: Telnyx::Calls::ActionTransferParams::Privacy::OrSymbol,
               record: Telnyx::Calls::ActionTransferParams::Record::OrSymbol,
               record_channels:
                 Telnyx::Calls::ActionTransferParams::RecordChannels::OrSymbol,
@@ -1024,6 +1047,40 @@ module Telnyx
           end
         end
 
+        # Indicates the privacy level to be used for the call. When set to `id`, caller ID
+        # information (name and number) will be hidden from the called party. When set to
+        # `none` or omitted, caller ID will be shown normally.
+        module Privacy
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Calls::ActionTransferParams::Privacy)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ID =
+            T.let(
+              :id,
+              Telnyx::Calls::ActionTransferParams::Privacy::TaggedSymbol
+            )
+          NONE =
+            T.let(
+              :none,
+              Telnyx::Calls::ActionTransferParams::Privacy::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Calls::ActionTransferParams::Privacy::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         # Start recording automatically after an event. Disabled by default.
         module Record
           extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/enterprise_create_params.rbi

@@ -287,7 +287,7 @@ module Telnyx
             :"2001-10000",
             Telnyx::EnterpriseCreateParams::NumberOfEmployees::TaggedSymbol
           )
-        NUMBER_OF_EMPLOYEES_10001 =
+        NUMBER_OF_EMPLOYEES_10001_PLUS =
           T.let(
             :"10001+",
             Telnyx::EnterpriseCreateParams::NumberOfEmployees::TaggedSymbol

data/rbi/telnyx/models/enterprise_public.rbi

@@ -314,7 +314,7 @@ module Telnyx
             :"2001-10000",
             Telnyx::EnterprisePublic::NumberOfEmployees::TaggedSymbol
           )
-        NUMBER_OF_EMPLOYEES_10001 =
+        NUMBER_OF_EMPLOYEES_10001_PLUS =
           T.let(
             :"10001+",
             Telnyx::EnterprisePublic::NumberOfEmployees::TaggedSymbol

data/rbi/telnyx/models/enterprise_update_params.rbi

@@ -279,7 +279,7 @@ module Telnyx
             :"2001-10000",
             Telnyx::EnterpriseUpdateParams::NumberOfEmployees::TaggedSymbol
           )
-        NUMBER_OF_EMPLOYEES_10001 =
+        NUMBER_OF_EMPLOYEES_10001_PLUS =
           T.let(
             :"10001+",
             Telnyx::EnterpriseUpdateParams::NumberOfEmployees::TaggedSymbol

data/rbi/telnyx/models/enterprises/reputation/{number_create_params.rbi → number_associate_params.rbi}

@@ -4,14 +4,14 @@ module Telnyx
   module Models
     module Enterprises
       module Reputation
-        class NumberCreateParams < Telnyx::Internal::Type::BaseModel
+        class NumberAssociateParams < Telnyx::Internal::Type::BaseModel
           extend Telnyx::Internal::Type::RequestParameters::Converter
           include Telnyx::Internal::Type::RequestParameters
 
           OrHash =
             T.type_alias do
               T.any(
-                Telnyx::Enterprises::Reputation::NumberCreateParams,
+                Telnyx::Enterprises::Reputation::NumberAssociateParams,
                 Telnyx::Internal::AnyHash
               )
             end