telnyx 5.171.0 → 5.173.0

data/lib/telnyx/models/ai/tests/test_framework/v1/aiagent_delete_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @type [Telnyx::Internal::Type::Converter]
+            AiagentDeleteResponse = Telnyx::Internal::Type::Unknown
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/aiagent_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Aiagents#list
+            class AiagentListParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute page
+              #   Page number (1-based).
+              #
+              #   @return [Integer, nil]
+              optional :page, Integer
+
+              # @!attribute page_size
+              #   Number of results per page.
+              #
+              #   @return [Integer, nil]
+              optional :page_size, Integer
+
+              # @!method initialize(page: nil, page_size: nil, request_options: {})
+              #   @param page [Integer] Page number (1-based).
+              #
+              #   @param page_size [Integer] Number of results per page.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/aiagent_list_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Aiagents#list
+            class AiagentListResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute count
+              #
+              #   @return [Integer]
+              required :count, Integer
+
+              # @!attribute next_
+              #   Link to the next page of results, or null.
+              #
+              #   @return [String, nil]
+              required :next_, String, api_name: :next, nil?: true
+
+              # @!attribute previous
+              #   Link to the previous page of results, or null.
+              #
+              #   @return [String, nil]
+              required :previous, String, nil?: true
+
+              # @!attribute results
+              #
+              #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::TestAgent>]
+              required :results, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Tests::TestFramework::V1::TestAgent] }
+
+              # @!method initialize(count:, next_:, previous:, results:)
+              #   @param count [Integer]
+              #
+              #   @param next_ [String, nil] Link to the next page of results, or null.
+              #
+              #   @param previous [String, nil] Link to the previous page of results, or null.
+              #
+              #   @param results [Array<Telnyx::Models::AI::Tests::TestFramework::V1::TestAgent>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/aiagent_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Aiagents#retrieve
+            class AiagentRetrieveParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!method initialize(id:, request_options: {})
+              #   @param id [Integer]
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/aiagent_update_params.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Aiagents#update
+            class AiagentUpdateParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent_name
+              #   Name of the test agent.
+              #
+              #   @return [String, nil]
+              optional :agent_name, String
+
+              # @!attribute assistant_id
+              #   ID of the Telnyx AI assistant under test.
+              #
+              #   @return [String, nil]
+              optional :assistant_id, String
+
+              # @!attribute auto_fetch_calls_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :auto_fetch_calls_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute auto_sync_prompt_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :auto_sync_prompt_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute auto_update_dropoff_nodes
+              #
+              #   @return [Boolean, nil]
+              optional :auto_update_dropoff_nodes, Telnyx::Internal::Type::Boolean
+
+              # @!attribute auto_update_topic_nodes
+              #
+              #   @return [Boolean, nil]
+              optional :auto_update_topic_nodes, Telnyx::Internal::Type::Boolean
+
+              # @!attribute contact_number
+              #
+              #   @return [String, nil]
+              optional :contact_number, String
+
+              # @!attribute description
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute inbound
+              #
+              #   @return [Boolean, nil]
+              optional :inbound, Telnyx::Internal::Type::Boolean
+
+              # @!attribute language
+              #   ISO language code the test agent converses in.
+              #
+              #   @return [String, nil]
+              optional :language, String
+
+              # @!attribute llm_max_tokens
+              #
+              #   @return [Integer, nil]
+              optional :llm_max_tokens, Integer
+
+              # @!attribute llm_model
+              #
+              #   @return [String, nil]
+              optional :llm_model, String
+
+              # @!attribute llm_system_prompt
+              #
+              #   @return [String, nil]
+              optional :llm_system_prompt, String
+
+              # @!attribute llm_temperature
+              #
+              #   @return [Float, nil]
+              optional :llm_temperature, Float
+
+              # @!attribute outbound_auto_call
+              #
+              #   @return [Boolean, nil]
+              optional :outbound_auto_call, Telnyx::Internal::Type::Boolean
+
+              # @!attribute sip_endpoint
+              #
+              #   @return [String, nil]
+              optional :sip_endpoint, String
+
+              # @!method initialize(id:, agent_name: nil, 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, 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: {})
+              #   @param id [Integer]
+              #
+              #   @param agent_name [String] Name of the test agent.
+              #
+              #   @param assistant_id [String] ID of the Telnyx AI assistant under test.
+              #
+              #   @param auto_fetch_calls_enabled [Boolean]
+              #
+              #   @param auto_sync_prompt_enabled [Boolean]
+              #
+              #   @param auto_update_dropoff_nodes [Boolean]
+              #
+              #   @param auto_update_topic_nodes [Boolean]
+              #
+              #   @param contact_number [String]
+              #
+              #   @param description [String]
+              #
+              #   @param inbound [Boolean]
+              #
+              #   @param language [String] ISO language code the test agent converses in.
+              #
+              #   @param llm_max_tokens [Integer]
+              #
+              #   @param llm_model [String]
+              #
+              #   @param llm_system_prompt [String]
+              #
+              #   @param llm_temperature [Float]
+              #
+              #   @param outbound_auto_call [Boolean]
+              #
+              #   @param sip_endpoint [String]
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/create_ai_test_metric_request.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class CreateAITestMetricRequest < Telnyx::Internal::Type::BaseModel
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute add_to_new_agents
+              #
+              #   @return [Boolean, nil]
+              optional :add_to_new_agents, Telnyx::Internal::Type::Boolean, nil?: true
+
+              # @!attribute agents
+              #
+              #   @return [Array<Integer>, nil]
+              optional :agents, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute assistant_id
+              #
+              #   @return [String, nil]
+              optional :assistant_id, String
+
+              # @!attribute audio_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :audio_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute description
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute display_order
+              #
+              #   @return [Integer, nil]
+              optional :display_order, Integer
+
+              # @!attribute enum_values
+              #
+              #   @return [Array<String>, nil]
+              optional :enum_values, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute eval_type
+              #   What the metric scores: numeric, continuous_qualitative, or
+              #   binary_workflow_adherence.
+              #
+              #   @return [String, nil]
+              optional :eval_type, String
+
+              # @!attribute observability_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :observability_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute prompt
+              #   Judge prompt used by llm_judge metrics.
+              #
+              #   @return [String, nil]
+              optional :prompt, String
+
+              # @!attribute sampling_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :sampling_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute simulation_enabled
+              #
+              #   @return [Boolean, nil]
+              optional :simulation_enabled, Telnyx::Internal::Type::Boolean
+
+              # @!attribute type
+              #   How the metric is evaluated: custom_code or llm_judge.
+              #
+              #   @return [String, nil]
+              optional :type, String
+
+              # @!method initialize(name:, add_to_new_agents: nil, agents: nil, assistant_id: nil, audio_enabled: nil, description: nil, display_order: nil, enum_values: nil, eval_type: nil, observability_enabled: nil, prompt: nil, sampling_enabled: nil, simulation_enabled: nil, type: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Tests::TestFramework::V1::CreateAITestMetricRequest} for
+              #   more details.
+              #
+              #   @param name [String]
+              #
+              #   @param add_to_new_agents [Boolean, nil]
+              #
+              #   @param agents [Array<Integer>]
+              #
+              #   @param assistant_id [String]
+              #
+              #   @param audio_enabled [Boolean]
+              #
+              #   @param description [String]
+              #
+              #   @param display_order [Integer]
+              #
+              #   @param enum_values [Array<String>]
+              #
+              #   @param eval_type [String] What the metric scores: numeric, continuous_qualitative, or binary_workflow_adhe
+              #
+              #   @param observability_enabled [Boolean]
+              #
+              #   @param prompt [String] Judge prompt used by llm_judge metrics.
+              #
+              #   @param sampling_enabled [Boolean]
+              #
+              #   @param simulation_enabled [Boolean]
+              #
+              #   @param type [String] How the metric is evaluated: custom_code or llm_judge.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/evaluator_scenario_detail.rb

