telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/models/ai/tests/test_framework/v1/result_rerun_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ResultRerunParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ResultRerunParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Integer) }
+              attr_accessor :id
+
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(id:, request_options: {})
+              end
+
+              sig do
+                override.returns(
+                  { id: Integer, request_options: Telnyx::RequestOptions }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/result_retrieve_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ResultRetrieveParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ResultRetrieveParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Integer) }
+              attr_accessor :id
+
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(id:, request_options: {})
+              end
+
+              sig do
+                override.returns(
+                  { id: Integer, request_options: Telnyx::RequestOptions }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_create_params.rbi

@@ -0,0 +1,126 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ScenarioCreateParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioCreateParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :name
+
+              # ID of the personality the caller simulates.
+              sig { returns(Integer) }
+              attr_accessor :personality
+
+              sig { returns(T.nilable(Integer)) }
+              attr_accessor :agent
+
+              sig { returns(T.nilable(String)) }
+              attr_reader :expected_outcome_prompt
+
+              sig { params(expected_outcome_prompt: String).void }
+              attr_writer :expected_outcome_prompt
+
+              sig { returns(T.nilable(String)) }
+              attr_reader :first_message
+
+              sig { params(first_message: String).void }
+              attr_writer :first_message
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :folder_path
+
+              sig { returns(T.nilable(String)) }
+              attr_reader :instructions
+
+              sig { params(instructions: String).void }
+              attr_writer :instructions
+
+              sig { returns(T.nilable(T::Array[Integer])) }
+              attr_reader :metrics
+
+              sig { params(metrics: T::Array[Integer]).void }
+              attr_writer :metrics
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :tags
+
+              sig { params(tags: T::Array[String]).void }
+              attr_writer :tags
+
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :test_profile
+
+              sig { params(test_profile: Integer).void }
+              attr_writer :test_profile
+
+              sig do
+                params(
+                  name: String,
+                  personality: Integer,
+                  agent: T.nilable(Integer),
+                  expected_outcome_prompt: String,
+                  first_message: String,
+                  folder_path: T.nilable(String),
+                  instructions: String,
+                  metrics: T::Array[Integer],
+                  tags: T::Array[String],
+                  test_profile: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                name:,
+                # ID of the personality the caller simulates.
+                personality:,
+                agent: nil,
+                expected_outcome_prompt: nil,
+                first_message: nil,
+                folder_path: nil,
+                instructions: nil,
+                metrics: nil,
+                tags: nil,
+                test_profile: nil,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    name: String,
+                    personality: Integer,
+                    agent: T.nilable(Integer),
+                    expected_outcome_prompt: String,
+                    first_message: String,
+                    folder_path: T.nilable(String),
+                    instructions: String,
+                    metrics: T::Array[Integer],
+                    tags: T::Array[String],
+                    test_profile: Integer,
+                    request_options: Telnyx::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_delete_params.rbi

@@ -0,0 +1,46 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ScenarioDeleteParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioDeleteParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Integer) }
+              attr_accessor :id
+
+              sig do
+                params(
+                  id: Integer,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(id:, request_options: {})
+              end
+
+              sig do
+                override.returns(
+                  { id: Integer, request_options: Telnyx::RequestOptions }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_delete_response.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            ScenarioDeleteResponse =
+              T.let(T.anything, Telnyx::Internal::Type::Converter)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_generate_bg_params.rbi

@@ -0,0 +1,206 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ScenarioGenerateBgParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # How many scenarios to generate.
+              sig { returns(Integer) }
+              attr_accessor :num_scenarios
+
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :agent_id
+
+              sig { params(agent_id: Integer).void }
+              attr_writer :agent_id
+
+              # Optional guidance steering scenario generation.
+              sig { returns(T.nilable(String)) }
+              attr_reader :extra_instructions
+
+              sig { params(extra_instructions: String).void }
+              attr_writer :extra_instructions
+
+              sig { returns(T.nilable(String)) }
+              attr_reader :first_message
+
+              sig { params(first_message: String).void }
+              attr_writer :first_message
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :folder_path
+
+              # Whether to generate expected-outcome prompts for the scenarios.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :generate_expected_outcomes
+
+              sig { params(generate_expected_outcomes: T::Boolean).void }
+              attr_writer :generate_expected_outcomes
+
+              sig { returns(T.nilable(Integer)) }
+              attr_accessor :inbound_phone_number
+
+              sig { returns(T.nilable(T::Array[Integer])) }
+              attr_reader :personalities
+
+              sig { params(personalities: T::Array[Integer]).void }
+              attr_writer :personalities
+
+              # Type of scenario to generate.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::OrSymbol
+                  )
+                )
+              end
+              attr_reader :scenario_type
+
+              sig do
+                params(
+                  scenario_type:
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::OrSymbol
+                ).void
+              end
+              attr_writer :scenario_type
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :tags
+
+              sig { params(tags: T::Array[String]).void }
+              attr_writer :tags
+
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :test_profile
+
+              sig { params(test_profile: Integer).void }
+              attr_writer :test_profile
+
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :tool_ids
+
+              sig { params(tool_ids: T::Array[String]).void }
+              attr_writer :tool_ids
+
+              sig do
+                params(
+                  num_scenarios: Integer,
+                  agent_id: Integer,
+                  extra_instructions: String,
+                  first_message: String,
+                  folder_path: T.nilable(String),
+                  generate_expected_outcomes: T::Boolean,
+                  inbound_phone_number: T.nilable(Integer),
+                  personalities: T::Array[Integer],
+                  scenario_type:
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::OrSymbol,
+                  tags: T::Array[String],
+                  test_profile: Integer,
+                  tool_ids: T::Array[String],
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # How many scenarios to generate.
+                num_scenarios:,
+                agent_id: nil,
+                # Optional guidance steering scenario generation.
+                extra_instructions: nil,
+                first_message: nil,
+                folder_path: nil,
+                # Whether to generate expected-outcome prompts for the scenarios.
+                generate_expected_outcomes: nil,
+                inbound_phone_number: nil,
+                personalities: nil,
+                # Type of scenario to generate.
+                scenario_type: nil,
+                tags: nil,
+                test_profile: nil,
+                tool_ids: nil,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    num_scenarios: Integer,
+                    agent_id: Integer,
+                    extra_instructions: String,
+                    first_message: String,
+                    folder_path: T.nilable(String),
+                    generate_expected_outcomes: T::Boolean,
+                    inbound_phone_number: T.nilable(Integer),
+                    personalities: T::Array[Integer],
+                    scenario_type:
+                      Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::OrSymbol,
+                    tags: T::Array[String],
+                    test_profile: Integer,
+                    tool_ids: T::Array[String],
+                    request_options: Telnyx::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              # Type of scenario to generate.
+              module ScenarioType
+                extend Telnyx::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                WORKFLOW =
+                  T.let(
+                    :workflow,
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::TaggedSymbol
+                  )
+                RED_TEAMING_VOICE =
+                  T.let(
+                    :red_teaming_voice,
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::TaggedSymbol
+                  )
+                RED_TEAMING_TEXT =
+                  T.let(
+                    :red_teaming_text,
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerateBgParams::ScenarioType::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_generation_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ScenarioGenerationResponse < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioGenerationResponse,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Identifier to poll generation progress with.
+              sig { returns(String) }
+              attr_accessor :progress_id
+
+              sig { params(progress_id: String).returns(T.attached_class) }
+              def self.new(
+                # Identifier to poll generation progress with.
+                progress_id:
+              )
+              end
+
+              sig { override.returns({ progress_id: String }) }
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tests/test_framework/v1/scenario_list_params.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Tests
+        module TestFramework
+          module V1
+            class ScenarioListParams < Telnyx::Internal::Type::BaseModel
+              extend Telnyx::Internal::Type::RequestParameters::Converter
+              include Telnyx::Internal::Type::RequestParameters
+
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Tests::TestFramework::V1::ScenarioListParams,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Filter scenarios belonging to the specified test agent.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :agent_id
+
+              sig { params(agent_id: Integer).void }
+              attr_writer :agent_id
+
+              # Filter scenarios belonging to the specified Telnyx assistant.
+              sig { returns(T.nilable(String)) }
+              attr_reader :assistant_id
+
+              sig { params(assistant_id: String).void }
+              attr_writer :assistant_id
+
+              # Page number (1-based).
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :page
+
+              sig { params(page: Integer).void }
+              attr_writer :page
+
+              # Number of results per page.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :page_size
+
+              sig { params(page_size: Integer).void }
+              attr_writer :page_size
+
+              # Filter scenarios by a comma-separated list of tags.
+              sig { returns(T.nilable(String)) }
+              attr_reader :tags
+
+              sig { params(tags: String).void }
+              attr_writer :tags
+
+              sig do
+                params(
+                  agent_id: Integer,
+                  assistant_id: String,
+                  page: Integer,
+                  page_size: Integer,
+                  tags: String,
+                  request_options: Telnyx::RequestOptions::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Filter scenarios belonging to the specified test agent.
+                agent_id: nil,
+                # Filter scenarios belonging to the specified Telnyx assistant.
+                assistant_id: nil,
+                # Page number (1-based).
+                page: nil,
+                # Number of results per page.
+                page_size: nil,
+                # Filter scenarios by a comma-separated list of tags.
+                tags: nil,
+                request_options: {}
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    agent_id: Integer,
+                    assistant_id: String,
+                    page: Integer,
+                    page_size: Integer,
+                    tags: String,
+                    request_options: Telnyx::RequestOptions
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end