Class: PureCloud::AlertingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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.



7
8
9
 
# File 'lib/purecloud/api/alerting_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/alerting_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

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

Delete an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:

  • (nil) 


252
253
254
255
 
# File 'lib/purecloud/api/alerting_api.rb', line 252

def delete_interactionstats_alerts_alert_id(alert_id, opts = {})
  delete_interactionstats_alerts_alert_id_with_http_info(alert_id, opts)
  return nil
end

#delete_interactionstats_alerts_alert_id_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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/purecloud/api/alerting_api.rb', line 262

def delete_interactionstats_alerts_alert_id_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#delete_interactionstats_alerts_alert_id ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling delete_interactionstats_alerts_alert_id" if alert_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:

  • (nil) 


550
551
552
553
 
# File 'lib/purecloud/api/alerting_api.rb', line 550

def delete_interactionstats_rules_rule_id(rule_id, opts = {})
  delete_interactionstats_rules_rule_id_with_http_info(rule_id, opts)
  return nil
end

#delete_interactionstats_rules_rule_id_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



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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/purecloud/api/alerting_api.rb', line 560

def delete_interactionstats_rules_rule_id_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#delete_interactionstats_rules_rule_id ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling delete_interactionstats_rules_rule_id" if rule_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_interactionstats_alerts(opts = {}) ⇒ InteractionStatsAlertContainer

Get interaction stats alert list.

Parameters:

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

    the optional parameters

Returns:



15
16
17
18
 
# File 'lib/purecloud/api/alerting_api.rb', line 15

def get_interactionstats_alerts(opts = {})
  data, status_code, headers = get_interactionstats_alerts_with_http_info(opts)
  return data
end

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

Get an interaction stats alert

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Returns:



128
129
130
131
 
# File 'lib/purecloud/api/alerting_api.rb', line 128

def get_interactionstats_alerts_alert_id(alert_id, opts = {})
  data, status_code, headers = get_interactionstats_alerts_alert_id_with_http_info(alert_id, opts)
  return data
end

#get_interactionstats_alerts_alert_id_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

Returns:

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

    InteractionStatsAlert data, response status code and response headers



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/purecloud/api/alerting_api.rb', line 138

def get_interactionstats_alerts_alert_id_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_alerts_alert_id ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling get_interactionstats_alerts_alert_id" if alert_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_interactionstats_alerts_unread(opts = {}) ⇒ UnreadMetric

Gets user unread count of interaction stats alerts.

Parameters:

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

    the optional parameters

Returns:



71
72
73
74
 
# File 'lib/purecloud/api/alerting_api.rb', line 71

def get_interactionstats_alerts_unread(opts = {})
  data, status_code, headers = get_interactionstats_alerts_unread_with_http_info(opts)
  return data
end

#get_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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/purecloud/api/alerting_api.rb', line 80

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get interaction stats alert list.

Parameters:

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

    the optional parameters

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/purecloud/api/alerting_api.rb', line 24

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_interactionstats_rules(opts = {}) ⇒ InteractionStatsRuleContainer

Get an interaction stats rule list.

Parameters:

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

    the optional parameters

Returns:



311
312
313
314
 
# File 'lib/purecloud/api/alerting_api.rb', line 311

def get_interactionstats_rules(opts = {})
  data, status_code, headers = get_interactionstats_rules_with_http_info(opts)
  return data
end

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

Get an interaction stats rule.

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Returns:



426
427
428
429
 
# File 'lib/purecloud/api/alerting_api.rb', line 426

def get_interactionstats_rules_rule_id(rule_id, opts = {})
  data, status_code, headers = get_interactionstats_rules_rule_id_with_http_info(rule_id, opts)
  return data
end

#get_interactionstats_rules_rule_id_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

Returns:

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

    InteractionStatsRule data, response status code and response headers



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
474
475
476
477
478
479
480
 
# File 'lib/purecloud/api/alerting_api.rb', line 436

def get_interactionstats_rules_rule_id_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_rules_rule_id ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling get_interactionstats_rules_rule_id" if rule_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get an interaction stats rule list.

Parameters:

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

    the optional parameters

Returns:



320
321
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/purecloud/api/alerting_api.rb', line 320

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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, 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_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_interactionstats_rules(opts = {}) ⇒ InteractionStatsRule

Create an interaction stats rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def post_interactionstats_rules(opts = {})
  data, status_code, headers = post_interactionstats_rules_with_http_info(opts)
  return data
end

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

Create an interaction stats rule.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InteractionStatsRule data, 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
418
419
 
# File 'lib/purecloud/api/alerting_api.rb', line 378

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_interactionstats_alerts_alert_id(alert_id, opts = {}) ⇒ UnreadStatus

Update an interaction stats alert read status

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

Returns:



190
191
192
193
 
# File 'lib/purecloud/api/alerting_api.rb', line 190

def put_interactionstats_alerts_alert_id(alert_id, opts = {})
  data, status_code, headers = put_interactionstats_alerts_alert_id_with_http_info(alert_id, opts)
  return data
end

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

Update an interaction stats alert read status

Parameters:

  • alert_id —

    Alert ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UnreadStatus data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/purecloud/api/alerting_api.rb', line 201

def put_interactionstats_alerts_alert_id_with_http_info(alert_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#put_interactionstats_alerts_alert_id ..."
  end
  
  # verify the required parameter 'alert_id' is set
  fail "Missing the required parameter 'alert_id' when calling put_interactionstats_alerts_alert_id" if alert_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update an interaction stats rule

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

Returns:



488
489
490
491
 
# File 'lib/purecloud/api/alerting_api.rb', line 488

def put_interactionstats_rules_rule_id(rule_id, opts = {})
  data, status_code, headers = put_interactionstats_rules_rule_id_with_http_info(rule_id, opts)
  return data
end

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

Update an interaction stats rule

Parameters:

  • rule_id —

    Rule ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InteractionStatsRule data, response status code and response headers



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
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/purecloud/api/alerting_api.rb', line 499

def put_interactionstats_rules_rule_id_with_http_info(rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AlertingApi#put_interactionstats_rules_rule_id ..."
  end
  
  # verify the required parameter 'rule_id' is set
  fail "Missing the required parameter 'rule_id' when calling put_interactionstats_rules_rule_id" if rule_id.nil?
  
  # resource path
  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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

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

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end