@@ -0,0 +1,283 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#create
+            class EvaluatorScenarioDetail < Telnyx::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [Integer]
+              required :id, Integer
+
+              # @!attribute agent
+              #
+              #   @return [Integer, nil]
+              required :agent, Integer, nil?: true
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute dynamic_variable_values
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :dynamic_variable_values, Telnyx::Internal::Type::HashOf[String], nil?: true
+
+              # @!attribute expected_outcome_prompt
+              #
+              #   @return [String, nil]
+              optional :expected_outcome_prompt, String
+
+              # @!attribute first_message
+              #
+              #   @return [String, nil]
+              optional :first_message, String
+
+              # @!attribute folder_path
+              #
+              #   @return [String, nil]
+              optional :folder_path, String, nil?: true
+
+              # @!attribute inbound_phone_number
+              #
+              #   @return [Integer, nil]
+              optional :inbound_phone_number, Integer, nil?: true
+
+              # @!attribute inbound_phone_number_data
+              #
+              #   @return [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::InboundPhoneNumberData, nil]
+              optional :inbound_phone_number_data,
+                       -> {
+                         Telnyx::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::InboundPhoneNumberData
+                       },
+                       nil?: true
+
+              # @!attribute information_fields
+              #
+              #   @return [Hash{Symbol=>String}, nil]
+              optional :information_fields, Telnyx::Internal::Type::HashOf[String], nil?: true
+
+              # @!attribute instructions
+              #
+              #   @return [String, nil]
+              optional :instructions, String
+
+              # @!attribute is_predefined
+              #
+              #   @return [Boolean, nil]
+              optional :is_predefined, Telnyx::Internal::Type::Boolean
+
+              # @!attribute max_duration
+              #
+              #   @return [Integer, nil]
+              optional :max_duration, Integer, nil?: true
+
+              # @!attribute metric_names
+              #
+              #   @return [Array<String>, nil]
+              optional :metric_names, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute metrics
+              #
+              #   @return [Array<Integer>, nil]
+              optional :metrics, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute outbound_phone_number_data
+              #
+              #   @return [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::OutboundPhoneNumberData, nil]
+              optional :outbound_phone_number_data,
+                       -> {
+                         Telnyx::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::OutboundPhoneNumberData
+                       },
+                       nil?: true
+
+              # @!attribute personality
+              #
+              #   @return [Integer, nil]
+              optional :personality, Integer, nil?: true
+
+              # @!attribute personality_name
+              #
+              #   @return [String, nil]
+              optional :personality_name, String
+
+              # @!attribute phone_number
+              #
+              #   @return [String, nil]
+              optional :phone_number, String
+
+              # @!attribute project
+              #
+              #   @return [Integer, nil]
+              optional :project, Integer, nil?: true
+
+              # @!attribute runs
+              #
+              #   @return [Array<Integer>, nil]
+              optional :runs, Telnyx::Internal::Type::ArrayOf[Integer]
+
+              # @!attribute scenario_language
+              #
+              #   @return [String, nil]
+              optional :scenario_language, String, nil?: true
+
+              # @!attribute scenario_type
+              #
+              #   @return [String, nil]
+              optional :scenario_type, String
+
+              # @!attribute simulation_description
+              #
+              #   @return [String, nil]
+              optional :simulation_description, String
+
+              # @!attribute suite_type
+              #
+              #   @return [String, nil]
+              optional :suite_type, String
+
+              # @!attribute tags
+              #
+              #   @return [Array<String>, nil]
+              optional :tags, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!attribute test_profile
+              #
+              #   @return [Integer, nil]
+              optional :test_profile, Integer, nil?: true
+
+              # @!attribute test_profile_data
+              #
+              #   @return [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::TestProfileData, nil]
+              optional :test_profile_data,
+                       -> { Telnyx::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::TestProfileData },
+                       nil?: true
+
+              # @!attribute tool_ids
+              #
+              #   @return [Array<String>, nil]
+              optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+              # @!method initialize(id:, agent:, name:, dynamic_variable_values: nil, expected_outcome_prompt: nil, first_message: nil, folder_path: nil, inbound_phone_number: nil, inbound_phone_number_data: nil, information_fields: nil, instructions: nil, is_predefined: nil, max_duration: nil, metric_names: nil, metrics: nil, outbound_phone_number_data: nil, personality: nil, personality_name: nil, phone_number: nil, project: nil, runs: nil, scenario_language: nil, scenario_type: nil, simulation_description: nil, suite_type: nil, tags: nil, test_profile: nil, test_profile_data: nil, tool_ids: nil)
+              #   @param id [Integer]
+              #   @param agent [Integer, nil]
+              #   @param name [String]
+              #   @param dynamic_variable_values [Hash{Symbol=>String}, nil]
+              #   @param expected_outcome_prompt [String]
+              #   @param first_message [String]
+              #   @param folder_path [String, nil]
+              #   @param inbound_phone_number [Integer, nil]
+              #   @param inbound_phone_number_data [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::InboundPhoneNumberData, nil]
+              #   @param information_fields [Hash{Symbol=>String}, nil]
+              #   @param instructions [String]
+              #   @param is_predefined [Boolean]
+              #   @param max_duration [Integer, nil]
+              #   @param metric_names [Array<String>]
+              #   @param metrics [Array<Integer>]
+              #   @param outbound_phone_number_data [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::OutboundPhoneNumberData, nil]
+              #   @param personality [Integer, nil]
+              #   @param personality_name [String]
+              #   @param phone_number [String]
+              #   @param project [Integer, nil]
+              #   @param runs [Array<Integer>]
+              #   @param scenario_language [String, nil]
+              #   @param scenario_type [String]
+              #   @param simulation_description [String]
+              #   @param suite_type [String]
+              #   @param tags [Array<String>]
+              #   @param test_profile [Integer, nil]
+              #   @param test_profile_data [Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail::TestProfileData, nil]
+              #   @param tool_ids [Array<String>]
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail#inbound_phone_number_data
+              class InboundPhoneNumberData < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute number
+                #
+                #   @return [String, nil]
+                optional :number, String
+
+                # @!attribute phone_number_id
+                #
+                #   @return [String, nil]
+                optional :phone_number_id, String
+
+                # @!method initialize(id: nil, number: nil, phone_number_id: nil)
+                #   @param id [Integer]
+                #   @param number [String]
+                #   @param phone_number_id [String]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail#outbound_phone_number_data
+              class OutboundPhoneNumberData < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute number
+                #
+                #   @return [String, nil]
+                optional :number, String
+
+                # @!attribute phone_number_id
+                #
+                #   @return [String, nil]
+                optional :phone_number_id, String
+
+                # @!method initialize(id: nil, number: nil, phone_number_id: nil)
+                #   @param id [Integer]
+                #   @param number [String]
+                #   @param phone_number_id [String]
+              end
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::EvaluatorScenarioDetail#test_profile_data
+              class TestProfileData < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer, nil]
+                optional :id, Integer
+
+                # @!attribute agent
+                #
+                #   @return [Integer, nil]
+                optional :agent, Integer, nil?: true
+
+                # @!attribute information
+                #
+                #   @return [Hash{Symbol=>String}, nil]
+                optional :information, Telnyx::Internal::Type::HashOf[String], nil?: true
+
+                # @!attribute name
+                #
+                #   @return [String, nil]
+                optional :name, String
+
+                # @!attribute project
+                #
+                #   @return [Integer, nil]
+                optional :project, Integer, nil?: true
+
+                # @!method initialize(id: nil, agent: nil, information: nil, name: nil, project: nil)
+                #   @param id [Integer]
+                #   @param agent [Integer, nil]
+                #   @param information [Hash{Symbol=>String}, nil]
+                #   @param name [String]
+                #   @param project [Integer, nil]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end