purecloudplatformclientv2 22.0.0 → 23.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActivityCode.md +8 -5
  4. data/docs/ActivityCodeContainer.md +1 -0
  5. data/docs/AdherenceSettings.md +1 -1
  6. data/docs/ArchitectApi.md +14 -14
  7. data/docs/AuthorizationApi.md +3 -1
  8. data/docs/BatchDownloadJobResult.md +20 -0
  9. data/docs/BatchDownloadJobStatusResult.md +20 -0
  10. data/docs/BatchDownloadJobSubmission.md +13 -0
  11. data/docs/BatchDownloadJobSubmissionResult.md +15 -0
  12. data/docs/BatchDownloadRequest.md +14 -0
  13. data/docs/Call.md +2 -0
  14. data/docs/CallBasic.md +2 -0
  15. data/docs/CallForwardingNotification.md +17 -0
  16. data/docs/CallForwardingNotificationCall.md +13 -0
  17. data/docs/CallForwardingNotificationCalls.md +13 -0
  18. data/docs/CallForwardingNotificationTarget.md +14 -0
  19. data/docs/CallForwardingNotificationTargets.md +14 -0
  20. data/docs/CallForwardingNotificationUser.md +13 -0
  21. data/docs/CallRoute.md +0 -1
  22. data/docs/{SignedData.md → ContactColumnTimeZone.md} +2 -3
  23. data/docs/CreateActivityCodeRequest.md +18 -0
  24. data/docs/CreateQueueRequest.md +12 -11
  25. data/docs/ExternalContact.md +1 -0
  26. data/docs/IgnoredActivityCategories.md +13 -0
  27. data/docs/ManagementUnit.md +4 -3
  28. data/docs/ManagementUnitSettings.md +1 -3
  29. data/docs/MessageDetails.md +1 -0
  30. data/docs/MessageMedia.md +14 -0
  31. data/docs/MoveAgentResponse.md +14 -0
  32. data/docs/MoveAgentsRequest.md +14 -0
  33. data/docs/MoveAgentsResponse.md +15 -0
  34. data/docs/NTPSettings.md +13 -0
  35. data/docs/OrganizationAuthorizationApi.md +2 -2
  36. data/docs/OutOfOfficeNotification.md +1 -0
  37. data/docs/OutboundApi.md +63 -0
  38. data/docs/Queue.md +12 -11
  39. data/docs/Recording.md +1 -0
  40. data/docs/RecordingApi.md +120 -0
  41. data/docs/RecordingMessagingMessage.md +18 -0
  42. data/docs/RoutingApi.md +2 -2
  43. data/docs/SchedulingSettings.md +1 -0
  44. data/docs/ShrinkageOverride.md +14 -0
  45. data/docs/ShrinkageOverrides.md +14 -0
  46. data/docs/Site.md +1 -0
  47. data/docs/TrustCreate.md +2 -1
  48. data/docs/TrustGroup.md +26 -0
  49. data/docs/{TrustUserCreate.md → TrustMemberCreate.md} +4 -4
  50. data/docs/TrustRequest.md +2 -1
  51. data/docs/TrustRequestCreate.md +2 -1
  52. data/docs/UserQueue.md +12 -11
  53. data/docs/WfmVersionedEntityMetadata.md +15 -0
  54. data/docs/WorkforceManagementApi.md +128 -3
  55. data/docs/{Entity.md → WrapUpCodeReference.md} +2 -2
  56. data/lib/purecloudplatformclientv2.rb +26 -4
  57. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  58. data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
  59. data/lib/purecloudplatformclientv2/api/outbound_api.rb +75 -0
  60. data/lib/purecloudplatformclientv2/api/recording_api.rb +130 -0
  61. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +138 -2
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/activity_code.rb +95 -12
  64. data/lib/purecloudplatformclientv2/models/activity_code_container.rb +35 -4
  65. data/lib/purecloudplatformclientv2/models/adherence_settings.rb +2 -4
  66. data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb +383 -0
  67. data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +385 -0
  68. data/lib/purecloudplatformclientv2/models/batch_download_job_submission.rb +209 -0
  69. data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +253 -0
  70. data/lib/purecloudplatformclientv2/models/batch_download_request.rb +228 -0
  71. data/lib/purecloudplatformclientv2/models/call.rb +56 -4
  72. data/lib/purecloudplatformclientv2/models/call_basic.rb +56 -4
  73. data/lib/purecloudplatformclientv2/models/call_forwarding_notification.rb +303 -0
  74. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_call.rb +203 -0
  75. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_calls.rb +203 -0
  76. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_target.rb +226 -0
  77. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_targets.rb +226 -0
  78. data/lib/purecloudplatformclientv2/models/{signed_data.rb → call_forwarding_notification_user.rb} +8 -8
  79. data/lib/purecloudplatformclientv2/models/call_route.rb +4 -30
  80. data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +176 -0
  81. data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +358 -0
  82. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +38 -12
  83. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  84. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  85. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
  87. data/lib/purecloudplatformclientv2/models/ignored_activity_categories.rb +204 -0
  88. data/lib/purecloudplatformclientv2/models/management_unit.rb +36 -5
  89. data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +9 -61
  90. data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
  91. data/lib/purecloudplatformclientv2/models/message_media.rb +228 -0
  92. data/lib/purecloudplatformclientv2/models/move_agent_response.rb +243 -0
  93. data/lib/purecloudplatformclientv2/models/move_agents_request.rb +236 -0
  94. data/lib/purecloudplatformclientv2/models/move_agents_response.rb +257 -0
  95. data/lib/purecloudplatformclientv2/models/ntp_settings.rb +204 -0
  96. data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +26 -1
  97. data/lib/purecloudplatformclientv2/models/prediction_results.rb +2 -2
  98. data/lib/purecloudplatformclientv2/models/queue.rb +38 -12
  99. data/lib/purecloudplatformclientv2/models/recording.rb +29 -1
  100. data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +327 -0
  101. data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/shrinkage_override.rb +233 -0
  103. data/lib/purecloudplatformclientv2/models/shrinkage_overrides.rb +230 -0
  104. data/lib/purecloudplatformclientv2/models/site.rb +27 -1
  105. data/lib/purecloudplatformclientv2/models/trust_create.rb +32 -9
  106. data/lib/purecloudplatformclientv2/models/trust_group.rb +603 -0
  107. data/lib/purecloudplatformclientv2/models/{trust_user_create.rb → trust_member_create.rb} +3 -3
  108. data/lib/purecloudplatformclientv2/models/trust_request.rb +28 -5
  109. data/lib/purecloudplatformclientv2/models/trust_request_create.rb +32 -9
  110. data/lib/purecloudplatformclientv2/models/user_queue.rb +38 -12
  111. data/lib/purecloudplatformclientv2/models/wfm_versioned_entity_metadata.rb +260 -0
  112. data/lib/purecloudplatformclientv2/models/{entity.rb → wrap_up_code_reference.rb} +1 -1
  113. data/lib/purecloudplatformclientv2/version.rb +1 -1
  114. metadata +54 -10
  115. data/docs/SignedDataApi.md +0 -73
  116. data/lib/purecloudplatformclientv2/api/signed_data_api.rb +0 -90
