purecloudplatformclientv2 49.0.0 → 49.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
data/docs/LanguagesApi.md CHANGED
@@ -22,7 +22,7 @@ Method | Description
22
22
 
23
23
  <a name="delete_language"></a>
24
24
 
25
- ## - delete_language(language_id)
25
+ ## delete_language(language_id)
26
26
 
27
27
  <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
28
28
 
@@ -38,7 +38,7 @@ Requires ANY permissions:
38
38
 
39
39
 
40
40
  ### Example
41
- ~~~ruby
41
+ ```{"language":"ruby"}
42
42
  # load the gem
43
43
  require 'purecloudplatformclientv2'
44
44
  # setup authorization
@@ -63,7 +63,7 @@ begin
63
63
  rescue PureCloud::ApiError => e
64
64
  puts "Exception when calling LanguagesApi->delete_language: #{e}"
65
65
  end
66
- ~~~
66
+ ```
67
67
 
68
68
  ### Parameters
69
69
 
@@ -86,7 +86,7 @@ nil (empty response body)
86
86
 
87
87
  <a name="delete_routing_language"></a>
88
88
 
89
- ## - delete_routing_language(language_id)
89
+ ## delete_routing_language(language_id)
90
90
 
91
91
 
92
92
 
@@ -102,7 +102,7 @@ Requires ANY permissions:
102
102
 
103
103
 
104
104
  ### Example
105
- ~~~ruby
105
+ ```{"language":"ruby"}
106
106
  # load the gem
107
107
  require 'purecloudplatformclientv2'
108
108
  # setup authorization
@@ -127,7 +127,7 @@ begin
127
127
  rescue PureCloud::ApiError => e
128
128
  puts "Exception when calling LanguagesApi->delete_routing_language: #{e}"
129
129
  end
130
- ~~~
130
+ ```
131
131
 
132
132
  ### Parameters
133
133
 
@@ -150,7 +150,7 @@ nil (empty response body)
150
150
 
151
151
  <a name="get_language"></a>
152
152
 
153
- ## -[**Language**](Language.html) get_language(language_id)
153
+ ## [**Language**](Language.html) get_language(language_id)
154
154
 
155
155
  <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
156
156
 
@@ -166,7 +166,7 @@ Requires ANY 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
@@ -192,7 +192,7 @@ begin
192
192
  rescue PureCloud::ApiError => e
193
193
  puts "Exception when calling LanguagesApi->get_language: #{e}"
194
194
  end
195
- ~~~
195
+ ```
196
196
 
197
197
  ### Parameters
198
198
 
@@ -215,7 +215,7 @@ Name | Type | Description | Notes
215
215
 
216
216
  <a name="get_languages"></a>
217
217
 
218
- ## -[**LanguageEntityListing**](LanguageEntityListing.html) get_languages(opts)
218
+ ## [**LanguageEntityListing**](LanguageEntityListing.html) get_languages(opts)
219
219
 
220
220
  <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
221
221
 
@@ -231,7 +231,7 @@ Requires ANY permissions:
231
231
 
232
232
 
233
233
  ### Example
234
- ~~~ruby
234
+ ```{"language":"ruby"}
235
235
  # load the gem
236
236
  require 'purecloudplatformclientv2'
237
237
  # setup authorization
@@ -261,7 +261,7 @@ begin
261
261
  rescue PureCloud::ApiError => e
262
262
  puts "Exception when calling LanguagesApi->get_languages: #{e}"
263
263
  end
264
- ~~~
264
+ ```
265
265
 
266
266
  ### Parameters
267
267
 
@@ -287,7 +287,7 @@ Name | Type | Description | Notes
287
287
 
288
288
  <a name="get_languages_translations"></a>
289
289
 
290
- ## -[**AvailableTranslations**](AvailableTranslations.html) get_languages_translations
290
+ ## [**AvailableTranslations**](AvailableTranslations.html) get_languages_translations
291
291
 
292
292
 
293
293
 
@@ -302,7 +302,7 @@ Requires NO permissions:
302
302
 
303
303
 
304
304
  ### Example
305
- ~~~ruby
305
+ ```{"language":"ruby"}
306
306
  # load the gem
