purecloudplatformclientv2 47.0.0 → 48.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 (99) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/docs/AnalyticsApi.md +66 -0
  4. data/docs/AnalyticsSession.md +1 -1
  5. data/docs/AuthorizationApi.md +9 -5
  6. data/docs/Condition.md +4 -4
  7. data/docs/ContactColumnToDataActionFieldMapping.md +12 -0
  8. data/docs/ConversationProperties.md +21 -0
  9. data/docs/DataActionConditionPredicate.md +12 -0
  10. data/docs/GroupsApi.md +1 -1
  11. data/docs/OrgUser.md +1 -0
  12. data/docs/OutboundApi.md +2 -2
  13. data/docs/QualityApi.md +376 -0
  14. data/docs/RoutingApi.md +85 -12
  15. data/docs/ScorableSurvey.md +18 -0
  16. data/docs/SearchApi.md +2 -42
  17. data/docs/SuggestApi.md +2 -2
  18. data/docs/Survey.md +22 -0
  19. data/docs/SurveyFormAndScoringSet.md +14 -0
  20. data/docs/SurveyQuestionGroupScore.md +17 -0
  21. data/docs/SurveyQuestionScore.md +19 -0
  22. data/docs/SurveyScoringSet.md +15 -0
  23. data/docs/Token.md +13 -0
  24. data/docs/TrustUser.md +1 -0
  25. data/docs/User.md +1 -0
  26. data/docs/UserMe.md +1 -0
  27. data/docs/UsersApi.md +8 -8
  28. data/docs/UtilitiesApi.md +59 -0
  29. data/docs/ViewFilter.md +13 -0
  30. data/lib/purecloudplatformclientv2.rb +10 -0
  31. data/lib/purecloudplatformclientv2/api/alerting_api.rb +11 -11
  32. data/lib/purecloudplatformclientv2/api/analytics_api.rb +91 -26
  33. data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -81
  34. data/lib/purecloudplatformclientv2/api/attributes_api.rb +6 -6
  35. data/lib/purecloudplatformclientv2/api/authorization_api.rb +45 -36
  36. data/lib/purecloudplatformclientv2/api/billing_api.rb +2 -2
  37. data/lib/purecloudplatformclientv2/api/content_management_api.rb +38 -38
  38. data/lib/purecloudplatformclientv2/api/conversations_api.rb +100 -100
  39. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +30 -30
  40. data/lib/purecloudplatformclientv2/api/fax_api.rb +6 -6
  41. data/lib/purecloudplatformclientv2/api/flows_api.rb +1 -1
  42. data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +4 -4
  43. data/lib/purecloudplatformclientv2/api/geolocation_api.rb +4 -4
  44. data/lib/purecloudplatformclientv2/api/greetings_api.rb +16 -16
  45. data/lib/purecloudplatformclientv2/api/groups_api.rb +14 -14
  46. data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +28 -28
  47. data/lib/purecloudplatformclientv2/api/integrations_api.rb +41 -41
  48. data/lib/purecloudplatformclientv2/api/languages_api.rb +10 -10
  49. data/lib/purecloudplatformclientv2/api/license_api.rb +8 -8
  50. data/lib/purecloudplatformclientv2/api/locations_api.rb +4 -4
  51. data/lib/purecloudplatformclientv2/api/messaging_api.rb +14 -14
  52. data/lib/purecloudplatformclientv2/api/mobile_devices_api.rb +5 -5
  53. data/lib/purecloudplatformclientv2/api/notifications_api.rb +7 -7
  54. data/lib/purecloudplatformclientv2/api/o_auth_api.rb +6 -6
  55. data/lib/purecloudplatformclientv2/api/objects_api.rb +8 -8
  56. data/lib/purecloudplatformclientv2/api/organization_api.rb +4 -4
  57. data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +23 -23
  58. data/lib/purecloudplatformclientv2/api/outbound_api.rb +98 -98
  59. data/lib/purecloudplatformclientv2/api/presence_api.rb +9 -9
  60. data/lib/purecloudplatformclientv2/api/quality_api.rb +450 -52
  61. data/lib/purecloudplatformclientv2/api/recording_api.rb +37 -37
  62. data/lib/purecloudplatformclientv2/api/response_management_api.rb +11 -11
  63. data/lib/purecloudplatformclientv2/api/routing_api.rb +173 -70
  64. data/lib/purecloudplatformclientv2/api/scripts_api.rb +11 -11
  65. data/lib/purecloudplatformclientv2/api/search_api.rb +16 -16
  66. data/lib/purecloudplatformclientv2/api/stations_api.rb +5 -5
  67. data/lib/purecloudplatformclientv2/api/suggest_api.rb +4 -4
  68. data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +125 -125
  69. data/lib/purecloudplatformclientv2/api/tokens_api.rb +2 -2
  70. data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +6 -6
  71. data/lib/purecloudplatformclientv2/api/users_api.rb +61 -61
  72. data/lib/purecloudplatformclientv2/api/utilities_api.rb +58 -3
  73. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +24 -24
  74. data/lib/purecloudplatformclientv2/api/web_chat_api.rb +8 -8
  75. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -64
  76. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  77. data/lib/purecloudplatformclientv2/configuration.rb +9 -2
  78. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  79. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
  80. data/lib/purecloudplatformclientv2/models/analytics_session.rb +1 -1
  81. data/lib/purecloudplatformclientv2/models/condition.rb +6 -6
  82. data/lib/purecloudplatformclientv2/models/contact_column_to_data_action_field_mapping.rb +176 -0
  83. data/lib/purecloudplatformclientv2/models/conversation_properties.rb +410 -0
  84. data/lib/purecloudplatformclientv2/models/data_action_condition_predicate.rb +176 -0
  85. data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/org_user.rb +27 -1
  87. data/lib/purecloudplatformclientv2/models/scorable_survey.rb +343 -0
  88. data/lib/purecloudplatformclientv2/models/survey.rb +444 -0
  89. data/lib/purecloudplatformclientv2/models/survey_form_and_scoring_set.rb +226 -0
  90. data/lib/purecloudplatformclientv2/models/survey_question_group_score.rb +303 -0
  91. data/lib/purecloudplatformclientv2/models/survey_question_score.rb +351 -0
  92. data/lib/purecloudplatformclientv2/models/survey_scoring_set.rb +253 -0
  93. data/lib/purecloudplatformclientv2/models/token.rb +207 -0
  94. data/lib/purecloudplatformclientv2/models/trust_user.rb +27 -1
  95. data/lib/purecloudplatformclientv2/models/user.rb +27 -1
  96. data/lib/purecloudplatformclientv2/models/user_me.rb +27 -1
  97. data/lib/purecloudplatformclientv2/models/view_filter.rb +354 -4
  98. data/lib/purecloudplatformclientv2/version.rb +1 -1
  99. metadata +22 -2