@@ -2170,7 +2170,7 @@ api_instance = PureCloud::RoutingApi.new
2170
2170
 
2171
2171
  queue_id = "queue_id_example" # String | Queue ID
2172
2172
 
2173
- body = [PureCloud::Entity.new] # Array<Entity> | List of wrapup codes
2173
+ body = [PureCloud::WrapUpCodeReference.new] # Array<WrapUpCodeReference> | List of wrapup codes
2174
2174
 
2175
2175
 
2176
2176
  begin
@@ -2187,7 +2187,7 @@ end
2187
2187
  Name | Type | Description | Notes
2188
2188
  ------------- | ------------- | ------------- | -------------
2189
2189
  **queue_id** | **String**| Queue ID | |
2190
- **body** | [**Array&lt;Entity&gt;**](Entity.html)| List of wrapup codes | |
2190
+ **body** | [**Array&lt;WrapUpCodeReference&gt;**](WrapUpCodeReference.html)| List of wrapup codes | |
2191
2191
  {: class="table table-striped"}
2192
2192
 
2193
2193
 
@@ -9,6 +9,7 @@ title: SchedulingSettings
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **max_occupancy_percent_for_deferred_work** | **Integer** | Max occupancy percent for deferred work | [optional] |
11
11
  | **default_shrinkage_percent** | **Float** | Default shrinkage percent for scheduling | [optional] |
