purecloudplatformclientv2 49.0.0 → 49.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +8 -8
  3. data/docs/AlertingApi.md +33 -33
  4. data/docs/AnalyticsApi.md +81 -81
  5. data/docs/ArchitectApi.md +243 -243
  6. data/docs/AuthorizationApi.md +102 -102
  7. data/docs/BillingApi.md +6 -6
  8. data/docs/ContentManagementApi.md +114 -114
  9. data/docs/ConversationsApi.md +300 -300
  10. data/docs/DialerRulesetConfigChangeCondition.md +1 -0
  11. data/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +2 -0
  12. data/docs/ExternalContactsApi.md +90 -90
  13. data/docs/FaxApi.md +18 -18
  14. data/docs/FlowsApi.md +3 -3
  15. data/docs/GeneralDataProtectionRegulationApi.md +12 -12
  16. data/docs/GeolocationApi.md +12 -12
  17. data/docs/GreetingsApi.md +48 -48
  18. data/docs/GroupsApi.md +42 -42
  19. data/docs/IdentityProviderApi.md +84 -84
  20. data/docs/IntegrationsApi.md +123 -123
  21. data/docs/LanguagesApi.md +30 -30
  22. data/docs/LicenseApi.md +24 -24
  23. data/docs/LocationsApi.md +21 -21
  24. data/docs/MessagingApi.md +42 -42
  25. data/docs/MobileDevicesApi.md +15 -15
  26. data/docs/NotificationsApi.md +21 -21
  27. data/docs/OAuthApi.md +18 -18
  28. data/docs/ObjectsApi.md +24 -24
  29. data/docs/OrganizationApi.md +18 -18
  30. data/docs/OrganizationAuthorizationApi.md +69 -69
  31. data/docs/OutboundApi.md +288 -288
  32. data/docs/PresenceApi.md +27 -27
  33. data/docs/QualityApi.md +174 -174
  34. data/docs/QueueUserEventTopicQueueMember.md +4 -3
  35. data/docs/RecordingApi.md +111 -111
  36. data/docs/ResponseManagementApi.md +33 -33
  37. data/docs/RoutingApi.md +189 -189
  38. data/docs/ScriptsApi.md +33 -33
  39. data/docs/SearchApi.md +48 -48
  40. data/docs/StationsApi.md +15 -15
  41. data/docs/SuggestApi.md +12 -12
  42. data/docs/TelephonyProvidersEdgeApi.md +375 -375
  43. data/docs/TokensApi.md +6 -6
  44. data/docs/UserRecordingsApi.md +18 -18
  45. data/docs/UsersApi.md +183 -183
  46. data/docs/UtilitiesApi.md +12 -12
  47. data/docs/VoicemailApi.md +72 -72
  48. data/docs/WebChatApi.md +24 -24
  49. data/docs/WorkforceManagementApi.md +192 -192
  50. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  51. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_voicemail.rb +2 -2
  52. data/lib/purecloudplatformclientv2/models/conversation_event_topic_voicemail.rb +2 -2
  53. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_condition.rb +26 -1
  54. data/lib/purecloudplatformclientv2/models/dialer_ruleset_config_change_data_action_condition_predicate.rb +51 -1
  55. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_voicemail.rb +2 -2
  56. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_voicemail.rb +2 -2
  57. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_voicemail.rb +2 -2
  58. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_voicemail.rb +2 -2
  59. data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +50 -25
  60. data/lib/purecloudplatformclientv2/version.rb +1 -1
  61. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 69b95df13b20a40c40f3450bdb011906d2b755a2
4
- data.tar.gz: 8537418c5e96f4563d51857675fbe1966475d8cf
3
+ metadata.gz: 2bb54a5f6af99e4761cf890ed05ebf303f69263c
4
+ data.tar.gz: 7b597dd69eff7f7cc671075a2ee5499354cfc389
5
5
  SHA512:
6
- metadata.gz: d0d16f811c9835d68b23ceee25b6d761e40b33ccd6874e2b3ee3deb61f8a50225e4c930fca757da4bab5864e2a19ebfa6fa89d66651612b64e5f529cfa2f58d0
7
- data.tar.gz: 445775d33df28f803b668e5508d129f0619c0d95f5a0f2839bc7511a50a24143529f534295ab5afa0cd0f580707734da0c7b7f6873b6efda9574970558e17c32
6
+ metadata.gz: 30d50d4bf73259682c9125053424951f1cd1bd0429e53fad5495838203a0400771d3d476396aa0d372331869daf595435dd3cfb1789001968ebe367f442d4ca4
7
+ data.tar.gz: 4c6142beb9485b3baefeb16e1d732e0351cc567c97dbcfdf0886024703dc0628cae95e717b26886f139fa634ff0976601ab7e19d659487ad94ca7a45e7dde025
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=49.0.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=49.0.1)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -9,21 +9,21 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
9
9
 
10
10
  ### from rubygems.org
11
11
 
12
- ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 49.0.0'
14
- ~~~
12
+ ```{"language":"ruby"}
13
+ gem install 'purecloudplatformclientv2', '~> 49.0.1'
14
+ ```
15
15
 
16
16
  ### Install from Git
17
17
 
18
- ~~~ ruby
18
+ ```{"language":"ruby"}
19
19
  gem install 'purecloudplatformclientv2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ruby.git'
20
- ~~~
20
+ ```
21
21
 
22
22
  ## Getting Started
23
23
 
