Class: DependencyTracker::DefaultApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/api/default_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DefaultApi

Returns a new instance of DefaultApi.



19
20
21
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_project_to_rule(rule_uuid, project_uuid, opts = {}) ⇒ NotificationRule

Adds a project to a notification rule

Parameters:

  • rule_uuid (String) —

    The UUID of the rule to add a project to

  • project_uuid (String) —

    The UUID of the project to add to the rule

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 27

def add_project_to_rule(rule_uuid, project_uuid, opts = {})
  data, _status_code, _headers = add_project_to_rule_with_http_info(rule_uuid, project_uuid, opts)
  data
end

#add_project_to_rule_with_http_info(rule_uuid, project_uuid, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

Adds a project to a notification rule

Parameters:

  • rule_uuid (String) —

    The UUID of the rule to add a project to

  • project_uuid (String) —

    The UUID of the project to add to the rule

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

    the optional parameters

Returns:

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

    NotificationRule data, response status code and response headers



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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 37

def add_project_to_rule_with_http_info(rule_uuid, project_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.add_project_to_rule ...'
  end
  # verify the required parameter 'rule_uuid' is set
  if @api_client.config.client_side_validation && rule_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'rule_uuid' when calling DefaultApi.add_project_to_rule"
  end
  # verify the required parameter 'project_uuid' is set
  if @api_client.config.client_side_validation && project_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'project_uuid' when calling DefaultApi.add_project_to_rule"
  end
  # resource path
  local_var_path = '/v1/notification/rule/{ruleUuid}/project/{projectUuid}'.sub('{' + 'ruleUuid' + '}', CGI.escape(rule_uuid.to_s)).sub('{' + 'projectUuid' + '}', CGI.escape(project_uuid.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NotificationRule' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#add_project_to_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_notification_rule(opts = {}) ⇒ NotificationRule

Creates a new notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



92
93
94
95
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 92

def create_notification_rule(opts = {})
  data, _status_code, _headers = create_notification_rule_with_http_info(opts)
  data
end

#create_notification_rule_with_http_info(opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

Creates a new notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    NotificationRule data, response status code and response headers



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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 101

def create_notification_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.create_notification_rule ...'
  end
  # resource path
  local_var_path = '/v1/notification/rule'

  # 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'])
  # 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
  return_type = opts[:return_type] || 'NotificationRule' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#create_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_notification_rule(opts = {}) ⇒ nil

Deletes a notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


150
151
152
153
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 150

def delete_notification_rule(opts = {})
  delete_notification_rule_with_http_info(opts)
  nil
end

#delete_notification_rule_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deletes a notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 159

def delete_notification_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.delete_notification_rule ...'
  end
  # resource path
  local_var_path = '/v1/notification/rule'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#delete_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_notification_publishers(opts = {}) ⇒ Array<NotificationPublisher>

Returns a list of all notification publishers

Parameters:

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 205

def get_all_notification_publishers(opts = {})
  data, _status_code, _headers = get_all_notification_publishers_with_http_info(opts)
  data
end

#get_all_notification_publishers_with_http_info(opts = {}) ⇒ Array<(Array<NotificationPublisher>, Integer, Hash)>

Returns a list of all notification publishers

Parameters:

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

    the optional parameters

Returns:

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

    Array<NotificationPublisher> data, response status code and response headers



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 213

def get_all_notification_publishers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_all_notification_publishers ...'
  end
  # resource path
  local_var_path = '/v1/notification/publisher'

  # 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<NotificationPublisher>' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_all_notification_publishers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_notification_rules(opts = {}) ⇒ Array<NotificationRule>

Returns a list of all notification rules

Parameters:

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

    the optional parameters

Returns:



259
260
261
262
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 259

def get_all_notification_rules(opts = {})
  data, _status_code, _headers = get_all_notification_rules_with_http_info(opts)
  data
end

#get_all_notification_rules_with_http_info(opts = {}) ⇒ Array<(Array<NotificationRule>, Integer, Hash)>

Returns a list of all notification rules

Parameters:

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

    the optional parameters

Returns:

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

    Array<NotificationRule> data, response status code and response headers



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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 267

def get_all_notification_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.get_all_notification_rules ...'
  end
  # resource path
  local_var_path = '/v1/notification/rule'

  # 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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'Array<NotificationRule>' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#get_all_notification_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_project_from_rule(rule_uuid, project_uuid, opts = {}) ⇒ NotificationRule

Removes a project from a notification rule

Parameters:

  • rule_uuid (String) —

    The UUID of the rule to remove the project from

  • project_uuid (String) —

    The UUID of the project to remove from the rule

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

    the optional parameters

Returns:



315
316
317
318
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 315

def remove_project_from_rule(rule_uuid, project_uuid, opts = {})
  data, _status_code, _headers = remove_project_from_rule_with_http_info(rule_uuid, project_uuid, opts)
  data
end

#remove_project_from_rule_with_http_info(rule_uuid, project_uuid, opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

Removes a project from a notification rule

Parameters:

  • rule_uuid (String) —

    The UUID of the rule to remove the project from

  • project_uuid (String) —

    The UUID of the project to remove from the rule

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

    the optional parameters

Returns:

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

    NotificationRule data, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 325

def remove_project_from_rule_with_http_info(rule_uuid, project_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.remove_project_from_rule ...'
  end
  # verify the required parameter 'rule_uuid' is set
  if @api_client.config.client_side_validation && rule_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'rule_uuid' when calling DefaultApi.remove_project_from_rule"
  end
  # verify the required parameter 'project_uuid' is set
  if @api_client.config.client_side_validation && project_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'project_uuid' when calling DefaultApi.remove_project_from_rule"
  end
  # resource path
  local_var_path = '/v1/notification/rule/{ruleUuid}/project/{projectUuid}'.sub('{' + 'ruleUuid' + '}', CGI.escape(rule_uuid.to_s)).sub('{' + 'projectUuid' + '}', CGI.escape(project_uuid.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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'NotificationRule' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#remove_project_from_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#test_smtp_publisher_config(opts = {}) ⇒ nil

Dispatches a SMTP notification test

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :destination (String)

Returns:

  • (nil) 


380
381
382
383
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 380

def test_smtp_publisher_config(opts = {})
  test_smtp_publisher_config_with_http_info(opts)
  nil
end

#test_smtp_publisher_config_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Dispatches a SMTP notification test

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :destination (String)

Returns:

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

    nil, response status code and response headers



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 389

def test_smtp_publisher_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.test_smtp_publisher_config ...'
  end
  # resource path
  local_var_path = '/v1/notification/publisher/test/smtp'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['destination'] = opts[:'destination'] if !opts[:'destination'].nil?

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#test_smtp_publisher_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_notification_rule(opts = {}) ⇒ NotificationRule

Updates a notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



437
438
439
440
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 437

def update_notification_rule(opts = {})
  data, _status_code, _headers = update_notification_rule_with_http_info(opts)
  data
end

#update_notification_rule_with_http_info(opts = {}) ⇒ Array<(NotificationRule, Integer, Hash)>

Updates a notification rule

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    NotificationRule data, response status code and response headers



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/dependency-tracker-client/api/default_api.rb', line 446

def update_notification_rule_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DefaultApi.update_notification_rule ...'
  end
  # resource path
  local_var_path = '/v1/notification/rule'

  # 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'])
  # 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
  return_type = opts[:return_type] || 'NotificationRule' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DefaultApi#update_notification_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end