telnyx 5.82.0 → 5.84.0

data/rbi/telnyx/models/text_to_speech_generate_params.rbi

@@ -177,6 +177,15 @@ module Telnyx
       sig { params(voice_settings: T::Hash[Symbol, T.anything]).void }
       attr_writer :voice_settings
 
+      # xAI provider-specific parameters.
+      sig { returns(T.nilable(::Telnyx::TextToSpeechGenerateParams::Xai)) }
+      attr_reader :xai
+
+      sig do
+        params(xai: ::Telnyx::TextToSpeechGenerateParams::Xai::OrHash).void
+      end
+      attr_writer :xai
+
       sig do
         params(
           aws: ::Telnyx::TextToSpeechGenerateParams::Aws::OrHash,
@@ -195,6 +204,7 @@ module Telnyx
           text_type: ::Telnyx::TextToSpeechGenerateParams::TextType::OrSymbol,
           voice: String,
           voice_settings: T::Hash[Symbol, T.anything],
+          xai: ::Telnyx::TextToSpeechGenerateParams::Xai::OrHash,
           request_options: ::Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -238,6 +248,8 @@ module Telnyx
         # Provider-specific voice settings. Contents vary by provider — see
         # provider-specific parameter objects below.
         voice_settings: nil,
+        # xAI provider-specific parameters.
+        xai: nil,
         request_options: {}
       )
       end
@@ -261,6 +273,7 @@ module Telnyx
             text_type: ::Telnyx::TextToSpeechGenerateParams::TextType::OrSymbol,
             voice: String,
             voice_settings: T::Hash[Symbol, T.anything],
+            xai: ::Telnyx::TextToSpeechGenerateParams::Xai,
             request_options: ::Telnyx::RequestOptions
           }
         )
@@ -782,6 +795,11 @@ module Telnyx
             :resemble,
             ::Telnyx::TextToSpeechGenerateParams::Provider::TaggedSymbol
           )
