Class: Athenian::FilterApi

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/api/filter_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FilterApi

Returns a new instance of FilterApi.



16
17
18
# File 'lib/athenian/api/filter_api.rb', line 16

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.



14
15
16
# File 'lib/athenian/api/filter_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#diff_releases(opts = {}) ⇒ DiffedReleases

Find releases between the two given ones per repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



23
24
25
26
# File 'lib/athenian/api/filter_api.rb', line 23

def diff_releases(opts = {})
  data, _status_code, _headers = diff_releases_with_http_info(opts)
  data
end

#diff_releases_with_http_info(opts = {}) ⇒ Array<(DiffedReleases, Integer, Hash)>

Find releases between the two given ones per repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(DiffedReleases, Integer, Hash)>)

    DiffedReleases data, response status code and response headers



32
33
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
73
74
75
76
77
78
79
# File 'lib/athenian/api/filter_api.rb', line 32

def diff_releases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.diff_releases ...'
  end
  # resource path
  local_var_path = '/diff/releases'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'DiffedReleases'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.diff_releases",
    :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: FilterApi#diff_releases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_code_checks(opts = {}) ⇒ FilteredCodeCheckRuns

Find code check runs that match the specified query. [What a code check run is exactly.](docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



85
86
87
88
# File 'lib/athenian/api/filter_api.rb', line 85

def filter_code_checks(opts = {})
  data, _status_code, _headers = filter_code_checks_with_http_info(opts)
  data
end

#filter_code_checks_with_http_info(opts = {}) ⇒ Array<(FilteredCodeCheckRuns, Integer, Hash)>

Find code check runs that match the specified query. [What a code check run is exactly.](docs.github.com/en/rest/guides/getting-started-with-the-checks-api#about-check-runs)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FilteredCodeCheckRuns, Integer, Hash)>)

    FilteredCodeCheckRuns data, response status code and response headers



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
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/athenian/api/filter_api.rb', line 94

def filter_code_checks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_code_checks ...'
  end
  # resource path
  local_var_path = '/filter/code_checks'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'FilteredCodeCheckRuns'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_code_checks",
    :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: FilterApi#filter_code_checks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_commits(opts = {}) ⇒ CommitsList

Find commits that match the specified query.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



147
148
149
150
# File 'lib/athenian/api/filter_api.rb', line 147

def filter_commits(opts = {})
  data, _status_code, _headers = filter_commits_with_http_info(opts)
  data
end

#filter_commits_with_http_info(opts = {}) ⇒ Array<(CommitsList, Integer, Hash)>

Find commits that match the specified query.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CommitsList, Integer, Hash)>)

    CommitsList data, response status code and response headers



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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/athenian/api/filter_api.rb', line 156

def filter_commits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_commits ...'
  end
  # resource path
  local_var_path = '/filter/commits'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'CommitsList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_commits",
    :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: FilterApi#filter_commits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_contributors(opts = {}) ⇒ Array<DeveloperSummary>

Find developers that made an action within the given timeframe.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



209
210
211
212
# File 'lib/athenian/api/filter_api.rb', line 209

def filter_contributors(opts = {})
  data, _status_code, _headers = filter_contributors_with_http_info(opts)
  data
end

#filter_contributors_with_http_info(opts = {}) ⇒ Array<(Array<DeveloperSummary>, Integer, Hash)>

Find developers that made an action within the given timeframe.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<DeveloperSummary>, Integer, Hash)>)

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



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
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/athenian/api/filter_api.rb', line 218

def filter_contributors_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_contributors ...'
  end
  # resource path
  local_var_path = '/filter/contributors'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_contributors",
    :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: FilterApi#filter_contributors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_deployments(opts = {}) ⇒ FilteredDeployments

