purecloudplatformclientv2 35.0.0 → 36.0.0

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 (82) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdditionalMessage.md +2 -0
  4. data/docs/AlertingApi.md +0 -2
  5. data/docs/AnalyticsApi.md +0 -13
  6. data/docs/ArchitectApi.md +210 -150
  7. data/docs/AttributesApi.md +0 -6
  8. data/docs/AuthorizationApi.md +15 -7
  9. data/docs/BillingApi.md +4 -1
  10. data/docs/CampaignDivisionView.md +1 -1
  11. data/docs/ContentManagementApi.md +0 -38
  12. data/docs/ConversationsApi.md +141 -75
  13. data/docs/CreateQueueRequest.md +1 -1
  14. data/docs/Division.md +15 -0
  15. data/docs/FaxApi.md +0 -6
  16. data/docs/Flow.md +1 -1
  17. data/docs/FlowDivisionView.md +1 -0
  18. data/docs/FreeSeatingConfiguration.md +1 -1
  19. data/docs/GeolocationApi.md +0 -3
  20. data/docs/GreetingsApi.md +0 -16
  21. data/docs/GroupsApi.md +2 -12
  22. data/docs/IdentityProviderApi.md +18 -9
  23. data/docs/IntegrationsApi.md +26 -31
  24. data/docs/LanguagesApi.md +0 -4
  25. data/docs/LicenseApi.md +21 -8
  26. data/docs/LocationsApi.md +0 -3
  27. data/docs/ManagementUnit.md +1 -0
  28. data/docs/MessageData.md +1 -0
  29. data/docs/MessageDetails.md +1 -0
  30. data/docs/MessageMedia.md +3 -0
  31. data/docs/MessageMediaData.md +20 -0
  32. data/docs/MessageSticker.md +14 -0
  33. data/docs/MobileDevicesApi.md +0 -5
  34. data/docs/NotificationsApi.md +0 -7
  35. data/docs/OrganizationApi.md +0 -2
  36. data/docs/OrganizationAuthorizationApi.md +16 -6
  37. data/docs/OutboundApi.md +8 -6
  38. data/docs/OutboundSettings.md +1 -0
  39. data/docs/PresenceApi.md +0 -5
  40. data/docs/QualityApi.md +0 -21
  41. data/docs/Queue.md +1 -1
  42. data/docs/RecordingApi.md +0 -17
  43. data/docs/ResponseManagementApi.md +0 -11
  44. data/docs/RoutingApi.md +93 -9
  45. data/docs/SearchApi.md +0 -14
  46. data/docs/StationsApi.md +0 -3
  47. data/docs/SuggestApi.md +0 -4
  48. data/docs/SurveyForm.md +3 -1
  49. data/docs/TelephonyProvidersEdgeApi.md +4 -16
  50. data/docs/TokensApi.md +0 -2
  51. data/docs/UserQueue.md +1 -1
  52. data/docs/UserRecordingsApi.md +0 -6
  53. data/docs/UsersApi.md +31 -42
  54. data/docs/UtilitiesApi.md +0 -3
  55. data/docs/VoicemailApi.md +8 -21
  56. data/docs/WorkforceManagementApi.md +25 -4
  57. data/lib/purecloudplatformclientv2.rb +3 -0
  58. data/lib/purecloudplatformclientv2/api/architect_api.rb +136 -102
  59. data/lib/purecloudplatformclientv2/api/conversations_api.rb +160 -0
  60. data/lib/purecloudplatformclientv2/api/routing_api.rb +122 -0
  61. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +22 -0
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/additional_message.rb +60 -4
  64. data/lib/purecloudplatformclientv2/models/campaign_division_view.rb +1 -1
  65. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  66. data/lib/purecloudplatformclientv2/models/division.rb +253 -0
  67. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  68. data/lib/purecloudplatformclientv2/models/flow.rb +1 -1
  69. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +27 -1
  70. data/lib/purecloudplatformclientv2/models/free_seating_configuration.rb +23 -9
  71. data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +29 -1
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
  74. data/lib/purecloudplatformclientv2/models/message_media.rb +82 -4
  75. data/lib/purecloudplatformclientv2/models/message_media_data.rb +411 -0
  76. data/lib/purecloudplatformclientv2/models/message_sticker.rb +228 -0
  77. data/lib/purecloudplatformclientv2/models/outbound_settings.rb +27 -1
  78. data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
  79. data/lib/purecloudplatformclientv2/models/survey_form.rb +53 -1
  80. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
  81. data/lib/purecloudplatformclientv2/version.rb +1 -1
  82. metadata +8 -2