307
307
  require 'purecloudplatformclientv2'
308
308
  # setup authorization
@@ -325,7 +325,7 @@ begin
325
325
  rescue PureCloud::ApiError => e
326
326
  puts "Exception when calling LanguagesApi->get_languages_translations: #{e}"
327
327
  end
328
- ~~~
328
+ ```
329
329
 
330
330
  ### Parameters
331
331
  This endpoint does not need any parameter.
@@ -345,7 +345,7 @@ This endpoint does not need any parameter.
345
345
 
346
346
  <a name="get_languages_translations_builtin"></a>
347
347
 
348
- ## -Hash&lt;String, Object&gt;** get_languages_translations_builtin(language)
348
+ ## Hash&lt;String, Object&gt;** get_languages_translations_builtin(language)
349
349
 
350
350
 
351
351
 
@@ -360,7 +360,7 @@ Requires NO permissions:
360
360
 
361
361
 
362
362
  ### Example
363
- ~~~ruby
363
+ ```{"language":"ruby"}
364
364
  # load the gem
365
365
  require 'purecloudplatformclientv2'
366
366
  # setup authorization
@@ -386,7 +386,7 @@ begin
386
386
  rescue PureCloud::ApiError => e
387
387
  puts "Exception when calling LanguagesApi->get_languages_translations_builtin: #{e}"
388
388
  end
389
- ~~~
389
+ ```
390
390
 
391
391
  ### Parameters
392
392
 
@@ -409,7 +409,7 @@ Name | Type | Description | Notes
409
409
 
410
410
  <a name="get_languages_translations_organization"></a>
411
411
 
412
- ## -Hash&lt;String, Object&gt;** get_languages_translations_organization(language)
412
+ ## Hash&lt;String, Object&gt;** get_languages_translations_organization(language)
413
413
 
414
414
 
415
415
 
@@ -424,7 +424,7 @@ Requires NO permissions:
424
424
 
425
425
 
426
426
  ### Example
427
- ~~~ruby
427
+ ```{"language":"ruby"}
428
428
  # load the gem
429
429
  require 'purecloudplatformclientv2'
430
430
  # setup authorization
@@ -450,7 +450,7 @@ begin
450
450
  rescue PureCloud::ApiError => e
451
451
  puts "Exception when calling LanguagesApi->get_languages_translations_organization: #{e}"
452
452
  end
453
- ~~~
453
+ ```
454
454
 
455
455
  ### Parameters
456
456
 
@@ -473,7 +473,7 @@ Name | Type | Description | Notes
473
473
 
474
474
  <a name="get_languages_translations_user"></a>
475
475
 
476
- ## -Hash&lt;String, Object&gt;** get_languages_translations_user(user_id)
476
+ ## Hash&lt;String, Object&gt;** get_languages_translations_user(user_id)
477
477
 
478
478
 
479
479
 
@@ -488,7 +488,7 @@ Requires NO permissions:
488
488
 
489
489
 
490
490
  ### Example
491
- ~~~ruby
491
+ ```{"language":"ruby"}
492
492
  # load the gem
493
493
  require 'purecloudplatformclientv2'
494
494
  # setup authorization
@@ -514,7 +514,7 @@ begin
514
514
  rescue PureCloud::ApiError => e
515
515
  puts "Exception when calling LanguagesApi->get_languages_translations_user: #{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="get_routing_language"></a>
539
539
 
540
- ## -[**Language**](Language.html) get_routing_language(language_id)
540
+ ## [**Language**](Language.html) get_routing_language(language_id)
541
541
 
542
542
 
543
543
 
@@ -552,7 +552,7 @@ Requires NO permissions:
552
552
 
553
553
 
554
554
  ### Example
555
- ~~~ruby
555
+ ```{"language":"ruby"}
556
556
  # load the gem
557
557
  require 'purecloudplatformclientv2'
558
558
  # setup authorization
@@ -578,7 +578,7 @@ begin
578
578
  rescue PureCloud::ApiError => e
579
579
  puts "Exception when calling LanguagesApi->get_routing_language: #{e}"
580
580
  end
581
- ~~~
581
+ ```
582
582
 
