telnyx 5.171.0 → 5.174.0

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#list
+            class ScenarioListParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute agent_id
+              #   Filter scenarios belonging to the specified test agent.
+              #
+              #   @return [Integer, nil]
+              optional :agent_id, Integer
+
+              # @!attribute assistant_id
+              #   Filter scenarios belonging to the specified Telnyx assistant.
+              #
+              #   @return [String, nil]
+              optional :assistant_id, String
+
+              # @!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
+
+              # @!attribute tags
+              #   Filter scenarios by a comma-separated list of tags.
+              #
+              #   @return [String, nil]
+              optional :tags, String
+
+              # @!method initialize(agent_id: nil, assistant_id: nil, page: nil, page_size: nil, tags: nil, request_options: {})
+              #   @param agent_id [Integer] Filter scenarios belonging to the specified test agent.
+              #
+              #   @param assistant_id [String] Filter scenarios belonging to the specified Telnyx assistant.
+              #
+              #   @param page [Integer] Page number (1-based).
+              #
+              #   @param page_size [Integer] Number of results per page.
+              #
+              #   @param tags [String] Filter scenarios by a comma-separated list of tags.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,264 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#list
+            class ScenarioListResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute count
+              #
+              #   @return [Integer]
+              required :count, Integer
+
+              # @!attribute next_
+              #
+              #   @return [String, nil]
+              required :next_, String, api_name: :next, nil?: true
+
+              # @!attribute previous
+              #
+              #   @return [String, nil]
+              required :previous, String, nil?: true
+
+              # @!attribute results
+              #
+              #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result>]
+              required :results,
+                       -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result] }
+
+              # @!method initialize(count:, next_:, previous:, results:)
+              #   @param count [Integer]
+              #   @param next_ [String, nil]
+              #   @param previous [String, nil]
+              #   @param results [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result>]
+
+              class Result < Telnyx::Internal::Type::BaseModel
+                # @!attribute id
+                #
+                #   @return [Integer]
+                required :id, Integer
+
+                # @!attribute agent
+                #   ID of the test agent the scenario runs against.
+                #
+                #   @return [Integer, nil]
+                required :agent, Integer, nil?: true
+
+                # @!attribute created_at
+                #
+                #   @return [Time]
+                required :created_at, Time
+
+                # @!attribute name
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!attribute updated_at
+                #
+                #   @return [Time]
+                required :updated_at, Time
+
+                # @!attribute dynamic_variable_values
+                #
+                #   @return [Hash{Symbol=>String}, nil]
+                optional :dynamic_variable_values, Telnyx::Internal::Type::HashOf[String], nil?: true
+
+                # @!attribute expected_outcome_prompt
+                #   What a successful conversation looks like; scored by the expected-outcome
+                #   metric.
+                #
+                #   @return [String, nil]
+                optional :expected_outcome_prompt, String
+
+                # @!attribute first_message
+                #   First message the simulated caller speaks or sends.
+                #
+                #   @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 [String, nil]
+                optional :inbound_phone_number_data, String, nil?: true
+
+                # @!attribute instructions
+                #   What the simulated caller should do during the conversation.
+                #
+                #   @return [String, nil]
+                optional :instructions, String
+
+                # @!attribute last_updated_by
+                #
+                #   @return [Integer, nil]
+                optional :last_updated_by, Integer, nil?: true
+
+                # @!attribute metric_names
+                #
+                #   @return [Array<String>, nil]
+                optional :metric_names, Telnyx::Internal::Type::ArrayOf[String]
+
+                # @!attribute metrics
+                #   Metric IDs applied to the scenario.
+                #
+                #   @return [Array<Integer>, nil]
+                optional :metrics, Telnyx::Internal::Type::ArrayOf[Integer]
+
+                # @!attribute personality
+                #   ID of the test personality the caller simulates.
+                #
+                #   @return [Integer, nil]
+                optional :personality, Integer, nil?: true
+
+                # @!attribute personality_name
+                #
+                #   @return [String, nil]
+                optional :personality_name, String
+
+                # @!attribute phone_number
+                #   Outbound phone number used to place the simulated call.
+                #
+                #   @return [String, nil]
+                optional :phone_number, String
+
+                # @!attribute scenario_language
+                #
+                #   @return [String, nil]
+                optional :scenario_language, String, nil?: true
+
+                # @!attribute scenario_type
+                #   Type of scenario: workflow, red_teaming_voice, or red_teaming_text.
+                #
+                #   @return [String, nil]
+                optional :scenario_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::ScenarioListResponse::Result::TestProfileData, nil]
+                optional :test_profile_data,
+                         -> { Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result::TestProfileData },
+                         nil?: true
+
+                # @!attribute tool_ids
+                #
+                #   @return [Array<String>, nil]
+                optional :tool_ids, Telnyx::Internal::Type::ArrayOf[String]
+
+                # @!method initialize(id:, agent:, created_at:, name:, updated_at:, dynamic_variable_values: nil, expected_outcome_prompt: nil, first_message: nil, folder_path: nil, inbound_phone_number: nil, inbound_phone_number_data: nil, instructions: nil, last_updated_by: nil, metric_names: nil, metrics: nil, personality: nil, personality_name: nil, phone_number: nil, scenario_language: nil, scenario_type: nil, tags: nil, test_profile: nil, test_profile_data: nil, tool_ids: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result} for
+                #   more details.
+                #
+                #   @param id [Integer]
+                #
+                #   @param agent [Integer, nil] ID of the test agent the scenario runs against.
+                #
+                #   @param created_at [Time]
+                #
+                #   @param name [String]
+                #
+                #   @param updated_at [Time]
+                #
+                #   @param dynamic_variable_values [Hash{Symbol=>String}, nil]
+                #
+                #   @param expected_outcome_prompt [String] What a successful conversation looks like; scored by the expected-outcome metric
+                #
+                #   @param first_message [String] First message the simulated caller speaks or sends.
+                #
+                #   @param folder_path [String, nil]
+                #
+                #   @param inbound_phone_number [Integer, nil]
+                #
+                #   @param inbound_phone_number_data [String, nil]
+                #
+                #   @param instructions [String] What the simulated caller should do during the conversation.
+                #
+                #   @param last_updated_by [Integer, nil]
+                #
+                #   @param metric_names [Array<String>]
+                #
+                #   @param metrics [Array<Integer>] Metric IDs applied to the scenario.
+                #
+                #   @param personality [Integer, nil] ID of the test personality the caller simulates.
+                #
+                #   @param personality_name [String]
+                #
+                #   @param phone_number [String] Outbound phone number used to place the simulated call.
+                #
+                #   @param scenario_language [String, nil]
+                #
+                #   @param scenario_type [String] Type of scenario: workflow, red_teaming_voice, or red_teaming_text.
+                #
+                #   @param tags [Array<String>]
+                #
+                #   @param test_profile [Integer, nil]
+                #
+                #   @param test_profile_data [Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result::TestProfileData, nil]
+                #
+                #   @param tool_ids [Array<String>]
+
+                # @see Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioListResponse::Result#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
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#retrieve_export_scenarios
+            class ScenarioRetrieveExportScenariosParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute export_type
+              #   File format of the export.
+              #
+              #   @return [Symbol, Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveExportScenariosParams::ExportType]
+              required :export_type,
+                       enum: -> { Telnyx::AI::Tests::TestFramework::V1::ScenarioRetrieveExportScenariosParams::ExportType }
+
+              # @!attribute scenario_ids
+              #   Comma-separated scenario IDs to export.
+              #
+              #   @return [String]
+              required :scenario_ids, String
+
+              # @!attribute agent_id
+              #   Export scenarios belonging to the specified test agent.
+              #
+              #   @return [Integer, nil]
+              optional :agent_id, Integer
+
+              # @!method initialize(export_type:, scenario_ids:, agent_id: nil, request_options: {})
+              #   @param export_type [Symbol, Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveExportScenariosParams::ExportType] File format of the export.
+              #
+              #   @param scenario_ids [String] Comma-separated scenario IDs to export.
+              #
+              #   @param agent_id [Integer] Export scenarios belonging to the specified test agent.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+              # File format of the export.
+              module ExportType
+                extend Telnyx::Internal::Type::Enum
+
+                CSV = :csv
+                XLSX = :xlsx
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#retrieve_generate_progress
+            class ScenarioRetrieveGenerateProgressParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute progress_id
+              #   Progress ID returned by the generate-evaluator-scenarios endpoint.
+              #
+              #   @return [String]
+              required :progress_id, String
+
+              # @!method initialize(progress_id:, request_options: {})
+              #   @param progress_id [String] Progress ID returned by the generate-evaluator-scenarios endpoint.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#retrieve_generate_progress
+            class ScenarioRetrieveGenerateProgressResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute completed_scenarios
+              #
+              #   @return [Integer, nil]
+              optional :completed_scenarios, Integer
+
+              # @!attribute failed_scenarios
+              #
+              #   @return [Integer, nil]
+              optional :failed_scenarios, Integer
+
+              # @!attribute scenarios_list
+              #
+              #   @return [Array<Hash{Symbol=>Object}>, nil]
+              optional :scenarios_list,
+                       Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+              # @!attribute total_scenarios
+              #
+              #   @return [Integer, nil]
+              optional :total_scenarios, Integer
+
+              # @!method initialize(completed_scenarios: nil, failed_scenarios: nil, scenarios_list: nil, total_scenarios: nil)
+              #   @param completed_scenarios [Integer]
+              #   @param failed_scenarios [Integer]
+              #   @param scenarios_list [Array<Hash{Symbol=>Object}>]
+              #   @param total_scenarios [Integer]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tests/test_framework/v1/scenario_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::Scenarios#retrieve
+            class ScenarioRetrieveParams < 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/scenario_retrieve_scenario_agent_progress_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#retrieve_scenario_agent_progress
+            class ScenarioRetrieveScenarioAgentProgressParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              # @!attribute progress_id
+              #   Progress ID returned by the improve-evaluator-scenarios endpoint.
+              #
+              #   @return [String]
+              required :progress_id, String
+
+              # @!method initialize(progress_id:, request_options: {})
+              #   @param progress_id [String] Progress ID returned by the improve-evaluator-scenarios endpoint.
+              #
+              #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            # @see Telnyx::Resources::AI::Tests::TestFramework::V1::Scenarios#retrieve_scenario_agent_progress
+            class ScenarioRetrieveScenarioAgentProgressResponse < Telnyx::Internal::Type::BaseModel
+              # @!attribute error
+              #
+              #   @return [String, nil]
+              optional :error, String, nil?: true
+
+              # @!attribute mode
+              #
+              #   @return [String, nil]
+              optional :mode, String
+
+              # @!attribute progress_id
+              #
+              #   @return [String, nil]
+              optional :progress_id, String
+
+              # @!attribute result
+              #
+              #   @return [Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result, nil]
+              optional :result,
+                       -> { Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result },
+                       nil?: true
+
+              # @!attribute session_id
+              #
+              #   @return [Integer, nil]
+              optional :session_id, Integer, nil?: true
+
+              # @!attribute status
+              #
+              #   @return [String, nil]
+              optional :status, String
+
+              # @!method initialize(error: nil, mode: nil, progress_id: nil, result: nil, session_id: nil, status: nil)
+              #   @param error [String, nil]
+              #   @param mode [String]
+              #   @param progress_id [String]
+              #   @param result [Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result, nil]
+              #   @param session_id [Integer, nil]
+              #   @param status [String]
+
+              # @see Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse#result
+              class Result < Telnyx::Internal::Type::BaseModel
+                # @!attribute cancelled
+                #
+                #   @return [Boolean, nil]
+                optional :cancelled, Telnyx::Internal::Type::Boolean
+
+                # @!attribute clarification_questions
+                #
+                #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ClarificationQuestion>, nil]
+                optional :clarification_questions,
+                         -> do
+                           Telnyx::Internal::Type::ArrayOf[
+                             Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ClarificationQuestion
+                           ]
+                         end
+
+                # @!attribute conversation_history
+                #
+                #   @return [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ConversationHistory>, nil]
+                optional :conversation_history,
+                         -> do
+                           Telnyx::Internal::Type::ArrayOf[
+                             Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ConversationHistory
+                           ]
+                         end
+
+                # @!attribute message
+                #
+                #   @return [String, nil]
+                optional :message, String
+
+                # @!attribute needs_clarification
+                #
+                #   @return [Boolean, nil]
+                optional :needs_clarification, Telnyx::Internal::Type::Boolean
+
+                # @!attribute session_id
+                #
+                #   @return [Integer, nil]
+                optional :session_id, Integer
+
+                # @!attribute success
+                #
+                #   @return [Boolean, nil]
+                optional :success, Telnyx::Internal::Type::Boolean
+
+                # @!attribute updated_scenarios
+                #
+                #   @return [Array<Hash{Symbol=>Object}>, nil]
+                optional :updated_scenarios,
+                         Telnyx::Internal::Type::ArrayOf[Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]]
+
+                # @!method initialize(cancelled: nil, clarification_questions: nil, conversation_history: nil, message: nil, needs_clarification: nil, session_id: nil, success: nil, updated_scenarios: nil)
+                #   @param cancelled [Boolean]
+                #   @param clarification_questions [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ClarificationQuestion>]
+                #   @param conversation_history [Array<Telnyx::Models::AI::Tests::TestFramework::V1::ScenarioRetrieveScenarioAgentProgressResponse::Result::ConversationHistory>]
+                #   @param message [String]
+                #   @param needs_clarification [Boolean]
+                #   @param session_id [Integer]
+                #   @param success [Boolean]
+                #   @param updated_scenarios [Array<Hash{Symbol=>Object}>]
+
+                class ClarificationQuestion < Telnyx::Internal::Type::BaseModel
+                  # @!attribute question
+                  #
+                  #   @return [String, nil]
+                  optional :question, String
+
+                  # @!method initialize(question: nil)
+                  #   @param question [String]
+                end
+
+                class ConversationHistory < Telnyx::Internal::Type::BaseModel
+                  # @!attribute content
+                  #
+                  #   @return [String, nil]
+                  optional :content, String
+
+                  # @!attribute role
+                  #
+                  #   @return [String, nil]
+                  optional :role, String
+
+                  # @!attribute timestamp
+                  #
+                  #   @return [String, nil]
+                  optional :timestamp, String
+
+                  # @!method initialize(content: nil, role: nil, timestamp: nil)
+                  #   @param content [String]
+                  #   @param role [String]
+                  #   @param timestamp [String]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end