Class: PureCloud::AlertingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/alerting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AlertingApi

Returns a new instance of AlertingApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_alerting_heartbeat_alert(alert_id, opts = {}) ⇒ nil

Delete a heart beat alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 32

def delete_alerting_heartbeat_alert(alert_id, opts = {})
  delete_alerting_heartbeat_alert_with_http_info(alert_id, opts)
  return nil
end

#delete_alerting_heartbeat_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a heart beat alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 42

def delete_alerting_heartbeat_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_heartbeat_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.delete_alerting_heartbeat_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_heartbeat_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_heartbeat_rule(rule_id, opts = {}) ⇒ nil

Delete a heart beat rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 88

def delete_alerting_heartbeat_rule(rule_id, opts = {})
  delete_alerting_heartbeat_rule_with_http_info(rule_id, opts)
  return nil
end

#delete_alerting_heartbeat_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a heart beat rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 98

def delete_alerting_heartbeat_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_heartbeat_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.delete_alerting_heartbeat_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_heartbeat_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_interactionstats_alert(alert_id, opts = {}) ⇒ nil

Delete an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


144
145
146
147
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 144

def delete_alerting_interactionstats_alert(alert_id, opts = {})
  delete_alerting_interactionstats_alert_with_http_info(alert_id, opts)
  return nil
end

#delete_alerting_interactionstats_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



154
155
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 154

def delete_alerting_interactionstats_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_interactionstats_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.delete_alerting_interactionstats_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_interactionstats_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_interactionstats_rule(rule_id, opts = {}) ⇒ nil

Delete an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


200
201
202
203
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 200

def delete_alerting_interactionstats_rule(rule_id, opts = {})
  delete_alerting_interactionstats_rule_with_http_info(rule_id, opts)
  return nil
end

#delete_alerting_interactionstats_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 210

def delete_alerting_interactionstats_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_interactionstats_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.delete_alerting_interactionstats_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_interactionstats_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_routingstatus_alert(alert_id, opts = {}) ⇒ nil

Delete a routing status alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


256
257
258
259
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 256

def delete_alerting_routingstatus_alert(alert_id, opts = {})
  delete_alerting_routingstatus_alert_with_http_info(alert_id, opts)
  return nil
end

#delete_alerting_routingstatus_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a routing status alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 266

def delete_alerting_routingstatus_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_routingstatus_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.delete_alerting_routingstatus_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_routingstatus_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_routingstatus_rule(rule_id, opts = {}) ⇒ nil

Delete a routing status rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


312
313
314
315
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 312

def delete_alerting_routingstatus_rule(rule_id, opts = {})
  delete_alerting_routingstatus_rule_with_http_info(rule_id, opts)
  return nil
end

#delete_alerting_routingstatus_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a routing status rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



322
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 322

def delete_alerting_routingstatus_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_routingstatus_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.delete_alerting_routingstatus_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_routingstatus_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_userpresence_alert(alert_id, opts = {}) ⇒ nil

Delete a user presence alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


368
369
370
371
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 368

def delete_alerting_userpresence_alert(alert_id, opts = {})
  delete_alerting_userpresence_alert_with_http_info(alert_id, opts)
  return nil
end

#delete_alerting_userpresence_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a user presence alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



378
379
380
381
382
383
384
385
386
387
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 378

def delete_alerting_userpresence_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_userpresence_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.delete_alerting_userpresence_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_userpresence_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_alerting_userpresence_rule(rule_id, opts = {}) ⇒ nil

Delete a user presence rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


424
425
426
427
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 424

def delete_alerting_userpresence_rule(rule_id, opts = {})
  delete_alerting_userpresence_rule_with_http_info(rule_id, opts)
  return nil
end

#delete_alerting_userpresence_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a user presence rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 434

def delete_alerting_userpresence_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.delete_alerting_userpresence_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.delete_alerting_userpresence_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#delete_alerting_userpresence_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_heartbeat_alert(alert_id, opts = {}) ⇒ HeartBeatAlert

Get a heart beat alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



481
482
483
484
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 481