List the deployments that satisfy the provided filters. We accept new deployment notifications at ‘/events/deployments`.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



271
272
273
274
# File 'lib/athenian/api/filter_api.rb', line 271

def filter_deployments(opts = {})
  data, _status_code, _headers = filter_deployments_with_http_info(opts)
  data
end

#filter_deployments_with_http_info(opts = {}) ⇒ Array<(FilteredDeployments, Integer, Hash)>

List the deployments that satisfy the provided filters. We accept new deployment notifications at &#x60;/events/deployments&#x60;.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FilteredDeployments, Integer, Hash)>)

    FilteredDeployments data, response status code and response headers



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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# File 'lib/athenian/api/filter_api.rb', line 280

def filter_deployments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_deployments ...'
  end
  # resource path
  local_var_path = '/filter/deployments'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'FilteredDeployments'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_deployments",
    :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: FilterApi#filter_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_environments(opts = {}) ⇒ Array<FilteredEnvironment>

List the deployment environments.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



333
334
335
336
# File 'lib/athenian/api/filter_api.rb', line 333

def filter_environments(opts = {})
  data, _status_code, _headers = filter_environments_with_http_info(opts)
  data
end

#filter_environments_with_http_info(opts = {}) ⇒ Array<(Array<FilteredEnvironment>, Integer, Hash)>

List the deployment environments.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<FilteredEnvironment>, Integer, Hash)>)

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



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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
# File 'lib/athenian/api/filter_api.rb', line 342

def filter_environments_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_environments ...'
  end
  # resource path
  local_var_path = '/filter/environments'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_environments",
    :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: FilterApi#filter_environments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_jira_stuff(opts = {}) ⇒ FilteredJIRAStuff

Find various JIRA entities relevant to the specified date interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



395
396
397
398
# File 'lib/athenian/api/filter_api.rb', line 395

def filter_jira_stuff(opts = {})
  data, _status_code, _headers = filter_jira_stuff_with_http_info(opts)
  data
end

#filter_jira_stuff_with_http_info(opts = {}) ⇒ Array<(FilteredJIRAStuff, Integer, Hash)>

Find various JIRA entities relevant to the specified date interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(FilteredJIRAStuff, Integer, Hash)>)

    FilteredJIRAStuff data, response status code and response headers



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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
# File 'lib/athenian/api/filter_api.rb', line 404

def filter_jira_stuff_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_jira_stuff ...'
  end
  # resource path
  local_var_path = '/filter/jira'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'FilteredJIRAStuff'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_jira_stuff",
    :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: FilterApi#filter_jira_stuff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_labels(opts = {}) ⇒ Array<FilteredLabel>

Find labels used in the given repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



457
458
459
460
# File 'lib/athenian/api/filter_api.rb', line 457

def filter_labels(opts = {})
  data, _status_code, _headers = filter_labels_with_http_info(opts)
  data
end

#filter_labels_with_http_info(opts = {}) ⇒ Array<(Array<FilteredLabel>, Integer, Hash)>

Find labels used in the given repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<FilteredLabel>, Integer, Hash)>)

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



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
# File 'lib/athenian/api/filter_api.rb', line 466

def filter_labels_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_labels ...'
  end
  # resource path
  local_var_path = '/filter/labels'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_labels",
    :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: FilterApi#filter_labels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_prs(opts = {}) ⇒ PullRequestSet

List pull requests that satisfy the query.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



519
520
521
522
# File 'lib/athenian/api/filter_api.rb', line 519

def filter_prs(opts = {})
  data, _status_code, _headers = filter_prs_with_http_info(opts)
  data
end

#filter_prs_with_http_info(opts = {}) ⇒ Array<(PullRequestSet, Integer, Hash)>

List pull requests that satisfy the query.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(PullRequestSet, Integer, Hash)>)

    PullRequestSet data, response status code and response headers



528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
# File 'lib/athenian/api/filter_api.rb', line 528

def filter_prs_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_prs ...'
  end
  # resource path
  local_var_path = '/filter/pull_requests'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PullRequestSet'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_prs",
    :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: FilterApi#filter_prs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_releases(opts = {}) ⇒ ReleaseSet

Find releases that were published in the given time fram in the given repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



581
582
583
584
# File 'lib/athenian/api/filter_api.rb', line 581

def filter_releases(opts = {})
  data, _status_code, _headers = filter_releases_with_http_info(opts)
  data
end

#filter_releases_with_http_info(opts = {}) ⇒ Array<(ReleaseSet, Integer, Hash)>

Find releases that were published in the given time fram in the given repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(ReleaseSet, Integer, Hash)>)

    ReleaseSet data, response status code and response headers



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
# File 'lib/athenian/api/filter_api.rb', line 590

def filter_releases_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_releases ...'
  end
  # resource path
  local_var_path = '/filter/releases'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'ReleaseSet'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_releases",
    :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: FilterApi#filter_releases\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#filter_repositories(opts = {}) ⇒ Array<String>

Find repositories that were updated within the given timeframe.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<String>)


643
644
645
646
# File 'lib/athenian/api/filter_api.rb', line 643

def filter_repositories(opts = {})
  data, _status_code, _headers = filter_repositories_with_http_info(opts)
  data
end

#filter_repositories_with_http_info(opts = {}) ⇒ Array<(Array<String>, Integer, Hash)>

Find repositories that were updated within the given timeframe.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<String>, Integer, Hash)>)

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



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'lib/athenian/api/filter_api.rb', line 652

def filter_repositories_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilterApi.filter_repositories ...'
  end
  # resource path
  local_var_path = '/filter/repositories'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"FilterApi.filter_repositories",
    :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: FilterApi#filter_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end