@@ -76,7 +76,6 @@ Requires NO permissions:
76
76
 
77
77
 
78
78
 
79
-
80
79
  ### Example
81
80
  ~~~ruby
82
81
  # load the gem
@@ -144,7 +143,6 @@ Requires NO permissions:
144
143
 
145
144
 
146
145
 
147
-
148
146
  ### Example
149
147
  ~~~ruby
150
148
  # load the gem
@@ -408,7 +406,6 @@ Requires NO permissions:
408
406
 
409
407
 
410
408
 
411
-
412
409
  ### Example
413
410
  ~~~ruby
414
411
  # load the gem
@@ -472,7 +469,6 @@ Requires NO permissions:
472
469
 
473
470
 
474
471
 
475
-
476
472
  ### Example
477
473
  ~~~ruby
478
474
  # load the gem
@@ -536,7 +532,6 @@ Requires NO permissions:
536
532
 
537
533
 
538
534
 
539
-
540
535
  ### Example
541
536
  ~~~ruby
542
537
  # load the gem
@@ -624,7 +619,6 @@ Requires NO permissions:
624
619
 
625
620
 
626
621
 
627
-
628
622
  ### Example
629
623
  ~~~ruby
630
624
  # load the gem
@@ -695,7 +689,6 @@ Requires NO permissions:
695
689
 
696
690
 
697
691
 
698
-
699
692
  ### Example
700
693
  ~~~ruby
701
694
  # load the gem
@@ -780,7 +773,6 @@ Requires NO permissions:
780
773
 
781
774
 
782
775
 
783
-
784
776
  ### Example
785
777
  ~~~ruby
786
778
  # load the gem
@@ -863,7 +855,6 @@ Requires NO permissions:
863
855
 
864
856
 
865
857
 
866
-
867
858
  ### Example
868
859
  ~~~ruby
869
860
  # load the gem
@@ -935,7 +926,6 @@ Requires NO permissions:
935
926
 
936
927
 
937
928
 
938
-
939
929
  ### Example
940
930
  ~~~ruby
941
931
  # load the gem
@@ -1035,7 +1025,6 @@ Requires NO permissions:
1035
1025
 
1036
1026
 
1037
1027
 
1038
-
1039
1028
  ### Example
1040
1029
  ~~~ruby
1041
1030
  # load the gem
@@ -1763,7 +1752,6 @@ Requires NO permissions:
1763
1752
 
1764
1753
 
1765
1754
 
1766
-
1767
1755
  ### Example
1768
1756
  ~~~ruby
1769
1757
  # load the gem
@@ -1828,7 +1816,6 @@ Requires NO permissions:
1828
1816
 
1829
1817
 
1830
1818
 
1831
-
1832
1819
  ### Example
1833
1820
  ~~~ruby
1834
1821
  # load the gem
@@ -2450,7 +2437,6 @@ Requires NO permissions:
2450
2437
 
2451
2438
 
2452
2439
 
2453
-
2454
2440
  ### Example
2455
2441
  ~~~ruby
2456
2442
  # load the gem
@@ -2519,7 +2505,6 @@ Requires NO permissions:
2519
2505
 
2520
2506
 
2521
2507
 
2522
-
2523
2508
  ### Example
2524
2509
  ~~~ruby
2525
2510
  # load the gem
@@ -2591,7 +2576,6 @@ Requires NO permissions:
2591
2576
 
2592
2577
 
2593
2578
 
2594
-
2595
2579
  ### Example
2596
2580
  ~~~ruby
2597
2581
  # load the gem
@@ -2851,7 +2835,6 @@ Requires NO permissions:
2851
2835
 
2852
2836
 
2853
2837
 
2854
-
2855
2838
  ### Example
2856
2839
  ~~~ruby
2857
2840
  # load the gem
@@ -3115,7 +3098,6 @@ Requires NO permissions:
3115
3098
 
3116
3099
 
3117
3100
 
3118
-
3119
3101
  ### Example
3120
3102
  ~~~ruby
3121
3103
  # load the gem
@@ -3181,7 +3163,6 @@ Requires NO permissions:
3181
3163
 
3182
3164
 
3183
3165
 
3184
-
3185
3166
  ### Example
3186
3167
  ~~~ruby
3187
3168
  # load the gem
@@ -3249,7 +3230,6 @@ Requires NO permissions:
3249
3230
 
3250
3231
 
3251
3232
 
3252
-
3253
3233
  ### Example
