purecloudplatformclientv2 14.1.0 → 15.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 (283) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AgentActivityEntityListing.md +1 -1
  4. data/docs/ArchitectApi.md +14 -14
  5. data/docs/AttemptLimitsEntityListing.md +1 -1
  6. data/docs/AttributeEntityListing.md +1 -1
  7. data/docs/CalibrationEntityListing.md +1 -1
  8. data/docs/CallConversationEntityListing.md +1 -1
  9. data/docs/CallableTimeSetEntityListing.md +1 -1
  10. data/docs/CallbackConversationEntityListing.md +1 -1
  11. data/docs/CampaignEntityListing.md +1 -1
  12. data/docs/CampaignRuleEntityListing.md +1 -1
  13. data/docs/CampaignSequenceEntityListing.md +1 -1
  14. data/docs/CertificateAuthorityEntityListing.md +1 -1
  15. data/docs/CertificateDetails.md +1 -1
  16. data/docs/ChatConversationEntityListing.md +1 -1
  17. data/docs/CobrowseConversationEntityListing.md +1 -1
  18. data/docs/CommandStatusEntityListing.md +1 -1
  19. data/docs/ConsumedResourcesEntityListing.md +1 -1
  20. data/docs/ConsumingResourcesEntityListing.md +1 -1
  21. data/docs/ContactListEntityListing.md +1 -1
  22. data/docs/ContactListFilterEntityListing.md +1 -1
  23. data/docs/ContactListing.md +1 -1
  24. data/docs/ConversationEntityListing.md +1 -1
  25. data/docs/ConversationsApi.md +63 -0
  26. data/docs/CreateEmailRequest.md +2 -1
  27. data/docs/CreateQueueRequest.md +1 -1
  28. data/docs/DIDEntityListing.md +1 -1
  29. data/docs/DIDPoolEntityListing.md +1 -1
  30. data/docs/DependencyObjectEntityListing.md +1 -1
  31. data/docs/DependencyTypeEntityListing.md +1 -1
  32. data/docs/DialerEventEntityListing.md +1 -1
  33. data/docs/DncListEntityListing.md +1 -1
  34. data/docs/DocumentAuditEntityListing.md +1 -1
  35. data/docs/DocumentEntityListing.md +1 -1
  36. data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
  37. data/docs/DomainEntityListing.md +1 -1
  38. data/docs/DomainEntityListingEvaluationForm.md +1 -1
  39. data/docs/DomainEntityListingQueryResult.md +1 -1
  40. data/docs/EdgeEntityListing.md +1 -1
  41. data/docs/EdgeGroupEntityListing.md +1 -1
  42. data/docs/EdgeLineEntityListing.md +1 -1
  43. data/docs/EmailConversationEntityListing.md +1 -1
  44. data/docs/EmailMessageListing.md +1 -1
  45. data/docs/EncryptionKeyEntityListing.md +1 -1
  46. data/docs/EndpointEntityListing.md +1 -1
  47. data/docs/EvaluationEntityListing.md +1 -1
  48. data/docs/EvaluationFormEntityListing.md +1 -1
  49. data/docs/EvaluatorActivityEntityListing.md +1 -1
  50. data/docs/ExtensionEntityListing.md +1 -1
  51. data/docs/ExtensionPoolEntityListing.md +1 -1
  52. data/docs/ExternalOrganizationListing.md +1 -1
  53. data/docs/FaxDocumentEntityListing.md +1 -1
  54. data/docs/FlowEntityListing.md +1 -1
  55. data/docs/FlowVersionEntityListing.md +1 -1
  56. data/docs/GreetingListing.md +1 -1
  57. data/docs/GroupEntityListing.md +1 -1
  58. data/docs/GroupsApi.md +2 -0
  59. data/docs/IVREntityListing.md +1 -1
  60. data/docs/InboundDomainEntityListing.md +1 -1
  61. data/docs/InboundMessageRequest.md +24 -0
  62. data/docs/InboundRouteEntityListing.md +1 -1
  63. data/docs/InteractionStatsAlertContainer.md +1 -1
  64. data/docs/InteractionStatsRuleContainer.md +1 -1
  65. data/docs/JsonNode.md +1 -1
  66. data/docs/KeywordSetEntityListing.md +1 -1
  67. data/docs/LanguageEntityListing.md +1 -1
  68. data/docs/LibraryEntityListing.md +1 -1
  69. data/docs/LineBaseEntityListing.md +1 -1
  70. data/docs/LineEntityListing.md +1 -1
  71. data/docs/LocationEntityListing.md +1 -1
  72. data/docs/LogicalInterfaceEntityListing.md +1 -1
  73. data/docs/NoteListing.md +1 -1
  74. data/docs/OAuthClientEntityListing.md +1 -1
  75. data/docs/OAuthProviderEntityListing.md +1 -1
  76. data/docs/OrganizationPresenceEntityListing.md +1 -1
  77. data/docs/OrganizationRoleEntityListing.md +1 -1
  78. data/docs/OrphanRecordingListing.md +1 -1
  79. data/docs/OutboundRouteBaseEntityListing.md +1 -1
  80. data/docs/OutboundRouteEntityListing.md +1 -1
  81. data/docs/PermissionCollectionEntityListing.md +1 -1
  82. data/docs/PhoneBaseEntityListing.md +1 -1
  83. data/docs/PhoneEntityListing.md +1 -1
  84. data/docs/PhoneMetaBaseEntityListing.md +1 -1
  85. data/docs/PhysicalInterfaceEntityListing.md +1 -1
  86. data/docs/PolicyEntityListing.md +1 -1
  87. data/docs/PromptAssetEntityListing.md +1 -1
  88. data/docs/PromptEntityListing.md +1 -1
  89. data/docs/QualityAuditPage.md +1 -1
  90. data/docs/Queue.md +1 -1
  91. data/docs/QueueEntityListing.md +1 -1
  92. data/docs/QueueMemberEntityListing.md +1 -1
  93. data/docs/Recording.md +1 -0
  94. data/docs/RelationshipListing.md +1 -1
  95. data/docs/ReportMetaDataEntityListing.md +1 -1
  96. data/docs/ReportRunEntryEntityDomainListing.md +1 -1
  97. data/docs/ReportScheduleEntityListing.md +1 -1
  98. data/docs/ResponseEntityList.md +1 -1
  99. data/docs/ResponseEntityListing.md +1 -1
  100. data/docs/ResponseSetEntityListing.md +1 -1
  101. data/docs/RoutingStatus.md +1 -1
  102. data/docs/RuleSetEntityListing.md +1 -1
  103. data/docs/ScheduleEntityListing.md +1 -1
  104. data/docs/ScheduleGroupEntityListing.md +1 -1
  105. data/docs/SchemaCategoryEntityListing.md +1 -1
  106. data/docs/SchemaReferenceEntityListing.md +1 -1
  107. data/docs/ScreenRecordingSessionListing.md +1 -1
  108. data/docs/ScriptEntityListing.md +1 -1
  109. data/docs/SecurityProfileEntityListing.md +1 -1
  110. data/docs/ShareEntityListing.md +1 -1
  111. data/docs/SiteEntityListing.md +1 -1
  112. data/docs/SkillEntityListing.md +1 -1
  113. data/docs/StationEntityListing.md +1 -1
  114. data/docs/SystemPromptAssetEntityListing.md +1 -1
  115. data/docs/SystemPromptEntityListing.md +1 -1
  116. data/docs/TagValueEntityListing.md +1 -1
  117. data/docs/TimeZoneEntityListing.md +1 -1
  118. data/docs/TrunkBaseEntityListing.md +1 -1
  119. data/docs/TrunkEntityListing.md +1 -1
  120. data/docs/TrunkMetabaseEntityListing.md +1 -1
  121. data/docs/TrustEntityListing.md +1 -1
  122. data/docs/TrustUserEntityListing.md +1 -1
  123. data/docs/TrustorEntityListing.md +1 -1
  124. data/docs/UserEntityListing.md +1 -1
  125. data/docs/UserQueue.md +1 -1
  126. data/docs/UserQueueEntityListing.md +1 -1
  127. data/docs/UserRecordingEntityListing.md +1 -1
  128. data/docs/UserSkillEntityListing.md +1 -1
  129. data/docs/VoicemailApi.md +66 -0
  130. data/docs/VoicemailMessage.md +2 -1
  131. data/docs/VoicemailMessageEntityListing.md +1 -1
  132. data/docs/WfmHistoricalAdherenceQuery.md +17 -0
  133. data/docs/WfmHistoricalAdherenceResponse.md +15 -0
  134. data/docs/WorkforceManagementApi.md +64 -0
  135. data/docs/WorkspaceEntityListing.md +1 -1
  136. data/docs/WorkspaceMemberEntityListing.md +1 -1
  137. data/docs/WrapupCodeEntityListing.md +1 -1
  138. data/lib/purecloudplatformclientv2.rb +3 -0
  139. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  140. data/lib/purecloudplatformclientv2/api/conversations_api.rb +75 -0
  141. data/lib/purecloudplatformclientv2/api/groups_api.rb +9 -0
  142. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +83 -0
  143. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +73 -0
  144. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  145. data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
  146. data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
  147. data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
  148. data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
  149. data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
  150. data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
  151. data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
  152. data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
  153. data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
  154. data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
  155. data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
  156. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  157. data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
  158. data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
  159. data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
  160. data/lib/purecloudplatformclientv2/models/condition.rb +2 -2
  161. data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
  162. data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
  163. data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
  164. data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
  165. data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
  166. data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
  167. data/lib/purecloudplatformclientv2/models/create_email_request.rb +27 -6
  168. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  169. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  170. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  171. data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
  172. data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
  173. data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
  174. data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
  175. data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
  176. data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
  177. data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
  178. data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
  179. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
  180. data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
  181. data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
  182. data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
  183. data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
  184. data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
  185. data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
  186. data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
  187. data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
  188. data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
  189. data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +12 -12
  190. data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
  191. data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
  192. data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
  193. data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
  194. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  195. data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
  196. data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
  197. data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
  198. data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
  199. data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
  200. data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
  201. data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
  202. data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
  203. data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
  204. data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
  205. data/lib/purecloudplatformclientv2/models/inbound_message_request.rb +497 -0
  206. data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
  207. data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
  208. data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
  209. data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
  210. data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
  211. data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
  212. data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
  213. data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
  214. data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
  215. data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
  216. data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
  217. data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
  218. data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
  219. data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
  220. data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
  221. data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
  222. data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
  223. data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
  224. data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
  225. data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
  226. data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
  227. data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
  228. data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
  229. data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
  230. data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
  231. data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
  232. data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
  233. data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
  234. data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
  235. data/lib/purecloudplatformclientv2/models/queue.rb +1 -1
  236. data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
  237. data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
  238. data/lib/purecloudplatformclientv2/models/recording.rb +29 -1
  239. data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
  240. data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
  241. data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
  242. data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
  243. data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
  244. data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
  245. data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
  246. data/lib/purecloudplatformclientv2/models/routing_status.rb +1 -1
  247. data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
  248. data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
  249. data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
  250. data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
  251. data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
  252. data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
  253. data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
  254. data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
  255. data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
  256. data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
  257. data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
  258. data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
  259. data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
  260. data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
  261. data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
  262. data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
  263. data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
  264. data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
  265. data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
  266. data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
  267. data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
  268. data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
  269. data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
  270. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -1
  271. data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
  272. data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
  273. data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
  274. data/lib/purecloudplatformclientv2/models/voicemail_message.rb +34 -8
  275. data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
  276. data/lib/purecloudplatformclientv2/models/voicemail_retention_policy.rb +1 -1
  277. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb +323 -0
  278. data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +269 -0
  279. data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
  280. data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
  281. data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
  282. data/lib/purecloudplatformclientv2/version.rb +1 -1
  283. metadata +8 -2