def get_alerting_heartbeat_alert(alert_id, opts = {})
  data, _status_code, _headers = get_alerting_heartbeat_alert_with_http_info(alert_id, opts)
  return data
end

#get_alerting_heartbeat_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(HeartBeatAlert, Fixnum, Hash)>

Get a heart beat alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatAlert, Fixnum, Hash)>) —

    HeartBeatAlert data, response status code and response headers



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
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 492

def get_alerting_heartbeat_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_heartbeat_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.get_alerting_heartbeat_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatAlert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_heartbeat_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_heartbeat_alerts(opts = {}) ⇒ HeartBeatAlertContainer

Get heart beat alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



540
541
542
543
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 540

def get_alerting_heartbeat_alerts(opts = {})
  data, _status_code, _headers = get_alerting_heartbeat_alerts_with_http_info(opts)
  return data
end

#get_alerting_heartbeat_alerts_with_http_info(opts = {}) ⇒ Array<(HeartBeatAlertContainer, Fixnum, Hash)>

Get heart beat alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatAlertContainer, Fixnum, Hash)>) —

    HeartBeatAlertContainer data, response status code and response headers



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
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 550

def get_alerting_heartbeat_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_heartbeat_alerts ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/alerts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatAlertContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_heartbeat_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_heartbeat_rule(rule_id, opts = {}) ⇒ HeartBeatRule

Get a heart beat rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



597
598
599
600
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 597

def get_alerting_heartbeat_rule(rule_id, opts = {})
  data, _status_code, _headers = get_alerting_heartbeat_rule_with_http_info(rule_id, opts)
  return data
end

#get_alerting_heartbeat_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(HeartBeatRule, Fixnum, Hash)>

Get a heart beat rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatRule, Fixnum, Hash)>) —

    HeartBeatRule data, response status code and response headers



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
644
645
646
647
648
649
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 608

def get_alerting_heartbeat_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_heartbeat_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.get_alerting_heartbeat_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_heartbeat_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_heartbeat_rules(opts = {}) ⇒ HeartBeatRuleContainer

Get a heart beat rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



656
657
658
659
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 656

def get_alerting_heartbeat_rules(opts = {})
  data, _status_code, _headers = get_alerting_heartbeat_rules_with_http_info(opts)
  return data
end

#get_alerting_heartbeat_rules_with_http_info(opts = {}) ⇒ Array<(HeartBeatRuleContainer, Fixnum, Hash)>

Get a heart beat rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatRuleContainer, Fixnum, Hash)>) —

    HeartBeatRuleContainer data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 666

def get_alerting_heartbeat_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_heartbeat_rules ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatRuleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_heartbeat_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_interactionstats_alert(alert_id, opts = {}) ⇒ InteractionStatsAlert

Get an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



713
714
715
716
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 713

def get_alerting_interactionstats_alert(alert_id, opts = {})
  data, _status_code, _headers = get_alerting_interactionstats_alert_with_http_info(alert_id, opts)
  return data
end

#get_alerting_interactionstats_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(InteractionStatsAlert, Fixnum, Hash)>

Get an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(InteractionStatsAlert, Fixnum, Hash)>) —

    InteractionStatsAlert data, response status code and response headers



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
757
758
759
760
761
762
763
764
765
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 724

def get_alerting_interactionstats_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_interactionstats_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.get_alerting_interactionstats_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsAlert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_interactionstats_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_interactionstats_alerts(opts = {}) ⇒ InteractionStatsAlertContainer

Get interaction stats alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



772
773
774
775
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 772

def get_alerting_interactionstats_alerts(opts = {})
  data, _status_code, _headers = get_alerting_interactionstats_alerts_with_http_info(opts)
  return data
end

#get_alerting_interactionstats_alerts_unread(opts = {}) ⇒ UnreadMetric

Gets user unread count of interaction stats alerts.

Parameters:

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

    the optional parameters

Returns:



827
828
829
830
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 827

def get_alerting_interactionstats_alerts_unread(opts = {})
  data, _status_code, _headers = get_alerting_interactionstats_alerts_unread_with_http_info(opts)
  return data
end

#get_alerting_interactionstats_alerts_unread_with_http_info(opts = {}) ⇒ Array<(UnreadMetric, Fixnum, Hash)>

