class Vellum::TestSuiteRunsClient

def create(test_suite_id:, exec_config:, request_options: nil)

Returns:
  • (TestSuiteRunRead) -

Parameters:
  • request_options (RequestOptions) --
  • exec_config (Hash) -- Configuration that defines how the Test Suite should be runRequest of type TestSuiteRunExecConfigRequest, as a Hash
  • test_suite_id (String) -- The ID of the Test Suite to run 
def create(test_suite_id:, exec_config:, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      test_suite_id: test_suite_id,
      exec_config: exec_config
    }.compact
    req.url "#{@request_client.default_environment[:Default]}/v1/test-suite-runs"
  end
  TestSuiteRunRead.from_json(json_object: response.body)
end

def initialize(request_client:)

Returns:
  • (TestSuiteRunsClient) -

Parameters:
  • request_client (RequestClient) -- 
def initialize(request_client:)
  # @type [RequestClient]
  @request_client = request_client
end

def list_executions(id:, limit: nil, offset: nil, request_options: nil)

Returns:
  • (PaginatedTestSuiteRunExecutionList) -

Parameters:
  • request_options (RequestOptions) --
  • offset (Integer) -- The initial index from which to return the results.
  • limit (Integer) -- Number of results to return per page.
  • id (String) -- A UUID string identifying this test suite run. 
def list_executions(id:, limit: nil, offset: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "limit": limit,
      "offset": offset
    }.compact
    req.url "#{@request_client.default_environment[:Default]}/v1/test-suite-runs/#{id}/executions"
  end
  PaginatedTestSuiteRunExecutionList.from_json(json_object: response.body)
end

def retrieve(id:, request_options: nil)

Returns:
  • (TestSuiteRunRead) -

Parameters:
  • request_options (RequestOptions) --
  • id (String) -- A UUID string identifying this test suite run. 
def retrieve(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["X_API_KEY"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
    req.url "#{@request_client.default_environment[:Default]}/v1/test-suite-runs/#{id}"
  end
  TestSuiteRunRead.from_json(json_object: response.body)
end