telnyx 5.171.0 → 5.173.0

data/sig/telnyx/models/ai/tests/test_framework/v1/scenario_update_params.rbs

@@ -0,0 +1,133 @@
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            type scenario_update_params =
+              {
+                id: Integer,
+                agent: Integer?,
+                expected_outcome_prompt: String,
+                first_message: String,
+                folder_path: String?,
+                inbound_phone_number: Integer,
+                instructions: String,
+                max_duration: Integer?,
+                metrics: ::Array[Integer],
+                name: String,
+                personality: Integer,
+                phone_number: Integer,
+                scenario_language: String,
+                tags: ::Array[String],
+                test_profile: Integer,
+                tool_ids: ::Array[String]
+              }
+              & Telnyx::Internal::Type::request_parameters
+
+            class ScenarioUpdateParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              attr_accessor id: Integer
+
+              attr_accessor agent: Integer?
+
+              attr_reader expected_outcome_prompt: String?
+
+              def expected_outcome_prompt=: (String) -> String
+
+              attr_reader first_message: String?
+
+              def first_message=: (String) -> String
+
+              attr_accessor folder_path: String?
+
+              attr_reader inbound_phone_number: Integer?
+
+              def inbound_phone_number=: (Integer) -> Integer
+
+              attr_reader instructions: String?
+
+              def instructions=: (String) -> String
+
+              attr_accessor max_duration: Integer?
+
+              attr_reader metrics: ::Array[Integer]?
+
+              def metrics=: (::Array[Integer]) -> ::Array[Integer]
+
+              attr_reader name: String?
+
+              def name=: (String) -> String
+
+              attr_reader personality: Integer?
+
+              def personality=: (Integer) -> Integer
+
+              attr_reader phone_number: Integer?
+
+              def phone_number=: (Integer) -> Integer
+
+              attr_reader scenario_language: String?
+
+              def scenario_language=: (String) -> String
+
+              attr_reader tags: ::Array[String]?
+
+              def tags=: (::Array[String]) -> ::Array[String]
+
+              attr_reader test_profile: Integer?
+
+              def test_profile=: (Integer) -> Integer
+
+              attr_reader tool_ids: ::Array[String]?
+
+              def tool_ids=: (::Array[String]) -> ::Array[String]
+
+              def initialize: (
+                id: Integer,
+                ?agent: Integer?,
+                ?expected_outcome_prompt: String,
+                ?first_message: String,
+                ?folder_path: String?,
+                ?inbound_phone_number: Integer,
+                ?instructions: String,
+                ?max_duration: Integer?,
+                ?metrics: ::Array[Integer],
+                ?name: String,
+                ?personality: Integer,
+                ?phone_number: Integer,
+                ?scenario_language: String,
+                ?tags: ::Array[String],
+                ?test_profile: Integer,
+                ?tool_ids: ::Array[String],
+                ?request_options: Telnyx::request_opts
+              ) -> void
+
+              def to_hash: -> {
+                id: Integer,
+                agent: Integer?,
+                expected_outcome_prompt: String,
+                first_message: String,
+                folder_path: String?,
+                inbound_phone_number: Integer,
+                instructions: String,
+                max_duration: Integer?,
+                metrics: ::Array[Integer],
+                name: String,
+                personality: Integer,
+                phone_number: Integer,
+                scenario_language: String,
+                tags: ::Array[String],
+                test_profile: Integer,
+                tool_ids: ::Array[String],
+                request_options: Telnyx::RequestOptions
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/tests/test_framework/v1/test_agent.rbs

@@ -0,0 +1,172 @@
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            type test_agent =
+              {
+                id: Integer,
+                agent_name: String,
+                assistant_id: String,
+                created_at: Time,
+                updated_at: Time,
+                auto_update_dropoff_nodes: bool,
+                auto_update_topic_nodes: bool,
+                chat_assistant_id: String,
+                contact_number: String,
+                description: String,
+                enabled_personalities: ::Array[Integer],
+                hallucination_metric_kb_files: ::Array[Integer],
+                inbound: bool,
+                knowledge_base_files: ::Array[top],
+                language: String,
+                llm_max_tokens: Integer,
+                llm_model: String,
+                llm_system_prompt: String,
+                llm_temperature: Float,
+                outbound_auto_call: bool,
+                outbound_numbers: ::Array[top]?,
+                sip_auth: ::Hash[Symbol, String]?,
+                sip_endpoint: String
+              }
+
+            class TestAgent < Telnyx::Internal::Type::BaseModel
+              attr_accessor id: Integer
+
+              attr_accessor agent_name: String
+
+              attr_accessor assistant_id: String
+
+              attr_accessor created_at: Time
+
+              attr_accessor updated_at: Time
+
+              attr_reader auto_update_dropoff_nodes: bool?
+
+              def auto_update_dropoff_nodes=: (bool) -> bool
+
+              attr_reader auto_update_topic_nodes: bool?
+
+              def auto_update_topic_nodes=: (bool) -> bool
+
+              attr_reader chat_assistant_id: String?
+
+              def chat_assistant_id=: (String) -> String
+
+              attr_reader contact_number: String?
+
+              def contact_number=: (String) -> String
+
+              attr_reader description: String?
+
+              def description=: (String) -> String
+
+              attr_reader enabled_personalities: ::Array[Integer]?
+
+              def enabled_personalities=: (::Array[Integer]) -> ::Array[Integer]
+
+              attr_reader hallucination_metric_kb_files: ::Array[Integer]?
+
+              def hallucination_metric_kb_files=: (
+                ::Array[Integer]
+              ) -> ::Array[Integer]
+
+              attr_reader inbound: bool?
+
+              def inbound=: (bool) -> bool
+
+              attr_reader knowledge_base_files: ::Array[top]?
+
+              def knowledge_base_files=: (::Array[top]) -> ::Array[top]
+
+              attr_reader language: String?
+
+              def language=: (String) -> String
+
+              attr_reader llm_max_tokens: Integer?
+
+              def llm_max_tokens=: (Integer) -> Integer
+
+              attr_reader llm_model: String?
+
+              def llm_model=: (String) -> String
+
+              attr_reader llm_system_prompt: String?
+
+              def llm_system_prompt=: (String) -> String
+
+              attr_reader llm_temperature: Float?
+
+              def llm_temperature=: (Float) -> Float
+
+              attr_reader outbound_auto_call: bool?
+
+              def outbound_auto_call=: (bool) -> bool
+
+              attr_accessor outbound_numbers: ::Array[top]?
+
+              attr_accessor sip_auth: ::Hash[Symbol, String]?
+
+              attr_reader sip_endpoint: String?
+
+              def sip_endpoint=: (String) -> String
+
+              def initialize: (
+                id: Integer,
+                agent_name: String,
+                assistant_id: String,
+                created_at: Time,
+                updated_at: Time,
+                ?auto_update_dropoff_nodes: bool,
+                ?auto_update_topic_nodes: bool,
+                ?chat_assistant_id: String,
+                ?contact_number: String,
+                ?description: String,
+                ?enabled_personalities: ::Array[Integer],
+                ?hallucination_metric_kb_files: ::Array[Integer],
+                ?inbound: bool,
+                ?knowledge_base_files: ::Array[top],
+                ?language: String,
+                ?llm_max_tokens: Integer,
+                ?llm_model: String,
+                ?llm_system_prompt: String,
+                ?llm_temperature: Float,
+                ?outbound_auto_call: bool,
+                ?outbound_numbers: ::Array[top]?,
+                ?sip_auth: ::Hash[Symbol, String]?,
+                ?sip_endpoint: String
+              ) -> void
+
+              def to_hash: -> {
+                id: Integer,
+                agent_name: String,
+                assistant_id: String,
+                created_at: Time,
+                updated_at: Time,
+                auto_update_dropoff_nodes: bool,
+                auto_update_topic_nodes: bool,
+                chat_assistant_id: String,
+                contact_number: String,
+                description: String,
+                enabled_personalities: ::Array[Integer],
+                hallucination_metric_kb_files: ::Array[Integer],
+                inbound: bool,
+                knowledge_base_files: ::Array[top],
+                language: String,
+                llm_max_tokens: Integer,
+                llm_model: String,
+                llm_system_prompt: String,
+                llm_temperature: Float,
+                outbound_auto_call: bool,
+                outbound_numbers: ::Array[top]?,
+                sip_auth: ::Hash[Symbol, String]?,
+                sip_endpoint: String
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/tests/test_framework/v1/test_run_result.rbs

@@ -0,0 +1,367 @@
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            type test_run_result =
+              {
+                id: Integer,
+                agent: Integer,
+                created_at: Time,
+                name: String,
+                status: String,
+                updated_at: Time,
+                agent_inbound: bool,
+                agent_name: String,
+                completed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count,
+                failed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count,
+                is_cronjob: bool,
+                met_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count,
+                run_as_text: bool,
+                run_type: String?,
+                runs: ::Hash[Symbol, Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run]?,
+                scenarios: ::Array[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Scenario]?,
+                success_rate: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate,
+                success_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count,
+                total_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count,
+                total_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count
+              }
+
+            class TestRunResult < Telnyx::Internal::Type::BaseModel
+              attr_accessor id: Integer
+
+              attr_accessor agent: Integer
+
+              attr_accessor created_at: Time
+
+              attr_accessor name: String
+
+              attr_accessor status: String
+
+              attr_accessor updated_at: Time
+
+              attr_reader agent_inbound: bool?
+
+              def agent_inbound=: (bool) -> bool
+
+              attr_reader agent_name: String?
+
+              def agent_name=: (String) -> String
+
+              attr_reader completed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count?
+
+              def completed_runs_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count
+
+              attr_reader failed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count?
+
+              def failed_runs_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count
+
+              attr_reader is_cronjob: bool?
+
+              def is_cronjob=: (bool) -> bool
+
+              attr_reader met_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count?
+
+              def met_expected_outcome_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count
+
+              attr_reader run_as_text: bool?
+
+              def run_as_text=: (bool) -> bool
+
+              attr_accessor run_type: String?
+
+              attr_accessor runs: ::Hash[Symbol, Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run]?
+
+              attr_accessor scenarios: ::Array[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Scenario]?
+
+              attr_reader success_rate: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate?
+
+              def success_rate=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate
+
+              attr_reader success_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count?
+
+              def success_runs_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count
+
+              attr_reader total_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count?
+
+              def total_expected_outcome_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count
+
+              attr_reader total_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count?
+
+              def total_runs_count=: (
+                Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count
+              ) -> Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count
+
+              def initialize: (
+                id: Integer,
+                agent: Integer,
+                created_at: Time,
+                name: String,
+                status: String,
+                updated_at: Time,
+                ?agent_inbound: bool,
+                ?agent_name: String,
+                ?completed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count,
+                ?failed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count,
+                ?is_cronjob: bool,
+                ?met_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count,
+                ?run_as_text: bool,
+                ?run_type: String?,
+                ?runs: ::Hash[Symbol, Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run]?,
+                ?scenarios: ::Array[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Scenario]?,
+                ?success_rate: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate,
+                ?success_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count,
+                ?total_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count,
+                ?total_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count
+              ) -> void
+
+              def to_hash: -> {
+                id: Integer,
+                agent: Integer,
+                created_at: Time,
+                name: String,
+                status: String,
+                updated_at: Time,
+                agent_inbound: bool,
+                agent_name: String,
+                completed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count,
+                failed_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count,
+                is_cronjob: bool,
+                met_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count,
+                run_as_text: bool,
+                run_type: String?,
+                runs: ::Hash[Symbol, Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run]?,
+                scenarios: ::Array[Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Scenario]?,
+                success_rate: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate,
+                success_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count,
+                total_expected_outcome_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count,
+                total_runs_count: Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count
+              }
+
+              type completed_runs_count = Integer | String
+
+              module CompletedRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::completed_runs_count]
+              end
+
+              type failed_runs_count = Integer | String
+
+              module FailedRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::failed_runs_count]
+              end
+
+              type met_expected_outcome_count = Integer | String
+
+              module MetExpectedOutcomeCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::met_expected_outcome_count]
+              end
+
+              type run =
+                {
+                  id: Integer,
+                  duration: String,
+                  error_message: String,
+                  evaluation_status: String,
+                  executed_at: String,
+                  personality_name: String,
+                  scenario: Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario,
+                  scenario_name: String,
+                  status: String,
+                  success: bool?,
+                  test_profile_name: String,
+                  timestamp: String
+                }
+
+              class Run < Telnyx::Internal::Type::BaseModel
+                attr_reader id: Integer?
+
+                def id=: (Integer) -> Integer
+
+                attr_reader duration: String?
+
+                def duration=: (String) -> String
+
+                attr_reader error_message: String?
+
+                def error_message=: (String) -> String
+
+                attr_reader evaluation_status: String?
+
+                def evaluation_status=: (String) -> String
+
+                attr_reader executed_at: String?
+
+                def executed_at=: (String) -> String
+
+                attr_reader personality_name: String?
+
+                def personality_name=: (String) -> String
+
+                attr_reader scenario: Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario?
+
+                def scenario=: (
+                  Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario
+                ) -> Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario
+
+                attr_reader scenario_name: String?
+
+                def scenario_name=: (String) -> String
+
+                attr_reader status: String?
+
+                def status=: (String) -> String
+
+                attr_accessor success: bool?
+
+                attr_reader test_profile_name: String?
+
+                def test_profile_name=: (String) -> String
+
+                attr_reader timestamp: String?
+
+                def timestamp=: (String) -> String
+
+                def initialize: (
+                  ?id: Integer,
+                  ?duration: String,
+                  ?error_message: String,
+                  ?evaluation_status: String,
+                  ?executed_at: String,
+                  ?personality_name: String,
+                  ?scenario: Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario,
+                  ?scenario_name: String,
+                  ?status: String,
+                  ?success: bool?,
+                  ?test_profile_name: String,
+                  ?timestamp: String
+                ) -> void
+
+                def to_hash: -> {
+                  id: Integer,
+                  duration: String,
+                  error_message: String,
+                  evaluation_status: String,
+                  executed_at: String,
+                  personality_name: String,
+                  scenario: Telnyx::AI::Tests::TestFramework::V1::TestRunResult::Run::Scenario,
+                  scenario_name: String,
+                  status: String,
+                  success: bool?,
+                  test_profile_name: String,
+                  timestamp: String
+                }
+
+                type scenario =
+                  {
+                    id: Integer,
+                    expected_outcome_prompt: String,
+                    name: String,
+                    personality_name: String
+                  }
+
+                class Scenario < Telnyx::Internal::Type::BaseModel
+                  attr_reader id: Integer?
+
+                  def id=: (Integer) -> Integer
+
+                  attr_reader expected_outcome_prompt: String?
+
+                  def expected_outcome_prompt=: (String) -> String
+
+                  attr_reader name: String?
+
+                  def name=: (String) -> String
+
+                  attr_reader personality_name: String?
+
+                  def personality_name=: (String) -> String
+
+                  def initialize: (
+                    ?id: Integer,
+                    ?expected_outcome_prompt: String,
+                    ?name: String,
+                    ?personality_name: String
+                  ) -> void
+
+                  def to_hash: -> {
+                    id: Integer,
+                    expected_outcome_prompt: String,
+                    name: String,
+                    personality_name: String
+                  }
+                end
+              end
+
+              type scenario = { id: Integer, name: String }
+
+              class Scenario < Telnyx::Internal::Type::BaseModel
+                attr_reader id: Integer?
+
+                def id=: (Integer) -> Integer
+
+                attr_reader name: String?
+
+                def name=: (String) -> String
+
+                def initialize: (?id: Integer, ?name: String) -> void
+
+                def to_hash: -> { id: Integer, name: String }
+              end
+
+              type success_rate = Float | String
+
+              module SuccessRate
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_rate]
+              end
+
+              type success_runs_count = Integer | String
+
+              module SuccessRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::success_runs_count]
+              end
+
+              type total_expected_outcome_count = Integer | String
+
+              module TotalExpectedOutcomeCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_expected_outcome_count]
+              end
+
+              type total_runs_count = Integer | String
+
+              module TotalRunsCount
+                extend Telnyx::Internal::Type::Union
+
+                def self?.variants: -> ::Array[Telnyx::Models::AI::Tests::TestFramework::V1::TestRunResult::total_runs_count]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/ai/tests/test_framework/v1_retrieve_personalities_params.rbs

@@ -0,0 +1,21 @@
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          type v1_retrieve_personalities_params =
+            {  } & Telnyx::Internal::Type::request_parameters
+
+          class V1RetrievePersonalitiesParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            def initialize: (?request_options: Telnyx::request_opts) -> void
+
+            def to_hash: -> { request_options: Telnyx::RequestOptions }
+          end
+        end
+      end
+    end
+  end
+end