Class: Athenian::SettingsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SettingsApi

Returns a new instance of SettingsApi.



16
17
18
 
# File 'lib/athenian/api/settings_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/athenian/api/settings_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#delete_logical_repository(opts = {}) ⇒ Object

🛡️ Delete a logical repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


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

def delete_logical_repository(opts = {})
  data, _status_code, _headers = delete_logical_repository_with_http_info(opts)
  data
end

#delete_logical_repository_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

🛡️ Delete a logical repository.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object 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/settings_api.rb', line 32

def delete_logical_repository_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.delete_logical_repository ...'
  end
  # resource path
  local_var_path = '/settings/logical_repository/delete'

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

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

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

#delete_work_type(opts = {}) ⇒ Object

👤 Remove the work type given the name.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Object) 


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

def delete_work_type(opts = {})
  data, _status_code, _headers = delete_work_type_with_http_info(opts)
  data
end

#delete_work_type_with_http_info(opts = {}) ⇒ Array<(Object, Integer, Hash)>

👤 Remove the work type given the name.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Object 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/settings_api.rb', line 94

def delete_work_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.delete_work_type ...'
  end
  # resource path
  local_var_path = '/settings/work_type/delete'

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

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

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

#get_jira_identities(id, opts = {}) ⇒ Array<MappedJIRAIdentity>

Fetch the GitHub<>JIRA user identity mapping.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:



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

def get_jira_identities(id, opts = {})
  data, _status_code, _headers = get_jira_identities_with_http_info(id, opts)
  data
end

#get_jira_identities_with_http_info(id, opts = {}) ⇒ Array<(Array<MappedJIRAIdentity>, Integer, Hash)>

Fetch the GitHub&lt;&gt;JIRA user identity mapping.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:

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

    Array<MappedJIRAIdentity> 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
 
# File 'lib/athenian/api/settings_api.rb', line 156

def get_jira_identities_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_jira_identities ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SettingsApi.get_jira_identities"
  end
  # resource path
  local_var_path = '/settings/jira/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

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

#get_jira_projects(id, opts = {}) ⇒ Array<JIRAProject>

List the currently enabled JIRA project settings.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:



208
209
210
211
 
# File 'lib/athenian/api/settings_api.rb', line 208

def get_jira_projects(id, opts = {})
  data, _status_code, _headers = get_jira_projects_with_http_info(id, opts)
  data
end

#get_jira_projects_with_http_info(id, opts = {}) ⇒ Array<(Array<JIRAProject>, Integer, Hash)>

List the currently enabled JIRA project settings.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:

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

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



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

def get_jira_projects_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_jira_projects ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SettingsApi.get_jira_projects"
  end
  # resource path
  local_var_path = '/settings/jira/projects/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

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

#get_work_type(opts = {}) ⇒ WorkType

Fetch the definition of the work type given the name.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



269
270
271
272
 
# File 'lib/athenian/api/settings_api.rb', line 269

def get_work_type(opts = {})
  data, _status_code, _headers = get_work_type_with_http_info(opts)
  data
end

#get_work_type_with_http_info(opts = {}) ⇒ Array<(WorkType, Integer, Hash)>

Fetch the definition of the work type given the name.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WorkType data, response status code and response headers



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

def get_work_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.get_work_type ...'
  end
  # resource path
  local_var_path = '/settings/work_type/get'

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

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

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

#list_logical_repositories(id, opts = {}) ⇒ Array<LogicalRepository>

List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:



331
332
333
334
 
# File 'lib/athenian/api/settings_api.rb', line 331

def list_logical_repositories(id, opts = {})
  data, _status_code, _headers = list_logical_repositories_with_http_info(id, opts)
  data
end

#list_logical_repositories_with_http_info(id, opts = {}) ⇒ Array<(Array<LogicalRepository>, Integer, Hash)>

List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:

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

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



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

def list_logical_repositories_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.list_logical_repositories ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SettingsApi.list_logical_repositories"
  end
  # resource path
  local_var_path = '/settings/logical_repositories/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"SettingsApi.list_logical_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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#list_logical_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_release_match_settings(id, opts = {}) ⇒ Hash<String, ReleaseMatchSetting>

List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:



392
393
394
395
 
# File 'lib/athenian/api/settings_api.rb', line 392

def list_release_match_settings(id, opts = {})
  data, _status_code, _headers = list_release_match_settings_with_http_info(id, opts)
  data
end

#list_release_match_settings_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, ReleaseMatchSetting>, Integer, Hash)>

List the current release matching settings. Release settings are rules by which to mark releases in GitHub repositories.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:

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

    Hash<String, ReleaseMatchSetting> data, response status code and response headers



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

def list_release_match_settings_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.list_release_match_settings ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SettingsApi.list_release_match_settings"
  end
  # resource path
  local_var_path = '/settings/release_match/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, ReleaseMatchSetting>'

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

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