583
583
  ### Parameters
584
584
 
@@ -601,7 +601,7 @@ Name | Type | Description | Notes
601
601
 
602
602
  <a name="post_languages"></a>
603
603
 
604
- ## -[**Language**](Language.html) post_languages(body)
604
+ ## [**Language**](Language.html) post_languages(body)
605
605
 
606
606
  <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
607
607
 
@@ -617,7 +617,7 @@ Requires ANY permissions:
617
617
 
618
618
 
619
619
  ### Example
620
- ~~~ruby
620
+ ```{"language":"ruby"}
621
621
  # load the gem
622
622
  require 'purecloudplatformclientv2'
623
623
  # setup authorization
@@ -643,7 +643,7 @@ begin
643
643
  rescue PureCloud::ApiError => e
644
644
  puts "Exception when calling LanguagesApi->post_languages: #{e}"
645
645
  end
646
- ~~~
646
+ ```
647
647
 
648
648
  ### Parameters
649
649
 
data/docs/LicenseApi.md CHANGED
@@ -20,7 +20,7 @@ Method | Description
20
20
 
21
21
  <a name="get_license_definition"></a>
22
22
 
23
- ## -[**LicenseDefinition**](LicenseDefinition.html) get_license_definition(license_id)
23
+ ## [**LicenseDefinition**](LicenseDefinition.html) get_license_definition(license_id)
24
24
 
25
25
 
26
26
 
@@ -38,7 +38,7 @@ Requires ANY permissions:
38
38
 
39
39
 
40
40
  ### Example
41
- ~~~ruby
41
+ ```{"language":"ruby"}
42
42
  # load the gem
43
43
  require 'purecloudplatformclientv2'
44
44
  # setup authorization
@@ -64,7 +64,7 @@ begin
64
64
  rescue PureCloud::ApiError => e
65
65
  puts "Exception when calling LicenseApi->get_license_definition: #{e}"
66
66
  end
67
- ~~~
67
+ ```
68
68
 
69
69
  ### Parameters
70
70
 
@@ -87,7 +87,7 @@ Name | Type | Description | Notes
87
87
 
88
88
  <a name="get_license_definitions"></a>
89
89
 
90
- ## -[**Array&lt;LicenseDefinition&gt;**](LicenseDefinition.html) get_license_definitions
90
+ ## [**Array&lt;LicenseDefinition&gt;**](LicenseDefinition.html) get_license_definitions
91
91
 
92
92
 
93
93
 
@@ -105,7 +105,7 @@ Requires ANY permissions:
105
105
 
106
106
 
107
107
  ### Example
108
- ~~~ruby
108
+ ```{"language":"ruby"}
109
109
  # load the gem
110
110
  require 'purecloudplatformclientv2'
111
111
  # setup authorization
@@ -128,7 +128,7 @@ begin
128
128
  rescue PureCloud::ApiError => e
129
129
  puts "Exception when calling LicenseApi->get_license_definitions: #{e}"
130
130
  end
131
- ~~~
131
+ ```
132
132
 
133
133
  ### Parameters
134
134
  This endpoint does not need any parameter.
@@ -148,7 +148,7 @@ This endpoint does not need any parameter.
148
148
 
149
149
  <a name="get_license_organization"></a>
150
150
 
151
- ## -[**LicenseOrganization**](LicenseOrganization.html) get_license_organization
151
+ ## [**LicenseOrganization**](LicenseOrganization.html) get_license_organization
152
152
 
153
153
 
154
154
 
@@ -166,7 +166,7 @@ Requires ANY 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 LicenseApi->get_license_organization: #{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_license_toggle"></a>
211
211
 
212
- ## -[**LicenseOrgToggle**](LicenseOrgToggle.html) get_license_toggle(feature_name)
212
+ ## [**LicenseOrgToggle**](LicenseOrgToggle.html) get_license_toggle(feature_name)
213
213
 
214
214
 
215
215
 
@@ -227,7 +227,7 @@ Requires ANY permissions:
227
227
 
228
228
 
229
229
  ### Example
