vellum_ai 0.3.15 → 0.14.74

data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_exec_config_request.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+require_relative "test_suite_run_prompt_sandbox_exec_config_data_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# Execution configuration for running a Test Suite against a Prompt Sandbox
+  class TestSuiteRunPromptSandboxExecConfigRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::TestSuiteRunPromptSandboxExecConfigDataRequest] 
+    attr_reader :data
+  # @return [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    attr_reader :test_case_ids
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param data [Vellum::TestSuiteRunPromptSandboxExecConfigDataRequest] 
+    # @param test_case_ids [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::TestSuiteRunPromptSandboxExecConfigRequest]
+    def initialize(type:, data:, test_case_ids: OMIT, additional_properties: nil)
+      @type = type
+      @data = data
+      @test_case_ids = test_case_ids if test_case_ids != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "data": data, "test_case_ids": test_case_ids }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  TestSuiteRunPromptSandboxExecConfigRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunPromptSandboxExecConfigRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::TestSuiteRunPromptSandboxExecConfigDataRequest.from_json(json_object: data)
+      else
+        data = nil
+      end
+      test_case_ids = parsed_json["test_case_ids"]
+      new(
+        type: type,
+        data: data,
+        test_case_ids: test_case_ids,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of TestSuiteRunPromptSandboxExecConfigRequest to a JSON
+#  object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::TestSuiteRunPromptSandboxExecConfigDataRequest.validate_raw(obj: obj.data)
+      obj.test_case_ids&.is_a?(Array) != false || raise("Passed value for field obj.test_case_ids is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require_relative "test_suite_run_prompt_sandbox_history_item_exec_config_data"
+require "ostruct"
+require "json"
+
+module Vellum
+# Execution configuration for running a Test Suite against a Prompt Sandbox
+#  History Item
+  class TestSuiteRunPromptSandboxHistoryItemExecConfig
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData] 
+    attr_reader :data
+  # @return [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    attr_reader :test_case_ids
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param data [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData] 
+    # @param test_case_ids [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfig]
+    def initialize(type:, data:, test_case_ids: OMIT, additional_properties: nil)
+      @type = type
+      @data = data
+      @test_case_ids = test_case_ids if test_case_ids != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "data": data, "test_case_ids": test_case_ids }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  TestSuiteRunPromptSandboxHistoryItemExecConfig
+    #
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfig]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData.from_json(json_object: data)
+      else
+        data = nil
+      end
+      test_case_ids = parsed_json["test_case_ids"]
+      new(
+        type: type,
+        data: data,
+        test_case_ids: test_case_ids,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of TestSuiteRunPromptSandboxHistoryItemExecConfig to a
+#  JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData.validate_raw(obj: obj.data)
+      obj.test_case_ids&.is_a?(Array) != false || raise("Passed value for field obj.test_case_ids is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_data.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class TestSuiteRunPromptSandboxHistoryItemExecConfigData
+  # @return [String] The ID of the Prompt Sandbox History Item that the Test Suite will run against.
+    attr_reader :history_item_id
+  # @return [String] The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd
+#  like to run the Test Suite against.
+    attr_reader :prompt_variant_id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param history_item_id [String] The ID of the Prompt Sandbox History Item that the Test Suite will run against.
+    # @param prompt_variant_id [String] The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd
+#  like to run the Test Suite against.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData]
+    def initialize(history_item_id:, prompt_variant_id:, additional_properties: nil)
+      @history_item_id = history_item_id
+      @prompt_variant_id = prompt_variant_id
+      @additional_properties = additional_properties
+      @_field_set = { "history_item_id": history_item_id, "prompt_variant_id": prompt_variant_id }
+    end
+# Deserialize a JSON object to an instance of
+#  TestSuiteRunPromptSandboxHistoryItemExecConfigData
+    #
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigData]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      history_item_id = parsed_json["history_item_id"]
+      prompt_variant_id = parsed_json["prompt_variant_id"]
+      new(
+        history_item_id: history_item_id,
+        prompt_variant_id: prompt_variant_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of TestSuiteRunPromptSandboxHistoryItemExecConfigData to a
+#  JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.history_item_id.is_a?(String) != false || raise("Passed value for field obj.history_item_id is not the expected type, validation failed.")
+      obj.prompt_variant_id.is_a?(String) != false || raise("Passed value for field obj.prompt_variant_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_data_request.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+require "ostruct"
+require "json"
+
+module Vellum
+  class TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest
+  # @return [String] The ID of the Prompt Sandbox History Item that the Test Suite will run against.
+    attr_reader :history_item_id
+  # @return [String] The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd
+#  like to run the Test Suite against.
+    attr_reader :prompt_variant_id
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param history_item_id [String] The ID of the Prompt Sandbox History Item that the Test Suite will run against.
+    # @param prompt_variant_id [String] The ID of the Prompt Variant within the Prompt Sandbox History Item that you'd
+#  like to run the Test Suite against.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest]
+    def initialize(history_item_id:, prompt_variant_id:, additional_properties: nil)
+      @history_item_id = history_item_id
+      @prompt_variant_id = prompt_variant_id
+      @additional_properties = additional_properties
+      @_field_set = { "history_item_id": history_item_id, "prompt_variant_id": prompt_variant_id }
+    end
+# Deserialize a JSON object to an instance of
+#  TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      history_item_id = parsed_json["history_item_id"]
+      prompt_variant_id = parsed_json["prompt_variant_id"]
+      new(
+        history_item_id: history_item_id,
+        prompt_variant_id: prompt_variant_id,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of
+#  TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.history_item_id.is_a?(String) != false || raise("Passed value for field obj.history_item_id is not the expected type, validation failed.")
+      obj.prompt_variant_id.is_a?(String) != false || raise("Passed value for field obj.prompt_variant_id is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/test_suite_run_prompt_sandbox_history_item_exec_config_request.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require_relative "test_suite_run_prompt_sandbox_history_item_exec_config_data_request"
+require "ostruct"
+require "json"
+
+module Vellum
+# Execution configuration for running a Test Suite against a Prompt Sandbox
+#  History Item
+  class TestSuiteRunPromptSandboxHistoryItemExecConfigRequest
+  # @return [String] 
+    attr_reader :type
+  # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest] 
+    attr_reader :data
+  # @return [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    attr_reader :test_case_ids
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param type [String] 
+    # @param data [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest] 
+    # @param test_case_ids [Array<String>] Optionally specify a subset of test case ids to run. If not provided, all test
+#  cases within the test suite will be run by default.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigRequest]
+    def initialize(type:, data:, test_case_ids: OMIT, additional_properties: nil)
+      @type = type
+      @data = data
+      @test_case_ids = test_case_ids if test_case_ids != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "type": type, "data": data, "test_case_ids": test_case_ids }.reject do | _k, v |
+  v == OMIT
+end
+    end
+# Deserialize a JSON object to an instance of
+#  TestSuiteRunPromptSandboxHistoryItemExecConfigRequest
+    #
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigRequest]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      type = parsed_json["type"]
+      unless parsed_json["data"].nil?
+        data = parsed_json["data"].to_json
+        data = Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest.from_json(json_object: data)
+      else
+        data = nil
+      end
+      test_case_ids = parsed_json["test_case_ids"]
+      new(
+        type: type,
+        data: data,
+        test_case_ids: test_case_ids,
+        additional_properties: struct
+      )
+    end
+# Serialize an instance of TestSuiteRunPromptSandboxHistoryItemExecConfigRequest
+#  to a JSON object
+    #
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
+    end
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
+    #
+    # @param obj [Object] 
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.type.is_a?(String) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      Vellum::TestSuiteRunPromptSandboxHistoryItemExecConfigDataRequest.validate_raw(obj: obj.data)
+      obj.test_case_ids&.is_a?(Array) != false || raise("Passed value for field obj.test_case_ids is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/vellum_ai/types/test_suite_run_read.rb

@@ -1,96 +1,125 @@
 # frozen_string_literal: true
-
 require "date"
 require_relative "test_suite_run_test_suite"
 require_relative "test_suite_run_state"
 require_relative "test_suite_run_exec_config"
+require_relative "test_suite_run_progress"
+require "ostruct"
 require "json"
 
 module Vellum
   class TestSuiteRunRead
-    attr_reader :id, :created, :test_suite, :state, :exec_config, :additional_properties
+  # @return [String] 
+    attr_reader :id
+  # @return [DateTime] 
+    attr_reader :created
+  # @return [Vellum::TestSuiteRunTestSuite] 
+    attr_reader :test_suite
+  # @return [Vellum::TestSuiteRunState] The current state of this run
+#  * `QUEUED` - Queued
+#  * `RUNNING` - Running
+#  * `COMPLETE` - Complete
+#  * `FAILED` - Failed
+#  * `CANCELLED` - Cancelled
+    attr_reader :state
+  # @return [Vellum::TestSuiteRunExecConfig] Configuration that defines how the Test Suite should be run
+    attr_reader :exec_config
+  # @return [Vellum::TestSuiteRunProgress] 
+    attr_reader :progress
+  # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+  # @return [Object] 
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
 
-    # @param id [String]
-    # @param created [DateTime]
-    # @param test_suite [TestSuiteRunTestSuite]
-    # @param state [TEST_SUITE_RUN_STATE] The current state of this run
-    #   - `QUEUED` - Queued
-    #   - `RUNNING` - Running
-    #   - `COMPLETE` - Complete
-    #   - `FAILED` - Failed
-    #   - `CANCELLED` - Cancelled
-    # @param exec_config [TestSuiteRunExecConfig] Configuration that defines how the Test Suite should be run
+    # @param id [String] 
+    # @param created [DateTime] 
+    # @param test_suite [Vellum::TestSuiteRunTestSuite] 
+    # @param state [Vellum::TestSuiteRunState] The current state of this run
+#  * `QUEUED` - Queued
+#  * `RUNNING` - Running
+#  * `COMPLETE` - Complete
+#  * `FAILED` - Failed
+#  * `CANCELLED` - Cancelled
+    # @param exec_config [Vellum::TestSuiteRunExecConfig] Configuration that defines how the Test Suite should be run
+    # @param progress [Vellum::TestSuiteRunProgress] 
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TestSuiteRunRead]
-    def initialize(id:, created:, test_suite:, state:, exec_config: nil, additional_properties: nil)
-      # @type [String]
+    # @return [Vellum::TestSuiteRunRead]
+    def initialize(id:, created:, test_suite:, state:, exec_config: OMIT, progress: OMIT, additional_properties: nil)
       @id = id
-      # @type [DateTime]
       @created = created
-      # @type [TestSuiteRunTestSuite]
       @test_suite = test_suite
-      # @type [TEST_SUITE_RUN_STATE] The current state of this run
-      #   - `QUEUED` - Queued
-      #   - `RUNNING` - Running
-      #   - `COMPLETE` - Complete
-      #   - `FAILED` - Failed
-      #   - `CANCELLED` - Cancelled
       @state = state
-      # @type [TestSuiteRunExecConfig] Configuration that defines how the Test Suite should be run
-      @exec_config = exec_config
-      # @type [OpenStruct] Additional properties unmapped to the current class definition
+      @exec_config = exec_config if exec_config != OMIT
+      @progress = progress if progress != OMIT
       @additional_properties = additional_properties
+      @_field_set = { "id": id, "created": created, "test_suite": test_suite, "state": state, "exec_config": exec_config, "progress": progress }.reject do | _k, v |
+  v == OMIT
+end
     end
-
-    # Deserialize a JSON object to an instance of TestSuiteRunRead
+# Deserialize a JSON object to an instance of TestSuiteRunRead
     #
-    # @param json_object [JSON]
-    # @return [TestSuiteRunRead]
+    # @param json_object [String] 
+    # @return [Vellum::TestSuiteRunRead]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      id = struct.id
-      created = DateTime.parse(parsed_json["created"])
-      if parsed_json["test_suite"].nil?
-        test_suite = nil
-      else
+      id = parsed_json["id"]
+      created = unless parsed_json["created"].nil?
+  DateTime.parse(parsed_json["created"])
+else
+  nil
+end
+      unless parsed_json["test_suite"].nil?
         test_suite = parsed_json["test_suite"].to_json
-        test_suite = TestSuiteRunTestSuite.from_json(json_object: test_suite)
+        test_suite = Vellum::TestSuiteRunTestSuite.from_json(json_object: test_suite)
+      else
+        test_suite = nil
       end
-      state = TEST_SUITE_RUN_STATE.key(parsed_json["state"]) || parsed_json["state"]
-      if parsed_json["exec_config"].nil?
+      state = parsed_json["state"]
+      unless parsed_json["exec_config"].nil?
+        exec_config = parsed_json["exec_config"].to_json
+        exec_config = Vellum::TestSuiteRunExecConfig.from_json(json_object: exec_config)
+      else
         exec_config = nil
+      end
+      unless parsed_json["progress"].nil?
+        progress = parsed_json["progress"].to_json
+        progress = Vellum::TestSuiteRunProgress.from_json(json_object: progress)
       else
-        exec_config = parsed_json["exec_config"].to_json
-        exec_config = TestSuiteRunExecConfig.from_json(json_object: exec_config)
+        progress = nil
       end
-      new(id: id, created: created, test_suite: test_suite, state: state, exec_config: exec_config,
-          additional_properties: struct)
+      new(
+        id: id,
+        created: created,
+        test_suite: test_suite,
+        state: state,
+        exec_config: exec_config,
+        progress: progress,
+        additional_properties: struct
+      )
     end
-
-    # Serialize an instance of TestSuiteRunRead to a JSON object
+# Serialize an instance of TestSuiteRunRead to a JSON object
     #
-    # @return [JSON]
-    def to_json(*_args)
-      {
-        "id": @id,
-        "created": @created,
-        "test_suite": @test_suite,
-        "state": TEST_SUITE_RUN_STATE[@state] || @state,
-        "exec_config": @exec_config
-      }.to_json
+    # @return [String]
+    def to_json
+      @_field_set&.to_json
     end
-
-    # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
+# Leveraged for Union-type generation, validate_raw attempts to parse the given
+#  hash and check each fields type against the current object's property
+#  definitions.
     #
-    # @param obj [Object]
+    # @param obj [Object] 
     # @return [Void]
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
-      TestSuiteRunTestSuite.validate_raw(obj: obj.test_suite)
-      obj.state.is_a?(TEST_SUITE_RUN_STATE) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
-      obj.exec_config.nil? || TestSuiteRunExecConfig.validate_raw(obj: obj.exec_config)
+      Vellum::TestSuiteRunTestSuite.validate_raw(obj: obj.test_suite)
+      obj.state.is_a?(Vellum::TestSuiteRunState) != false || raise("Passed value for field obj.state is not the expected type, validation failed.")
+      obj.exec_config.nil? || Vellum::TestSuiteRunExecConfig.validate_raw(obj: obj.exec_config)
+      obj.progress.nil? || Vellum::TestSuiteRunProgress.validate_raw(obj: obj.progress)
     end
   end
-end
+end

data/lib/vellum_ai/types/test_suite_run_state.rb

@@ -1,12 +1,18 @@
 # frozen_string_literal: true
 
 module Vellum
-  # @type [TEST_SUITE_RUN_STATE]
-  TEST_SUITE_RUN_STATE = {
-    queued: "QUEUED",
-    running: "RUNNING",
-    complete: "COMPLETE",
-    failed: "FAILED",
-    cancelled: "CANCELLED"
-  }.freeze
-end
+# * `QUEUED` - Queued
+#  * `RUNNING` - Running
+#  * `COMPLETE` - Complete
+#  * `FAILED` - Failed
+#  * `CANCELLED` - Cancelled
+  class TestSuiteRunState
+
+    QUEUED = "QUEUED"
+    RUNNING = "RUNNING"
+    COMPLETE = "COMPLETE"
+    FAILED = "FAILED"
+    CANCELLED = "CANCELLED"
+
+  end
+end