12
+ | **shrinkage_overrides** | [**ShrinkageOverrides**](ShrinkageOverrides.html) | Shrinkage overrides for scheduling | [optional] |
12
13
  {: class="table table-striped"}
13
14
 
14
15
 
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: ShrinkageOverride
3
+ ---
4
+ ## PureCloud::ShrinkageOverride
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **interval_index** | **Integer** | Index of shrinkage override interval. Starting index is 0 and indexes are based on 15 minute intervals for a 7 day week | |
11
+ | **shrinkage_percent** | **Float** | Shrinkage override percent. Setting a null value will reset the interval to the default | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: ShrinkageOverrides
3
+ ---
4
+ ## PureCloud::ShrinkageOverrides
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **clear** | **BOOLEAN** | Set true to clear the shrinkage interval overrides | [optional] |
11
+ | **values** | [**Array&lt;ShrinkageOverride&gt;**](ShrinkageOverride.html) | List of interval shrinkage overrides | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -27,6 +27,7 @@ title: Site
27
27
  | **edge_auto_update_config** | [**EdgeAutoUpdateConfig**](EdgeAutoUpdateConfig.html) | Recurrance rule, time zone, and start/end settings for automatic edge updates for this site | [optional] |
28
28
  | **location** | [**LocationDefinition**](LocationDefinition.html) | Location | |
29
29
  | **managed** | **BOOLEAN** | | [optional] |
30
+ | **ntp_settings** | [**NTPSettings**](NTPSettings.html) | Network Time Protocol settings for the site | [optional] |
30
31
  | **self_uri** | **String** | The URI for this object | [optional] |
31
32
  {: class="table table-striped"}
32
33
 
@@ -9,7 +9,8 @@ title: TrustCreate
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **pairing_id** | **String** | The pairing Id created by the trustee. This is required to prove that the trustee agrees to the relationship. | |
11
11
  | **enabled** | **BOOLEAN** | If disabled no trustee user will have access, even if they were previously added. | |
12
- | **users** | [**Array&lt;TrustUserCreate&gt;**](TrustUserCreate.html) | The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. | |
12
+ | **users** | [**Array&lt;TrustMemberCreate&gt;**](TrustMemberCreate.html) | The list of users and their roles to which access will be granted. The users are from the trustee and the roles are from the trustor. If no users are specified, at least one group is required. | [optional] |
13
+ | **groups** | [**Array&lt;TrustMemberCreate&gt;**](TrustMemberCreate.html) | The list of groups and their roles to which access will be granted. The groups are from the trustee and the roles are from the trustor. If no groups are specified, at least one user is required. | [optional] |
13
14
  {: class="table table-striped"}
14
15
 
15
16
 
@@ -0,0 +1,26 @@
1
+ ---
2
+ title: TrustGroup
3
+ ---
4
+ ## PureCloud::TrustGroup
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | The group name. | |
12
+ | **description** | **String** | | [optional] |
13
+ | **date_modified** | **DateTime** | Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **member_count** | **Integer** | Number of members. | [optional] |
15
+ | **state** | **String** | Active, inactive, or deleted state. | [optional] |
16
+ | **version** | **Integer** | Current version for this resource. | [optional] |
17
+ | **type** | **String** | Type of group. | |
18
+ | **images** | [**Array&lt;UserImage&gt;**](UserImage.html) | | [optional] |
19
+ | **addresses** | [**Array&lt;GroupContact&gt;**](GroupContact.html) | | [optional] |
20
+ | **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | |
21
+ | **visibility** | **String** | Who can view this group | |
22
+ | **date_created** | **DateTime** | The date on which the trusted group was added. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
+ | **created_by** | [**OrgUser**](OrgUser.html) | The user that added trusted group. | [optional] |
24
+ {: class="table table-striped"}
25
+
26
+
@@ -1,14 +1,14 @@
1
1
  ---
2
- title: TrustUserCreate
2
+ title: TrustMemberCreate
3
3
  ---
4
- ## PureCloud::TrustUserCreate
4
+ ## PureCloud::TrustMemberCreate
5
5
 
