Class: Vapi::TestSuiteRunsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/test_suite_runs/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vapi::TestSuiteRunsClient

Parameters:



17
18
19
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 17

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vapi::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#test_suite_run_controller_create(test_suite_id:, name: nil, request_options: nil) ⇒ Vapi::TestSuiteRun

Parameters:

  • test_suite_id (String)
  • name (String) (defaults to: nil) —

    This is the name of the test suite run.

  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 75

def test_suite_run_controller_create(test_suite_id:, name: nil, 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["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request_options&.additional_body_parameters || {}), name: name }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/test-suite/#{test_suite_id}/run"
  end
  Vapi::TestSuiteRun.from_json(json_object: response.body)
end

#test_suite_run_controller_find_all_paginated(test_suite_id:, page: nil, sort_order: nil, limit: nil, created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil, updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: nil, request_options: nil) ⇒ Vapi::TestSuiteRunsPaginatedResponse

Parameters:

  • test_suite_id (String)
  • page (Float) (defaults to: nil) —

    This is the page number to return. Defaults to 1.

  • sort_order (Vapi::TestSuiteRuns::TestSuiteRunControllerFindAllPaginatedRequestSortOrder) (defaults to: nil) —

    This is the sort order for pagination. Defaults to ‘DESC’.

  • limit (Float) (defaults to: nil) —

    This is the maximum number of items to return. Defaults to 100.

  • created_at_gt (DateTime) (defaults to: nil) —

    This will return items where the createdAt is greater than the specified value.

  • created_at_lt (DateTime) (defaults to: nil) —

    This will return items where the createdAt is less than the specified value.

  • created_at_ge (DateTime) (defaults to: nil) —

    This will return items where the createdAt is greater than or equal to the specified value.

  • created_at_le (DateTime) (defaults to: nil) —

    This will return items where the createdAt is less than or equal to the specified value.

  • updated_at_gt (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is greater than the specified value.

  • updated_at_lt (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is less than the specified value.

  • updated_at_ge (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is greater than or equal to the specified value.

  • updated_at_le (DateTime) (defaults to: nil) —

    This will return items where the updatedAt is less than or equal to the specified value.

  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 39

def test_suite_run_controller_find_all_paginated(test_suite_id:, page: nil, sort_order: nil, limit: nil,
                                                 created_at_gt: nil, created_at_lt: nil, created_at_ge: nil, created_at_le: nil, updated_at_gt: nil, updated_at_lt: nil, updated_at_ge: nil, updated_at_le: 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["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.params = {
      **(request_options&.additional_query_parameters || {}),
      "page": page,
      "sortOrder": sort_order,
      "limit": limit,
      "createdAtGt": created_at_gt,
      "createdAtLt": created_at_lt,
      "createdAtGe": created_at_ge,
      "createdAtLe": created_at_le,
      "updatedAtGt": updated_at_gt,
      "updatedAtLt": updated_at_lt,
      "updatedAtGe": updated_at_ge,
      "updatedAtLe": updated_at_le
    }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/test-suite/#{test_suite_id}/run"
  end
  Vapi::TestSuiteRunsPaginatedResponse.from_json(json_object: response.body)
end

#test_suite_run_controller_find_one(test_suite_id:, id:, request_options: nil) ⇒ Vapi::TestSuiteRun

Parameters:

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 97

def test_suite_run_controller_find_one(test_suite_id:, 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["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/test-suite/#{test_suite_id}/run/#{id}"
  end
  Vapi::TestSuiteRun.from_json(json_object: response.body)
end

#test_suite_run_controller_remove(test_suite_id:, id:, request_options: nil) ⇒ Vapi::TestSuiteRun

Parameters:

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 121

def test_suite_run_controller_remove(test_suite_id:, id:, request_options: nil)
  response = @request_client.conn.delete do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/test-suite/#{test_suite_id}/run/#{id}"
  end
  Vapi::TestSuiteRun.from_json(json_object: response.body)
end

#test_suite_run_controller_update(test_suite_id:, id:, name: nil, request_options: nil) ⇒ Vapi::TestSuiteRun

Parameters:

  • test_suite_id (String)
  • id (String)
  • name (String) (defaults to: nil) —

    This is the name of the test suite run.

  • request_options (Vapi::RequestOptions) (defaults to: nil)

Returns:



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/vapi_server_sdk/test_suite_runs/client.rb', line 146

def test_suite_run_controller_update(test_suite_id:, id:, name: nil, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = { **(request_options&.additional_body_parameters || {}), name: name }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/test-suite/#{test_suite_id}/run/#{id}"
  end
  Vapi::TestSuiteRun.from_json(json_object: response.body)
end