data/docs/ScriptEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: ScriptEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/SecurityProfileEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: SecurityProfileEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/ShareEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: ShareEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/SiteEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: SiteEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/SkillEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: SkillEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/StationEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: StationEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/SystemPromptAssetEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: SystemPromptAssetEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/SystemPromptEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: SystemPromptEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TagValueEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TagValueEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TimeZoneEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TimeZoneEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrunkBaseEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrunkBaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrunkEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrunkEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrunkMetabaseEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrunkMetabaseEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrustEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrustEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrustUserEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrustUserEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/TrustorEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: TrustorEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/UserEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: UserEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/UserQueue.md CHANGED
@@ -18,7 +18,7 @@ title: UserQueue
18
18
  | **state** | **String** | | [optional] |
19
19
  | **modified_by_app** | **String** | | [optional] |
20
20
  | **created_by_app** | **String** | | [optional] |
21
- | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. | |
21
+ | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
22
22
  | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
23
23
  | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
24
24
  | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
data/docs/UserQueueEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: UserQueueEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/UserRecordingEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: UserRecordingEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/UserSkillEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: UserSkillEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/VoicemailApi.md CHANGED
@@ -21,6 +21,7 @@ Method | Description
21
21
  [**get_voicemail_message_media**](VoicemailApi.html#get_voicemail_message_media) | Get media playback URI for this voicemail message
22
22
  [**get_voicemail_messages**](VoicemailApi.html#get_voicemail_messages) | List voicemail messages
23
23
  [**get_voicemail_policy**](VoicemailApi.html#get_voicemail_policy) | Get a policy
24
+ [**get_voicemail_queue_messages**](VoicemailApi.html#get_voicemail_queue_messages) | List voicemail messages
24
25
  [**get_voicemail_search**](VoicemailApi.html#get_voicemail_search) | Search voicemails using the q64 value returned from a previous search
25
26
  [**get_voicemail_userpolicy**](VoicemailApi.html#get_voicemail_userpolicy) | Get a user's voicemail policy
26
27
  [**patch_voicemail_group_policy**](VoicemailApi.html#patch_voicemail_group_policy) | Update a group's voicemail policy
@@ -788,6 +789,71 @@ This endpoint does not need any parameter.
788
789
 
789
790
 
790
791
 
792
+ <a name="get_voicemail_queue_messages"></a>
793
+
794
+ ## -[**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html) get_voicemail_queue_messages(queue_id, opts)
795
+
796
+ List voicemail messages
797
+
798
+
799
+
800
+ Wraps GET /api/v2/voicemail/queues/{queueId}/messages
801
+
802
+
803
+ ### Example
804
+ ~~~ruby
805
+ # load the gem
806
+ require 'purecloudplatformclientv2'
807
+ # setup authorization
808
+ @secret = ENV['PURECLOUD_SECRET']
809
+ @id = ENV['PURECLOUD_CLIENT_ID']
810
+ environment = "mypurecloud.com"
811
+
812
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
813
+
814
+ PureCloud.configure do |config|
815
+ config.access_token = @authToken
816
+ end
817
+
818
+ api_instance = PureCloud::VoicemailApi.new
819
+
820
+ queue_id = "queue_id_example" # String | Queue ID
821
+
822
+ opts = {
823
+ page_size: 25, # Integer | Page size
824
+ page_number: 1 # Integer | Page number
825
+ }
826
+
827
+ begin
828
+ #List voicemail messages
829
+ result = api_instance.get_voicemail_queue_messages(queue_id, opts)
830
+ p result
831
+ rescue PureCloud::ApiError => e
832
+ puts "Exception when calling VoicemailApi->get_voicemail_queue_messages: #{e}"
833
+ end
834
+ ~~~
835
+
836
+ ### Parameters
837
+
838
+ Name | Type | Description | Notes
839
+ ------------- | ------------- | ------------- | -------------
840
+ **queue_id** | **String**| Queue ID | |
841
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
842
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
843
+ {: class="table table-striped"}
844
+
845
+
846
+ ### Return type
847
+
848
+ [**VoicemailMessageEntityListing**](VoicemailMessageEntityListing.html)
849
+
850
+ ### HTTP request headers
851
+
852
+ - **Content-Type**: application/json
853
+ - **Accept**: application/json
854
+
855
+
856
+
791
857
  <a name="get_voicemail_search"></a>
792
858
 
793
859
  ## -[**VoicemailsSearchResponse**](VoicemailsSearchResponse.html) get_voicemail_search(q64, opts)
data/docs/VoicemailMessage.md CHANGED
@@ -14,6 +14,7 @@ title: VoicemailMessage
14
14
  | **audio_recording_size_bytes** | **Integer** | The voicemail message&#39;s audio recording size in bytes | [optional] |
15
15
  | **created_date** | **DateTime** | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
16
  | **modified_date** | **DateTime** | The date the voicemail message was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
+ | **deleted_date** | **DateTime** | The date the voicemail message deleted property was set to true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
18
  | **caller_address** | **String** | The caller address | [optional] |
18
19
  | **caller_name** | **String** | Optionally the name of the caller that left the voicemail message if the caller was a known user | [optional] |
19
20
  | **caller_user** | [**User**](User.html) | Optionally the user that left the voicemail message if the caller was a known user | [optional] |
@@ -24,7 +25,7 @@ title: VoicemailMessage
24
25
  | **queue** | [**Queue**](Queue.html) | The queue that the voicemail message belongs to or null which means the voicemail message belongs to a user or group | [optional] |
25
26
  | **copied_from** | [**VoicemailCopyRecord**](VoicemailCopyRecord.html) | Represents where this voicemail message was copied from | [optional] |
26
27
  | **copied_to** | [**Array&lt;VoicemailCopyRecord&gt;**](VoicemailCopyRecord.html) | Represents where this voicemail has been copied to | [optional] |
27
- | **retention_policy** | [**VoicemailRetentionPolicy**](VoicemailRetentionPolicy.html) | The retention policy for this voicemail | [optional] |
28
+ | **delete_retention_policy** | [**VoicemailRetentionPolicy**](VoicemailRetentionPolicy.html) | The retention policy for this voicemail when deleted is set to true | [optional] |
28
29
  | **self_uri** | **String** | The URI for this object | [optional] |
29
30
  {: class="table table-striped"}
30
31
 
data/docs/VoicemailMessageEntityListing.md CHANGED
@@ -13,8 +13,8 @@ title: VoicemailMessageEntityListing
13
13
  | **total** | **Integer** | | [optional] |
14
14
  | **self_uri** | **String** | | [optional] |
15
15
  | **first_uri** | **String** | | [optional] |
16
- | **previous_uri** | **String** | | [optional] |
17
16
  | **next_uri** | **String** | | [optional] |
17
+ | **previous_uri** | **String** | | [optional] |
18
18
  | **last_uri** | **String** | | [optional] |
19
19
  | **page_count** | **Integer** | | [optional] |
20
20
  {: class="table table-striped"}
data/docs/WfmHistoricalAdherenceQuery.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: WfmHistoricalAdherenceQuery
3
+ ---
4
+ ## PureCloud::WfmHistoricalAdherenceQuery
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **start_date** | **DateTime** | Beginning of the date range to query in ISO-8601 format | |
11
+ | **end_date** | **DateTime** | End of the date range to query in ISO-8601 format | |
12
+ | **time_zone** | **String** | The time zone to use for returned results in olson format (See https://www.ibm.com/developerworks/aix/library/au-aix-posix/) | [optional] |
13
+ | **user_ids** | **Array&lt;String&gt;** | The userIds to report on | |
14
+ | **include_exceptions** | **BOOLEAN** | | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
data/docs/WfmHistoricalAdherenceResponse.md ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ title: WfmHistoricalAdherenceResponse
3
+ ---
4
+ ## PureCloud::WfmHistoricalAdherenceResponse
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The query ID to listen for | [optional] |
11
+ | **download_url** | **String** | The uri to query to GET the results of the Historical Adherence query. This will return unpopulated but will be populated in the notification | [optional] |
12
+ | **query_state** | **String** | The state of the adherence query | [optional] |
13
+ {: class="table table-striped"}
14
+
15
+
data/docs/WorkforceManagementApi.md CHANGED
@@ -18,6 +18,7 @@ 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_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
21
22
  [**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
22
23
  [**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Get user schedules within the given time range
23
24
  [**post_workforcemanagement_schedules**](WorkforceManagementApi.html#post_workforcemanagement_schedules) | Get a schedule for the current user
@@ -638,6 +639,69 @@ nil (empty response body)
638
639
 
639
640
 
640
641
 
642
+ <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
643
+
644
+ ## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
645
+
646
+ Request a historical adherence report
647
+
648
+
649
+
650
+ Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/historicaladherencequery
651
+
652
+
653
+ ### Example
654
+ ~~~ruby
655
+ # load the gem
656
+ require 'purecloudplatformclientv2'
657
+ # setup authorization
658
+ @secret = ENV['PURECLOUD_SECRET']
659
+ @id = ENV['PURECLOUD_CLIENT_ID']
660
+ environment = "mypurecloud.com"
661
+
662
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
663
+
664
+ PureCloud.configure do |config|
665
+ config.access_token = @authToken
666
+ end
667
+
668
+ api_instance = PureCloud::WorkforceManagementApi.new
669
+
670
+ mu_id = "mu_id_example" # String | The muId of the management unit, or 'mine' for the management unit of the logged-in user.
671
+
672
+ opts = {
673
+ body: PureCloud::WfmHistoricalAdherenceQuery.new # WfmHistoricalAdherenceQuery | body
674
+ }
675
+
676
+ begin
677
+ #Request a historical adherence report
678
+ result = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
679
+ p result
680
+ rescue PureCloud::ApiError => e
681
+ puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: #{e}"
682
+ end
683
+ ~~~
684
+
685
+ ### Parameters
686
+
687
+ Name | Type | Description | Notes
688
+ ------------- | ------------- | ------------- | -------------
689
+ **mu_id** | **String**| The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. | |
690
+ **body** | [**WfmHistoricalAdherenceQuery**](WfmHistoricalAdherenceQuery.html)| body | [optional] |
691
+ {: class="table table-striped"}
692
+
693
+
694
+ ### Return type
695
+
696
+ [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html)
697
+
698
+ ### HTTP request headers
699
+
700
+ - **Content-Type**: application/json
701
+ - **Accept**: application/json
702
+
703
+
704
+
641
705
  <a name="post_workforcemanagement_managementunit_intraday"></a>
642
706
 
643
707
  ## -[**IntradayResponse**](IntradayResponse.html) post_workforcemanagement_managementunit_intraday(mu_id, opts)