#list_work_types(id, opts = {}) ⇒ Array<WorkType>

List the current work types - rule sets to group PRs, releases, etc. together.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:



453
454
455
456
 
# File 'lib/athenian/api/settings_api.rb', line 453

def list_work_types(id, opts = {})
  data, _status_code, _headers = list_work_types_with_http_info(id, opts)
  data
end

#list_work_types_with_http_info(id, opts = {}) ⇒ Array<(Array<WorkType>, Integer, Hash)>

List the current work types - rule sets to group PRs, releases, etc. together.

Parameters:

  • id (Integer) —

    Numeric identifier of the account.

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

    the optional parameters

Returns:

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

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



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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/athenian/api/settings_api.rb', line 462

def list_work_types_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.list_work_types ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SettingsApi.list_work_types"
  end
  # resource path
  local_var_path = '/settings/work_types/{id}'.sub('{' + 'id' + '}', CGI.escape(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'])

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

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

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

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

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

#set_jira_identities(opts = {}) ⇒ Array<MappedJIRAIdentity>

👤 Add, remove or override GitHub<>JIRA user identity mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



514
515
516
517
 
# File 'lib/athenian/api/settings_api.rb', line 514

def set_jira_identities(opts = {})
  data, _status_code, _headers = set_jira_identities_with_http_info(opts)
  data
end

#set_jira_identities_with_http_info(opts = {}) ⇒ Array<(Array<MappedJIRAIdentity>, Integer, Hash)>

👤 Add, remove or override GitHub&lt;&gt;JIRA user identity mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



523
524
525
526
527
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
 
# File 'lib/athenian/api/settings_api.rb', line 523

def set_jira_identities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.set_jira_identities ...'
  end
  # resource path
  local_var_path = '/settings/jira/identities'

  # 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<MappedJIRAIdentity>'

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

  new_options = opts.merge(
    :operation => :"SettingsApi.set_jira_identities",
    :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(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SettingsApi#set_jira_identities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_jira_projects(opts = {}) ⇒ Array<JIRAProject>

🛡️👤 Set the enabled JIRA projects.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



576
577
578
579
 
# File 'lib/athenian/api/settings_api.rb', line 576

def set_jira_projects(opts = {})
  data, _status_code, _headers = set_jira_projects_with_http_info(opts)
  data
end

#set_jira_projects_with_http_info(opts = {}) ⇒ Array<(Array<JIRAProject>, Integer, Hash)>

🛡️👤 Set the enabled JIRA projects.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



585
586
587
588
589
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
 
# File 'lib/athenian/api/settings_api.rb', line 585

def set_jira_projects_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.set_jira_projects ...'
  end
  # resource path
  local_var_path = '/settings/jira/projects'

  # 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<JIRAProject>'

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

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

#set_logical_repository(opts = {}) ⇒ LogicalRepository

🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



638
639
640
641
 
# File 'lib/athenian/api/settings_api.rb', line 638

def set_logical_repository(opts = {})
  data, _status_code, _headers = set_logical_repository_with_http_info(opts)
  data
end

#set_logical_repository_with_http_info(opts = {}) ⇒ Array<(LogicalRepository, Integer, Hash)>

🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    LogicalRepository data, response status code and response headers



647
648
649
650
651
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
 
# File 'lib/athenian/api/settings_api.rb', line 647

def set_logical_repository_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.set_logical_repository ...'
  end
  # resource path
  local_var_path = '/settings/logical_repository'

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

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

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

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

👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<String>) 


700
701
702
703
 
# File 'lib/athenian/api/settings_api.rb', line 700

def set_release_match(opts = {})
  data, _status_code, _headers = set_release_match_with_http_info(opts)
  data
end

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

👤 Set the release matching rule for a list of repositories. Only for account admins. Release settings are rules by which to mark releases in GitHub repositories.

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



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
 
# File 'lib/athenian/api/settings_api.rb', line 709

def set_release_match_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.set_release_match ...'
  end
  # resource path
  local_var_path = '/settings/release_match'

  # 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] || ['bearerAuth']

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

#set_work_type(opts = {}) ⇒ WorkType

👤 Create or update a work type - a rule set to group PRs, releases, etc. together.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



762
763
764
765
 
# File 'lib/athenian/api/settings_api.rb', line 762

def set_work_type(opts = {})
  data, _status_code, _headers = set_work_type_with_http_info(opts)
  data
end

#set_work_type_with_http_info(opts = {}) ⇒ Array<(WorkType, Integer, Hash)>

👤 Create or update a work type - a rule set to group PRs, releases, etc. together.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WorkType data, response status code and response headers



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
 
# File 'lib/athenian/api/settings_api.rb', line 771

def set_work_type_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SettingsApi.set_work_type ...'
  end
  # resource path
  local_var_path = '/settings/work_type'

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

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

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