Class: DatadogAPIClient::V2::OnCallAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of OnCallAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/on_call_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/on_call_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create On-Call escalation policy.

See Also:



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

def create_on_call_escalation_policy(body, opts = {})
  data, _status_code, _headers = create_on_call_escalation_policy_with_http_info(body, opts)
  data
end

#create_on_call_escalation_policy_with_http_info(body, opts = {}) ⇒ Array<(EscalationPolicy, Integer, Hash)>

Create On-Call escalation policy.

Create a new On-Call escalation policy

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `steps`, `steps.targets`.

Returns:

  • EscalationPolicy data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 42

def create_on_call_escalation_policy_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.create_on_call_escalation_policy ...'
  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 OnCallAPI.create_on_call_escalation_policy"
  end
  # resource path
  local_var_path = '/api/v2/on-call/escalation-policies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

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

Create On-Call schedule.

See Also:



98
99
100
101
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 98

def create_on_call_schedule(body, opts = {})
  data, _status_code, _headers = create_on_call_schedule_with_http_info(body, opts)
  data
end

#create_on_call_schedule_with_http_info(body, opts = {}) ⇒ Array<(Schedule, Integer, Hash)>

Create On-Call schedule.

Create a new On-Call schedule

Parameters:

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `layers`, `layers.members`, `layers.members.user`.

Returns:

  • Schedule data, response status code and response headers



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 111

def create_on_call_schedule_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.create_on_call_schedule ...'
  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 OnCallAPI.create_on_call_schedule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/schedules'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#create_user_notification_channel(user_id, body, opts = {}) ⇒ Object

Create an On-Call notification channel for a user.

See Also:



167
168
169
170
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 167

def create_user_notification_channel(user_id, body, opts = {})
  data, _status_code, _headers = create_user_notification_channel_with_http_info(user_id, body, opts)
  data
end

#create_user_notification_channel_with_http_info(user_id, body, opts = {}) ⇒ Array<(NotificationChannel, Integer, Hash)>

Create an On-Call notification channel for a user.

Create a new notification channel for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • (defaults to: {})

    the optional parameters

Returns:

  • NotificationChannel data, response status code and response headers



180
181
182
183
184
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
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 180

