Class: DatadogAPIClient::V2::JiraIntegrationAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/jira_integration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ JiraIntegrationAPI

Returns a new instance of JiraIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_jira_issue_template(body, opts = {}) ⇒ Object

Create Jira issue template.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 29

def create_jira_issue_template(body, opts = {})
  data, _status_code, _headers = create_jira_issue_template_with_http_info(body, opts)
  data
end

#create_jira_issue_template_with_http_info(body, opts = {}) ⇒ Array<(JiraIssueTemplateResponse, Integer, Hash)>

Create Jira issue template.

Create a new Jira issue template.

Parameters:

Returns:

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

    JiraIssueTemplateResponse data, response status code and response headers



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
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 41

def create_jira_issue_template_with_http_info(body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.create_jira_issue_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_jira_issue_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_jira_issue_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.create_jira_issue_template ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling JiraIntegrationAPI.create_jira_issue_template"
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/issue-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'])
  # 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[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :create_jira_issue_template,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_jira_account(account_id, opts = {}) ⇒ Object

Delete Jira account.

See Also:



102
103
104
105
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 102

def (, opts = {})
  (, opts)
  nil
end

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

Delete Jira account.

Delete a Jira account by ID.

Parameters:

  • account_id (UUID) —

    The ID of the Jira account to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 114

def (, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_jira_account".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_jira_account")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_jira_account"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.delete_jira_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling JiraIntegrationAPI.delete_jira_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/accounts/{account_id}'.sub('{account_id}', CGI.escape(.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_jira_account,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#delete_jira_issue_template(issue_template_id, opts = {}) ⇒ Object

Delete Jira issue template.

See Also:



173
174
175
176
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 173

def delete_jira_issue_template(issue_template_id, opts = {})
  delete_jira_issue_template_with_http_info(issue_template_id, opts)
  nil
end

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

Delete Jira issue template.

Delete a Jira issue template by ID.

Parameters:

  • issue_template_id (UUID) —

    The ID of the Jira issue template to delete

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



185
186
187
188
189
190
191
192
193
194
195
196
197
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
235
236
237
238
239
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 185

def delete_jira_issue_template_with_http_info(issue_template_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_jira_issue_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_jira_issue_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_jira_issue_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.delete_jira_issue_template ...'
  end
  # verify the required parameter 'issue_template_id' is set
  if @api_client.config.client_side_validation && issue_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_template_id' when calling JiraIntegrationAPI.delete_jira_issue_template"
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/issue-templates/{issue_template_id}'.sub('{issue_template_id}', CGI.escape(issue_template_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :delete_jira_issue_template,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_jira_issue_template(issue_template_id, opts = {}) ⇒ Object

Get Jira issue template.

See Also:



244
245
246
247
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 244

def get_jira_issue_template(issue_template_id, opts = {})
  data, _status_code, _headers = get_jira_issue_template_with_http_info(issue_template_id, opts)
  data
end

#get_jira_issue_template_with_http_info(issue_template_id, opts = {}) ⇒ Array<(JiraIssueTemplateResponse, Integer, Hash)>

Get Jira issue template.

Get a Jira issue template by ID.

Parameters:

  • issue_template_id (UUID) —

    The ID of the Jira issue template to retrieve

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

    the optional parameters

Returns:

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

    JiraIssueTemplateResponse data, response status code and response headers



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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 256

def get_jira_issue_template_with_http_info(issue_template_id, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.get_jira_issue_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_jira_issue_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_jira_issue_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.get_jira_issue_template ...'
  end
  # verify the required parameter 'issue_template_id' is set
  if @api_client.config.client_side_validation && issue_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_template_id' when calling JiraIntegrationAPI.get_jira_issue_template"
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/issue-templates/{issue_template_id}'.sub('{issue_template_id}', CGI.escape(issue_template_id.to_s).gsub('%2F', '/'))

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_jira_issue_template,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_jira_accounts(opts = {}) ⇒ Object

List Jira accounts.

See Also:



315
316
317
318
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 315

def list_jira_accounts(opts = {})
  data, _status_code, _headers = list_jira_accounts_with_http_info(opts)
  data
end

#list_jira_accounts_with_http_info(opts = {}) ⇒ Array<(JiraAccountsResponse, Integer, Hash)>

List Jira accounts.

Get all Jira accounts for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    JiraAccountsResponse data, response status code and response headers



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
375
376
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 326

def list_jira_accounts_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_jira_accounts".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_jira_accounts")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_jira_accounts"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.list_jira_accounts ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/accounts'

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_jira_accounts,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#list_jira_issue_templates(opts = {}) ⇒ Object

List Jira issue templates.

See Also:



381
382
383
384
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 381

def list_jira_issue_templates(opts = {})
  data, _status_code, _headers = list_jira_issue_templates_with_http_info(opts)
  data
end

#list_jira_issue_templates_with_http_info(opts = {}) ⇒ Array<(JiraIssueTemplatesResponse, Integer, Hash)>

List Jira issue templates.

Get all Jira issue templates for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    JiraIssueTemplatesResponse data, response status code and response headers



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
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 392

def list_jira_issue_templates_with_http_info(opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.list_jira_issue_templates".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_jira_issue_templates")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_jira_issue_templates"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.list_jira_issue_templates ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/issue-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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :list_jira_issue_templates,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#update_jira_issue_template(issue_template_id, body, opts = {}) ⇒ Object

Update Jira issue template.

See Also:



447
448
449
450
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 447

def update_jira_issue_template(issue_template_id, body, opts = {})
  data, _status_code, _headers = update_jira_issue_template_with_http_info(issue_template_id, body, opts)
  data
end

#update_jira_issue_template_with_http_info(issue_template_id, body, opts = {}) ⇒ Array<(JiraIssueTemplateResponse, Integer, Hash)>

Update Jira issue template.

Update a Jira issue template by ID.

Parameters:

  • issue_template_id (UUID) —

    The ID of the Jira issue template to update

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

    the optional parameters

Returns:

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

    JiraIssueTemplateResponse data, response status code and response headers



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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/datadog_api_client/v2/api/jira_integration_api.rb', line 460

def update_jira_issue_template_with_http_info(issue_template_id, body, opts = {})
  unstable_enabled = @api_client.config.unstable_operations["v2.update_jira_issue_template".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_jira_issue_template")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_jira_issue_template"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: JiraIntegrationAPI.update_jira_issue_template ...'
  end
  # verify the required parameter 'issue_template_id' is set
  if @api_client.config.client_side_validation && issue_template_id.nil?
    fail ArgumentError, "Missing the required parameter 'issue_template_id' when calling JiraIntegrationAPI.update_jira_issue_template"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling JiraIntegrationAPI.update_jira_issue_template"
  end
  # resource path
  local_var_path = '/api/v2/integration/jira/issue-templates/{issue_template_id}'.sub('{issue_template_id}', CGI.escape(issue_template_id.to_s).gsub('%2F', '/'))

  # 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[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :update_jira_issue_template,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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