3254
3234
  ~~~ruby
3255
3235
  # load the gem
@@ -3528,7 +3508,6 @@ Requires NO permissions:
3528
3508
 
3529
3509
 
3530
3510
 
3531
-
3532
3511
  ### Example
3533
3512
  ~~~ruby
3534
3513
  # load the gem
@@ -9,7 +9,7 @@ title: Queue
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **division** | [**UriReference**](UriReference.html) | The division to which this entity belongs. | [optional] |
12
+ | **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
13
13
  | **description** | **String** | The queue description. | [optional] |
14
14
  | **version** | **Integer** | The current version of the queue. | [optional] |
15
15
  | **date_created** | **DateTime** | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -63,7 +63,6 @@ Requires NO permissions:
63
63
 
64
64
 
65
65
 
66
-
67
66
  ### Example
68
67
  ~~~ruby
69
68
  # load the gem
@@ -326,7 +325,6 @@ Requires NO permissions:
326
325
 
327
326
 
328
327
 
329
-
330
328
  ### Example
331
329
  ~~~ruby
332
330
  # load the gem
@@ -402,7 +400,6 @@ Requires NO permissions:
402
400
 
403
401
 
404
402
 
405
-
406
403
  ### Example
407
404
  ~~~ruby
408
405
  # load the gem
@@ -473,7 +470,6 @@ Requires NO permissions:
473
470
 
474
471
 
475
472
 
476
-
477
473
  ### Example
478
474
  ~~~ruby
479
475
  # load the gem
@@ -541,7 +537,6 @@ Requires NO permissions:
541
537
 
542
538
 
543
539
 
544
-
545
540
  ### Example
546
541
  ~~~ruby
547
542
  # load the gem
@@ -606,7 +601,6 @@ Requires NO permissions:
606
601
 
607
602
 
608
603
 
609
-
610
604
  ### Example
611
605
  ~~~ruby
612
606
  # load the gem
@@ -674,7 +668,6 @@ Requires NO permissions:
674
668
 
675
669
 
676
670
 
677
-
678
671
  ### Example
679
672
  ~~~ruby
680
673
  # load the gem
@@ -810,7 +803,6 @@ Requires NO permissions:
810
803
 
811
804
 
812
805
 
813
-
814
806
  ### Example
815
807
  ~~~ruby
816
808
  # load the gem
@@ -963,7 +955,6 @@ Requires NO permissions:
963
955
 
964
956
 
965
957
 
966
-
967
958
  ### Example
968
959
  ~~~ruby
969
960
  # load the gem
@@ -1428,7 +1419,6 @@ Requires NO permissions:
1428
1419
 
1429
1420
 
1430
1421
 
1431
-
1432
1422
  ### Example
1433
1423
  ~~~ruby
1434
1424
  # load the gem
@@ -1494,7 +1484,6 @@ Requires NO permissions:
1494
1484
 
1495
1485
 
1496
1486
 
1497
-
1498
1487
  ### Example
1499
1488
  ~~~ruby
1500
1489
  # load the gem
@@ -1630,7 +1619,6 @@ Requires NO permissions:
1630
1619
 
1631
1620
 
1632
1621
 
1633
-
1634
1622
  ### Example
1635
1623
  ~~~ruby
1636
1624
  # load the gem
@@ -1698,7 +1686,6 @@ Requires NO permissions:
1698
1686
 
1699
1687
 
1700
1688
 
1701
-
1702
1689
  ### Example
1703
1690
  ~~~ruby
1704
1691
  # load the gem
@@ -1769,7 +1756,6 @@ Requires NO permissions:
1769
1756
 
1770
1757
 
1771
1758
 
1772
-
1773
1759
  ### Example
1774
1760
  ~~~ruby
1775
1761
  # load the gem
@@ -2088,7 +2074,6 @@ Requires NO permissions:
2088
2074
 
2089
2075
 
2090
2076
 
2091
-
2092
2077
  ### Example
2093
2078
  ~~~ruby
2094
2079
  # load the gem
@@ -2159,7 +2144,6 @@ Requires NO permissions:
2159
2144
 
2160
2145
 
2161
2146
 
2162
-
2163
2147
  ### Example
2164
2148
  ~~~ruby
2165
2149
  # load the gem
@@ -2503,7 +2487,6 @@ Requires NO permissions:
2503
2487
 
2504
2488
 
2505
2489
 
2506
-
2507
2490
  ### Example
2508
2491
  ~~~ruby
2509
2492
  # load the gem
