Class: SwaggerClient::ScanTemplateApi

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ScanTemplateApi

Returns a new instance of ScanTemplateApi.



16
17
18
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create_scan_template(opts = {}) ⇒ CreatedReferenceScanTemplateIDLink

Scan Templates Creates a new scan template.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ScanTemplate) —

    The details of the scan template.

Returns:



24
25
26
27
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 24

def create_scan_template(opts = {})
  data, _status_code, _headers = create_scan_template_with_http_info(opts)
  data
end

#create_scan_template_with_http_info(opts = {}) ⇒ Array<(CreatedReferenceScanTemplateIDLink, Integer, Hash)>

Scan Templates Creates a new scan template.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ScanTemplate) —

    The details of the scan template.

Returns:



34
35
36
37
38
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
70
71
72
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 34

def create_scan_template_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanTemplateApi.create_scan_template ...'
  end
  # resource path
  local_var_path = '/api/3/scan_templates'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'CreatedReferenceScanTemplateIDLink' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanTemplateApi#create_scan_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_scan_template(site_idte_id, opts = {}) ⇒ Links

Scan Template Deletes a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 78

def delete_scan_template(site_idte_id, opts = {})
  data, _status_code, _headers = delete_scan_template_with_http_info(site_idte_id, opts)
  data
end

#delete_scan_template_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Scan Template Deletes a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Links, Integer, Hash)>) —

    Links data, response status code and response headers



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 88

def delete_scan_template_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanTemplateApi.delete_scan_template ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScanTemplateApi.delete_scan_template"
  end
  # resource path
  local_var_path = '/api/3/scan_templates/{id}'.sub('{' + 'id' + '}', site_idte_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanTemplateApi#delete_scan_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scan_template(site_idte_id, opts = {}) ⇒ ScanTemplate

Scan Template Returns a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



134
135
136
137
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 134

def get_scan_template(site_idte_id, opts = {})
  data, _status_code, _headers = get_scan_template_with_http_info(site_idte_id, opts)
  data
end

#get_scan_template_with_http_info(site_idte_id, opts = {}) ⇒ Array<(ScanTemplate, Integer, Hash)>

Scan Template Returns a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ScanTemplate, Integer, Hash)>) —

    ScanTemplate data, response status code and response headers



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 144

def get_scan_template_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanTemplateApi.get_scan_template ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScanTemplateApi.get_scan_template"
  end
  # resource path
  local_var_path = '/api/3/scan_templates/{id}'.sub('{' + 'id' + '}', site_idte_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'ScanTemplate' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanTemplateApi#get_scan_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scan_templates(opts = {}) ⇒ ResourcesScanTemplate

Scan Templates Returns all scan templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



189
190
191
192
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 189

def get_scan_templates(opts = {})
  data, _status_code, _headers = get_scan_templates_with_http_info(opts)
  data
end

#get_scan_templates_with_http_info(opts = {}) ⇒ Array<(ResourcesScanTemplate, Integer, Hash)>

Scan Templates Returns all scan templates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResourcesScanTemplate, Integer, Hash)>) —

    ResourcesScanTemplate data, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 198

def get_scan_templates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanTemplateApi.get_scan_templates ...'
  end
  # resource path
  local_var_path = '/api/3/scan_templates'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'ResourcesScanTemplate' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanTemplateApi#get_scan_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_scan_template(site_idte_id, opts = {}) ⇒ Links

Scan Template Updates a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ScanTemplate) —

    The details of the scan template.

Returns:



241
242
243
244
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 241

def update_scan_template(site_idte_id, opts = {})
  data, _status_code, _headers = update_scan_template_with_http_info(site_idte_id, opts)
  data
end

#update_scan_template_with_http_info(site_idte_id, opts = {}) ⇒ Array<(Links, Integer, Hash)>

Scan Template Updates a scan template.

Parameters:

  • id —

    The identifier of the scan template

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (ScanTemplate) —

    The details of the scan template.

Returns:

  • (Array<(Links, Integer, Hash)>) —

    Links data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/api/scan_template_api.rb', line 252

def update_scan_template_with_http_info(site_idte_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ScanTemplateApi.update_scan_template ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && site_idte_id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ScanTemplateApi.update_scan_template"
  end
  # resource path
  local_var_path = '/api/3/scan_templates/{id}'.sub('{' + 'id' + '}', site_idte_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=UTF-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  return_type = opts[:return_type] || 'Links' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ScanTemplateApi#update_scan_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end