24
24
  Please follow the [installation](#installation) procedure and then run the following code:
25
25
 
26
- ~~~ ruby
26
+ ```{"language":"ruby"}
27
27
  # Load the gem
28
28
  require 'purecloudplatformclientv2'
29
29
 
@@ -45,7 +45,7 @@ rescue PureCloud::ApiError => e
45
45
  puts "Exception when calling AlertingApi->delete_alerting_interactionstats_alert: #{e}"
46
46
  end
47
47
 
48
- ~~~
48
+ ```
49
49
 
50
50
  ## SDK Source Code Generation
51
51
 
data/docs/AlertingApi.md CHANGED
@@ -23,7 +23,7 @@ Method | Description
23
23
 
24
24
  <a name="delete_alerting_interactionstats_alert"></a>
25
25
 
26
- ## - delete_alerting_interactionstats_alert(alert_id)
26
+ ## delete_alerting_interactionstats_alert(alert_id)
27
27
 
28
28
 
29
29
 
@@ -39,7 +39,7 @@ Requires ANY permissions:
39
39
 
40
40
 
41
41
  ### Example
42
- ~~~ruby
42
+ ```{"language":"ruby"}
43
43
  # load the gem
44
44
  require 'purecloudplatformclientv2'
45
45
  # setup authorization
@@ -64,7 +64,7 @@ begin
64
64
  rescue PureCloud::ApiError => e
65
65
  puts "Exception when calling AlertingApi->delete_alerting_interactionstats_alert: #{e}"
66
66
  end
67
- ~~~
67
+ ```
68
68
 
69
69
  ### Parameters
70
70
 
@@ -87,7 +87,7 @@ nil (empty response body)
87
87
 
88
88
  <a name="delete_alerting_interactionstats_rule"></a>
89
89
 
90
- ## - delete_alerting_interactionstats_rule(rule_id)
90
+ ## delete_alerting_interactionstats_rule(rule_id)
91
91
 
92
92
 
93
93
 
@@ -103,7 +103,7 @@ Requires ANY permissions:
103
103
 
104
104
 
105
105
  ### Example
106
- ~~~ruby
106
+ ```{"language":"ruby"}
107
107
  # load the gem
108
108
  require 'purecloudplatformclientv2'
109
109
  # setup authorization
@@ -128,7 +128,7 @@ begin
128
128
  rescue PureCloud::ApiError => e
129
129
  puts "Exception when calling AlertingApi->delete_alerting_interactionstats_rule: #{e}"
130
130
  end
131
- ~~~
131
+ ```
132
132
 
133
133
  ### Parameters
134
134
 
@@ -151,7 +151,7 @@ nil (empty response body)
151
151
 
152
152
  <a name="get_alerting_alerts_active"></a>
153
153
 
154
- ## -[**ActiveAlertCount**](ActiveAlertCount.html) get_alerting_alerts_active
154
+ ## [**ActiveAlertCount**](ActiveAlertCount.html) get_alerting_alerts_active
155
155
 
156
156
 
157
157
 
@@ -166,7 +166,7 @@ Requires NO permissions:
166
166
 
167
167
 
168
168
  ### Example
169
- ~~~ruby
169
+ ```{"language":"ruby"}
170
170
  # load the gem
171
171
  require 'purecloudplatformclientv2'
172
172
  # setup authorization
@@ -189,7 +189,7 @@ begin
189
189
  rescue PureCloud::ApiError => e
190
190
  puts "Exception when calling AlertingApi->get_alerting_alerts_active: #{e}"
191
191
  end
192
- ~~~
192
+ ```
193
193
 
194
194
  ### Parameters
195
195
  This endpoint does not need any parameter.
@@ -209,7 +209,7 @@ This endpoint does not need any parameter.
209
209
 
210
210
  <a name="get_alerting_interactionstats_alert"></a>
211
211
 
212
- ## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts)
212
+ ## [**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts)
213
213
 
214
214
 
215
215
 
@@ -225,7 +225,7 @@ Requires ANY permissions:
225
225
 
226
226
 
227
227
  ### Example
228
- ~~~ruby
228
+ ```{"language":"ruby"}
229
229
  # load the gem
230
230
  require 'purecloudplatformclientv2'
231
231
  # setup authorization
@@ -254,7 +254,7 @@ begin
254
254
  rescue PureCloud::ApiError => e
255
255
  puts "Exception when calling AlertingApi->get_alerting_interactionstats_alert: #{e}"
256
256
  end
257
- ~~~
257
+ ```
258
258
 
259
259
  ### Parameters
260
260
 
@@ -278,7 +278,7 @@ Name | Type | Description | Notes
278
278
 
279
279
  <a name="get_alerting_interactionstats_alerts"></a>
280
280
 
281
- ## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts)
281
+ ## [**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts)
282
282
 
283
283
 
284
284
 
@@ -294,7 +294,7 @@ Requires ANY permissions:
294
294
 
295
295
 
296
296
  ### Example
297
- ~~~ruby
297
+ ```{"language":"ruby"}
298
298
  # load the gem
299
299
  require 'purecloudplatformclientv2'
300
300
  # setup authorization
@@ -321,7 +321,7 @@ begin
321
321
  rescue PureCloud::ApiError => e
322
322
  puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts: #{e}"
323
323
  end
324
- ~~~
324
+ ```
325
325
 
326
326
  ### Parameters
327
327
 
@@ -344,7 +344,7 @@ Name | Type | Description | Notes
344
344
 
345
345
  <a name="get_alerting_interactionstats_alerts_unread"></a>
346
346
 
347
- ## -[**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread
347
+ ## [**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread
348
348
 
349
349
 
350
350
 
@@ -359,7 +359,7 @@ Requires NO permissions:
359
359
 
360
360
 
361
361
  ### Example
362
- ~~~ruby
362
+ ```{"language":"ruby"}
363
363
  # load the gem
364
364
  require 'purecloudplatformclientv2'
365
365
  # setup authorization
@@ -382,7 +382,7 @@ begin
382
382
  rescue PureCloud::ApiError => e
383
383
  puts "Exception when calling AlertingApi->get_alerting_interactionstats_alerts_unread: #{e}"
384
384
  end
385
- ~~~
385
+ ```
386
386
 
387
387
  ### Parameters
388
388
  This endpoint does not need any parameter.
@@ -402,7 +402,7 @@ This endpoint does not need any parameter.
402
402
 
403
403
  <a name="get_alerting_interactionstats_rule"></a>
404
404
 
405
- ## -[**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts)
405
+ ## [**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts)
406
406
 
407
407
 
408
408
 
@@ -418,7 +418,7 @@ Requires ANY permissions:
418
418
 
419
419
 
420
420
  ### Example
421
- ~~~ruby
421
+ ```{"language":"ruby"}
422
422
  # load the gem
423
423
  require 'purecloudplatformclientv2'
424
424
  # setup authorization
@@ -447,7 +447,7 @@ begin
447
447
  rescue PureCloud::ApiError => e
448
448
  puts "Exception when calling AlertingApi->get_alerting_interactionstats_rule: #{e}"
449
449
  end
450
- ~~~
450
+ ```
451
451
 
452
452
  ### Parameters
453
453
 
@@ -471,7 +471,7 @@ Name | Type | Description | Notes
471
471
 
472
472
  <a name="get_alerting_interactionstats_rules"></a>
473
473
 
474
- ## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts)
474
+ ## [**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts)
475
475
 
476
476
 
477
477
 
@@ -487,7 +487,7 @@ Requires ANY permissions:
487
487
 
488
488
 
489
489
  ### Example
490
- ~~~ruby
490
+ ```{"language":"ruby"}
491
491
  # load the gem
492
492
  require 'purecloudplatformclientv2'
493
493
  # setup authorization
@@ -514,7 +514,7 @@ begin
514
514
  rescue PureCloud::ApiError => e
515
515
  puts "Exception when calling AlertingApi->get_alerting_interactionstats_rules: #{e}"
516
516
  end
517
- ~~~
517
+ ```
518
518
 
519
519
  ### Parameters
520
520
 
@@ -537,7 +537,7 @@ Name | Type | Description | Notes
537
537
 
538
538
  <a name="post_alerting_interactionstats_rules"></a>
539
539
 
540
- ## -[**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts)
540
+ ## [**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts)
541
541
 
542
542
 
543
543
 
@@ -553,7 +553,7 @@ Requires ANY permissions:
553
553
 
554
554
 
555
555
  ### Example
556
- ~~~ruby
556
+ ```{"language":"ruby"}
557
557
  # load the gem
558
558
  require 'purecloudplatformclientv2'
559
559
  # setup authorization
@@ -582,7 +582,7 @@ begin
582
582
  rescue PureCloud::ApiError => e
583
583
  puts "Exception when calling AlertingApi->post_alerting_interactionstats_rules: #{e}"
584
584
  end
585
- ~~~
585
+ ```
586
586
 
587
587
  ### Parameters
588
588
 
@@ -606,7 +606,7 @@ Name | Type | Description | Notes
606
606
 
607
607
  <a name="put_alerting_interactionstats_alert"></a>
608
608
 
609
- ## -[**UnreadStatus**](UnreadStatus.html) put_alerting_interactionstats_alert(alert_id, body, opts)
609
+ ## [**UnreadStatus**](UnreadStatus.html) put_alerting_interactionstats_alert(alert_id, body, opts)
610
610
 
611
611
 
612
612
 
@@ -622,7 +622,7 @@ Requires ANY permissions:
622
622
 
623
623
 
624
624
  ### Example
625
- ~~~ruby
625
+ ```{"language":"ruby"}
626
626
  # load the gem
627
627
  require 'purecloudplatformclientv2'
628
628
  # setup authorization
@@ -653,7 +653,7 @@ begin
653
653
  rescue PureCloud::ApiError => e
654
654
  puts "Exception when calling AlertingApi->put_alerting_interactionstats_alert: #{e}"
655
655
  end
656
- ~~~
656
+ ```
657
657
 
658
658
  ### Parameters
659
659
 
@@ -678,7 +678,7 @@ Name | Type | Description | Notes
678
678
 
679
679
  <a name="put_alerting_interactionstats_rule"></a>
680
680
 
681
- ## -[**InteractionStatsRule**](InteractionStatsRule.html) put_alerting_interactionstats_rule(rule_id, body, opts)
681
+ ## [**InteractionStatsRule**](InteractionStatsRule.html) put_alerting_interactionstats_rule(rule_id, body, opts)
682
682
 
683
683
 
684
684
 
@@ -694,7 +694,7 @@ Requires ANY permissions:
694
694
 
695
695
 
696
696
  ### Example
697
- ~~~ruby
697
+ ```{"language":"ruby"}
698
698
  # load the gem
699
699
  require 'purecloudplatformclientv2'
700
700
  # setup authorization
@@ -725,7 +725,7 @@ begin
725
725
  rescue PureCloud::ApiError => e
726
726
  puts "Exception when calling AlertingApi->put_alerting_interactionstats_rule: #{e}"
727
727
  end
728
- ~~~
728
+ ```
729
729
 
730
730
  ### Parameters
731
731
 
data/docs/AnalyticsApi.md CHANGED
@@ -39,7 +39,7 @@ Method | Description
39
39
 
40
40
  <a name="delete_analytics_reporting_schedule"></a>
41
41
 
42
- ## - delete_analytics_reporting_schedule(schedule_id)
42
+ ## delete_analytics_reporting_schedule(schedule_id)
43
43
 
44
44
 
45
45
 
@@ -54,7 +54,7 @@ Requires NO permissions:
54
54
 
55
55
 
56
56
  ### Example
57
- ~~~ruby
57
+ ```{"language":"ruby"}
58
58
  # load the gem
59
59
  require 'purecloudplatformclientv2'
60
60
  # setup authorization
@@ -79,7 +79,7 @@ begin
79
79
  rescue PureCloud::ApiError => e
80
80
  puts "Exception when calling AnalyticsApi->delete_analytics_reporting_schedule: #{e}"
81
81
  end
82
- ~~~
82
+ ```
83
83
 
84
84
  ### Parameters
85
85
 
@@ -102,7 +102,7 @@ nil (empty response body)
102
102
 
103
103
  <a name="get_analytics_conversation_details"></a>
104
104
 
105
- ## -[**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
105
+ ## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
106
106
 
107
107
 
108
108
 
@@ -118,7 +118,7 @@ Requires ANY permissions:
118
118
 
119
119
 
120
120
  ### Example
121
- ~~~ruby
121
+ ```{"language":"ruby"}
122
122
  # load the gem
123
123
  require 'purecloudplatformclientv2'
124
124
  # setup authorization
@@ -144,7 +144,7 @@ begin
144
144
  rescue PureCloud::ApiError => e
145
145
  puts "Exception when calling AnalyticsApi->get_analytics_conversation_details: #{e}"
146
146
  end
147
- ~~~
147
+ ```
148
148
 
149
149
  ### Parameters
150
150
 
@@ -167,7 +167,7 @@ Name | Type | Description | Notes
167
167
 
168
168
  <a name="get_analytics_conversations_details"></a>
169
169
 
170
- ## -[**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversations_details(opts)
170
+ ## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversations_details(opts)
171
171
 
172
172
 
173
173
 
@@ -183,7 +183,7 @@ Requires ANY permissions:
183
183
 
184
184
 
185
185
  ### Example
186
- ~~~ruby
186
+ ```{"language":"ruby"}
187
187
  # load the gem
188
188
  require 'purecloudplatformclientv2'
189
189
  # setup authorization
@@ -210,7 +210,7 @@ begin
210
210
  rescue PureCloud::ApiError => e
211
211
  puts "Exception when calling AnalyticsApi->get_analytics_conversations_details: #{e}"
212
212
  end
213
- ~~~
213
+ ```
214
214
 
215
215
  ### Parameters
216
216
 
@@ -233,7 +233,7 @@ Name | Type | Description | Notes
233
233
 
234
234
  <a name="get_analytics_reporting_exports"></a>
235
235
 
236
- ## -[**ReportingExportJobListing**](ReportingExportJobListing.html) get_analytics_reporting_exports
236
+ ## [**ReportingExportJobListing**](ReportingExportJobListing.html) get_analytics_reporting_exports
237
237
 
238
238
 
239
239
 
@@ -249,7 +249,7 @@ Requires ANY permissions:
249
249
 
250
250
 
251
251
  ### Example
252
- ~~~ruby
252
+ ```{"language":"ruby"}
253
253
  # load the gem
254
254
  require 'purecloudplatformclientv2'
255
255
  # setup authorization
@@ -272,7 +272,7 @@ begin
272
272
  rescue PureCloud::ApiError => e
273
273
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_exports: #{e}"
274
274
  end
275
- ~~~
275
+ ```
276
276
 
277
277
  ### Parameters
278
278
  This endpoint does not need any parameter.
@@ -292,7 +292,7 @@ This endpoint does not need any parameter.
292
292
 
293
293
  <a name="get_analytics_reporting_metadata"></a>
294
294
 
295
- ## -[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
295
+ ## [**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
296
296
 
297
297
 
298
298
 
@@ -307,7 +307,7 @@ Requires NO permissions:
307
307
 
308
308
 
309
309
  ### Example
310
- ~~~ruby
310
+ ```{"language":"ruby"}
311
311
  # load the gem
312
312
  require 'purecloudplatformclientv2'
313
313
  # setup authorization
@@ -336,7 +336,7 @@ begin
336
336
  rescue PureCloud::ApiError => e
337
337
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_metadata: #{e}"
338
338
  end
339
- ~~~
339
+ ```
340
340
 
341
341
  ### Parameters
342
342
 
@@ -361,7 +361,7 @@ Name | Type | Description | Notes
361
361
 
362
362
  <a name="get_analytics_reporting_report_id_metadata"></a>
363
363
 
364
- ## -[**ReportMetaData**](ReportMetaData.html) get_analytics_reporting_report_id_metadata(report_id, opts)
364
+ ## [**ReportMetaData**](ReportMetaData.html) get_analytics_reporting_report_id_metadata(report_id, opts)
365
365
 
366
366
 
367
367
 
@@ -376,7 +376,7 @@ Requires NO permissions:
376
376
 
377
377
 
378
378
  ### Example
379
- ~~~ruby
379
+ ```{"language":"ruby"}
380
380
  # load the gem
381
381
  require 'purecloudplatformclientv2'
382
382
  # setup authorization
@@ -405,7 +405,7 @@ begin
405
405
  rescue PureCloud::ApiError => e
406
406
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_report_id_metadata: #{e}"
407
407
  end
408
- ~~~
408
+ ```
409
409
 
410
410
  ### Parameters
411
411
 
@@ -429,7 +429,7 @@ Name | Type | Description | Notes
429
429
 
430
430
  <a name="get_analytics_reporting_reportformats"></a>
431
431
 
432
- ## -Array&lt;String&gt;** get_analytics_reporting_reportformats
432
+ ## Array&lt;String&gt;** get_analytics_reporting_reportformats
433
433
 
434
434
 
435
435
 
@@ -444,7 +444,7 @@ Requires NO permissions:
444
444
 
445
445
 
446
446
  ### Example
447
- ~~~ruby
447
+ ```{"language":"ruby"}
448
448
  # load the gem
449
449
  require 'purecloudplatformclientv2'
450
450
  # setup authorization
@@ -467,7 +467,7 @@ begin
467
467
  rescue PureCloud::ApiError => e
468
468
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_reportformats: #{e}"
469
469
  end
470
- ~~~
470
+ ```
471
471
 
472
472
  ### Parameters
473
473
  This endpoint does not need any parameter.
@@ -487,7 +487,7 @@ This endpoint does not need any parameter.
487
487
 
488
488
  <a name="get_analytics_reporting_schedule"></a>
489
489
 
490
- ## -[**ReportSchedule**](ReportSchedule.html) get_analytics_reporting_schedule(schedule_id)
490
+ ## [**ReportSchedule**](ReportSchedule.html) get_analytics_reporting_schedule(schedule_id)
491
491
 
492
492
 
493
493
 
@@ -502,7 +502,7 @@ Requires NO permissions:
502
502
 
503
503
 
504
504
  ### Example
505
- ~~~ruby
505
+ ```{"language":"ruby"}
506
506
  # load the gem
507
507
  require 'purecloudplatformclientv2'
508
508
  # setup authorization
@@ -528,7 +528,7 @@ begin
528
528
  rescue PureCloud::ApiError => e
529
529
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_schedule: #{e}"
530
530
  end
531
- ~~~
531
+ ```
532
532
 
533
533
  ### Parameters
534
534
 
@@ -551,7 +551,7 @@ Name | Type | Description | Notes
551
551
 
552
552
  <a name="get_analytics_reporting_schedule_history"></a>
553
553
 
554
- ## -[**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html) get_analytics_reporting_schedule_history(schedule_id, opts)
554
+ ## [**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html) get_analytics_reporting_schedule_history(schedule_id, opts)
555
555
 
556
556
 
557
557
 
@@ -566,7 +566,7 @@ Requires NO permissions:
566
566
 
567
567
 
568
568
  ### Example
569
- ~~~ruby
569
+ ```{"language":"ruby"}
570
570
  # load the gem
571
571
  require 'purecloudplatformclientv2'
572
572
  # setup authorization
@@ -596,7 +596,7 @@ begin
596
596
  rescue PureCloud::ApiError => e
597
597
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_schedule_history: #{e}"
598
598
  end
599
- ~~~
599
+ ```
600
600
 
601
601
  ### Parameters
602
602
 
@@ -621,7 +621,7 @@ Name | Type | Description | Notes
621
621
 
622
622
  <a name="get_analytics_reporting_schedule_history_latest"></a>
623
623
 
624
- ## -[**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_latest(schedule_id)
624
+ ## [**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_latest(schedule_id)
625
625
 
626
626
 
627
627
 
@@ -636,7 +636,7 @@ Requires NO permissions:
636
636
 
637
637
 
638
638
  ### Example
639
- ~~~ruby
639
+ ```{"language":"ruby"}
640
640
  # load the gem
641
641
  require 'purecloudplatformclientv2'
642
642
  # setup authorization
@@ -662,7 +662,7 @@ begin
662
662
  rescue PureCloud::ApiError => e
663
663
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_schedule_history_latest: #{e}"
664
664
  end
665
- ~~~
665
+ ```
666
666
 
667
667
  ### Parameters
668
668
 
@@ -685,7 +685,7 @@ Name | Type | Description | Notes
685
685
 
686
686
  <a name="get_analytics_reporting_schedule_history_run_id"></a>
687
687
 
688
- ## -[**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_run_id(run_id, schedule_id)
688
+ ## [**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_run_id(run_id, schedule_id)
689
689
 
690
690
 
691
691
 
@@ -700,7 +700,7 @@ Requires NO permissions:
700
700
 
701
701
 
702
702
  ### Example
703
- ~~~ruby
703
+ ```{"language":"ruby"}
704
704
  # load the gem
705
705
  require 'purecloudplatformclientv2'
706
706
  # setup authorization
@@ -728,7 +728,7 @@ begin
728
728
  rescue PureCloud::ApiError => e
729
729
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_schedule_history_run_id: #{e}"
730
730
  end
731
- ~~~
731
+ ```
732
732
 
733
733
  ### Parameters
734
734
 
@@ -752,7 +752,7 @@ Name | Type | Description | Notes
752
752
 
753
753
  <a name="get_analytics_reporting_schedules"></a>
754
754
 
755
- ## -[**ReportScheduleEntityListing**](ReportScheduleEntityListing.html) get_analytics_reporting_schedules(opts)
755
+ ## [**ReportScheduleEntityListing**](ReportScheduleEntityListing.html) get_analytics_reporting_schedules(opts)
756
756
 
757
757
 
758
758
 
@@ -767,7 +767,7 @@ Requires NO permissions:
767
767
 
768
768
 
769
769
  ### Example
770
- ~~~ruby
770
+ ```{"language":"ruby"}
771
771
  # load the gem
772
772
  require 'purecloudplatformclientv2'
773
773
  # setup authorization
@@ -795,7 +795,7 @@ begin
795
795
  rescue PureCloud::ApiError => e
796
796
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_schedules: #{e}"
797
797
  end
798
- ~~~
798
+ ```
799
799
 
800
800
  ### Parameters
801
801
 
@@ -819,7 +819,7 @@ Name | Type | Description | Notes
819
819
 
820
820
  <a name="get_analytics_reporting_timeperiods"></a>
821
821
 
822
- ## -Array&lt;String&gt;** get_analytics_reporting_timeperiods
822
+ ## Array&lt;String&gt;** get_analytics_reporting_timeperiods
823
823
 
824
824
 
825
825
 
@@ -834,7 +834,7 @@ Requires NO permissions:
834
834
 
835
835
 
836
836
  ### Example
837
- ~~~ruby
837
+ ```{"language":"ruby"}
838
838
  # load the gem
839
839
  require 'purecloudplatformclientv2'
840
840
  # setup authorization
@@ -857,7 +857,7 @@ begin
857
857
  rescue PureCloud::ApiError => e
858
858
  puts "Exception when calling AnalyticsApi->get_analytics_reporting_timeperiods: #{e}"
859
859
  end
860
- ~~~
860
+ ```
861
861
 
862
862
  ### Parameters
863
863
  This endpoint does not need any parameter.
@@ -877,7 +877,7 @@ This endpoint does not need any parameter.
877
877
 
878
878
  <a name="post_analytics_conversation_details_properties"></a>
879
879
 
880
- ## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
880
+ ## [**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
881
881
 
882
882
 
883
883
 
@@ -893,7 +893,7 @@ Requires ANY permissions:
893
893
 
894
894
 
895
895
  ### Example
896
- ~~~ruby
896
+ ```{"language":"ruby"}
897
897
  # load the gem
898
898
  require 'purecloudplatformclientv2'
899
899
  # setup authorization
@@ -921,7 +921,7 @@ begin
921
921
  rescue PureCloud::ApiError => e
922
922
  puts "Exception when calling AnalyticsApi->post_analytics_conversation_details_properties: #{e}"
923
923
  end
924
- ~~~
924
+ ```
925
925
 
926
926
  ### Parameters
927
927
 
@@ -945,7 +945,7 @@ Name | Type | Description | Notes
945
945
 
946
946
  <a name="post_analytics_conversations_aggregates_query"></a>
947
947
 
948
- ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
948
+ ## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
949
949
 
950
950
 
951
951
 
@@ -961,7 +961,7 @@ Requires ANY permissions:
961
961
 
962
962
 
963
963
  ### Example
964
- ~~~ruby
964
+ ```{"language":"ruby"}
965
965
  # load the gem
966
966
  require 'purecloudplatformclientv2'
967
967
  # setup authorization
@@ -987,7 +987,7 @@ begin
987
987
  rescue PureCloud::ApiError => e
988
988
  puts "Exception when calling AnalyticsApi->post_analytics_conversations_aggregates_query: #{e}"
989
989
  end
990
- ~~~
990
+ ```
991
991
 
992
992
  ### Parameters
993
993
 
@@ -1010,7 +1010,7 @@ Name | Type | Description | Notes
1010
1010
 
1011
1011
  <a name="post_analytics_conversations_details_query"></a>
1012
1012
 
1013
- ## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
1013
+ ## [**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
1014
1014
 
1015
1015
 
1016
1016
 
@@ -1026,7 +1026,7 @@ Requires ANY permissions:
1026
1026
 
1027
1027
 
1028
1028
  ### Example
1029
- ~~~ruby
1029
+ ```{"language":"ruby"}
1030
1030
  # load the gem
1031
1031
  require 'purecloudplatformclientv2'
1032
1032
  # setup authorization
@@ -1052,7 +1052,7 @@ begin
1052
1052
  rescue PureCloud::ApiError => e
1053
1053
  puts "Exception when calling AnalyticsApi->post_analytics_conversations_details_query: #{e}"
1054
1054
  end
1055
- ~~~
1055
+ ```
1056
1056
 
1057
1057
  ### Parameters
1058
1058
 
@@ -1075,7 +1075,7 @@ Name | Type | Description | Notes
1075
1075
 
1076
1076
  <a name="post_analytics_evaluations_aggregates_query"></a>
1077
1077
 
1078
- ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
1078
+ ## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
1079
1079
 
1080
1080
 
1081
1081
 
@@ -1091,7 +1091,7 @@ Requires ANY permissions:
1091
1091
 
1092
1092
 
1093
1093
  ### Example
1094
- ~~~ruby
1094
+ ```{"language":"ruby"}
1095
1095
  # load the gem
1096
1096
  require 'purecloudplatformclientv2'
1097
1097
  # setup authorization
@@ -1117,7 +1117,7 @@ begin
1117
1117
  rescue PureCloud::ApiError => e
1118
1118
  puts "Exception when calling AnalyticsApi->post_analytics_evaluations_aggregates_query: #{e}"
1119
1119
  end
1120
- ~~~
1120
+ ```
1121
1121
 
1122
1122
  ### Parameters
1123
1123
 
@@ -1140,7 +1140,7 @@ Name | Type | Description | Notes
1140
1140
 
1141
1141
  <a name="post_analytics_flows_aggregates_query"></a>
1142
1142
 
1143
- ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_flows_aggregates_query(body)
1143
+ ## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_flows_aggregates_query(body)
1144
1144
 
1145
1145
 
1146
1146
 
@@ -1156,7 +1156,7 @@ Requires ANY permissions:
1156
1156
 
1157
1157
 
1158
1158
  ### Example
1159
- ~~~ruby
1159
+ ```{"language":"ruby"}
1160
1160
  # load the gem
1161
1161
  require 'purecloudplatformclientv2'
1162
1162
  # setup authorization
@@ -1182,7 +1182,7 @@ begin
1182
1182
  rescue PureCloud::ApiError => e
1183
1183
  puts "Exception when calling AnalyticsApi->post_analytics_flows_aggregates_query: #{e}"
1184
1184
  end
1185
- ~~~
1185
+ ```
1186
1186
 
1187
1187
  ### Parameters
1188
1188
 
@@ -1205,7 +1205,7 @@ Name | Type | Description | Notes
1205
1205
 
1206
1206
  <a name="post_analytics_queues_observations_query"></a>
1207
1207
 
1208
- ## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
1208
+ ## [**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
1209
1209
 
1210
1210
 
1211
1211
 
@@ -1221,7 +1221,7 @@ Requires ANY permissions:
1221
1221
 
1222
1222
 
1223
1223
  ### Example
1224
- ~~~ruby
1224
+ ```{"language":"ruby"}
1225
1225
  # load the gem
1226
1226
  require 'purecloudplatformclientv2'
1227
1227
  # setup authorization
@@ -1247,7 +1247,7 @@ begin
1247
1247
  rescue PureCloud::ApiError => e
1248
1248
  puts "Exception when calling AnalyticsApi->post_analytics_queues_observations_query: #{e}"
1249
1249
  end
1250
- ~~~
1250
+ ```
1251
1251
 
1252
1252
  ### Parameters
1253
1253
 
@@ -1270,7 +1270,7 @@ Name | Type | Description | Notes
1270
1270
 
1271
1271
  <a name="post_analytics_reporting_exports"></a>
1272
1272
 
1273
- ## -[**ReportingExportJobResponse**](ReportingExportJobResponse.html) post_analytics_reporting_exports(body)
1273
+ ## [**ReportingExportJobResponse**](ReportingExportJobResponse.html) post_analytics_reporting_exports(body)
1274
1274
 
1275
1275
 
1276
1276
 
@@ -1286,7 +1286,7 @@ Requires ANY permissions:
1286
1286
 
1287
1287
 
1288
1288
  ### Example
1289
- ~~~ruby
1289
+ ```{"language":"ruby"}
1290
1290
  # load the gem
1291
1291
  require 'purecloudplatformclientv2'
1292
1292
  # setup authorization
@@ -1312,7 +1312,7 @@ begin
1312
1312
  rescue PureCloud::ApiError => e
1313
1313
  puts "Exception when calling AnalyticsApi->post_analytics_reporting_exports: #{e}"
1314
1314
  end
1315
- ~~~
1315
+ ```
1316
1316
 
1317
1317
  ### Parameters
1318
1318
 
@@ -1335,7 +1335,7 @@ Name | Type | Description | Notes
1335
1335
 
1336
1336
  <a name="post_analytics_reporting_schedule_runreport"></a>
1337
1337
 
1338
- ## -[**RunNowResponse**](RunNowResponse.html) post_analytics_reporting_schedule_runreport(schedule_id)
1338
+ ## [**RunNowResponse**](RunNowResponse.html) post_analytics_reporting_schedule_runreport(schedule_id)
1339
1339
 
1340
1340
 
1341
1341
 
@@ -1350,7 +1350,7 @@ Requires NO permissions:
1350
1350
 
1351
1351
 
1352
1352
  ### Example
1353
- ~~~ruby
1353
+ ```{"language":"ruby"}
1354
1354
  # load the gem
1355
1355
  require 'purecloudplatformclientv2'
1356
1356
  # setup authorization
@@ -1376,7 +1376,7 @@ begin
1376
1376
  rescue PureCloud::ApiError => e
1377
1377
  puts "Exception when calling AnalyticsApi->post_analytics_reporting_schedule_runreport: #{e}"
1378
1378
  end
1379
- ~~~
1379
+ ```
1380
1380
 
1381
1381
  ### Parameters
1382
1382
 
@@ -1399,7 +1399,7 @@ Name | Type | Description | Notes
1399
1399
 
1400
1400
  <a name="post_analytics_reporting_schedules"></a>
1401
1401
 
1402
- ## -[**ReportSchedule**](ReportSchedule.html) post_analytics_reporting_schedules(body)
1402
+ ## [**ReportSchedule**](ReportSchedule.html) post_analytics_reporting_schedules(body)
1403
1403
 
1404
1404
 
1405
1405
 
@@ -1414,7 +1414,7 @@ Requires NO permissions:
1414
1414
 
1415
1415
 
1416
1416
  ### Example
1417
- ~~~ruby
1417
+ ```{"language":"ruby"}
1418
1418
  # load the gem
1419
1419
  require 'purecloudplatformclientv2'
1420
1420
  # setup authorization
@@ -1440,7 +1440,7 @@ begin
1440
1440
  rescue PureCloud::ApiError => e
1441
1441
  puts "Exception when calling AnalyticsApi->post_analytics_reporting_schedules: #{e}"
1442
1442
  end
1443
- ~~~
1443
+ ```
1444
1444
 
1445
1445
  ### Parameters
1446
1446
 
@@ -1463,7 +1463,7 @@ Name | Type | Description | Notes
1463
1463
 
1464
1464
  <a name="post_analytics_surveys_aggregates_query"></a>
1465
1465
 
1466
- ## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_surveys_aggregates_query(body)
1466
+ ## [**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_surveys_aggregates_query(body)
1467
1467
 
1468
1468
 
1469
1469
 
@@ -1479,7 +1479,7 @@ Requires ANY permissions:
1479
1479
 
1480
1480
 
1481
1481
  ### Example
1482
- ~~~ruby
1482
+ ```{"language":"ruby"}
1483
1483
  # load the gem
1484
1484
  require 'purecloudplatformclientv2'
1485
1485
  # setup authorization
@@ -1505,7 +1505,7 @@ begin
1505
1505
  rescue PureCloud::ApiError => e
1506
1506
  puts "Exception when calling AnalyticsApi->post_analytics_surveys_aggregates_query: #{e}"
1507
1507
  end
1508
- ~~~
1508
+ ```
1509
1509
 
1510
1510
  ### Parameters
1511
1511
 
@@ -1528,7 +1528,7 @@ Name | Type | Description | Notes
1528
1528
 
1529
1529
  <a name="post_analytics_users_aggregates_query"></a>
1530
1530
 
1531
- ## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
1531
+ ## [**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
1532
1532
 
1533
1533
 
1534
1534
 
@@ -1544,7 +1544,7 @@ Requires ANY permissions:
1544
1544
 
1545
1545
 
1546
1546
  ### Example
1547
- ~~~ruby
1547
+ ```{"language":"ruby"}
1548
1548
  # load the gem
1549
1549
  require 'purecloudplatformclientv2'
1550
1550
  # setup authorization
@@ -1570,7 +1570,7 @@ begin
1570
1570
  rescue PureCloud::ApiError => e
1571
1571
  puts "Exception when calling AnalyticsApi->post_analytics_users_aggregates_query: #{e}"
1572
1572
  end
1573
- ~~~
1573
+ ```
1574
1574
 
1575
1575
  ### Parameters
1576
1576
 
@@ -1593,7 +1593,7 @@ Name | Type | Description | Notes
1593
1593
 
1594
1594
  <a name="post_analytics_users_details_query"></a>
1595
1595
 
1596
- ## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
1596
+ ## [**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
1597
1597
 
1598
1598
 
1599
1599
 
@@ -1609,7 +1609,7 @@ Requires ANY permissions:
1609
1609
 
1610
1610
 
1611
1611
  ### Example
1612
- ~~~ruby
1612
+ ```{"language":"ruby"}
1613
1613
  # load the gem
1614
1614
  require 'purecloudplatformclientv2'
1615
1615
  # setup authorization
@@ -1635,7 +1635,7 @@ begin
1635
1635
  rescue PureCloud::ApiError => e
1636
1636
  puts "Exception when calling AnalyticsApi->post_analytics_users_details_query: #{e}"
1637
1637
  end
1638
- ~~~
1638
+ ```
1639
1639
 
1640
1640
  ### Parameters
1641
1641
 
@@ -1658,7 +1658,7 @@ Name | Type | Description | Notes
1658
1658
 
1659
1659
  <a name="post_analytics_users_observations_query"></a>
1660
1660
 
1661
- ## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
1661
+ ## [**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
1662
1662
 
1663
1663
 
1664
1664
 
@@ -1674,7 +1674,7 @@ Requires ANY permissions:
1674
1674
 
1675
1675
 
1676
1676
  ### Example
1677
- ~~~ruby
1677
+ ```{"language":"ruby"}
1678
1678
  # load the gem
1679
1679
  require 'purecloudplatformclientv2'
1680
1680
  # setup authorization
@@ -1700,7 +1700,7 @@ begin
1700
1700
  rescue PureCloud::ApiError => e
1701
1701
  puts "Exception when calling AnalyticsApi->post_analytics_users_observations_query: #{e}"
1702
1702
  end
1703
- ~~~
1703
+ ```
1704
1704
 
1705
1705
  ### Parameters
1706
1706
 
@@ -1723,7 +1723,7 @@ Name | Type | Description | Notes
1723
1723
 
1724
1724
  <a name="put_analytics_reporting_schedule"></a>
1725
1725
 
1726
- ## -[**ReportSchedule**](ReportSchedule.html) put_analytics_reporting_schedule(schedule_id, body)
1726
+ ## [**ReportSchedule**](ReportSchedule.html) put_analytics_reporting_schedule(schedule_id, body)
1727
1727
 
1728
1728
 
1729
1729
 
@@ -1738,7 +1738,7 @@ Requires NO permissions:
1738
1738
 
1739
1739
 
1740
1740
  ### Example
1741
- ~~~ruby
1741
+ ```{"language":"ruby"}
1742
1742
  # load the gem
1743
1743
  require 'purecloudplatformclientv2'
1744
1744
  # setup authorization
@@ -1766,7 +1766,7 @@ begin
1766
1766
  rescue PureCloud::ApiError => e
1767
1767
  puts "Exception when calling AnalyticsApi->put_analytics_reporting_schedule: #{e}"
1768
1768
  end
1769
- ~~~
1769
+ ```
1770
1770
 
1771
1771
  ### Parameters
1772
1772