telnyx 5.119.0 → 5.121.0

data/lib/telnyx/models/conferences/action_speak_params.rb

@@ -52,8 +52,8 @@ module Telnyx
         #     `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
         #     to configure speed, volume, pitch, and language_boost.
         #   - **Rime:** Use `Rime.<model_id>.<voice_id>` (e.g., `Rime.Arcana.cove`).
-        #     Supported model_ids: `Arcana`, `Mist`. Use `voice_settings` to configure
-        #     voice_speed.
+        #     Supported model_ids: `Arcana`, `Mist`, `ArcanaV3`, `Coda`. Use
+        #     `voice_settings` to configure voice_speed.
         #   - **Resemble:** Use `Resemble.Turbo.<voice_id>` (e.g.,
         #     `Resemble.Turbo.my_voice`). Only `Turbo` model is supported. Use
         #     `voice_settings` to configure precision, sample_rate, and format.

data/lib/telnyx/models/voice_sdk_call_report_list_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::VoiceSDKCallReports#list
+    class VoiceSDKCallReportListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute page_number
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute sort
+      #   Set the order of the results by creation date. `asc` and `created_at` sort
+      #   oldest reports first; `desc` and `-created_at` sort newest reports first. If not
+      #   given, results are sorted by creation date in descending order.
+      #
+      #   @return [Symbol, Telnyx::Models::VoiceSDKCallReportListParams::Sort, nil]
+      optional :sort, enum: -> { Telnyx::VoiceSDKCallReportListParams::Sort }
+
+      # @!method initialize(page_number: nil, page_size: nil, sort: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::VoiceSDKCallReportListParams} for more details.
+      #
+      #   @param page_number [Integer]
+      #
+      #   @param page_size [Integer]
+      #
+      #   @param sort [Symbol, Telnyx::Models::VoiceSDKCallReportListParams::Sort] Set the order of the results by creation date. `asc` and `created_at` sort oldes
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Set the order of the results by creation date. `asc` and `created_at` sort
+      # oldest reports first; `desc` and `-created_at` sort newest reports first. If not
+      # given, results are sorted by creation date in descending order.
+      module Sort
+        extend Telnyx::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+        CREATED_AT = :created_at
+        CREATED_AT_DESC = :"-created_at"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/voice_sdk_call_report_list_response.rb