+        XAI =
+          T.let(
+            :xai,
+            ::Telnyx::TextToSpeechGenerateParams::Provider::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -1130,6 +1148,257 @@ module Telnyx
         def self.values
         end
       end
+
+      class Xai < ::Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ::Telnyx::TextToSpeechGenerateParams::Xai,
+              ::Telnyx::Internal::AnyHash
+            )
+          end
+
+        # xAI voice identifier.
+        sig do
+          returns(::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::OrSymbol)
+        end
+        attr_accessor :voice_id
+
+        # Language code, or `auto` to detect.
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        # Audio output format.
+        sig do
+          returns(
+            T.nilable(
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::OrSymbol
+            )
+          )
+        end
+        attr_reader :output_format
+
+        sig do
+          params(
+            output_format:
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::OrSymbol
+          ).void
+        end
+        attr_writer :output_format
+
+        # Audio sample rate in Hz.
+        sig do
+          returns(
+            T.nilable(
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::OrInteger
+            )
+          )
+        end
+        attr_reader :sample_rate
+
+        sig do
+          params(
+            sample_rate:
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::OrInteger
+          ).void
+        end
+        attr_writer :sample_rate
+
+        # xAI provider-specific parameters.
+        sig do
+          params(
+            voice_id:
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::OrSymbol,
+            language: String,
+            output_format:
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::OrSymbol,
+            sample_rate:
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::OrInteger
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # xAI voice identifier.
+          voice_id:,
+          # Language code, or `auto` to detect.
+          language: nil,
+          # Audio output format.
+          output_format: nil,
+          # Audio sample rate in Hz.
+          sample_rate: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              voice_id:
+                ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::OrSymbol,
+              language: String,
+              output_format:
+                ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::OrSymbol,
+              sample_rate:
+                ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::OrInteger
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # xAI voice identifier.
+        module VoiceID
+          extend ::Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EVE =
+            T.let(
+              :eve,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+            )
+          ARA =
+            T.let(
+              :ara,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+            )
+          REX =
+            T.let(
+              :rex,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+            )
+          SAL =
+            T.let(
+              :sal,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+            )
+          LEO =
+            T.let(
+              :leo,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ::Telnyx::TextToSpeechGenerateParams::Xai::VoiceID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Audio output format.
+        module OutputFormat
+          extend ::Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          MP3 =
+            T.let(
+              :mp3,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+            )
+          WAV =
+            T.let(
+              :wav,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+            )
+          PCM =
+            T.let(
+              :pcm,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+            )
+          MULAW =
+            T.let(
+              :mulaw,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+            )
+          ALAW =
+            T.let(
+              :alaw,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ::Telnyx::TextToSpeechGenerateParams::Xai::OutputFormat::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Audio sample rate in Hz.
+        module SampleRate
+          extend ::Telnyx::Internal::Type::Enum
+
+          TaggedInteger =
+            T.type_alias do
+              T.all(
+                Integer,
+                ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate
+              )
+            end
+          OrInteger = T.type_alias { Integer }
+
+          SAMPLE_RATE_8000 =
+            T.let(
+              8000,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+          SAMPLE_RATE_16000 =
+            T.let(
+              16_000,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+          SAMPLE_RATE_22050 =
+            T.let(
+              22_050,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+          SAMPLE_RATE_24000 =
+            T.let(
+              24_000,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+          SAMPLE_RATE_44100 =
+            T.let(
+              44_100,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+          SAMPLE_RATE_48000 =
+            T.let(
+              48_000,
+              ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ::Telnyx::TextToSpeechGenerateParams::Xai::SampleRate::TaggedInteger
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi

@@ -106,6 +106,11 @@ module Telnyx
             :resemble,
             Telnyx::TextToSpeechListVoicesParams::Provider::TaggedSymbol
           )
+        XAI =
+          T.let(
+            :xai,
+            Telnyx::TextToSpeechListVoicesParams::Provider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi

@@ -24,6 +24,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -46,6 +47,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,

data/rbi/telnyx/models/unwrap_webhook_event.rbi

@@ -24,6 +24,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -46,6 +47,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,

data/rbi/telnyx/models.rbi

@@ -233,6 +233,8 @@ module Telnyx
 
   CallHangupWebhookEvent = Telnyx::Models::CallHangupWebhookEvent
 
+  CallHoldWebhookEvent = Telnyx::Models::CallHoldWebhookEvent
+
   CallInitiated = Telnyx::Models::CallInitiated
 
   CallInitiatedWebhookEvent = Telnyx::Models::CallInitiatedWebhookEvent
@@ -340,6 +342,8 @@ module Telnyx
   CallStreamingStoppedWebhookEvent =
     Telnyx::Models::CallStreamingStoppedWebhookEvent
 
+  CallUnholdWebhookEvent = Telnyx::Models::CallUnholdWebhookEvent
+
   CampaignStatusUpdate = Telnyx::Models::CampaignStatusUpdate
 
   ChannelZoneListParams = Telnyx::Models::ChannelZoneListParams

data/rbi/telnyx/resources/calls/actions.rbi

@@ -45,6 +45,7 @@ module Telnyx
         # **Expected Webhooks:**
         #
         # - `call.answered`
+        # - `call.hold` and `call.unhold` if the call is held/unheld
         # - `call.deepfake_detection.result` if `deepfake_detection` was enabled
         # - `call.deepfake_detection.error` if `deepfake_detection` was enabled and an
         #   error occurred

data/rbi/telnyx/resources/calls.rbi

@@ -15,6 +15,7 @@ module Telnyx
       #
       # - `call.initiated`
       # - `call.answered` or `call.hangup`
+      # - `call.hold` and `call.unhold` if the call is held/unheld
       # - `call.machine.detection.ended` if `answering_machine_detection` was requested
       # - `call.machine.greeting.ended` if `answering_machine_detection` was requested
       #   to detect the end of machine greeting

data/rbi/telnyx/resources/text_to_speech.rbi

@@ -17,7 +17,7 @@ module Telnyx
       # with provider-specific parameters.
       #
       # Supported providers: `aws`, `telnyx`, `azure`, `elevenlabs`, `minimax`, `rime`,
-      # `resemble`.
+      # `resemble`, `xai`.
       #
       # The Telnyx `Ultra` model supports 44 languages with emotion control, speed
       # adjustment, and volume control. Use the `telnyx` provider-specific parameters to
@@ -40,6 +40,7 @@ module Telnyx
           text_type: ::Telnyx::TextToSpeechGenerateParams::TextType::OrSymbol,
           voice: String,
           voice_settings: T::Hash[Symbol, T.anything],
+          xai: ::Telnyx::TextToSpeechGenerateParams::Xai::OrHash,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(Telnyx::Models::TextToSpeechGenerateResponse)
       end
@@ -83,6 +84,8 @@ module Telnyx
         # Provider-specific voice settings. Contents vary by provider — see
         # provider-specific parameter objects below.
         voice_settings: nil,
+        # xAI provider-specific parameters.
+        xai: nil,
         request_options: {}
       )
       end

data/rbi/telnyx/resources/webhooks.rbi

@@ -22,6 +22,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -44,6 +45,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,
@@ -102,6 +104,7 @@ module Telnyx
             Telnyx::CallForkStoppedWebhookEvent,
             Telnyx::CallGatherEndedWebhookEvent,
             Telnyx::CallHangupWebhookEvent,
+            Telnyx::CallHoldWebhookEvent,
             Telnyx::CallInitiatedWebhookEvent,
             Telnyx::CallLeftQueueWebhookEvent,
             Telnyx::CallMachineDetectionEndedWebhookEvent,
@@ -124,6 +127,7 @@ module Telnyx
             Telnyx::CallStreamingFailedWebhookEvent,
             Telnyx::CallStreamingStartedWebhookEvent,
             Telnyx::CallStreamingStoppedWebhookEvent,
+            Telnyx::CallUnholdWebhookEvent,
             Telnyx::CampaignStatusUpdate,
             Telnyx::ConferenceCreatedWebhookEvent,
             Telnyx::ConferenceEndedWebhookEvent,

data/sig/telnyx/models/call_hold_webhook_event.rbs

@@ -0,0 +1,151 @@
+module Telnyx
+  module Models
+    type call_hold_webhook_event = { data: Telnyx::CallHoldWebhookEvent::Data }
+
+    class CallHoldWebhookEvent < Telnyx::Internal::Type::BaseModel
+      attr_reader data: Telnyx::CallHoldWebhookEvent::Data?
+
+      def data=: (
+        Telnyx::CallHoldWebhookEvent::Data
+      ) -> Telnyx::CallHoldWebhookEvent::Data
+
+      def initialize: (?data: Telnyx::CallHoldWebhookEvent::Data) -> void
+
+      def to_hash: -> { data: Telnyx::CallHoldWebhookEvent::Data }
+
+      type data =
+        {
+          id: String,
+          event_type: Telnyx::Models::CallHoldWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallHoldWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallHoldWebhookEvent::Data::record_type
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_reader id: String?
+
+        def id=: (String) -> String
+
+        attr_reader event_type: Telnyx::Models::CallHoldWebhookEvent::Data::event_type?
+
+        def event_type=: (
+          Telnyx::Models::CallHoldWebhookEvent::Data::event_type
+        ) -> Telnyx::Models::CallHoldWebhookEvent::Data::event_type
+
+        attr_reader occurred_at: Time?
+
+        def occurred_at=: (Time) -> Time
+
+        attr_reader payload: Telnyx::CallHoldWebhookEvent::Data::Payload?
+
+        def payload=: (
+          Telnyx::CallHoldWebhookEvent::Data::Payload
+        ) -> Telnyx::CallHoldWebhookEvent::Data::Payload
+
+        attr_reader record_type: Telnyx::Models::CallHoldWebhookEvent::Data::record_type?
+
+        def record_type=: (
+          Telnyx::Models::CallHoldWebhookEvent::Data::record_type
+        ) -> Telnyx::Models::CallHoldWebhookEvent::Data::record_type
+
+        def initialize: (
+          ?id: String,
+          ?event_type: Telnyx::Models::CallHoldWebhookEvent::Data::event_type,
+          ?occurred_at: Time,
+          ?payload: Telnyx::CallHoldWebhookEvent::Data::Payload,
+          ?record_type: Telnyx::Models::CallHoldWebhookEvent::Data::record_type
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          event_type: Telnyx::Models::CallHoldWebhookEvent::Data::event_type,
+          occurred_at: Time,
+          payload: Telnyx::CallHoldWebhookEvent::Data::Payload,
+          record_type: Telnyx::Models::CallHoldWebhookEvent::Data::record_type
+        }
+
+        type event_type = :"call.hold"
+
+        module EventType
+          extend Telnyx::Internal::Type::Enum
+
+          CALL_HOLD: :"call.hold"
+
+          def self?.values: -> ::Array[Telnyx::Models::CallHoldWebhookEvent::Data::event_type]
+        end
+
+        type payload =
+          {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            client_state: String,
+            connection_id: String,
+            from: String,
+            to: String
+          }
+
+        class Payload < Telnyx::Internal::Type::BaseModel
+          attr_reader call_control_id: String?
+
+          def call_control_id=: (String) -> String
+
+          attr_reader call_leg_id: String?
+
+          def call_leg_id=: (String) -> String
+
+          attr_reader call_session_id: String?
+
+          def call_session_id=: (String) -> String
+
+          attr_reader client_state: String?
+
+          def client_state=: (String) -> String
+
+          attr_reader connection_id: String?
+
+          def connection_id=: (String) -> String
+
+          attr_reader from: String?
+
+          def from=: (String) -> String
+
+          attr_reader to: String?
+
+          def to=: (String) -> String
+
+          def initialize: (
+            ?call_control_id: String,
+            ?call_leg_id: String,
+            ?call_session_id: String,
+            ?client_state: String,
+            ?connection_id: String,
+            ?from: String,
+            ?to: String
+          ) -> void
+
+          def to_hash: -> {
+            call_control_id: String,
+            call_leg_id: String,
+            call_session_id: String,
+            client_state: String,
+            connection_id: String,
+            from: String,
+            to: String
+          }
+        end
+
+        type record_type = :event
+
+        module RecordType
+          extend Telnyx::Internal::Type::Enum
+
+          EVENT: :event
+
+          def self?.values: -> ::Array[Telnyx::Models::CallHoldWebhookEvent::Data::record_type]
+        end
+      end
+    end
+  end
+end