purecloudplatformclientv2 44.0.0 → 45.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (97) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ADFS.md +1 -1
  4. data/docs/AnalyticsEvaluation.md +1 -1
  5. data/docs/AnalyticsSurvey.md +2 -1
  6. data/docs/ArchitectApi.md +52 -127
  7. data/docs/ContactListDivisionView.md +20 -0
  8. data/docs/ContactListDivisionViewListing.md +22 -0
  9. data/docs/ContactListNotification.md +1 -0
  10. data/docs/ConversationQuery.md +1 -1
  11. data/docs/CreateOutboundMessagingConversationRequest.md +1 -1
  12. data/docs/CreateWorkPlan.md +2 -0
  13. data/docs/CustomerInteractionCenter.md +1 -1
  14. data/docs/DataExportNotificationNotification.md +1 -0
  15. data/docs/DncListNotification.md +1 -0
  16. data/docs/DncListNotificationUriReference.md +14 -0
  17. data/docs/GSuite.md +1 -1
  18. data/docs/HelpLink.md +15 -0
  19. data/docs/IdentityNow.md +1 -1
  20. data/docs/IntegrationType.md +8 -0
  21. data/docs/IntradayDataUpdateNotification.md +2 -2
  22. data/docs/Okta.md +1 -1
  23. data/docs/OneLogin.md +1 -1
  24. data/docs/OutboundApi.md +152 -0
  25. data/docs/PingIdentity.md +1 -1
  26. data/docs/QualityApi.md +66 -0
  27. data/docs/ReportingExportJobResponse.md +1 -0
  28. data/docs/RoutingApi.md +74 -0
  29. data/docs/Salesforce.md +1 -1
  30. data/docs/UserScheduleAdherenceUpdateNotification.md +2 -2
  31. data/docs/WfmAgentScheduleUpdateNotificationNotification.md +18 -0
  32. data/docs/WfmAgentScheduleUpdateNotificationNotificationActivities.md +18 -0
  33. data/docs/WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers.md +19 -0
  34. data/docs/WfmAgentScheduleUpdateNotificationNotificationShifts.md +15 -0
  35. data/docs/WfmAgentScheduleUpdateNotificationNotificationUpdates.md +14 -0
  36. data/docs/WfmAgentScheduleUpdateNotificationNotificationUserReference.md +13 -0
  37. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate.md +14 -0
  38. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker.md +19 -0
  39. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity.md +18 -0
  40. data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift.md +15 -0
  41. data/docs/WfmScheduleNotificationNotification.md +1 -0
  42. data/docs/WorkPlan.md +2 -0
  43. data/docs/WorkPlanListItemResponse.md +16 -5
  44. data/docs/WorkforceManagementApi.md +2 -2
  45. data/lib/purecloudplatformclientv2.rb +14 -3
  46. data/lib/purecloudplatformclientv2/api/outbound_api.rb +230 -0
  47. data/lib/purecloudplatformclientv2/api/quality_api.rb +66 -0
  48. data/lib/purecloudplatformclientv2/api/routing_api.rb +100 -0
  49. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -7
  50. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  51. data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
  52. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  53. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +2 -2
  54. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  55. data/lib/purecloudplatformclientv2/models/analytics_survey.rb +34 -8
  56. data/lib/purecloudplatformclientv2/models/contact_list_division_view.rb +397 -0
  57. data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +428 -0
  58. data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +26 -1
  59. data/lib/purecloudplatformclientv2/models/conversation_query.rb +1 -1
  60. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +1 -1
  61. data/lib/purecloudplatformclientv2/models/create_work_plan.rb +53 -1
  62. data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
  63. data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +31 -6
  64. data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +26 -1
  65. data/lib/purecloudplatformclientv2/models/dnc_list_notification_uri_reference.rb +226 -0
  66. data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
  67. data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
  68. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_date_time.rb → help_link.rb} +24 -45
  69. data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
  70. data/lib/purecloudplatformclientv2/models/integration_type.rb +211 -1
  71. data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +2 -2
  72. data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
  73. data/lib/purecloudplatformclientv2/models/message_details.rb +2 -2
  74. data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
  75. data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
  76. data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
  77. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +34 -3
  78. data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
  79. data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +2 -2
  80. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification.rb +332 -0
  81. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_activities.rb +326 -0
  82. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_full_day_time_off_markers.rb +351 -0
  83. data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_start_date.rb → wfm_agent_schedule_update_notification_notification_shifts.rb} +22 -45
  84. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_updates.rb +242 -0
  85. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_user_reference.rb +201 -0
  86. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_agent_schedule_update.rb +242 -0
  87. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_full_day_time_off_marker.rb +351 -0
  88. data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_activity.rb +326 -0
  89. data/lib/purecloudplatformclientv2/models/{user_schedule_adherence_update_notification_date_time.rb → wfm_agent_schedule_update_notification_notification_wfm_schedule_shift.rb} +22 -45
  90. data/lib/purecloudplatformclientv2/models/wfm_schedule_notification_notification.rb +28 -3
  91. data/lib/purecloudplatformclientv2/models/work_plan.rb +53 -1
  92. data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +313 -18
  93. data/lib/purecloudplatformclientv2/version.rb +1 -1
  94. metadata +30 -8
  95. data/docs/IntradayDataUpdateNotificationDateTime.md +0 -16
  96. data/docs/IntradayDataUpdateNotificationStartDate.md +0 -16
  97. data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +0 -16