@@ -37,7 +37,6 @@ Requires NO permissions:
37
37
 
38
38
 
39
39
 
40
-
41
40
  ### Example
42
41
  ~~~ruby
43
42
  # load the gem
@@ -101,7 +100,6 @@ Requires NO permissions:
101
100
 
102
101
 
103
102
 
104
-
105
103
  ### Example
106
104
  ~~~ruby
107
105
  # load the gem
@@ -165,7 +163,6 @@ Requires NO permissions:
165
163
 
166
164
 
167
165
 
168
-
169
166
  ### Example
170
167
  ~~~ruby
171
168
  # load the gem
@@ -233,7 +230,6 @@ Requires NO permissions:
233
230
 
234
231
 
235
232
 
236
-
237
233
  ### Example
238
234
  ~~~ruby
239
235
  # load the gem
@@ -298,7 +294,6 @@ Requires NO permissions:
298
294
 
299
295
 
300
296
 
301
-
302
297
  ### Example
303
298
  ~~~ruby
304
299
  # load the gem
@@ -367,7 +362,6 @@ Requires NO permissions:
367
362
 
368
363
 
369
364
 
370
-
371
365
  ### Example
372
366
  ~~~ruby
373
367
  # load the gem
@@ -440,7 +434,6 @@ Requires NO permissions:
440
434
 
441
435
 
442
436
 
443
-
444
437
  ### Example
445
438
  ~~~ruby
446
439
  # load the gem
@@ -505,7 +498,6 @@ Requires NO permissions:
505
498
 
506
499
 
507
500
 
508
-
509
501
  ### Example
510
502
  ~~~ruby
511
503
  # load the gem
@@ -574,7 +566,6 @@ Requires NO permissions:
574
566
 
575
567
 
576
568
 
577
-
578
569
  ### Example
579
570
  ~~~ruby
580
571
  # load the gem
@@ -639,7 +630,6 @@ Requires NO permissions:
639
630
 
640
631
 
641
632
 
642
-
643
633
  ### Example
644
634
  ~~~ruby
645
635
  # load the gem
@@ -707,7 +697,6 @@ Requires NO permissions:
707
697
 
708
698
 
709
699
 
710
-
711
700
  ### Example
712
701
  ~~~ruby
713
702
  # load the gem
