telnyx 5.111.0 → 5.113.0

data/rbi/telnyx/models/calls/action_start_conversation_relay_response.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Calls
+      class ActionStartConversationRelayResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Calls::ActionStartConversationRelayResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Calls::ActionStartConversationRelayResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The ID of the Conversation Relay session created by the command.
+          sig { returns(T.nilable(String)) }
+          attr_reader :conversation_relay_id
+
+          sig { params(conversation_relay_id: String).void }
+          attr_writer :conversation_relay_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :result
+
+          sig { params(result: String).void }
+          attr_writer :result
+
+          sig do
+            params(conversation_relay_id: String, result: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # The ID of the Conversation Relay session created by the command.
+            conversation_relay_id: nil,
+            result: nil
+          )
+          end
+
+          sig do
+            override.returns({ conversation_relay_id: String, result: String })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/calls/action_stop_conversation_relay_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Calls
+      class ActionStopConversationRelayParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Calls::ActionStopConversationRelayParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :call_control_id
+
+        # Use this field to add state to subsequent webhooks. It must be a valid Base-64
+        # encoded string.
+        sig { returns(T.nilable(String)) }
+        attr_reader :client_state
+
+        sig { params(client_state: String).void }
+        attr_writer :client_state
+
+        # Use this field to avoid duplicate commands. Telnyx will ignore any command with
+        # the same `command_id` for the same `call_control_id`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :command_id
+
+        sig { params(command_id: String).void }
+        attr_writer :command_id
+
+        sig do
+          params(
+            call_control_id: String,
+            client_state: String,
+            command_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          call_control_id:,
+          # Use this field to add state to subsequent webhooks. It must be a valid Base-64
+          # encoded string.
+          client_state: nil,
+          # Use this field to avoid duplicate commands. Telnyx will ignore any command with
+          # the same `command_id` for the same `call_control_id`.
+          command_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              call_control_id: String,
+              client_state: String,
+              command_id: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/calls/action_stop_conversation_relay_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Calls
+      class ActionStopConversationRelayResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Calls::ActionStopConversationRelayResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Telnyx::Calls::CallControlCommandResult)) }
+        attr_reader :data
+
+        sig do
+          params(data: Telnyx::Calls::CallControlCommandResult::OrHash).void
+        end
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::Calls::CallControlCommandResult::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns({ data: Telnyx::Calls::CallControlCommandResult })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi

@@ -0,0 +1,289 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Calls
+      class TranscriptionEngineSpeechmaticsConfig < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Whether to send also interim results. If set to false, only final results will
+        # be sent.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :interim_results
+
+        sig { params(interim_results: T::Boolean).void }
+        attr_writer :interim_results
+
+        # Language to use for speech recognition
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::OrSymbol
+            )
+          )
+        end
+        attr_reader :language
+
+        sig do
+          params(
+            language:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::OrSymbol
+          ).void
+        end
+        attr_writer :language
+
+        # Engine identifier for Speechmatics transcription service
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::OrSymbol
+            )
+          )
+        end
+        attr_reader :transcription_engine
+
+        sig do
+          params(
+            transcription_engine:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::OrSymbol
+          ).void
+        end
+        attr_writer :transcription_engine
+
+        # The model to use for transcription.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::OrSymbol
+            )
+          )
+        end
+        attr_reader :transcription_model
+
+        sig do
+          params(
+            transcription_model:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::OrSymbol
+          ).void
+        end
+        attr_writer :transcription_model
+
+        sig do
+          params(
+            interim_results: T::Boolean,
+            language:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::OrSymbol,
+            transcription_engine:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::OrSymbol,
+            transcription_model:
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Whether to send also interim results. If set to false, only final results will
+          # be sent.
+          interim_results: nil,
+          # Language to use for speech recognition
+          language: nil,
+          # Engine identifier for Speechmatics transcription service
+          transcription_engine: nil,
+          # The model to use for transcription.
+          transcription_model: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              interim_results: T::Boolean,
+              language:
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::OrSymbol,
+              transcription_engine:
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::OrSymbol,
+              transcription_model:
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Language to use for speech recognition
+        module Language
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EN =
+            T.let(
+              :en,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          BA =
+            T.let(
+              :ba,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          EU =
+            T.let(
+              :eu,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          GL =
+            T.let(
+              :gl,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          GA =
+            T.let(
+              :ga,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          MT =
+            T.let(
+              :mt,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          MN =
+            T.let(
+              :mn,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          SW =
+            T.let(
+              :sw,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          UG =
+            T.let(
+              :ug,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          CY =
+            T.let(
+              :cy,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          AR_EN =
+            T.let(
+              :ar_en,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          CMN_EN =
+            T.let(
+              :cmn_en,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          EN_MS =
+            T.let(
+              :en_ms,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          EN_TA =
+            T.let(
+              :en_ta,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          TL =
+            T.let(
+              :tl,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          ES_BILINGUAL_EN =
+            T.let(
+              :"es-bilingual-en",
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+          CMN_EN_MS_TA =
+            T.let(
+              :cmn_en_ms_ta,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::Language::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Engine identifier for Speechmatics transcription service
+        module TranscriptionEngine
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SPEECHMATICS =
+            T.let(
+              :Speechmatics,
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionEngine::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The model to use for transcription.
+        module TranscriptionModel
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SPEECHMATICS_STANDARD =
+            T.let(
+              :"speechmatics/standard",
+              Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::TranscriptionModel::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/calls/transcription_start_request.rbi

@@ -56,6 +56,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAzureConfig,
                 Telnyx::Calls::TranscriptionEngineXaiConfig,
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                 Telnyx::Calls::TranscriptionEngineAConfig,
                 Telnyx::Calls::TranscriptionEngineBConfig,
                 Telnyx::Calls::DeepgramNova2Config,
@@ -75,6 +76,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAzureConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineXaiConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
                 Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -106,6 +108,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAzureConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineXaiConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::OrHash,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineAConfig::OrHash,
                 Telnyx::Calls::TranscriptionEngineBConfig::OrHash,
                 Telnyx::Calls::DeepgramNova2Config::OrHash,
@@ -146,6 +149,7 @@ module Telnyx
                   Telnyx::Calls::TranscriptionEngineAzureConfig,
                   Telnyx::Calls::TranscriptionEngineXaiConfig,
                   Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
+                  Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                   Telnyx::Calls::TranscriptionEngineAConfig,
                   Telnyx::Calls::TranscriptionEngineBConfig,
                   Telnyx::Calls::DeepgramNova2Config,
@@ -202,6 +206,11 @@ module Telnyx
               :AssemblyAI,
               Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngine::TaggedSymbol
             )
+          SPEECHMATICS =
+            T.let(
+              :Speechmatics,
+              Telnyx::Calls::TranscriptionStartRequest::TranscriptionEngine::TaggedSymbol
+            )
           A =
             T.let(
               :A,
@@ -235,6 +244,7 @@ module Telnyx
                 Telnyx::Calls::TranscriptionEngineAzureConfig,
                 Telnyx::Calls::TranscriptionEngineXaiConfig,
                 Telnyx::Calls::TranscriptionEngineAssemblyaiConfig,
+                Telnyx::Calls::TranscriptionEngineSpeechmaticsConfig,
                 Telnyx::Calls::TranscriptionEngineAConfig,
                 Telnyx::Calls::TranscriptionEngineBConfig,
                 Telnyx::Calls::DeepgramNova2Config,

data/rbi/telnyx/models/fax.rbi

@@ -56,16 +56,18 @@ module Telnyx
       attr_writer :from_display_name
 
       # The media_name used for the fax's media. Must point to a file previously
-      # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-      # and media_url/contents can't be submitted together.
+      # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+      # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+      # media_url/contents can't be submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_name
 
       sig { params(media_name: String).void }
       attr_writer :media_name
 
-      # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-      # media_name/contents can't be submitted together.
+      # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+      # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+      # submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_url
 
@@ -187,11 +189,13 @@ module Telnyx
         # destination (`to` number).
         from_display_name: nil,
         # The media_name used for the fax's media. Must point to a file previously
-        # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-        # and media_url/contents can't be submitted together.
+        # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+        # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+        # media_url/contents can't be submitted together.
         media_name: nil,
-        # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-        # media_name/contents can't be submitted together.
+        # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+        # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+        # submitted together.
         media_url: nil,
         # If `store_preview` was set to `true`, this is a link to temporary location. Link
         # expires after 10 minutes.

data/rbi/telnyx/models/fax_create_params.rbi

@@ -51,16 +51,18 @@ module Telnyx
       attr_writer :from_display_name
 
       # The media_name used for the fax's media. Must point to a file previously
-      # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-      # and media_url/contents can't be submitted together.
+      # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+      # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+      # media_url/contents can't be submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_name
 
       sig { params(media_name: String).void }
       attr_writer :media_name
 
-      # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-      # media_name/contents can't be submitted together.
+      # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+      # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+      # submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_url
 
@@ -166,11 +168,13 @@ module Telnyx
         # number in the `from` field.
         from_display_name: nil,
         # The media_name used for the fax's media. Must point to a file previously
-        # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-        # and media_url/contents can't be submitted together.
+        # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+        # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+        # media_url/contents can't be submitted together.
         media_name: nil,
-        # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-        # media_name/contents can't be submitted together.
+        # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+        # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+        # submitted together.
         media_url: nil,
         # The flag to enable monochrome, true black and white fax results.
         monochrome: nil,

data/rbi/telnyx/models/fax_delivered.rbi

@@ -222,8 +222,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -307,8 +308,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/fax_failed.rbi

@@ -219,8 +219,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -294,8 +295,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted