telnyx 5.171.0 → 5.174.0

data/lib/telnyx/models/ai/transcription_settings_config.rb

@@ -33,9 +33,10 @@ module Telnyx
         optional :enable_endpoint_detection, Telnyx::Internal::Type::Boolean
 
         # @!attribute end_of_turn_confidence_threshold
-        #   Available only for assemblyai/universal-3-5-pro (and its legacy alias
-        #   assemblyai/universal-streaming). Confidence level required to trigger an end of
-        #   turn. Higher values require more certainty before ending a turn.
+        #   @deprecated
+        #
+        #   Deprecated and ignored. Accepted for backwards compatibility. AssemblyAI turn
+        #   detection is configured with min_turn_silence and max_turn_silence.
         #
         #   @return [Float, nil]
         optional :end_of_turn_confidence_threshold, Float
@@ -62,10 +63,13 @@ module Telnyx
         optional :interim_results, Telnyx::Internal::Type::Boolean
 
         # @!attribute keyterm
-        #   Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
-        #   key terms to boost for recognition during transcription. Helps improve accuracy
-        #   for domain-specific terminology, proper nouns, or uncommon words. This field may
-        #   be templated with
+        #   A comma-separated list of key terms to boost for recognition during
+        #   transcription, used by Deepgram, Reson8, Speechmatics Linden 1 and AssemblyAI
+        #   models. Helps improve accuracy for domain-specific terminology, proper nouns, or
+        #   uncommon words. At most 1000 characters in total. For
+        #   assemblyai/universal-3-6-pro (and its legacy aliases
+        #   assemblyai/universal-3-5-pro and assemblyai/universal-streaming), also at most
+        #   100 terms of up to 50 characters each. This field may be templated with
         #   [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
         #   using mustache syntax (e.g. `Telnyx,{{customer_name}},VoIP`). Variables are
         #   resolved at call time before the value is sent to the speech-to-text engine.
@@ -90,17 +94,18 @@ module Telnyx
         optional :max_endpoint_delay_ms, Integer
 
         # @!attribute max_turn_silence
-        #   Available only for assemblyai/universal-3-5-pro (and its legacy alias
-        #   assemblyai/universal-streaming). Maximum duration of silence in milliseconds
-        #   before forcing an end of turn.
+        #   Available only for assemblyai/universal-3-6-pro (and its legacy aliases
+        #   assemblyai/universal-3-5-pro and assemblyai/universal-streaming). Maximum
+        #   duration of silence in milliseconds before forcing an end of turn.
         #
         #   @return [Integer, nil]
         optional :max_turn_silence, Integer
 
         # @!attribute min_turn_silence
-        #   Available only for assemblyai/universal-3-5-pro (and its legacy alias
-        #   assemblyai/universal-streaming). Minimum duration of silence in milliseconds
-        #   before a turn can end. Must be less than or equal to max_turn_silence.
+        #   Available only for assemblyai/universal-3-6-pro (and its legacy aliases
+        #   assemblyai/universal-3-5-pro and assemblyai/universal-streaming). Minimum
+        #   duration of silence in milliseconds before a turn can end. Must be less than or
+        #   equal to max_turn_silence.
         #
         #   @return [Integer, nil]
         optional :min_turn_silence, Integer
@@ -110,12 +115,33 @@ module Telnyx
         #   @return [Boolean, nil]
         optional :numerals, Telnyx::Internal::Type::Boolean
 
+        # @!attribute prompt
+        #   Available only for assemblyai/universal-3-6-pro (and its legacy aliases
+        #   assemblyai/universal-3-5-pro and assemblyai/universal-streaming). Context about
+        #   the conversation (domain, names, terms) to improve transcription; describe the
+        #   content, do not give instructions. Leave empty unless needed. At most 1750
+        #   characters.
+        #
+        #   @return [String, nil]
+        optional :prompt, String
+
+        # @!attribute remove_disfluencies
+        #   Available only for speechmatics/linden-1. When true, filler words such as "um"
+        #   and "uh" are removed from the transcript. Disfluency removal is supported only
+        #   for `ar`, `cmn`, `da`, `de`, `el`, `en`, `es`, `fr`, `he`, `hi`, `hu`, `it`,
+        #   `ja`, `nl`, `pl`, `pt`, and `ru`, determined by the base language (so `en-US`,
+        #   `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant` are supported); for other
+        #   languages, filler words remain in the transcript.
+        #
+        #   @return [Boolean, nil]
+        optional :remove_disfluencies, Telnyx::Internal::Type::Boolean
+
         # @!attribute smart_format
         #
         #   @return [Boolean, nil]
         optional :smart_format, Telnyx::Internal::Type::Boolean
 
-        # @!method initialize(context: nil, eager_eot_threshold: nil, enable_endpoint_detection: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, interim_results: nil, keyterm: nil, language_hints: nil, max_endpoint_delay_ms: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, smart_format: nil)
+        # @!method initialize(context: nil, eager_eot_threshold: nil, enable_endpoint_detection: nil, end_of_turn_confidence_threshold: nil, eot_threshold: nil, eot_timeout_ms: nil, interim_results: nil, keyterm: nil, language_hints: nil, max_endpoint_delay_ms: nil, max_turn_silence: nil, min_turn_silence: nil, numerals: nil, prompt: nil, remove_disfluencies: nil, smart_format: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::TranscriptionSettingsConfig} for more details.
         #
@@ -125,7 +151,7 @@ module Telnyx
         #
         #   @param enable_endpoint_detection [Boolean] Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox emit
         #
-        #   @param end_of_turn_confidence_threshold [Float] Available only for assemblyai/universal-3-5-pro (and its legacy alias assemblyai
+        #   @param end_of_turn_confidence_threshold [Float] Deprecated and ignored. Accepted for backwards compatibility. AssemblyAI turn de
         #
         #   @param eot_threshold [Float] Available only for deepgram/flux. Confidence required to trigger an end of turn.
         #
@@ -133,18 +159,22 @@ module Telnyx
         #
         #   @param interim_results [Boolean] Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. When true, Soniox stre
         #
-        #   @param keyterm [String] Available only for deepgram/nova-3 and deepgram/flux. A comma-separated list of
+        #   @param keyterm [String] A comma-separated list of key terms to boost for recognition during transcriptio
         #
         #   @param language_hints [Array<String>] Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A list of ISO 639-1 la
         #
         #   @param max_endpoint_delay_ms [Integer] Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. Maximum silence (in mi
         #
-        #   @param max_turn_silence [Integer] Available only for assemblyai/universal-3-5-pro (and its legacy alias assemblyai
+        #   @param max_turn_silence [Integer] Available only for assemblyai/universal-3-6-pro (and its legacy aliases assembly
         #
-        #   @param min_turn_silence [Integer] Available only for assemblyai/universal-3-5-pro (and its legacy alias assemblyai
+        #   @param min_turn_silence [Integer] Available only for assemblyai/universal-3-6-pro (and its legacy aliases assembly
         #
         #   @param numerals [Boolean]
         #
+        #   @param prompt [String] Available only for assemblyai/universal-3-6-pro (and its legacy aliases assembly
+        #
+        #   @param remove_disfluencies [Boolean] Available only for speechmatics/linden-1. When true, filler words such as "um" a
+        #
         #   @param smart_format [Boolean]
       end
     end

data/lib/telnyx/models/ai/vision_tool_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class VisionToolParams < Telnyx::Internal::Type::BaseModel
+        # @!attribute max_frame_age_secs
+        #   Frames received longer ago than this many seconds are not shown to the
+        #   assistant, so it never describes a frozen or disconnected camera as live.
+        #
+        #   @return [Integer, nil]
+        optional :max_frame_age_secs, Integer
+
+        # @!method initialize(max_frame_age_secs: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::VisionToolParams} for more details.
+        #
+        #   @param max_frame_age_secs [Integer] Frames received longer ago than this many seconds are not shown to the assistant
+      end
+    end
+  end
+end

data/lib/telnyx/models/api_error.rb

@@ -18,6 +18,12 @@ module Telnyx
       #   @return [String, nil]
       optional :description, String
 
+      # @!attribute detail
+      #   A human-readable explanation of the error.
+      #
+      #   @return [String, nil]
+      optional :detail, String
+
       # @!attribute meta
       #
       #   @return [Hash{Symbol=>Object}, nil]
@@ -28,11 +34,17 @@ module Telnyx
       #   @return [Telnyx::Models::APIError::Source, nil]
       optional :source, -> { Telnyx::APIError::Source }
 
-      # @!method initialize(code:, title:, description: nil, meta: nil, source: nil)
+      # @!method initialize(code:, title:, description: nil, detail: nil, meta: nil, source: nil)
       #   @param code [String]
+      #
       #   @param title [String]
+      #
       #   @param description [String]
+      #
+      #   @param detail [String] A human-readable explanation of the error.
+      #
       #   @param meta [Hash{Symbol=>Object}]
+      #
       #   @param source [Telnyx::Models::APIError::Source]
 
       # @see Telnyx::Models::APIError#source

data/lib/telnyx/models/artifact_download_retrieve_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::ArtifactDownloads#retrieve
+    class ArtifactDownloadRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute artifact_id
+      #
+      #   @return [String]
+      required :artifact_id, String
+
+      # @!attribute expires
+      #
+      #   @return [String]
+      required :expires, String
+
+      # @!attribute sig_
+      #
+      #   @return [String]
+      required :sig_, String
+
+      # @!method initialize(artifact_id:, expires:, sig_:, request_options: {})
+      #   @param artifact_id [String]
+      #   @param expires [String]
+      #   @param sig_ [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/available_service.rb

@@ -7,6 +7,7 @@ module Telnyx
 
       CLOUD_VPN = :cloud_vpn
       PRIVATE_WIRELESS_GATEWAY = :private_wireless_gateway
+      TAILSCALE_SUBNET_ROUTER = :tailscale_subnet_router
       VIRTUAL_CROSS_CONNECT = :virtual_cross_connect
 
       # @!method self.values

data/lib/telnyx/models/browser_session_create_params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#create
+    class BrowserSessionCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute policy
+      #
+      #   @return [Telnyx::Models::BrowserSessionCreateParams::Policy]
+      required :policy, -> { Telnyx::BrowserSessionCreateParams::Policy }
+
+      # @!attribute idempotency_key
+      #   Scoped to the organization. The same key and identical normalized policy,
+      #   limits, and metadata replay the existing session (HTTP 201); a different request
+      #   returns 409 idempotency_conflict. Replays do not restart terminal sessions.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limits
+      #
+      #   @return [Telnyx::Models::BrowserSessionCreateParams::Limits, nil]
+      optional :limits, -> { Telnyx::BrowserSessionCreateParams::Limits }
+
+      # @!attribute metadata
+      #   Arbitrary key-value metadata.
+      #
+      #   @return [Object, nil]
+      optional :metadata, Telnyx::Internal::Type::Unknown
+
+      # @!method initialize(policy:, idempotency_key: nil, limits: nil, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::BrowserSessionCreateParams} for more details.
+      #
+      #   @param policy [Telnyx::Models::BrowserSessionCreateParams::Policy]
+      #
+      #   @param idempotency_key [String] Scoped to the organization. The same key and identical normalized policy, limits
+      #
+      #   @param limits [Telnyx::Models::BrowserSessionCreateParams::Limits]
+      #
+      #   @param metadata [Object] Arbitrary key-value metadata.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class Policy < Telnyx::Internal::Type::BaseModel
+        # @!attribute allowed_domains
+        #   Domain patterns the browser can navigate to. Exact match (example.com) or
+        #   wildcard (\*.example.com). IP literals not allowed.
+        #
+        #   @return [Array<String>]
+        required :allowed_domains, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(allowed_domains:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::BrowserSessionCreateParams::Policy} for more details.
+        #
+        #   @param allowed_domains [Array<String>] Domain patterns the browser can navigate to. Exact match (example.com) or wildca
+      end
+
+      class Limits < Telnyx::Internal::Type::BaseModel
+        # @!attribute idle_timeout_s
+        #   Idle timeout in seconds. Must not exceed lifetime_s.
+        #
+        #   @return [Integer, nil]
+        optional :idle_timeout_s, Integer
+
+        # @!attribute lifetime_s
+        #   Max session duration in seconds (60-1800).
+        #
+        #   @return [Integer, nil]
+        optional :lifetime_s, Integer
+
+        # @!method initialize(idle_timeout_s: nil, lifetime_s: nil)
+        #   @param idle_timeout_s [Integer] Idle timeout in seconds. Must not exceed lifetime_s.
+        #
+        #   @param lifetime_s [Integer] Max session duration in seconds (60-1800).
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_session_create_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#create
+    class BrowserSessionCreateResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::Session, nil]
+      optional :data, -> { Telnyx::Session }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::Session]
+    end
+  end
+end

data/lib/telnyx/models/{meeting_session_retrieve_recordings_params.rb → browser_session_delete_params.rb}

@@ -2,8 +2,8 @@
 
 module Telnyx
   module Models
-    # @see Telnyx::Resources::MeetingSessions#retrieve_recordings
-    class MeetingSessionRetrieveRecordingsParams < Telnyx::Internal::Type::BaseModel
+    # @see Telnyx::Resources::BrowserSessions#delete
+    class BrowserSessionDeleteParams < Telnyx::Internal::Type::BaseModel
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 

data/lib/telnyx/models/browser_session_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#delete
+    class BrowserSessionDeleteResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::Session, nil]
+      optional :data, -> { Telnyx::Session }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::Session]
+    end
+  end
+end

data/lib/telnyx/models/browser_session_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#list
+    class BrowserSessionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Telnyx::Models::BrowserSessionListParams::Status, nil]
+      optional :status, enum: -> { Telnyx::BrowserSessionListParams::Status }
+
+      # @!method initialize(status: nil, request_options: {})
+      #   @param status [Symbol, Telnyx::Models::BrowserSessionListParams::Status]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        PROVISIONING = :provisioning
+        READY = :ready
+        CLOSING = :closing
+        CLOSED = :closed
+        FAILED = :failed
+        EXPIRED = :expired
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_session_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#list
+    class BrowserSessionListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::Session>, nil]
+      optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Session] }
+
+      # @!method initialize(data: nil)
+      #   @param data [Array<Telnyx::Models::Session>]
+    end
+  end
+end

data/lib/telnyx/models/browser_session_retrieve_artifact_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#retrieve_artifact
+    class BrowserSessionRetrieveArtifactParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute artifact_id
+      #
+      #   @return [String]
+      required :artifact_id, String
+
+      # @!method initialize(id:, artifact_id:, request_options: {})
+      #   @param id [String]
+      #   @param artifact_id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/browser_session_retrieve_artifact_response.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#retrieve_artifact
+    class BrowserSessionRetrieveArtifactResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::BrowserSessionRetrieveArtifactResponse::Data, nil]
+      optional :data, -> { Telnyx::Models::BrowserSessionRetrieveArtifactResponse::Data }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::BrowserSessionRetrieveArtifactResponse::Data]
+
+      # @see Telnyx::Models::BrowserSessionRetrieveArtifactResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute action_id
+        #
+        #   @return [String]
+        required :action_id, String
+
+        # @!attribute checksum
+        #
+        #   @return [String]
+        required :checksum, String
+
+        # @!attribute content_type
+        #
+        #   @return [String]
+        required :content_type, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute download_url
+        #   Signed relative path (starts with /v2/artifact_downloads/). Prepend your API
+        #   host, e.g. https://api.telnyx.com, before calling it.
+        #
+        #   @return [String]
+        required :download_url, String
+
+        # @!attribute expires_at
+        #
+        #   @return [Time]
+        required :expires_at, Time
+
+        # @!attribute session_id
+        #
+        #   @return [String]
+        required :session_id, String
+
+        # @!attribute size_bytes
+        #
+        #   @return [Integer]
+        required :size_bytes, Integer
+
+        # @!attribute type
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!method initialize(id:, action_id:, checksum:, content_type:, created_at:, download_url:, expires_at:, session_id:, size_bytes:, type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::BrowserSessionRetrieveArtifactResponse::Data} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param action_id [String]
+        #
+        #   @param checksum [String]
+        #
+        #   @param content_type [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param download_url [String] Signed relative path (starts with /v2/artifact_downloads/). Prepend your API hos
+        #
+        #   @param expires_at [Time]
+        #
+        #   @param session_id [String]
+        #
+        #   @param size_bytes [Integer]
+        #
+        #   @param type [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/browser_session_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#retrieve
+    class BrowserSessionRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/browser_session_retrieve_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::BrowserSessions#retrieve
+    class BrowserSessionRetrieveResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::Session, nil]
+      optional :data, -> { Telnyx::Session }
+
+      # @!method initialize(data: nil)
+      #   @param data [Telnyx::Models::Session]
+    end
+  end
+end