6
6
  ## Properties
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | Trustee User Id | |
11
- | **role_ids** | **Array&lt;String&gt;** | The list of trustor organization roles granting this user access. | |
10
+ | **id** | **String** | Trustee User or Group Id | |
11
+ | **role_ids** | **Array&lt;String&gt;** | The list of trustor organization roles granting this user or group access. | |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
@@ -11,7 +11,8 @@ title: TrustRequest
11
11
  | **created_by** | [**OrgUser**](OrgUser.html) | User who created this request. | [optional] |
12
12
  | **date_created** | **DateTime** | Date request was created. There is a 48 hour expiration on all requests. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
13
  | **trustee** | [**Organization**](Organization.html) | Trustee organization who generated this request. | |
14
- | **users** | [**Array&lt;OrgUser&gt;**](OrgUser.html) | The list of trustee users that are requesting access. | |
14
+ | **users** | [**Array&lt;OrgUser&gt;**](OrgUser.html) | The list of trustee users that are requesting access. | [optional] |
15
+ | **groups** | [**Array&lt;TrustGroup&gt;**](TrustGroup.html) | The list of trustee groups that are requesting access. | [optional] |
15
16
  | **self_uri** | **String** | The URI for this object | [optional] |
16
17
  {: class="table table-striped"}
17
18
 
@@ -7,7 +7,8 @@ title: TrustRequestCreate
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **user_ids** | **Array&lt;String&gt;** | The list of trustee users that are requesting access. | |
10
+ | **user_ids** | **Array&lt;String&gt;** | The list of trustee users that are requesting access. If no users are specified, at least one group is required. | [optional] |
11
+ | **group_ids** | **Array&lt;String&gt;** | The list of trustee groups that are requesting access. If no groups are specified, at least one user is required. | [optional] |
11
12
  {: class="table table-striped"}
12
13
 
13
14
 