def create_user_notification_channel_with_http_info(user_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.create_user_notification_channel ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.create_user_notification_channel"
  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 OnCallAPI.create_user_notification_channel"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-channels'.sub('{user_id}', CGI.escape(user_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] || 'NotificationChannel'

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

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

#create_user_notification_rule(user_id, body, opts = {}) ⇒ Object

Create an On-Call notification rule for a user.

See Also:



239
240
241
242
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 239

def create_user_notification_rule(user_id, body, opts = {})
  data, _status_code, _headers = create_user_notification_rule_with_http_info(user_id, body, opts)
  data
end

#create_user_notification_rule_with_http_info(user_id, body, opts = {}) ⇒ Array<(OnCallNotificationRule, Integer, Hash)>

Create an On-Call notification rule for a user.

Create a new notification rule for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • (defaults to: {})

    the optional parameters

Returns:

  • OnCallNotificationRule data, response status code and response headers



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 252

def create_user_notification_rule_with_http_info(user_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.create_user_notification_rule ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.create_user_notification_rule"
  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 OnCallAPI.create_user_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-rules'.sub('{user_id}', CGI.escape(user_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] || 'OnCallNotificationRule'

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

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

#delete_on_call_escalation_policy(policy_id, opts = {}) ⇒ Object

Delete On-Call escalation policy.

See Also:



311
312
313
314
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 311

def delete_on_call_escalation_policy(policy_id, opts = {})
  delete_on_call_escalation_policy_with_http_info(policy_id, opts)
  nil
end

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

Delete On-Call escalation policy.

Delete an On-Call escalation policy

Parameters:

  • The ID of the escalation policy

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



323
324
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
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 323

def delete_on_call_escalation_policy_with_http_info(policy_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.delete_on_call_escalation_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling OnCallAPI.delete_on_call_escalation_policy"
  end
  # resource path
  local_var_path = '/api/v2/on-call/escalation-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_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, :AuthZ]

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

#delete_on_call_schedule(schedule_id, opts = {}) ⇒ Object

Delete On-Call schedule.

See Also:



376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 376

def delete_on_call_schedule(schedule_id, opts = {})
  delete_on_call_schedule_with_http_info(schedule_id, opts)
  nil
end

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

Delete On-Call schedule.

Delete an On-Call schedule

Parameters:

  • The ID of the schedule

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



388
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
432
433
434
435
436
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 388

def delete_on_call_schedule_with_http_info(schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.delete_on_call_schedule ...'
  end
  # verify the required parameter 'schedule_id' is set
  if @api_client.config.client_side_validation && schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'schedule_id' when calling OnCallAPI.delete_on_call_schedule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/schedules/{schedule_id}'.sub('{schedule_id}', CGI.escape(schedule_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, :AuthZ]

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

#delete_user_notification_channel(user_id, channel_id, opts = {}) ⇒ Object

Delete an On-Call notification channel for a user.

See Also:



441
442
443
444
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 441

def delete_user_notification_channel(user_id, channel_id, opts = {})
  delete_user_notification_channel_with_http_info(user_id, channel_id, opts)
  nil
end

#delete_user_notification_channel_with_http_info(user_id, channel_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an On-Call notification channel for a user.

Delete a notification channel for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • The channel ID

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 454

def delete_user_notification_channel_with_http_info(user_id, channel_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.delete_user_notification_channel ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.delete_user_notification_channel"
  end
  # verify the required parameter 'channel_id' is set
  if @api_client.config.client_side_validation && channel_id.nil?
    fail ArgumentError, "Missing the required parameter 'channel_id' when calling OnCallAPI.delete_user_notification_channel"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-channels/{channel_id}'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/')).sub('{channel_id}', CGI.escape(channel_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, :AuthZ]

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

#delete_user_notification_rule(user_id, rule_id, opts = {}) ⇒ Object

Delete an On-Call notification rule for a user.

See Also:



511
512
513
514
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 511

def delete_user_notification_rule(user_id, rule_id, opts = {})
  delete_user_notification_rule_with_http_info(user_id, rule_id, opts)
  nil
end

#delete_user_notification_rule_with_http_info(user_id, rule_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete an On-Call notification rule for a user.

Delete a notification rule for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • The rule ID

  • (defaults to: {})

    the optional parameters

Returns:

  • nil, response status code and response headers



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
571
572
573
574
575
576
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 524

def delete_user_notification_rule_with_http_info(user_id, rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.delete_user_notification_rule ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.delete_user_notification_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling OnCallAPI.delete_user_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-rules/{rule_id}'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/')).sub('{rule_id}', CGI.escape(rule_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, :AuthZ]

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

#get_on_call_escalation_policy(policy_id, opts = {}) ⇒ Object

Get On-Call escalation policy.

See Also:



581
582
583
584
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 581

def get_on_call_escalation_policy(policy_id, opts = {})
  data, _status_code, _headers = get_on_call_escalation_policy_with_http_info(policy_id, opts)
  data
end

#get_on_call_escalation_policy_with_http_info(policy_id, opts = {}) ⇒ Array<(EscalationPolicy, Integer, Hash)>

Get On-Call escalation policy.

Get an On-Call escalation policy

Parameters:

  • The ID of the escalation policy

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `steps`, `steps.targets`.

Returns:

  • EscalationPolicy data, response status code and response headers



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
638
639
640
641
642
643
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 594

def get_on_call_escalation_policy_with_http_info(policy_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_on_call_escalation_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling OnCallAPI.get_on_call_escalation_policy"
  end
  # resource path
  local_var_path = '/api/v2/on-call/escalation-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#get_on_call_schedule(schedule_id, opts = {}) ⇒ Object

Get On-Call schedule.

See Also:



648
649
650
651
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 648

def get_on_call_schedule(schedule_id, opts = {})
  data, _status_code, _headers = get_on_call_schedule_with_http_info(schedule_id, opts)
  data
end

#get_on_call_schedule_with_http_info(schedule_id, opts = {}) ⇒ Array<(Schedule, Integer, Hash)>

Get On-Call schedule.

Get an On-Call schedule

Parameters:

  • The ID of the schedule

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `layers`, `layers.members`, `layers.members.user`.

Returns:

  • Schedule data, response status code and response headers



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
700
701
702
703
704
705
706
707
708
709
710
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 661

def get_on_call_schedule_with_http_info(schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_on_call_schedule ...'
  end
  # verify the required parameter 'schedule_id' is set
  if @api_client.config.client_side_validation && schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'schedule_id' when calling OnCallAPI.get_on_call_schedule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/schedules/{schedule_id}'.sub('{schedule_id}', CGI.escape(schedule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#get_on_call_team_routing_rules(team_id, opts = {}) ⇒ Object

Get On-Call team routing rules.

See Also:



715
716
717
718
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 715

def get_on_call_team_routing_rules(team_id, opts = {})
  data, _status_code, _headers = get_on_call_team_routing_rules_with_http_info(team_id, opts)
  data
end

#get_on_call_team_routing_rules_with_http_info(team_id, opts = {}) ⇒ Array<(TeamRoutingRules, Integer, Hash)>

Get On-Call team routing rules.

Get a team’s On-Call routing rules

Parameters:

  • The team ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘rules`, `rules.policy`.

Returns:

  • TeamRoutingRules data, response status code and response headers



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
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 728

def get_on_call_team_routing_rules_with_http_info(team_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_on_call_team_routing_rules ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling OnCallAPI.get_on_call_team_routing_rules"
  end
  # resource path
  local_var_path = '/api/v2/on-call/teams/{team_id}/routing-rules'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#get_schedule_on_call_user(schedule_id, opts = {}) ⇒ Object

Get scheduled on-call user.

See Also:



782
783
784
785
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 782

def get_schedule_on_call_user(schedule_id, opts = {})
  data, _status_code, _headers = get_schedule_on_call_user_with_http_info(schedule_id, opts)
  data
end

#get_schedule_on_call_user_with_http_info(schedule_id, opts = {}) ⇒ Array<(Shift, Integer, Hash)>

Get scheduled on-call user.

Retrieves the user who is on-call for the specified schedule at a given time.

Parameters:

  • The ID of the schedule.

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Specifies related resources to include in the response as a comma-separated list. Allowed value: ‘user`.

  • :filter_at_ts (String) —

    Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted.“

Returns:

  • Shift data, response status code and response headers



796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 796

def get_schedule_on_call_user_with_http_info(schedule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_schedule_on_call_user ...'
  end
  # verify the required parameter 'schedule_id' is set
  if @api_client.config.client_side_validation && schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'schedule_id' when calling OnCallAPI.get_schedule_on_call_user"
  end
  # resource path
  local_var_path = '/api/v2/on-call/schedules/{schedule_id}/on-call'.sub('{schedule_id}', CGI.escape(schedule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'filter[at_ts]'] = opts[:'filter_at_ts'] if !opts[:'filter_at_ts'].nil?

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

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

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

#get_team_on_call_users(team_id, opts = {}) ⇒ Object

Get team on-call users.

See Also:



851
852
853
854
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 851

def get_team_on_call_users(team_id, opts = {})
  data, _status_code, _headers = get_team_on_call_users_with_http_info(team_id, opts)
  data
end

#get_team_on_call_users_with_http_info(team_id, opts = {}) ⇒ Array<(TeamOnCallResponders, Integer, Hash)>

Get team on-call users.

Get a team’s on-call users at a given time

Parameters:

  • The team ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘responders`, `escalations`, `escalations.responders`.

Returns:

  • TeamOnCallResponders data, response status code and response headers



864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 864

def get_team_on_call_users_with_http_info(team_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_team_on_call_users ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling OnCallAPI.get_team_on_call_users"
  end
  # resource path
  local_var_path = '/api/v2/on-call/teams/{team_id}/on-call'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#get_user_notification_channel(user_id, channel_id, opts = {}) ⇒ Object

Get an On-Call notification channel for a user.

See Also:



918
919
920
921
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 918

def get_user_notification_channel(user_id, channel_id, opts = {})
  data, _status_code, _headers = get_user_notification_channel_with_http_info(user_id, channel_id, opts)
  data
end

#get_user_notification_channel_with_http_info(user_id, channel_id, opts = {}) ⇒ Array<(NotificationChannel, Integer, Hash)>

Get an On-Call notification channel for a user.

Get a notification channel for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • The channel ID

  • (defaults to: {})

    the optional parameters

Returns:

  • NotificationChannel data, response status code and response headers



931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 931

def get_user_notification_channel_with_http_info(user_id, channel_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_user_notification_channel ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.get_user_notification_channel"
  end
  # verify the required parameter 'channel_id' is set
  if @api_client.config.client_side_validation && channel_id.nil?
    fail ArgumentError, "Missing the required parameter 'channel_id' when calling OnCallAPI.get_user_notification_channel"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-channels/{channel_id}'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/')).sub('{channel_id}', CGI.escape(channel_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] || 'NotificationChannel'

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

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

#get_user_notification_rule(user_id, rule_id, opts = {}) ⇒ Object

Get an On-Call notification rule for a user.

See Also:



988
989
990
991
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 988

def get_user_notification_rule(user_id, rule_id, opts = {})
  data, _status_code, _headers = get_user_notification_rule_with_http_info(user_id, rule_id, opts)
  data
end

#get_user_notification_rule_with_http_info(user_id, rule_id, opts = {}) ⇒ Array<(OnCallNotificationRule, Integer, Hash)>

Get an On-Call notification rule for a user.

Get a notification rule for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • The rule ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘channel`.

Returns:

  • OnCallNotificationRule data, response status code and response headers



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1002

def get_user_notification_rule_with_http_info(user_id, rule_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.get_user_notification_rule ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.get_user_notification_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling OnCallAPI.get_user_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-rules/{rule_id}'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/')).sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#list_user_notification_channels(user_id, opts = {}) ⇒ Object

List On-Call notification channels for a user.

See Also:



1060
1061
1062
1063
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1060

def list_user_notification_channels(user_id, opts = {})
  data, _status_code, _headers = list_user_notification_channels_with_http_info(user_id, opts)
  data
end

#list_user_notification_channels_with_http_info(user_id, opts = {}) ⇒ Array<(ListNotificationChannelsResponse, Integer, Hash)>

List On-Call notification channels for a user.

List the notification channels for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • (defaults to: {})

    the optional parameters

Returns:

  • ListNotificationChannelsResponse data, response status code and response headers



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1072

def list_user_notification_channels_with_http_info(user_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.list_user_notification_channels ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.list_user_notification_channels"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-channels'.sub('{user_id}', CGI.escape(user_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] || 'ListNotificationChannelsResponse'

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

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

#list_user_notification_rules(user_id, opts = {}) ⇒ Object

List On-Call notification rules for a user.

See Also:



1125
1126
1127
1128
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1125

def list_user_notification_rules(user_id, opts = {})
  data, _status_code, _headers = list_user_notification_rules_with_http_info(user_id, opts)
  data
end

#list_user_notification_rules_with_http_info(user_id, opts = {}) ⇒ Array<(ListOnCallNotificationRulesResponse, Integer, Hash)>

List On-Call notification rules for a user.

List the notification rules for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘channel`.

Returns:

  • ListOnCallNotificationRulesResponse data, response status code and response headers



1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1138

def list_user_notification_rules_with_http_info(user_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.list_user_notification_rules ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.list_user_notification_rules"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-rules'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#set_on_call_team_routing_rules(team_id, body, opts = {}) ⇒ Object

Set On-Call team routing rules.

See Also:



1192
1193
1194
1195
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1192

def set_on_call_team_routing_rules(team_id, body, opts = {})
  data, _status_code, _headers = set_on_call_team_routing_rules_with_http_info(team_id, body, opts)
  data
end

#set_on_call_team_routing_rules_with_http_info(team_id, body, opts = {}) ⇒ Array<(TeamRoutingRules, Integer, Hash)>

Set On-Call team routing rules.

Set a team’s On-Call routing rules

Parameters:

  • The team ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘rules`, `rules.policy`.

Returns:

  • TeamRoutingRules data, response status code and response headers



1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1206

def set_on_call_team_routing_rules_with_http_info(team_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.set_on_call_team_routing_rules ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling OnCallAPI.set_on_call_team_routing_rules"
  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 OnCallAPI.set_on_call_team_routing_rules"
  end
  # resource path
  local_var_path = '/api/v2/on-call/teams/{team_id}/routing-rules'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#update_on_call_escalation_policy(policy_id, body, opts = {}) ⇒ Object

Update On-Call escalation policy.

See Also:



1266
1267
1268
1269
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1266

def update_on_call_escalation_policy(policy_id, body, opts = {})
  data, _status_code, _headers = update_on_call_escalation_policy_with_http_info(policy_id, body, opts)
  data
end

#update_on_call_escalation_policy_with_http_info(policy_id, body, opts = {}) ⇒ Array<(EscalationPolicy, Integer, Hash)>

Update On-Call escalation policy.

Update an On-Call escalation policy

Parameters:

  • The ID of the escalation policy

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `steps`, `steps.targets`.

Returns:

  • EscalationPolicy data, response status code and response headers



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1280

def update_on_call_escalation_policy_with_http_info(policy_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.update_on_call_escalation_policy ...'
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling OnCallAPI.update_on_call_escalation_policy"
  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 OnCallAPI.update_on_call_escalation_policy"
  end
  # resource path
  local_var_path = '/api/v2/on-call/escalation-policies/{policy_id}'.sub('{policy_id}', CGI.escape(policy_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#update_on_call_schedule(schedule_id, body, opts = {}) ⇒ Object

Update On-Call schedule.

See Also:



1340
1341
1342
1343
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1340

def update_on_call_schedule(schedule_id, body, opts = {})
  data, _status_code, _headers = update_on_call_schedule_with_http_info(schedule_id, body, opts)
  data
end

#update_on_call_schedule_with_http_info(schedule_id, body, opts = {}) ⇒ Array<(Schedule, Integer, Hash)>

Update On-Call schedule.

Update a new On-Call schedule

Parameters:

  • The ID of the schedule

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘teams`, `layers`, `layers.members`, `layers.members.user`.

Returns:

  • Schedule data, response status code and response headers



1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1354

def update_on_call_schedule_with_http_info(schedule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.update_on_call_schedule ...'
  end
  # verify the required parameter 'schedule_id' is set
  if @api_client.config.client_side_validation && schedule_id.nil?
    fail ArgumentError, "Missing the required parameter 'schedule_id' when calling OnCallAPI.update_on_call_schedule"
  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 OnCallAPI.update_on_call_schedule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/schedules/{schedule_id}'.sub('{schedule_id}', CGI.escape(schedule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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

#update_user_notification_rule(user_id, rule_id, body, opts = {}) ⇒ Object

Update an On-Call notification rule for a user.

See Also:



1414
1415
1416
1417
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1414

def update_user_notification_rule(user_id, rule_id, body, opts = {})
  data, _status_code, _headers = update_user_notification_rule_with_http_info(user_id, rule_id, body, opts)
  data
end

#update_user_notification_rule_with_http_info(user_id, rule_id, body, opts = {}) ⇒ Array<(OnCallNotificationRule, Integer, Hash)>

Update an On-Call notification rule for a user.

Update a notification rule for a user. The authenticated user must be the target user or have the ‘on_call_admin` permission

Parameters:

  • The user ID

  • The rule ID

  • (defaults to: {})

    the optional parameters

Options Hash (opts):

  • :include (String) —

    Comma-separated list of included relationships to be returned. Allowed values: ‘channel`.

Returns:

  • OnCallNotificationRule data, response status code and response headers



1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/datadog_api_client/v2/api/on_call_api.rb', line 1429

def update_user_notification_rule_with_http_info(user_id, rule_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OnCallAPI.update_user_notification_rule ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling OnCallAPI.update_user_notification_rule"
  end
  # verify the required parameter 'rule_id' is set
  if @api_client.config.client_side_validation && rule_id.nil?
    fail ArgumentError, "Missing the required parameter 'rule_id' when calling OnCallAPI.update_user_notification_rule"
  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 OnCallAPI.update_user_notification_rule"
  end
  # resource path
  local_var_path = '/api/v2/on-call/users/{user_id}/notification-rules/{rule_id}'.sub('{user_id}', CGI.escape(user_id.to_s).gsub('%2F', '/')).sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?

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

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

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