230
- ~~~ruby
230
+ ```{"language":"ruby"}
231
231
  # load the gem
232
232
  require 'purecloudplatformclientv2'
233
233
  # setup authorization
@@ -253,7 +253,7 @@ begin
253
253
  rescue PureCloud::ApiError => e
254
254
  puts "Exception when calling LicenseApi->get_license_toggle: #{e}"
255
255
  end
256
- ~~~
256
+ ```
257
257
 
258
258
  ### Parameters
259
259
 
@@ -276,7 +276,7 @@ Name | Type | Description | Notes
276
276
 
277
277
  <a name="get_license_user"></a>
278
278
 
279
- ## -[**LicenseUser**](LicenseUser.html) get_license_user(user_id)
279
+ ## [**LicenseUser**](LicenseUser.html) get_license_user(user_id)
280
280
 
281
281
 
282
282
 
@@ -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
@@ -320,7 +320,7 @@ begin
320
320
  rescue PureCloud::ApiError => e
321
321
  puts "Exception when calling LicenseApi->get_license_user: #{e}"
322
322
  end
323
- ~~~
323
+ ```
324
324
 
325
325
  ### Parameters
326
326
 
@@ -343,7 +343,7 @@ Name | Type | Description | Notes
343
343
 
344
344
  <a name="post_license_organization"></a>
345
345
 
346
- ## -[**Array&lt;LicenseUpdateStatus&gt;**](LicenseUpdateStatus.html) post_license_organization(opts)
346
+ ## [**Array&lt;LicenseUpdateStatus&gt;**](LicenseUpdateStatus.html) post_license_organization(opts)
347
347
 
348
348
 
349
349
 
@@ -361,7 +361,7 @@ Requires ANY permissions:
361
361
 
362
362
 
363
363
  ### Example
364
- ~~~ruby
364
+ ```{"language":"ruby"}
365
365
  # load the gem
366
366
  require 'purecloudplatformclientv2'
367
367
  # setup authorization
@@ -388,7 +388,7 @@ begin
388
388
  rescue PureCloud::ApiError => e
389
389
  puts "Exception when calling LicenseApi->post_license_organization: #{e}"
390
390
  end
391
- ~~~
391
+ ```
392
392
 
393
393
  ### Parameters
394
394
 
@@ -411,7 +411,7 @@ Name | Type | Description | Notes
411
411
 
412
412
  <a name="post_license_toggle"></a>
413
413
 
414
- ## -[**LicenseOrgToggle**](LicenseOrgToggle.html) post_license_toggle(feature_name)
414
+ ## [**LicenseOrgToggle**](LicenseOrgToggle.html) post_license_toggle(feature_name)
415
415
 
416
416
 
417
417
 
@@ -429,7 +429,7 @@ Requires ANY permissions:
429
429
 
430
430
 
431
431
  ### Example
432
- ~~~ruby
432
+ ```{"language":"ruby"}
433
433
  # load the gem
434
434
  require 'purecloudplatformclientv2'
435
435
  # setup authorization
@@ -455,7 +455,7 @@ begin
455
455
  rescue PureCloud::ApiError => e
456
456
  puts "Exception when calling LicenseApi->post_license_toggle: #{e}"
457
457
  end
458
- ~~~
458
+ ```
459
459
 
460
460
  ### Parameters
461
461
 
@@ -478,7 +478,7 @@ Name | Type | Description | Notes
478
478
 
479
479
  <a name="post_license_users"></a>
480
480
 
481
- ## -Hash&lt;String, Object&gt;** post_license_users(opts)
481
+ ## Hash&lt;String, Object&gt;** post_license_users(opts)
482
482
 
483
483
 
484
484
 
@@ -493,7 +493,7 @@ Requires NO permissions:
493
493
 
494
494
 
495
495
  ### Example
496
- ~~~ruby
496
+ ```{"language":"ruby"}
497
497
  # load the gem
498
498
  require 'purecloudplatformclientv2'
499
499
  # setup authorization
@@ -520,7 +520,7 @@ begin
520
520
  rescue PureCloud::ApiError => e
521
521
  puts "Exception when calling LicenseApi->post_license_users: #{e}"
522
522
  end
523
- ~~~
523
+ ```
524
524
 
525
525
  ### Parameters
526
526