telnyx 5.171.0 → 5.173.0

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -86,6 +86,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
@@ -114,8 +115,9 @@ module Telnyx
           # that capability for the conversation; it does not fail the call.
           a2a_agents: nil,
           # Body param: **Beta:** Configuration for the Telnyx open-source avatar provider.
-          # The launch catalog supports six avatars and office, studio, or reception
-          # backgrounds.
+          # Use a stock avatar or an organization-owned custom avatar returned by the
+          # Avatars API. Discover the available stock catalog with GET /v2/ai/avatars and
+          # filter[avatar_type]=stock; follow meta.total_pages to load every page.
           avatar_settings: nil,
           # Body param: Conversation flow as supplied by API clients (create / update).
           #
@@ -271,7 +273,10 @@ module Telnyx
 
         # Updates the specified AI assistant's attributes and returns the updated
         # assistant. The request can also control how the change is promoted across
-        # assistant versions.
+        # assistant versions. Every update saves a new version, and an assistant keeps at
+        # most 10 versions: once it has more, the oldest versions are permanently deleted,
+        # except the main version and any version referenced by a traffic distribution
+        # rule.
         sig do
           params(
             assistant_id: String,
@@ -321,6 +326,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
@@ -346,8 +352,10 @@ module Telnyx
           # capability for the conversation; it does not fail the call. Omit this field to
           # leave the assistant's agents unchanged; send an empty array to remove them all.
           a2a_agents: nil,
-          # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
-          # catalog supports six avatars and office, studio, or reception backgrounds.
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+          # avatar or an organization-owned custom avatar returned by the Avatars API.
+          # Discover the available stock catalog with GET /v2/ai/avatars and
+          # filter[avatar_type]=stock; follow meta.total_pages to load every page.
           avatar_settings: nil,
           # Conversation flow as supplied by API clients (create / update).
           #

data/rbi/telnyx/resources/ai/audio.rbi

@@ -30,6 +30,8 @@ module Telnyx
           # English only (`en` and its regional variants, e.g. `en-US`, `en-GB`).
           # `nvidia/parakeet-v3` is multilingual with automatic language detection;
           # `omi-health/omi-med-stt-v1` is a medical model, English only.
+          # `reson8/prerecorded` covers 10 languages, returns word timestamps, and labels
+          # speakers via `model_config`.
           model:,
           # The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
           # mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
@@ -50,13 +52,21 @@ module Telnyx
           # `openai/whisper-large-v3-turbo`, supports multiple languages.
           # `distil-whisper/distil-large-v2` does not support language parameter.
           # `nvidia/parakeet-v3` detects the language automatically;
-          # `omi-health/omi-med-stt-v1` is English only.
+          # `omi-health/omi-med-stt-v1` is English only. `reson8/prerecorded` accepts `nl`,
+          # `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es` and `sv` (regional variants are
+          # transcribed as the base language) and detects the language when it is omitted.
           language: nil,
           # Additional model-specific configuration parameters. Only allowed with the
-          # `deepgram/*` models. Can include Deepgram-specific options such as
-          # `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
-          # If `language` is provided both as a top-level parameter and in `model_config`,
-          # the top-level parameter takes precedence.
+          # `deepgram/*` models and `reson8/prerecorded`. Sent as a JSON string in multipart
+          # requests; for the `deepgram/*` models it is passed through to Deepgram as query
+          # parameters, while `reson8/prerecorded` accepts only `diarize` (speaker labels)
+          # and `max_speakers` (1 to 8). Any other model with `model_config` returns 400.
+          # Can include Deepgram-specific options such as `smart_format`, `punctuate`,
+          # `diarize` (speaker labels), `multichannel` (transcribe each channel
+          # independently; billed duration is file duration multiplied by the number of
+          # channels), `utterances`, `numerals`, and `language`. If `language` is provided
+          # both as a top-level parameter and in `model_config`, the top-level parameter
+          # takes precedence.
           model_config: nil,
           # The format of the transcript output. Use `verbose_json` to take advantage of
           # timestamps.

data/rbi/telnyx/resources/ai/avatars.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      # Create and manage real-time AI avatars
+      class Avatars
+        # Uploads an image, validates its file type, size, safe decoding, and resolution,
+        # stores it in Telnyx-managed private storage, and creates an avatar owned by the
+        # authenticated organization. Creating an avatar does not update an AI Assistant;
+        # use the returned ID separately wherever the avatar is consumed. The avatar image
+        # is stored independently from the rendering model and background, which are
+        # selected where the avatar is consumed. Supported image types are JPEG, PNG, and
+        # WebP. Images may be up to 10 MiB, must be between 256 and 8192 pixels on each
+        # side, and may contain at most 40 megapixels. A per-organization custom-avatar
+        # quota applies; the create request returns an error when the quota is reached.
+        # For best results, use a 16:9 landscape image, preferably 1920 by 1080 pixels and
+        # at least 1280 by 720 pixels. Show one centered, front-facing person from the
+        # shoulders up, keep the full head and hair visible with space around it, and use
+        # a sharp, evenly lit image with unobstructed eyes and mouth. Use a transparent
+        # PNG or WebP when the avatar will be combined with a selectable background. These
+        # composition recommendations are not enforced in the first release; the first
+        # release does not validate the number of faces, pose, or image content.
+        sig do
+          params(
+            image_file: Telnyx::Internal::FileInput,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::AvatarResponse)
+        end
+        def create(
+          # JPEG, PNG, or WebP image file. The maximum file size is 10 MiB.
+          image_file:,
+          # Customer-facing name of the custom avatar.
+          name:,
+          request_options: {}
+        )
+        end
+
+        # Returns a Telnyx stock avatar or a custom avatar owned by the authenticated
+        # organization. A custom avatar belonging to another organization is returned as
+        # not found.
+        sig do
+          params(
+            avatar_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::AvatarResponse)
+        end
+        def retrieve(
+          # Stable identifier returned by the Avatars API. Discover available stock IDs with
+          # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+          # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+          # authenticated organization. The service validates that the selected avatar is
+          # available.
+          avatar_id,
+          request_options: {}
+        )
+        end
+
+        # Updates the customer-facing name of a custom avatar owned by the authenticated
+        # organization. Stock avatars cannot be modified. To replace the image, create a
+        # new custom avatar so existing references keep their original content.
+        sig do
+          params(
+            avatar_id: String,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AI::AvatarResponse)
+        end
+        def update(
+          # Stable identifier returned by the Avatars API. Discover available stock IDs with
+          # GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+          # list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+          # authenticated organization. The service validates that the selected avatar is
+          # available.
+          avatar_id,
+          # New customer-facing name of the custom avatar.
+          name:,
+          request_options: {}
+        )
+        end
+
+        # Returns a paginated list of the Telnyx stock avatars and custom avatars
+        # available to the authenticated organization. Custom avatars owned by other
+        # organizations are never returned. The `image_url` value is suitable for
+        # displaying a thumbnail and may be refreshed by listing or retrieving the avatar
+        # again. `suggested_voice_id` recommends a compatible Telnyx voice for stock
+        # avatars and is an empty string for custom avatars; it does not change an AI
+        # Assistant's voice automatically.
+        sig do
+          params(
+            filter_avatar_type: Telnyx::AI::AvatarType::OrSymbol,
+            filter_id: String,
+            filter_name: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Internal::DefaultFlatPagination[Telnyx::AI::Avatar])
+        end
+        def list(
+          # Return only stock or custom avatars.
+          filter_avatar_type: nil,
+          # Return the avatar with this exact ID.
+          filter_id: nil,
+          # Return avatars whose names contain this value, using case-insensitive matching.
+          filter_name: nil,
+          # Page number to retrieve, starting at 1.
+          page_number: nil,
+          # Number of avatars to return per page.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/tests/schedules/v1/cron_jobs.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Tests
+        class Schedules
+          class V1
+            # Test agents, evaluator scenarios, metrics, and run results for the AI test
+            # framework.
+            class CronJobs
+              # Returns the specified scheduled test job.
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::Schedules::V1::ScheduledTestJob)
+              end
+              def retrieve(
+                # Numeric ID of the scheduled test job.
+                id,
+                request_options: {}
+              )
+              end
+
+              # Updates the specified scheduled test job.
+              sig do
+                params(
+                  id: Integer,
+                  agent: T.nilable(Integer),
+                  crontab_expression: String,
+                  execution_mode: String,
+                  frequency: Integer,
+                  is_active: T::Boolean,
+                  name: String,
+                  notify_on:
+                    Telnyx::AI::Tests::Schedules::V1::CronJobUpdateParams::NotifyOn::OrSymbol,
+                  personalities: T::Array[Integer],
+                  run_as_text: T::Boolean,
+                  scenarios: T::Array[Integer],
+                  tags: T::Array[String],
+                  timezone: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::Schedules::V1::ScheduledTestJob)
+              end
+              def update(
+                # Numeric ID of the scheduled test job.
+                id,
+                agent: nil,
+                # Cron expression controlling when the job runs.
+                crontab_expression: nil,
+                # Execution mode for the test runs, such as voice, text, or sip.
+                execution_mode: nil,
+                frequency: nil,
+                is_active: nil,
+                name: nil,
+                notify_on: nil,
+                personalities: nil,
+                run_as_text: nil,
+                scenarios: nil,
+                tags: nil,
+                timezone: nil,
+                request_options: {}
+              )
+              end
+
+              # Deletes the specified scheduled test job.
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.anything)
+              end
+              def delete(
+                # Numeric ID of the scheduled test job.
+                id,
+                request_options: {}
+              )
+              end
+
+              # Creates a scheduled test job that runs the selected scenarios on a cron
+              # expression.
+              sig do
+                params(
+                  crontab_expression: String,
+                  agent: Integer,
+                  execution_mode: String,
+                  frequency: Integer,
+                  is_active: T::Boolean,
+                  name: String,
+                  notify_on:
+                    Telnyx::AI::Tests::Schedules::V1::CronJobCronJobsParams::NotifyOn::OrSymbol,
+                  personalities: T::Array[Integer],
+                  run_as_text: T::Boolean,
+                  scenarios: T::Array[Integer],
+                  tags: T::Array[String],
+                  timezone: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::Schedules::V1::ScheduledTestJob)
+              end
+              def cron_jobs(
+                # Cron expression controlling when the job runs.
+                crontab_expression:,
+                agent: nil,
+                # Execution mode for the test runs, such as voice, text, or sip.
+                execution_mode: nil,
+                frequency: nil,
+                is_active: nil,
+                name: nil,
+                notify_on: nil,
+                personalities: nil,
+                run_as_text: nil,
+                scenarios: nil,
+                tags: nil,
+                timezone: nil,
+                request_options: {}
+              )
+              end
+
+              # Returns the scheduled test jobs in your organization, optionally filtered by
+              # test agent. A scheduled job runs selected scenarios on a cron expression.
+              sig do
+                params(
+                  agent_id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(
+                  T::Array[Telnyx::AI::Tests::Schedules::V1::ScheduledTestJob]
+                )
+              end
+              def retrieve_cron_jobs(
+                # Filter jobs belonging to the specified test agent.
+                agent_id: nil,
+                request_options: {}
+              )
+              end
+
+              # @api private
+              sig { params(client: Telnyx::Client).returns(T.attached_class) }
+              def self.new(client:)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/tests/schedules/v1.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Tests
+        class Schedules
+          class V1
+            # Test agents, evaluator scenarios, metrics, and run results for the AI test
+            # framework.
+            sig do
+              returns(Telnyx::Resources::AI::Tests::Schedules::V1::CronJobs)
+            end
+            attr_reader :cron_jobs
+
+            # @api private
+            sig { params(client: Telnyx::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/tests/schedules.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Tests
+        class Schedules
+          sig { returns(Telnyx::Resources::AI::Tests::Schedules::V1) }
+          attr_reader :v1
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/tests/test_framework/v1/aiagents.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class Tests
+        class TestFramework
+          class V1
+            # Test agents, evaluator scenarios, metrics, and run results for the AI test
+            # framework.
+            class Aiagents
+              # Creates a test agent in your organization. The agent wraps a Telnyx AI assistant
+              # so simulated callers can be sent against it.
+              sig do
+                params(
+                  agent_name: String,
+                  assistant_id: String,
+                  auto_fetch_calls_enabled: T::Boolean,
+                  auto_sync_prompt_enabled: T::Boolean,
+                  auto_update_dropoff_nodes: T::Boolean,
+                  auto_update_topic_nodes: T::Boolean,
+                  contact_number: String,
+                  description: String,
+                  inbound: T::Boolean,
+                  language: String,
+                  llm_max_tokens: Integer,
+                  llm_model: String,
+                  llm_system_prompt: String,
+                  llm_temperature: Float,
+                  outbound_auto_call: T::Boolean,
+                  sip_endpoint: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::TestFramework::V1::TestAgent)
+              end
+              def create(
+                # Name of the test agent.
+                agent_name:,
+                # ID of the Telnyx AI assistant under test.
+                assistant_id:,
+                auto_fetch_calls_enabled: nil,
+                auto_sync_prompt_enabled: nil,
+                auto_update_dropoff_nodes: nil,
+                auto_update_topic_nodes: nil,
+                contact_number: nil,
+                description: nil,
+                inbound: nil,
+                # ISO language code the test agent converses in.
+                language: nil,
+                llm_max_tokens: nil,
+                llm_model: nil,
+                llm_system_prompt: nil,
+                llm_temperature: nil,
+                outbound_auto_call: nil,
+                sip_endpoint: nil,
+                request_options: {}
+              )
+              end
+
+              # Returns the specified test agent.
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::TestFramework::V1::TestAgent)
+              end
+              def retrieve(
+                # Numeric ID of the test agent.
+                id,
+                request_options: {}
+              )
+              end
+
+              # Updates the specified test agent.
+              sig do
+                params(
+                  id: Integer,
+                  agent_name: String,
+                  assistant_id: String,
+                  auto_fetch_calls_enabled: T::Boolean,
+                  auto_sync_prompt_enabled: T::Boolean,
+                  auto_update_dropoff_nodes: T::Boolean,
+                  auto_update_topic_nodes: T::Boolean,
+                  contact_number: String,
+                  description: String,
+                  inbound: T::Boolean,
+                  language: String,
+                  llm_max_tokens: Integer,
+                  llm_model: String,
+                  llm_system_prompt: String,
+                  llm_temperature: Float,
+                  outbound_auto_call: T::Boolean,
+                  sip_endpoint: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(Telnyx::AI::Tests::TestFramework::V1::TestAgent)
+              end
+              def update(
+                # Numeric ID of the test agent.
+                id,
+                # Name of the test agent.
+                agent_name: nil,
+                # ID of the Telnyx AI assistant under test.
+                assistant_id: nil,
+                auto_fetch_calls_enabled: nil,
+                auto_sync_prompt_enabled: nil,
+                auto_update_dropoff_nodes: nil,
+                auto_update_topic_nodes: nil,
+                contact_number: nil,
+                description: nil,
+                inbound: nil,
+                # ISO language code the test agent converses in.
+                language: nil,
+                llm_max_tokens: nil,
+                llm_model: nil,
+                llm_system_prompt: nil,
+                llm_temperature: nil,
+                outbound_auto_call: nil,
+                sip_endpoint: nil,
+                request_options: {}
+              )
+              end
+
+              # Returns a paginated list of test agents in your organization. A test agent wraps
+              # the Telnyx AI assistant under test and drives simulated callers against it.
+              sig do
+                params(
+                  page: Integer,
+                  page_size: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(
+                  Telnyx::Models::AI::Tests::TestFramework::V1::AiagentListResponse
+                )
+              end
+              def list(
+                # Page number (1-based).
+                page: nil,
+                # Number of results per page.
+                page_size: nil,
+                request_options: {}
+              )
+              end
+
+              # Deletes the specified test agent.
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.anything)
+              end
+              def delete(
+                # Numeric ID of the test agent.
+                id,
+                request_options: {}
+              )
+              end
+
+              # @api private
+              sig { params(client: Telnyx::Client).returns(T.attached_class) }
+              def self.new(client:)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end