Gets user unread count of interaction stats alerts.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(UnreadMetric, Fixnum, Hash)>) —

    UnreadMetric data, response status code and response headers



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 836

def get_alerting_interactionstats_alerts_unread_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_interactionstats_alerts_unread ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/alerts/unread".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnreadMetric')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_interactionstats_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_interactionstats_alerts_with_http_info(opts = {}) ⇒ Array<(InteractionStatsAlertContainer, Fixnum, Hash)>

Get interaction stats alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



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
819
820
821
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 782

def get_alerting_interactionstats_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_interactionstats_alerts ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/alerts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsAlertContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_interactionstats_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_interactionstats_rule(rule_id, opts = {}) ⇒ InteractionStatsRule

Get an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



882
883
884
885
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 882

def get_alerting_interactionstats_rule(rule_id, opts = {})
  data, _status_code, _headers = get_alerting_interactionstats_rule_with_http_info(rule_id, opts)
  return data
end

#get_alerting_interactionstats_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(InteractionStatsRule, Fixnum, Hash)>

Get an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(InteractionStatsRule, Fixnum, Hash)>) —

    InteractionStatsRule data, response status code and response headers



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 893

def get_alerting_interactionstats_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_interactionstats_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.get_alerting_interactionstats_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_interactionstats_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_interactionstats_rules(opts = {}) ⇒ InteractionStatsRuleContainer

Get an interaction stats rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



941
942
943
944
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 941

def get_alerting_interactionstats_rules(opts = {})
  data, _status_code, _headers = get_alerting_interactionstats_rules_with_http_info(opts)
  return data
end

#get_alerting_interactionstats_rules_with_http_info(opts = {}) ⇒ Array<(InteractionStatsRuleContainer, Fixnum, Hash)>

Get an interaction stats rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



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
984
985
986
987
988
989
990
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 951

def get_alerting_interactionstats_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_interactionstats_rules ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsRuleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_routingstatus_alert(alert_id, opts = {}) ⇒ RoutingStatusAlert

Get a routing status alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



998
999
1000
1001
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 998

def get_alerting_routingstatus_alert(alert_id, opts = {})
  data, _status_code, _headers = get_alerting_routingstatus_alert_with_http_info(alert_id, opts)
  return data
end

#get_alerting_routingstatus_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(RoutingStatusAlert, Fixnum, Hash)>

Get a routing status alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(RoutingStatusAlert, Fixnum, Hash)>) —

    RoutingStatusAlert data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1009

def get_alerting_routingstatus_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_routingstatus_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.get_alerting_routingstatus_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusAlert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_routingstatus_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_routingstatus_alerts(opts = {}) ⇒ RoutingStatusAlertContainer

Get routing status alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1057
1058
1059
1060
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1057

def get_alerting_routingstatus_alerts(opts = {})
  data, _status_code, _headers = get_alerting_routingstatus_alerts_with_http_info(opts)
  return data
end

#get_alerting_routingstatus_alerts_with_http_info(opts = {}) ⇒ Array<(RoutingStatusAlertContainer, Fixnum, Hash)>

Get routing status alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1067
1068
1069
1070
1071
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1067

def get_alerting_routingstatus_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_routingstatus_alerts ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/alerts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusAlertContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_routingstatus_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_routingstatus_rule(rule_id, opts = {}) ⇒ RoutingStatusRule

Get a routing status rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1114
1115
1116
1117
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1114

def get_alerting_routingstatus_rule(rule_id, opts = {})
  data, _status_code, _headers = get_alerting_routingstatus_rule_with_http_info(rule_id, opts)
  return data
end

#get_alerting_routingstatus_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(RoutingStatusRule, Fixnum, Hash)>

Get a routing status rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(RoutingStatusRule, Fixnum, Hash)>) —

    RoutingStatusRule data, response status code and response headers



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1125

def get_alerting_routingstatus_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_routingstatus_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.get_alerting_routingstatus_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_routingstatus_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_routingstatus_rules(opts = {}) ⇒ RoutingStatusRuleContainer

Get a routing status rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1173
1174
1175
1176
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1173