@@ -9,22 +9,23 @@ title: UserQueue
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **description** | **String** | The resource&#39;s description. | [optional] |
13
- | **version** | **Integer** | The current version of the resource. | [optional] |
14
- | **date_created** | **DateTime** | The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
- | **date_modified** | **DateTime** | The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
- | **modified_by** | **String** | The ID of the user that last modified the resource. | [optional] |
17
- | **created_by** | **String** | The ID of the user that created the resource. | [optional] |
18
- | **state** | **String** | Indicates if the resource is active, inactive, or deleted. | [optional] |
19
- | **modified_by_app** | **String** | The application that last modified the resource. | [optional] |
20
- | **created_by_app** | **String** | The application that created the resource. | [optional] |
12
+ | **description** | **String** | The queue description. | [optional] |
13
+ | **version** | **Integer** | The current version of the queue. | [optional] |
14
+ | **division** | [**UriReference**](UriReference.html) | The division to which this queue belongs. | [optional] |
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] |
16
+ | **date_modified** | **DateTime** | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
+ | **modified_by** | **String** | The ID of the user that last modified the queue. | [optional] |
18
+ | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
19
+ | **state** | **String** | Indicates if the queue is active, inactive, or deleted. | [optional] |
20
+ | **modified_by_app** | **String** | The application that last modified the queue. | [optional] |
21
+ | **created_by_app** | **String** | The application that created the queue. | [optional] |
21
22
  | **media_settings** | [**Hash&lt;String, MediaSetting&gt;**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
22
23
  | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
23
24
  | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
24
25
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
25
26
  | **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
26
- | **whisper** | [**UriReference**](UriReference.html) | The prompt used for whisper audio on the queue, if configured. | [optional] |
27
- | **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered. | [optional] |
27
+ | **whisper** | [**UriReference**](UriReference.html) | ID of the whisper configured for this queue, if any. | [optional] |
28
+ | **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. | [optional] |
28
29
  | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
29
30
  | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
30
31
  | **default_scripts** | [**Hash&lt;String, Script&gt;**](Script.html) | The default script Ids for the communication types. | [optional] |
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmVersionedEntityMetadata
3
+ ---
4
+ ## PureCloud::WfmVersionedEntityMetadata
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **version** | **Integer** | The version of the associated entity. Used to prevent conflicts on concurrent edits | |
11
+ | **modified_by** | [**UserReference**](UserReference.html) | The user who last modified the associated entity | [optional] |
12
+ | **date_modified** | **DateTime** | The date the associated entity was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.mypurecloud.com*
9
9
  Method | Description
10
10
  ------------- | ------------- | -------------
11
11
  [**get_workforcemanagement_adherence**](WorkforceManagementApi.html#get_workforcemanagement_adherence) | Get a list of UserScheduleAdherence records for the requested users
12
- [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes corresponding to a management unit
12
+ [**get_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_activitycodes) | Get activity codes
13
13
  [**get_workforcemanagement_managementunit_intraday_queues**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_intraday_queues) | Get intraday queues for the given date
14
14
  [**get_workforcemanagement_managementunit_user_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequest) | Get a time off request by id
15
15
  [**get_workforcemanagement_managementunit_user_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_managementunit_user_timeoffrequests) | Get a list of time off requests for any user
@@ -18,7 +18,9 @@ Method | Description
18
18
  [**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user by id
19
19
  [**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
20
20
  [**patch_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_timeoffrequest) | Mark a time off request for the current user as read or unread
21
+ [**post_workforcemanagement_agents**](WorkforceManagementApi.html#post_workforcemanagement_agents) | Move agents in and out of management unit
21
22
  [**post_workforcemanagement_agents_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_agents_managementunits) | Get the management units to which the agents belong
23
+ [**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
22
24
  [**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
23
25
  [**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
24
26
  [**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Get user schedules within the given time range
@@ -88,7 +90,7 @@ Name | Type | Description | Notes
88
90
 
89
91
  ## -[**ActivityCodeContainer**](ActivityCodeContainer.html) get_workforcemanagement_managementunit_activitycodes(mu_id)
90
92
 
91
- Get activity codes corresponding to a management unit
93
+ Get activity codes
92
94
 
93
95
 
94
96
 
@@ -116,7 +118,7 @@ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' fo
116
118
 
117
119
 
118
120
  begin
119
- #Get activity codes corresponding to a management unit
121
+ #Get activity codes
120
122
  result = api_instance.get_workforcemanagement_managementunit_activitycodes(mu_id)
121
123
  p result
122
124
  rescue PureCloud::ApiError => e
@@ -640,6 +642,66 @@ nil (empty response body)
640
642
 
641
643
 
642
644
 
645
+ <a name="post_workforcemanagement_agents"></a>
646
+
647
+ ## -[**MoveAgentsResponse**](MoveAgentsResponse.html) post_workforcemanagement_agents(opts)
648
+
649
+ Move agents in and out of management unit
650
+
651
+
652
+
653
+ Wraps POST /api/v2/workforcemanagement/agents
654
+
655
+
656
+ ### Example
657
+ ~~~ruby
658
+ # load the gem
659
+ require 'purecloudplatformclientv2'
660
+ # setup authorization
661
+ @secret = ENV['PURECLOUD_SECRET']
662
+ @id = ENV['PURECLOUD_CLIENT_ID']
663
+ environment = "mypurecloud.com"
664
+
665
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
666
+
667
+ PureCloud.configure do |config|
668
+ config.access_token = @authToken
669
+ end
670
+
671
+ api_instance = PureCloud::WorkforceManagementApi.new
672
+
673
+ opts = {
674
+ body: PureCloud::MoveAgentsRequest.new # MoveAgentsRequest | body
675
+ }
676
+
677
+ begin
678
+ #Move agents in and out of management unit
679
+ result = api_instance.post_workforcemanagement_agents(opts)
680
+ p result
681
+ rescue PureCloud::ApiError => e
682
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_agents: #{e}"
683
+ end
684
+ ~~~
685
+
686
+ ### Parameters
687
+
688
+ Name | Type | Description | Notes
689
+ ------------- | ------------- | ------------- | -------------
690
+ **body** | [**MoveAgentsRequest**](MoveAgentsRequest.html)| body | [optional] |
691
+ {: class="table table-striped"}
692
+
693
+
694
+ ### Return type
695
+
696
+ [**MoveAgentsResponse**](MoveAgentsResponse.html)
697
+
698
+ ### HTTP request headers
699
+
700
+ - **Content-Type**: application/json
701
+ - **Accept**: application/json
702
+
703
+
704
+
643
705
  <a name="post_workforcemanagement_agents_managementunits"></a>
644
706
 
645
707
  ## -[**Array&lt;AgentManagementUnitReference&gt;**](AgentManagementUnitReference.html) post_workforcemanagement_agents_managementunits(opts)
@@ -700,6 +762,69 @@ Name | Type | Description | Notes
700
762
 
701
763
 
702
764
 
765
+ <a name="post_workforcemanagement_managementunit_activitycodes"></a>
766
+
767
+ ## -[**ActivityCode**](ActivityCode.html) post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
768
+
769
+ Create a new activity code
770
+
771
+
772
+
773
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/activitycodes
774
+
775
+
776
+ ### Example
777
+ ~~~ruby
778
+ # load the gem
779
+ require 'purecloudplatformclientv2'
780
+ # setup authorization
781
+ @secret = ENV['PURECLOUD_SECRET']
782
+ @id = ENV['PURECLOUD_CLIENT_ID']
783
+ environment = "mypurecloud.com"
784
+
785
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
786
+
787
+ PureCloud.configure do |config|
788
+ config.access_token = @authToken
789
+ end
790
+
791
+ api_instance = PureCloud::WorkforceManagementApi.new
792
+
793
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
794
+
795
+ opts = {
796
+ body: PureCloud::CreateActivityCodeRequest.new # CreateActivityCodeRequest | body
797
+ }
798
+
799
+ begin
800
+ #Create a new activity code
801
+ result = api_instance.post_workforcemanagement_managementunit_activitycodes(mu_id, opts)
802
+ p result
803
+ rescue PureCloud::ApiError => e
804
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_activitycodes: #{e}"
805
+ end
806
+ ~~~
807
+
808
+ ### Parameters
809
+
810
+ Name | Type | Description | Notes
811
+ ------------- | ------------- | ------------- | -------------
812
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
813
+ **body** | [**CreateActivityCodeRequest**](CreateActivityCodeRequest.html)| body | [optional] |
814
+ {: class="table table-striped"}
815
+
816
+
817
+ ### Return type
818
+
819
+ [**ActivityCode**](ActivityCode.html)
820
+
821
+ ### HTTP request headers
822
+
823
+ - **Content-Type**: application/json
824
+ - **Accept**: application/json
825
+
826
+
827
+
703
828
  <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
704
829
 
705
830
  ## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
@@ -1,7 +1,7 @@
1
1
  ---
2
- title: Entity
2
+ title: WrapUpCodeReference
3
3
  ---
4
- ## PureCloud::Entity
4
+ ## PureCloud::WrapUpCodeReference
5
5
 
6
6
  ## Properties
7
7
 
@@ -101,6 +101,11 @@ require 'purecloudplatformclientv2/models/available_language_list'
101
101
  require 'purecloudplatformclientv2/models/available_topic'
102
102
  require 'purecloudplatformclientv2/models/available_topic_entity_listing'
103
103
  require 'purecloudplatformclientv2/models/available_translations'
104
+ require 'purecloudplatformclientv2/models/batch_download_job_result'
105
+ require 'purecloudplatformclientv2/models/batch_download_job_status_result'
106
+ require 'purecloudplatformclientv2/models/batch_download_job_submission'
107
+ require 'purecloudplatformclientv2/models/batch_download_job_submission_result'
108
+ require 'purecloudplatformclientv2/models/batch_download_request'
104
109
  require 'purecloudplatformclientv2/models/billing_usage'
105
110
  require 'purecloudplatformclientv2/models/billing_usage_report'
106
111
  require 'purecloudplatformclientv2/models/billing_usage_resource'
@@ -124,6 +129,12 @@ require 'purecloudplatformclientv2/models/call_conversation_notification_partici
124
129
  require 'purecloudplatformclientv2/models/call_conversation_notification_uri_reference'
125
130
  require 'purecloudplatformclientv2/models/call_conversation_notification_wrapup'
126
131
  require 'purecloudplatformclientv2/models/call_forwarding'
132
+ require 'purecloudplatformclientv2/models/call_forwarding_notification'
133
+ require 'purecloudplatformclientv2/models/call_forwarding_notification_call'
134
+ require 'purecloudplatformclientv2/models/call_forwarding_notification_calls'
135
+ require 'purecloudplatformclientv2/models/call_forwarding_notification_target'
136
+ require 'purecloudplatformclientv2/models/call_forwarding_notification_targets'
137
+ require 'purecloudplatformclientv2/models/call_forwarding_notification_user'
127
138
  require 'purecloudplatformclientv2/models/call_history_conversation'
128
139
  require 'purecloudplatformclientv2/models/call_history_conversation_entity_listing'
129
140
  require 'purecloudplatformclientv2/models/call_history_participant'
@@ -251,6 +262,7 @@ require 'purecloudplatformclientv2/models/consuming_resources_entity_listing'
251
262
  require 'purecloudplatformclientv2/models/contact'
252
263
  require 'purecloudplatformclientv2/models/contact_address'
253
264
  require 'purecloudplatformclientv2/models/contact_callback_request'
265
+ require 'purecloudplatformclientv2/models/contact_column_time_zone'
254
266
  require 'purecloudplatformclientv2/models/contact_list'
255
267
  require 'purecloudplatformclientv2/models/contact_list_entity_listing'
256
268
  require 'purecloudplatformclientv2/models/contact_list_filter'
@@ -320,6 +332,7 @@ require 'purecloudplatformclientv2/models/conversation_notification_wrapup'
320
332
  require 'purecloudplatformclientv2/models/conversation_query'
321
333
  require 'purecloudplatformclientv2/models/copy_voicemail_message'
322
334
  require 'purecloudplatformclientv2/models/cover_sheet'
335
+ require 'purecloudplatformclientv2/models/create_activity_code_request'
323
336
  require 'purecloudplatformclientv2/models/create_asg_request'
324
337
  require 'purecloudplatformclientv2/models/create_call_request'
325
338
  require 'purecloudplatformclientv2/models/create_call_response'
@@ -466,7 +479,6 @@ require 'purecloudplatformclientv2/models/encryption_key'
466
479
  require 'purecloudplatformclientv2/models/encryption_key_entity_listing'
467
480
  require 'purecloudplatformclientv2/models/endpoint'
468
481
  require 'purecloudplatformclientv2/models/endpoint_entity_listing'
469
- require 'purecloudplatformclientv2/models/entity'
470
482
  require 'purecloudplatformclientv2/models/entry'
471
483
  require 'purecloudplatformclientv2/models/error_body'
472
484
  require 'purecloudplatformclientv2/models/error_details'
@@ -558,6 +570,7 @@ require 'purecloudplatformclientv2/models/history_listing'
558
570
  require 'purecloudplatformclientv2/models/ivr'
559
571
  require 'purecloudplatformclientv2/models/ivr_entity_listing'
560
572
  require 'purecloudplatformclientv2/models/identity_now'
573
+ require 'purecloudplatformclientv2/models/ignored_activity_categories'
561
574
  require 'purecloudplatformclientv2/models/import_script_status_response'
562
575
  require 'purecloudplatformclientv2/models/import_status'
563
576
  require 'purecloudplatformclientv2/models/import_status_notification'
@@ -665,11 +678,16 @@ require 'purecloudplatformclientv2/models/message_conversation_notification_part
665
678
  require 'purecloudplatformclientv2/models/message_conversation_notification_uri_reference'
666
679
  require 'purecloudplatformclientv2/models/message_conversation_notification_wrapup'
667
680
  require 'purecloudplatformclientv2/models/message_details'
681
+ require 'purecloudplatformclientv2/models/message_media'
668
682
  require 'purecloudplatformclientv2/models/message_media_policy'
669
683
  require 'purecloudplatformclientv2/models/message_media_policy_conditions'
670
684
  require 'purecloudplatformclientv2/models/meta_data'
671
685
  require 'purecloudplatformclientv2/models/metabase'
672
686
  require 'purecloudplatformclientv2/models/metered_evaluation_assignment'
687
+ require 'purecloudplatformclientv2/models/move_agent_response'
688
+ require 'purecloudplatformclientv2/models/move_agents_request'
689
+ require 'purecloudplatformclientv2/models/move_agents_response'
690
+ require 'purecloudplatformclientv2/models/ntp_settings'
673
691
  require 'purecloudplatformclientv2/models/named_entity'
674
692
  require 'purecloudplatformclientv2/models/note'
675
693
  require 'purecloudplatformclientv2/models/note_listing'
@@ -792,6 +810,7 @@ require 'purecloudplatformclientv2/models/recording_data_v2_notification_lock_in
792
810
  require 'purecloudplatformclientv2/models/recording_data_v2_notification_user_data'
793
811
  require 'purecloudplatformclientv2/models/recording_data_v2_notification_workspace_data'
794
812
  require 'purecloudplatformclientv2/models/recording_email_message'
813
+ require 'purecloudplatformclientv2/models/recording_messaging_message'
795
814
  require 'purecloudplatformclientv2/models/recording_settings'
796
815
  require 'purecloudplatformclientv2/models/relationship'
797
816
  require 'purecloudplatformclientv2/models/relationship_listing'
@@ -887,7 +906,8 @@ require 'purecloudplatformclientv2/models/share_entity_listing'
887
906
  require 'purecloudplatformclientv2/models/shared_entity'
888
907
  require 'purecloudplatformclientv2/models/shared_response'
889
908
  require 'purecloudplatformclientv2/models/short_term_forecasting_settings'
890
- require 'purecloudplatformclientv2/models/signed_data'
909
+ require 'purecloudplatformclientv2/models/shrinkage_override'
910
+ require 'purecloudplatformclientv2/models/shrinkage_overrides'
891
911
  require 'purecloudplatformclientv2/models/site'
892
912
  require 'purecloudplatformclientv2/models/site_entity_listing'
893
913
  require 'purecloudplatformclientv2/models/skill_entity_listing'
@@ -959,10 +979,11 @@ require 'purecloudplatformclientv2/models/trunk_metrics_registers'
959
979
  require 'purecloudplatformclientv2/models/trunk_recording_enabled_count'
960
980
  require 'purecloudplatformclientv2/models/trust_create'
961
981
  require 'purecloudplatformclientv2/models/trust_entity_listing'
982
+ require 'purecloudplatformclientv2/models/trust_group'
983
+ require 'purecloudplatformclientv2/models/trust_member_create'
962
984
  require 'purecloudplatformclientv2/models/trust_request'
963
985
  require 'purecloudplatformclientv2/models/trust_request_create'
964
986
  require 'purecloudplatformclientv2/models/trust_user'
965
- require 'purecloudplatformclientv2/models/trust_user_create'
966
987
  require 'purecloudplatformclientv2/models/trust_user_details'
967
988
  require 'purecloudplatformclientv2/models/trust_user_entity_listing'
968
989
  require 'purecloudplatformclientv2/models/trustee'
@@ -1064,6 +1085,7 @@ require 'purecloudplatformclientv2/models/wfm_historical_adherence_query'
1064
1085
  require 'purecloudplatformclientv2/models/wfm_historical_adherence_response'
1065
1086
  require 'purecloudplatformclientv2/models/wfm_intraday_queue_listing'
1066
1087
  require 'purecloudplatformclientv2/models/wfm_user_entity_listing'
1088
+ require 'purecloudplatformclientv2/models/wfm_versioned_entity_metadata'
1067
1089
  require 'purecloudplatformclientv2/models/workspace'
1068
1090
  require 'purecloudplatformclientv2/models/workspace_create'
1069
1091
  require 'purecloudplatformclientv2/models/workspace_entity_listing'
@@ -1072,6 +1094,7 @@ require 'purecloudplatformclientv2/models/workspace_member_entity_listing'
1072
1094
  require 'purecloudplatformclientv2/models/workspace_summary'
1073
1095
  require 'purecloudplatformclientv2/models/wrap_up_code_mapping'
1074
1096
  require 'purecloudplatformclientv2/models/wrap_up_code_mapping_notification'
1097
+ require 'purecloudplatformclientv2/models/wrap_up_code_reference'
1075
1098
  require 'purecloudplatformclientv2/models/wrapup'
1076
1099
  require 'purecloudplatformclientv2/models/wrapup_code'
1077
1100
  require 'purecloudplatformclientv2/models/wrapup_code_entity_listing'
@@ -1108,7 +1131,6 @@ require 'purecloudplatformclientv2/api/response_management_api'
1108
1131
  require 'purecloudplatformclientv2/api/routing_api'
1109
1132
  require 'purecloudplatformclientv2/api/scripts_api'
1110
1133
  require 'purecloudplatformclientv2/api/search_api'
1111
- require 'purecloudplatformclientv2/api/signed_data_api'
1112
1134
  require 'purecloudplatformclientv2/api/stations_api'
1113
1135
  require 'purecloudplatformclientv2/api/suggest_api'
1114
1136
  require 'purecloudplatformclientv2/api/telephony_providers_edge_api'