@@ -33,6 +33,7 @@ Method | Description
33
33
  [**get_routing_queue_users**](RoutingApi.html#get_routing_queue_users) | Get the members of this queue
34
34
  [**get_routing_queue_wrapupcodes**](RoutingApi.html#get_routing_queue_wrapupcodes) | Get the wrap-up codes for a queue
35
35
  [**get_routing_queues**](RoutingApi.html#get_routing_queues) | Get list of queues.
36
+ [**get_routing_queues_search**](RoutingApi.html#get_routing_queues_search) | Search for queues by name
36
37
  [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
37
38
  [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
38
39
  [**get_routing_sms_availablephonenumbers**](RoutingApi.html#get_routing_sms_availablephonenumbers) | Get a list of available phone numbers for SMS provisioning.
@@ -665,7 +666,8 @@ Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId}
665
666
 
666
667
  Requires ANY permissions:
667
668
 
668
- * routing:skill:assign* admin
669
+ * routing:skill:assign
670
+ * admin
669
671
 
670
672
 
671
673
  ### Example
@@ -732,7 +734,8 @@ Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
732
734
 
733
735
  Requires ANY permissions:
734
736
 
735
- * routing:skill:assign* admin
737
+ * routing:skill:assign
738
+ * admin
736
739
 
737
740
 
738
741
  ### Example
@@ -1746,6 +1749,84 @@ Name | Type | Description | Notes
1746
1749
 
1747
1750
 
1748
1751
 
1752
+ <a name="get_routing_queues_search"></a>
1753
+
1754
+ ## -[**QueueEntityListing**](QueueEntityListing.html) get_routing_queues_search(opts)
1755
+
1756
+
1757
+
1758
+ Search for queues by name
1759
+
1760
+
1761
+
1762
+ Wraps GET /api/v2/routing/queues/search
1763
+
1764
+ Requires ANY permissions:
1765
+
1766
+ * routing:queue:search
1767
+
1768
+
1769
+ ### Example
1770
+ ~~~ruby
1771
+ # load the gem
1772
+ require 'purecloudplatformclientv2'
1773
+ # setup authorization
1774
+ @secret = ENV['PURECLOUD_SECRET']
1775
+ @id = ENV['PURECLOUD_CLIENT_ID']
1776
+ environment = "mypurecloud.com"
1777
+
1778
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1779
+
1780
+ PureCloud.configure do |config|
1781
+ config.access_token = @authToken
1782
+ end
1783
+
1784
+ api_instance = PureCloud::RoutingApi.new
1785
+
1786
+ opts = {
1787
+ page_size: 25, # Integer | Page size
1788
+ page_number: 1, # Integer | Page number
1789
+ sort_by: "name", # String | Sort by
1790
+ sort_order: "asc", # String | Sort order
1791
+ name: "name_example", # String | Name
1792
+ id: ["id_example"], # Array<String> | Queue ID(s)
1793
+ division_id: ["division_id_example"] # Array<String> | Division ID(s)
1794
+ }
1795
+
1796
+ begin
1797
+ #Search for queues by name
1798
+ result = api_instance.get_routing_queues_search(opts)
1799
+ p result
1800
+ rescue PureCloud::ApiError => e
1801
+ puts "Exception when calling RoutingApi->get_routing_queues_search: #{e}"
1802
+ end
1803
+ ~~~
1804
+
1805
+ ### Parameters
1806
+
1807
+ Name | Type | Description | Notes
1808
+ ------------- | ------------- | ------------- | -------------
1809
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1810
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1811
+ **sort_by** | **String**| Sort by | [optional] [default to name] |
1812
+ **sort_order** | **String**| Sort order | [optional] [default to asc]<br />**Values**: asc, desc, score |
1813
+ **name** | **String**| Name | [optional] |
1814
+ **id** | [**Array&lt;String&gt;**](String.html)| Queue ID(s) | [optional] |
1815
+ **division_id** | [**Array&lt;String&gt;**](String.html)| Division ID(s) | [optional] |
1816
+ {: class="table table-striped"}
1817
+
1818
+
1819
+ ### Return type
1820
+
1821
+ [**QueueEntityListing**](QueueEntityListing.html)
1822
+
1823
+ ### HTTP request headers
1824
+
1825
+ - **Content-Type**: application/json
1826
+ - **Accept**: application/json
1827
+
1828
+
1829
+
1749
1830
  <a name="get_routing_skill"></a>
1750
1831
 
1751
1832
  ## -[**RoutingSkill**](RoutingSkill.html) get_routing_skill(skill_id)
@@ -2114,7 +2195,8 @@ Wraps GET /api/v2/routing/utilization
2114
2195
 
2115
2196
  Requires ANY permissions:
2116
2197
 
2117
- * routing:utilization:manage* routing:utilization:view
2198
+ * routing:utilization:manage
2199
+ * routing:utilization:view
2118
2200
 
2119
2201
 
2120
2202
  ### Example
@@ -2312,7 +2394,6 @@ Requires NO permissions:
2312
2394
 
2313
2395
 
2314
2396
 
2315
-
2316
2397
  ### Example
2317
2398
  ~~~ruby
2318
2399
  # load the gem
@@ -2385,7 +2466,6 @@ Requires NO permissions:
2385
2466
 
2386
2467
 
2387
2468
 
2388
-
2389
2469
  ### Example
2390
2470
  ~~~ruby
2391
2471
  # load the gem
@@ -2595,7 +2675,8 @@ Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId}
2595
2675
 
2596
2676
  Requires ANY permissions:
2597
2677
 
2598
- * routing:skill:assign* admin
2678
+ * routing:skill:assign
2679
+ * admin
2599
2680
 
2600
2681
 
2601
2682
  ### Example
@@ -3394,7 +3475,8 @@ Wraps POST /api/v2/users/{userId}/routinglanguages
3394
3475
 
3395
3476
  Requires ANY permissions:
3396
3477
 
3397
- * routing:skill:assign* admin
3478
+ * routing:skill:assign
3479
+ * admin
3398
3480
 
3399
3481
 
3400
3482
  ### Example
@@ -3462,7 +3544,8 @@ Wraps POST /api/v2/users/{userId}/routingskills
3462
3544
 
3463
3545
  Requires ANY permissions:
3464
3546
 
3465
- * routing:skill:assign* admin
3547
+ * routing:skill:assign
3548
+ * admin
3466
3549
 
3467
3550
 
3468
3551
  ### Example
@@ -3938,7 +4021,8 @@ Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
3938
4021
 
3939
4022
  Requires ANY permissions:
3940
4023
 
3941
- * routing:skill:assign* admin
4024
+ * routing:skill:assign
4025
+ * admin
3942
4026
 
3943
4027
 
3944
4028
  ### Example