def get_alerting_routingstatus_rules(opts = {})
  data, _status_code, _headers = get_alerting_routingstatus_rules_with_http_info(opts)
  return data
end

#get_alerting_routingstatus_rules_with_http_info(opts = {}) ⇒ Array<(RoutingStatusRuleContainer, Fixnum, Hash)>

Get a routing status rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(RoutingStatusRuleContainer, Fixnum, Hash)>) —

    RoutingStatusRuleContainer data, response status code and response headers



1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1183

def get_alerting_routingstatus_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_routingstatus_rules ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusRuleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_routingstatus_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_userpresence_alert(alert_id, opts = {}) ⇒ UserPresenceAlert

Get a user presence alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1230
1231
1232
1233
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1230

def get_alerting_userpresence_alert(alert_id, opts = {})
  data, _status_code, _headers = get_alerting_userpresence_alert_with_http_info(alert_id, opts)
  return data
end

#get_alerting_userpresence_alert_with_http_info(alert_id, opts = {}) ⇒ Array<(UserPresenceAlert, Fixnum, Hash)>

Get a user presence alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceAlert, Fixnum, Hash)>) —

    UserPresenceAlert data, response status code and response headers



1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1241

def get_alerting_userpresence_alert_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_userpresence_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.get_alerting_userpresence_alert" if alert_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceAlert')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_userpresence_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_userpresence_alerts(opts = {}) ⇒ UserPresenceAlertContainer

Get user presence alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1289
1290
1291
1292
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1289

def get_alerting_userpresence_alerts(opts = {})
  data, _status_code, _headers = get_alerting_userpresence_alerts_with_http_info(opts)
  return data
end

#get_alerting_userpresence_alerts_with_http_info(opts = {}) ⇒ Array<(UserPresenceAlertContainer, Fixnum, Hash)>

Get user presence alert list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceAlertContainer, Fixnum, Hash)>) —

    UserPresenceAlertContainer data, response status code and response headers



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
1336
1337
1338
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1299

def get_alerting_userpresence_alerts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_userpresence_alerts ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/alerts".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceAlertContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_userpresence_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_userpresence_rule(rule_id, opts = {}) ⇒ UserPresenceRule

Get a user presence rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1346
1347
1348
1349
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1346

def get_alerting_userpresence_rule(rule_id, opts = {})
  data, _status_code, _headers = get_alerting_userpresence_rule_with_http_info(rule_id, opts)
  return data
end

#get_alerting_userpresence_rule_with_http_info(rule_id, opts = {}) ⇒ Array<(UserPresenceRule, Fixnum, Hash)>

Get a user presence rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceRule, Fixnum, Hash)>) —

    UserPresenceRule data, response status code and response headers



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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1357

def get_alerting_userpresence_rule_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_userpresence_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.get_alerting_userpresence_rule" if rule_id.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_userpresence_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_alerting_userpresence_rules(opts = {}) ⇒ UserPresenceRuleContainer

Get a user presence rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1405
1406
1407
1408
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1405

def get_alerting_userpresence_rules(opts = {})
  data, _status_code, _headers = get_alerting_userpresence_rules_with_http_info(opts)
  return data
end

#get_alerting_userpresence_rules_with_http_info(opts = {}) ⇒ Array<(UserPresenceRuleContainer, Fixnum, Hash)>

Get a user presence rule list.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceRuleContainer, Fixnum, Hash)>) —

    UserPresenceRuleContainer data, response status code and response headers



1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
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
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1415

def get_alerting_userpresence_rules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.get_alerting_userpresence_rules ..."
  end
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
        auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceRuleContainer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#get_alerting_userpresence_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_alerting_heartbeat_rules(body, opts = {}) ⇒ HeartBeatRule

Create a heart beat rule.

Parameters:

  • body —

    HeartBeatRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1462
1463
1464
1465
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1462

def post_alerting_heartbeat_rules(body, opts = {})
  data, _status_code, _headers = post_alerting_heartbeat_rules_with_http_info(body, opts)
  return data
end

#post_alerting_heartbeat_rules_with_http_info(body, opts = {}) ⇒ Array<(HeartBeatRule, Fixnum, Hash)>