@@ -22,6 +22,7 @@ title: ReportingExportJobResponse
22
22
  | **created_date_time** | **DateTime** | The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
23
23
  | **modified_date_time** | **DateTime** | The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
24
24
  | **locale** | **String** | The locale use for localization of the exported data, i.e. en-us, es-mx | |
25
+ | **percentage_complete** | **Float** | The percentage of the job that has completed processing | |
25
26
  | **self_uri** | **String** | The URI for this object | [optional] |
26
27
  {: class="table table-striped"}
27
28
 
@@ -34,6 +34,7 @@ Method | Description
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
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).
37
+ [**get_routing_queues_me**](RoutingApi.html#get_routing_queues_me) | Get a paged listing of queues the user is a member of.
37
38
  [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
38
39
  [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
39
40
  [**get_routing_sms_availablephonenumbers**](RoutingApi.html#get_routing_sms_availablephonenumbers) | Get a list of available phone numbers for SMS provisioning.
@@ -1830,6 +1831,79 @@ Name | Type | Description | Notes
1830
1831
 
1831
1832
 
1832
1833
 
1834
+ <a name="get_routing_queues_me"></a>
1835
+
1836
+ ## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_routing_queues_me(opts)
1837
+
1838
+
1839
+
1840
+ Get a paged listing of queues the user is a member of.
1841
+
1842
+
1843
+
1844
+ Wraps GET /api/v2/routing/queues/me
1845
+
1846
+ Requires NO permissions:
1847
+
1848
+
1849
+
1850
+ ### Example
1851
+ ~~~ruby
1852
+ # load the gem
1853
+ require 'purecloudplatformclientv2'
1854
+ # setup authorization
1855
+ @secret = ENV['PURECLOUD_SECRET']
1856
+ @id = ENV['PURECLOUD_CLIENT_ID']
1857
+ environment = "mypurecloud.com"
1858
+
1859
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1860
+
1861
+ PureCloud.configure do |config|
1862
+ config.access_token = @authToken
1863
+ end
1864
+
1865
+ api_instance = PureCloud::RoutingApi.new
1866
+
1867
+ opts = {
1868
+ joined: true, # BOOLEAN | Joined
1869
+ page_size: 25, # Integer | Page size
1870
+ page_number: 1, # Integer | Page number
1871
+ sort_by: "name", # String | Sort by
1872
+ sort_order: "asc" # String | Sort order
1873
+ }
1874
+
1875
+ begin
1876
+ #Get a paged listing of queues the user is a member of.
1877
+ result = api_instance.get_routing_queues_me(opts)
1878
+ p result
1879
+ rescue PureCloud::ApiError => e
1880
+ puts "Exception when calling RoutingApi->get_routing_queues_me: #{e}"
1881
+ end
1882
+ ~~~
1883
+
1884
+ ### Parameters
1885
+
1886
+ Name | Type | Description | Notes
1887
+ ------------- | ------------- | ------------- | -------------
1888
+ **joined** | **BOOLEAN**| Joined | [optional] |
1889
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1890
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1891
+ **sort_by** | **String**| Sort by | [optional] [default to name] |
1892
+ **sort_order** | **String**| Sort order | [optional] [default to asc] |
1893
+ {: class="table table-striped"}
1894
+
1895
+
1896
+ ### Return type
1897
+
1898
+ [**UserQueueEntityListing**](UserQueueEntityListing.html)
1899
+
1900
+ ### HTTP request headers
1901
+
1902
+ - **Content-Type**: application/json
1903
+ - **Accept**: application/json
1904
+
1905
+
1906
+
1833
1907
  <a name="get_routing_skill"></a>
1834
1908
 
1835
1909
  ## -[**RoutingSkill**](RoutingSkill.html) get_routing_skill(skill_id)
@@ -10,8 +10,8 @@ title: Salesforce
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **certificate** | **String** | | [optional] |
13
- | **issuer_uri** | **String** | | [optional] |
14
13
  | **sso_target_uri** | **String** | | [optional] |
14
+ | **issuer_uri** | **String** | | [optional] |
15
15
  | **disabled** | **BOOLEAN** | | [optional] |
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
@@ -16,8 +16,8 @@ title: UserScheduleAdherenceUpdateNotification
16
16
  | **is_out_of_office** | **BOOLEAN** | | [optional] |
17
17
  | **adherence_state** | **String** | | [optional] |
18
18
  | **impact** | **String** | | [optional] |
19
- | **adherence_change_time** | [**IntradayDataUpdateNotificationStartDate**](IntradayDataUpdateNotificationStartDate.html) | | [optional] |
20
- | **presence_update_time** | [**UserScheduleAdherenceUpdateNotificationDateTime**](UserScheduleAdherenceUpdateNotificationDateTime.html) | | [optional] |
19
+ | **adherence_change_time** | **DateTime** | | [optional] |
20
+ | **presence_update_time** | **DateTime** | | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
23
23
 
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotification
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotification
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
11
+ | **start_date** | **DateTime** | | [optional] |
12
+ | **end_date** | **DateTime** | | [optional] |
13
+ | **shifts** | [**Array&lt;WfmAgentScheduleUpdateNotificationNotificationShifts&gt;**](WfmAgentScheduleUpdateNotificationNotificationShifts.html) | | [optional] |
14
+ | **full_day_time_off_markers** | [**Array&lt;WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers&gt;**](WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers.html) | | [optional] |
15
+ | **updates** | [**Array&lt;WfmAgentScheduleUpdateNotificationNotificationUpdates&gt;**](WfmAgentScheduleUpdateNotificationNotificationUpdates.html) | | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationActivities
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationActivities
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **activity_code_id** | **String** | | [optional] |
11
+ | **start_date** | **DateTime** | | [optional] |
12
+ | **counts_as_paid_time** | **BOOLEAN** | | [optional] |
13
+ | **length_in_minutes** | **Integer** | | [optional] |
14
+ | **time_off_request_id** | **String** | | [optional] |
15
+ | **description** | **String** | | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **time_off_request_id** | **String** | | [optional] |
11
+ | **management_unit_date** | **String** | | [optional] |
12
+ | **activity_code_id** | **String** | | [optional] |
13
+ | **is_paid** | **BOOLEAN** | | [optional] |
14
+ | **length_in_minutes** | **Integer** | | [optional] |
15
+ | **description** | **String** | | [optional] |
16
+ | **paid** | **BOOLEAN** | | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationShifts
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationShifts
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | | [optional] |
11
+ | **length_in_minutes** | **Integer** | | [optional] |
12
+ | **activities** | [**Array&lt;WfmAgentScheduleUpdateNotificationNotificationActivities&gt;**](WfmAgentScheduleUpdateNotificationNotificationActivities.html) | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationUpdates
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationUpdates
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **update_type** | **String** | | [optional] |
11
+ | **shift_start_dates** | **Array&lt;DateTime&gt;** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationUserReference
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationUserReference
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **update_type** | **String** | | [optional] |
11
+ | **shift_start_dates** | **Array&lt;DateTime&gt;** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,19 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **time_off_request_id** | **String** | | [optional] |
11
+ | **management_unit_date** | **String** | | [optional] |
12
+ | **activity_code_id** | **String** | | [optional] |
13
+ | **is_paid** | **BOOLEAN** | | [optional] |
14
+ | **length_in_minutes** | **Integer** | | [optional] |
15
+ | **description** | **String** | | [optional] |
16
+ | **paid** | **BOOLEAN** | | [optional] |
17
+ {: class="table table-striped"}
18
+
19
+
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **activity_code_id** | **String** | | [optional] |
11
+ | **start_date** | **DateTime** | | [optional] |
12
+ | **counts_as_paid_time** | **BOOLEAN** | | [optional] |
13
+ | **length_in_minutes** | **Integer** | | [optional] |
14
+ | **time_off_request_id** | **String** | | [optional] |
15
+ | **description** | **String** | | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift
3
+ ---
4
+ ## PureCloud::WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | | [optional] |
11
+ | **length_in_minutes** | **Integer** | | [optional] |
12
+ | **activities** | [**Array&lt;WfmAgentScheduleUpdateNotificationNotificationActivities&gt;**](WfmAgentScheduleUpdateNotificationNotificationActivities.html) | | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -10,6 +10,7 @@ title: WfmScheduleNotificationNotification
10
10
  | **status** | **String** | | [optional] |
11
11
  | **operation_id** | **String** | | [optional] |
12
12
  | **download_url** | **String** | | [optional] |
13
+ | **percent_complete** | **Integer** | | [optional] |
13
14
  | **event_type** | **String** | | [optional] |
14
15
  {: class="table table-striped"}
15
16
 
@@ -15,6 +15,8 @@ title: WorkPlan
15
15
  | **weekly_exact_paid_minutes** | **Integer** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | [optional] |
16
16
  | **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
17
17
  | **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
18
+ | **constrain_paid_time_granularity** | **BOOLEAN** | Whether paid time granularity is constrained for this workplan | [optional] |
19
+ | **paid_time_granularity_minutes** | **Integer** | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | [optional] |
18
20
  | **constrain_minimum_time_between_shifts** | **BOOLEAN** | Whether the minimum time between shifts constraint is enabled for this work plan | [optional] |
19
21
  | **minimum_time_between_shifts_minutes** | **Integer** | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | [optional] |
20
22
  | **maximum_days** | **Integer** | Maximum number days in a week allowed to be scheduled for this work plan | [optional] |
@@ -9,12 +9,23 @@ title: WorkPlanListItemResponse
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **agent_count** | **Integer** | Number of agents in this work plan | [optional] |
13
- | **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes defined in this work plan | [optional] |
14
- | **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes defined in this work plan | [optional] |
15
- | **maximum_days** | **Integer** | Maximum number of days in a week that can be scheduled using this work plan | [optional] |
16
12
  | **enabled** | **BOOLEAN** | Whether the work plan is enabled for scheduling | [optional] |
17
- | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | [optional] |
13
+ | **constrain_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is enabled for this work plan | [optional] |
14
+ | **flexible_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is flexible for this work plan | [optional] |
15
+ | **weekly_exact_paid_minutes** | **Integer** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | [optional] |
16
+ | **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
17
+ | **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
18
+ | **constrain_paid_time_granularity** | **BOOLEAN** | Whether paid time granularity is constrained for this workplan | [optional] |
19
+ | **paid_time_granularity_minutes** | **Integer** | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | [optional] |
20
+ | **constrain_minimum_time_between_shifts** | **BOOLEAN** | Whether the minimum time between shifts constraint is enabled for this work plan | [optional] |
21
+ | **minimum_time_between_shifts_minutes** | **Integer** | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | [optional] |
22
+ | **maximum_days** | **Integer** | Maximum number days in a week allowed to be scheduled for this work plan | [optional] |
23
+ | **optional_days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Optional days to schedule for this work plan. Populate with expand=details | [optional] |
24
+ | **shift_start_variances** | [**ListWrapperShiftStartVariance**](ListWrapperShiftStartVariance.html) | Variance in minutes among start times of shifts in this work plan. Populate with expand=details | [optional] |
25
+ | **shifts** | [**Array&lt;WorkPlanShift&gt;**](WorkPlanShift.html) | Shifts in this work plan. Populate with expand=details (defaults to empty list) | [optional] |
26
+ | **agents** | [**Array&lt;DeletableUserReference&gt;**](DeletableUserReference.html) | Agents in this work plan. Populate with expand=details (defaults to empty list) | [optional] |
27
+ | **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | |
28
+ | **agent_count** | **Integer** | Number of agents in this work plan. Populate with expand=agentCount | [optional] |
18
29
  | **self_uri** | **String** | The URI for this object | [optional] |
19
30
  {: class="table table-striped"}
20
31
 
@@ -2149,7 +2149,7 @@ api_instance = PureCloud::WorkforceManagementApi.new
2149
2149
  management_unit_id = "management_unit_id_example" # String | The ID of the management unit, or 'mine' for the management unit of the logged-in user.
2150
2150
 
2151
2151
  opts = {
2152
- expand: "expand_example" # String |
2152
+ expand: ["expand_example"] # Array<String> |
2153
2153
  }
2154
2154
 
2155
2155
  begin
@@ -2166,7 +2166,7 @@ end
2166
2166
  Name | Type | Description | Notes
2167
2167
  ------------- | ------------- | ------------- | -------------
2168
2168
  **management_unit_id** | **String**| The ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
2169
- **expand** | **String**| | [optional] <br />**Values**: agentCount |
2169
+ **expand** | [**Array&lt;String&gt;**](String.html)| | [optional] <br />**Values**: agentCount, details |
2170
2170
  {: class="table table-striped"}
2171
2171
 
2172
2172
 
@@ -288,6 +288,8 @@ require 'purecloudplatformclientv2/models/contact_address'
288
288
  require 'purecloudplatformclientv2/models/contact_callback_request'
289
289
  require 'purecloudplatformclientv2/models/contact_column_time_zone'
290
290
  require 'purecloudplatformclientv2/models/contact_list'
291
+ require 'purecloudplatformclientv2/models/contact_list_division_view'
292
+ require 'purecloudplatformclientv2/models/contact_list_division_view_listing'
291
293
  require 'purecloudplatformclientv2/models/contact_list_entity_listing'
292
294
  require 'purecloudplatformclientv2/models/contact_list_filter'
293
295
  require 'purecloudplatformclientv2/models/contact_list_filter_clause'
@@ -440,6 +442,7 @@ require 'purecloudplatformclientv2/models/dnc_list_create'
440
442
  require 'purecloudplatformclientv2/models/dnc_list_entity_listing'
441
443
  require 'purecloudplatformclientv2/models/dnc_list_notification'
442
444
  require 'purecloudplatformclientv2/models/dnc_list_notification_import_status'
445
+ require 'purecloudplatformclientv2/models/dnc_list_notification_uri_reference'
443
446
  require 'purecloudplatformclientv2/models/document'
444
447
  require 'purecloudplatformclientv2/models/document_attribute'
445
448
  require 'purecloudplatformclientv2/models/document_audit'
@@ -670,6 +673,7 @@ require 'purecloudplatformclientv2/models/heart_beat_alert_notification_notifica
670
673
  require 'purecloudplatformclientv2/models/heart_beat_alert_notification_notification_users'
671
674
  require 'purecloudplatformclientv2/models/heart_beat_rule_notification'
672
675
  require 'purecloudplatformclientv2/models/heart_beat_rule_notification_notification_user'
676
+ require 'purecloudplatformclientv2/models/help_link'
673
677
  require 'purecloudplatformclientv2/models/history_listing'
674
678
  require 'purecloudplatformclientv2/models/ivr'
675
679
  require 'purecloudplatformclientv2/models/ivr_entity_listing'
@@ -705,7 +709,6 @@ require 'purecloudplatformclientv2/models/interaction_stats_rule'
705
709
  require 'purecloudplatformclientv2/models/interaction_stats_rule_container'
706
710
  require 'purecloudplatformclientv2/models/intraday_data_group'
707
711
  require 'purecloudplatformclientv2/models/intraday_data_update_notification'
708
- require 'purecloudplatformclientv2/models/intraday_data_update_notification_date_time'
709
712
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_forecast_data_per_interval'
710
713
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_historical_agent_data_per_interval'
711
714
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_historical_queue_data_per_interval'
@@ -722,7 +725,6 @@ require 'purecloudplatformclientv2/models/intraday_data_update_notification_metr
722
725
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_agent_data_per_interval'
723
726
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_performance_prediction_queue_data_per_interval'
724
727
  require 'purecloudplatformclientv2/models/intraday_data_update_notification_schedule_data_per_interval'
725
- require 'purecloudplatformclientv2/models/intraday_data_update_notification_start_date'
726
728
  require 'purecloudplatformclientv2/models/intraday_forecast_data'
727
729
  require 'purecloudplatformclientv2/models/intraday_historical_agent_data'
728
730
  require 'purecloudplatformclientv2/models/intraday_historical_queue_data'
@@ -1234,7 +1236,6 @@ require 'purecloudplatformclientv2/models/user_schedule'
1234
1236
  require 'purecloudplatformclientv2/models/user_schedule_activity'
1235
1237
  require 'purecloudplatformclientv2/models/user_schedule_adherence'
1236
1238
  require 'purecloudplatformclientv2/models/user_schedule_adherence_update_notification'
1237
- require 'purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time'
1238
1239
  require 'purecloudplatformclientv2/models/user_schedule_adherence_update_notification_user_reference'
1239
1240
  require 'purecloudplatformclientv2/models/user_schedule_container'
1240
1241
  require 'purecloudplatformclientv2/models/user_schedule_full_day_time_off_marker'
@@ -1290,6 +1291,16 @@ require 'purecloudplatformclientv2/models/week_schedule_list_item_response'
1290
1291
  require 'purecloudplatformclientv2/models/week_schedule_list_response'
1291
1292
  require 'purecloudplatformclientv2/models/week_schedule_response'
1292
1293
  require 'purecloudplatformclientv2/models/wfm_agent'
1294
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification'
1295
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_activities'
1296
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_full_day_time_off_markers'
1297
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_shifts'
1298
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_updates'
1299
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_user_reference'
1300
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_agent_schedule_update'
1301
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_full_day_time_off_marker'
1302
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_activity'
1303
+ require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_shift'
1293
1304
  require 'purecloudplatformclientv2/models/wfm_average_speed_of_answer'
1294
1305
  require 'purecloudplatformclientv2/models/wfm_forecast_modification'
1295
1306
  require 'purecloudplatformclientv2/models/wfm_forecast_modification_attributes'
@@ -3127,6 +3127,150 @@ module PureCloud
3127
3127
  return data, status_code, headers
3128
3128
  end
3129
3129
 
3130
+ # Query a list of simplified contact list objects.
3131
+ # This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
3132
+ # @param [Hash] opts the optional parameters
3133
+ # @option opts [BOOLEAN] :include_import_status Include import status (default to false)
3134
+ # @option opts [BOOLEAN] :include_size Include size (default to false)
3135
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100. (default to 25)
3136
+ # @option opts [Integer] :page_number Page number (default to 1)
3137
+ # @option opts [String] :filter_type Filter type (default to Prefix)
3138
+ # @option opts [String] :name Name
3139
+ # @option opts [Array<String>] :id id
3140
+ # @option opts [String] :sort_by Sort by
3141
+ # @option opts [String] :sort_order Sort order (default to a)
3142
+ # @return [ContactListDivisionViewListing]
3143
+ def get_outbound_contactlists_divisionviews(opts = {})
3144
+ data, _status_code, _headers = get_outbound_contactlists_divisionviews_with_http_info(opts)
3145
+ return data
3146
+ end
3147
+
3148
+ # Query a list of simplified contact list objects.
3149
+ # This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
3150
+ # @param [Hash] opts the optional parameters
3151
+ # @option opts [BOOLEAN] :include_import_status Include import status
3152
+ # @option opts [BOOLEAN] :include_size Include size
3153
+ # @option opts [Integer] :page_size Page size. The max that will be returned is 100.
3154
+ # @option opts [Integer] :page_number Page number
3155
+ # @option opts [String] :filter_type Filter type
3156
+ # @option opts [String] :name Name
3157
+ # @option opts [Array<String>] :id id
3158
+ # @option opts [String] :sort_by Sort by
3159
+ # @option opts [String] :sort_order Sort order
3160
+ # @return [Array<(ContactListDivisionViewListing, Fixnum, Hash)>] ContactListDivisionViewListing data, response status code and response headers
3161
+ def get_outbound_contactlists_divisionviews_with_http_info(opts = {})
3162
+ if @api_client.config.debugging
3163
+ @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionviews ..."
3164
+ end
3165
+
3166
+
3167
+
3168
+
3169
+
3170
+
3171
+
3172
+
3173
+
3174
+
3175
+
3176
+
3177
+
3178
+
3179
+
3180
+
3181
+
3182
+
3183
+
3184
+
3185
+
3186
+
3187
+
3188
+
3189
+
3190
+
3191
+
3192
+
3193
+ if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
3194
+ fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
3195
+ end
3196
+
3197
+
3198
+
3199
+
3200
+
3201
+
3202
+
3203
+
3204
+
3205
+
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+
3212
+
3213
+
3214
+
3215
+
3216
+
3217
+
3218
+
3219
+
3220
+
3221
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
3222
+ fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
3223
+ end
3224
+
3225
+
3226
+
3227
+
3228
+ # resource path
3229
+ local_var_path = "/api/v2/outbound/contactlists/divisionviews".sub('{format}','json')
3230
+
3231
+ # query parameters
3232
+ query_params = {}
3233
+ query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
3234
+ query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
3235
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
3236
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
3237
+ query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
3238
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
3239
+ query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
3240
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
3241
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
3242
+
3243
+ # header parameters
3244
+ header_params = {}
3245
+
3246
+ # HTTP header 'Accept' (if needed)
3247
+ local_header_accept = ['application/json']
3248
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
3249
+
3250
+ # HTTP header 'Content-Type'
3251
+ local_header_content_type = ['application/json']
3252
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
3253
+
3254
+ # form parameters
3255
+ form_params = {}
3256
+
3257
+ # http body (model)
3258
+ post_body = nil
3259
+
3260
+ auth_names = ['PureCloud Auth']
3261
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3262
+ :header_params => header_params,
3263
+ :query_params => query_params,
3264
+ :form_params => form_params,
3265
+ :body => post_body,
3266
+ :auth_names => auth_names,
3267
+ :return_type => 'ContactListDivisionViewListing')
3268
+ if @api_client.config.debugging
3269
+ @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3270
+ end
3271
+ return data, status_code, headers
3272
+ end
3273
+
3130
3274
  # Get dialer DNC list
3131
3275
  #
3132
3276
  # @param dnc_list_id DncList ID
@@ -3358,6 +3502,8 @@ module PureCloud
3358
3502
  # @option opts [Integer] :page_number Page number (default to 1)
3359
3503
  # @option opts [String] :filter_type Filter type (default to Prefix)
3360
3504
  # @option opts [String] :name Name
3505
+ # @option opts [String] :dnc_source_type DncSourceType
3506
+ # @option opts [Array<String>] :division_id Division ID(s)
3361
3507
  # @option opts [String] :sort_by Sort by
3362
3508
  # @option opts [String] :sort_order Sort order
3363
3509
  # @return [DncListEntityListing]
@@ -3375,6 +3521,8 @@ module PureCloud
3375
3521
  # @option opts [Integer] :page_number Page number
3376
3522
  # @option opts [String] :filter_type Filter type
3377
3523
  # @option opts [String] :name Name
3524
+ # @option opts [String] :dnc_source_type DncSourceType
3525
+ # @option opts [Array<String>] :division_id Division ID(s)
3378
3526
  # @option opts [String] :sort_by Sort by
3379
3527
  # @option opts [String] :sort_order Sort order
3380
3528
  # @return [Array<(DncListEntityListing, Fixnum, Hash)>] DncListEntityListing data, response status code and response headers
@@ -3426,6 +3574,22 @@ module PureCloud
3426
3574
 
3427
3575
 
3428
3576
 
3577
+ if opts[:'dnc_source_type'] && !['rds', 'dnc.com', 'gryphon'].include?(opts[:'dnc_source_type'])
3578
+ fail ArgumentError, 'invalid value for "dnc_source_type", must be one of rds, dnc.com, gryphon'
3579
+ end
3580
+
3581
+
3582
+
3583
+
3584
+
3585
+
3586
+
3587
+
3588
+
3589
+
3590
+
3591
+
3592
+
3429
3593
 
3430
3594
 
3431
3595
 
@@ -3450,6 +3614,8 @@ module PureCloud
3450
3614
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
3451
3615
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
3452
3616
  query_params[:'name'] = opts[:'name'] if opts[:'name']
3617
+ query_params[:'dncSourceType'] = opts[:'dnc_source_type'] if opts[:'dnc_source_type']
3618
+ query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
3453
3619
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
3454
3620
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
3455
3621
 
@@ -5028,6 +5194,70 @@ module PureCloud
5028
5194
  return data, status_code, headers
5029
5195
  end
5030
5196
 
5197
+ # Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
5198
+ #
5199
+ # @param contact_list_id Contact List ID
5200
+ # @param [Hash] opts the optional parameters
5201
+ # @return [nil]
5202
+ def post_outbound_contactlist_clear(contact_list_id, opts = {})
5203
+ post_outbound_contactlist_clear_with_http_info(contact_list_id, opts)
5204
+ return nil
5205
+ end
5206
+
5207
+ # Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
5208
+ #
5209
+ # @param contact_list_id Contact List ID
5210
+ # @param [Hash] opts the optional parameters
5211
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
5212
+ def post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {})
5213
+ if @api_client.config.debugging
5214
+ @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_clear ..."
5215
+ end
5216
+
5217
+
5218
+ # verify the required parameter 'contact_list_id' is set
5219
+ fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_clear" if contact_list_id.nil?
5220
+
5221
+
5222
+
5223
+
5224
+
5225
+ # resource path
5226
+ local_var_path = "/api/v2/outbound/contactlists/{contactListId}/clear".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)
5227
+
5228
+ # query parameters
5229
+ query_params = {}
5230
+
5231
+ # header parameters
5232
+ header_params = {}
5233
+
5234
+ # HTTP header 'Accept' (if needed)
5235
+ local_header_accept = ['application/json']
5236
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
5237
+
5238
+ # HTTP header 'Content-Type'
5239
+ local_header_content_type = ['application/json']
5240
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
5241
+
5242
+ # form parameters
5243
+ form_params = {}
5244
+
5245
+ # http body (model)
5246
+ post_body = nil
5247
+
5248
+ auth_names = ['PureCloud Auth']
5249
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
5250
+ :header_params => header_params,
5251
+ :query_params => query_params,
5252
+ :form_params => form_params,
5253
+ :body => post_body,
5254
+ :auth_names => auth_names)
5255
+ if @api_client.config.debugging
5256
+ @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5257
+ end
5258
+ return data, status_code, headers
5259
+ end
5260
+
5031
5261
  # Add contacts to a contact list.
5032
5262
  #
5033
5263
  # @param contact_list_id Contact List ID