@@ -0,0 +1,385 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::VoiceSDKCallReports#list
+    class VoiceSDKCallReportListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute call_id
+      #   Unique call identifier.
+      #
+      #   @return [String, nil]
+      optional :call_id, String
+
+      # @!attribute call_report_id
+      #   User-scoped storage grouping identifier derived from the authenticated user.
+      #   This is not a unique per-call report identifier and may be shared by multiple
+      #   calls for the same user.
+      #
+      #   @return [String, nil]
+      optional :call_report_id, String
+
+      # @!attribute created_at
+      #   Creation timestamp when present.
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time
+
+      # @!attribute flush_reason
+      #   Reason the SDK flushed this stats report segment, for example an intermediate
+      #   socket-close flush.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :flush_reason,
+               Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+               api_name: :flushReason
+
+      # @!attribute logs
+      #   Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      #   responses commonly return an array of log entries, but object-shaped log
+      #   payloads are also allowed for compatibility.
+      #
+      #   @return [Array<Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries, nil]
+      optional :logs, union: -> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs }
+
+      # @!attribute organization_id
+      #   Organization associated with the stored call report when provided by the Voice
+      #   SDK reporting path.
+      #
+      #   @return [String, nil]
+      optional :organization_id, String
+
+      # @!attribute segment
+      #   Zero-based stats segment index when the SDK sends segmented or intermediate
+      #   reports.
+      #
+      #   @return [Integer, nil]
+      optional :segment, Integer
+
+      # @!attribute stats
+      #   Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      #   exact shape can vary by SDK platform and version. Live responses commonly return
+      #   an array of interval snapshots, but object-shaped stats payloads are also
+      #   allowed for compatibility.
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember1, nil]
+      optional :stats, union: -> { Telnyx::Models::VoiceSDKCallReportListResponse::Stats }
+
+      # @!attribute stored_at
+      #   Time when the call report was stored.
+      #
+      #   @return [Time, nil]
+      optional :stored_at, Time
+
+      # @!attribute summary
+      #   High-level call metadata.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :summary, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute telnyx_leg_id
+      #   Telnyx call leg identifier for correlating the report with call-control, SIP,
+      #   and media troubleshooting data.
+      #
+      #   @return [String, nil]
+      optional :telnyx_leg_id, String
+
+      # @!attribute telnyx_session_id
+      #   Telnyx RTC session identifier for correlating the report with Voice SDK
+      #   signaling and media-session logs.
+      #
+      #   @return [String, nil]
+      optional :telnyx_session_id, String
+
+      # @!attribute user_agent
+      #   Voice SDK user agent string reported by the client. This is the preferred
+      #   SDK/platform/version dimension when present.
+      #
+      #   @return [String, nil]
+      optional :user_agent, String
+
+      # @!attribute user_id
+      #   Authenticated user that owns the call report.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!attribute version
+      #   Legacy SDK version value when the client reports one separately from the user
+      #   agent.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!attribute voice_sdk_id
+      #   Voice SDK instance identifier.
+      #
+      #   @return [String, nil]
+      optional :voice_sdk_id, String
+
+      # @!attribute voice_sdk_id_decoded
+      #   Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :voice_sdk_id_decoded, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute voice_sdk_session_id
+      #   Voice SDK session correlation identifier used to group stats segments for the
+      #   same SDK session.
+      #
+      #   @return [String, nil]
+      optional :voice_sdk_session_id, String
+
+      # @!method initialize(call_id: nil, call_report_id: nil, created_at: nil, flush_reason: nil, logs: nil, organization_id: nil, segment: nil, stats: nil, stored_at: nil, summary: nil, telnyx_leg_id: nil, telnyx_session_id: nil, user_agent: nil, user_id: nil, version: nil, voice_sdk_id: nil, voice_sdk_id_decoded: nil, voice_sdk_session_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::VoiceSDKCallReportListResponse} for more details.
+      #
+      #   A raw call report stats JSON payload. The schema is intentionally permissive
+      #   because Voice SDK clients can add fields over time.
+      #
+      #   @param call_id [String] Unique call identifier.
+      #
+      #   @param call_report_id [String] User-scoped storage grouping identifier derived from the authenticated user. Thi
+      #
+      #   @param created_at [Time] Creation timestamp when present.
+      #
+      #   @param flush_reason [Hash{Symbol=>Object}] Reason the SDK flushed this stats report segment, for example an intermediate so
+      #
+      #   @param logs [Array<Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries] Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      #
+      #   @param organization_id [String] Organization associated with the stored call report when provided by the Voice S
+      #
+      #   @param segment [Integer] Zero-based stats segment index when the SDK sends segmented or intermediate repo
+      #
+      #   @param stats [Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember1] Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      #
+      #   @param stored_at [Time] Time when the call report was stored.
+      #
+      #   @param summary [Hash{Symbol=>Object}] High-level call metadata.
+      #
+      #   @param telnyx_leg_id [String] Telnyx call leg identifier for correlating the report with call-control, SIP, an
+      #
+      #   @param telnyx_session_id [String] Telnyx RTC session identifier for correlating the report with Voice SDK signalin
+      #
+      #   @param user_agent [String] Voice SDK user agent string reported by the client. This is the preferred SDK/pl
+      #
+      #   @param user_id [String] Authenticated user that owns the call report.
+      #
+      #   @param version [String] Legacy SDK version value when the client reports one separately from the user ag
+      #
+      #   @param voice_sdk_id [String] Voice SDK instance identifier.
+      #
+      #   @param voice_sdk_id_decoded [Hash{Symbol=>Object}] Decoded Voice SDK identifier metadata emitted by voice-sdk-proxy when available.
+      #
+      #   @param voice_sdk_session_id [String] Voice SDK session correlation identifier used to group stats segments for the sa
+
+      # Raw logs payload emitted by the Voice SDK and stored without normalization. Live
+      # responses commonly return an array of log entries, but object-shaped log
+      # payloads are also allowed for compatibility.
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportListResponse#logs
+      module Logs
+        extend Telnyx::Internal::Type::Union
+
+        # Raw log entries emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0Array }
+
+        # Raw logs object emitted by the Voice SDK when logs are grouped under an entries field.
+        variant -> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries }
+
+        class UnionMember0 < Telnyx::Internal::Type::BaseModel
+          # @!attribute context
+          #   Raw structured context attached to the log entry.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :context, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute level
+          #   Log level emitted by the SDK.
+          #
+          #   @return [Symbol, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0::Level, nil]
+          optional :level, enum: -> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0::Level }
+
+          # @!attribute message
+          #   Log message.
+          #
+          #   @return [String, nil]
+          optional :message, String
+
+          # @!attribute timestamp
+          #   Time when the log entry was emitted.
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!method initialize(context: nil, level: nil, message: nil, timestamp: nil)
+          #   A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+          #
+          #   @param context [Hash{Symbol=>Object}] Raw structured context attached to the log entry.
+          #
+          #   @param level [Symbol, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0::Level] Log level emitted by the SDK.
+          #
+          #   @param message [String] Log message.
+          #
+          #   @param timestamp [Time] Time when the log entry was emitted.
+
+          # Log level emitted by the SDK.
+          #
+          # @see Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0#level
+          module Level
+            extend Telnyx::Internal::Type::Enum
+
+            DEBUG = :debug
+            INFO = :info
+            WARN = :warn
+            ERROR = :error
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Entries < Telnyx::Internal::Type::BaseModel
+          # @!attribute entries
+          #   Raw log entries when the SDK groups logs under an entries field.
+          #
+          #   @return [Array<Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry>, nil]
+          optional :entries,
+                   -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry] }
+
+          # @!method initialize(entries: nil)
+          #   Raw logs object emitted by the Voice SDK when logs are grouped under an entries
+          #   field.
+          #
+          #   @param entries [Array<Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry>] Raw log entries when the SDK groups logs under an entries field.
+
+          class Entry < Telnyx::Internal::Type::BaseModel
+            # @!attribute context
+            #   Raw structured context attached to the log entry.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :context, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+            # @!attribute level
+            #   Log level emitted by the SDK.
+            #
+            #   @return [Symbol, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry::Level, nil]
+            optional :level, enum: -> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry::Level }
+
+            # @!attribute message
+            #   Log message.
+            #
+            #   @return [String, nil]
+            optional :message, String
+
+            # @!attribute timestamp
+            #   Time when the log entry was emitted.
+            #
+            #   @return [Time, nil]
+            optional :timestamp, Time
+
+            # @!method initialize(context: nil, level: nil, message: nil, timestamp: nil)
+            #   A raw Voice SDK log entry. Additional SDK-specific fields may be present.
+            #
+            #   @param context [Hash{Symbol=>Object}] Raw structured context attached to the log entry.
+            #
+            #   @param level [Symbol, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry::Level] Log level emitted by the SDK.
+            #
+            #   @param message [String] Log message.
+            #
+            #   @param timestamp [Time] Time when the log entry was emitted.
+
+            # Log level emitted by the SDK.
+            #
+            # @see Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries::Entry#level
+            module Level
+              extend Telnyx::Internal::Type::Enum
+
+              DEBUG = :debug
+              INFO = :info
+              WARN = :warn
+              ERROR = :error
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(Array<Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0>, Telnyx::Models::VoiceSDKCallReportListResponse::Logs::Entries)]
+
+        # @type [Telnyx::Internal::Type::Converter]
+        UnionMember0Array =
+          Telnyx::Internal::Type::ArrayOf[-> { Telnyx::Models::VoiceSDKCallReportListResponse::Logs::UnionMember0 }]
+      end
+
+      # Raw stats payload emitted by the Voice SDK and stored without normalization. The
+      # exact shape can vary by SDK platform and version. Live responses commonly return
+      # an array of interval snapshots, but object-shaped stats payloads are also
+      # allowed for compatibility.
+      #
+      # @see Telnyx::Models::VoiceSDKCallReportListResponse#stats
+      module Stats
+        extend Telnyx::Internal::Type::Union
+
+        # Raw interval stats snapshots emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember0Array }
+
+        # Raw stats object emitted by the Voice SDK.
+        variant -> { Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember1 }
+
+        class UnionMember1 < Telnyx::Internal::Type::BaseModel
+          # @!attribute audio
+          #   Raw audio stats such as inbound/outbound packet, byte, jitter, packet-loss,
+          #   bitrate, and audio-level metrics.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :audio, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute connection
+          #   Raw connection stats such as round-trip time, packets, and bytes sent or
+          #   received.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :connection, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute ice
+          #   Raw ICE candidate-pair information, including selected pair, local/remote
+          #   candidates, state, and nomination data when provided by the SDK.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :ice, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!attribute transport
+          #   Raw transport stats such as ICE state, DTLS state, SRTP cipher, TLS version, and
+          #   selected-candidate-pair changes.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :transport, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+          # @!method initialize(audio: nil, connection: nil, ice: nil, transport: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember1} for more
+          #   details.
+          #
+          #   Raw stats object emitted by the Voice SDK.
+          #
+          #   @param audio [Hash{Symbol=>Object}] Raw audio stats such as inbound/outbound packet, byte, jitter, packet-loss, bitr
+          #
+          #   @param connection [Hash{Symbol=>Object}] Raw connection stats such as round-trip time, packets, and bytes sent or receive
+          #
+          #   @param ice [Hash{Symbol=>Object}] Raw ICE candidate-pair information, including selected pair, local/remote candid
+          #
+          #   @param transport [Hash{Symbol=>Object}] Raw transport stats such as ICE state, DTLS state, SRTP cipher, TLS version, and
+        end
+
+        # @!method self.variants
+        #   @return [Array(Array<Hash{Symbol=>Object}>, Telnyx::Models::VoiceSDKCallReportListResponse::Stats::UnionMember1)]
+
+        # @type [Telnyx::Internal::Type::Converter]
+        UnionMember0Array =
+          Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+      end
+    end
+  end
+end

data/lib/telnyx/models/voice_sdk_call_report_retrieve_params.rb

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