Create a heart beat rule.

Parameters:

  • body —

    HeartBeatRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatRule, Fixnum, Hash)>) —

    HeartBeatRule data, response status code and response headers



1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1473

def post_alerting_heartbeat_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.post_alerting_heartbeat_rules ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.post_alerting_heartbeat_rules" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#post_alerting_heartbeat_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_alerting_interactionstats_rules(body, opts = {}) ⇒ InteractionStatsRule

Create an interaction stats rule.

Parameters:

  • body —

    AlertingRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1522
1523
1524
1525
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1522

def post_alerting_interactionstats_rules(body, opts = {})
  data, _status_code, _headers = post_alerting_interactionstats_rules_with_http_info(body, opts)
  return data
end

#post_alerting_interactionstats_rules_with_http_info(body, opts = {}) ⇒ Array<(InteractionStatsRule, Fixnum, Hash)>

Create an interaction stats rule.

Parameters:

  • body —

    AlertingRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(InteractionStatsRule, Fixnum, Hash)>) —

    InteractionStatsRule data, response status code and response headers



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1533

def post_alerting_interactionstats_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.post_alerting_interactionstats_rules ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.post_alerting_interactionstats_rules" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#post_alerting_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_alerting_routingstatus_rules(body, opts = {}) ⇒ RoutingStatusRule

Create a routing status rule.

Parameters:

  • body —

    RoutingStatusRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1582
1583
1584
1585
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1582

def post_alerting_routingstatus_rules(body, opts = {})
  data, _status_code, _headers = post_alerting_routingstatus_rules_with_http_info(body, opts)
  return data
end

#post_alerting_routingstatus_rules_with_http_info(body, opts = {}) ⇒ Array<(RoutingStatusRule, Fixnum, Hash)>

Create a routing status rule.

Parameters:

  • body —

    RoutingStatusRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(RoutingStatusRule, Fixnum, Hash)>) —

    RoutingStatusRule data, response status code and response headers



1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1593

def post_alerting_routingstatus_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.post_alerting_routingstatus_rules ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.post_alerting_routingstatus_rules" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#post_alerting_routingstatus_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_alerting_userpresence_rules(body, opts = {}) ⇒ UserPresenceRule

Create a user presence rule.

Parameters:

  • body —

    UserPresenceRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1642
1643
1644
1645
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1642

def post_alerting_userpresence_rules(body, opts = {})
  data, _status_code, _headers = post_alerting_userpresence_rules_with_http_info(body, opts)
  return data
end

#post_alerting_userpresence_rules_with_http_info(body, opts = {}) ⇒ Array<(UserPresenceRule, Fixnum, Hash)>

Create a user presence rule.

Parameters:

  • body —

    UserPresenceRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceRule, Fixnum, Hash)>) —

    UserPresenceRule data, response status code and response headers



1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1653

def post_alerting_userpresence_rules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.post_alerting_userpresence_rules ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.post_alerting_userpresence_rules" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/rules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#post_alerting_userpresence_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_alerting_heartbeat_rule(rule_id, body, opts = {}) ⇒ HeartBeatRule

Update a heart beat rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    HeartBeatRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1703
1704
1705
1706
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1703

def put_alerting_heartbeat_rule(rule_id, body, opts = {})
  data, _status_code, _headers = put_alerting_heartbeat_rule_with_http_info(rule_id, body, opts)
  return data
end

#put_alerting_heartbeat_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(HeartBeatRule, Fixnum, Hash)>

Update a heart beat rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    HeartBeatRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(HeartBeatRule, Fixnum, Hash)>) —

    HeartBeatRule data, response status code and response headers



1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1715