data/docs/RoutingApi.md CHANGED
@@ -33,7 +33,8 @@ 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_divisionviews**](RoutingApi.html#get_routing_queues_divisionviews) | Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
36
+ [**get_routing_queues_divisionviews**](RoutingApi.html#get_routing_queues_divisionviews) | Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
37
+ [**get_routing_queues_divisionviews_all**](RoutingApi.html#get_routing_queues_divisionviews_all) | Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
37
38
  [**get_routing_queues_me**](RoutingApi.html#get_routing_queues_me) | Get a paged listing of queues the user is a member of.
38
39
  [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
39
40
  [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
@@ -45,7 +46,7 @@ Method | Description
45
46
  [**get_routing_wrapupcodes**](RoutingApi.html#get_routing_wrapupcodes) | Get list of wrapup codes.
46
47
  [**get_user_routinglanguages**](RoutingApi.html#get_user_routinglanguages) | List routing language for user
47
48
  [**get_user_routingskills**](RoutingApi.html#get_user_routingskills) | List routing skills for user
48
- [**patch_routing_queue_user**](RoutingApi.html#patch_routing_queue_user) | Update the ring number of joined status for a User in a Queue
49
+ [**patch_routing_queue_user**](RoutingApi.html#patch_routing_queue_user) | Update the ring number or joined status for a User in a Queue
49
50
  [**patch_routing_queue_users**](RoutingApi.html#patch_routing_queue_users) | Join or unjoin a set of users for a queue
50
51
  [**patch_user_routinglanguage**](RoutingApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
51
52
  [**patch_user_routinglanguages_bulk**](RoutingApi.html#patch_user_routinglanguages_bulk) | Add bulk routing language to user. Max limit 50 languages
@@ -1592,7 +1593,7 @@ Name | Type | Description | Notes
1592
1593
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
1593
1594
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
1594
1595
  **sort_by** | **String**| Sort by | [optional] [default to name] |
1595
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
1596
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
1596
1597
  **joined** | **BOOLEAN**| Filter by joined status | [optional] |
1597
1598
  **name** | **String**| Filter by queue member name | [optional] |
1598
1599
  **profile_skills** | [**Array&lt;String&gt;**](String.html)| Filter by profile skill | [optional] |
@@ -1761,7 +1762,7 @@ Name | Type | Description | Notes
1761
1762
 
1762
1763
 
1763
1764
 
1764
- Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
1765
+ Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
1765
1766
 
1766
1767
 
1767
1768
 
@@ -1790,8 +1791,8 @@ end
1790
1791
  api_instance = PureCloud::RoutingApi.new
1791
1792
 
1792
1793
  opts = {
1793
- page_size: 25, # Integer | Page size
1794
- page_number: 1, # Integer | Page number
1794
+ page_size: 25, # Integer | Page size [max value is 100]
1795
+ page_number: 1, # Integer | Page number [max value is 5]
1795
1796
  sort_by: "name", # String | Sort by
1796
1797
  sort_order: "asc", # String | Sort order
1797
1798
  name: "name_example", # String | Name
@@ -1800,7 +1801,7 @@ opts = {
1800
1801
  }
1801
1802
 
1802
1803
  begin
1803
- #Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
1804
+ #Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
1804
1805
  result = api_instance.get_routing_queues_divisionviews(opts)
1805
1806
  p result
1806
1807
  rescue PureCloud::ApiError => e
@@ -1812,9 +1813,9 @@ end
1812
1813
 
1813
1814
  Name | Type | Description | Notes
1814
1815
  ------------- | ------------- | ------------- | -------------
1815
- **page_size** | **Integer**| Page size | [optional] [default to 25] |
1816
- **page_number** | **Integer**| Page number | [optional] [default to 1] |
1817
- **sort_by** | **String**| Sort by | [optional] [default to name] |
1816
+ **page_size** | **Integer**| Page size [max value is 100] | [optional] [default to 25] |
1817
+ **page_number** | **Integer**| Page number [max value is 5] | [optional] [default to 1] |
1818
+ **sort_by** | **String**| Sort by | [optional] [default to name]<br />**Values**: name, id, divisionId |
1818
1819
  **sort_order** | **String**| Sort order | [optional] [default to asc]<br />**Values**: asc, desc, score |
1819
1820
  **name** | **String**| Name | [optional] |
1820
1821
  **id** | [**Array&lt;String&gt;**](String.html)| Queue ID(s) | [optional] |
@@ -1833,6 +1834,78 @@ Name | Type | Description | Notes
1833
1834
 
1834
1835
 
1835
1836
 
1837
+ <a name="get_routing_queues_divisionviews_all"></a>
1838
+
1839
+ ## -[**QueueEntityListing**](QueueEntityListing.html) get_routing_queues_divisionviews_all(opts)
1840
+
1841
+
1842
+
1843
+ Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
1844
+
1845
+
1846
+
1847
+ Wraps GET /api/v2/routing/queues/divisionviews/all
1848
+
1849
+ Requires ANY permissions:
1850
+
1851
+ * routing:queue:search
1852
+
1853
+
1854
+ ### Example
1855
+ ~~~ruby
1856
+ # load the gem
1857
+ require 'purecloudplatformclientv2'
1858
+ # setup authorization
1859
+ @secret = ENV['PURECLOUD_SECRET']
1860
+ @id = ENV['PURECLOUD_CLIENT_ID']
1861
+ environment = "mypurecloud.com"
1862
+
1863
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1864
+
1865
+ PureCloud.configure do |config|
1866
+ config.access_token = @authToken
1867
+ end
1868
+
1869
+ api_instance = PureCloud::RoutingApi.new
1870
+
1871
+ opts = {
1872
+ page_size: 25, # Integer | Page size [max value is 500]
1873
+ page_number: 1, # Integer | Page number
1874
+ sort_by: "name", # String | Sort by
1875
+ sort_order: "asc" # String | Sort order
1876
+ }
1877
+
1878
+ begin
1879
+ #Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
1880
+ result = api_instance.get_routing_queues_divisionviews_all(opts)
1881
+ p result
1882
+ rescue PureCloud::ApiError => e
1883
+ puts "Exception when calling RoutingApi->get_routing_queues_divisionviews_all: #{e}"
1884
+ end
1885
+ ~~~
1886
+
1887
+ ### Parameters
1888
+
1889
+ Name | Type | Description | Notes
1890
+ ------------- | ------------- | ------------- | -------------
1891
+ **page_size** | **Integer**| Page size [max value is 500] | [optional] [default to 25] |
1892
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1893
+ **sort_by** | **String**| Sort by | [optional] [default to name]<br />**Values**: name, id, divisionId |
1894
+ **sort_order** | **String**| Sort order | [optional] [default to asc]<br />**Values**: asc, desc, score |
1895
+ {: class="table table-striped"}
1896
+
1897
+
1898
+ ### Return type
1899
+
1900
+ [**QueueEntityListing**](QueueEntityListing.html)
1901
+
1902
+ ### HTTP request headers
1903
+
1904
+ - **Content-Type**: application/json
1905
+ - **Accept**: application/json
1906
+
1907
+
1908
+
1836
1909
  <a name="get_routing_queues_me"></a>
1837
1910
 
1838
1911
  ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_routing_queues_me(opts)
@@ -2607,7 +2680,7 @@ Name | Type | Description | Notes
2607
2680
 
2608
2681
 
2609
2682
 
2610
- Update the ring number of joined status for a User in a Queue
2683
+ Update the ring number or joined status for a User in a Queue
2611
2684
 
2612
2685
 
2613
2686
 
@@ -2643,7 +2716,7 @@ body = PureCloud::QueueMember.new # QueueMember | Queue Member
2643
2716
 
2644
2717
 
2645
2718
  begin
2646
- #Update the ring number of joined status for a User in a Queue
2719
+ #Update the ring number or joined status for a User in a Queue
2647
2720
  result = api_instance.patch_routing_queue_user(queue_id, member_id, body)
2648
2721
  p result
2649
2722
  rescue PureCloud::ApiError => e
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: ScorableSurvey
3
+ ---
4
+ ## PureCloud::ScorableSurvey
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **survey_form** | [**SurveyForm**](SurveyForm.html) | Survey form used for this survey. | [optional] |
13
+ | **status** | **String** | | [optional] |
14
+ | **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
15
+ | **self_uri** | **String** | The URI for this object | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
data/docs/SearchApi.md CHANGED
@@ -46,16 +46,6 @@ Requires NO permissions:
46
46
  ~~~ruby
47
47
  # load the gem
48
48
  require 'purecloudplatformclientv2'
49
- # setup authorization
50
- @secret = ENV['PURECLOUD_SECRET']
51
- @id = ENV['PURECLOUD_CLIENT_ID']
52
- environment = "mypurecloud.com"
53
-
54
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
55
-
56
- PureCloud.configure do |config|
57
- config.access_token = @authToken
58
- end
59
49
 
60
50
  api_instance = PureCloud::SearchApi.new
61
51
 
@@ -110,16 +100,6 @@ Requires NO permissions:
110
100
  ~~~ruby
111
101
  # load the gem
112
102
  require 'purecloudplatformclientv2'
113
- # setup authorization
114
- @secret = ENV['PURECLOUD_SECRET']
115
- @id = ENV['PURECLOUD_CLIENT_ID']
116
- environment = "mypurecloud.com"
117
-
118
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
119
-
120
- PureCloud.configure do |config|
121
- config.access_token = @authToken
122
- end
123
103
 
124
104
  api_instance = PureCloud::SearchApi.new
125
105
 
@@ -344,7 +324,7 @@ end
344
324
  Name | Type | Description | Notes
345
325
  ------------- | ------------- | ------------- | -------------
346
326
  **q64** | **String**| q64 | |
347
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
327
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
348
328
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
349
329
  {: class="table table-striped"}
350
330
 
@@ -414,7 +394,7 @@ end
414
394
  Name | Type | Description | Notes
415
395
  ------------- | ------------- | ------------- | -------------
416
396
  **q64** | **String**| q64 | |
417
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
397
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
418
398
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
419
399
  {: class="table table-striped"}
420
400
 
@@ -586,16 +566,6 @@ Requires NO permissions:
586
566
  ~~~ruby
587
567
  # load the gem
588
568
  require 'purecloudplatformclientv2'
589
- # setup authorization
590
- @secret = ENV['PURECLOUD_SECRET']
591
- @id = ENV['PURECLOUD_CLIENT_ID']
592
- environment = "mypurecloud.com"
593
-
594
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
595
-
596
- PureCloud.configure do |config|
597
- config.access_token = @authToken
598
- end
599
569
 
600
570
  api_instance = PureCloud::SearchApi.new
601
571
 
@@ -650,16 +620,6 @@ Requires NO permissions:
650
620
  ~~~ruby
651
621
  # load the gem
652
622
  require 'purecloudplatformclientv2'
653
- # setup authorization
654
- @secret = ENV['PURECLOUD_SECRET']
655
- @id = ENV['PURECLOUD_CLIENT_ID']
656
- environment = "mypurecloud.com"
657
-
658
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
659
-
660
- PureCloud.configure do |config|
661
- config.access_token = @authToken
662
- end
663
623
 
664
624
  api_instance = PureCloud::SearchApi.new
665
625
 
data/docs/SuggestApi.md CHANGED
@@ -68,7 +68,7 @@ end
68
68
  Name | Type | Description | Notes
69
69
  ------------- | ------------- | ------------- | -------------
70
70
  **q64** | **String**| q64 | |
71
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
71
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
72
72
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
73
73
  {: class="table table-striped"}
74
74
 
@@ -138,7 +138,7 @@ end
138
138
  Name | Type | Description | Notes
139
139
  ------------- | ------------- | ------------- | -------------
140
140
  **q64** | **String**| q64 | |
141
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
141
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference, callerUser.routingStatus, callerUser.primaryPresence, callerUser.conversationSummary, callerUser.outOfOffice, callerUser.geolocation |
142
142
  **profile** | **BOOLEAN**| profile | [optional] [default to true] |
143
143
  {: class="table table-striped"}
144
144
 
data/docs/Survey.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: Survey
3
+ ---
4
+ ## PureCloud::Survey
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **conversation** | [**Conversation**](Conversation.html) | | [optional] |
13
+ | **survey_form** | [**SurveyForm**](SurveyForm.html) | Survey form used for this survey. | [optional] |
14
+ | **agent** | [**UriReference**](UriReference.html) | | [optional] |
15
+ | **status** | **String** | | [optional] |
16
+ | **queue** | [**QueueReference**](QueueReference.html) | | [optional] |
17
+ | **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
18
+ | **completed_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
+ | **self_uri** | **String** | The URI for this object | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: SurveyFormAndScoringSet
3
+ ---
4
+ ## PureCloud::SurveyFormAndScoringSet
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **survey_form** | [**SurveyForm**](SurveyForm.html) | | [optional] |
11
+ | **answers** | [**SurveyScoringSet**](SurveyScoringSet.html) | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: SurveyQuestionGroupScore
3
+ ---
4
+ ## PureCloud::SurveyQuestionGroupScore
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **question_group_id** | **String** | | [optional] |
11
+ | **total_score** | **Float** | | [optional] |
12
+ | **max_total_score** | **Float** | | [optional] |
13
+ | **marked_na** | **BOOLEAN** | | [optional] |
14
+ | **question_scores** | [**Array&lt;SurveyQuestionScore&gt;**](SurveyQuestionScore.html) | | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: SurveyQuestionScore
3
+ ---
4
+ ## PureCloud::SurveyQuestionScore
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **question_id** | **String** | | [optional] |
11
+ | **answer_id** | **String** | | [optional] |
12
+ | **score** | **Integer** | | [optional] |
13
+ | **marked_na** | **BOOLEAN** | | [optional] |
14
+ | **nps_score** | **Integer** | | [optional] |
15
+ | **nps_text_answer** | **String** | | [optional] |
16
+ | **free_text_answer** | **String** | | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: SurveyScoringSet
3
+ ---
4
+ ## PureCloud::SurveyScoringSet
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **total_score** | **Float** | | [optional] |
11
+ | **nps_score** | **Integer** | | [optional] |
12
+ | **question_group_scores** | [**Array&lt;SurveyQuestionGroupScore&gt;**](SurveyQuestionGroupScore.html) | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
data/docs/Token.md ADDED
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: Token
3
+ ---
4
+ ## PureCloud::Token
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **jwt** | **String** | Token for use with common api | |
11
+ {: class="table table-striped"}
12
+
13
+
data/docs/TrustUser.md CHANGED
@@ -34,6 +34,7 @@ title: TrustUser
34
34
  | **skills** | [**Array&lt;UserRoutingSkill&gt;**](UserRoutingSkill.html) | Routing (ACD) skills possessed by the user | [optional] |
35
35
  | **languages** | [**Array&lt;UserRoutingLanguage&gt;**](UserRoutingLanguage.html) | Routing (ACD) languages possessed by the user | [optional] |
36
36
  | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
37
+ | **language_preference** | **String** | preferred language by the user | [optional] |
37
38
  | **trust_user_details** | [**TrustUserDetails**](TrustUserDetails.html) | | [optional] |
38
39
  {: class="table table-striped"}
39
40
 
data/docs/User.md CHANGED
@@ -34,6 +34,7 @@ title: User
34
34
  | **skills** | [**Array&lt;UserRoutingSkill&gt;**](UserRoutingSkill.html) | Routing (ACD) skills possessed by the user | [optional] |
35
35
  | **languages** | [**Array&lt;UserRoutingLanguage&gt;**](UserRoutingLanguage.html) | Routing (ACD) languages possessed by the user | [optional] |
36
36
  | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
37
+ | **language_preference** | **String** | preferred language by the user | [optional] |
37
38
  | **self_uri** | **String** | The URI for this object | [optional] |
38
39
  {: class="table table-striped"}
39
40
 
data/docs/UserMe.md CHANGED
@@ -34,6 +34,7 @@ title: UserMe
34
34
  | **skills** | [**Array&lt;UserRoutingSkill&gt;**](UserRoutingSkill.html) | Routing (ACD) skills possessed by the user | [optional] |
35
35
  | **languages** | [**Array&lt;UserRoutingLanguage&gt;**](UserRoutingLanguage.html) | Routing (ACD) languages possessed by the user | [optional] |
36
36
  | **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
37
+ | **language_preference** | **String** | preferred language by the user | [optional] |
37
38
  | **date** | [**ServerDate**](ServerDate.html) | The PureCloud system date time. | [optional] |
38
39
  | **geolocation_settings** | [**GeolocationSettings**](GeolocationSettings.html) | Geolocation settings for user&#39;s organization. | [optional] |
39
40
  | **organization** | [**Organization**](Organization.html) | Organization details for this user. | [optional] |
data/docs/UsersApi.md CHANGED
@@ -995,7 +995,7 @@ end
995
995
  Name | Type | Description | Notes
996
996
  ------------- | ------------- | ------------- | -------------
997
997
  **user_id** | **String**| User ID | |
998
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
998
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
999
999
  **state** | **String**| Search for a user with this state | [optional] [default to active]<br />**Values**: active, deleted |
1000
1000
  {: class="table table-striped"}
1001
1001
 
@@ -1064,7 +1064,7 @@ end
1064
1064
  Name | Type | Description | Notes
1065
1065
  ------------- | ------------- | ------------- | -------------
1066
1066
  **user_id** | **String**| User ID | |
1067
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
1067
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
1068
1068
  {: class="table table-striped"}
1069
1069
 
1070
1070
 
@@ -1196,7 +1196,7 @@ end
1196
1196
  Name | Type | Description | Notes
1197
1197
  ------------- | ------------- | ------------- | -------------
1198
1198
  **user_id** | **String**| User ID | |
1199
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
1199
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
1200
1200
  {: class="table table-striped"}
1201
1201
 
1202
1202
 
@@ -1270,7 +1270,7 @@ Name | Type | Description | Notes
1270
1270
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
1271
1271
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
1272
1272
  **sort_order** | **String**| Sort order | [optional] [default to ASC] |
1273
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
1273
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
1274
1274
  {: class="table table-striped"}
1275
1275
 
1276
1276
 
@@ -1469,7 +1469,7 @@ end
1469
1469
  Name | Type | Description | Notes
1470
1470
  ------------- | ------------- | ------------- | -------------
1471
1471
  **user_id** | **String**| userId | |
1472
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
1472
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
1473
1473
  {: class="table table-striped"}
1474
1474
 
1475
1475
 
@@ -2014,7 +2014,7 @@ end
2014
2014
  Name | Type | Description | Notes
2015
2015
  ------------- | ------------- | ------------- | -------------
2016
2016
  **user_id** | **String**| User ID | |
2017
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
2017
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
2018
2018
  {: class="table table-striped"}
2019
2019
 
2020
2020
 
@@ -2159,7 +2159,7 @@ Name | Type | Description | Notes
2159
2159
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
2160
2160
  **id** | [**Array&lt;String&gt;**](String.html)| id | [optional] |
2161
2161
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
2162
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
2162
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
2163
2163
  **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted |
2164
2164
  {: class="table table-striped"}
2165
2165
 
@@ -2225,7 +2225,7 @@ end
2225
2225
 
2226
2226
  Name | Type | Description | Notes
2227
2227
  ------------- | ------------- | ------------- | -------------
2228
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
2228
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
2229
2229
  {: class="table table-striped"}
2230
2230
 
2231
2231