def put_alerting_heartbeat_rule_with_http_info(rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.put_alerting_heartbeat_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.put_alerting_heartbeat_rule" if rule_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.put_alerting_heartbeat_rule" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'HeartBeatRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#put_alerting_heartbeat_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_alerting_interactionstats_alert(alert_id, body, opts = {}) ⇒ UnreadStatus

Update an interaction stats alert read status

Parameters:

  • alert_id —

    Alert ID

  • body —

    InteractionStatsAlert

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1767
1768
1769
1770
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1767

def put_alerting_interactionstats_alert(alert_id, body, opts = {})
  data, _status_code, _headers = put_alerting_interactionstats_alert_with_http_info(alert_id, body, opts)
  return data
end

#put_alerting_interactionstats_alert_with_http_info(alert_id, body, opts = {}) ⇒ Array<(UnreadStatus, Fixnum, Hash)>

Update an interaction stats alert read status

Parameters:

  • alert_id —

    Alert ID

  • body —

    InteractionStatsAlert

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UnreadStatus, Fixnum, Hash)>) —

    UnreadStatus data, response status code and response headers



1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1779

def put_alerting_interactionstats_alert_with_http_info(alert_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.put_alerting_interactionstats_alert ..."
  end
  # verify the required parameter 'alert_id' is set
  fail ArgumentError, "Missing the required parameter 'alert_id' when calling AlertingApi.put_alerting_interactionstats_alert" if alert_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.put_alerting_interactionstats_alert" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UnreadStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#put_alerting_interactionstats_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_alerting_interactionstats_rule(rule_id, body, opts = {}) ⇒ InteractionStatsRule

Update an interaction stats rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    AlertingRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1831
1832
1833
1834
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1831

def put_alerting_interactionstats_rule(rule_id, body, opts = {})
  data, _status_code, _headers = put_alerting_interactionstats_rule_with_http_info(rule_id, body, opts)
  return data
end

#put_alerting_interactionstats_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(InteractionStatsRule, Fixnum, Hash)>

Update an interaction stats rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    AlertingRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(InteractionStatsRule, Fixnum, Hash)>) —

    InteractionStatsRule data, response status code and response headers



1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1843

def put_alerting_interactionstats_rule_with_http_info(rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.put_alerting_interactionstats_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.put_alerting_interactionstats_rule" if rule_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.put_alerting_interactionstats_rule" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InteractionStatsRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#put_alerting_interactionstats_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_alerting_routingstatus_rule(rule_id, body, opts = {}) ⇒ RoutingStatusRule

Update a routing status rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    RoutingStatusRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1895
1896
1897
1898
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1895

def put_alerting_routingstatus_rule(rule_id, body, opts = {})
  data, _status_code, _headers = put_alerting_routingstatus_rule_with_http_info(rule_id, body, opts)
  return data
end

#put_alerting_routingstatus_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(RoutingStatusRule, Fixnum, Hash)>

Update a routing status rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    RoutingStatusRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(RoutingStatusRule, Fixnum, Hash)>) —

    RoutingStatusRule data, response status code and response headers



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1907

def put_alerting_routingstatus_rule_with_http_info(rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.put_alerting_routingstatus_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.put_alerting_routingstatus_rule" if rule_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.put_alerting_routingstatus_rule" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingStatusRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#put_alerting_routingstatus_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_alerting_userpresence_rule(rule_id, body, opts = {}) ⇒ UserPresenceRule

Update a user presence rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    UserPresenceRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1959
1960
1961
1962
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1959

def put_alerting_userpresence_rule(rule_id, body, opts = {})
  data, _status_code, _headers = put_alerting_userpresence_rule_with_http_info(rule_id, body, opts)
  return data
end

#put_alerting_userpresence_rule_with_http_info(rule_id, body, opts = {}) ⇒ Array<(UserPresenceRule, Fixnum, Hash)>

Update a user presence rule

Parameters:

  • rule_id —

    Rule ID

  • body —

    UserPresenceRule

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

  • (Array<(UserPresenceRule, Fixnum, Hash)>) —

    UserPresenceRule data, response status code and response headers



1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
 
# File 'lib/purecloudplatformclientv2/api/alerting_api.rb', line 1971

def put_alerting_userpresence_rule_with_http_info(rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi.put_alerting_userpresence_rule ..."
  end
  # verify the required parameter 'rule_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_id' when calling AlertingApi.put_alerting_userpresence_rule" if rule_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling AlertingApi.put_alerting_userpresence_rule" if body.nil?
  # resource path
  local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserPresenceRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AlertingApi#put_alerting_userpresence_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end